netzke-core 0.6.2 → 0.6.3

data/CHANGELOG.rdoc

@@ -1,4 +1,7 @@
-= v0.6.2 - EDGE
+= v0.6.3 - EDGE
+* The +ext_config+ option is back, deprecated.
+
+= v0.6.2 - 2010-10-27
 * Introduced the Symbol#component method to declare components in the config (instead of now deprecated js_component).
 
 = v0.6.1 - 2010-10-26
@@ -11,9 +14,9 @@
 * API backward incompatibility
   * +ext_config+ config level is removed; put all that configuration in the top level
   * mentioning actions in the +bbar+, +tbar+, etc, should be explicit, e.g.:
-  
+
       :bbar => [:apply.action, :delete.action]
-      
+
   * +late_aggregatee+ is now +lazy_loading+
   * +aggregatees+ are now +components+
   * +widgets+ are now +components+, too
@@ -30,9 +33,9 @@
   * +js_method+ DSL method to define (public) methods in JS class
   * +js_property+ DSL method to define (public) properties in JS class
   * +endpoint+ DSL method to define server endpoints
-  
+
 * Different deprecations throughout the code
-  
+
 = v0.5.3 - 2010-06-14
 * Fix: Getting rid of deprecation warnings about tasks not sitting in lib.
 
@@ -206,7 +209,7 @@
 = v0.1.0.2
 * Meta: fix outdated Manifest
 
-= v0.1.0.1 
+= v0.1.0.1
 * Meta work: replacing underscore with dash in the name
 
 = v0.1.0 - 2008-12-11

data/README.rdoc

@@ -2,14 +2,14 @@
 
 Create Ext JS + Rails components with minimum effort.
 
