netzke-core 0.5.5 → 0.6.0

data/lib/netzke/services.rb

@@ -0,0 +1,68 @@
+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 
+      # 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__
+          def endpoint_#{apip}(*args)
+            before_api_call_result = defined?(before_api_call) && before_api_call('#{apip}', *args) || {}
+            (before_api_call_result.empty? ? #{apip}(*args) : before_api_call_result).to_nifty_json
+          end
+          END
+        end
+      end
+
+      # Defines an endpoint
+      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) || []
+        current_endpoints << ep
+        write_inheritable_attribute(:endpoints, current_endpoints.uniq)
+      end
+
+      # Returns registered endpoints
+      def endpoints
+        read_inheritable_attribute(:endpoints)
+      end
+    end
+    
+    module InstanceMethods
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+  end
+end

data/lib/netzke/session.rb

@@ -0,0 +1,35 @@
+module Netzke
+  # This modules provides (component-specific) session manupulation.
+  # The :session_persistence config option should be set to true in order for the component to make use of this.
+  module Session
+    # Top-level session (straight from the controller).
+    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?
+        component_session[:options] ||= {}
+        component_session[:options].merge!(hash)
+      else
+        logger.debug "Netzke warning: No session persistence enabled for component '#{global_id}'"
+      end
+    end
+    
+    private
+      def session_persistence_enabled?
+        initial_config[:session_persistence]
+      end
+  end
+end

data/lib/netzke/stylesheets.rb

@@ -0,0 +1,52 @@
+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
+        # Prevent re-including code that was already included by the parent
+        # (thus, only include those JS files when include_js was defined in the current class, not in its ancestors)
+        ((singleton_methods(false).map(&:to_sym).include?(:include_css) ? include_css : [] ) + css_included_files).inject(""){ |r, path| r + File.new(path).read + "\n"}
+      end
+
+      # All CSS code needed for this class including the one from the ancestor component
+      def css_code(cached = [])
+        res = ""
+
+        # include the base-class javascript if doing JS inheritance
+        res << superclass.css_code << "\n" if extends_netzke_component? && !cached.include?(superclass.short_component_class_name)
+
+        res << css_included << "\n"
+
+        res
+      end
+
+      # Definition of CSS files which will be dynamically loaded together with this component
+      # 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"
+      #  This is alternative to defining self.include_css
+      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| 
+          cached.include?(k) ? r : r + constantize_class_name(k).css_code(cached)
+        end
+        code.blank? ? nil : code
+      end
+      
+    end    
+  end
+end

data/lib/netzke-core.rb

@@ -1,38 +1,37 @@
-require 'active_support'
+$LOAD_PATH << File.dirname(__FILE__)
 
-# NetzkeCore
-require 'netzke/base'
+# require 'netzke/core_ext'
 
-require 'netzke/action_view_ext'
-require 'netzke/controller_extensions'
-require 'netzke/core_ext'
-require 'netzke/routing'
+require 'netzke/core'
+require 'netzke/base'
 
-# Load models and controllers from lib/app
-%w{ models controllers }.each do |dir|
-  path = File.join(File.dirname(__FILE__), 'app', dir)
-  $LOAD_PATH << path
-  ActiveSupport::Dependencies.load_paths << path
-  ActiveSupport::Dependencies.load_once_paths.delete(path)
+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
+      Netzke::Core.ext_location ||= ::Rails.root.join("public", "extjs")
+      Netzke::Core.with_icons = File.exists?("#{Rails.root}/public#{Netzke::Core.icons_uri}") if Netzke::Core.with_icons.nil?
+    end
+  end
 end
 
-if defined? ActionController
-  ActionController::Base.class_eval do
+# Rails specific
+if defined? Rails
+  require 'netzke/rails/routes'
+
+  ActiveSupport.on_load(:action_controller) do
+    require 'netzke/rails/controller_extensions'
     include Netzke::ControllerExtensions
   end
 
-  # Include the route to the Netzke controller
-  ActionController::Routing::RouteSet::Mapper.send :include, Netzke::Routing::MapperExtensions
+  ActiveSupport.on_load(:action_view) do
+    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
-
-if defined? ActionView
-  ActionView::Base.send :include, Netzke::ActionViewExt
-end  
-
-# Make this plugin auto-reloadable for easier development
-ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
-
-# Include javascript & styles required by all Netzke widgets. 
-# These files will get loaded at the initial load of the framework (along with Ext).
-Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/core.js"
-Netzke::Base.config[:stylesheets] << "#{File.dirname(__FILE__)}/../stylesheets/core.css"

data/netzke-core.gemspec

