netzke-basepack 0.1.4.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,13 @@
+v0.2.0
+Some re-factoring and redesign along with netzke-core
+Panel widget added
+BorderLayoutPanel added
+AccordionPanel added
+Bug fix: column operations configuration misbehaving
+Renamed Grid into GridPanel
+Bug fix: exception was thrown at a column operation when no layout_manager was present
+Reworked permission handling in GridPanel.
+
 v0.1.4.1
 Meta: updated netzke-core version (dependency)
 

data/Manifest

@@ -1,23 +1,27 @@
 CHANGELOG
+css/basepack.css
 generators/netzke_basepack/netzke_basepack_generator.rb
-generators/netzke_basepack/netzke_grid_generator.rb
-generators/netzke_basepack/templates/create_netzke_grid_columns.rb
+generators/netzke_basepack/netzke_grid_panel_generator.rb
+generators/netzke_basepack/templates/create_netzke_grid_panel_columns.rb
 generators/netzke_basepack/USAGE
 init.rb
 install.rb
 javascripts/basepack.js
 javascripts/filters.js
-lib/app/models/netzke_grid_column.rb
-lib/netzke/accordion.rb
+lib/app/models/netzke_grid_panel_column.rb
+lib/netzke/accordion_panel.rb
 lib/netzke/ar_ext.rb
+lib/netzke/border_layout_panel.rb
 lib/netzke/column.rb
 lib/netzke/container.rb
-lib/netzke/grid.rb
-lib/netzke/grid_interface.rb
-lib/netzke/grid_js_builder.rb
+lib/netzke/grid_panel.rb
+lib/netzke/grid_panel_interface.rb
+lib/netzke/grid_panel_js_builder.rb
+lib/netzke/panel.rb
 lib/netzke/preference_grid.rb
 lib/netzke/properties_tool.rb
 lib/netzke/property_grid.rb
+lib/netzke/wrapper.rb
 lib/netzke-basepack.rb
 LICENSE
 Manifest
@@ -49,6 +53,7 @@ test/app_root/db/migrate/20081223025653_create_continents.rb
 test/app_root/db/migrate/20081223025732_create_cities.rb
 test/app_root/script/console
 test/ar_ext_test.rb
+test/border_layout_panel_test.rb
 test/column_test.rb
 test/console_with_fixtures.rb
 test/fixtures/books.yml
@@ -57,7 +62,7 @@ test/fixtures/cities.yml
 test/fixtures/continents.yml
 test/fixtures/countries.yml
 test/fixtures/genres.yml
-test/grid_test.rb
+test/grid_panel_test.rb
 test/netzke_basepack_test.rb
 test/schema.rb
 test/test_helper.rb

data/README.mdown

@@ -1,9 +1,9 @@
 # netzke-basepack
-A pack of basic Rails/ExtJS widgets, as a part of Netzke framework.
+A pack of basic Rails/Ext JS widgets, as a part of Netzke framework.
 
 # Prerequisites
 1. Rails >= 2.2
-2. ExtJS >= 2.0: its root *must* be accessible as RAILS_ROOT/public/extjs. You may symlink your ExtJS library to here, like this (from your app folder): `cd public && ln -s ~/Developer/extjs/ext-2.2 extjs`
+2. Ext JS >= 2.0: its root *must* be accessible as `RAILS_ROOT/public/extjs`. You may symlink your Ext JS library here like this (from your app folder): `cd public && ln -s ~/Developer/extjs/ext-2.2 extjs`
 3. `acts_as_list` plugin must be installed: `./script/plugin install git://github.com/rails/acts_as_list.git`
 
 # Installation
@@ -14,7 +14,7 @@ Include it into environment.rb:
 `config.gem "netzke-basepack"`
 
 # Usage
-First, run the generators to have the necessary migrations (if not done so already):
+First, run the generators to have the necessary migrations:
 
 `./script/generate netzke_core`
 
@@ -24,27 +24,27 @@ Do the migrations:
 
 `rake db:migrate`
 
