ChangeLog.md

TBone Change Log

3.0.0

• Breaking change: (#16) Sub-models now propagate their values continuously to the parent model. A separate structure maintains a record of the (hidden) sub-model hierarchy within the parent model, but it is no longer necessary to perform sub-queries into sub-models in order to fetch their data. It is now sufficient to simply query the root of the parent model, i.e. parent.query(''), in order to get all the data for it and its children. More details can be found at https://github.com/appneta/tbone/issues/16.
• You must now call tbone.patchReact to patch React with TBone instrumentation.
• DEBUG mode is now on by default in the non-minified source.
• "Scope" objects have been renamed to "Runlets" for clarity. "Scope" was overused and ambiguous, even within the TBone source.
• We no longer explicitly depend on JQuery except for the default ajax function implementation for ajax models, which we pull from window.$.ajax if available.
• T.metrics('ajax.modelsInFlight') has been removed (due to #16), and T.metrics('ajax.urlsInFlight') has been added to fill in the typical use case for the former.

2.0.3

• Fix React integration when used via browserify.

2.0.2

• Fix issues that prevented using browserify to require tbone.

2.0.0

This release removes the DOM-manipulation portions of TBone. TBone's view & template components were never first in class, and this move focuses on TBone's strengths in setting up data dependencies.

React functions in a very similar fashion to TBone's old view module, and TBone-React integration (though entirely optional) is now bundled with the regular TBone build.

In addition, it includes some significant breaking changes:

• Removed support for Backbone model interoperability.
• Removed clearOnFetch from ajax models. Replaced with preFetch callback, which in the default implementation clears the model. Set preFetch: _.noop for the old clearOnFetch: false behavior.
• TBone models now throw an exception when attempting to set DOM elements or functions to them as values, either at the root of the model or in any descendent. This change was made to discourage using TBone as a general storage container for non-data JS objects, and to keep with the overall strategy where TBone forms a pipeline of serializable data.
• autorun now takes either a function or an object as its single argument. The old style of T(fn, priority) is no longer supported.
• Removed previously-deprecated queryText, text, lookup, lookupText, set, and get functions from the base model.
• Removed little-used find method from the base model.
• TBone no longer guards against extensions made to Array.prototype.

Additional notes:

• When run in DEBUG mode, TBone now executes a recursive Object.freeze on anything that is set to a TBone model. This replaces the previous aliasCheck that depended on using JSON serialization to detect changes made behind TBone's back. With Object.freeze, some browsers (e.g. Chrome) will now throw JS exceptions when an attempt is made to modify an object that has been previously passed to TBone. You should fix these errors by _.cloneing the object and making modifications to your own copy. Object.freezeing is disabled when not in DEBUG mode in order to maximize performance.
• Refactored the query function to be much simpler by removing all the array mutations.
• Unit tests are now executed in nodeunit, though this is perhaps one step forward and one step back, as the tests no longer run in the browser. womp womp.
• Significantly increased unit test coverage via Istanbul. Unit tests now cover almost all of the non-debug, non-browser code branches.
• A number of changes were made to the React integration to make it more robust and to eliminate memory leaks.
• Added tbone.isExecuting flag which is set to true while any TBone Scope is executing.
• Fix bug whereby destroyed scopes would still execute if they'd already been queued.

1.0.0

This release includes some breaking changes:

• The TBone internal metrics __isReady__, __ajaxReady__, and __numAjaxInFlight__ have been moved to a new T.metrics model:
  • T('__isReady__') -> T.metrics('isReady')
  • T('__ajaxReady__') -> T.metrics('ajax.isReady')
  • T('__numAjaxInFlight__') -> T.metrics('ajax.numInFlight')
  • Newly added: T.metrics('ajax.modelsInFlight')
• Ajax models now populate themselves with data returned on error responses, i.e. 4xx/5xx. Previously, the models would remain unchanged by error responses.

Major notes:

• TBone's own View and Template modules are now deprecated in favor of using React for the same functionality.
• React integration (in ext/react_init.js) is now bundled with the main TBone build. React integrates seamlessly with TBone; any T-references made in the Component methods componentDidMount, componentWillUpdate, componentDidUpdate, and render will be automagically bound and trigger Component updates as you'd expect.
• Support for TBone views/templates and Backbone models have been moved to the tbone_legacy build.

Additional notes:

• TBone is now built using gulp and uglify, replacing grunt and closure compiler, respectively.
• Since we no longer use closure compiler advanced optimizations, minified TBone source is a little bit larger, but we were also able to remove all the externs files and a large number of unnecessarily-quoted key strings in the source.
• The location fancy model now includes pathname and search in addition to hash, and listens to popstate and pushstate events to try and keep them up-to-date.
• Experimental Angular integration is available to try in ext/init_angular.js. However, development was suspended after the discovery that React integrates much more cleanly with TBone.

0.8.0

• Exposed dataType as a configurable ajax model property, and changed the default from 'text' to 'json'.
• Add log warnings when making ad hoc changes to a bound model.
• Add initial draft Angular support (unstable).
• Add bower support.

0.7.2

• Fix hasViewListener such that references inside T-functions in views wake the models they depend on.
• Add disableSleep function to bound models (for debug mode only).

0.7.1

• No longer suppresses JS errors during Scope execution, either in debug or release mode.
• Set default autorun/T-function priority higher than the default view/model priorities.
• Support auto-rendering subviews of views (you no longer need to explicitly call tbone.render).

0.7.0

• Refactored into three modules: core, core_ext, and full:
  • core includes base/bound models; this is intended for use where minimal footprint is needed (~3K gzipped)
  • core_ext adds async/ajax models, collections, and a few other "fancy" models; this is best for node apps (~4K gzipped)
  • full adds views and live templates (~7K gzipped)
• Add Travis CI support
• Add assumeChanged flag to optimize bound model updates by avoiding recursiveDiff if not needed.

0.6.0

• Refactored build & packaging process to use Grunt.
• Async models now support rolling updates.
• Add tbone.runOnlyOnce and model.readSilent functions to more easily enable stateful behavior when desired.
• No longer fire change events when overwriting a Date with an equivalent Date.
• Bound models' scopes now run detached from any T-function they may be declared in.
• Add model.destroy function to destroy the model's scope.
• Expose tbone.priority and make priority the second (optional) argument to autorun / T(fn, ...).
• Add ajaxReady and numAjaxInFlight live properties.
• Add tbone.showRenderTrees to aid in debugging render performance.
• Fixed many instances of auto-Nameing objects in debug mode.

0.5.0

• Event binding performance significantly improved in some cases.
• TBone now binds scope contexts to property changes instead of arbitrary functions. This enables significant performance scaling improvements with a large number of scopes bound to a model by using the ID of the scope context to index those bindings.
• Fixed a bug where drainQueue would not always eventually execute all pending scopes if there were too many queued.
• Bound models may now take naps by setting sleepEnabled to true.
• Added a kludge to attempt to maintain the window scrollTop position around drainQueue operations. This may help prevent "scrolling up" when content is temporary replaced/re-rendered, modifying temporarily the total body height.
• Added trackable T('isReady') property. This can be used to track whether there are any outstanding tbone model ajax requests.
• (dev only) Alias-checking is now turned off by default. Enable by setting tbone.opts.aliasCheck to true.

0.4.2

• In dev mode, many models now have Name properties automatically set based on the query path to which each model is first assigned.
• Only dots may now be used to separate property names in TBone paths. Previously, colons and spaces were allowed as well.
• Change template root variable to view, and added it to the list of property names not to query-patch when compiling templates.

0.4.1

• Added fancy localStorage collection.

0.4.0

• Split base model into base, bound, async, and ajax models.
• Collections are now indexed by ID by default and do not support simple arrays of models. Added the size live property for reading the current number of models in the collection. For support of a simple list of models, use a model instead.
• Templates now use root.denullText instead of root.queryText to avoid printing non-text values.
• Added model.queryModel to query for models without extracting their data.
• Added model.increment to support counters.
• Added fancy model implementations localStorage and location.
• Reorganized source files into subfolders.

0.3.4

• Added collection.remove
• View root elements now get a class for each of their parent views.
• Added support for use in node.js

0.3.3

• Added support for collections indexed by model ID.
• Fixed tbone.isReady() in cases where XHRs are aborted.
• Refined logic for when to do subqueries.
• Added model.unset

0.3.2

• Added JSON-serialization-based aliasing checks (in debug mode) when setting tbone models.
• Added optional lazy-loading of templates from script tags.

0.3.1

• Added support for <%@ ... %> to pass data from templates into subviews.

0.3

• Backbone is now an optional dependency.
• Added TBone-native models and views.
• T is now a TBone model.

0.2

• Initial release.