netzke-core 0.4.3 → 0.4.4

data/.gitignore

@@ -2,4 +2,6 @@
 pkg
 doc
 Manifest
-.DS_Store
+.DS_Store
+rdoc
+netzke-core.gemspec

data/CHANGELOG.rdoc

@@ -0,0 +1,128 @@
+= v0.4.4 - 2009-10-12
+* API change: default handlers for actions and tools are now supposed to be prefixed with "on". E.g.: if you declare an action named <tt>clear_table</tt>, the handler must be called (in Ruby) <tt>on_clear_table</tt> (mapped to <tt>onClearTable</tt> in JavaScript).
+* Internal: the JavaScript instance now knows if persistent config is enabled (by checking this.persistentConfig).
+* Fix: solving the "Node cannot be inserted at the specified point in the hierarchy" problem by being more strict with duplicated IDs for elements on the same page.
+* Fix: Ext 3.0 compatibility.
+* Impr: <tt>getChildWidget</tt> now allows referring to a widget like this: "parent__parent__some_widget__some_nested_widget"
+
+= v0.4.3
+* Fix: reworking loadAggregatee()-related code, closing a security flaw when a malicious browser could send any configuration options to instantiate the widget being loaded.
+
+= v0.4.2 - 2009-09-11
+* Fix: the API call (at the JavaScript side) was ignoring the callback parameter.
+* Impr: if the array of API points is empty, it's not added into js_config anymore.
+* New: new testing widgets in netzke_controller.
+* Fix: extra CSS includes now take effect.
+* New: Support for masquerading as "World". In this mode all the "touched" persistent preferences will be overwritten for all roles and users.
+
+= v0.4.1 - 2009-09-06
+* Version bumb to force github rebuild the gem (Manifest is now included)
+
+= v0.4.0 - 2009-09-05
+* Major refactoring.
+
+= v0.3.2 - 2009-06-05
+* Netzke doesn't overwrite session[:user] anymore to not cause authentication-related problems.
+
+= v0.3.1 - 2009-05-07
+* Fix: persistent_config_manager can now be set to nil, and it will work fine
+
+= v0.3.0 - 2009-05-07
+* Refactor: got rid of NetzkeLayout model, now all layouts are stored in netzke_preferences
+* New: persistent_config now has a method for_widget that accepts a block
+* autotest compatibility
+* New: String#to_b converts a string to true/false
+* New: Netzke::Base.session introduced for session data
+* New: weak_children_config and strong_children_config can now be declared by a widget, which specifies weak and strong configuration that every child of this widget will receive (e.g. display/hide configuration tool)
+* Fix: (degradation) flash message is now shown again in case of erroneous attempt to load a widget
+* New: widgets now can check session[:netzke_just_logged_in] and session[:netzke_just_logged_out] automatically set by Netzke after login/logout
+
+= v0.2.11
+* Introduction of getOwnerWidget()-method to Ext.Component. It provides the Netzke widget this Component belongs to.
+
+= v0.2.10
+* Removed dependency on 'json' gem.
+* Rails v2.3.2 compatibility.
+
+= v0.2.9
+* Actions, toolbars and tools reworked for easier configuration.
+* Menus introduced (based on actions).
+* Significant code clean-up.
+* Bug fix (nasty one): Ext.widgetMixIn was getting messed up along with dynamic widget loading.
+* Must work in IE now.
+
+= v0.2.8
+* Support for extra javascripts and stylesheets per widget.
+
+= v0.2.7
+* QuickTips get initialized now, as otherwise Ext 2.2.1 doesn't properly destroy() BoxComponents for me.
+
+= v0.2.6
+* FeedackGhost is now capable of displaying multiple flash messages.
+* Dependencies slightly refactored.
+* An informative exception added to Base#aggregatee_instance.
+* JS-level inheritance enabled.
+* Work-around for the problem with Ext 2.2.1 in loadWidget.
+* Events "<action_id>click" added to the widgets along with the actions.
+* aggregatee_missing method added to Netzke::Base - called when a non-existing aggregate of a widget is tried to be invoked
+* Code readability improvements.
+
+= v0.2.5
+* Minor code restructuring.
+
+= v0.2.4
+* Some minor improvements.
+
+= v0.2.3
+* FeedbackGhost will show the feedback on the top of the screen independent of the page scrolling.
+* Ext.Panel#loadWidget will accept null as url to delete the currently loaded widget
+* Bug fix: persistent_config works again
+
+= v0.2.2
+* js_ext_config instance method added for overwriting
+* Multiuser support
+* Using Rails.logger for logging
+* "config"-class method for every class inheriting Netzke::Base - for class-level configurations
+
+= v0.2.1
+* Fixed the path to ext-base-min.js for production mode.
+* Also works in Safari now.
+
+= v0.2.0
+* Some re-factoring and redesign. Now simple compound widgets can be created on the fly in the controller
+* Added ext_widget[:quiet] configuration option to suppress widget's feedback
+* Support for extra CSS sources, similar to JS
+* NETZKE_BOOT_CONFIG introduced to specify which Netzke functionality should be disabled to reduce the size of /netzke/netzke.[js|css]
+* FeedbackGhost widget added - invisible widget providing feedback to the user
+* netzke_widget controller class-method renamed into netzke
+* JS-comments now get stripped also from the extra files that get included in the netzke-* gems.
+* Permissions joined js_config
+* Bug fixes
+
+= v0.1.4
+* Helpers added to facilitate ExtJS/netzke.js inclusion
+* The route defined for netzke_controller
+* netzke.html.erb-layout is not needed anymore, so not produced by the generator
+* Now compliant with Rails' forgery protection
+
+= v0.1.3
+* Generators fixed
+
+= v0.1.2
+* Fixed the bug with <widget>_class_definition returning empty string on sequential loading.
+
+= v0.1.1.1
+* Meta: moving from GitHub to RubyForge
+
+= v0.1.1
+* Inter-widget dependencies code reworked
+* JS-class code generation code slightly reworked
+
+= v0.1.0.2
+* Meta: fix outdated Manifest
+
+= v0.1.0.1 
+* Meta work: replacing underscore with dash in the name
+
+= v0.1.0 - 2008-12-11
+* Initial release