@@ -0,0 +1,253 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{netzke-core}
+  s.version = "0.6.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sergei Kozlov"]
+  s.date = %q{2010-10-24}
+  s.description = %q{Allows building ExtJS/Rails reusable code in a DRY way}
+  s.email = %q{sergei@playcode.nl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc",
+     "TODO"
+  ]
+  s.files = [
+    ".autotest",
+     ".gitignore",
+     "CHANGELOG.rdoc",
+     "LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "app/controllers/netzke_controller.rb",
+     "app/models/netzke_preference.rb",
+     "autotest/discover.rb",
+     "features/actions.feature",
+     "features/basic.feature",
+     "features/client-server.feature",
+     "features/complex_component.feature",
+     "features/component.feature",
+     "features/component_loader.feature",
+     "features/composition.feature",
+     "features/custom_css.feature",
+     "features/file_inclusion.feature",
+     "features/inheritance.feature",
+     "features/persistence.feature",
+     "features/scopes.feature",
+     "features/step_definitions/custom_css_steps.rb",
+     "features/step_definitions/generic_steps.rb",
+     "features/step_definitions/web_steps.rb",
+     "features/support/env.rb",
+     "features/support/paths.rb",
+     "generators/netzke_core/USAGE",
+     "generators/netzke_core/netzke_core_generator.rb",
+     "init.rb",
+     "install.rb",
+     "javascripts/core.js",
+     "lib/generators/migration_helper.rb",
+     "lib/generators/netzke/USAGE",
+     "lib/generators/netzke/core_generator.rb",
+     "lib/netzke-core.rb",
+     "lib/netzke/actions.rb",
+     "lib/netzke/base.rb",
+     "lib/netzke/composition.rb",
+     "lib/netzke/configuration.rb",
+     "lib/netzke/core.rb",
+     "lib/netzke/core/masquerading.rb",
+     "lib/netzke/core/session.rb",
+     "lib/netzke/core/version.rb",
+     "lib/netzke/core_ext.rb",
+     "lib/netzke/core_ext/array.rb",
+     "lib/netzke/core_ext/hash.rb",
+     "lib/netzke/core_ext/string.rb",
+     "lib/netzke/core_ext/symbol.rb",
+     "lib/netzke/core_ext/time_with_zone.rb",
+     "lib/netzke/embedding.rb",
+     "lib/netzke/ext_component.rb",
+     "lib/netzke/javascript.rb",
+     "lib/netzke/persistence.rb",
+     "lib/netzke/rails/action_view_ext.rb",
+     "lib/netzke/rails/controller_extensions.rb",
+     "lib/netzke/rails/routes.rb",
+     "lib/netzke/services.rb",
+     "lib/netzke/session.rb",
+     "lib/netzke/stylesheets.rb",
+     "lib/tasks/netzke_core_tasks.rake",
+     "netzke-core.gemspec",
+     "spec/component/actions_spec.rb",
+     "spec/component/base_spec.rb",
+     "spec/component/composition_spec.rb",
+     "spec/component/javascript_spec.rb",
+     "spec/core_ext_spec.rb",
+     "spec/spec.opt",
+     "spec/spec_helper.rb",
+     "stylesheets/core.css",
+     "templates/core/create_netzke_preferences.rb",
+     "test/fixtures/roles.yml",
+     "test/fixtures/users.yml",
+     "test/rails_app/.gitignore",
+     "test/rails_app/Gemfile",
+     "test/rails_app/Gemfile.lock",
+     "test/rails_app/README",
+     "test/rails_app/Rakefile",
+     "test/rails_app/app/components/border_layout_panel.rb",
+     "test/rails_app/app/components/component_loader.rb",
+     "test/rails_app/app/components/component_with_actions.rb",
+     "test/rails_app/app/components/component_with_custom_css.rb",
+     "test/rails_app/app/components/component_with_included_js.rb",
+     "test/rails_app/app/components/component_with_session_persistence.rb",
+     "test/rails_app/app/components/custom.css",
+     "test/rails_app/app/components/deprecated/server_caller.rb",
+     "test/rails_app/app/components/extended_component_with_actions.rb",
+     "test/rails_app/app/components/extended_server_caller.rb",
+     "test/rails_app/app/components/included.js",
+     "test/rails_app/app/components/kinda_complex_component.rb",
+     "test/rails_app/app/components/kinda_complex_component/basic_stuff.rb",
+     "test/rails_app/app/components/kinda_complex_component/extra_stuff.rb",
+     "test/rails_app/app/components/loader_of_component_with_custom_css.rb",
+     "test/rails_app/app/components/scoped_components/deep_scoped_components/some_deep_scoped_component.rb",
+     "test/rails_app/app/components/scoped_components/extended_scoped_component.rb",
+     "test/rails_app/app/components/scoped_components/some_scoped_component.rb",
+     "test/rails_app/app/components/server_caller.rb",
+     "test/rails_app/app/components/simple_component.rb",
+     "test/rails_app/app/components/simple_tab_panel.rb",
+     "test/rails_app/app/components/simple_window.rb",
+     "test/rails_app/app/components/some_composite.rb",
+     "test/rails_app/app/components/some_ext_component.rb",
+     "test/rails_app/app/controllers/application_controller.rb",
+     "test/rails_app/app/controllers/components_controller.rb",
+     "test/rails_app/app/controllers/multiple_components_controller.rb",
+     "test/rails_app/app/controllers/welcome_controller.rb",
+     "test/rails_app/app/helpers/application_helper.rb",
+     "test/rails_app/app/views/layouts/application.html.erb",
+     "test/rails_app/app/views/multiple_components/set_one.html.erb",
+     "test/rails_app/config.ru",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/config/boot.rb",
+     "test/rails_app/config/database.yml",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/environments/development.rb",
+     "test/rails_app/config/environments/production.rb",
+     "test/rails_app/config/environments/test.rb",
+     "test/rails_app/config/initializers/backtrace_silencers.rb",
+     "test/rails_app/config/initializers/inflections.rb",
+     "test/rails_app/config/initializers/mime_types.rb",
+     "test/rails_app/config/initializers/netzke.rb",
+     "test/rails_app/config/initializers/secret_token.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/locales/en.yml",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/db/development_structure.sql",
+     "test/rails_app/db/migrate/20100905214933_create_netzke_preferences.rb",
+     "test/rails_app/db/schema.rb",
+     "test/rails_app/db/seeds.rb",
+     "test/rails_app/lib/tasks/.gitkeep",
+     "test/rails_app/public/404.html",
+     "test/rails_app/public/422.html",
+     "test/rails_app/public/500.html",
+     "test/rails_app/public/favicon.ico",
+     "test/rails_app/public/images/rails.png",
+     "test/rails_app/public/robots.txt",
+     "test/rails_app/script/rails",
+     "test/rails_app/vendor/plugins/.gitkeep",
+     "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.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
+
+========================================================================
+
+}
+  s.rdoc_options = ["--charset=UTF-8"]
+  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 = [
+    "spec/component/actions_spec.rb",
+     "spec/component/base_spec.rb",
+     "spec/component/composition_spec.rb",
+     "spec/component/javascript_spec.rb",
+     "spec/core_ext_spec.rb",
+     "spec/spec_helper.rb",
+     "test/rails_app/app/components/border_layout_panel.rb",
+     "test/rails_app/app/components/component_loader.rb",
+     "test/rails_app/app/components/component_with_actions.rb",
+     "test/rails_app/app/components/component_with_custom_css.rb",
+     "test/rails_app/app/components/component_with_included_js.rb",
+     "test/rails_app/app/components/component_with_session_persistence.rb",
+     "test/rails_app/app/components/deprecated/server_caller.rb",
+     "test/rails_app/app/components/extended_component_with_actions.rb",
+     "test/rails_app/app/components/extended_server_caller.rb",
+     "test/rails_app/app/components/kinda_complex_component/basic_stuff.rb",
+     "test/rails_app/app/components/kinda_complex_component/extra_stuff.rb",
+     "test/rails_app/app/components/kinda_complex_component.rb",
+     "test/rails_app/app/components/loader_of_component_with_custom_css.rb",
+     "test/rails_app/app/components/scoped_components/deep_scoped_components/some_deep_scoped_component.rb",
+     "test/rails_app/app/components/scoped_components/extended_scoped_component.rb",
+     "test/rails_app/app/components/scoped_components/some_scoped_component.rb",
+     "test/rails_app/app/components/server_caller.rb",
+     "test/rails_app/app/components/simple_component.rb",
+     "test/rails_app/app/components/simple_tab_panel.rb",
+     "test/rails_app/app/components/simple_window.rb",
+     "test/rails_app/app/components/some_composite.rb",
+     "test/rails_app/app/components/some_ext_component.rb",
+     "test/rails_app/app/controllers/application_controller.rb",
+     "test/rails_app/app/controllers/components_controller.rb",
+     "test/rails_app/app/controllers/multiple_components_controller.rb",
+     "test/rails_app/app/controllers/welcome_controller.rb",
+     "test/rails_app/app/helpers/application_helper.rb",
+     "test/rails_app/config/application.rb",
+     "test/rails_app/config/boot.rb",
+     "test/rails_app/config/environment.rb",
+     "test/rails_app/config/environments/development.rb",
+     "test/rails_app/config/environments/production.rb",
+     "test/rails_app/config/environments/test.rb",
+     "test/rails_app/config/initializers/backtrace_silencers.rb",
+     "test/rails_app/config/initializers/inflections.rb",
+     "test/rails_app/config/initializers/mime_types.rb",
+     "test/rails_app/config/initializers/netzke.rb",
+     "test/rails_app/config/initializers/secret_token.rb",
+     "test/rails_app/config/initializers/session_store.rb",
+     "test/rails_app/config/routes.rb",
+     "test/rails_app/db/migrate/20100905214933_create_netzke_preferences.rb",
+     "test/rails_app/db/schema.rb",
+     "test/rails_app/db/seeds.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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 3.0.1"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 3.0.1"])
+  end
+end
+

data/spec/component/actions_spec.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'netzke-core'
+
+module Netzke
+  describe Actions do
+    # it "should be possible to override toolbars without overriding action settings" do
+    #   ExtendedComponentWithActions.new.actions[:another_action][:disabled].should == true
+    # end
+    
+    class SomeComponent < Base
+      action :action_one
+      action :action_two
+      action :action_three do
+        {:text => "Action three"}
+      end
+      
+      js_property :bbar, [:action_one.action, :action_two.action]
+    
+      def config
+        {
+          :tbar => [:action_three.action]
+        }
+      end
+    
+      def actions
+        super.deep_merge({
+          :action_four => {:text => "Action 4"}
+        })
+      end
+      
+      action :action_five, :text => "Action 5"
+    end
+  
+    class ExtendedComponent < SomeComponent
+      js_property :bbar, [:action_one.action, :action_two.action, :action_three.action, :action_four.action, :action_five.action]
+      js_property :tbar, [:action_one.action, :action_two.action, :action_three.action, :action_four.action, :action_five.action]
+    end
+    
+    class AnotherExtendedComponent < ExtendedComponent
+      action :action_one, :text => "Action 1"
+      action :action_five, :text => "Action Five"
+      
+      action :action_two do
+        super().merge :disabled => true, :text => super()[:text] + ", extended"
+      end
+      
+      action :action_three do
+        {:text => "Action 3"}
+      end
+    end
+    
+    class YetAnotherExtendedComponent < AnotherExtendedComponent
+      action :action_two, :disabled => false
+    end
+  
+    # it "should auto collect actions from both js_methods and config" do
+    #   component = SomeComponent.new
+    #   component.actions.keys.size.should == 5
+    #   component.actions[:action_one][:text].should == "Action one"
+    #   component.actions[:action_two][:text].should == "Action two"
+    #   component.actions[:action_three][:text].should == "Action three"
+    #   component.actions[:action_four][:text].should == "Action 4"
+    #   component.actions[:action_five][:text].should == "Action 5"
+    # end
+    
+    it "should not override previous actions when reconfiguring bars in child class" do
+      component = ExtendedComponent.new
+      # component.actions.keys.size.should == 5
+      component.actions[:action_one][:text].should == "Action one"
+      component.actions[:action_two][:text].should == "Action two"
+      component.actions[:action_three][:text].should == "Action three"
+      component.actions[:action_four][:text].should == "Action 4"
+      component.actions[:action_five][:text].should == "Action 5"
+    end
+    
+    it "should be possible to override actions in child class" do
+      component = AnotherExtendedComponent.new
+      component.actions[:action_one][:text].should == "Action 1"
+      component.actions[:action_five][:text].should == "Action Five"
+      
+      component.actions[:action_two][:text].should == "Action two, extended"
+      component.actions[:action_two][:disabled].should == true
+      
+      component.actions[:action_three][:text].should == "Action 3"
+    end
+    
+    it "should only override the specified actions" do
+      component = YetAnotherExtendedComponent.new
+      component.actions[:action_two][:disabled].should == false
+      component.actions[:action_two][:text].should == "Action two, extended"
+    end
+     
+  end  
+end

data/spec/component/base_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'netzke-core'
+
+describe Netzke::Base do
+  it "should keep config independent inside class hierarchy" do
+    class Parent < Netzke::Base
+      class_attribute :with_feature
+      self.with_feature = "yes"
+    end
+    
+    class Child < Parent; end
+    
+    Parent.with_feature.should == "yes"
+    Child.with_feature.should == "yes"
+    
+    Child.with_feature = "no"
+    
+    Parent.with_feature.should == "yes"
+    Child.with_feature.should == "no"
+    
+    Parent.with_feature = "maybe"
+    Parent.with_feature.should == "maybe"
+    Child.with_feature.should == "no"
+  end
+end