netzke-basepack 0.5.6 → 0.5.7

data/CHANGELOG.rdoc

@@ -1,4 +1,9 @@
-= v0.5.6
+= v0.5.7 - 2010-02-26
+* Regression: column config for GridPanel again accepts a renderer along with its parameters (as array, where the first element is the renderers name, the second - the parameters passed to the renderer, e.g.: :renderer => ["date", "y-m-d"])
+* Fix: Window resize/move now works correctly
+* Code: taking care of deprecated methods
+
+= v0.5.6 - 2010-01-10
 * Compatibility with latest netzke-core
 * Compatibility with Ext JS v3.1
 * Impr: Code reorganization

data/README.rdoc

@@ -3,9 +3,9 @@ A pack of basic Rails/ExtJS widgets as a part of the Netzke framework. Live demo
 
 = Prerequisites
 1. Rails >= 2.2
-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):
+2. Netzke assumes that your ExtJS library is in public/extjs, which may be a symbolic link, e.g:
 
-    cd public && ln -s ~/Developer/extjs/ext-3.0.3 extjs
+    cd public && ln -s ~/Developer/extjs/ext-3.1.1 extjs
 
 3. acts_as_list plugin: 
 
@@ -24,11 +24,7 @@ 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
-
-Install the gem:
+Or install as gem:
 
     gem install netzke-basepack
 
@@ -66,10 +62,19 @@ Now embed a widget into a view like this:
 
   <%= netzke :books, :class_name => 'GridPanel', :model => 'Book' %>
 
-== Dynamic loading of widgets
-TODO: this part will be covered later
+For more examples, see http://netzke-demo.writelesscode.com
+
+== More info
+Introduction to Netzke framework and wiki: http://github.com/skozlov/netzke
+
+Twitter: http://twitter.com/skozlov
+
+Tutorials: http://blog.writelesscode.com
+
+Live-demo with sample code: http://netzke-demo.writelesscode.com
 
 = Credentials
 Testing done with the help of http://github.com/pluginaweek/plugin_test_helper
 
-Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license
+---
+Copyright (c) 2008-2010 Sergei Kozlov, released under the MIT license

data/Rakefile

@@ -1,7 +1,7 @@
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.version = "0.5.6"
+    gemspec.version = "0.5.7"
     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.5.0")
+    gemspec.add_dependency("netzke-core", ">=0.5.1")
     gemspec.add_dependency("searchlogic", ">=2.0.0")
     gemspec.add_dependency("will_paginate", ">=2.0.0")
   end

data/lib/netzke/accordion_panel.rb

@@ -104,7 +104,7 @@ module Netzke
     def initial_aggregatees
       res = {}
       config[:items].each_with_index do |item, i|
-        item[:late_aggregation] = !item[:active]
+        item[:late_aggregation] = !item[:active] && !item[:preloaded]
         res.merge!(item[:name].to_sym => item)
       end
       res

data/lib/netzke/border_layout_panel.rb

@@ -22,10 +22,10 @@ module Netzke
   # == Example configuration:
   # 
   #     :regions => {
-  #       :center => {:widget_class_name => "Panel", :ext_config => {:html => "A panel"}}, 
+  #       :center => {:class_name => "Panel", :ext_config => {:html => "A panel"}}, 
   #       :west => {
-  #         :widget_class_name => "GridPanel", 
-  #         :data_class_name => "User", 
+  #         :class_name => "GridPanel", 
+  #         :model => "User", 
   #         :region_config => {
   #           :width => 100,
   #           :split => true

data/lib/netzke/fields_configurator.rb

