netzke-basepack 0.7.7 → 0.8.0

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

@@ -3,7 +3,7 @@
     if (this.searchWindow) {
       this.searchWindow.show();
     } else {
-      this.loadNetzkeComponent({name: 'search_form', callback: function(win){
+      this.netzkeLoadComponent('search_window', {callback: function(win){
         this.searchWindow = win;
         win.show();
 

data/lib/netzke/basepack/{grid_panel → grid}/javascripts/edit_in_form.js

@@ -3,7 +3,7 @@
     var selModel = this.getSelectionModel();
     if (selModel.getCount() > 1) {
       var recordId = selModel.selected.first().getId();
-      this.loadNetzkeComponent({name: "multi_edit_form",
+      this.netzkeLoadComponent("multi_edit_window", {
         params: {record_id: recordId},
         callback: function(w){
           w.show();
@@ -25,7 +25,7 @@
         }, scope: this});
     } else {
       var recordId = selModel.selected.first().getId();
-      this.loadNetzkeComponent({name: "edit_form",
+      this.netzkeLoadComponent("edit_window", {
         params: {record_id: recordId},
         callback: function(w){
           w.show();
@@ -39,7 +39,7 @@
   },
 
   onAddInForm: function(){
-    this.loadNetzkeComponent({name: "add_form", callback: function(w){
+    this.netzkeLoadComponent("add_window", {callback: function(w){
       w.show();
       w.on('close', function(){
         if (w.closeRes === "ok") {

data/lib/netzke/basepack/{grid_panel → grid}/javascripts/event_handling.js

@@ -113,6 +113,9 @@
   },
 
   onColumnMove: function(ct, cl, oldIndex, newIndex){
+    // when moving a column forwards, the new index appears to be 1 too high; a bug in Ext JS? Fixing.
+    if (newIndex > oldIndex) newIndex--;
+
     this.moveColumn({
       old_index: oldIndex,
       new_index: newIndex
@@ -138,7 +141,7 @@
     var ids = [];
     // collect records ids
     Ext.each(records, function(r){ids.push(r.id)});
-    // call GridPanel's API
+    // call Grid's API
     this.moveRows({ids: Ext.encode(ids), new_index: newIndex});
   },
 
@@ -169,7 +172,7 @@
 
   // Not a very clean approach to clean-up. The problem is that this way the advanced search functionality stops being really pluggable. With Ext JS 4 find the way to make it truely so.
   onDestroy: function(){
-    Netzke.classes.Basepack.GridPanel.superclass.onDestroy.call(this);
+    this.callParent();
 
     // Destroy the search window (here's the problem: we are not supposed to know it exists)
     if (this.searchWindow) {

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

@@ -8,92 +8,28 @@
   multiSelect: true,
 
   initComponent: function(){
-    var metaColumn;
-    var fields = []; // field configs for the underlying data model
-
     this.plugins = this.plugins || [];
     this.features = this.features || [];
 
     // Enable filters feature
-    this.features.push({
-      encode: true,
-      ftype: 'filters'
-    });
-
-    // Run through columns and set up different configuration for each
-    Ext.each(this.columns, function(c, i){
-
-      this.normalizeRenderer(c);
-
-      // Build the field configuration for this column
-      var fieldConfig = {name: c.name, defaultValue: c.defaultValue, useNull: true}; // useNull is needed to not convert nils to 0 in associations!
-
-      if (c.name !== 'meta') fieldConfig.type = this.fieldTypeForAttrType(c.attrType); // field type (grid editors need this to function well)
-
-      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)
-
-        // 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");
-        }
-      };
-
-      fields.push(fieldConfig);
-
-      // We will not use meta columns as actual columns (not even hidden) - only to create the records
-      if (c.meta) {
-        metaColumn = c;
-        return;
-      }
-
-      // if comboboxOptions are provided, we render a combobox instead of textfield
-      // if (c.comboboxOptions && c.editor.xtype === "textfield") {
-      //   c.editor = {xtype: "combobox", options: c.comboboxOptions.split('\\n')}
-      // }
-
-
-      // Set rendeder for association columns (the one displaying associations by the specified method instead of id)
-
-      if (c.assoc) {
-        // Editor for association column
-        c.editor = Ext.apply({
-          parentId: this.id,
-          name: c.name
-        }, c.editor);
-
-        // Renderer for association column
-        this.normalizeAssociationRenderer(c);
-      }
-
-      if (c.editor) {
-        Ext.applyIf(c.editor, {selectOnFocus: true});
-      }
-
-      // Setting the default filter type
-      if (c.filterable && !c.filter) {
-        c.filter = {type: c.assoc ? 'string' : this.fieldTypeForAttrType(c.attrType)};
-      }
-
-      // setting dataIndex
-      c.dataIndex = c.name;
-
-    }, this);
+    if (this.enableColumnFilters) {
+      this.features.push({
+        encode: true,
+        ftype: 'filters'
+      });
+    }
 
-    /* ... and done with the columns */
+    // Normalize columns. Extract data fields and meta column.
+    this.processColumns();
 
     // Define the model
     Ext.define(this.id, {
       extend: 'Ext.data.Model',
       idProperty: this.pri, // Primary key
-      fields: fields
+      fields: this.fields
     });
-
-    // After we created the record (model), we can get rid of the meta column
-    Ext.Array.remove(this.columns, metaColumn);
+    delete this.pri;
+    delete this.fields;
 
     // Prepare column model config with columns in the correct order; columns out of order go to the end.
     var colModelConfig = [];
@@ -117,49 +53,12 @@
     // ... instead, define own column model
     this.columns = colModelConfig;
 
-    var reader = Ext.create('Ext.data.reader.Array', {root: 'data', totalProperty: 'total'});
-
-    // DirectProxy that uses our Ext.direct provider
-    var proxy = Ext.create('Ext.data.proxy.Direct', {
-      directFn: Netzke.providers[this.id].getData,
-      reader: reader,
-      listeners: {
-        exception: {
-          fn: this.loadExceptionHandler,
-          scope: this
-        },
-        load: { // Netzke-introduced event; this will also be fired when an exception occurs.
-          fn: function(proxy, response, operation) {
-            // besides getting data into the store, we may also get commands to execute
-            response = response.result;
-            if (response) { // or did we have an exception?
-              Ext.each(['data', 'total', 'success'], function(property){delete response[property];});
-              this.bulkExecute(response);
-            }
-          },
-          scope: this
-        }
-      }
-    });
-
-    this.store = Ext.create('Ext.data.Store', {
-      model: this.id,
-      proxy: proxy,
-      pruneModifiedRecords: true,
-      remoteSort: true,
-      pageSize: this.rowsPerPage
-    });
+    // data store
+    this.store = this.buildStore();
 
+    // load inline data if available
     if (this.inlineData) this.store.loadRawData(this.inlineData);
 
-    // Drag'n'Drop
-    if (this.enableRowsReordering){
-      this.ddPlugin = new Ext.ux.dd.GridDragDropRowOrder({
-        scrollable: true // enable scrolling support (default is false)
-      });
-      this.plugins.push(this.ddPlugin);
-    }
-
     // Cell editing
     if (!this.prohibitUpdate) {
       this.plugins.push(Ext.create('Ext.grid.plugin.CellEditing', {pluginId: 'celleditor'}));
@@ -172,7 +71,7 @@
         xtype: 'pagingtoolbar',
         dock: 'bottom',
         store: this.store,
-        items: this.bbar && ["-"].concat(this.bbar) // append the old bbar
+        items: this.bbar && ["-"].concat(this.bbar) // append the passed bbar
       });
     } else if (this.bbar) {
       this.dockedItems.push({
@@ -182,10 +81,8 @@
       });
     }
 
-
     delete this.bbar;
 
-    // Now let Ext.grid.EditorGridPanel do the rest (original initComponent)
     this.callParent();
 
     // Context menu
@@ -215,21 +112,9 @@
       if (this.actions.edit) this.actions.edit.setDisabled(selModel.getCount() != 1 || this.prohibitUpdate);
     }, this);
 
-    // Drag n Drop event
-    if (this.enableRowsReordering){
-      this.ddPlugin.on('afterrowmove', this.onAfterRowMove, this);
-    }
-
     // WIP: GridView
     this.getView().getRowClass = this.defaultGetRowClass;
 
-    // this.on('edit', function(editor, e) {
-    //   if (e.column.assoc && e.record.get('meta')) {
-    //     console.log("editor:", editor);
-    //     editor.setRawValue("");
-    //   }
-    // });
-
     // 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){
       if (e.column.assoc && e.record.get('meta')) {
@@ -246,7 +131,7 @@
       }
     }, this);
 
-    this.on('afterrender', function() {
+    this.on('afterlayout', function() {
       // Persistence-related events (afterrender to avoid blank event firing on render)
       if (this.persistence) {
         // Inform the server part about column operations
@@ -258,6 +143,109 @@
     }, this);
   },
 
+  processColumns: function() {
+    this.fields = [];
+
+    // Run through columns and set up different configuration for each
+    Ext.each(this.columns, function(c, i){
+
+      this.normalizeRenderer(c);
+
+      // Build the field configuration for this column
+      var fieldConfig = {name: c.name, defaultValue: c.defaultValue, useNull: true}; // useNull is needed to not convert nils to 0 in associations!
+
+      if (c.name !== 'meta') fieldConfig.type = this.fieldTypeForAttrType(c.attrType); // field type (grid editors need this to function well)
+
+      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)
+
+        // 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");
+        }
+      };
+
+      this.fields.push(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;
+      }
+
+      // Set rendeder for association columns (the one displaying associations by the specified method instead of id)
+      if (c.assoc) {
+        // Editor for association column
+        c.editor = Ext.apply({
+          name: c.name
+        }, c.editor);
+
+        // Renderer for association column
+        this.normalizeAssociationRenderer(c);
+      }
+
+      if (c.editor) {
+        Ext.applyIf(c.editor, {selectOnFocus: true, parentId: this.id});
+      }
+
+      // Setting the default filter type
+      if (c.filterable && !c.filter) {
+        c.filter = {type: c.assoc ? 'string' : this.fieldTypeForAttrType(c.attrType)};
+      }
+
+      // setting dataIndex
+      c.dataIndex = c.name;
+
+    }, this);
+  },
+
+  buildStore: function() {
+    var store = Ext.create('Ext.data.Store', Ext.apply({
+      model: this.id,
+      proxy: this.buildProxy(),
+      pruneModifiedRecords: true,
+      remoteSort: true,
+      pageSize: this.rowsPerPage,
+      autoLoad: !this.loadInlineData
+    }, this.dataStore));
+
+    delete this.dataStore;
+
+    return store;
+  },
+
+  buildProxy: function() {
+    // DirectProxy that uses our Ext.direct provider
+    return Ext.create('Ext.data.proxy.Direct', {
+      directFn: Netzke.providers[this.id].getData,
+      reader: this.buildReader(),
+      listeners: {
+        exception: {
+          fn: this.loadExceptionHandler,
+          scope: this
+        },
+        load: { // Netzke-introduced event; this will also be fired when an exception occurs.
+          fn: function(proxy, response, operation) {
+            // besides getting data into the store, we may also get commands to execute
+            response = response.result;
+            if (response) { // or did we have an exception?
+              Ext.each(['data', 'total', 'success'], function(property){delete response[property];});
+              this.netzkeBulkExecute(response);
+            }
+          },
+          scope: this
+        }
+      }
+    });
+  },
+
+  buildReader: function() {
+    return Ext.create('Ext.data.reader.Array', {root: 'data', totalProperty: 'total'});
+  },
+
   fieldTypeForAttrType: function(attrType){
     var map = {
       integer   : 'int',
@@ -279,7 +267,7 @@
     var dataRecords = this.getStore().getProxy().getReader().read(data);
     this.getStore().loadData(dataRecords.records);
     Ext.each(['data', 'total', 'success'], function(property){delete data[property];}, this);
-    this.bulkExecute(data);
+    this.netzkeBulkExecute(data);
   },
 
   // Tries editing the first editable (i.e. not hidden, not read-only) sell

data/lib/netzke/basepack/grid/services.rb

@@ -0,0 +1,216 @@
+module Netzke
+  module Basepack
+    class Grid < Netzke::Base
+      module Services
+        extend ActiveSupport::Concern
+
+        included do
+          endpoint :get_data do |params, this|
+            # not a usual Netzke endpoint, as it's being used by the Ext.data.DirectStore
+            this.merge! get_data(params)
+          end
+
+          endpoint :post_data do |params, this|
+            mod_records = {}
+            [:create, :update].each do |operation|
+              data = ActiveSupport::JSON.decode(params["#{operation}d_records"]) if params["#{operation}d_records"]
+              if !data.nil? && !data.empty? # data may be nil for one of the operations
+                mod_records[operation] = process_data(data, operation)
+                mod_records[operation] = nil if mod_records[operation].empty?
+              end
+            end
+
+            on_data_changed
+
+            this.update_new_records mod_records[:create]
+            this.update_mod_records mod_records[:update] if mod_records[:update]
+            this.netzke_feedback @flash
+          end
+
+          endpoint :delete_data do |params, this|
+            if !config[:prohibit_delete]
+              record_ids = ActiveSupport::JSON.decode(params[:records])
+              data_adapter.destroy(record_ids)
+              on_data_changed
+              this.netzke_feedback I18n.t('netzke.basepack.grid.deleted_n_records', :n => record_ids.size)
+              this.load_store_data get_data
+            else
+              this.netzke_feedback I18n.t('netzke.basepack.grid.cannot_delete')
+            end
+          end
+
+          endpoint :resize_column do |params, this|
+            raise "Called resize_column endpoint while not configured to do so" if !config[:persistence]
+
+            current_columns_order = state[:columns_order] || initial_columns_order
+            current_columns_order[normalize_index(params[:index].to_i)][:width] = params[:size].to_i
+            state[:columns_order] = current_columns_order
+          end
+
+          endpoint :move_column do |params, this|
+            raise "Called move_column endpoint while not configured to do so" if !config[:persistence]
+
+            remove_from = normalize_index(params[:old_index].to_i)
+            insert_to = normalize_index(params[:new_index].to_i)
+
+            current_columns_order = state[:columns_order] || initial_columns_order
+
+            column_to_move = current_columns_order.delete_at(remove_from)
+            current_columns_order.insert(insert_to, column_to_move)
+
+            state[:columns_order] = current_columns_order
+          end
+
+          endpoint :hide_column do |params, this|
+            raise "Called hide_column endpoint while not configured to do so" if !config[:persistence]
+            current_columns_order = state[:columns_order] || initial_columns_order
+            current_columns_order[normalize_index(params[:index].to_i)][:hidden] = params[:hidden]
+            state[:columns_order] = current_columns_order
+          end
+
+          # Returns options for a combobox
+          # params receive:
+          # +attr+ - column's name
+          # +query+ - what's typed-in in the combobox
+          # +id+ - selected record id
+          endpoint :get_combobox_options do |params, this|
+            column = final_columns.detect{ |c| c[:name] == params[:attr] }
+            this.data = data_adapter.combo_data(column, params[:query])
+          end
+
+          endpoint :move_rows do |params, this|
+            data_adapter.move_records(params)
+          end
+
+          # When providing the edit_form component, fill in the form with the requested record
+          endpoint :deliver_component do |params, this|
+            if params[:name] == 'edit_window'
+              components[:edit_window].form_config.record_id = params[:record_id].to_i
+            end
+
+            super(params, this)
+          end
+
+          # TODO: functionality of the following 2 endpoints could probably be improved by subclassing Basepack::Form as a dedicated form for adding/editing records in a grid.
+          # Process the submit of multi-editing form ourselves
+          endpoint :multi_edit_window__multi_edit_form__netzke_submit do |params, this|
+            ids = ActiveSupport::JSON.decode(params.delete(:ids))
+            data = ids.collect{ |id| ActiveSupport::JSON.decode(params[:data]).merge("id" => id) }
+
+            data.map!{|el| el.delete_if{ |k,v| v.is_a?(String) && v.blank? }} # only interested in set values
+
+            mod_records_count = process_data(data, :update).count
+
+            # remove duplicated flash messages
+            @flash = @flash.inject([]){ |r,hsh| r.include?(hsh) ? r : r.push(hsh) }
+
+            if mod_records_count > 0
+              on_data_changed
+              this.netzke_set_result("ok")
+              this.on_submit_success
+            end
+
+            this.netzke_feedback(@flash)
+          end
+
+          # The following two look a bit hackish, but serve to invoke on_data_changed when a form gets successfully submitted
+          endpoint :add_window__add_form__netzke_submit do |params, this|
+            this.merge!(component_instance(:add_window__add_form).invoke_endpoint(:netzke_submit, params))
+            on_data_changed if this.set_form_values.present?
+            this.delete(:set_form_values)
+          end
+
+          endpoint :edit_window__edit_form__netzke_submit do |params, this|
+            this.merge!(component_instance(:edit_window__edit_form).invoke_endpoint(:netzke_submit, params))
+            on_data_changed if this.set_form_values.present?
+            this.delete(:set_form_values)
+          end
+        end # included
+
+        # Implementation for the "get_data" endpoint
+        def get_data(*args)
+          params = args.first || {} # params are optional!
+          if !config[:prohibit_read]
+            {}.tap do |res|
+              records = get_records(params)
+              res[:data] = records.map{|r| data_adapter.record_to_array(r, final_columns(:with_meta => true))}
+              res[:total] = count_records(params)  if config[:enable_pagination]
+            end
+          else
+            flash :error => "You don't have permissions to read data"
+            { :netzke_feedback => @flash }
+          end
+        end
+
+      protected
+
+        # Returns an array of records.
+        def get_records(params)
+          params[:limit] = config[:rows_per_page] if config[:enable_pagination]
+          params[:scope] = config[:scope] # note, params[:scope] becomes ActiveSupport::HashWithIndifferentAccess
+
+          data_adapter.get_records(params, final_columns)
+        end
+
+        def count_records(params)
+          params[:scope] = config[:scope] # note, params[:scope] becomes ActiveSupport::HashWithIndifferentAccess
+
+          data_adapter.count_records(params, final_columns)
+        end
+
+        # Override this method to react on each operation that caused changing of data
+        def on_data_changed
+        end
+
+        # Given an index of a column among enabled (non-excluded) columns, provides the index (position) in the table
+        def normalize_index(index)
+          norm_index = 0
+          index.times do
+            while true do
+              norm_index += 1
+              break unless final_columns[norm_index][:included] == false
+            end
+          end
+          norm_index
+        end
+
+        # Params:
+        # <tt>:operation</tt>: :update or :create
+        def process_data(data, operation)
+          success = true
+          mod_records = {}
+          if !config[:"prohibit_#{operation}"]
+            modified_records = 0
+            data.each do |record_hash|
+              id = record_hash.delete('id')
+              record = operation == :create ? data_adapter.new_record : data_adapter.find_record(id)
+              success = true
+
+              # merge with strong default attirbutes
+              record_hash.merge!(config[:strong_default_attrs]) if config[:strong_default_attrs]
+
+              record_hash.each_pair do |k,v|
+                data_adapter.set_record_value_for_attribute(record, final_columns_hash[k.to_sym].nil? ? {:name => k} : final_columns_hash[k.to_sym], v, config.role || :default)
+              end
+
+              # try to save
+              mod_records[id] = data_adapter.record_to_array(record, final_columns(:with_meta => true)) if success && record.save
+
+              # flash eventual errors
+              if !record.errors.empty?
+                success = false
+                record.errors.to_a.each do |msg|
+                  flash :error => msg
+                end
+              end
+            end
+          else
+            success = false
+            flash :error => "You don't have permissions to #{operation} data"
+          end
+          mod_records
+        end
+      end
+    end
+  end
+end