-This example will provide you with a grid-based scaffold for ActiveRecord-model called `Book`. If you don't have it already, you may generate it like this:
+The following example will provide you with a grid-based scaffold for ActiveRecord-model called `Book`. You may generate it like this:
 
 `./script/generate model Book title:string amount:integer`
-(don't forget to do the migrations after this)
+(don't forget to run the migrations after it)
 
 In the controller declare the widget:
 
 `class WelcomeController < ApplicationController
-  netzke_widget :books, :widget_class_name => 'Grid', :data_class_name => 'Book'
+  netzke :books, :widget_class_name => 'GridPanel', :data_class_name => 'Book'
 end`
 
 After a widget is declared in the controller, it can be accessed in 3 different ways: 1) loaded by means of an automatically created controller action which will produce a basic HTML-page with the widget (handy for testing), 2) embedded directly into a view (by means of helpers), 3) dynamically loaded by other widgets (usually by the widget of class 'Application', if you want a desktop-like, AJAX-driven web-app).
 
 ## Using automatically created controller action
-Without writing any more code, you can access the widget by `http://yourhost/welcome/books_test`. That is to say, you simply append `_test` to your widget's name (as declared in the controller) and use it as the action of the controller.
+Without writing any more code, you can access the widget by `http://yourhost/welcome/books_test`. That is to say, you simply append `_test` to your widget's name (as declared in the controller) to get the action name.
 
 ## Embedding a widget into a view
-netzke-core plugin provides the following 2 helpers to put inside your head-tag (use it in your layout)
+netzke-core plugin provides the following 2 helpers to put inside your head-tag (use it in your layout):
 
 1. `netzke_js_include` - to include extjs and netzke javascript files
-2. `netzke_css_include` - to include the css. This one can take a parameter to specify a color schema you wish for ExtJS, e.g.: `netzke_css_include(:gray)`
+2. `netzke_css_include` - to include the css. This one can take a parameter to specify a color schema you wish for Ext JS, e.g.: `netzke_css_include(:gray)`
 
 Declaring a widget in the controller provides you with a couple of helpers that can be used in the view:
 
@@ -71,7 +71,7 @@ Ext.onReady(function(){
 	books.render("books");
 })
 <% end %>