@@ -25,7 +25,7 @@ module Netzke
     def default_config
       super.deep_merge({
         :name              => 'columns',
-        :data_class_name   => is_for_grid? ? "NetzkeAutoColumn" : "NetzkeAutoField",
+        :model   => is_for_grid? ? "NetzkeAutoColumn" : "NetzkeAutoField",
         :ext_config        => {
           :header => false,
           :enable_extended_search => false,

data/lib/netzke/form_panel.rb

@@ -76,7 +76,7 @@ module Netzke
       
       res << {
         :name              => 'fields',
-        :widget_class_name => "FieldsConfigurator",
+        :class_name => "FieldsConfigurator",
         :active            => true,
         :widget            => self,
         :persistent_config => true
@@ -84,7 +84,7 @@ module Netzke
 
       res << {
         :name               => 'general',
-        :widget_class_name  => "PropertyEditor",
+        :class_name  => "PropertyEditor",
         :widget             => self,
         :ext_config         => {:title => false}
       }
@@ -106,7 +106,7 @@ module Netzke
     def js_config
       res = super
       res.merge!(:clmns => columns)
-      res.merge!(:data_class_name => data_class.name) if data_class
+      res.merge!(:model => data_class.name) if data_class
       res.merge!(:pri => data_class.primary_key) if data_class
       res
     end

data/lib/netzke/form_panel/form_panel_api.rb

@@ -42,7 +42,7 @@ module Netzke
 
       # API handling form load
       # def load(params)
-      #   klass = config[:data_class_name].constantize
+      #   klass = config[:model].constantize
       #   case params[:neighbour]
       #     when "previous" then @record = klass.previous(params[:id])
       #     when "next"     then @record = klass.next(params[:id])

data/lib/netzke/grid_panel.rb

@@ -237,13 +237,13 @@ module Netzke
       res << {
         :persistent_config => true,
         :name              => 'columns',
-        :widget_class_name => "FieldsConfigurator",
+        :class_name => "FieldsConfigurator",
         :active            => true,
         :widget            => self
       }
       res << {
         :name               => 'general',
-        :widget_class_name  => "PropertyEditor",
+        :class_name  => "PropertyEditor",
         :widget             => self,
         :ext_config         => {:title => false}
       }
@@ -269,14 +269,14 @@ module Netzke
       # Edit in form
       res.merge!({
         :add_form => {
-          :widget_class_name => "GridPanel::RecordFormWindow",
+          :class_name => "GridPanel::RecordFormWindow",
           :ext_config => {
             :title => "Add #{data_class.name.humanize}",
             :button_align => "right"
           },
           :item => {
-            :widget_class_name => "FormPanel",
-            :data_class_name => data_class.name,
+            :class_name => "FormPanel",
+            :model => data_class.name,
             :persistent_config => config[:persistent_config],
             :strong_default_attrs => config[:strong_default_attrs],
             :ext_config => {
@@ -290,8 +290,8 @@ module Netzke
         },
         
         :edit_form => {
-          :widget_class_name => "FormPanel",
-          :data_class_name => data_class.name,
+          :class_name => "FormPanel",
+          :model => data_class.name,
           :persistent_config => config[:persistent_config],
           :ext_config => {
             :bbar => false,
@@ -301,8 +301,8 @@ module Netzke
         },
         
         :multi_edit_form => {
-          :widget_class_name => "FormPanel",
-          :data_class_name => data_class.name,
+          :class_name => "FormPanel",
+          :model => data_class.name,
           :persistent_config => config[:persistent_config],
           :ext_config => {
             :bbar => false,
@@ -312,8 +312,8 @@ module Netzke
         },
         
         :new_record_form => {
-          :widget_class_name => "FormPanel",
-          :data_class_name => data_class.name,
+          :class_name => "FormPanel",
+          :model => data_class.name,
           :persistent_config => config[:persistent_config],
           :strong_default_attrs => config[:strong_default_attrs],
           :ext_config => {
@@ -328,7 +328,7 @@ module Netzke
       # Extended search
       res.merge!({
         :search_panel => {
-          :widget_class_name => "SearchPanel",
+          :class_name => "SearchPanel",
           :search_class_name => data_class.name,
           :persistent_config => config[:persistent_config],
           :ext_config => {

data/lib/netzke/grid_panel/grid_panel_js.rb

@@ -8,7 +8,7 @@ module Netzke
       def js_config
         res = super
         res.merge!(:clmns => columns)
-        res.merge!(:data_class_name => config[:data_class_name])
+        res.merge!(:model => config[:model])
         res.merge!(:inline_data => get_data) if ext_config[:load_inline_data]
         res.merge!(:pri => data_class.primary_key)
         res
@@ -106,7 +106,7 @@ module Netzke
                   }
 
                   // set the renderer
-                  if (c.renderer && c.renderer.match(/^\\s*function\\s*\\(/)) {
+                  if (c.renderer && !Ext.isArray(c.renderer) && c.renderer.match(/^\\s*function\\s*\\(/)) {
                     // if the renderer is an inline function - eval it (double escaping because we are inside of the Ruby string here...)
                     eval("c.renderer = " + c.renderer + ";");
                   } else {

data/lib/netzke/masquerade_selector.rb

@@ -5,8 +5,8 @@ module Netzke
       @items ||= [{
           :name              => "roles",
           :active            => true,
-          :widget_class_name => "GridPanel",
-          :data_class_name   => 'Role',
+          :class_name => "GridPanel",
+          :model   => 'Role',
           :columns           => [:id, :name],
           :ext_config => {
             :header        => false,
@@ -15,8 +15,8 @@ module Netzke
         },{
           :name                 => "users",
           :preloaded            => true,
-          :widget_class_name    => "GridPanel", 
-          :data_class_name      => 'User', 
+          :class_name    => "GridPanel", 
+          :model      => 'User', 
           :ext_config           => {
             :header        => false,
             :rows_per_page => 10,

data/lib/netzke/plugins/configuration_tool.rb

@@ -31,7 +31,7 @@ module Netzke::Plugins
           :on_gear => <<-END_OF_JAVASCRIPT.l
             function(){
               var w = new Ext.Window({
-                title:'Config - '+ this.dataClassName,
+                title:'Config - '+ this.model,
                 layout:'fit',
                 modal:true,
                 width: Ext.lib.Dom.getViewWidth() *0.9,
@@ -93,7 +93,7 @@ module Netzke::Plugins
       # Add the ConfigurationPanel as aggregatee, which in its turn aggregates widgets from the 
       # configuration_widgets method
       res.merge!(:configuration_panel => {
-        :widget_class_name => 'ConfigurationPanel', 
+        :class_name => 'ConfigurationPanel', 
         :items => configuration_widgets,
         :late_aggregation => true
       }) if config_tool_needed?

data/lib/netzke/search_panel.rb

@@ -9,7 +9,7 @@ module Netzke
     
     def default_config
       super.merge({
-        :data_class_name => @passed_config[:search_class_name]
+        :model => @passed_config[:search_class_name]
       })
     end
     

data/lib/netzke/table_editor.rb

@@ -88,16 +88,16 @@ module Netzke
       split_size    = config[:split_size] || 200
       {
         :center => {
-          :widget_class_name    => "GridPanel", 
-          :data_class_name      => config[:data_class_name], 
+          :class_name    => "GridPanel", 
+          :model      => config[:model], 
           :ext_config           => {
-            :title        => config[:grid_title] || config[:data_class_name].pluralize
+            :title        => config[:grid_title] || config[:model].pluralize
           }
         }.deep_merge(config[:grid_config] || {}),
         
         split_region => {
-          :widget_class_name    => "FormPanel", 
-          :data_class_name      => config[:data_class_name], 
+          :class_name    => "FormPanel", 
+          :model      => config[:model], 
           :region_config        => {
             :width  => split_size, 
             :height => split_size, 
@@ -105,7 +105,7 @@ module Netzke
             :collapsible => true
           },
           :ext_config => {
-            :title        => config[:form_title] || "#{config[:data_class_name]} details",
+            :title        => config[:form_title] || "#{config[:model]} details",
             :listeners    => {:actioncomplete => {
               :fn => "function(f, a){this.ownerCt.ownerCt.onFormActioncomplete(f,a)}".l
             }}

data/lib/netzke/tree_panel.rb

@@ -18,7 +18,7 @@ class Netzke::TreePanel < Netzke::Base
   end
   
   def get_children(params)
-    klass = config[:data_class_name].constantize
+    klass = config[:model].constantize
     node = params[:node] == 'source' ? klass.find_by_parent_id(nil) : klass.find(params[:node].to_i)
     node.children.map{|n| {:text => n.name, :id => n.id, :leaf => n.children.empty?}}
   end

data/lib/netzke/window.rb

@@ -1,15 +1,14 @@
 module Netzke
   # == Window
-  # Ext.Window-based widget
+  # Ext.Window-based widget able to nest other Netzke widgets
   # 
   # == Features
-  # * Persistent position
-  # * Persistent dimensions
+  # * Persistent position and dimensions
   # 
   # == Instance configuration
-  # <tt>:height</tt> and <tt>:width</tt> - besides accepting a number (which would be just standard ExtJS),
-  # can accept a string specifying relative sizes, calculated from current browser window dimensions.
-  # E.g.: :height => "90%", :width => "60%"
+  # <tt>:item</tt> - nested Netzke widget, e.g.:
+  #     
+  #     netzke :window, :item => {:class_name => "GridPanel", :model => "User"}
   class Window < Base
     # Based on Ext.Window, naturally
     def self.js_base_class
@@ -26,57 +25,57 @@ module Netzke
     # Extends the JavaScript class
     def self.js_extend_properties
       {
+        # we nest widget inside the "fit" layout
         :layout => "fit",
         
+        # default width and height
+        :width => 300, 
+        :height => 200,
+        
         :init_component => <<-END_OF_JAVASCRIPT.l,
           function(){
-            // Width and height may be specified as percentage of available space, e.g. "60%".
-            // Convert them into actual pixels.
-            Ext.each(["width", "length"], function(k){
-              if (Ext.isString(this[k])) {
-                this[k] = Ext.lib.Dom.getViewHeight() * parseFloat("." + this[k].substr(0, this[k].length - 1)); // "66%" => ".66"
-              }
-            });
-            
-            // Superclass' initComponent
+            // superclass' initComponent
             #{js_full_class_name}.superclass.initComponent.call(this);
             
-            // Set the move and resize events after window is shown, so that they don't fire at initial rendering
+            // set the move and resize events after window is shown, so that they don't fire at initial rendering
             this.on("show", function(){
-              this.on("move", this.onMove, this);
-              this.on("resize", this.onSelfResize, this); // Work around firing "resize" event twice (currently a bug in ExtJS)
+              this.on("move", this.onMoveResize, this);
+              this.on("resize", this.onMoveResize, this);
             }, this);
 
+            // instantiate the aggregatee
             if (this.itemConfig){
               this.instantiateChild(this.itemConfig);
             }
           }
         END_OF_JAVASCRIPT
       
-        :on_move => <<-END_OF_JAVASCRIPT.l,
-          function(w,x,y){
-            this.moveToPosition({x:x, y:y});
-          }
-        END_OF_JAVASCRIPT
+        :on_move_resize => <<-END_OF_JAVASCRIPT.l,
+          function(){
+            var x = this.getPosition()[0], y = this.getPosition()[1], w = this.getSize().width, h = this.getSize().height;
 
-        :on_self_resize => <<-END_OF_JAVASCRIPT.l,
-          function(w, width, height){
-            this.selfResize({w:width, h:height});
+            // Don't bother the server twice when both move and resize events are fired at the same time
+            // (which happens when the left or upper window border is dragged)
+            if (this.moveResizeTimer) {clearTimeout(this.moveResizeTimer)};
+            
+            this.moveResizeTimer = (function(sizeAndPosition){
+              this.setSizeAndPosition(sizeAndPosition); // API call
+            }).defer(10, this, [{x:x, y:y, w:w, h:h}]); // 10ms should be enough
           }
         END_OF_JAVASCRIPT
+        
       }
     end
     
     # Processing API calls from client
-    api :move_to_position
-    def move_to_position(params)
-      update_persistent_ext_config(:x => params[:x].to_i, :y => params[:y].to_i)
-      {}
-    end
-    
-    api :self_resize
-    def self_resize(params)
-      update_persistent_ext_config(:width => params[:w].to_i, :height => params[:h].to_i)
+    api :set_size_and_position
+    def set_size_and_position(params)
+      update_persistent_ext_config(
+        :x => params[:x].to_i, 
+        :y => params[:y].to_i, 
+        :width => params[:w].to_i, 
+        :height => params[:h].to_i
+      )
       {}
     end
   end

data/lib/netzke/wrapper.rb

@@ -11,8 +11,8 @@ module Netzke
   # Example:
   # 
   #   netzke :wrapper, :item => {
-  #     :widget_class_name => "FormPanel",
-  #     :data_class_name => "User"
+  #     :class_name => "FormPanel",
+  #     :model => "User"
   #   }
   class Wrapper < Base
     def self.js_extend_properties

data/test/unit/accordion_panel_test.rb

@@ -6,9 +6,9 @@ class AccordionPanelTest < ActiveSupport::TestCase
   
   test "specifying items" do
     accordion = Netzke::AccordionPanel.new(:items => [{
-      :widget_class_name => "Panel"
+      :class_name => "Panel"
     },{
-      :widget_class_name => "Panel", :name => "second_panel", :active => true
+      :class_name => "Panel", :name => "second_panel", :active => true
     }])
         
     assert_equal(2, accordion.initial_aggregatees.keys.size)

data/test/unit/grid_panel_test.rb

@@ -4,8 +4,8 @@ require 'netzke-core'
 require 'netzke/plugins/configuration_tool'
 require 'netzke/accordion_panel'
 
-require 'netzke/grid_panel_api'
-require 'netzke/grid_panel_js'
+require 'netzke/grid_panel/grid_panel_api'
+require 'netzke/grid_panel/grid_panel_js'
 require 'netzke/grid_panel'
 
 require 'netzke/active_record/basepack'
@@ -13,7 +13,7 @@ require 'netzke/active_record/basepack'
 class GridPanelTest < ActiveSupport::TestCase
   
   test "api" do
-    grid = Netzke::GridPanel.new(:name => 'grid', :data_class_name => 'Book', :columns => [:id, :title, :recent])
+    grid = Netzke::GridPanel.new(:name => 'grid', :model => 'Book', :columns => [:id, :title, :recent])
 
     # post
     res = grid.post_data("created_records" => [{:title => 'Lord of the Rings'}].to_nifty_json)
@@ -36,7 +36,7 @@ class GridPanelTest < ActiveSupport::TestCase
   end
   
   test "normalize index" do
-    grid = Netzke::GridPanel.new(:name => 'grid', :data_class_name => 'Book', :columns => [:id, :col0, {:name => :col1, :excluded => true}, :col2, {:name => :col3, :excluded => true}, :col4, :col5])
+    grid = Netzke::GridPanel.new(:name => 'grid', :model => 'Book', :columns => [:id, :col0, {:name => :col1, :excluded => true}, :col2, {:name => :col3, :excluded => true}, :col4, :col5])
     
     assert_equal(0, grid.normalize_index(0))
     assert_equal(1, grid.normalize_index(1))

data/test/unit/helper_model_test.rb

@@ -11,7 +11,7 @@ class HelperModelTest < ActiveSupport::TestCase
         :enable_config_tool => true
       },
     })
-    form = Netzke::FormPanel.new(:data_class_name => "Book")
+    form = Netzke::FormPanel.new(:model => "Book")
     Netzke::PropertyEditor::HelperModel.widget = form
     helper_model = Netzke::PropertyEditor::HelperModel.new
     
@@ -23,7 +23,7 @@ class HelperModelTest < ActiveSupport::TestCase
     
     # now try to change the configuration
     helper_model.ext_config__config_tool = "false"
-    # form = Netzke::FormPanel.new(:data_class_name => "Book")
+    # form = Netzke::FormPanel.new(:model => "Book")
     # assert(false, form.ext_config[:enable_config_tool]) # FIXME: make it work
   end
 

data/test/unit/tab_panel_test.rb

@@ -6,9 +6,9 @@ class TabPanelTest < ActiveSupport::TestCase
   
   test "active item" do
     tab_panel = Netzke::TabPanel.new(:items => [{
-      :widget_class_name => "Panel"
+      :class_name => "Panel"
     },{
-      :widget_class_name => "Panel", :name => "second_panel", :active => true
+      :class_name => "Panel", :name => "second_panel", :active => true
     }])
         
     assert_equal(2, tab_panel.initial_aggregatees.keys.size)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-basepack
 version: !ruby/object:Gem::Version 
-  version: 0.5.6
+  version: 0.5.7
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-21 00:00:00 -03:00
+date: 2010-02-26 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.5.0
+        version: 0.5.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: searchlogic