netzke-core 0.7.3 → 0.7.4

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+= v0.7.4 - 2011-10-20
+* enhancements
+  * Less aggressive rescuing at constantizing a string, to let more descriptive exceptions get through.
+  * New +delegates_to_dsl+ class method to degelate default config options to class level. See the +ConfigToDslDelegator+ module.
+
 = v0.7.3 - 2011-09-04
 * Rails 3.1 compatibility. Really. Hopefully.
 
@@ -49,7 +54,7 @@
 = v0.6.7 - 2011-08-16
 * enhancements
   * No more using +method_missing+ for invoking endpoints.
-  * New "cache" option for `netzke_init` which gets passed to `javascript_include_tag` (no support for css caching of this type yet)
+  * New "cache" option for +netzke_init+ which gets passed to +javascript_include_tag+ (no support for css caching of this type yet)
   * Netzke dynamic js and css-files such as ext.js, touch.css, now get generated at the application start, and put into "public/netzke". Solves a long standing problem with serving those files by HTTP servers in some cases. Enables caching naturally.
   * Moved features and specs to test/core_test_app (tests should be run from that folder from now on)
   * Introduced plugin functionality. We can create Netzke components that are pluggable into other components as Ext JS plugins.
@@ -59,7 +64,7 @@
   * Client-server communication is updated to use Ext.Direct (many thanks to @pschyska)
   * Introduced +js_translate+ class method that allows specifying i18n properties used in the JavaScript class
   * Better handling of actions i18n
-  * New `Netzke::Base.class_config_option` method to specify a class-level configuration options for a component, e.g. (in GridPanel): `class_config_option :column_filters_available, true`. This option then can be set in Rails application configuration, e.g.: `config.netzke.basepack.grid_panel.column_filters_available = false`, or directly on `Netzke::Core.config`, e.g.: `Netzke::Core.config.netzke.basepack.grid_panel.column_filters_available = false`.
+  * New +Netzke::Base.class_config_option+ method to specify a class-level configuration options for a component, e.g. (in GridPanel): +class_config_option :column_filters_available, true+. This option then can be set in Rails application configuration, e.g.: `config.netzke.basepack.grid_panel.column_filters_available = false`, or directly on `Netzke::Core.config`, e.g.: `Netzke::Core.config.netzke.basepack.grid_panel.column_filters_available = false`.
 
 = v0.6.5 - 2011-01-14
 * enhancements

data/{TODO → TODO.md}

@@ -1,14 +1,27 @@
-= ToDo
+# ToDo
 Make it possible to pass a constant (not a string) to the `class_name` option
+
 Make :lazy_loading "true" by default when defining a child component
+
 Make :items option also accept a hash.
+
 Caching for netzke_controller-provided JS and CSS.
+
 Caching - investigate reusing (fragment?) caching of Rails.
 
 
-= Ideas that didn't work out
+## Roadmap
+
+### 0.8
 
-== Making value from super-class accessible in the block parameters in endpoints, e.g.:
+Get rid of Symbol#action and Symbol#component
+
+Get rid of String#l
+
+
+## Ideas that didn't work out
+
+### Making value from super-class accessible in the block parameters in endpoints
 
     endpoint :call_server do |params, orig|
       orig.merge(:set_title => orig[:set_title] + " extended")
@@ -19,4 +32,4 @@ So, to override an endpoint, simply define a method with endpoint's name, e.g.:
 
     def call_server(params)
       super.merge(...)
-    end
+    end

data/lib/netzke/base.rb

@@ -12,6 +12,7 @@ require 'netzke/state'
 require 'netzke/embedding'
 require 'netzke/actions'
 require 'netzke/session'
+require 'netzke/config_to_dsl_delegator'
 
 module Netzke
   # The base for every Netzke component
@@ -41,6 +42,9 @@ module Netzke
     include Stylesheets
     include Embedding
     include Actions
+    include ConfigToDslDelegator
+
+    delegates_to_dsl :title, :items
 
     class_config_option :default_instance_config, {}
 
@@ -67,11 +71,7 @@ module Netzke
       def constantize_class_name(class_name)
         "#{class_name}".constantize
       rescue NameError
-        begin
-          "Netzke::#{class_name}".constantize
-        rescue NameError
-          nil
-        end
+        "Netzke::#{class_name}".constantize
       end
 
       # Instance of component by config

