netzke-basepack 0.6.2 → 0.6.3

data/lib/netzke/basepack/grid_panel.rb

@@ -1,6 +1,5 @@
 require "netzke/basepack/grid_panel/columns"
 require "netzke/basepack/grid_panel/services"
-require "netzke/basepack/grid_panel/javascript"
 # require "netzke/basepack/plugins/configuration_tool"
 # require "data_accessor"
 
@@ -50,11 +49,11 @@ module Netzke
     #   When it's a hash, it's a conditions hash (passed directly to +where+).
     #   When it's an array, it's expanded into an SQL statement with arguments (passed directly to +where+), e.g.:
     #
-    #     :query => ["id > ?", 100])
+    #     :scope => ["id > ?", 100])
     #
     #   When it's a Proc, it's passed the model class, and is expected to return a ActiveRecord::Relation, e.g.:
     #
-    #     :query => { |klass| klass.where(:id.gt => 100).order(:created_at) }
+    #     :scope => { |rel| rel.where(:id.gt => 100).order(:created_at) }
     #
     # * <tt>:enable_column_filters</tt> - enable filters in column's context menu
     # * <tt>:enable_edit_in_form</tt> - provide buttons into the toolbar that activate editing/adding records via a form
@@ -70,15 +69,36 @@ module Netzke
     # * <tt>:columns</tt> - an array of columns to be displayed in the grid; each column may be represented by a symbol (representing the model's attribute name), or a hash (when extra configuration is needed)
     #
     # == Columns
-    # Each column supports the option :sorting_scope, which defines a scope used for sorting the column. This option would be
-    # useful for virtual columns for example. The scope will get one parameter which contains the direction (:asc or :desc)
-    # Example:
-    # { :name => "complete_user_name", :sorting_scope => :sort_user_by_full_name }
-    # class User < ActiveRecord::Base
-    #     scope :sort_user_by_full_name, lambda { |dir|
+    # Columns are configured by passing an array to the +columns+ option. Each element in the array is either the name of model's (virtual) attribute, or a column configuration hash.
+    # The column configuration hash recognizes the following options:
+    #
+    # * +name+ - name of the column, that may correspond to model's (virtual) attribute
+    # * +read_only+ - a boolean that defines if the cells in the column should be editable
+    # * +editable+ - same as +read_only+, but in reverse (takes precedence over +read_only+)
+    # * +getter+ - a lambda that receives a record as a parameter, and is expected to return a string that will be printed in the cell (can be HTML code)
+    # * +setter+ - a lambda that receives a record as first parameter, and the value passed from the cell as the second parameter, and is expected to modify the record accordingly
+    #
+    # * +sorting_scope+ - the name of the scope used for sorting the column. This can be useful for virtual columns for example. The scope will get one parameter specifying the direction (:asc or :desc). Example:
+    #
+    #     columns => [{ :name => "complete_user_name", :sorting_scope => :sort_user_by_full_name }, ...]
+    #
+    #     class User < ActiveRecord::Base
+    #       scope :sort_user_by_full_name, lambda { |dir|
     #         order("users.first_name #{dir.to_s}, users.last_name #{dir.to_s}")
-    #     }
-    # end
+    #       }
+    #     end
+    # Besides these options, a column can receive any meaningful config option understood by Ext.grid.Column (http://dev.sencha.com/deploy/dev/docs/?class=Ext.grid.Column)
+    #
+    # == Actions
+    # You can override GridPanel's actions to change their text, icons, and tooltips (see http://api.netzke.org/core/Netzke/Actions.html). You can also use these actions when configuring menus and toolbars.
+    # GridPanel implements the following actions:
+    # * +add+
+    # * +del+
+    # * +edit+
+    # * +apply+
+    # * +add_in_form+
+    # * +edit_in_form+
+    # * +search+
     class GridPanel < Netzke::Base
       # Class-level configuration. These options directly influence the amount of generated
       # javascript code for this component's class. For example, if you don't want filters for the grid,
@@ -110,7 +130,6 @@ module Netzke
         :tools                  => %w{ refresh },
       }
 
-      include self::Javascript
       include self::Services
       include self::Columns
 
@@ -129,16 +148,20 @@ module Netzke
       #   super(*args)
       # end
 
