netzke-basepack 0.2.0.1 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.2.2
+Meta: updated netzke-core version (dependency)
+
+v0.2.1
+Regression: BorderLayoutPanel now restores the region sizes from the database
+
 v0.2.0.1
 Meta: updated netzke-core version (dependency)
 

data/Manifest

@@ -1,19 +1,23 @@
 CHANGELOG
 css/basepack.css
 generators/netzke_basepack/netzke_basepack_generator.rb
-generators/netzke_basepack/netzke_grid_panel_generator.rb
-generators/netzke_basepack/templates/create_netzke_grid_panel_columns.rb
 generators/netzke_basepack/USAGE
+generators/netzke_form_panel/netzke_form_panel_generator.rb
+generators/netzke_form_panel/templates/create_netzke_form_panel_fields.rb
+generators/netzke_grid_panel/netzke_grid_panel_generator.rb
+generators/netzke_grid_panel/templates/create_netzke_grid_panel_columns.rb
 init.rb
 install.rb
 javascripts/basepack.js
 javascripts/filters.js
+lib/app/models/netzke_form_panel_field.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/form_panel.rb
 lib/netzke/grid_panel.rb
 lib/netzke/grid_panel_interface.rb
 lib/netzke/grid_panel_js_builder.rb
@@ -26,7 +30,7 @@ lib/netzke-basepack.rb
 LICENSE
 Manifest
 Rakefile
-README.mdown
+README.rdoc
 tasks/netzke_basepack_tasks.rake
 test/app_root/app/controllers/application.rb
 test/app_root/app/models/book.rb
@@ -51,7 +55,12 @@ test/app_root/db/migrate/20081223024935_create_categories.rb
 test/app_root/db/migrate/20081223025635_create_countries.rb
 test/app_root/db/migrate/20081223025653_create_continents.rb
 test/app_root/db/migrate/20081223025732_create_cities.rb
+test/app_root/db/migrate/20090102223630_create_netzke_layouts.rb
+test/app_root/db/migrate/20090102223811_create_netzke_grid_panel_columns.rb
 test/app_root/script/console
+test/app_root/vendor/plugins/acts_as_list/init.rb
+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

data/README.rdoc

@@ -0,0 +1,87 @@
+= netzke-basepack
+A pack of basic Rails/Ext JS widgets, as a part of Netzke framework. Live demo/tutorials on http://blog.writelesscode.com
+
+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.
+
+= Prerequisites
+1. Rails >= 2.2
+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
+Install the gem:
+    gem install netzke-basepack
+
+Include it into environment.rb:
+    config.gem "netzke-basepack"
+
+Include mapping for Netzke controller providing *.js and *.css (in routes.rb):
+    map.netzke
+
+= Usage
+First, run the generators to have the necessary migrations:
+    ./script/generate netzke_core
+    ./script/generate netzke_grid_panel
+
+Do the migrations:
+    rake db:migrate
+
+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 run the migrations after it)
+
+In the controller declare the widget:
+
+    class WelcomeController < ApplicationController
+      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://localhost:3000/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):
+
+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 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:
+
+1. books_class_definition will contain the javascript code defining the code for the JS class.
+2. books_widget_instance will declare a local javascript variable called book.
+
+Use these helpers inside of the script-tag like the following (in the view):
+	
+    <script type="text/javascript" charset="utf-8">
+    <%= books_class_definition %>
+    Ext.onReady(function(){
+    	<%= books_widget_instance %>
+    	books.render("books");
+    })
+    </script>
+    <div id="books">the widget will be rendered in this div</div>
+
+If your layout already calls yield :javascripts wrapped in the <script>-tag, you can have all javascript-code in one place on the page:
+
+    <% content_for :javascripts do %>
+    <%= books_class_definition %>
+    Ext.onReady(function(){
+    	<%= books_widget_instance %>
+    	books.render("books");
+    })
+    <% end %>
+    <p>... your page content here ...</p>
+    <div id="books">the widget will be rendered in this div</div>
+
+== Dynamic loading of widgets
+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

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

data/generators/netzke_form_panel/netzke_form_panel_generator.rb

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

data/generators/netzke_form_panel/templates/create_netzke_form_panel_fields.rb

@@ -0,0 +1,22 @@
+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.boolean   :hidden
+      t.integer   :width
+      t.integer   :height
+      t.string    :editor, :limit => 32
+
+      t.integer   :layout_id
+      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :netzke_form_panel_fields
+  end
+end

data/javascripts/basepack.js

@@ -49,4 +49,34 @@ Ext.netzke.filterMap = {
 	checkbox:'Boolean',
 	combo_box:'String',
 	date:'Date'
-}
+}
+
+Ext.data.RecordArrayReader = Ext.extend(Ext.data.JsonReader, {
+    /**
+     * Create a data block containing Ext.data.Records from an Array.
+     * @param {Object} o An Array of row objects which represents the dataset.
+     * @return {Object} data A data block which is used by an Ext.data.Store object as
+     * a cache of Ext.data.Records.
+     */
+    readRecord : function(o){
+      var sid = this.meta ? this.meta.id : null;
+    	var recordType = this.recordType, fields = recordType.prototype.fields;
+    	var records = [];
+    	var root = o;
+	    // for(var i = 0; i < root.length; i++){
+		    var n = root;
+	        var values = {};
+	        var id = ((sid || sid === 0) && n[sid] !== undefined && n[sid] !== "" ? n[sid] : null);
+	        for(var j = 0, jlen = fields.length; j < jlen; j++){
+                var f = fields.items[j];
+                var k = f.mapping !== undefined && f.mapping !== null ? f.mapping : j;
+                var v = n[k] !== undefined ? n[k] : f.defaultValue;
+                v = f.convert(v, n);
+                values[f.name] = v;
+            }
+	        var record = new recordType(values, id);
+	        record.json = n;
+	    // }
+	    return record;
+    }
+});