data/lib/netzke/config_to_dsl_delegator.rb

@@ -0,0 +1,41 @@
+module Netzke
+  # This module allows delegating the configuration options for a component into the level of the component's class.
+  # As an example, let's take the :title option understood by any Ext.panel.Panel-derived component. Netzke::Base calls:
+  #
+  #     delegates_to_dsl :title
+  #
+  # which provides any child class with a DSL method `title` which can be used like this:
+  #
+  #     class MyComponent < Netzke::Base
+  #       title "My cool component"
+  #     end
+  #
+  # This will provide for :title => "My cool component" being a default option for MyComponent's instances.
+  #
+  # This is very handy when a frequently-inherited class implements some common option. Another example would be the :model option in Basepack::Grid/FormPanel. This way the child class will not need to mess up with the `default_config` method if all it needs is specify that default option.
+  module ConfigToDslDelegator
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Delegates specified configuration options to the class level. See ConfigToDslDelegator.
+      def delegates_to_dsl(*option_names)
+        delegated_options = read_inheritable_attribute(:delegated_options) || []
+        delegated_options += option_names
+        write_inheritable_attribute(:delegated_options, delegated_options)
+      end
+
+      def inherited(inherited_class) # :nodoc:
+        super
+
+        properties = read_inheritable_attribute(:delegated_options) || []
+        properties.size.times do |i|
+          inherited_class.class.send(:define_method, properties[i], lambda { |value|
+            default_config = read_inheritable_attribute(:default_config) || {}
+            default_config.merge!(properties[i].to_sym => value)
+            write_inheritable_attribute(:default_config, default_config)
+          })
+        end
+      end
+    end
+  end
+end

data/lib/netzke/configuration.rb

@@ -1,4 +1,6 @@
 module Netzke
+  # Handles all the intricate matters of component configuration.
+  # TODO: simplify!
   module Configuration
     extend ActiveSupport::Concern
 
@@ -91,7 +93,7 @@ module Netzke
     module InstanceMethods
       # Default config - before applying any passed configuration
       def default_config
-        @default_config ||= {}.merge(weak_default_options).merge(self.class.default_instance_config)
+        @default_config ||= {}.merge(weak_default_options).merge(self.class.default_instance_config).merge(self.class.read_inheritable_attribute(:default_config) || {})
       end
 
       # Static, hardcoded config. Consists of default values merged with config that was passed during instantiation

data/lib/netzke/core/version.rb

@@ -3,7 +3,7 @@ module Netzke
     module Version
       MAJOR = 0
       MINOR = 7
-      PATCH = 3
+      PATCH = 4
 
       STRING = [MAJOR, MINOR, PATCH].compact.join('.')
     end

data/netzke-core.gemspec

@@ -5,17 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.7.3"
+  s.version = "0.7.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{NomadCoder}]
-  s.date = %q{2011-09-04}
+  s.date = %q{2011-10-20}
   s.description = %q{Allows building DRY ExtJS/Rails applications by enabling modular development}
   s.email = %q{nmcoder@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-    "README.md",
-    "TODO"
+    "README.md"
   ]
   s.files = [
     ".autotest",
@@ -24,7 +23,7 @@ Gem::Specification.new do |s|
     "Manifest",
     "README.md",
     "Rakefile",
-    "TODO",
+    "TODO.md",
     "app/controllers/netzke_controller.rb",
     "init.rb",
     "install.rb",
@@ -36,6 +35,7 @@ Gem::Specification.new do |s|
     "lib/netzke/actions.rb",
     "lib/netzke/base.rb",
     "lib/netzke/composition.rb",
+    "lib/netzke/config_to_dsl_delegator.rb",
     "lib/netzke/configuration.rb",
     "lib/netzke/core.rb",
     "lib/netzke/core/dynamic_assets.rb",

data/test/core_test_app/app/components/component_with_actions.rb

@@ -1,4 +1,6 @@
 class ComponentWithActions < Netzke::Base
+  title "Panel that has actions"
+
   # Define actions as a hash
   action :another_action, :disabled => true, :text => "Disabled action", :icon => :accept
 
@@ -12,7 +14,6 @@ class ComponentWithActions < Netzke::Base
     {:text => "Not used"}
   end
 
-  js_property :title, "Panel that has actions"
 
   js_property :bbar, [:some_action.action, :another_action.action]
 
@@ -55,4 +56,4 @@ class ComponentWithActions < Netzke::Base
     }
   JS
 
