netzke-basepack 0.5.5.1 → 0.5.6

data/CHANGELOG.rdoc

@@ -1,3 +1,18 @@
+= v0.5.6
+* Compatibility with latest netzke-core
+* Compatibility with Ext JS v3.1
+* Impr: Code reorganization
+* Impr: Non-standard primary key support in GridPanel and FormPanel
+* Impr: Search button in GridPanel indicates that records filtering is active
+* Fix: by default, SearchPanel excludes boolean fields for now (until a 3-state checkbox is introduced)
+* Impr: made it possible to create new AR records with assigned associations using double-underscore notation, e.g.: Clerk.new(:boss__last_name => "Aguraijuja ")
+* Impr: specifying an item for Netzke::Window is now optional
+* Fix: xtype field in FieldsConfigurator is now a combobox
+* Fix: FieldsConfigurator was crashing when fired consequently for grid and form
+* Depr: :data_class_name option is deprecated, use :model
+* Impr: "gear" tool is now hidden on FieldsConfigurator
+* Impr: Grid/FormPanel layouts are now not stored into the netzke_preferences table unless the defaults are modified (cleaner table)
+
 = v0.5.5.1 - 2009-11-09
 * Compatibility with latest netzke-core
 
@@ -5,7 +20,7 @@
 * Compatibility with latest netzke-core
 * Regression: pressing "enter" was not submitting the form (FormPanel)
 * Regression: "Restore defaults" button was not working in FieldsConfigurator and PropertyEditor
-* Fix: excluding columns in FieldConfigurator was causing inconsistent column behavior (move/hide/resize)
+* Fix: excluding columns in FieldsConfigurator was causing inconsistent column behavior (move/hide/resize)
 * Fix: resolving conflicts with Ext.form.FormPanel's <tt>submit</tt> and <tt>load</tt> methods
 * New: rudimentary FileUploadField support in FormPanel (it will do a normal, non-AJAX, form submit)
 * New: Netzke::Window widget, supports persistent moving/resizing.

data/README.rdoc

@@ -1,20 +1,30 @@
 = netzke-basepack
 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 and the Wiki: http://github.com/skozlov/netzke
 
-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 >= 3.0: its root by default must be accessible as RAILS_ROOT/public/extjs. You may symlink your Ext JS library here like this (from your app folder):
+2. ExtJS = 3.0.3. Its root by default 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-3.0 extjs
+    cd public && ln -s ~/Developer/extjs/ext-3.0.3 extjs
 
-3. acts_as_list plugin must be installed: 
+3. acts_as_list plugin: 
 
     ./script/plugin install git://github.com/rails/acts_as_list.git
 
+4. netzke-core gem or plugin. Gem:
+  
+    gem install netzke-core
+    
+Plugin (for the "edge" stuff, recommended):
+
+    ./script/plugin install git://github.com/skozlov/netzke-core.git
+
 = Installation
-The gem is hosted on gemcutter. If you haven't yet enabled gemcutter, run the following:
+For the "edge" stuff, install as plugin (recommended):
+
+    ./script/plugin install git://github.com/skozlov/netzke-basepack.git
+
+Otherwise install as gem. The gem is hosted on gemcutter. If you haven't yet enabled gemcutter, run the following:
 
     sudo gem install gemcutter && gem tumble
 
@@ -22,74 +32,39 @@ Install the gem:
 
     gem install netzke-basepack
 
-Include it into environment.rb:
+= Usage
+If using as gem, include it into environment.rb:
 
     config.gem "netzke-basepack"
 
-Include mapping for Netzke controller providing *.js and *.css (in routes.rb):
+Include mapping for Netzke controller providing Netzke javascripts and styles (in routes.rb):
 
     map.netzke
 
-= Usage
-First, run the generators to have the necessary migrations:
+To be able to use persistent on-the-fly configuration of widgets, run netzke-core generators to have the necessary migrations:
 
     ./script/generate netzke_core
 
-Do the migrations:
+... then run 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 re-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 (like BasicApp-derived, if you want a desktop-like, AJAX-driven web-app).
+== Embedding widgets into Rails' view
+To enable Netzke widgets in Rails' views, you need to add the following helper into your layout template, inside the "head" tag:
 
-== 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's name.
+    <%= netzke_init %>
+    
+This will include both ExtJS-related files (JavaScript and styles), and Netzke-related files.
 
