codebndr / eratosthenes Goto Github PK

Entities:

• Preference (Issue #25)
• Partner (Issue #26)
• Architecture (Issue #27)
• Library (Issue #30)
• Version (Issue #29)
• LibraryExample (Issue #31)

'Libraries are usually found on the internet in github repos or zip files, and we have some ways to import them, but we can do better. A zip export wouldn't hurt either.'

Details of our workplan and milestones can be found here.

See schema described in issue #21.

To do:

• Modify LoadExternalLibraryFilesCommand.php
• Modify DefaultHandler.php

These are passed to later issues. This issue will focus on new file structure.

id, version_id, name, path, boards
Unique index on: version_id

Renamed from Example to CodeExample.

Create 6 new fixture files in order to initialize the database for set up and test.

• Fixture for Architecture
• Fixture for LibraryExample
• Fixture for Library
• Fixture for Partner
• Fixture for Preference
• Fixture for Version

A delete library feature should be added, which would handle the deletion of the library metadata and examples metadata from the database, as well as the actual files deletion from the filesystem.

Regarding the original schema (#21), here are two issues I found today:
1.Unique index on folder_name of Version (#29)
Currently we are using relative path, so in each version we only store the folder name like "1.0.0" or "1.5.2". But this may violate the unique constraint.
Possible solution: We either store the full path, or we remove the index.

2.Unique index of version_id in LibraryExample (#31)
What if there may be two or more example for this version? The unique constraint may be broken then.
Possible solution: we remove the index, or we set the constraint to be {id, version_id}

Currently I resolved the issue 1 by removing the index; resolved issue 2 by apply unique index on {id, version_id}. (see f66431b)

Currently there are far too many magic strings, and the system is prone to silent failure from typo, change, etc.

One suggestion is to make constant package files. For example, a library that needs Form related constants will need to have use FormConstants and use getter like getDefaultHeader() to use a constant. This way, changing the value will not break anything, and some mistakes like typo will be caught by the compiler.

'Arduino IDE has a new feature that parses a special json hosted someplace on the internet to import libraries. In most cases we already have those libraries, but figuring how this works and incorporating it in eratosthenes would be welcome too.'

install.sh places the app in a directory called /opt/codbender/eratosthenes/Symfony/web , but it creates an apache configuration with alias and directory pointing to /opt/codebender/codebender-library-manager/Symfony/web