-      # Include extra javascript that we depend on
-      def self.include_js
-        res = ["#{File.dirname(__FILE__)}/grid_panel/javascripts/pre.js"]
-
-        # Optional edit in form functionality
-        res << "#{File.dirname(__FILE__)}/grid_panel/javascripts/edit_in_form.js" if edit_in_form_available
+      js_base_class "Ext.grid.EditorGridPanel"
+      js_mixin :main
+      js_mixin :advanced_search if extended_search_available
+      js_mixin :edit_in_form if edit_in_form_available
 
-        # Optional extended search functionality
-        res << "#{File.dirname(__FILE__)}/grid_panel/javascripts/advanced_search.js" if extended_search_available
+      # I18n used in JavaScript
+      js_property :i18n, {
+        :are_you_sure => I18n.translate("netzke.basepack.generic.are_you_sure"),
+        :confirm => I18n.translate("netzke.basepack.generic.confirm")
+      }
 
+      # Include extra javascript that we depend on
+      def self.include_js
+        res = []
         ext_examples = Netzke::Core.ext_location.join("examples")
 
         # Checkcolumn
@@ -153,6 +176,9 @@ module Netzke
           %w{Boolean Date List Numeric String}.unshift("").each do |f|
             res << ext_examples + "ux/gridfilters/filter/#{f}Filter.js"
           end
+
+          # Fix
+          res << "#{File.dirname(__FILE__)}/grid_panel/javascripts/misc.js"
         end
 
         # DD
@@ -179,16 +205,24 @@ module Netzke
       end
 
 
+      # The result of this method (a hash) is converted to a JSON object and passed as the configuration parameter
+      # to the constructor of our JavaScript class. Override it when you want to pass any extra configuration
+      # to the JavaScript side.
+      def js_config
+        super.merge({
+          :bbar => config.has_key?(:bbar) ? config[:bbar] : default_bbar,
+          :context_menu => config.has_key?(:context_menu) ? config[:context_menu] : default_context_menu,
+          :columns => columns, # columns
+          :model => config[:model], # the model name
+          :inline_data => (get_data if config[:load_inline_data]), # inline data (loaded along with the grid panel)
+          :pri => data_class.primary_key # table primary key name
+        })
+      end
+
       def default_bbar
         res = %w{ add edit apply del }.map(&:to_sym).map(&:action)
         res << "-" << :add_in_form.action << :edit_in_form.action if config[:enable_edit_in_form]
         res << "-" << :search.action if config[:enable_extended_search]
-        # config[:enable_extended_search] && res << "-" << {
-        #   :text => "Search",
-        #   :handler => :on_search,
-        #   :enable_toggle => true,
-        #   :icon => :find
-        # }
         res
       end
 
