netzke-core 0.5.0 → 0.5.1

data/CHANGELOG.rdoc

@@ -1,4 +1,9 @@
-= v0.5.0
+= v0.5.1 - 2010-02-26
+* Compatibility with Ext 3.1.1
+* New: <tt>Netzke.page</tt> object now contains all the widgets declared on the page
+* Code: replaced (references to) deprecated function names
+
+= v0.5.0 - 2010-01-10
 * Compatibility with Ext 3.1.0
 * API change: Netzke widget's now should be declared directly in the views instead of controllers.
 * API change: all ExtJS and Netzke JavaScript and styles are now loaded with the help of <tt>netzke_init</tt> helper.

data/README.rdoc

@@ -10,19 +10,13 @@ For the latest ("edge") stuff, install as plugin (recommended!):
 
     ./script/plugin install git://github.com/skozlov/netzke-core.git
 
-Otherwise, install as gem. The gem is hosted on gemcutter. If you haven't yet enabled gemcutter, run the following:
+Otherwise, install as gem:
 
-    sudo gem install gemcutter && gem tumble
-
-Install the gem 
-
-    sudo gem install netzke-core
+    gem install netzke-core
     
-Generate the migrations for Netzke persistent storage:
+To generate the migrations for Netzke persistent storage (if you want to use it):
 
     ./script/generate netzke_core
-    
-Run the migrations.
 
 Netzke assumes that your ExtJS library is in public/extjs (which may be a symbolic link).
 
@@ -31,25 +25,29 @@ Here's how to embed a Netzke widget into your Rails view.
 
 1. In your layout, within the "head" tag, use the <tt>netzke_init</tt> helper to include all the necessary JavaScript and styles. 
 
-  <%= netzke_init %>
-  
-2. In your view use the <tt>netzke</tt> helper wherever you want to insert a widget.
+    <%= netzke_init %>
+    
+2. In config/routes.rb declare the Netzke routes:
 
-  <%= netzke :grid_panel, :data_class_name => "User", :columns => [:id, :name, :created_at] %>
-  
+    map.netzke
+    
+3. In your view use the <tt>netzke</tt> helper wherever you want to insert a widget.
+
+    <%= netzke :grid_panel, :model => "User", :columns => [:id, :name, :created_at] %>
+    
 (here we use the GridPanel widget from the netzke-basepack project)
 
 == More info
 Introduction to Netzke framework and wiki: http://github.com/skozlov/netzke
 
-Twitter: <http://twitter.com/skozlov>
+Twitter: http://twitter.com/skozlov
 
-Tutorials: <http://blog.writelesscode.com>
+Tutorials: http://blog.writelesscode.com
 
-Live-demo: <http://netzke-demo.writelesscode.com>
+Live-demo with sample code: http://netzke-demo.writelesscode.com
 
-The netzke-basepack project (pre-built full-featured widgets): <http://github.com/skozlov/netzke-basepack>
+The netzke-basepack project (pre-built full-featured widgets): http://github.com/skozlov/netzke-basepack
 
 ---
 
-Copyright (c) 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.0"
+    gemspec.version = "0.5.1"
     gemspec.name = "netzke-core"
     gemspec.summary = "Build ExtJS/Rails widgets with minimum effort"
     gemspec.description = "Allows building ExtJS/Rails reusable code in a DRY way"

data/javascripts/core.js

@@ -3,7 +3,7 @@ This file gets loaded along with the rest of Ext library at the initial load
 */
 
 // Check Ext JS version
