netzke-core 0.6.2 → 0.6.3

data/lib/netzke/javascript.rb

@@ -3,7 +3,7 @@ module Netzke
   # Here's a brief explanation on how a javascript class for a component gets built.
   # Component gets defined as a constructor (a function) by +js_class+ class method (see "Inside component's contstructor").
   # +Ext.extend+ provides inheritance from an Ext class specified in +js_base_class+ class method.
-  # 
+  #
   # == Inside component's constructor
   # * Component's constructor gets called with a parameter that is a configuration object provided by +config+ instance method. This configuration is specific for the instance of the component, and, for example, contains this component's unique id. As another example, by means of this configuration object, a grid receives the configuration array for its columns, a form - for its fields, etc.
   module Javascript
@@ -13,14 +13,14 @@ module Netzke
       class_attribute :js_included_files
       self.js_included_files = []
     end
-    
+
     module ClassMethods
 
       # The JS (Ext) class that we inherit from on the JS level
       def js_base_class(class_name = nil)
         class_name.nil? ? (read_inheritable_attribute(:js_base_class) || "Ext.Panel") : write_inheritable_attribute(:js_base_class, class_name)
       end
-      
+
       # Definition of a public JS method, e.g.:
       #     js_method :on_call_server, <<-JS
       #       function(){
@@ -33,7 +33,7 @@ module Netzke
         current_js_methods.merge!(name => definition.l)
         write_inheritable_attribute(:js_methods, current_js_methods)
       end
-      
+
       # Returns all JS method definitions in a hash
       def js_methods
         read_clean_inheritable_hash(:js_methods)
@@ -47,7 +47,7 @@ module Netzke
       def js_include(*args)
         self.js_included_files += args
       end
-      
+
       # Definition of a public JS property, e.g.:
       #     js_property :title, "My Netzke Component"
       def js_property(name, value = nil)
@@ -60,7 +60,7 @@ module Netzke
           write_inheritable_attribute(:js_properties, current_js_properties)
         end
       end
-      
+
       # Assignment of multiple public JS properties in a bunch, e.g.:
       #     js_properties :title => "My Component", :border => true, :html => "Inner HTML"
       def js_properties(hsh = nil)
@@ -72,7 +72,7 @@ module Netzke
           write_inheritable_attribute(:js_properties, current_js_properties)
         end
       end
-      
+
       # JS properties and methods merged together
       def js_extend_properties
         @_js_extend_properties ||= js_properties.merge(js_methods)
@@ -82,13 +82,13 @@ module Netzke
           # res
         # end
       end
-      
+
       # TODO: the code below needs refactoring and cleaning-up
-      
+
       # component's menus
       # def js_menus; []; end
 
-      # Given class name, e.g. GridPanelLib::Components::RecordFormWindow, 
+      # Given class name, e.g. GridPanelLib::Components::RecordFormWindow,
       # returns its scope: "Components.RecordFormWindow"
       def js_class_name_to_scope(name)
         name.split("::")[0..-2].join(".")
@@ -129,7 +129,7 @@ module Netzke
         superclass != Netzke::Base
       end
 
-      # Declaration of component's class (stored in the cache storage (Ext.netzke.cache) at the client side 
+      # Declaration of component's class (stored in the cache storage (Ext.netzke.cache) at the client side
       # to be reused at the moment of component instantiation)
       def js_class(cached = [])
         res = []
@@ -142,29 +142,29 @@ module Netzke
 
         res.join("\n")
       end
-      
-      
+
+
       def js_extra_code
         ""
       end