-== 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):
+Now let's embed a widget into a view. The following example will provide you with a grid-based scaffold for ActiveRecord-model called Book. You may generate it like this:
 
-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'.
-3. books_widget_render will provide the JavaScript code that calls the "render" method on the variable declared by books_widget_instance; the widget will be rendered into a div with id "books-div".
+    ./script/generate model Book title:string amount:integer
 
-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_widget_render %>
-    })
-    </script>
-    <div id="books-div">the widget will be rendered in this div</div>
+(don't forget to re-run the migrations after it)
 
-If your layout already calls yield :javascripts wrapped in the <script>-tag, you can have all javascript-code in one place on the page:
+Now embed a widget into a view like this:
 
-    <% 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-div">the widget will be rendered in this div</div>
+  <%= netzke :books, :class_name => 'GridPanel', :model => 'Book' %>
 
 == Dynamic loading of widgets
 TODO: this part will be covered later

data/Rakefile

@@ -1,7 +1,7 @@
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.version = "0.5.5.1"
+    gemspec.version = "0.5.6"
     gemspec.name = "netzke-basepack"
     gemspec.summary = "Pre-built Rails + ExtJS widgets for your RIA"
     gemspec.description = "A set of full-featured extendible Netzke widgets (such as FormPanel, GridPanel, Window, BorderLayoutPanel, etc) which can be used as building block for your RIA"
@@ -9,7 +9,7 @@ begin
     gemspec.homepage = "http://github.com/skozlov/netzke-basepack"
     gemspec.rubyforge_project = "netzke-basepack"
     gemspec.authors = ["Sergei Kozlov"]
-    gemspec.add_dependency("netzke-core", ">=0.4.5.2")
+    gemspec.add_dependency("netzke-core", ">=0.5.0")
     gemspec.add_dependency("searchlogic", ">=2.0.0")
     gemspec.add_dependency("will_paginate", ">=2.0.0")
   end

data/TODO.rdoc

@@ -9,5 +9,8 @@
 == Optimizations
 * Check persistent_config-related queries (aren't they too many?)
 
+== Code design
+* Replace <tt>initial_late_aggregatees</tt> method with a set of methods for each aggregatee, so that more logic would be possible at the moment of on-demand aggregatee loading.
+
 == One day
 * Replace xcheckbox with checkbox in FormPanel

data/javascripts/basepack.js

@@ -22,7 +22,7 @@ Ext.netzke.ComboBox = Ext.extend(Ext.form.ComboBox, {
     } else {
       var row = Ext.data.Record.create([{name:'id'}]);
       var store = new Ext.data.Store({
-        proxy         : new Ext.data.HttpProxy({url:this.parentId+"__get_combobox_options", jsonData:{column:this.name}}),
+        proxy         : new Ext.data.HttpProxy({url: Ext.getCmp(this.parentId).buildApiUrl("get_combobox_options"), jsonData:{column:this.name}}),
         reader        : new Ext.data.ArrayReader({root:'data', id:0}, row)
       });
     
@@ -794,35 +794,75 @@ Ext.grid.HeaderDropZone.prototype.onNodeDrop = function(n, dd, e, data){
         return true;
     }
     return false;
-}
-
-// Feedback Ghost
-Netzke.FeedbackGhost = function(){};
-Ext.apply(Netzke.FeedbackGhost.prototype, {
-  showFeedback: function(msg){
-    var createBox = function(s, l){
-        return ['<div class="msg">',
-                '<div class="x-box-tl"><div class="x-box-tr"><div class="x-box-tc"></div></div></div>',
-                '<div class="x-box-ml"><div class="x-box-mr"><div class="x-box-mc">', s, '</div></div></div>',
-                '<div class="x-box-bl"><div class="x-box-br"><div class="x-box-bc"></div></div></div>',
-                '</div>'].join('');
-    }
+};
 
-    var showBox = function(msg, lvl){
-      if (!lvl) {lvl = 'notice'};
-      var msgCt = Ext.DomHelper.insertFirst(document.body, {'class':'netzke-feedback'}, true);
-      var m = Ext.DomHelper.append(msgCt, {html:createBox(msg,lvl)}, true);
-      m.slideIn('t').pause(2).ghost("b", {remove:true});
-    }
+// Temporary fix for Ext 3.1 resize problem:
+Ext.override(Ext.Panel, {
+
+   // private
+    onResize : function(w, h, rw, rh){
+        if(Ext.isDefined(w) || Ext.isDefined(h)){
+            if(!this.collapsed){
+                // First, set the the Panel's body width.
+                // If we have auto-widthed it, get the resulting full offset width so we can size the Toolbars to match
+                // The Toolbars must not buffer this resize operation because we need to know their heights.
+
+                if(Ext.isNumber(w)){
+                    this.body.setWidth(w = this.adjustBodyWidth(w - this.getFrameWidth()));
+                } else if (w == 'auto') {
+                    w = this.body.setWidth('auto').dom.offsetWidth;
+                } else {
+                    w = this.body.dom.offsetWidth;
+                }
 
-    if (typeof msg != 'string') {
-      var compoundMsg = "";
-      Ext.each(msg, function(m){
-        compoundMsg += m.msg + '<br>';
-      });
-      if (compoundMsg != "") showBox(compoundMsg, null); // the second parameter will be level
-    } else {
-      showBox(msg);
+                if(this.tbar){
+                    this.tbar.setWidth(w);
+                    if(this.topToolbar){
+                        this.topToolbar.setSize(w);
+                    }
+                }
+                if(this.bbar){
+                    this.bbar.setWidth(w);
+                    if(this.bottomToolbar){
+                        this.bottomToolbar.setSize(w);
+                        // The bbar does not move on resize without this.
+                        if (Ext.isIE) {
+                            this.bbar.setStyle('position', 'static');
+                            this.bbar.setStyle('position', '');
+                        }
+                    }
+                }
+                if(this.footer){
+                    this.footer.setWidth(w);
+                    if(this.fbar){
+                        this.fbar.setSize(Ext.isIE ? (w - this.footer.getFrameWidth('lr')) : 'auto');
+                    }
+                }
+
+                // At this point, the Toolbars must be layed out for getFrameHeight to find a result.
+                if(Ext.isNumber(h)){
+                    h = Math.max(0, this.adjustBodyHeight(h - this.getFrameHeight()));
+                    this.body.setHeight(h);
+                }else if(h == 'auto'){
+                    this.body.setHeight(h);
+                }
+
+                if(this.disabled && this.el._mask){
+                    this.el._mask.setSize(this.el.dom.clientWidth, this.el.getHeight());
+                }
+            }else{
+                this.queuedBodySize = {width: w, height: h};
+                if(!this.queuedExpand && this.allowQueuedExpand !== false){
+                    this.queuedExpand = true;
+                    this.on('expand', function(){
+                        delete this.queuedExpand;
+                        this.onResize(this.queuedBodySize.width, this.queuedBodySize.height);
+                    }, this, {single:true});
+                }
+            }
+            this.onBodyResize(w, h);
+        }
+        this.syncShadow();
+        Ext.Panel.superclass.onResize.call(this, w, h, rw, rh);
     }
-	}
-});
+});

data/lib/app/models/netzke_auto_column.rb

@@ -1,56 +1,4 @@
-require 'acts_as_list'
-class NetzkeAutoColumn < ActiveRecord::Base
-  
+class NetzkeAutoColumn < NetzkeAutoTable
   acts_as_list
   default_scope :order => "position"
-
-  # Returns an array of column configuration hashes (without the "id" attribute)
-  def self.all_columns
-    self.all.map do |c|
-      column_hash = c.attributes.reject{ |k,v| k == 'id' }
-      column_hash.each_pair do |k,v|
-        # try to detect JSON format
-        begin
-          normalized_value = v.is_a?(String) ? ActiveSupport::JSON.decode(v) : v
-        rescue ActiveSupport::JSON::ParseError
-          normalized_value = v
-        end
-        column_hash[k] = normalized_value
-      end
-      column_hash
-    end
-  end
-
-  # Build the table with columns for this widget
-  def self.rebuild_table
-    connection.drop_table('netzke_auto_columns') if table_exists?
-  
-    normalized_config_columns = []
-    
-    @@widget.class.config_columns.each do |mc|
-      column_hash = mc.is_a?(Symbol) ? {:name => mc} : mc
-      column_hash[:type] ||= :string
-      normalized_config_columns << column_hash
-    end
-    
-    # create the table with the fields
-    self.connection.create_table('netzke_auto_columns') do |t|
-      normalized_config_columns.each do |mc|
-        t.column mc[:name], mc[:type], :default => mc[:default]
-      end
-      t.column :position, :integer
-    end
-
-    # populate the table with data
-    NetzkeAutoColumn.create @@widget.normalized_columns.map(&:deebeefy_values) rescue ActiveRecord::UnknownAttributeError
-    
-  end
-
-  def self.widget=(widget)
-    @@widget = widget
-    if Netzke::Base.session["netzke_auto_column_last_widget"] != @@widget.global_id
-      rebuild_table
-      Netzke::Base.session["netzke_auto_column_last_widget"] = @@widget.global_id
-    end
-  end
 end

data/lib/app/models/netzke_auto_field.rb

@@ -0,0 +1,4 @@
+class NetzkeAutoField < NetzkeAutoTable
+  acts_as_list
+  default_scope :order => "position"
+end

data/lib/app/models/netzke_auto_table.rb

@@ -0,0 +1,61 @@
+require 'acts_as_list'
+
+class NetzkeAutoTable < ActiveRecord::Base
+  
+  # Returns an array of column configuration hashes (without the "id" attribute)
+  def self.all_columns
+    self.all.map do |c|
+      column_hash = c.attributes.reject{ |k,v| k == 'id' }
+      column_hash.each_pair do |k,v|
+        # try to detect JSON format
+        begin
+          normalized_value = v.is_a?(String) ? ActiveSupport::JSON.decode(v) : v
+        rescue ActiveSupport::JSON::ParseError
+          normalized_value = v
+        end
+        column_hash[k] = normalized_value
+      end
+      column_hash
+    end
+  end
+
+  # Build the table with columns for this widget
+  def self.rebuild_table
+    connection.drop_table(table_name) if table_exists?
+  
+    normalized_config_columns = []
+    
+    widget = read_inheritable_attribute(:widget)
+    
+    widget.class.config_columns.each do |mc|
+      column_hash = mc.is_a?(Symbol) ? {:name => mc} : mc
+      column_hash[:type] ||= :string
+      normalized_config_columns << column_hash
+    end
+    
+    # create the table with the fields
+    self.connection.create_table(table_name) do |t|
+      normalized_config_columns.each do |mc|
+        t.column mc[:name], mc[:type], :default => mc[:default]
+      end
+      t.column :position, :integer
+    end
+
+    # populate the table with data
+    create widget.normalized_columns.map(&:deebeefy_values) # rescue ActiveRecord::UnknownAttributeError
+    
+  end
+
+  def self.table_name
+    self.name.tableize
+  end
+
+  def self.widget=(widget)
+    write_inheritable_attribute(:widget, widget)
+    if Netzke::Base.session["#{table_name}_last_widget"] != widget.global_id
+      rebuild_table
+      Netzke::Base.session["#{table_name}_last_widget"] = widget.global_id
+    end
+  end
+  
+end

data/lib/netzke-basepack.rb

@@ -1,11 +1,18 @@
 # External dependencies
+require 'active_support'
 require 'netzke-core'
-require 'searchlogic'
-require 'will_paginate'
 
-require 'netzke/active_record/basepack'
+# ExtJS-related constants
 require 'netzke/ext'
 
+# Make widget classes auto-loadable with help of ActiveSupport
+path = File.dirname(__FILE__)
+ActiveSupport::Dependencies.load_paths << path
+
+# Make this plugin auto-reloadable for easier development
+ActiveSupport::Dependencies.load_once_paths.delete(path)
+
+# Make gem's models auto-loadable
 %w{ models }.each do |dir|
   path = File.join(File.dirname(__FILE__), 'app', dir)
   $LOAD_PATH << path
@@ -13,11 +20,10 @@ require 'netzke/ext'
   ActiveSupport::Dependencies.load_once_paths.delete(path)
 end
 
-# Make this plugin reloadable at app restart for easier development
-ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
-
 # Include javascript & styles required by all basepack widgets. 
 # These files will get loaded at the initial load of the framework (along with Ext and Netzke-core).
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
 Netzke::Base.config[:stylesheets] << "#{File.dirname(__FILE__)}/../stylesheets/basepack.css"
-Netzke::Base.config[:stylesheets] << Netzke::Base.config[:ext_location] + "/examples/form/file-upload.css"
+
+# FIXME: doesn't belong here
+Netzke::Base.config[:stylesheets] << Netzke::Base.config[:ext_location] + "/examples/ux/fileuploadfield/css/fileuploadfield.css" if Netzke::Base.config[:ext_location]