@@ -218,52 +252,52 @@ module Netzke
 
       action :add do
         {
-          :text => I18n.t('netzke.basepack.grid_panel.add', :default => "Add"),
-          :tooltip => I18n.t('netzke.basepack.grid_panel.add', :default => "Add"),
+          :text => I18n.t('netzke.basepack.grid_panel.actions.add'),
+          :tooltip => I18n.t('netzke.basepack.grid_panel.actions.add'),
           :disabled => config[:prohibit_create],
           :icon => :add
         }
       end
 
       action :edit, {
-        :text => I18n.t('netzke.basepack.grid_panel.edit', :default => "Edit"),
-        :tooltip => I18n.t('netzke.basepack.grid_panel.edit', :default => "Edit"),
+        :text => I18n.t('netzke.basepack.grid_panel.actions.edit'),
+        :tooltip => I18n.t('netzke.basepack.grid_panel.actions.edit'),
         :disabled => true,
         :icon => :table_edit
       }
 
       action :del, {
-        :text => I18n.t('netzke.basepack.grid_panel.delete', :default => "Delete"),
-        :tooltip => I18n.t('netzke.basepack.grid_panel.delete', :default => "Delete"),
+        :text => I18n.t('netzke.basepack.grid_panel.actions.del'),
+        :tooltip => I18n.t('netzke.basepack.grid_panel.actions.del'),
         :disabled => true,
         :icon => :table_row_delete
       }
 
       action :apply do
         {
-          :text => I18n.t('netzke.basepack.grid_panel.apply', :default => "Apply"),
-          :tooltip => I18n.t('netzke.basepack.grid_panel.apply', :default => "Apply"),
+          :text => I18n.t('netzke.basepack.grid_panel.actions.apply'),
+          :tooltip => I18n.t('netzke.basepack.grid_panel.actions.apply'),
           :disabled => config[:prohibit_update] && config[:prohibit_create],
           :icon => :tick
         }
       end
 
       action :add_in_form, {
-        :text => I18n.t('netzke.basepack.grid_panel.add_in_form', :default => "Add in form"),
-        :tooltip => I18n.t('netzke.basepack.grid_panel.add_in_form', :default => "Add in form"),
+        :text => I18n.t('netzke.basepack.grid_panel.actions.add_in_form'),
+        :tooltip => I18n.t('netzke.basepack.grid_panel.actions.add_in_form'),
         :icon => :application_form_add
       }
 
       action :edit_in_form, {
-        :text => I18n.t('netzke.basepack.grid_panel.edit_in_form', :default => "Edit in form"),
-        :tooltip => I18n.t('netzke.basepack.grid_panel.edit_in_form', :default => "Edit in form"),
+        :text => I18n.t('netzke.basepack.grid_panel.actions.edit_in_form'),
+        :tooltip => I18n.t('netzke.basepack.grid_panel.actions.edit_in_form'),
         :disabled => true,
         :icon => :application_form_edit
       }
 
       action :search, {
-        :text => I18n.t('netzke.basepack.grid_panel.search', :default => "Search"),
-        :tooltip => I18n.t('netzke.basepack.grid_panel.search', :default => "Search"),
+        :text => I18n.t('netzke.basepack.grid_panel.actions.search'),
+        :tooltip => I18n.t('netzke.basepack.grid_panel.actions.search'),
         :enable_toggle => true,
         :icon => :find
       }
