netzke-basepack 0.3.1 → 0.3.3

data/CHANGELOG

@@ -1,3 +1,25 @@
+v0.3.3
+Bug fix: application not loading the widget specified in the URL (Ext.History-related).
+Some code refactoring and readability improvements.
+Ext.componentCache renamed into Ext.netzke.cache.
+New widget: TableEditor (a compound widget containing a grid and a form for editing table data).
+BorderLayoutPanel: a function getRegionWidget(region) added to access a widget in the specified region.
+Bug fix: BasicApp: FeedbackGhost now gets instantiated before BasicApp.
+Clearer handling of requests to non-existing aggregatees.
+Bug fix: now Ext 2.2.1 compatible.
+Column operations are now handled properly when :persistent_layout is set to false.
+Grid/Form fields configuration is extended with "ext_config" field which stores (in JSON-format) all the extra configuration, which gives extra flexibility to individual column/field configuration.
+:persistent_layout set to false now makes a widget ignore what's in the DB.
+Bug fix: AccordionPanel doesn't crash when no active item is specified.
+Bug fix: redundant flash messages for GridPanel.
+FeedbackGhost won't be showing anything if given an empty array.
+Cleaner handling of validations in GridPanel.
+FormPanel ready for the demo.
+
+v0.3.2
+Minor code restructuring.
+Working on FormPanel cont'd.
+
 v0.3.1
 Added the "conditions" configuration option to GridPanel to limit the search
 Basic column editor for grids has been replaced with FieldsConfigurator, which can do a bit more

data/Manifest

@@ -17,17 +17,20 @@ lib/netzke/accordion_panel.rb
 lib/netzke/ar_ext.rb
 lib/netzke/basic_app.rb
 lib/netzke/border_layout_panel.rb
-lib/netzke/column.rb
 lib/netzke/container.rb
+lib/netzke/db_fields.rb
 lib/netzke/fields_configurator.rb
 lib/netzke/form_panel.rb
+lib/netzke/form_panel_extras/interface.rb
+lib/netzke/form_panel_extras/js_builder.rb
 lib/netzke/grid_panel.rb
-lib/netzke/grid_panel_interface.rb
-lib/netzke/grid_panel_js_builder.rb
+lib/netzke/grid_panel_extras/interface.rb
+lib/netzke/grid_panel_extras/js_builder.rb
 lib/netzke/panel.rb
 lib/netzke/preference_grid.rb
 lib/netzke/properties_tool.rb
 lib/netzke/property_grid.rb
+lib/netzke/table_editor.rb
 lib/netzke/wrapper.rb
 lib/netzke-basepack.rb
 LICENSE
@@ -66,7 +69,6 @@ test/app_root/vendor/plugins/acts_as_list/lib/active_record/acts/list.rb
 test/app_root/vendor/plugins/acts_as_list/README
 test/ar_ext_test.rb
 test/border_layout_panel_test.rb
-test/column_test.rb
 test/console_with_fixtures.rb
 test/fixtures/books.yml
 test/fixtures/categories.yml

data/README.rdoc

@@ -1,5 +1,5 @@
 = netzke-basepack
-A pack of basic Rails/Ext JS widgets, as a part of Netzke framework. Live demo/tutorials on http://blog.writelesscode.com
+A pack of basic Rails/ExtJS widgets as a part of the Netzke framework. Live demo/tutorials on http://blog.writelesscode.com. Introduction to the Netzke framework: http://github.com/skozlov/netzke/tree/master
 
 Note that if you would like to modify this code or experiment with it, you may be better off cloning this project into your app's vendor/plugin directory - it will then behave as a Rails plugin.
 
@@ -84,4 +84,4 @@ TODO: this part will be covered later
 = Credentials
 Testing done with the help of http://github.com/pluginaweek/plugin_test_helper
 
-Copyright (c) 2009 Sergei Kozlov, released under the MIT license
+Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license

data/Rakefile

@@ -5,7 +5,7 @@ Echoe.new("netzke-basepack") do |p|
   p.email = "sergei@writelesscode.com"
   p.summary = "Base Netzke widgets - grid, form, tree, and more"
   p.url = "http://writelesscode.com"
-  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke-core >= 0.2.4"]
+  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke-core >= 0.2.6"]
   p.development_dependencies = []
   p.test_pattern = 'test/**/*_test.rb'
 

