netzke-basepack 0.12.9 → 1.0.0.0.pre

data/CHANGELOG.md

@@ -1,44 +1,75 @@
-# 0.12.9 - 2015-12-06
-* Grid: warn the user at an attempt to change the page when there are unapplied changes;
-  disable the warning by setting `disable_dirty_page_warning` to `true`.
-* Implement `scope` option for `Tree`
-
-# 0.12.8 - 2015-09-11
-* Fix regression in Tree that would (again) prevent snake_cased columns from being displayed
-
-# 0.12.7 - 2015-08-09
-* Fix the strong_default_attrs option support
-* Support column action's isDisabled option
-* Store tree nodes expand/collapse state
-
-# 0.12.6 - 2015-07-11
-* Regression: show cell editor on adding/editing a record in grid
-* Fix occasional autoload-related problems
-
-# 0.12.5 - 2015-07-07
-* Fix potential problems caused by changing window.id on deleting grid records
-
-# 0.12.4 - 2015-06-22
-* Remove (broken) `load_inline_data` option
-
-# 0.12.3 - 2015-06-16
-* Fix bug preventing primary key column from being overridden in a specific case
-* Fix grid freeze when `prohibit_read` is set to true
-
-# 0.12.2 - 2015-06-06
-* Fix exception when nesting a grid with action column
-* Fix Tree for Ruby 1.9.3
-
-# 0.12.1 - 2015-05-31
-* New component: Tree
-* Fix filtering by association when associtaion method is integer
-* Fix decimal and float columns in extended search form
-* Fix showing 0-value in association shown by integer
-* Fix extended panel browser exceptions
-* Fix showing null values as 0 in int columns
-
-# 0.12.0 - 2015-03-18
-* ExtJS 5
-* New component: DynamicTabPanel
-
-Please check [0-11](https://github.com/netzke/netzke-basepack/blob/0-11/CHANGELOG.md) for previous changes.
+### Components changed/renamed
+
+*   Base classes of main componens have been renamed from `Netzke::Basepack::{Grid|Form|Tree|Window|Viewport}` to `Netzke::{Grid|Form|Tree|Window|Viewport}::Base`.
+
+*   `Netzke::Basepack::TapPanel` and `Netzke::Basepack::Accordion` have been removed. The only purpose for them was dynamic loading of child components, which didn't prove that useful.
+
+### Form, Grid, Tree
+
+#### Breaking changes
+
+*   `strong_default_attrs` config option has been renamed to `strong_values`.
+
+*   `attr_type` config option for columns/fields has been renamed to `type`.
+
+*   The new `attribute` DSL method and the accompanying `attribute_overrides` config option allow reconfiguring the way specific model attributes are presented by both the grid and the form. The `column` DSL method has been left for configuring what's specific for a column. For details, see [Netzke::Basepack::Attributes](http://www.rubydoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Attributes).
+
+### Form
+
+#### Breaking changes
+
+*   The `netzkeSubmit` and `netzkeLoad` endpoints have been renamed to `submit` and `load` respectively; keep this in mind if you override them in your app.
+
+### Grid
+
+#### Breaking changes
+
+*   Column/field label for association no longer includes association method name by default. For example, for
+    `author__name` attribute it'll now be "Author", not "Author  name".
+
+*   `preconfigure_record_window` has been renamed to `configure_form_window`
+
+*   The `default_fields_for_forms` method has been renamed to `default_form_items`.
+
+*   The `data_store` config option has been renamed to `store_config`.
+
+*   Permissions configuration got consolidated into single `permissions` config option. See [Netzke::Grid::Base](http://www.rubydoc.info/github/netzke/netzke-basepack/Netzke/Grid/Base)
+
+*   The `del` action has been renamed to `delete`.
+
+*   Columns configuration (by using the `Grid.column` DSL method, or the `columns` configuration option) no longer has effect on corresponding form fields. Use the new `attribute` DSL method or the `attribute_overrides` config option (see above) to set the common configuration option for both column and form field.
+
+*   Virtual columns declared with the `column` DSL method are no longer automatically appended to the end of the column
+    list; use the `columns` config option or override the `Grid#columns` method to explicitely list them.
+
+*   The endpoints dropped their prefix `server`; additionally, `serverDelete` has become `destroy`; keep this in mind if you override endpoints in your app.
+
+*   All scope-related configs (including those of the columns) now only accept a Proc object.
+
+*   Class-level configuration is gone (its sole purpose was to allow reducing the amount of generated JS code - not worth it).
+
+*   `enable_edit_in_form`, `enable_edit_inline`, `enable_pagination` options are gone.
+
+*   `enable_extended_search` option is gone.
+
+#### Non-breaking changes
+
+*   By default, Grid now uses form to add/edit records. Set `edit_inline` to true to use inline editing when possible (implicitly sets `paging` to `true`).
+
+*   By default, Grid now handles large number of records by using a buffered store (allows for "infinite scrolling"). Set `paging` to `true` if you want pagination instead.
+
+*   The toolbar was reduced to 'add', 'edit', 'delete', and 'search' buttons by default. Additionally, the 'apply' button is added when `edit_inline` is set to `true`.
+
+*   Buttons previously disabled due to permissions are now not added to the bottom bar alltogether.
+
+#### Added
+
+*   Override new `configure_form` method to specify extra configuration to the forms
+
+*   Warn the user at an attempt to change the page when there are unapplied changes; disable the warning by setting `disable_dirty_page_warning` to `true`.
+
+#### Bugfixes
+
+*   Multiediting of reconds now works properly with boolean fields (a tristate selector was implemented).
+
+Please check [0-12](https://github.com/netzke/netzke-basepack/blob/0-12/CHANGELOG.md) for previous changes.

data/Gemfile

@@ -8,6 +8,7 @@ gem 'yard'
 gem 'rake'
 
 gem 'awesome_nested_set'
+gem 'carrierwave'
 
 group :test do
   gem 'rspec'
@@ -22,6 +23,7 @@ group :development, :test do
   gem 'web-console', '~> 2.0'
   # gem 'spring' # troubles...
   gem 'pry-rails'
-  gem 'netzke-core', github: 'netzke/netzke-core', branch: '0-12'
-  gem 'netzke-testing', github: 'netzke/netzke-testing', branch: '0-12'
+  gem 'netzke-core', github: 'netzke/netzke-core', branch: 'master'
+  gem 'netzke-testing', github: 'netzke/netzke-testing', branch: 'master'
+  gem 'faker'
 end

data/LICENSE

@@ -1,7 +1,3 @@
-Copyright (c) 2013 Max Gorin
+Copyright (c) 2009-2015 Good Bit Labs Limited
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+GPLv3 License: http://www.gnu.org/licenses/gpl-3.0.en.html

data/README.md

@@ -1,37 +1,37 @@
-# Netzke Basepack [![Build Status](https://travis-ci.org/netzke/netzke-basepack.png?branch=master)](https://travis-ci.org/netzke/netzke-basepack) [![Code Climate](https://codeclimate.com/github/netzke/netzke-basepack.png)](https://codeclimate.com/github/netzke/netzke-basepack)
+# Netzke Basepack [![Build Status](https://travis-ci.org/netzke/netzke-basepack.svg?branch=master)](https://travis-ci.org/netzke/netzke-basepack) [![Code Climate](https://codeclimate.com/github/netzke/netzke-basepack/badges/gpa.svg)](https://codeclimate.com/github/netzke/netzke-basepack)
 
 [RDocs](http://rdoc.info/github/netzke/netzke-basepack)
 
 A pack of pre-built [Netzke](http://netzke.org) components that can be used as building blocks for your webapps.
 
 *Notes on versioning:*
-* [![Gem Version](https://badge.fury.io/rb/netzke-basepack.png)](http://badge.fury.io/rb/netzke-basepack) is the latest *released* version
-* for the version under development (master), check [version.rb](https://github.com/netzke/netzke-core/blob/master/lib/netzke/core/version.rb)
-* for other versions, check corresponding [branches](https://github.com/netzke/netzke-core/branches)
+
+* The latest *released* version is: [![Gem Version](https://badge.fury.io/rb/netzke-basepack.svg)](https://badge.fury.io/rb/netzke-basepack)
+* The version under development (master): [version.rb](https://github.com/netzke/netzke-core/blob/master/lib/netzke/core/version.rb)
+* For other versions check corresponding [branches](https://github.com/netzke/netzke-core/branches)
 
 ## Included components
 
 Basepack includes the following components:
 
-* [Grid](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Grid) - a grid panel with a thick bag of features
-* [Tree](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Tree) - a tree panel with features similar to the Grid
-* [Form](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Form) - a form panel with automatic binding of fields
-* [TabPanel](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/TabPanel) - a tab panel with support for lazy loading of nested components
-* [Accordion](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Accordion) - an accordion panel with support for lazy loading of nested components
-* [Window](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Window) - a window which stores its size, position, and maximized state
+* [Grid](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Grid/Base) - a grid panel with a thick bag of features
+* [Tree](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Tree/Base) - a tree panel with features similar to the Grid
+* [Form](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Form/Base) - a form panel with automatic binding of fields
+* [Window](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Window/Base) - a window which stores its size, position, and maximized state
+* [Viewport](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Viewport/Base) - a full-window component usually used as one-page application base
 
 Besides, Basepack implements:
 
 * persistence of region sizes and collapsed states of an arbitrary component that uses
-[border layout](http://docs.sencha.com/ext-js/4-1/#!/api/Ext.layout.container.Border) (see [ItemPersistence](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/ItemPersistence))
+Ext's border layout (see [ItemPersistence](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/ItemPersistence))
 * [GridLiveSearch](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/GridLiveSearch) - a plugin that allows
 enhancing any grid with live search functionality
 
 ## Requirements
 
-* Ruby > 1.9.3
+* Ruby >= 1.9.3
 * Rails ~> 4.2.0
-* Ext JS = 5.1.0
+* Ext JS = 5.1.1
 
 ## Installation
 
@@ -48,11 +48,12 @@ For the "edge" stuff, instruct bundler to get the gem straight from GitHub:
 Embed a basepack component into a view as any other Netzke component, e.g.:
 
 ```erb
-<%= netzke :books, class_name: 'Netzke::Basepack::Grid', model: 'Book' %>
+<%= netzke :books, class_name: 'Netzke::Grid::Base', model: 'Book' %>
 ```
 
-For more examples, see http://netzke-demo.herokuapp.com ([source code](https://github.com/netzke/netzke-demo)), and look
-into `spec/rails_app`.
+This will give you a grid with all the many features, configured to use your `Book` model.
+
+For detailed examples with code see http://demo.netzke.org
 
 ## Running tests
 
@@ -66,13 +67,13 @@ good source of concise, focused examples. After starting the application, access
 
     http://localhost:3000/netzke/components/{name of the component's class}
 
-For example [http://localhost:3000/netzke/components/BookGrid](http://localhost:3000/netzke/components/BookGrid)
+For example [http://localhost:3000/netzke/components/Grid::Books](http://localhost:3000/netzke/components/Grid::Books)
 
 To run all the tests (from the gem's root):
 
     $ rake
 
-*Sourcing Ext JS files from Sencha CDN is broken in Basepack at the moment*.
+*Sourcing Ext JS files from Sencha CDN is not possible with Basepack at the moment*.
 
 ## Using ORM other than ActiveRecord
 
@@ -94,15 +95,12 @@ application.
 
 Help developing Netzke by submitting a pull request when you think others can benefit from it.
 
-If you feel particularily generous, you can donate a couple of bucks weekly at [Gratipay](https://www.gittip.com/mxgrn/).
+If you feel particularily generous, you can donate a couple of bucks weekly at [Gratipay](https://gratipay.com/~mxgrn/).
 
 ## Useful links
 * [Project website](http://netzke.org)
-* [Live-demo](http://netzke-demo.herokuapp.com)
+* [Live demo](http://demo.netzke.org)
 * [Twitter](http://twitter.com/netzke) - latest news about the framework
 
 ---
-Copyright (c) 2008-2015 [Max Gorin](https://twitter.com/mxgrn), released under the MIT license (see LICENSE).
-
-**Note** that Ext JS is licensed [differently](http://www.sencha.com/products/extjs/license/), and you may need to
-purchase a commercial license in order to use it in your projects.
+Copyright (c) 2009-2015 [Good Bit Labs](http://goodbitlabs.com/), released under the GPLv3 license

data/javascripts/basepack.js

@@ -26,14 +26,6 @@ Ext.override(Ext.view.BoundList, {
   },
 });
 
-Netzke.isModelDefined = function(name) {
-  return !!(Netzke.models || {})[name];
-};
-
-Netzke.modelName = function(name){
-  return "Netzke.models." + name;
-};
-
 // Fix 2-digit precision in the numeric filter
 Ext.define('Ext.grid.filters.filter.Number', {
   override: 'Ext.grid.filters.filter.Number',

data/javascripts/{columns.js → grid/columns.js}

@@ -1,84 +1,73 @@
 /* Shared column-related functionality, used in Tree and Grid */
-Ext.define("Netzke.mixins.Basepack.Columns", {
-  netzkeBuildModel: function(modelClass) {
-    if (!Netzke.isModelDefined(this.id)) {
-      Ext.define(Netzke.modelName(this.id), {
-        extend: modelClass,
-        idProperty: this.pri, // Primary key
-        fields: this.fields
-      });
-    }
-    delete this.pri;
-  },
-
+Ext.define("Netzke.Grid.Columns", {
   netzkeProcessColumns: function() {
     this.fields = [];
 
     // Run through columns and set up different configuration for each
-    Ext.each(this.columns.items, function(c, i){
-
+    Ext.each(this.columns.items, function(c){
       this.netzkeNormalizeRenderer(c);
+      this.fields.push(this.netzkeExtractFieldConfig(c));
 
-      // Build the field configuration for this column
-      var fieldConfig = {name: c.name, defaultValue: c.defaultValue, allowNull: true};
+      // We will not use meta columns as actual columns (not even hidden) - only to create the records
+      if (!c.meta) {
+        this.netzkeExtendColumnConfig(c);
+      }
+    }, this);
 
-      if (c.name !== 'meta') fieldConfig.type = this.netzkeFieldTypeForAttrType(c.attrType); // field type (grid editors need this to function well)
+    // Now reorder columns as specified in this.columnsOrder
+    this.orderColumns();
+  },
 
-      if (c.attrType == 'datetime') {
-        fieldConfig.dateFormat = 'Y-m-d H:i:s'; // set the format in which we receive datetime from the server (so that the model can parse it)
+  netzkeExtractFieldConfig: function(c){
+    // Build the field configuration for this column
+    var fieldConfig = {name: c.name, defaultValue: c.defaultValue, allowNull: true};
 
-        // While for 'date' columns the renderer is set up automatically (through using column's xtype), there's no appropriate xtype for our custom datetime column.
-        // Thus, we need to set the renderer manually.
-        // NOTE: for Ext there's no distinction b/w date and datetime; date fields can include time.
-        if (!c.renderer) {
-          // format in which the data will be rendered; if c.format is nil, Ext.Date.defaultFormat extended with time will be used
-          c.renderer = Ext.util.Format.dateRenderer(c.format || Ext.Date.defaultFormat + " H:i:s");
-        }
-      };
+    if (!c.meta) fieldConfig.type = this.netzkeFieldTypeForAttrType(c.type); // field type (grid editors need this to function well)
 
-      if (c.attrType == 'date') {
-        // If no dateFormat given for date attrType, Timezone translation can subtract zone offset from 00:00:00 causing previous day.
-        fieldConfig.dateFormat = 'Y-m-d';
-      };
+    if (c.type == 'datetime') {
+      fieldConfig.dateFormat = 'Y-m-d H:i:s'; // set the format in which we receive datetime from the server (so that the model can parse it)
+    };
 
-      // because checkcolumn doesn't care about editor (not) being set, we need to explicitely set readOnly here
-      if (c.xtype == 'checkcolumn' && !c.editor) {
-        c.readOnly = true;
-      }
+    if (c.type == 'date') {
+      // If no dateFormat given for date type, Timezone translation can subtract zone offset from 00:00:00 causing previous day.
+      fieldConfig.dateFormat = 'Y-m-d';
+    };
 
-      this.fields.push(fieldConfig);
+    return fieldConfig;
+  },
 
-      // We will not use meta columns as actual columns (not even hidden) - only to create the records
-      if (c.meta) {
-        this.metaColumn = c;
-        return;
-      }
+  netzkeExtendColumnConfig: function(c){
+    // Set rendeder for association columns (the one displaying associations by the specified method instead of id)
+    if (c.assoc) {
+      // Editor for association column
+      if (c.editor) c.editor = Ext.apply({ name: c.name, netzkeParent: this }, c.editor);
 
-      // Set rendeder for association columns (the one displaying associations by the specified method instead of id)
-      if (c.assoc) {
-        // Editor for association column
-        if (c.editor) c.editor = Ext.apply({ name: c.name }, c.editor);
+      // Renderer for association column
+      this.netzkeNormalizeAssociationRenderer(c);
+    }
 
-        // Renderer for association column
-        this.netzkeNormalizeAssociationRenderer(c);
-      }
+    // extend editor with editorConfig passed from the server
+    if (c.editor) {
+      Ext.apply(c.editor, (c.editorConfig || {}), {selectOnFocus: true});
+    }
 
-      if (c.editor) {
-        Ext.applyIf(c.editor, {selectOnFocus: true, netzkeParent: this});
-      }
+    // Setting the default filter type
+    if (c.filterable != false && !c.filter) {
+      c.filter = {type: this.netzkeFilterTypeForAttrType(c.type)};
+    }
 
-      // Setting the default filter type
-      if (c.filterable != false && !c.filter) {
-        c.filter = {type: this.netzkeFilterTypeForAttrType(c.attrType)};
+    if (c.type == 'datetime') {
+      // While for 'date' columns the renderer is set up automatically (through using column's xtype), there's no appropriate xtype for our custom datetime column.
+      // Thus, we need to set the renderer manually.
+      // NOTE: for Ext there's no distinction b/w date and datetime; date fields can include time.
+      if (!c.renderer) {
+        // format in which the data will be rendered; if c.format is nil, Ext.Date.defaultFormat extended with time will be used
+        c.renderer = Ext.util.Format.dateRenderer(c.format || Ext.Date.defaultFormat + " H:i:s");
       }
+    };
 
-      // setting dataIndex
-      c.dataIndex = c.name;
-
-    }, this);
-
-    // Now reorder columns as specified in this.columnsOrder
-    this.orderColumns();
+    // setting dataIndex
+    c.dataIndex = c.name;
   },
 
   // Build column model config with columns in the correct order; columns out of order go to the end.
@@ -101,7 +90,7 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
     // We don't need original columns any longer
     delete this.columns.items;
 
-    // ... instead, define own column model
+    // ... instead, use own column model
     this.columns.items = colModelConfig;
   },
 
@@ -150,7 +139,7 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
   */
   netzkeNormalizeAssociationRenderer: function(c) {
     var passedRenderer = c.renderer, // renderer we got from netzkeNormalizeRenderer
-        metaData, assocValue;
+        assocValue;
     c.scope = this;
     c.renderer = function(value, a, r, ri, ci, store, view){
       var column = view.headerCt.items.getAt(ci),
@@ -160,8 +149,7 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
 
       if (recordFromStore) {
         renderedValue = recordFromStore.get('text');
-      } else if (metaData = r.get('meta')) {
-        assocValue = metaData.associationValues[c.name];
+      } else if ((assocValue = (r.get('association_values') || {})[c.name]) !== undefined) {
         renderedValue = (assocValue == undefined) ? c.emptyText : assocValue;
       } else {
         renderedValue = value;
@@ -177,19 +165,19 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
       cols.push({name: c.name, width: c.width, hidden: c.hidden});
     });
 
-    this.serverSaveColumns(cols);
+    this.server.saveColumns(cols);
   },
 
   // Tries editing the first editable (i.e. not hidden, not read-only) sell
   netzkeTryStartEditing: function(r){
     var column = Ext.Array.findBy(this.columns, function(c){
-      return !(c.hidden || c.readOnly || c.attrType == 'boolean')
+      return !(c.hidden || c.readOnly || c.type == 'boolean')
     });
 
     if (column) {this.getPlugin('celleditor').startEdit(r, column);}
   },
 
-  netzkeFilterTypeForAttrType: function(attrType){
+  netzkeFilterTypeForAttrType: function(type){
     var map = {
       integer   : 'number',
       decimal   : 'number',
@@ -200,10 +188,10 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
       text      : 'string',
       'boolean' : 'boolean'
     };
-    return map[attrType] || 'string';
+    return map[type] || 'string';
   },
 
-  netzkeFieldTypeForAttrType: function(attrType){
+  netzkeFieldTypeForAttrType: function(type){
     var map = {
       integer   : 'int',
       decimal   : 'float',
@@ -214,6 +202,6 @@ Ext.define("Netzke.mixins.Basepack.Columns", {
       text      : 'string',
       'boolean' : 'boolean'
     };
-    return map[attrType] || 'string';
+    return map[type] || 'string';
   }
 });