@@ -271,13 +305,13 @@ module Netzke
       component :add_form do
         {
           :lazy_loading => true,
-          :class_name => "Basepack::GridPanel::RecordFormWindow",
-          :title => "Add #{data_class.table_name.singularize.humanize}",
+          :class_name => "Netzke::Basepack::GridPanel::RecordFormWindow",
+          :title => "Add #{data_class.model_name.human}",
           :button_align => "right",
           :items => [{
-            :class_name => "Basepack::FormPanel",
+            :class_name => "Netzke::Basepack::FormPanel",
             :model => config[:model],
-            :items => default_fields_for_forms,
+            :items => default_fields_for_forms_with_default_values,
             :persistent_config => config[:persistent_config],
             :strong_default_attrs => config[:strong_default_attrs],
             :border => true,
@@ -292,11 +326,11 @@ module Netzke
       component :edit_form do
         {
           :lazy_loading => true,
-          :class_name => "Basepack::GridPanel::RecordFormWindow",
-          :title => "Edit #{data_class.table_name.singularize.humanize}",
+          :class_name => "Netzke::Basepack::GridPanel::RecordFormWindow",
+          :title => "Edit #{data_class.model_name.human}",
           :button_align => "right",
           :items => [{
-            :class_name => "Basepack::FormPanel",
+            :class_name => "Netzke::Basepack::FormPanel",
             :model => config[:model],
             :items => default_fields_for_forms,
             :persistent_config => config[:persistent_config],
@@ -311,11 +345,11 @@ module Netzke
       component :multi_edit_form do
         {
           :lazy_loading => true,
-          :class_name => "Basepack::GridPanel::RecordFormWindow",
-          :title => "Edit #{data_class.table_name.humanize}",
+          :class_name => "Netzke::Basepack::GridPanel::RecordFormWindow",
+          :title => "Edit #{data_class.model_name.human.pluralize}",
           :button_align => "right",
           :items => [{
-            :class_name => "Basepack::GridPanel::MultiEditForm",
+            :class_name => "Netzke::Basepack::GridPanel::MultiEditForm",
             :model => config[:model],
             :items => default_fields_for_forms,
             :persistent_config => config[:persistent_config],
@@ -329,7 +363,7 @@ module Netzke
       component :search_form do
         {
           :lazy_loading => true,
-          :class_name => "Basepack::GridPanel::SearchWindow",
+          :class_name => "Netzke::Basepack::GridPanel::SearchWindow",
           :model => config[:model],
           :fields => default_fields_for_forms
         }
@@ -338,7 +372,7 @@ module Netzke
 
       # def search_panel
       #   {
-      #     :class_name => "Basepack::FormPanel",
+      #     :class_name => "Netzke::Basepack::FormPanel",
       #     :model => "User",
       #     # :items => default_fields_for_forms,
       #     # :search_class_name => cronfig[:model],
@@ -353,4 +387,4 @@ module Netzke
 
     end
   end
-end
+end

data/lib/netzke/basepack/grid_panel/columns.rb

@@ -66,6 +66,11 @@ module Netzke
           end
         end
 
+        # Columns as a hash, for easier access to a specific column
+        def columns_hash
+          @columns_hash ||= columns.inject({}){|r,c| r.merge(c[:name].to_sym => c)}
+        end
+
         # Columns that we fall back to when neither persistent columns, nor configured columns are present.
         # If there's a model-level field configuration, it's being used.
         # Otherwise the defaults straight from the ActiveRecord model ("netzke_attributes").
@@ -101,6 +106,7 @@ module Netzke
           # Make the column config complete with the defaults
           columns_for_create.each do |c|
             detect_association(c)
+            set_default_virtual(c)
             set_default_header(c)
             set_default_editor(c)
             set_default_width(c)
@@ -114,6 +120,7 @@ module Netzke
         end
 
         private
+
           def filter_out_excluded_columns(cols)
             cols.reject!{ |c| c[:included] == false }
           end
@@ -132,7 +139,7 @@ module Netzke
           end
 
           def set_default_header(c)
-            c[:label] ||= c[:name].humanize
+            c[:label] ||= data_class.human_attribute_name(c[:name])
           end
 
           def set_default_editor(c)
@@ -150,8 +157,15 @@ module Netzke
           end
 
           def set_default_editable(c)
-            c[:editable] = c[:read_only].nil? ? !(primary_key_attr?(c) || c[:virtual]) : !c[:read_only]
-            c.delete(:read_only)
+            not_editable_if = primary_key_attr?(c)
+            not_editable_if ||= c[:virtual]
+            not_editable_if ||= c.delete(:read_only)
+
+            editable_if = data_class.column_names.include?(c[:name])
+            editable_if ||= data_class.instance_methods.map(&:to_s).include?("#{c[:name]}=")
+            editable_if ||= association_attr?(c[:name])
+
+            c[:editable] = editable_if && !not_editable_if if c[:editable].nil?
           end
 
           def set_default_sortable(c)
@@ -164,7 +178,7 @@ module Netzke
 
           # Returns editor's xtype for a column type
           def editor_for_attr_type(type)
-            attr_type_to_editor_map[type]
+            attr_type_to_editor_map[type] || :textfield
           end
 
           def editor_for_association
@@ -185,23 +199,34 @@ module Netzke
 
           # Detects an association column and sets up the proper editor.
           def detect_association(c)
-            # double-underscore notation? surely an association column
-            if c[:name].index('__')
-              assoc_name, assoc_method = c[:name].split('__')
-              if assoc_method && assoc = data_class.reflect_on_association(assoc_name.to_sym)
-                assoc_column = assoc.klass.columns_hash[assoc_method]
-                assoc_method_type = assoc_column.try(:type)
-
-                # if association column is boolean, display a checkbox (or alike), otherwise - a combobox (or alike)
+            assoc, assoc_method = get_assoc_and_method(c)
+            if assoc
+              assoc_column = assoc.klass.columns_hash[assoc_method]
+              assoc_method_type = assoc_column.try(:type)
+
+              # if association column is boolean, display a checkbox (or alike), otherwise - a combobox (or alike)
+              if c[:nested_attribute]
+                c[:editor] ||= editor_for_attr_type(assoc_method_type)
+              else
                 c[:editor] ||= assoc_method_type == :boolean ? editor_for_attr_type(:boolean) : editor_for_association
               end
             end
           end
 
+          def get_assoc_and_method(c)
+            if c[:name].index("__")
+              assoc_name, assoc_method = c[:name].split('__')
+              assoc = data_class.reflect_on_association(assoc_name.to_sym)
+              [assoc, assoc_method]
+            else
+              [nil, nil]
+            end
+          end
+
           # Default fields that will be displayed in the Add/Edit/Search forms
+          # When overriding this method, keep in mind that the fields inside the layout must be expanded (each field represented by a hash, not just a symbol)
           def default_fields_for_forms
-            form_klass = "Netzke::ModelExtensions::#{config[:model]}ForFormPanel".constantize rescue nil
-            form_klass ||= original_data_class
+            form_klass = constantize_class_name("Netzke::ModelExtensions::#{config[:model]}ForFormPanel") || original_data_class
 
             # Select only those fields that are known to the form_klass
             selected_columns = columns.select do |c|
@@ -220,6 +245,26 @@ module Netzke
             end
           end
 
+          # default_fields_for_forms extended with default values (for new-record form)
+          def default_fields_for_forms_with_default_values
+            res = default_fields_for_forms.dup
+            each_attr_in(res) do |a|
+              attr_name = a[:name].to_sym
+              a[:value] = a[:default_value] || columns_hash[attr_name].try(:fetch, :default_value, nil) || data_class.netzke_attribute_hash[attr_name].try(:fetch, :default_value, nil)
+            end
+            res
+          end
+
+          # Recursively traversess items (an array) and yields each found field (a hash with :name set)
+          def each_attr_in(items)
+            items.each do |item|
+              if item.is_a?(Hash)
+                each_attr_in(item[:items]) if item[:items].is_a?(Array)
+                yield(item) if item[:name]
+              end
+            end
+          end
+
           # Receives 2 arrays of columns. Merges the missing config from the +source+ into +dest+, matching columns by name
           def reverse_merge_equally_named_columns(dest, source)
             dest.each{ |dc| dc.reverse_merge!(source.detect{ |sc| sc[:name] == dc[:name] } || {}) }
@@ -228,4 +273,4 @@ module Netzke
       end
     end
   end
-end
+end

data/lib/netzke/basepack/grid_panel/javascripts/advanced_search.js

@@ -1,4 +1,4 @@
-Ext.override(Netzke.pre.GridPanel, {
+{
   onSearch: function(el){
     el.toggle(el.toggled); // do not toggle immediately
 
@@ -30,67 +30,5 @@ Ext.override(Netzke.pre.GridPanel, {
         }
       }, this);
     }, scope: this});
-
-    //   delete this.searchWindow;
-    //   this.searchWindow = new Ext.Window({
-    //     title:'Advanced search',
-    //     layout:'fit',
-    //     modal: true,
-    //     width: 400,
-    //     height: Ext.lib.Dom.getViewHeight() *0.9,
-    //     closeAction:'close',
-    //     buttons:[{
-    //       text: 'OK',
-    //       handler: function(){
-    //         this.ownerCt.ownerCt.closePositively();
-    //       }
-    //     },{
-    //       text:'Cancel',
-    //       handler:function(){
-    //         this.ownerCt.ownerCt.closeNegatively();
-    //       }
-    //     }],
-    //     closePositively : function(){
-    //       this.conditions = this.getNetzkeComponent().getForm().getValues();
-    //       this.closeRes = 'OK';
-    //       this.close();
-    //     },
-    //     closeNegatively: function(){
-    //       this.closeRes = 'cancel';
-    //       this.close();
-    //     }
-    //   });
-    //
-    //   this.searchWindow.on('close', function(){
-    //     if (this.searchWindow.closeRes == 'OK'){
-    //       var searchConditions = this.searchWindow.conditions;
-    //       var filtered = false;
-    //       // check if there's any search condition set
-    //       for (var k in searchConditions) {
-    //         if (searchConditions[k].length > 0) {
-    //           filtered = true;
-    //           break;
-    //         }
-    //       }
-    //       this.actions.search.setText(filtered ? "Search *" : "Search");
-    //       this.getStore().baseParams = {extra_conditions: Ext.encode(this.searchWindow.conditions)};
-    //       this.getStore().load();
-    //     }
-    //   }, this);
-    //
-    //   this.searchWindow.on('add', function(container, searchPanel){
-    //     searchPanel.on('apply', function(component){
-    //       this.searchWindow.closePositively();
-    //       return false; // stop the event
-    //     }, this);
-    //   }, this);
-    //
-    //   this.searchWindow.show(null, function(){
-    //     this.searchWindow.closeRes = 'cancel';
-    //     if (!this.searchWindow.getNetzkeComponent()){
-    //       this.loadComponent({id:"searchPanel", container:this.searchWindow.id});
-    //     }
-    //   }, this);
-    //
   }
-});
+}