-var requiredExtVersion = "3.1.0";
+var requiredExtVersion = "3.1.1";
 var currentExtVersion = Ext.version;
 if (requiredExtVersion !== currentExtVersion) {
   alert("Netzke needs Ext " + requiredExtVersion + ". You have " + currentExtVersion + ".");
@@ -13,6 +13,7 @@ if (requiredExtVersion !== currentExtVersion) {
 Ext.BLANK_IMAGE_URL = "/extjs/resources/images/default/s.gif";
 Ext.ns('Ext.netzke'); // namespace for extensions that depend on Ext
 Ext.ns('Netzke'); // Netzke namespace
+Ext.ns('Netzke.page'); // namespace for all widget instantces on the page
 
 Ext.QuickTips.init();
 

data/lib/netzke/action_view_ext.rb

@@ -40,7 +40,7 @@ module Netzke
     end
     
     # Use this helper in your views to embed Netzke widgets. E.g.:
-    #   netzke :my_grid, :widget_class_name => "GridPanel", :columns => [:id, :name, :created_at]
+    #   netzke :my_grid, :class_name => "GridPanel", :columns => [:id, :name, :created_at]
     # On how to configure a widget, see documentation for Netzke::Base or/and specific widget
     def netzke(name, config = {})
       ::ActiveSupport::Deprecation.warn("widget_class_name option is deprecated. Use class_name instead", caller) if config[:widget_class_name]

data/lib/netzke/base.rb

@@ -9,13 +9,13 @@ module Netzke
   #     netzke :widget_name, configuration_hash
   # 
   # == Configuration
-  # * <tt>:widget_class_name</tt> - name of the widget class in the scope of the Netzke module, e.g. "FormPanel".
+  # * <tt>:class_name</tt> - name of the widget class in the scope of the Netzke module, e.g. "FormPanel".
   # When a widget is defined in the controller and this option is omitted, widget class is deferred from the widget's
   # name. E.g.:
   # 
-  #   netzke :grid_panel, :data_class_name => "User"
+  #   netzke :grid_panel, :model => "User"
   # 
-  # In this case <tt>:widget_class_name</tt> is assumed to be "GridPanel"
+  # In this case <tt>:class_name</tt> is assumed to be "GridPanel"
   # 
   # * <tt>:ext_config</tt> - a config hash that is used to create a javascript instance of the widget. Every
   # configuration that comes here will be available inside the javascript instance of the widget.
@@ -27,8 +27,8 @@ module Netzke
   # Examples of configuration:
   #
   #     netzke :books, 
-  #       :widget_class_name => "GridPanel", 
-  #       :data_class_name => "Book", # GridPanel specific option
+  #       :class_name => "GridPanel", 
+  #       :model => "Book", # GridPanel specific option
   #       :persistent_config => false, # don't use persistent config for this instance
   #       :ext_config => {
   #         :icon_cls => 'icon-grid', 
@@ -36,7 +36,7 @@ module Netzke
   #       }
   # 
   #     netzke :form_panel, 
-  #       :data_class_name => "User" # FormPanel specific option
+  #       :model => "User" # FormPanel specific option
   class Base
     extend ActiveSupport::Memoizable
     
@@ -153,7 +153,7 @@ module Netzke
     # Instance of widget by config
     def self.instance_by_config(config)
       ::ActiveSupport::Deprecation.warn("widget_class_name option is deprecated. Use class_name instead", caller) if config[:widget_class_name]
-      widget_class = "Netzke::#{config[:class_name] || config[:widget_class_name]}".constantize
+      widget_class = "Netzke::#{config[:class_name] || config[:class_name]}".constantize
       widget_class.new(config)
     end
     
@@ -362,7 +362,7 @@ module Netzke
     ## Dependencies
     def dependencies
       @dependencies ||= begin
-        non_late_aggregatees_widget_classes = non_late_aggregatees.values.map{|v| v[:widget_class_name]}
+        non_late_aggregatees_widget_classes = non_late_aggregatees.values.map{|v| v[:class_name]}
         (initial_dependencies + non_late_aggregatees_widget_classes << self.class.short_widget_class_name).uniq
       end
     end
@@ -414,9 +414,9 @@ module Netzke
         aggregatee_config = aggregator.aggregatees[aggr]
         raise ArgumentError, "No aggregatee '#{aggr}' defined for widget '#{aggregator.global_id}'" if aggregatee_config.nil?
         ::ActiveSupport::Deprecation.warn("widget_class_name option is deprecated. Use class_name instead", caller) if aggregatee_config[:widget_class_name]
-        short_class_name = aggregatee_config[:class_name] || aggregatee_config[:widget_class_name]
-        raise ArgumentError, "No widget_class_name specified for aggregatee #{aggr} of #{aggregator.global_id}" if short_class_name.nil?
-        widget_class = "Netzke::#{short_class_name}".constantize
+        short_widget_class_name = aggregatee_config[:class_name] || aggregatee_config[:class_name]
+        raise ArgumentError, "No class_name specified for aggregatee #{aggr} of #{aggregator.global_id}" if short_widget_class_name.nil?
+        widget_class = "Netzke::#{short_widget_class_name}".constantize
 
         conf = weak_children_config.
           deep_merge(aggregatee_config).
@@ -430,7 +430,7 @@ module Netzke
       aggregator
     end
     
-    def full_widget_class_name(short_name)
+    def full_class_name(short_name)
       "Netzke::#{short_name}"
     end
 

data/lib/netzke/base_js.rb

@@ -83,12 +83,12 @@ module Netzke
 
     # instantiating
     def js_widget_instance
-      %Q{var #{name.jsonify} = new #{self.class.js_full_class_name}(#{js_config.to_nifty_json});}
+      %Q{Netzke.page.#{name.jsonify} = new #{self.class.js_full_class_name}(#{js_config.to_nifty_json});}
     end
 
     # rendering
     def js_widget_render
-      self.class.js_xtype == "netzkewindow" ? %Q{#{name.jsonify}.show();} : %Q{#{name.jsonify}.render("#{name.to_s.split('_').join('-')}-div");}
+      %Q{Netzke.page.#{name.jsonify}.render("#{name.to_s.split('_').join('-')}-div");} unless self.class.js_xtype == "netzkewindow"
     end
 
     # container for rendering

data/test/unit/netzke_core_test.rb

@@ -14,8 +14,8 @@ module Netzke
     
     def initial_aggregatees
       {
-        :nested_one => {:widget_class_name => 'NestedWidgetOne'},
-        :nested_two => {:widget_class_name => 'NestedWidgetTwo'}
+        :nested_one => {:class_name => 'NestedWidgetOne'},
+        :nested_two => {:class_name => 'NestedWidgetTwo'}
       }
     end
   
@@ -37,7 +37,7 @@ module Netzke
   class NestedWidgetTwo < Base
     def initial_aggregatees
       {
-        :nested => {:widget_class_name => 'DeepNestedWidget'}
+        :nested => {:class_name => 'DeepNestedWidget'}
       }
     end
   end
@@ -45,7 +45,7 @@ module Netzke
   class DeepNestedWidget < Base
     def initial_aggregatees
       {
-        :nested => {:widget_class_name => "VeryDeepNestedWidget"}
+        :nested => {:class_name => "VeryDeepNestedWidget"}
       }
     end
   end
@@ -142,7 +142,7 @@ class NetzkeCoreTest < ActiveSupport::TestCase
   end
 
   test "widget instance by config" do
-    widget = Netzke::Base.instance_by_config({:widget_class_name => 'Widget', :name => 'a_widget'})
+    widget = Netzke::Base.instance_by_config({:class_name => 'Widget', :name => 'a_widget'})
     assert(Widget, widget.class)
     assert('a_widget', widget.name)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 -03:00
+date: 2010-02-26 00:00:00 -03:00
 default_executable: 
 dependencies: []