netzke-basepack 0.12.9 → 1.0.0.0.pre

data/lib/netzke/{basepack/grid/javascripts → grid/base/client}/advanced_search.js

@@ -1,5 +1,9 @@
 {
-  onSearch: function(el){
+  /**
+   * Handler for the `search` action
+   * @method netzkeOnSearch
+   */
+  netzkeOnSearch: function(el){
     if (this.searchWindow) {
       this.searchWindow.show();
     } else {

data/lib/netzke/{basepack/grid/javascripts/grid.js → grid/base/client/base.js}

@@ -1,3 +1,7 @@
+/**
+ * Client-side code for [Netzke::Grid::Base](http://www.rubydoc.info/github/netzke/netzke-basepack/Netzke/Grid/Base)
+ * @class Netzke.Grid.Base
+ */
 {
   multiSelect: true,
 
@@ -8,17 +12,11 @@
     this.plugins = this.plugins || [];
 
     // Enable filters feature
-    if (this.enableColumnFilters) {
-      this.plugins.push('gridfilters');
-    }
+    this.plugins.push('gridfilters');
 
     // Normalize columns. Extract data fields and meta column.
     this.netzkeProcessColumns();
 
-    this.netzkeBuildModel('Ext.data.Model');
-
-    delete this.fields;
-
     // Prepare column model config with columns in the correct order; columns out of order go to the end.
     var colModelConfig = [];
     var columns = this.columns;
@@ -37,17 +35,16 @@
 
     this.columns.items = colModelConfig;
 
-    // data store
     this.store = this.netzkeBuildStore();
 
     // Cell editing
-    if (!this.prohibitUpdate && this.enableEditInline) {
+    if (!this.prohibitUpdate && this.editInline) {
       this.plugins.push(Ext.create('Ext.grid.plugin.CellEditing', {pluginId: 'celleditor'}));
     }
 
     // Toolbar
     this.dockedItems = this.dockedItems || [];
-    if (this.enablePagination) {
+    if (this.paging) {
       this.dockedItems.push({
         xtype: 'pagingtoolbar',
         dock: 'bottom',
@@ -55,7 +52,7 @@
           'beforechange': this.disableDirtyPageWarning ? {} : {fn: this.netzkeBeforePageChange, scope: this}
         },
         store: this.store,
-        items: this.bbar && ["-"].concat(this.bbar) // append the passed bbar
+        items: this.bbar && ["-"].concat(this.bbar)
       });
     } else if (this.bbar) {
       this.dockedItems.push({
@@ -71,30 +68,10 @@
 
     // Context menu
     if (this.contextMenu) {
-      this.on('itemcontextmenu', this.onItemContextMenu, this);
-    }
-
-    // Disabling/enabling editInForm button according to current selection
-    if (this.enableEditInForm && !this.prohibitUpdate) {
-      this.getSelectionModel().on('selectionchange', function(selModel, selected){
-        var disabled;
-        if (selected === undefined || selected.length === 0) { // empty?
-          disabled = true;
-        } else {
-          // Disable "edit in form" button if new record is present in selection
-          Ext.each(selected, function(r){
-            if (r.isNew) { disabled = true; return false; }
-          });
-        };
-        this.actions.editInForm.setDisabled(disabled);
-      }, this);
+      this.on('itemcontextmenu', this.netzkeOnItemContextMenu, this);
     }
 
-    // Process selectionchange event to enable/disable actions
-    this.getSelectionModel().on('selectionchange', function(selModel){
-      if (this.actions.del) this.actions.del.setDisabled(!selModel.hasSelection() || this.prohibitDelete);
-      if (this.actions.edit) this.actions.edit.setDisabled(selModel.getCount() != 1 || this.prohibitUpdate);
-    }, this);
+    this.netzkeSetActionEvents();
 
     // When starting editing as assocition column, pre-load the combobox store from the meta column, so that we don't see the real value of this cell (the id of the associated record), but rather the associated record by the configured method.
     this.on('beforeedit', function(editor, e){
@@ -124,19 +101,14 @@
     }, this);
 
     if(this.getStore().autoSync){
-      // if autoSync is enabled, cancel event and call onApply() instead
+      // if autoSync is enabled, cancel event and call netzkeOnApply() instead
       this.getStore().on('beforesync', function(){
-        this.onApply();
+        this.netzkeOnApply();
         return false;
       }, this);
     }
 
-    // If edit in form is enabled, but edit in cell is disabled, change double-click to edit in form
-    if (this.enableEditInForm && !this.enableEditInline) {
-      this.on('itemdblclick', function(view, record) {
-        this.onEditInForm();
-      }, this);
-    }
+    this.on('itemdblclick', this.netzkeHandleItemdblclick, this);
 
     // Remember grid selection on reloads
     if(this.netzkeRememberSelection && this.netzkeRestoreSelection){
@@ -145,16 +117,12 @@
     }
   },
 
+  /**
+   * @method netzkeBuildStore
+   * @return {Ext.data.Store} Pre-configured instance of the store
+   */
   netzkeBuildStore: function() {
-    var store = Ext.create('Ext.data.Store', Ext.apply({
-      model: Netzke.modelName(this.id),
-      proxy: this.netzkeBuildProxy(),
-      pruneModifiedRecords: true,
-      remoteSort: true,
-      remoteFilter: true,
-      pageSize: this.rowsPerPage,
-      autoLoad: true
-    }, this.dataStore));
+    var store = Ext.create('Ext.data.Store', this.netzkeStoreConfig());
 
     delete this.dataStore;
 
@@ -165,17 +133,57 @@
     return store;
   },
 
+  /**
+   * @method netzkeStoreConfig
+   * @return {Object} Configuration for the store
+   */
+  netzkeStoreConfig: function(){
+    var defaults = {
+      proxy: this.netzkeBuildProxy(),
+      fields: this.fields,
+      pruneModifiedRecords: true,
+      remoteSort: true,
+      remoteFilter: true,
+      buffered: !this.paging
+    };
+
+    if (!this.paging) defaults.pageSize = 300;
+
+    return Ext.apply({}, this.storeConfig, defaults);
+  },
+
+  /**
+   * @method netzkeBuildProxy
+   * @return {Netzke.Grid.Proxy} Instance of the data proxy
+   */
   netzkeBuildProxy: function() {
-    return Ext.create('Netzke.classes.Basepack.Grid.Proxy', {
+    return Ext.create('Netzke.Grid.Proxy', this.netzkeProxyConfig());
+  },
+
+  /**
+   * @method netzkeProxyConfig
+   * @return {Object} configuration for data proxy
+   */
+  netzkeProxyConfig: function(){
+    return {
       reader: this.netzkeBuildReader(),
       grid: this
-    });
+    }
   },
 
+  /**
+   * @method netzkeBuildReader
+   * @return {Netzke.Grid.ArrayReader} Instance of the data reader
+   */
   netzkeBuildReader: function() {
-    return Ext.create('Netzke.classes.Basepack.Grid.ArrayReader');
+    return Ext.create('Netzke.Grid.ArrayReader');
   },
 
+  /**
+   * Called before user navigates from page in the grid
+   * @method netzkeBeforePageChange
+   * @return {Boolean} Browser confirmation popup result
+   */
   netzkeBeforePageChange: function(){
     var store = this.getStore();
     if (store.getNewRecords().length > 0 || store.getModifiedRecords().length > 0) {

data/lib/netzke/{basepack/grid/javascripts → grid/base/client}/extensions.js

@@ -1,8 +1,10 @@
 /**
- * Extended Ext.data.reader.Array, which can handle commands from the endpoint, and fires the 'endpointcommands' event
+ * Data reader which can handle commands from the endpoint, and fires the 'endpointcommands' event
  * when commands are present in the endpoint response
+ * @class Netzke.Grid.ArrayReader
+ * @extends Ext.data.reader.Array
  */
-Ext.define('Netzke.classes.Basepack.Grid.ArrayReader', {
+Ext.define('Netzke.Grid.ArrayReader', {
   extend: 'Ext.data.reader.Array',
   config: {
     rootProperty: 'data',
@@ -19,7 +21,12 @@ Ext.define('Netzke.classes.Basepack.Grid.ArrayReader', {
   }
 });
 
-Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
+/**
+ * Data proxy that talks to Grid's endpoints.
+ * @extends Ext.data.proxy.Server
+ * @class Netzke.Grid.Proxy
+ */
+Ext.define('Netzke.Grid.Proxy', {
   extend: 'Ext.data.proxy.Server',
 
   batch: function(options) {
@@ -30,10 +37,11 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
     }
   },
 
+  // NOTE: not used, as delete is being called directly from the grid
   destroy: function(op, callback, scope) {
     var data = Ext.Array.map(op.getRecords(), function(r) { return r.getData().id; });
     var store = this.grid.getStore();
-    this.grid.serverDelete(data, function(res){
+    this.grid.server.destroy(data, function(res){
       var errors = [];
       for (var id in res) {
         var error;
@@ -51,7 +59,7 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
       store.commitChanges();
 
       if (errors.length > 0) {
-        this.grid.netzkeFeedback([errors]);
+        this.grid.netzkeNotify(errors);
       }
 
       this.grid.getStore().load();
@@ -63,7 +71,7 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
     var records = op.getRecords(),
         data = Ext.Array.map(records, function(r) { return Ext.apply(r.getData(), {internal_id: r.internalId}); });
 
-    this.grid.serverCreate(data, function(res) {
+    this.grid.server.create(data, function(res) {
       var errors = [];
       Ext.each(records, function(r) {
         var rid = r.internalId,
@@ -80,7 +88,7 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
       if (errors.length == 0) {
         this.grid.getStore().load();
       } else {
-        this.grid.netzkeFeedback(errors);
+        this.grid.netzkeNotify(errors);
       }
 
     }, this);
@@ -89,7 +97,7 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
   update: function(op, callback, scope) {
     var data = Ext.Array.map(op.getRecords(), function(r) { return r.getData(); });
 
-    this.grid.serverUpdate(data, function(res) {
+    this.grid.server.update(data, function(res) {
       var errors = [];
       Ext.each(op.records, function(r) {
         var rid = r.getId(),
@@ -106,13 +114,13 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
       if (errors.length == 0) {
         this.grid.getStore().load();
       } else {
-        this.grid.netzkeFeedback(errors);
+        this.grid.netzkeNotify(errors);
       }
     }, this);
   },
 
   read: function(operation, callback, scope) {
-    this.grid.serverRead(this.paramsFromOperation(operation), function(res) {
+    this.grid.server.read(this.paramsFromOperation(operation), function(res) {
       this.processResponse(true, operation, {}, res, callback, scope);
     }, this);
     return {};
@@ -138,9 +146,7 @@ Ext.define('Netzke.classes.Basepack.Grid.Proxy', {
   }
 });
 
-/**
- * A fix for CheckColumn
- */
+// Fix for CheckColumn
 Ext.override(Ext.ux.CheckColumn, {
   processEvent: function(type) {
     // by returning true, we'll allow event propagation, so it reacts similarly to other columns

data/lib/netzke/{basepack/grid/javascripts → grid/base/client}/remember_selection.js

@@ -23,4 +23,3 @@
     this.getSelectionModel().select(newRecordsToSelect);
   }
 }
-

data/lib/netzke/grid/client.rb

@@ -0,0 +1,8 @@
+module Netzke
+  module Grid
+    module Client
+      extend ActiveSupport::Concern
+
+    end
+  end
+end

data/lib/netzke/grid/components.rb

@@ -0,0 +1,55 @@
+module Netzke
+  module Grid
+    # Child components for Grid and Tree
+    module Components
+      extend ActiveSupport::Concern
+
+      included do
+        component :add_window do |c|
+          configure_form_window(c)
+          c.title = I18n.t('netzke.grid.base.add_record', model: model.model_name.human)
+          c.items = [:add_form]
+          c.form_config.record = model.new(columns_default_values)
+          c.excluded = !allowed_to?(:create)
+        end
+
+        component :edit_window do |c|
+          configure_form_window(c)
+          c.title = I18n.t('netzke.grid.base.edit_record', model: model.model_name.human)
+          c.items = [:edit_form]
+          c.excluded = !allowed_to?(:update)
+        end
+
+        component :multiedit_window do |c|
+          configure_form_window(c)
+          c.title = I18n.t('netzke.grid.base.edit_records', models: model.model_name.human.pluralize)
+          c.items = [:multiedit_form]
+          c.excluded = !allowed_to?(:update)
+        end
+
+        component :search_window do |c|
+          c.klass = Basepack::SearchWindow
+          c.model = config.model
+          c.fields = attributes_for_search
+        end
+      end
+
+      def configure_form_window(c)
+        c.klass = Basepack::RecordFormWindow
+        c.form_config = ActiveSupport::OrderedOptions.new
+        configure_form(c.form_config)
+      end
+
+      def configure_form(c)
+        shared_config = %w(mode persistent_config strong_values).reduce({}) do |r, m|
+          r.merge!(m.to_sym => config.send(m))
+        end
+
+        c.model = model
+        c.merge!(shared_config)
+        c.attribute_overrides = attribute_overrides
+        c.items = form_items
+      end
+    end
+  end
+end

data/lib/netzke/grid/configuration.rb

@@ -0,0 +1,72 @@
+module Netzke
+  module Grid
+    # Overridable methods related to configuration of Grid. For example, to add a custom action to the end of the grid's
+    # bbar, you can do:
+    #
+    #     def bbar
+    #       super + [:my_action]
+    #     end
+    module Configuration # WTF: naming it Config causes troubles in 1.9.3
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def server_side_config_options
+          super + [:scope]
+        end
+      end
+
+      def bbar
+        config.has_key?(:bbar) ? config[:bbar] : default_bbar
+      end
+
+      def default_bbar
+        [].tap do |bbar|
+          bbar << :add if has_add_action?
+          bbar << :edit if has_edit_action?
+          bbar << :apply if has_apply_action?
+          bbar << :delete if has_delete_action?
+          bbar << :search if has_search_action?
+        end
+      end
+
+      def context_menu
+        config.has_key?(:context_menu) ? config.context_menu : default_context_menu
+      end
+
+      def default_context_menu
+        [].tap do |menu|
+          menu << :edit if has_edit_action?
+          menu << :delete if has_delete_action?
+        end
+      end
+
+      def tools
+        config.has_key?(:tools) ? config.tools : default_tools
+      end
+
+      def default_tools
+        [{ type: :refresh, handler: f(:netzke_on_refresh_tool) }]
+      end
+
+      def configure_client(c)
+        super
+        c.title ||= model.name.pluralize
+        c.columns = {items: js_columns}
+        c.columns_order = columns_order
+        c.pri = model_adapter.primary_key
+        if c.default_filters
+          populate_columns_with_filters(c)
+        end
+      end
+
+      def validate_config(c)
+        raise ArgumentError, "Grid requires a model" if model.nil?
+        c.paging = true if c.edit_inline
+        c.tools = tools
+        c.bbar = bbar
+        c.context_menu = context_menu
+        super
+      end
+    end
+  end
+end