-end
+end

data/test/core_test_app/app/components/component_with_custom_css.rb

@@ -1,6 +1,6 @@
 # This component has the header hidden by custom CSS
 class ComponentWithCustomCss < Netzke::Base
-  js_property :title, "ComponentWithCustomCss"
+  title "ComponentWithCustomCss"
 
   js_property :html, "A component with the body hidden by means of custom CSS"
 

data/test/core_test_app/app/components/component_with_js_mixin.rb

@@ -1,5 +1,6 @@
 class ComponentWithJsMixin < Netzke::Base
-  js_property :title, "ComponentWithJsMixin"
+  title "ComponentWithJsMixin"
+
   js_include :extra_one, :extra_two
   js_mixin :method_set_one, :method_set_two
   js_mixin # with no parameters, it'll assume :component_with_js_mixin

data/test/core_test_app/app/components/component_with_session_persistence.rb

@@ -1,5 +1,6 @@
 class ComponentWithSessionPersistence < Netzke::Base
-  js_property :title, "Default Title"
+  title "Default Title"
+
   js_property :bbar, [:bug_server.action]
 
   action :bug_server, :text => "Tell server to store new title"

data/test/core_test_app/app/components/extended_server_caller.rb

@@ -1,5 +1,5 @@
 class ExtendedServerCaller < ServerCaller
-  js_properties :title => "Extended Server Caller"
+  title "Extended Server Caller"
 
   js_method :on_bug_server, <<-JS
     function(){
@@ -9,6 +9,7 @@ class ExtendedServerCaller < ServerCaller
     }
   JS
 
+  # Overriding the :whats_up endpoint from ServerCaller
   def whats_up_endpoint(params)
     super.tap do |s|
       s[:set_title] = s[:set_title] + ", shiny weather"

data/test/core_test_app/app/components/hello_world_component.rb

@@ -1,6 +1,6 @@
 class HelloWorldComponent < Netzke::Base
   # Ext.Panel's config option "title"
-  js_property :title, "My Hello World Component"
+  title "My Hello World Component"
 
   # Bottom bar with an automatically created action
   js_property :bbar, [:bug_server.action]

data/test/core_test_app/app/components/server_caller.rb

@@ -1,4 +1,6 @@
 class ServerCaller < Netzke::Base
+  title "Server Caller!"
+
   action :bug_server # Actual action's text is set in en.yml
 
   js_properties(
@@ -18,4 +20,4 @@ class ServerCaller < Netzke::Base
     {:set_title => "All quiet here on the server"}
   end
 
-end
+end

data/test/core_test_app/features/persistence.feature

@@ -12,6 +12,7 @@ Feature: Persistence
     And I should not see "HTML from session"
 
     When I press "Tell server to store new title"
+    And I wait for response from server
     And I go to the ComponentWithSessionPersistence test page
     Then I should see "Title From Session"
     And I should see "HTML from session"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netzke-core
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-04 00:00:00.000000000Z
+date: 2011-10-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70108192225160 !ruby/object:Gem::Requirement
+  requirement: &70252618149160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70108192225160
+  version_requirements: *70252618149160
 description: Allows building DRY ExtJS/Rails applications by enabling modular development
 email: nmcoder@gmail.com
 executables: []
@@ -29,7 +29,6 @@ extensions: []
 extra_rdoc_files:
 - LICENSE
 - README.md
-- TODO
 files:
 - .autotest
 - CHANGELOG.rdoc
@@ -37,7 +36,7 @@ files:
 - Manifest
 - README.md
 - Rakefile
-- TODO
+- TODO.md
 - app/controllers/netzke_controller.rb
 - init.rb
 - install.rb
@@ -49,6 +48,7 @@ files:
 - lib/netzke/actions.rb
 - lib/netzke/base.rb
 - lib/netzke/composition.rb
+- lib/netzke/config_to_dsl_delegator.rb
 - lib/netzke/configuration.rb
 - lib/netzke/core.rb
 - lib/netzke/core/dynamic_assets.rb