-      
+
       # Generates declaration of the JS class as direct extension of a Ext component
       def js_class_declaration_new_component
         %(#{js_full_class_name} = Ext.extend(#{js_base_class}, Ext.apply(Netzke.componentMixin(#{js_base_class}),
 #{js_extend_properties.to_nifty_json}));)
       end
-      
+
       # Generates declaration of the JS class as extension of another Netzke component
       def js_class_declaration_extending_component
         base_class = superclass.js_full_class_name
 
-        # Do we specify our own extend properties? 
+        # Do we specify our own extend properties?
         # If so, include them, if not - don't re-include those from the parent.
         js_extend_properties.empty? ? \
         %{#{js_full_class_name} = #{base_class};} :
         %{#{js_full_class_name} = Ext.extend(#{base_class}, #{js_extend_properties.to_nifty_json});}
       end
-      
+
       # Returns all extra JavaScript-code (as string) required by this component's class
       def js_included
         res = ""
@@ -175,7 +175,7 @@ module Netzke
           f = File.new(path)
           res << f.read << "\n"
         end
-        
+
         res
       end
 
@@ -187,7 +187,7 @@ module Netzke
       def js_code(cached = [])
         [js_included, js_class(cached)].join("\n")
       end
-      
+
       # Little helper
       def this; "this".l; end
 
@@ -195,7 +195,7 @@ module Netzke
       def null; "null".l; end
 
     end
-    
+
     module InstanceMethods
       # Config that is used for instantiating the component in javascript
       def js_config
@@ -211,7 +211,7 @@ module Netzke
           comp_instance.before_load
           comp_hash[comp_name] = comp_instance.js_config
         end
-        
+
         # All our non-lazy-loaded children are specified here, while in +items+ we barely reference them, because
         # +items+, generally, only contain a subset of all non-lazy-loaded children.
         res[:components] = comp_hash unless comp_hash.empty?
@@ -228,21 +228,32 @@ module Netzke
 
         # Merge with the rest of config options, besides those that are only meant for the server side
         res.merge!(config.reject{ |k,v| self.class.server_side_config_options.include?(k.to_sym) })
-        
+
+        if config[:ext_config].present?
+          ::ActiveSupport::Deprecation.warn("Using ext_config option is deprecated. All config options must be specified at the same level in the hash.", caller)
+          res.merge!(config[:ext_config])
+        end
+
         res[:items] = items unless items.blank?
-        
+
         res
       end
+      
+      # Helper to access config[:ext_config] - DEPRECATED
+      def ext_config
+        ::ActiveSupport::Deprecation.warn("Using ext_config is deprecated. All config options must be specified at the same level in the hash.", caller)
+        config[:ext_config] || {}
+      end
 
       # All the JS-code required by this instance of the component to be instantiated in the browser.
       # It includes JS-classes for the parents, non-lazy-loaded child components, and itself.
       def js_missing_code(cached = [])
-        code = dependency_classes.inject("") do |r,k| 
+        code = dependency_classes.inject("") do |r,k|
           cached.include?(k.to_s) ? r : r + k.js_code(cached)#.strip_js_comments
         end
         code.blank? ? nil : code
       end
-      
+
     end
   end
 end

data/lib/netzke/persistence.rb

@@ -1,8 +1,8 @@
 module Netzke
-  # TODO: 
+  # TODO:
   # rename persistence_ to persistence_
   module Persistence
-    
+
     module ClassMethods
       # Persistent config manager class
       def persistence_manager_class
@@ -12,14 +12,14 @@ module Netzke
       end
 
     end
-  
+
     module InstanceMethods
-      
+
       # If the component has persistent config in its disposal
       def persistence_enabled?
         !persistence_manager_class.nil? && initial_config[:persistent_config]
       end
-      
+
       # Access to own persistent config, e.g.:
       #     persistent_config["window.size"] = 100
       #     persistent_config["window.size"] => 100
@@ -30,7 +30,7 @@ module Netzke
       #     config_class.component_name = persistence_key.to_s # pass to the config class our unique name
       #     config_class
       #   else
-      #     # if we can't use presistent config, all the calls to it will always return nil, 
+      #     # if we can't use presistent config, all the calls to it will always return nil,
       #     # and the "="-operation will be ignored
       #     logger.debug "==> NETZKE: no persistent config is set up for component '#{global_id}'"
       #     {}
@@ -44,7 +44,7 @@ module Netzke
         config_class
       end
 
-      # A string which will identify NetzkePreference records for this component. 
+      # A string which will identify NetzkePreference records for this component.
       # If <tt>persistence_key</tt> is passed, use it. Otherwise use global component's id.
       def persistence_key #:nodoc:
         # initial_config[:persistence_key] ? parent.try(:persistence_key) ? "#{parent.persistence_key}__#{initial_config[:persistence_key]}".to_sym : initial_config[:persistence_key] : global_id.to_sym
@@ -56,18 +56,18 @@ module Netzke
       #   current_config.deep_merge!(hsh.deep_convert_keys{ |k| k.to_s }) # first, recursively stringify the keys
       #   persistent_config[:ext_config] = current_config
       # end
-      
+
       # Returns a hash built from all persistent config values for the current component, following the double underscore
       # naming convention. E.g., if we have the following persistent config pairs:
       #     enabled  => true
       #     layout__width => 100
       #     layout__header__height => 20
-      # 
+      #
       # this method will return the following hash:
       #     {:enabled => true, :layout => {:width => 100, :header => {:height => 20}}}
       # def persistence_hash_OLD
       #   return {} if !persistence_enabled?
-      #   
+      #
       #   @persistence_hash ||= begin
       #     prefs = NetzkePreference.find_all_for_component(persistence_key.to_s)
       #     res = {}
@@ -80,7 +80,7 @@ module Netzke
       #         anchor = tmp_res[level_prefix] if level_prefix == hsh_levels.first
       #         tmp_res = tmp_res[level_prefix]
       #       end
-      #       # Now 'anchor' is a hash that represents the path to the single value, 
+      #       # Now 'anchor' is a hash that represents the path to the single value,
       #       # for example: {:ext_config => {:title => 100}} (which corresponds to ext_config__title)
       #       # So we need to recursively merge it into the final result
       #       res.deep_merge!(hsh_levels.first => anchor)
@@ -88,7 +88,7 @@ module Netzke
       #     res.deep_convert_keys{ |k| k.to_sym } # recursively symbolize the keys
       #   end
       # end
-      
+
       def update_persistent_options(hash)
         if persistence_enabled?
           options = persistent_options
@@ -97,19 +97,19 @@ module Netzke
           logger && logger.debug("Netzke warning: No persistence enabled for component '#{global_id}'")
         end
       end
-      
+
       def persistent_options
         return {} if !persistence_enabled?
         persistence_manager_class.pref_to_read(global_id).try(:value) || {}
       end
-      
+
       # A convenience method for instances
       def persistence_manager_class
         self.class.persistence_manager_class
       end
-      
+
     end
-  
+
     def self.included(receiver)
       receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods

data/lib/netzke/rails/action_view_ext.rb

@@ -3,10 +3,10 @@ module Netzke
     # Include JavaScript
     def netzke_js_include
       res = []
-      
+
       # ExtJS
       res << (ENV['RAILS_ENV'] == 'development' ? javascript_include_tag("/extjs/adapter/ext/ext-base-debug", "/extjs/ext-all-debug") : javascript_include_tag("/extjs/adapter/ext/ext-base", "/extjs/ext-all"))
-      
+
       # Netzke (dynamically generated)
       res << javascript_include_tag("/netzke/netzke")
       res.join("\n")
@@ -20,14 +20,14 @@ module Netzke
       res << "\n" << stylesheet_link_tag("/extjs/resources/css/xtheme-#{theme_name}") unless theme_name.to_s == "default"
       # Netzke (dynamically generated)
       res << "\n" << stylesheet_link_tag("/netzke/netzke")
-      
-      # External stylesheets (which cannot be loaded dynamically along with the rest of the component, e.g. due to that 
+
+      # External stylesheets (which cannot be loaded dynamically along with the rest of the component, e.g. due to that
       # relative paths are used in them)
       res << "\n" << stylesheet_link_tag(Netzke::Core.external_css)
-      
+
       res
     end
-    
+
     # JavaScript for all Netzke classes in this view, and Ext.onReady which renders all Netzke components in this view
     def netzke_js
       res = []
@@ -38,17 +38,17 @@ module Netzke
       res << "Ext.onReady(function(){"
       res << content_for(:netzke_on_ready)
       res << "});"
-      
+
       javascript_tag res.join("\n")
     end
-    
+
     def netzke_css
       %{
 <style type="text/css" media="screen">
   #{content_for(:netzke_css)}
 </style>}
     end
-    
+
     # Wrapper for all the above. Use it in your layout.
     # Params: <tt>:ext_theme</tt> - the name of ExtJS theme to apply (optional)
     # E.g.:
@@ -57,42 +57,42 @@ module Netzke
       theme = params[:ext_theme] || :default
       raw([netzke_css_include(theme), netzke_css, netzke_js_include, netzke_js].join("\n"))
     end
-    
+
     # Use this helper in your views to embed Netzke components. E.g.:
     #   netzke :my_grid, :class_name => "Basepack::GridPanel", :columns => [:id, :name, :created_at]
     # On how to configure a component, see documentation for Netzke::Base or/and specific component
     def netzke(name, config = {})
       @rendered_classes ||= []
-      
+
       # if we are the first netzke call on the page, reset components hash in the session
       if @rendered_classes.empty?
         Netzke::Core.reset_components_in_session
       end
-      
+
       class_name = config[:class_name] ||= name.to_s.camelcase
-      
+
       config[:name] = name
-      
+
       Netzke::Core.reg_component(config)
-      
+
       w = Netzke::Base.instance_by_config(config)
       w.before_load # inform the component about initial load
-      
+
       if Netzke::Core.javascript_on_main_page
         content_for :netzke_js_classes, raw(w.js_missing_code(@rendered_classes))
       end
-      
+
       content_for :netzke_css, raw(w.css_missing_code(@rendered_classes))
-      
+
       content_for :netzke_on_ready, raw("#{w.js_component_instance}\n\n#{w.js_component_render}")
-      
+
       # Now mark this component's class as rendered, so that we only generate it once per view
       @rendered_classes << class_name unless @rendered_classes.include?(class_name)
 
       # Return the html for this component
       raw(w.js_component_html)
     end
-    
+
     def ext(name, config = {})
       comp = Netzke::ExtComponent.new(name, config)
       content_for :netzke_on_ready, raw("#{comp.js_component_render}")

data/lib/netzke/rails/controller_extensions.rb

@@ -4,7 +4,7 @@ module Netzke
       base.send(:before_filter, :set_session_data)
       base.send(:before_filter, :set_controller)
     end
-    
+
     def set_session_data
       ::Netzke::Core.session = session
       session[:netzke_user_id] = defined?(current_user) ? current_user.try(:id) : nil

data/lib/netzke/rails/routes.rb

@@ -1,7 +1,7 @@
 module ActionDispatch::Routing
   class Mapper
     def netzke
-      match "/netzke/:action(.:format)" => "netzke"      
+      match "/netzke/:action(.:format)" => "netzke"
     end
   end
 end

data/lib/netzke/services.rb

@@ -1,26 +1,26 @@
 module Netzke
   module Services
     class BadEndpointReturnType < RuntimeError; end
-    
+
     module ClassMethods
       # Declare connection points between client side of a component and its server side. For example:
       #
       #     api :reset_data
-      # 
-      # will provide JavaScript side with a method <tt>resetData</tt> that will result in a call to Ruby 
+      #
+      # will provide JavaScript side with a method <tt>resetData</tt> that will result in a call to Ruby
       # method <tt>reset_data</tt>, e.g.:
-      # 
+      #
       #     this.resetData({hard:true});
-      # 
+      #
       # See netzke-basepack's GridPanel for an example.
-      # 
+      #
       def api(*api_points)
         ::ActiveSupport::Deprecation.warn("Using the 'api' call is deprecated. Use the 'endpoint' approach instead", caller)
-        
+
         api_points.each do |apip|
           add_endpoint(apip)
         end
-        
+
         # It may be needed later for security
         api_points.each do |apip|
           module_eval <<-END, __FILE__, __LINE__
@@ -36,14 +36,14 @@ module Netzke
       def endpoint(name, options = {}, &block)
         add_endpoint(name)
         define_method name, &block if block # if no block is given, the method is supposed to be defined elsewhere
-          
+
         # define_method name, &block if block # if no block is given, the method is supposed to be defined elsewhere
         define_method :"endpoint_#{name}" do |*args|
           res = send(name, *args)
           res.respond_to?(:to_nifty_json) && res.to_nifty_json || ""
         end
       end
-      
+
       # Register an endpoint
       def add_endpoint(ep)
         current_endpoints = read_inheritable_attribute(:endpoints) || []
@@ -56,10 +56,10 @@ module Netzke
         read_inheritable_attribute(:endpoints)
       end
     end
-    
+
     module InstanceMethods
     end
-    
+
     def self.included(receiver)
       receiver.extend         ClassMethods
       receiver.send :include, InstanceMethods

data/lib/netzke/session.rb

@@ -6,17 +6,17 @@ module Netzke
     def session
       ::Netzke::Core.session
     end
-  
+
     # Component-specific session.
     def component_session
       session[global_id] ||= {}
     end
-    
+
     # Returns this component's configuration options stored in the session. Those get merged into the component's configuration at instantiation.
     def session_options
       session_persistence_enabled? && component_session[:options] || {}
     end
- 
+
     # Updates the session options
     def update_session_options(hash)
       if session_persistence_enabled?
@@ -26,7 +26,7 @@ module Netzke
         logger.debug "Netzke warning: No session persistence enabled for component '#{global_id}'"
       end
     end
-    
+
     private
       def session_persistence_enabled?
         initial_config[:session_persistence]

data/lib/netzke/stylesheets.rb

@@ -1,12 +1,12 @@
 module Netzke
   module Stylesheets
     extend ActiveSupport::Concern
-  
+
     included do
       class_attribute :css_included_files
       self.css_included_files = []
     end
-      
+
     module ClassMethods
       # Returns all extra CSS code (as string) required by this component's class
       def css_included
@@ -28,7 +28,7 @@ module Netzke
       end
 
       # Definition of CSS files which will be dynamically loaded together with this component
-      # e.g. 
+      # e.g.
       # css_include "#{File.dirname(__FILE__)}/themis_navigation/static.css"
       # or
       # css_include "#{File.dirname(__FILE__)}/themis_navigation/one.css","#{File.dirname(__FILE__)}/themis_navigation/two.css"
@@ -36,17 +36,17 @@ module Netzke
       def css_include(*args)
         self.css_included_files += args
       end
-      
+
     end
-    
+
     module InstanceMethods
       def css_missing_code(cached = [])
-        code = dependency_classes.inject("") do |r,k| 
+        code = dependency_classes.inject("") do |r,k|
           cached.include?(k) ? r : r + constantize_class_name(k).css_code(cached)
         end
         code.blank? ? nil : code
       end
-      
-    end    
+
+    end
   end
 end

data/lib/netzke-core.rb

@@ -8,7 +8,7 @@ require 'netzke/base'
 module Netzke
   autoload :Core, 'netzke/core'
   autoload :ExtComponent, 'netzke/ext_component'
-  
+
   class Engine < ::Rails::Engine
     config.after_initialize do
       # Do some initialization which is only possible after Rails is initialized
@@ -31,7 +31,7 @@ if defined? Rails
     require 'netzke/rails/action_view_ext'
     include Netzke::ActionViewExt
   end
-  
+
   # Make this plugin auto-reloadable for easier development
   # ActiveSupport::Dependencies.autoload_once_paths.delete(File.join(File.dirname(__FILE__)))
 end

data/netzke-core.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.6.2"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2010-10-27}
+  s.date = %q{2010-11-02}
   s.description = %q{Allows building ExtJS/Rails reusable code in a DRY way}
   s.email = %q{sergei@playcode.nl}
   s.extra_rdoc_files = [
@@ -162,12 +162,12 @@ Gem::Specification.new do |s|
     "test/unit/netzke_preference_test.rb",
     "uninstall.rb"
   ]
-  s.homepage = %q{http://github.com/skozlov/netzke-core}
+  s.homepage = %q{http://netzke.org}
   s.post_install_message = %q{
 ========================================================================
 
            Thanks for installing Netzke Core!
-           
+
   Netzke home page:     http://netzke.org
   Netzke Google Groups: http://groups.google.com/group/netzke
   Netzke tutorials:     http://blog.writelesscode.com
@@ -176,7 +176,6 @@ Gem::Specification.new do |s|
 
 }
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{netzke-core}
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Build ExtJS/Rails components with minimum effort}
   s.test_files = [