-This is the bare bones of the Netzke framework. Use it to build your own components from scratch. For pre-built components (like panels, grids, forms, trees, applications), see the netzke-basepack (http://github.com/skozlov/netzke-basepack) project.
+This is the bare bones of the Netzke framework. Use it to build your own components from scratch. For pre-built components (like panels, grids, forms, trees, applications), see the http://github.com/skozlov/netzke-basepack.
 
 The idea behind the Netzke framework is that it allows you write reusable client/server code. Create a component, and then embed it straight to your Rails' view, load it dynamically into your Ext-based applications, or use it as a building block for other (composite) components. For more info, see the links below.
 
 == Requirements
 
+* Ruby >= 1.9.2 (1.8.7 may work, too)
 * Rails >= 3.0.0
-* Ruby >= 1.9.2 (1.8.7 should work, but may not be supported as diligently)
 * Ext >= 3.3.0
 
 == Installation
@@ -18,16 +18,14 @@ For the latest ("edge") stuff, tell bundler to get the gem straight from github:
 
     gem 'netzke-core', :git => "git://github.com/skozlov/netzke-core.git"
 
-Or install as plugin:
-
-    rails plugin install git://github.com/skozlov/netzke-core.git
-    
 Netzke assumes that your ExtJS library is in public/extjs (which may be a symbolic link):
 
     ln -s ~/code/sencha/ext-3.3.0 public/extjs
 
 == Usage
 
+=== Creating a simple component
+
 Let's create a simple "Hello world!" component and embed it into a Rails' view. It'll be an Ext.Panel-based component with a button that triggers a client-server communication.
 
 Create YOUR_APP/app/components/hello_world_component.rb, and put in the following content:
@@ -38,10 +36,10 @@ Create YOUR_APP/app/components/hello_world_component.rb, and put in the followin
 
       # Bottom bar with an automatically created action
       js_property :bbar, [:bug_server.action]
-      
+
       # Action to be placed on the bottom bar
       action :bug_server, :text => 'Ask server', :icon => :accept
-      
+
       # Method in the JS class that (by default) processes the action's "click" event
       js_method :on_bug_server, <<-JS
         function(){
@@ -64,10 +62,11 @@ Create YOUR_APP/app/components/hello_world_component.rb, and put in the followin
       JS
     end
 
+=== Embedding components into Rails views
 
 To embed a Netzke component into your Rails view do the following:
 
-1. Add <tt>netzke</tt> routes:
+* Add <tt>netzke</tt> routes:
 
     # in routes.rb
     RailsApp::Application.routes.draw do
@@ -75,15 +74,15 @@ To embed a Netzke component into your Rails view do the following:
       ...
     end
 
-2. In your layout, within the "head" tag, use the <tt>netzke_init</tt> helper to include all the necessary JavaScript and styles.
+* In your layout, within the "head" tag, use the <tt>netzke_init</tt> helper to include all the necessary JavaScript and styles.
 
     <%= netzke_init %>
 
     # You can optionally specify an Ext theme:
 
     <%= netzke_init :ext_theme => 'grey' %>
-      
-3. In your view use the <tt>netzke</tt> helper to embed the component:
+
+* In your view use the <tt>netzke</tt> helper to embed the component:
 
     <%= netzke :hello_world_component %>
 
@@ -98,11 +97,11 @@ netzke-core is bundled with cucumber and RSpec tests. Before you can run them, y
 For cucumber tests:
 
     cucumber features
-    
+
 RSpec tests:
 
     rspec spec
-    
+
 == Testing playground
 
 The bundled test/rails_app application is also a convenient playground to learn more about the framework, as it may be run as a stand-alone Rails app. It's also a pretty good source of examples. After starting it, access any of the app/components/netzke test components by using the following url:
@@ -110,7 +109,7 @@ The bundled test/rails_app application is also a convenient playground to learn
     http://localhost:3000/components/<name of the component's class>
 
 e.g.:
-  
+
     http://localhost:3000/components/ServerCaller
 
 or, for scoped components:

data/Rakefile

@@ -7,8 +7,7 @@ begin
     gemspec.summary = "Build ExtJS/Rails components with minimum effort"
     gemspec.description = "Allows building ExtJS/Rails reusable code in a DRY way"
     gemspec.email = "sergei@playcode.nl"
-    gemspec.homepage = "http://github.com/skozlov/netzke-core"
-    gemspec.rubyforge_project = "netzke-core"
+    gemspec.homepage = "http://netzke.org"
     gemspec.authors = ["Sergei Kozlov"]
     gemspec.add_dependency("activesupport", ">=3.0.1")
     gemspec.post_install_message = <<-MESSAGE
@@ -16,7 +15,7 @@ begin
 ========================================================================
 
            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
@@ -24,30 +23,36 @@ begin
 ========================================================================
 
 MESSAGE
-    
+
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  require './lib/netzke/core/version'
+  version = Netzke::Core::Version::STRING
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "netzke-core #{version}"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('CHANGELOG*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+namespace :rdoc do
+  desc "Publish rdocs"
+  task :publish => :rdoc do
+    `scp -r rdoc/* fl:www/api.netzke.org/core`
+  end
+end

data/TODO

@@ -15,7 +15,7 @@ Some day
     endpoint :call_server do |params, orig|
       orig.merge(:set_title => orig[:set_title] + " extended")
     end
-  
+
 Bad idea because calling the super method is often required AFTER doing something in the override, not BEFORE. For example, deliver_component in GridPanel in Basepack is overridden to reconfigure the components on the fly before actually delivering the component (i.e. calling super).
 So, to override an endpoint, simply define a method with endpoint's name, e.g.:
 

data/app/controllers/netzke_controller.rb

@@ -1,5 +1,5 @@
 class NetzkeController < ApplicationController
-  
+
   # Collect javascripts and stylesheets from all plugins that registered it in Netzke::Core.javascripts
   # TODO: caching
   # caches_action :netzke
@@ -11,7 +11,7 @@ class NetzkeController < ApplicationController
           f = File.new(path)
           res << f.read
         end
-        
+
         # If JS classes are not inserted into the main page, we need to render all the classes needed to load the page that includes us
         # (i.e. netzke/netzke.js) here
         if !Netzke::Core.javascript_on_main_page
@@ -26,7 +26,7 @@ class NetzkeController < ApplicationController
 
         render :text => defined?(::Rails) && ::Rails.env.production? ? res.strip_js_comments : res
       }
-      
+
       format.css {
         res = ""
         Netzke::Core.stylesheets.each do |path|
@@ -37,15 +37,15 @@ class NetzkeController < ApplicationController
       }
     end
   end
-  
-  # Main dispatcher of the HTTP requests. The URL contains the name of the component, 
-  # as well as the method of this component to be called, according to the double underscore notation. 
+
+  # Main dispatcher of the HTTP requests. The URL contains the name of the component,
+  # as well as the method of this component to be called, according to the double underscore notation.
   # E.g.: some_grid__post_grid_data.
   def method_missing(method_name)
     component_name, *action = method_name.to_s.split('__')
     component_name = component_name.to_sym
     action = !action.empty? && action.join("__").to_sym
-  
+
     if action
       w_instance = Netzke::Base.instance_by_config(Netzke::Core.session[:netzke_components][component_name])
       # only component's actions starting with "endpoint_" are accessible from outside (security)
@@ -55,7 +55,7 @@ class NetzkeController < ApplicationController
       super
     end
   end
-  
+
   private
     # Generates initial javascript code that is dependent on Rails environement
     def initial_dynamic_javascript
@@ -66,5 +66,5 @@ class NetzkeController < ApplicationController
       res << %{Netzke.RelativeExtUrl = '#{ActionController::Base.config.relative_url_root}/extjs';}
       res.join("\n")
     end
-  
+
 end

data/app/models/netzke_preference.rb

@@ -1,23 +1,23 @@
 class NetzkePreference < ActiveRecord::Base
   serialize :value
-  
+
   # belongs_to :user
   # belongs_to :role
-  
+
   # ELEMENTARY_CONVERTION_METHODS= {'Fixnum' => 'to_i', 'String' => 'to_s', 'Float' => 'to_f', 'Symbol' => 'to_sym'}
-  
+
   # def self.component_name=(value)
   #   @@component_name = value
   # end
-  # 
+  #
   # def self.component_name
   #   @@component_name ||= nil
   # end
-  
+
   # def normalized_value
   #   klass      = read_attribute(:pref_type)
   #   norm_value = read_attribute(:value)
-  #   
+  #
   #   case klass
   #   when nil             then r = norm_value  # do not cast
   #   when 'Boolean'       then r = norm_value == 'false' ? false : (norm_value == 'true' || norm_value)
@@ -28,7 +28,7 @@ class NetzkePreference < ActiveRecord::Base
   #   end
   #   r
   # end
-  # 
+  #
   # def normalized_value=(new_value)
   #   case new_value.class.name
   #   when "Array" then write_attribute(:value, new_value.to_json)
@@ -37,17 +37,17 @@ class NetzkePreference < ActiveRecord::Base
   #   end
   #   write_attribute(:pref_type, [TrueClass, FalseClass].include?(new_value.class) ? 'Boolean' : new_value.class.to_s)
   # end
-  # 
+  #
   # def self.[](pref_name)
   #   pref_name  = normalize_preference_name(pref_name)
   #   pref       = self.pref_to_read(pref_name)
   #   pref && pref.normalized_value
   # end
-  # 
+  #
   # def self.[]=(pref_name, new_value)
   #   pref_name  = normalize_preference_name(pref_name)
   #   pref       = self.pref_to_write(pref_name)
-  #   
+  #
   #   # if assigning nil, simply delete the eventually found preference
   #   if new_value.nil?
   #     pref && pref.destroy
@@ -58,9 +58,9 @@ class NetzkePreference < ActiveRecord::Base
   #   end
   # end
 
-  
 
-  # Overwrite pref_to_read, pref_to_write methods, and find_all_for_component if you want a different way of 
+
+  # Overwrite pref_to_read, pref_to_write methods, and find_all_for_component if you want a different way of
   # identifying the proper preference based on your own authorization strategy.
   #
   # The default strategy is:
@@ -70,12 +70,12 @@ class NetzkePreference < ActiveRecord::Base
   #   2) if masq_user or masq_role is defined
   #     pref_to_read and pref_to_write will always take the masquerade into account, e.g. reads/writes will go to
   #     the user/role specified
-  #   
+  #
   def self.pref_to_read(name)
     name = name.to_s
     session = Netzke::Core.session
     cond = {:key => name}
-    
+
     if session[:masq_user]
       # first, get the prefs for this user it they exist
       res = self.where(cond.merge({:user_id => session[:masq_user]})).first
@@ -83,9 +83,9 @@ class NetzkePreference < ActiveRecord::Base
       # if it doesn't exist, get them for the user's role
       user = User.where(session[:masq_user])
       res ||= self.where(cond.merge({:role_id => user.role.id})).first
-      
+
       # if it doesn't exist either, get them for the World (role_id = 0)
-      res ||= self.where(cond.merge({:role_id => 0})).first 
+      res ||= self.where(cond.merge({:role_id => 0})).first
     elsif session[:masq_role]
       # first, get the prefs for this role
       res = self.where(cond.merge({:role_id => session[:masq_role]})).first
@@ -102,15 +102,15 @@ class NetzkePreference < ActiveRecord::Base
     else
       res = self.where(cond).first
     end
-    
-    res      
+
+    res
   end
-  
+
   def self.pref_to_write(name)
     name = name.to_s
     session = Netzke::Core.session
     cond = {:key => name}
-    
+
     if session[:masq_user]
       cond.merge!({:user_id => session[:masq_user]})
       # first, try to find the preference for masq_user
@@ -139,11 +139,11 @@ class NetzkePreference < ActiveRecord::Base
     end
     res
   end
-  
+
   # def self.find_all_for_component(name)
   #   session = Netzke::Core.session
   #   cond = {:component_name => name}
-  #   
+  #
   #   if session[:masq_user] || session[:masq_role]
   #     cond.merge!({:user_id => session[:masq_user], :role_id => session[:masq_role]})
   #     res = self.where(cond).all
@@ -154,17 +154,17 @@ class NetzkePreference < ActiveRecord::Base
   #   else
   #     res = self.where(cond).all
   #   end
-  #   
-  #   res      
+  #
+  #   res
   # end
-  
+
   # def self.delete_all_for_component(name)
   #   self.destroy(find_all_for_component(name))
   # end
-  # 
+  #
   # private
   # def self.normalize_preference_name(name)
   #   name.to_s.gsub(".", "__").gsub("/", "__")
   # end
-  
+
 end

data/features/actions.feature

@@ -8,6 +8,6 @@ Scenario: Pressing button should result in corresponding actions
   When I go to the ComponentWithActions test page
   Then I should see "Disabled action"
   And button "Disabled action" should be disabled
-  
+
   When I press "Some action"
   Then I should see "Some action was triggered"

data/features/basic.feature

@@ -2,6 +2,6 @@ Feature: Basic Netzke functionality
   In order to value
   As a role
   I want feature
-  
+
 Scenario: Initial loading
   Then Netzke should be initialized

data/features/client-server.feature

@@ -7,7 +7,7 @@ Feature: Client/server communication
 Scenario: Ask server to set our title
   Given I am on the ServerCaller test page
   Then I should see "Server Caller"
-  
+
   # When I execute "Ext.getCmp('server_caller').buttons.first().fireEvent('click');"
   When I press "Call server"
   Then I should see "All quiet here on the server"

data/features/component_loader.feature

@@ -9,23 +9,22 @@ Feature: Component loader
     When I press "Load component"
     Then I should see "Inner text"
     And I should see "Simple Component"
-  
+
     When I press "Load in window"
     Then I should see "Component loaded in window"
-    
+
   @selenium
   Scenario: Component loader should invoke a callback
     Given I am on the ComponentLoader test page
     When I press "Load with feedback"
     Then I should see "Callback invoked!"
-  
-  
+
+
   @selenium
   Scenario: Component loader should load a window component with another component in it
     Given I am on the ComponentLoader test page
     When I press "Load window with simple component"
     Then I should see "Simple Component Inside Window"
     And I should see "Inner text"
-  
-  
-  
+
+

data/features/composition.feature

@@ -15,18 +15,17 @@ Feature: Composition
     When I press "Call server" within "#some_composite__center_panel"
     Then I should see "All quiet here on the server"
     And I should not see "All quiet here on the server, shiny weather"
-    
+
     When I press "Call server" within "#some_composite__west_panel"
     Then I should see "All quiet here on the server, shiny weather"
-  
+
   @javascript
   Scenario: Server should be able to address (deeply) nested components
     Given I am on the SomeComposite test page
     When I press "Update west from server"
     Then I should see "Here's an update for west panel"
-    
+
     When I press "Update east south from server"
     Then I should see "Here's an update for south panel in east panel"
-  
-  
-  
+
+

data/features/custom_css.feature

@@ -8,7 +8,7 @@ Feature: Custom css
     When I go to the ComponentWithCustomCss test page
     Then I should see "ComponentWithCustomCss"
     But  the body of ComponentWithCustomCss component should not be invisible
-  
+
   @javascript
   Scenario: A dynamically loaded component with a hidden body should not display its body
     When I go to the LoaderOfComponentWithCustomCss test page

data/features/inheritance.feature

@@ -16,4 +16,3 @@ Feature: Inheritance
     Given I am on the ScopedComponents::ExtendedScopedComponent test page
     Then I should see "Extended Scoped Component Title"
     And I should see "Extended Scoped Component HTML"
-  

data/features/persistence.feature

@@ -11,6 +11,6 @@ Feature: Persistence
     When I press "Tell server to store new title"
     And I go to the ComponentWithSessionPersistence test page
     Then I should see "New Title!"
-  
-  
-  
+
+
+

data/features/scopes.feature

@@ -12,6 +12,6 @@ Feature: Scopes
     When I go to the ScopedComponents::DeepScopedComponents::SomeDeepScopedComponent test page
     Then I should see "Some Deep Scoped Component Title"
     And I should see "Some Deep Scoped Component HTML"
-  
-  
-  
+
+
+

data/features/step_definitions/web_steps.rb

@@ -1,6 +1,6 @@
 # IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
-# It is recommended to regenerate this file in the future when you upgrade to a 
-# newer version of cucumber-rails. Consider adding your own code to a new file 
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
@@ -191,7 +191,7 @@ Then /^the "([^"]*)" checkbox(?: within "([^"]*)")? should not be checked$/ do |
     end
   end
 end
- 
+
 Then /^(?:|I )should be on (.+)$/ do |page_name|
   current_path = URI.parse(current_url).path
   if current_path.respond_to? :should
@@ -205,8 +205,8 @@ Then /^(?:|I )should have the following query string:$/ do |expected_pairs|
   query = URI.parse(current_url).query
   actual_params = query ? CGI.parse(query) : {}
   expected_params = {}
-  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')} 
-  
+  expected_pairs.rows_hash.each_pair{|k,v| expected_params[k] = v.split(',')}
+
   if actual_params.respond_to? :should
     actual_params.should == expected_params
   else

data/features/support/env.rb

@@ -1,6 +1,6 @@
 # IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
-# It is recommended to regenerate this file in the future when you upgrade to a 
-# newer version of cucumber-rails. Consider adding your own code to a new file 
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
 # instead of editing this one. Cucumber will automatically load all features/**/*.rb
 # files.
 
@@ -27,7 +27,7 @@ require 'cucumber/rails/capybara_javascript_emulation' # Lets you click links wi
 # steps to use the XPath syntax.
 Capybara.default_selector = :css
 
-# If you set this to false, any error raised from within your app will bubble 
+# If you set this to false, any error raised from within your app will bubble
 # up to your step definition and out to cucumber unless you catch it somewhere
 # on the way. You can make Rails rescue errors and render error pages on a
 # per-scenario basis by tagging a scenario or feature with the @allow-rescue tag.
@@ -39,15 +39,15 @@ Capybara.default_selector = :css
 ActionController::Base.allow_rescue = false
 
 # If you set this to true, each scenario will run in a database transaction.
-# You can still turn off transactions on a per-scenario basis, simply tagging 
+# You can still turn off transactions on a per-scenario basis, simply tagging
 # a feature or scenario with the @no-txn tag. If you are using Capybara,
 # tagging with @culerity or @javascript will also turn transactions off.
 #
 # If you set this to false, transactions will be off for all scenarios,
 # regardless of whether you use @no-txn or not.
 #
-# Beware that turning transactions off will leave data in your database 
-# after each scenario, which can lead to hard-to-debug failures in 
+# Beware that turning transactions off will leave data in your database
+# after each scenario, which can lead to hard-to-debug failures in
 # subsequent scenarios. If you do this, we recommend you create a Before
 # block that will explicitly put your database in a known state.
 Cucumber::Rails::World.use_transactional_fixtures = true

data/generators/netzke_core/netzke_core_generator.rb

@@ -7,12 +7,12 @@ class NetzkeCoreGenerator < Rails::Generator::Base
       }, :migration_file_name => "create_netzke_preferences"
     end
   end
-  
+
   def self.gem_root
     File.expand_path('../../../', __FILE__)
   end
 
   def self.source_root
     File.join(gem_root, 'templates', 'core')
-  end  
+  end
 end