data/generators/netzke_form_panel/templates/create_netzke_form_panel_fields.rb

@@ -2,14 +2,13 @@ class CreateNetzkeFormPanelFields < ActiveRecord::Migration
   def self.up
     create_table :netzke_form_panel_fields do |t|
       t.string    :name
-      t.string    :label
-      t.boolean   :read_only
-      t.integer   :position
+      t.string    :field_label
       t.boolean   :hidden
-      t.integer   :width
-      t.integer   :height
-      t.string    :editor, :limit => 32
+      t.boolean   :disabled
+      t.string    :xtype
+      t.string    :ext_config, :limit => 1024
 
+      t.integer   :position
       t.integer   :layout_id
       
       t.timestamps

data/generators/netzke_grid_panel/templates/create_netzke_grid_panel_columns.rb

@@ -4,12 +4,13 @@ class CreateNetzkeGridPanelColumns < ActiveRecord::Migration
       t.string    :name
       t.string    :label
       t.boolean   :read_only
-      t.integer   :position
       t.boolean   :hidden
       t.integer   :width
       t.string    :editor, :limit => 32
       t.string    :renderer, :limit => 32
+      t.string    :ext_config, :limit => 1024
 
+      t.integer   :position
       t.integer   :layout_id
       
       t.timestamps

data/javascripts/basepack.js