data/LICENSE

@@ -1,3 +1 @@
-Copyright (c) 2008-2009 Sergei Kozlov
-
-GNU GPL license v3
+Copyright (c) 2009 Sergei Kozlov, released under the MIT license

data/README.rdoc

@@ -6,14 +6,9 @@ This is the bare bones of the Netzke framework. Use it to build your own widgets
 The idea behind the Netzke framework is that it allows you write reusable client/server code. Create a widget, and then embed it (or load it dynamically) into your Ext-based applications or HTML pages. For more info, see the links below.
 
 == Instalation
-From RubyForge:
   
     sudo gem install netzke-core
     
-From github:
-
-    sudo gem install skozlov-netzke-core
-    
 If you want the most recent changes, install this as a plugin:
 
     script/plugin install git://github.com/skozlov/netzke-core.git

data/VERSION

@@ -1 +1 @@
-0.4.3
+0.4.4

data/javascripts/core.js

@@ -23,7 +23,7 @@ Netzke.isObject = function(o) {
 // from http://code.google.com/p/inflection-js/
 String.prototype.camelize=function(lowFirstLetter)
 {
-  var str=this.toLowerCase();
+  var str=this; //.toLowerCase();
   var str_path=str.split('/');
   for(var i=0;i<str_path.length;i++)
   {
@@ -86,7 +86,7 @@ Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
 // Properties/methods common to all widget classes
 Ext.widgetMixIn = {
   height: 400,
-  width: 800,
+  // width: 800,
   border: false,
   is_netzke: true, // to distinguish Netzke components from regular Ext components
   
@@ -240,7 +240,7 @@ Ext.widgetMixIn = {
           if (childWidget) {
             childWidget.bulkExecute(instructions[instr]);
           } else {
-            throw "Unknown method or child widget '" + instr +"' in widget '" + this.id + "'"
+            throw "Netzke: Unknown method or child widget '" + instr +"' in widget '" + this.id + "'"
           }
         }
       }
@@ -249,14 +249,25 @@ Ext.widgetMixIn = {
   
   // Get the child widget
   getChildWidget : function(id){
-    return id === 'parent' ? this.getParent() : Ext.getCmp(this.id+"__"+id);
+    if (id === "") {return this};
+    
+    var split = id.split("__");
+    if (split[0] === 'parent') {
+      split.shift();
+      var childInParentScope = split.join("__");
+      return this.getParent().getChildWidget(childInParentScope);
+    } else {
+      return Ext.getCmp(this.id+"__"+id);
+    }
   },
   
   // Common handler for actions
   actionHandler : function(action){
     // If firing corresponding event doesn't return false, call the handler
     if (this.fireEvent(action.name+'click', action)) {
-      this[(action.fn || action.name)](action);
+      var methodName = action.fn || "on"+action.name.camelize();
+      if (!this[methodName]) {throw "Netzke: handler for action '" + action.name + "' is undefined"}
+      this[methodName](action);
     }
   },
 
@@ -264,7 +275,9 @@ Ext.widgetMixIn = {
   toolActionHandler : function(tool){
     // If firing corresponding event doesn't return false, call the handler
     if (this.fireEvent(tool.id+'click')) {
-      this[tool]();
+      var methodName = "on"+tool.camelize();
+      if (!this[methodName]) {throw "Netzke: handler for tool '"+tool+"' is undefined"}
+      this[methodName]();
     }
   },
 

data/lib/app/controllers/netzke_controller.rb

@@ -28,7 +28,7 @@ class NetzkeController < ActionController::Base
   end
   
   #
-  # Primitive tests to quickly test the widgets
+  # Primitive tests to quickly test the widgets (TODO: move to the basepack)
   #
   
   # FormPanel

data/lib/netzke/base.rb

@@ -18,7 +18,7 @@ module Netzke
   # In this case <tt>:widget_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. 
+  # configuration that comes here will be available inside the javascript instance of the widget.
   # * <tt>:persistent_config</tt> - if set to <tt>true</tt>, the widget will use persistent storage to store its state;
   # for instance, Netzke::GridPanel stores there its columns state (width, visibility, order, headers, etc).
   # A widget may or may not provide interface to its persistent settings. GridPanel and FormPanel from netzke-basepack
@@ -29,6 +29,7 @@ module Netzke
   #     netzke :books, 
   #       :widget_class_name => "GridPanel", 
   #       :data_class_name => "Book", # GridPanel specific option
+  #       :persistent_config => false, # don't use persistent config for this instance
   #       :ext_config => {
   #         :icon_cls => 'icon-grid', 
   #         :title => "My books"
@@ -50,8 +51,7 @@ module Netzke
           :persistent_config_manager => "NetzkePreference",
           :ext_location              => defined?(RAILS_ROOT) && "#{RAILS_ROOT}/public/extjs",
           :default_config => {
-            :persistent_config => true,
-            :ext_config => {}
+            :persistent_config => true
           }
         })
       end
@@ -161,6 +161,11 @@ module Netzke
     end
     extend ClassMethods
     
+    # If the widget has persistent config in its disposal
+    def persistent_config_enabled?
+      !persistent_config_manager_class.nil? && config[:persistent_config]
+    end
+    
     attr_accessor :parent, :name, :id_name, :permissions, :session
 
     api :load_aggregatee_with_cache # every widget gets this api
@@ -453,7 +458,8 @@ module Netzke
       widget_session.clear
     end
 
-    # API
+    # API: provides all that is necessary for the browser to render a widget.
+    # <tt>params</tt>
     def load_aggregatee_with_cache(params)
       cache = ActiveSupport::JSON.decode(params.delete(:cache))
       relative_widget_id = params.delete(:id).underscore

data/lib/netzke/base_js.rb

@@ -52,9 +52,13 @@ module Netzke
       actions && res.merge!(:actions => actions)
       menu    && res.merge!(:menu    => menu)
 
+      # Inform the JavaScript side if persistent_config is enabled
+      res[:persistent_config] = persistent_config_enabled?
+
       # Merge with all config options passed as hash to config[:ext_config]
       res.merge!(ext_config)
   
+
       res
     end
   
@@ -85,12 +89,12 @@ module Netzke
 
     # rendering
     def js_widget_render
-      %Q{#{name.jsonify}.render("#{name.to_s.split('_').join('-')}");}
+      %Q{#{name.jsonify}.render("#{name.to_s.split('_').join('-')}-div");}
     end
 
     # container for rendering
     def js_widget_html
-      %Q{<div id="#{name.to_s.split('_').join('-')}"></div>}
+      %Q{<div id="#{name.to_s.split('_').join('-')}-div" style="width:800px;"></div>}
     end
 
     #

data/lib/netzke/controller_extensions.rb

@@ -9,7 +9,7 @@ module Netzke
       Netzke::Base.session = session
       session[:netzke_user_id] = defined?(current_user) ? current_user.try(:id) : nil
 
-      Netzke::Base.user = current_user # for backward compatibility (TODO: eliminate the need for this)
+      Netzke::Base.user = defined?(current_user) ? current_user : nil # for backward compatibility (TODO: eliminate the need for this)
       
       # set netzke_just_logged_in and netzke_just_logged_out states (may be used by Netzke widgets)
       if session[:_netzke_next_request_is_first_after_login]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-24 00:00:00 -05:00
+date: 2009-10-12 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -25,7 +25,7 @@ extra_rdoc_files:
 files: 
 - .autotest
 - .gitignore
-- CHANGELOG
+- CHANGELOG.rdoc
 - LICENSE
 - Manifest
 - README.rdoc
@@ -49,7 +49,6 @@ files:
 - lib/netzke/core_ext.rb
 - lib/netzke/feedback_ghost.rb
 - lib/netzke/routing.rb
-- netzke-core.gemspec
 - stylesheets/core.css
 - tasks/netzke_core_tasks.rake
 - test/app_root/app/controllers/application_controller.rb

data/CHANGELOG

@@ -1,125 +0,0 @@
-v0.4.3
-Fix: reworking loadAggregatee()-related code, closing a security flaw when a malicious browser could send any configuration options to instantiate the widget being loaded.
-
-v0.4.2
-2009-09-11
-Fix: the API call (at the JavaScript side) was ignoring the callback parameter.
-Impr: if the array of API points is empty, it's not added into js_config anymore.
-New: new testing widgets in netzke_controller.
-Fix: extra CSS includes now take effect.
-New: Support for masquerading as "World". In this mode all the "touched" persistent preferences will be overwritten for all roles and users.
-
-v0.4.1
-2009-09-06
-Version bumb to force github rebuild the gem (Manifest is now included)
-
-v0.4.0
-2009-09-05
-Major refactoring.
-
-v0.3.2
-2009-06-05
-Netzke doesn't overwrite session[:user] anymore to not cause authentication-related problems.
-
-v0.3.1
-2009-05-07
-Fix: persistent_config_manager can now be set to nil, and it will work fine
-
-v0.3.0
-2009-05-07
-Refactor: got rid of NetzkeLayout model, now all layouts are stored in netzke_preferences
-New: persistent_config now has a method for_widget that accepts a block
-autotest compatibility
-New: String#to_b converts a string to true/false
-New: Netzke::Base.session introduced for session data
-New: weak_children_config and strong_children_config can now be declared by a widget, which specifies weak and strong configuration that every child of this widget will receive (e.g. display/hide configuration tool)
-Fix: (degradation) flash message is now shown again in case of erroneous attempt to load a widget
-New: widgets now can check session[:netzke_just_logged_in] and session[:netzke_just_logged_out] automatically set by Netzke after login/logout
-
-v0.2.11
-Introduction of getOwnerWidget()-method to Ext.Component. It provides the Netzke widget this Component belongs to.
-
-v0.2.10
-Removed dependency on 'json' gem.
-Rails v2.3.2 compatibility.
-
-v0.2.9
-Actions, toolbars and tools reworked for easier configuration.
-Menus introduced (based on actions).
-Significant code clean-up.
-Bug fix (nasty one): Ext.widgetMixIn was getting messed up along with dynamic widget loading.
-Must work in IE now.
-
-v0.2.8
-Support for extra javascripts and stylesheets per widget.
-
-v0.2.7
-QuickTips get initialized now, as otherwise Ext 2.2.1 doesn't properly destroy() BoxComponents for me.
-
-v0.2.6
-FeedackGhost is now capable of displaying multiple flash messages.
-Dependencies slightly refactored.
-An informative exception added to Base#aggregatee_instance.
-JS-level inheritance enabled.
-Work-around for the problem with Ext 2.2.1 in loadWidget.
-Events "<action_id>click" added to the widgets along with the actions.
-aggregatee_missing method added to Netzke::Base - called when a non-existing aggregate of a widget is tried to be invoked
-Code readability improvements.
-
-v0.2.5
-Minor code restructuring.
-
-v0.2.4
-Some minor improvements.
-
-v0.2.3
-FeedbackGhost will show the feedback on the top of the screen independent of the page scrolling.
-Ext.Panel#loadWidget will accept null as url to delete the currently loaded widget
-Bug fix: persistent_config works again
-
-v0.2.2
-js_ext_config instance method added for overwriting
-Multiuser support
-Using Rails.logger for logging
-"config"-class method for every class inheriting Netzke::Base - for class-level configurations
-
-v0.2.1
-Fixed the path to ext-base-min.js for production mode.
-Also works in Safari now.
-
-v0.2.0
-* Some re-factoring and redesign. Now simple compound widgets can be created on the fly in the controller
-* Added ext_widget[:quiet] configuration option to suppress widget's feedback
-* Support for extra CSS sources, similar to JS
-* NETZKE_BOOT_CONFIG introduced to specify which Netzke functionality should be disabled to reduce the size of /netzke/netzke.[js|css]
-* FeedbackGhost widget added - invisible widget providing feedback to the user
-* netzke_widget controller class-method renamed into netzke
-* JS-comments now get stripped also from the extra files that get included in the netzke-* gems.
-* Permissions joined js_config
-* Bug fixes
-
-v0.1.4
-Helpers added to facilitate ExtJS/netzke.js inclusion
-The route defined for netzke_controller
-netzke.html.erb-layout is not needed anymore, so not produced by the generator
-Now compliant with Rails' forgery protection
-
-v0.1.3
-Generators fixed
-
-v0.1.2
-Fixed the bug with <widget>_class_definition returning empty string on sequential loading.
-
-v0.1.1.1
-Meta: moving from GitHub to RubyForge
-
-v0.1.1
-Inter-widget dependencies code reworked
-JS-class code generation code slightly reworked
-
-v0.1.0.2
-Meta: fix outdated Manifest
-
-v0.1.0.1 Meta work: replacing underscore with dash in the name
-
-v0.1.0 Initial release

data/netzke-core.gemspec

@@ -1,111 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{netzke-core}
-  s.version = "0.4.3"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Sergei Kozlov"]
-  s.date = %q{2009-09-24}
-  s.description = %q{Build ExtJS/Rails widgets with minimum effort}
-  s.email = %q{sergei@playcode.nl}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".autotest",
-     ".gitignore",
-     "CHANGELOG",
-     "LICENSE",
-     "Manifest",
-     "README.rdoc",
-     "Rakefile",
-     "TODO",
-     "VERSION",
-     "autotest/discover.rb",
-     "generators/netzke_core/USAGE",
-     "generators/netzke_core/netzke_core_generator.rb",
-     "generators/netzke_core/templates/create_netzke_preferences.rb",
-     "init.rb",
-     "install.rb",
-     "javascripts/core.js",
-     "lib/app/controllers/netzke_controller.rb",
-     "lib/app/models/netzke_preference.rb",
-     "lib/netzke-core.rb",
-     "lib/netzke/action_view_ext.rb",
-     "lib/netzke/base.rb",
-     "lib/netzke/base_js.rb",
-     "lib/netzke/controller_extensions.rb",
-     "lib/netzke/core_ext.rb",
-     "lib/netzke/feedback_ghost.rb",
-     "lib/netzke/routing.rb",
-     "netzke-core.gemspec",
-     "stylesheets/core.css",
-     "tasks/netzke_core_tasks.rake",
-     "test/app_root/app/controllers/application_controller.rb",
-     "test/app_root/app/models/role.rb",
-     "test/app_root/app/models/user.rb",
-     "test/app_root/config/boot.rb",
-     "test/app_root/config/database.yml",
-     "test/app_root/config/environment.rb",
-     "test/app_root/config/environments/in_memory.rb",
-     "test/app_root/config/environments/mysql.rb",
-     "test/app_root/config/environments/postgresql.rb",
-     "test/app_root/config/environments/sqlite.rb",
-     "test/app_root/config/environments/sqlite3.rb",
-     "test/app_root/config/routes.rb",
-     "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb",
-     "test/app_root/db/migrate/20090423214303_create_roles.rb",
-     "test/app_root/db/migrate/20090423222114_create_users.rb",
-     "test/app_root/lib/console_with_fixtures.rb",
-     "test/app_root/script/console",
-     "test/fixtures/roles.yml",
-     "test/fixtures/users.yml",
-     "test/test_helper.rb",
-     "test/unit/core_ext_test.rb",
-     "test/unit/netzke_core_test.rb",
-     "test/unit/netzke_preference_test.rb",
-     "uninstall.rb"
-  ]
-  s.homepage = %q{http://github.com/skozlov/netzke-core}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{netzke-core}
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Build ExtJS/Rails widgets with minimum effort}
-  s.test_files = [
-    "test/app_root/app/controllers/application_controller.rb",
-     "test/app_root/app/models/role.rb",
-     "test/app_root/app/models/user.rb",
-     "test/app_root/config/boot.rb",
-     "test/app_root/config/environment.rb",
-     "test/app_root/config/environments/in_memory.rb",
-     "test/app_root/config/environments/mysql.rb",
-     "test/app_root/config/environments/postgresql.rb",
-     "test/app_root/config/environments/sqlite.rb",
-     "test/app_root/config/environments/sqlite3.rb",
-     "test/app_root/config/routes.rb",
-     "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb",
-     "test/app_root/db/migrate/20090423214303_create_roles.rb",
-     "test/app_root/db/migrate/20090423222114_create_users.rb",
-     "test/app_root/lib/console_with_fixtures.rb",
-     "test/test_helper.rb",
-     "test/unit/core_ext_test.rb",
-     "test/unit/netzke_core_test.rb",
-     "test/unit/netzke_preference_test.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end