data/lib/app/models/netzke_form_panel_field.rb

@@ -0,0 +1,18 @@
+class NetzkeFormPanelField < ActiveRecord::Base
+  belongs_to :layout, :class_name => "NetzkeLayout"
+  
+  acts_as_list :scope => :layout
+
+  def self.create_layout_for_widget(widget)
+    layout = NetzkeLayout.create(:widget_name => widget.id_name, :items_class => self.name, :user_id => NetzkeLayout.user_id)
+
+    columns = Netzke::Column.default_fields_for_widget(widget)
+
+    for c in columns
+      config_for_create = c.merge(:layout_id => layout.id).stringify_values!
+      create(config_for_create)
+    end
+    
+    layout
+  end
+end

data/lib/app/models/netzke_grid_panel_column.rb

@@ -3,14 +3,8 @@ class NetzkeGridPanelColumn < ActiveRecord::Base
   
   acts_as_list :scope => :layout
 
-  # old?
-  # def self.create_with_defaults(column_config, klass)
-  #   create(klass.default_column_config(column_config).stringify_values!)
-  # end
-  
   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_columns_for_widget(widget)
 
     for c in columns

data/lib/netzke/ar_ext.rb

@@ -49,7 +49,24 @@ module Netzke
       end
     end
     
+    def to_array(columns)
+      res = []
+      for c in columns
+        method = c.is_a?(Symbol) ? c : c[:name]
+        res << send(method)
+      end
+      res
+    end
+    
     module ActiveRecordClassMethods
+      # next and previous to id records
+      def next(id)
+        find(:first, :conditions => ["#{primary_key} > ?", id])
+      end
+      def previous(id)
+        find(:first, :conditions => ["#{primary_key} < ?", id], :order => "#{primary_key} DESC")
+      end
+      
       # Returns all unique values for a column, filtered by the query
       def choices_for(column, query = nil)
         if respond_to?("#{column}_choices", query)
@@ -107,18 +124,8 @@ module Netzke
         read_inheritable_attribute(:virtual_columns).keys.include?(column)
       end
       
-      #
-      # 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 = config.dup
-        # config = config.dup # to not touch the original config
-        config = {:name => config} if config.is_a?(Symbol) # if got a column name
+      def default_dbfield_config(config, mode = :grid)
+        config = config.is_a?(Symbol) ? {:name => config} : config.dup
 
         # 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
@@ -128,9 +135,12 @@ module Netzke
           :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,
+          :width => mode == :grid ? DEFAULT_COLUMN_WIDTH : DEFAULT_FIELD_WIDTH,
           :editor => ext_editor(type)
         }
+        
+        # for forms fields also set up the height
+        res.merge!(:height => DEFAULT_FIELD_HEIGHT) if mode == :form
 
         # detect :assoc__method
         if config[:name].to_s.index('__')
@@ -157,13 +167,38 @@ module Netzke
       end
       
       #
-      # Used by Netzke::Form
+      # 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)
+        default_dbfield_config(config, :grid)
+      end
+      
+      #
+      # Used by Netzke::FormPanel
       #
       
       DEFAULT_FIELD_WIDTH = 100
-      DEFAULT_FIELD_HEIGHT = 50
+      DEFAULT_FIELD_HEIGHT = nil
       def default_field_config(config)
-        # TODO
+        # default_dbfield_config(config, :form)
+        config = config.is_a?(Symbol) ? {:name => config} : config.dup
+
+        # 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]
+        }
+        
       end
       
       private
@@ -176,6 +211,14 @@ module Netzke
         :string => :text_field
       }
       
+      XTYPE_MAP = {
+        :integer => :numberfield,
+        :boolean => :textfield,
+        :date => :datefield,
+        :datetime => :datefield,
+        :string => :textfield
+      }
+      
       def ext_editor(type)
         TYPE_EDITOR_MAP[type] || :text_field # fall back to :text_field
       end

data/lib/netzke/border_layout_panel.rb

@@ -20,7 +20,7 @@ module Netzke
           Ext.each(['center', 'west', 'east', 'south', 'north'], function(r){
             var configName = r+'Config';
             if (config[configName]){
-              var regionConfig = config[configName].regionConfig || {};
+              var regionConfig = config.regions[r] || {};
               regionConfig.layout = 'fit';
               regionConfig.region = r;
               regionConfig.items = [new Ext.componentCache[config[configName].widgetClassName](config[configName])]
@@ -75,39 +75,28 @@ module Netzke
       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 js_config
+      regions = {}
+      REGIONS.each do |r|
+        if region_aggr = aggregatees[r]
+          regions.merge!(r => region_aggr[:region_config] || {})
+          height = persistent_config["#{r}_height"] ||= regions[r][:height] if regions[r][:height]
+          width = persistent_config["#{r}_width"] ||= regions[r][:width] if regions[r][:width]
+          regions[r].merge!(:height => height)
+          regions[r].merge!(:width => width)
+        end
+      end
+      super.merge(:regions => regions)
+    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]
+    def resize_region(params)
+      persistent_config["#{params[:region_name]}_width"] = params[:new_width].to_i if params[:new_width]
+      persistent_config["#{params[:region_name]}_height"] = params[:new_height].to_i if params[:new_height]
+      {}
     end
     
     protected