Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ES2015 Refactor (Release Checklist) #572

Open
19 of 23 tasks
bpatram opened this issue Jun 28, 2016 · 1 comment
Open
19 of 23 tasks

ES2015 Refactor (Release Checklist) #572

bpatram opened this issue Jun 28, 2016 · 1 comment
Labels
enhancement PR in progress
Milestone
v0.11.0

Comments

@bpatram
Copy link
Collaborator

bpatram commented Jun 28, 2016 •
edited
Loading

I've started work on refactoring some of bbr to use Rollup + Babel with a more modular design. Overall this should help everyone out to make it more extensible and easier to maintain in the long run. All work will be done on the next branch, if you are submitting a pull request make sure to branch off next until the release is completed.

  • Export in separate namespace Update exports for es6 #566
  • Create rollup configuration
  • Create prepublish npm script task to run rollup
  • Move into separate modules:
    • Relation
      • Decouple Relation from HasOne and HasMany (create lookup store for relation types)
    • HasOne
    • HasMany
    • Collection
    • Model
    • Store
    • Semaphore
  • Create base object extensible object
    • Refactor Relation to use base object
    • Refactor Store to use base object
  • Refactor test setup to use distributable
  • Ensure all unit tests pass
  • Update documentation Update documentation for ES2015/CommonJS importing #567
  • Create upgrade guide
  • Update contribution guidelines
  • Create PR and Issue templates for github
  • Create shimmed distributable to export how v0.10.0 does to ease transition
  • Update TravisCI tests to test against multiple Backbone versions

Since This library is so tightly coupled in places there will be more extensive refactoring required (for example, the base Relation 'class' is dependent on HasOne and HasMany while both HasOne and HasMany extend and depend on Relation).

Due to the nature of this large of a refactor I'm unsure how collaboration will work out with PRs and merge conflicts. It will take extra coordination.
@bpatram bpatram added this to the v0.11.0 milestone Jun 28, 2016
@bpatram bpatram mentioned this issue Jul 25, 2016
Merged
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 added build system, fixed some broken tests
6ec86b9
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 moved into their own module:
7287860 
- semaphore prototype
- blocking queue
- event queue
- configuration settings

create new base object used to extend off of. relation and store uses this now.
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 added watch and test gulp tasks. updated banner text. gulp build…
4c297be 
… builds minified version too now.

tweaked linter rules for spacing and console output.
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 remove console print lines in tests
eeadf2c
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 removed un-needed type checks and tightly coupled code.
919edad 
moved collection into its own module.
refactor some pieces of code to fit linter rules.
bpatram added a commit that referenced this issue Jul 26, 2016
@bpatram
#572 created relation-type-store to break the tight coupling between …
72e022e 
…relation, hasone, and hasmany.

moved store and relation into their own module
bpatram added a commit that referenced this issue Oct 23, 2016
@bpatram
#572 removed gulp build system to just npm scripts, no minified versi…
efd01c9 
…on now.

updated rollup and babel (and presets)
bpatram added a commit that referenced this issue Oct 23, 2016
@bpatram
#572 added watch task to auto build and run tests.
a94f410 
finished separation of modules into their own files for the most part
bpatram added a commit that referenced this issue Oct 23, 2016
@bpatram
#572 update karma and quint
d917a22
@bpatram
Copy link
Collaborator Author

bpatram commented Oct 24, 2016

What I ended up adding is a relation type store, which maps the relation types to their names. 'HasMany' => Relation.HasMany and the same idea for HasOne. This would also make it easier to override and register new relation types (Many to many?) in the future.

@bpatram bpatram mentioned this issue Nov 4, 2016
Closed
bpatram added a commit that referenced this issue Apr 2, 2017
@bpatram
#572 added changelog.
15a8d57 
updated build tools.
updated qunit to latest 2.x version.
added code coverage reporting.
unit testing uses source files instead of distributable.
refactor unit tests to be more modular.
bpatram added a commit that referenced this issue Apr 2, 2017
@bpatram
#572 fix for broken travis test.
8c6b310 
updated readme to include test badge and organized info
@bpatram bpatram changed the title ES6 Refactor (v0.11.0 Release Checklist) ES2015 Refactor (v0.11.0 Release Checklist) Apr 2, 2017
bpatram added a commit that referenced this issue Apr 3, 2017
@bpatram
#567 #572 updated docs to reflect new namespace and exports.
4c4b9d0
@bpatram bpatram modified the milestones: v0.11.0, v0.12.0 Apr 4, 2017
bpatram pushed a commit that referenced this issue Nov 26, 2017
#572 added upgrade guide
f406d64
@bpatram bpatram mentioned this issue Nov 26, 2017
Closed
@bpatram bpatram changed the title ES2015 Refactor (v0.11.0 Release Checklist) ES2015 Refactor (Release Checklist) Mar 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement PR in progress
Projects
None yet
Milestone
v0.11.0
Development

No branches or pull requests
1 participant
@bpatram