-<!-- some HTML... -->
+<p>... your page content here ...</p>
 <div id="books">the widget will be rendered in this div</div>`
 
 ## Dynamic loading of widgets

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.1.4"]
+  p.runtime_dependencies = ["searchlogic >=1.6.2", "netzke-core >= 0.2.0"]
   p.development_dependencies = []
   p.test_pattern = 'test/**/*_test.rb'
 

data/css/basepack.css

@@ -0,0 +1,4 @@
+/* write accordion header in bold */
+.x-accordion-hd {
+	font-weight:bold;
+}

data/generators/netzke_basepack/netzke_grid_panel_generator.rb

@@ -0,0 +1,7 @@
+class NetzkeGridPanelGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'create_netzke_grid_panel_columns.rb', "db/migrate", {:migration_file_name => "create_netzke_grid_panel_columns"}
+    end
+  end
+end

data/generators/netzke_basepack/templates/{create_netzke_grid_columns.rb → create_netzke_grid_panel_columns.rb}

@@ -1,13 +1,13 @@
-class CreateNetzkeGridColumns < ActiveRecord::Migration
+class CreateNetzkeGridPanelColumns < ActiveRecord::Migration
   def self.up
-    create_table :netzke_grid_columns do |t|
+    create_table :netzke_grid_panel_columns do |t|
       t.string    :name
       t.string    :label
       t.boolean   :read_only
       t.integer   :position
       t.boolean   :hidden
       t.integer   :width
-      t.string    :shows_as, :limit => 32
+      t.string    :editor, :limit => 32
 
       t.integer   :layout_id
       
@@ -16,6 +16,6 @@ class CreateNetzkeGridColumns < ActiveRecord::Migration
   end
 
   def self.down
-    drop_table :netzke_grid_columns
+    drop_table :netzke_grid_panel_columns
   end
 end

data/javascripts/basepack.js

@@ -41,7 +41,7 @@ Ext.netzke.editors = {
 	}
 };
 
-// Mapping of showsAs field to grid filters
+// Mapping of editor field to grid filters
 Ext.netzke.filterMap = {
 	number_field:'Numeric',
 	text_field:'String',

data/lib/app/models/{netzke_grid_column.rb → netzke_grid_panel_column.rb}

@@ -1,4 +1,4 @@
-class NetzkeGridColumn < ActiveRecord::Base
+class NetzkeGridPanelColumn < ActiveRecord::Base
   belongs_to :layout, :class_name => "NetzkeLayout"
   
   acts_as_list :scope => :layout

data/lib/netzke-basepack.rb

@@ -4,6 +4,11 @@ require 'searchlogic'
 
 require 'netzke/ar_ext'
 
+# Default boot config
+Netzke::Base.config.merge!({
+  :grid_panel => {:filters => true}
+}.recursive_merge(Object.const_defined?(:NETZKE_BOOT_CONFIG) ? Object.const_get(:NETZKE_BOOT_CONFIG) : {}))
+
 %w{ models }.each do |dir|
   path = File.join(File.dirname(__FILE__), 'app', dir)
   $LOAD_PATH << path
@@ -16,13 +21,20 @@ Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/b
 
 # TODO: implement configurable loading of JS, to spare the traffic at the initial loading
 extjs_dir = "#{RAILS_ROOT}/public/extjs"
-Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/EditableItem.js"
-Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/RangeMenu.js"
-Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/GridFilters.js"
-%w{Boolean Date List Numeric String}.unshift("").each do |f|
-  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/filter/#{f}Filter.js"
+
+# Filters in GridPanel
+if Netzke::Base.config[:grid_panel][:filters]
+  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/EditableItem.js"
+  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/RangeMenu.js"
+  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/GridFilters.js"
+  %w{Boolean Date List Numeric String}.unshift("").each do |f|
+    Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/filter/#{f}Filter.js"
+  end
+  Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/filters.js"
 end
-Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/filters.js"
 
 # Make this plugin reloadable for easier development
 ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
+
+# Include CSS
+Netzke::Base.config[:css] << "#{File.dirname(__FILE__)}/../css/basepack.css"

data/lib/netzke/accordion_panel.rb

@@ -0,0 +1,73 @@
+module Netzke
+  class AccordionPanel < Base
+    #
+    # JS-class generation
+    #
+    class << self
+
+      def js_default_config
+        super.merge({
+          :layout => 'accordion',
+          :listeners => {
+            # every item gets an expand event activeted, which dynamically loads a widget into this item 
+            :add => {
+              :fn => <<-JS.l
+              function(self, comp){
+                comp.on('expand', this.loadItemWidget, self)
+              }
+              JS
+            }
+          }
+        })
+      end
+
+      def js_extend_properties
+        {
+          # 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");
+            }
+          JS
+        }
+      end
+
+    end
+
+    def js_config
+      super.merge(:items => items)
+    end
+
+    # the items are late aggregatees (besides the ones that are marked "active")
+    def initial_aggregatees
+      res = {}
+      config[:items].each_with_index do |item, i|
+        item[:late_aggregation] = !item[:active]
+        res.merge!(item[:name].to_sym => item)
+      end
+      res
+    end
+
+    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',
+          :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
+    end
+    
+  end
+end

data/lib/netzke/ar_ext.rb

@@ -5,11 +5,11 @@ module Netzke
     end
 
     #
-    # Allow nested association acces (assocs separated by "." or "__"), e.g.: proxy_service.send('asset__gui_folder__name')
+    # Allow nested association access (assocs separated by "." or "__"), e.g.: proxy_service.asset__gui_folder__name
     # Example:
     # b = Book.first
     # b.genre__name = 'Fantasy' => b.genre = Genre.find_by_name('Fantasy')
-    # NOT IMPLEMENTED: ANY USE? b.genre__catalog__name = 'Best sellers' => b.genre_id = b.genre.find_by_catalog_id(Catalog.find_by_name('Best sellers')).id
+    # NOT IMPLEMENTED (any real use?): b.genre__catalog__name = 'Best sellers' => b.genre_id = b.genre.find_by_catalog_id(Catalog.find_by_name('Best sellers')).id
     #
     
     def method_missing(method, *args, &block)
@@ -49,8 +49,8 @@ module Netzke
       end
     end
     
-    
     module ActiveRecordClassMethods
+      # Returns all unique values for a column, filtered by the query
       def choices_for(column, query = nil)
         if respond_to?("#{column}_choices", query)
           # AR class provides the choices itself
@@ -77,11 +77,11 @@ module Netzke
       end
       
       # which columns are to be picked up by grids and forms
-      def expose_columns(columns, *args)
-        if columns == :all
+      def expose_columns(*column_configs)
+        if column_configs.first == :all
           write_inheritable_attribute(:exposed_columns, self.column_names.map(&:to_sym))
         else
-          write_inheritable_attribute(:exposed_columns, columns)
+          write_inheritable_attribute(:exposed_columns, column_configs)
         end
       end
       
@@ -108,40 +108,52 @@ module Netzke
       end
       
       #
-      # Used by Netzke::Grid
+      # Used by Netzke::GridPanel
       #
       
       DEFAULT_COLUMN_WIDTH = 100
       
+      # Returns default column config understood by Netzke::GridPanel
+      # Argument: column name (as Symbol) or column config
       def default_column_config(config)
-        config = {:name => config} if config.is_a?(Symbol) # optionally we may get only a column name (as Symbol)
+        config = config.dup
+        # config = config.dup # to not touch the original config
+        config = {:name => config} if config.is_a?(Symbol) # if got a column name
+
+        # 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
 
-        # general config
         res = {
           :name => config[:name].to_s || "unnamed",
-          :label => config[:label] || config[:name].to_s.humanize,
+          :label => config[:label] || config[:name].to_s.gsub('__', '_').humanize,
           :read_only => config[:name] == :id, # make "id" column read-only by default
           :hidden => config[:name] == :id, # hide "id" column by default
           :width => DEFAULT_COLUMN_WIDTH,
-          :shows_as => :text_field
+          :editor => ext_editor(type)
         }
 
-        case type
-          when :integer
-            res[:shows_as] = :number_field
-          when :boolean
-            res[:shows_as] = :checkbox
-            res[:width] = 50
-          when :date
-            res[:shows_as] = :date_field
-          when :datetime
-            res[:shows_as] = :datetime
-          when :string
-            res[:shows_as] = :text_field
+        # detect :assoc__method
+        if config[:name].to_s.index('__')
+          assoc_name, method = config[:name].to_s.split('__').map(&:to_sym)
+          if assoc = reflect_on_association(assoc_name)
+            assoc_column = assoc.klass.columns_hash[method.to_s]
+            assoc_method_type = assoc_column && assoc_column.type
+            if assoc_method_type
+              res[:editor] = ext_editor(assoc_method_type) == :checkbox ? :checkbox : :combo_box
+            end
+          end
         end
-
-        res.merge(config) # merge with custom confg (it has the priority)
+        
+        # detect association column (e.g. :category_id)
+        if assoc = reflect_on_all_associations.detect{|a| a.primary_key_name.to_sym == config[:name]}
+          res[:editor] = :combo_box
+          assoc_method = %w{name title label}.detect{|m| (assoc.klass.instance_methods + assoc.klass.column_names).include?(m) } || assoc.klass.primary_key
+          res[:name] = "#{assoc.name}__#{assoc_method}"
+        end
+        
+        # merge with the given confg, which has the priority
+        config.delete(:name) # because we might have changed the name
+        res.merge(config)
       end
       
       #
@@ -154,6 +166,20 @@ module Netzke
         # TODO
       end
       
+      private
+      # identify Ext editor for the data type
+      TYPE_EDITOR_MAP = {
+        :integer => :number_field,
+        :boolean => :checkbox,
+        :date => :date_field,
+        :datetime => :datetime,
+        :string => :text_field
+      }
+      
+      def ext_editor(type)
+        TYPE_EDITOR_MAP[type] || :text_field # fall back to :text_field
+      end
+      
     end
   end
 end

data/lib/netzke/border_layout_panel.rb

@@ -0,0 +1,119 @@
+module Netzke
+  class BorderLayoutPanel < Base
+    interface :resize_region
+    
+    REGIONS = %w(center west east south north).map(&:to_sym)
+
+    #
+    # JS-class generation
+    #
+    class << self
+      def js_listeners
+        {
+          :afterlayout => {:fn => "this.setResizeEvents".l, :scope => this}
+        }
+      end
+
+      def js_before_constructor
+        <<-JS.l
+          var items = [];
+          Ext.each(['center', 'west', 'east', 'south', 'north'], function(r){
+            var configName = r+'Config';
+            if (config[configName]){
+              var regionConfig = config[configName].regionConfig || {};
+              regionConfig.layout = 'fit';
+              regionConfig.region = r;
+              regionConfig.items = [new Ext.componentCache[config[configName].widgetClassName](config[configName])]
+              items.push(regionConfig);
+            };
+          }, this)
+        JS
+      end
+
+      def js_default_config
+        super.merge({
+          :layout => 'border',
+          :items => "items".l
+        })
+      end
+
+      def js_extend_properties
+        {:set_resize_events => <<-JS.l,
+          function(){
+            this.items.each(function(item, index, length){
+              if (!item.oldSize) item.oldSize = item.getSize();
+              if (item.region == 'east' || item.region == 'west') item.on('resize', function(panel, w, h){
+                if (panel.oldSize.width != w) {
+                  Ext.Ajax.request({
+                    url:this.initialConfig.interface.resizeRegion,
+                    params: {region_name: panel.region, new_width:w}
+                  });
+                  panel.oldSize.width = w;
+                }
+            		return true;
+              }, this);
+              else if (item.region == 'south' || item.region == 'north') item.on('resize', function(panel, w, h){
+                if (panel.oldSize.height != h) {
+                  Ext.Ajax.request({
+                    url:this.initialConfig.interface.resizeRegion,
+                    params: {region_name: panel.region, new_height:h}
+                  });
+                  panel.oldSize.height = h;
+                }
+            		return true;
+              }, this);
+            }, this);
+            this.un('afterlayout', this.setResizeEvents, this); // to avoid redefinition of resize events
+          }
+        JS
+      }
+      end
+      
+    end
+    
+    def initial_aggregatees
+      config[:regions] || {}
+    end
+    
+    # def items
+    #   res = []
+    #   config[:regions].each_pair do |k,v|
+    #     width = v.delete(:width)
+    #     height = v.delete(:height)
+    #     split = v[:split].nil? ? true : v.delete(:split) # split is by default true
+    #     region_config = {
+    #       :region => k, 
+    #       :width => @pref["#{k}_width"] || width || 100, 
+    #       :height => @pref["#{k}_height"] || height || 100, 
+    #       :split => split,
+    #       :layout => v.delete(:layout) || 'fit',
+    #       :id => @id_name + "_#{k}_region"
+    #     }
+    #     region_widget_instance = "Netzke::#{v[:widget_class_name]}".constantize.new(v.merge(:name => "#{id_name}__#{k}"))
+    #     region_config.merge!(v)
+    #     region_config[:items] = ["new Ext.componentCache['#{v[:widget_class_name]}'](#{region_widget_instance.js_config.to_js})".l]
+    #     res << region_config
+    #   end
+    #   res
+    # end
+    
+    def region_aggregatees
+      aggregatees.reject{ |k,v| !REGIONS.include?(k) }
+    end
+    
+    # def js_config
+    #   super.merge(:regional_config => items)
+    # end
+  
+    def interface_resize_region(params)
+      @pref["#{params[:region_name]}_width"] = params[:new_width].to_i if params[:new_width]
+      @pref["#{params[:region_name]}_height"] = params[:new_height].to_i if params[:new_height]
+    end
+    
+    protected
+  
+    def extend_functions; ""; end
+    def js_extra_events; ""; end
+    
+  end
+end