@@ -1,3 +1,5 @@
+Ext.apply(Ext.History, new Ext.util.Observable());
+
 // Editors for grid cells and form fields
 Ext.netzke.editors = {
   combo_box: function(c, config){

data/lib/app/models/netzke_form_panel_field.rb

@@ -3,16 +3,48 @@ class NetzkeFormPanelField < ActiveRecord::Base
   
   acts_as_list :scope => :layout
 
+  validate :valid_ext_config
+  
+  expose_columns :id, 
+    :name,
+    :field_label,
+    :hidden,
+    {:name => :disabled, :renderer => "checkbox"},
+    :ext_config
+
+
   def self.create_layout_for_widget(widget)
-    layout = NetzkeLayout.create(:widget_name => widget.id_name, :items_class => self.name, :user_id => NetzkeLayout.user_id)
+    layout = NetzkeLayout.create_with_user(:widget_name => widget.id_name, :items_class => self.name)
 
-    columns = Netzke::Column.default_fields_for_widget(widget)
+    columns = widget.default_db_fields
 
     for c in columns
       config_for_create = c.merge(:layout_id => layout.id).stringify_values!
-      create(config_for_create)
+      new_field = self.new
+      ext_config = {}
+      for k in config_for_create.keys
+        if new_field.respond_to?("#{k}=")
+          new_field.send("#{k}=", config_for_create[k]) 
+        else
+          ext_config[k] = config_for_create[k]
+        end
+      end
+      new_field.ext_config = ext_config.to_js
+      new_field.save!
     end
     
     layout
   end
+  
+  private
+  
+  def valid_ext_config
+    begin
+      JSON.parse(ext_config)
+    rescue
+      errors.add(:ext_config, "is not valid JSON")
+    end
+  end
+  
+  
 end

data/lib/app/models/netzke_grid_panel_column.rb

@@ -3,15 +3,52 @@ class NetzkeGridPanelColumn < ActiveRecord::Base
   
   acts_as_list :scope => :layout
 
+  validate :valid_ext_config
+
+  expose_columns :id, 
+    :name,
+    :label,
+    {:name => :read_only, :label => "R/O"}, 
+    :hidden, 
+    {:name => :width, :width => 50}, 
+    {:name => :editor, :editor => :combo_box},
+    {:name => :renderer, :editor => :combo_box},
+    :ext_config
+  
   def self.create_layout_for_widget(widget)
     layout = NetzkeLayout.create_with_user(:widget_name => widget.id_name, :items_class => self.name)
-    columns = Netzke::Column.default_columns_for_widget(widget)
+    columns = widget.default_db_fields
 
     for c in columns
       config_for_create = c.merge(:layout_id => layout.id).stringify_values!
-      create(config_for_create)
+      new_field = self.new
+      ext_config = {}
+      for k in config_for_create.keys
+        if new_field.respond_to?("#{k}=")
+          new_field.send("#{k}=", config_for_create[k]) 
+        else
+          ext_config[k] = config_for_create[k]
+        end
+      end
+
+      new_field.ext_config = ext_config.to_js
+      new_field.save!
+      
+      # config_for_create = c.merge(:layout_id => layout.id).stringify_values!
+      # create(config_for_create)
     end
     
     layout
   end
+  
+  private
+  
+  def valid_ext_config
+    begin
+      JSON.parse(ext_config)
+    rescue
+      errors.add(:ext_config, "is not valid JSON")
+    end
+  end
+  
 end

data/lib/netzke-basepack.rb

@@ -20,7 +20,6 @@ end
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/check_column.js"
 
-# TODO: implement configurable loading of JS, to spare the traffic at the initial loading
 extjs_dir = "#{RAILS_ROOT}/public/extjs"
 
 # Filters in GridPanel

data/lib/netzke/accordion_panel.rb

@@ -1,15 +1,26 @@
 module Netzke
+  #
+  # AccordionPanel
+  # 
+  # Features:
+  # * Dynamically loads widgets for the panels that get expanded for the first time
+  # * Gets loaded along with the widget that is to be put into the active (expanded) panel (saves us a server request)
+  #
+  # TODO:
+  # * Stores the last active panel in the persistent_configuration
+  # 
   class AccordionPanel < Base
     #
     # JS-class generation
     #
-    class << self
+    module ClassMethods
 
       def js_default_config
         super.merge({
           :layout => 'accordion',
+          :defaults => {:layout => 'fit'}, # all items will be of type Panel with layout 'fit'
           :listeners => {
-            # every item gets an expand event activeted, which dynamically loads a widget into this item 
+            # every item gets an expand event set, which dynamically loads a widget into this item 
             :add => {
               :fn => <<-JS.l
               function(self, comp){
@@ -26,19 +37,50 @@ module Netzke
           # loads widget into the panel if it wasn't loaded yet
           :load_item_widget => <<-JS.l,
             function(panel) {
-              if (!panel.getWidget()) panel.loadWidget(this.id + "__" + panel.id + "__get_widget");
+              if (!panel.getWidget()) panel.loadWidget(this.id + "__" + panel.containerFor + "__get_widget");
+            }
+          JS
+          
+          :on_widget_load => <<-JS.l
+            function(){
+              // immediately instantiate the active panel
+              var activePanel = this.findById(this.id + "_active");
+              var activeItemConfig = this.initialConfig[this.initialConfig.expandedItem+"Config"];
+              if (activeItemConfig) activePanel.add(new Ext.netzke.cache[activeItemConfig.widgetClassName](activeItemConfig));
             }
           JS
         }
       end
+    end
+    extend ClassMethods
+    
+    # some configuration normalization
+    def initialize(*args)
+      super
+
+      seen_active = false
+
+      config[:items].each_with_index do |item, i|
+        # if some items are provided without names, give them generated names
+        item[:name] ||= "item#{i}"
 
+        # remove duplucated :active configuration
+        if item[:active]
+          item[:active] = nil if seen_active
+          seen_active = true
+        end
+      end
     end
 
     def js_config
-      super.merge(:items => items)
+      expanded_widget_config = config[:items].select{|i| i[:active]}.first
+      super.merge({
+        :items => items,
+        :expanded_item => expanded_widget_config && expanded_widget_config[:name]
+      })
     end
 
-    # the items are late aggregatees (besides the ones that are marked "active")
+    # the items are late aggregatees, besides the ones that are marked "active"
     def initial_aggregatees
       res = {}
       config[:items].each_with_index do |item, i|
@@ -48,22 +90,16 @@ module Netzke
       res
     end
 
+    # configuration for items (fit-panels)
     def items
       res = []
       config[:items].each_with_index do |item, i|
         item_config = {
-          :id => item[:name] || "item_#{i}",
-          :title => item[:title] || (item[:name] && item[:name].humanize) || "Item #{i}",
-          :layout => 'fit',
+          :id => item[:active] && id_name + '_active',
+          :title => item[:title] || (item[:name] && item[:name].humanize),
+          :container_for => item[:name], # to know which fit panel will load which widget
           :collapsed => !(item[:active] || false)
         }
-
-        # directly embed the widget in the active panel
-        if item[:active]
-          item_instance = Netzke::Base.instance_by_config(item.merge(:name => "#{id_name}__#{item[:name]}"))
-          item_config[:items] = ["new Ext.componentCache['#{item[:widget_class_name]}'](#{item_instance.js_config.to_js})".l]
-        end
-        
         res << item_config
       end
       res

data/lib/netzke/ar_ext.rb

@@ -193,13 +193,21 @@ module Netzke
         # detect ActiveRecord column type (if the column is "real") or fall back to :virtual
         type = (columns_hash[config[:name].to_s] && columns_hash[config[:name].to_s].type) || :virtual
 
-        res = {
-          :name => config[:name].to_s || "unnamed",
-          :field_label => config[:field_label] || config[:name].to_s.gsub('__', '_').humanize,
-          :disabled => config[:name] == :id, # make "id" column disabled by default
-          # :hidden => config[:name] == :id, # hide "id" column by default
-          :xtype => XTYPE_MAP[type]
+        defaults = {
+          :field_label => config[:name].to_s.gsub('__', '_').humanize,
+          :xtype       => XTYPE_MAP[type],
+          :hidden      => config[:name] == :id
         }
+
+        res = defaults.merge(config)
+        
+        # res = {
+        #   :name => config[:name].to_s || "unnamed",
+        #   :field_label => config[:field_label] || config[:name].to_s.gsub('__', '_').humanize,
+        #   # :disabled => config[:name] == :id, # make "id" column disabled by default
+        #   # :hidden => config[:name] == :id, # hide "id" column by default
+        #   :xtype => XTYPE_MAP[type]
+        # }
         
       end
       

data/lib/netzke/basic_app.rb

@@ -96,8 +96,6 @@ module Netzke
             // Initialize menus (upcoming support for dynamically loaded menus)
             this.menus = {};
             
-            // Initialize history
-            Ext.History.init();
             Ext.History.on('change', this.processHistory, this);
 
             // If we are given a token, load the corresponding widget, otherwise load the last loaded widget
@@ -168,9 +166,11 @@ module Netzke
 
     # Besides instantiating ourselves, also instantiate the FeedbackGhost
     def js_widget_instance
-      super << %Q{
-        new Ext.componentCache['FeedbackGhost']({id:'feedback_ghost'})
-      }
+      %Q{
+        new Ext.netzke.cache['FeedbackGhost']({id:'feedback_ghost'})
+        // Initialize history (can't say why it's not working well inside the appLoaded handler)
+        Ext.History.init();
+      } << super
     end
     
     # Interface implementation

data/lib/netzke/border_layout_panel.rb

@@ -7,7 +7,7 @@ module Netzke
     #
     # JS-class generation
     #
-    class << self
+    module ClassMethods
       def js_listeners
         {
           :afterlayout => {:fn => "this.setResizeEvents".l, :scope => this}
@@ -23,8 +23,17 @@ module Netzke
               var regionConfig = config.regions[r] || {};
               regionConfig.layout = 'fit';
               regionConfig.region = r;
-              regionConfig.items = [new Ext.componentCache[config[configName].widgetClassName](config[configName])]
+              regionConfig.items = [new Ext.netzke.cache[config[configName].widgetClassName](config[configName])]
               items.push(regionConfig);
+              
+              // A function to access a region widget (even if the widget gets reloaded, the function will work).
+              // E.g.: getEastWidget()
+              // I love JavaScript
+              this['get'+r.capitalize()+'Widget'] = function(){
+                return this.find('region', r)[0].getWidget()
+              }.createDelegate(this)
+              
+              
             };
           }, this)
         JS
@@ -38,7 +47,13 @@ module Netzke
       end
 
       def js_extend_properties
-        {:set_resize_events => <<-JS.l,
+        {
+          :get_region_widget => <<-JS.l,
+            function(region){
+              return this.find('region', region)[0].getWidget()
+            }
+          JS
+          :set_resize_events => <<-JS.l,
           function(){
             this.items.each(function(item, index, length){
               if (!item.oldSize) item.oldSize = item.getSize();
@@ -68,8 +83,8 @@ module Netzke
         JS
       }
       end
-      
     end
+    extend ClassMethods
     
     def initial_aggregatees
       config[:regions] || {}