netzke-core 0.6.4 → 0.6.5

data/lib/netzke/railz/action_view_ext.rb

@@ -0,0 +1,86 @@
+require 'netzke/railz/action_view_ext/ext'
+require 'netzke/railz/action_view_ext/touch'
+module Netzke
+  module Railz
+    module ActionViewExt
+      include Ext
+      include Touch
+
+      # A helper to initialize Netzke. Usually used in the layout.
+      #
+      # Params:
+      # * :platform - :ext or :touch, by default :ext
+      # * :theme - the name of theme to apply
+      #
+      # E.g.:
+      #     <%= netzke_init :theme => :grey %>
+      #
+      # For Sencha Touch:
+      #     <%= netzke_init :platform => :touch %>
+      def netzke_init(params = {})
+        Netzke::Core.platform = params[:platform] || :ext
+        theme = params[: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]
+      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
+
+        # Register the component in session
+        Netzke::Core.reg_component(config)
+
+        w = Netzke::Base.instance_by_config(config)
+        w.before_load # inform the component about initial load
+
+        content_for :netzke_js_classes, raw(w.js_missing_code(@rendered_classes))
+
+        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 (by storing it's xtype), so that we only generate it once per view
+        @rendered_classes << class_name.to_s.gsub("::", "").downcase unless @rendered_classes.include?(class_name)
+
+        # Return the html for this component
+        raw(w.js_component_html)
+      end
+
+      protected
+
+        # Link tags for all the required stylsheets
+        def netzke_css_include(theme)
+          send :"netzke_#{Netzke::Core.platform}_css_include", theme
+        end
+
+        # Inline CSS specific for the page
+        def netzke_css
+          %{
+    <style type="text/css" media="screen">
+      #{content_for(:netzke_css)}
+    </style>} if content_for(:netzke_css).present?
+        end
+
+        # Script tags for all the required JavaScript
+        def netzke_js_include
+          send :"netzke_#{Netzke::Core.platform}_js_include"
+        end
+
+        # Inline JavaScript for all Netzke classes on the page, as well as Ext.onReady (Ext.setup in case of Touch) which renders Netzke components in this view after the page is loaded
+        def netzke_js
+          send :"netzke_#{Netzke::Core.platform}_js"
+        end
+
+    end
+  end
+end

data/lib/netzke/railz/controller_extensions.rb

@@ -0,0 +1,33 @@
+module Netzke
+  module Railz
+    module ControllerExtensions
+      def self.included(base)
+        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
+        # set netzke_just_logged_in and netzke_just_logged_out states (may be used by Netzke components)
+        if session[:_netzke_next_request_is_first_after_login]
+          session[:netzke_just_logged_in] = true
+          session[:_netzke_next_request_is_first_after_login] = false
+        else
+          session[:netzke_just_logged_in] = false
+        end
+
+        if session[:_netzke_next_request_is_first_after_logout]
+          session[:netzke_just_logged_out] = true
+          session[:_netzke_next_request_is_first_after_logout] = false
+        else
+          session[:netzke_just_logged_out] = false
+        end
+      end
+
+      def set_controller
+         ::Netzke::Core.controller = self
+      end
+    end
+  end
+end

data/lib/netzke/railz.rb

@@ -0,0 +1,3 @@
+require 'netzke/railz/routes'
+require 'netzke/railz/action_view_ext'
+require 'netzke/railz/controller_extensions'

data/lib/netzke/session.rb

@@ -2,6 +2,22 @@ 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
+    class ComponentSessionProxy < Hash #:nodoc:
+      def initialize(component_id)
+        @component_id = component_id
+        super
+      end
+
+      def [](key)
+        (Netzke::Core.session[@component_id] || {})[key]
+      end
+
+      def []=(key, value)
+        (Netzke::Core.session[@component_id] ||= {})[key] = value
+        # super
+      end
+    end
+
     # Top-level session (straight from the controller).
     def session
       ::Netzke::Core.session
@@ -9,7 +25,7 @@ module Netzke
 
     # Component-specific session.
     def component_session
-      session[global_id] ||= {}
+      @component_session_proxy ||= ComponentSessionProxy.new(global_id)
     end
 
     # Returns this component's configuration options stored in the session. Those get merged into the component's configuration at instantiation.
@@ -20,8 +36,7 @@ module Netzke
     # Updates the session options
     def update_session_options(hash)
       if session_persistence_enabled?
-        component_session[:options] ||= {}
-        component_session[:options].merge!(hash)
+        component_session.deep_merge!(:options => hash)
       else
         logger.debug "Netzke warning: No session persistence enabled for component '#{global_id}'"
       end

data/lib/netzke/state.rb

@@ -2,23 +2,23 @@ require 'active_support/core_ext/hash/indifferent_access'
 module Netzke
   # When a persistence subsystem (such as {netzke-persistence}[https://github.com/skozlov/netzke-persistence]) is used, a widget can store its state using the +update_state+ method that accepts a hash, e.g.:
   #     update_state(:position => {:x => 100, :y => 200})
-  # 
+  #
   # Later the state can be retrieved by calling the +state+ method:
-  # 
+  #
   #     state[:position] #=> {:x => 100, :y => 200}
-  # 
+  #
   # To enable persistence for a specific component, configure it with +persistence+ option set to +true+.
-  # 
+  #
   # == Sharing state
-  # 
+  #
   # Different components can share the state by sharing the persistence key, which can be provided as configuration option, e.g.:
-  # 
+  #
   #     netzke :books, :class_name => "Basepack::GridPanel", :persistence_key => "books_state_identifier"
   #     netzke :deleted_books, :class_name => "Basepack::GridPanel", :persistence_key => "books_state_identifier"
-  # 
+  #
   # Make sure that the provided persistence_key has effect on _application_ level, _not_ only within the view.
   # By default persistence_key is set to component's global id. Thus, <i>two components named equally will share the state even being used in different views</i>.
-  # 
+  #
   module State
     # A string which will identify the component in persistence subsystem.
     # If +persistence_key+ is passed, use it. Otherwise use global_id.
@@ -30,18 +30,36 @@ module Netzke
     def state
       @state ||= (state_manager.state || {}).symbolize_keys
     end
-    
+
     # Merges passed hash into component's state.
-    def update_state(hsh)
-      state_manager.update_state!(hsh)
+    # Can also accept 2 arguments which will be treated as a hash pair. E.g.:
+    #
+    #     update_state(:peoples_most_feared_number, 13)
+    #
+    # is equivalent to:
+    #
+    #     update_state(:peoples_most_feared_number => 13)
+    def update_state(*args)
+      state_manager.update_state!(args.first.is_a?(Hash) ? args.first : {args.first => args.last})
       @state = nil # reset cache
     end
 
+    # Component's persistent state.
+    def global_state
+      @global_state ||= (global_state_manager.state || {}).symbolize_keys
+    end
+
+    # Merges passed hash into component's state.
+    def update_global_state(hsh)
+      global_state_manager.update_state!(hsh)
+      @global_state = nil # reset cache
+    end
+
     # Options merged into component's configuration right after default and user-passed config, thus being reflected in +Netzke::Base#independent_config+ (see Netzke::Configuration).
     def persistent_options
       (state[:persistent_options] || {}).symbolize_keys
     end
-    
+
     # Updates +persistent_options+
     def update_persistent_options(hsh)
       new_persistent_options = persistent_options.merge(hsh)
@@ -49,8 +67,8 @@ module Netzke
       update_state(:persistent_options => new_persistent_options)
     end
 
-    protected 
-    
+    protected
+
     # Initialized state manager class. At this moment this class has current_user, component, and session set.
     def state_manager
       @state_manager ||= Netzke::Core.persistence_manager_class.init({
@@ -60,5 +78,14 @@ module Netzke
       })
     end
 
+    # Initialized state manager class, configured for managing global (not component specific) settings. At this moment this class has current_user and session set.
+    def global_state_manager
+      @global_state_manager ||= Netzke::Core.persistence_manager_class.init({
+        :current_user => Netzke::Core.controller.respond_to?(:current_user) && Netzke::Core.controller.current_user,
+        :session => Netzke::Core.session
+      })
+    end
+
+
   end
-end
+end

data/lib/netzke/stylesheets.rb

@@ -27,22 +27,37 @@ module Netzke
         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
+      # Use it to specify stylesheet files to be loaded along with this component.
+      # It may accept one or more symbols or strings. Strings will be interpreted as full paths to included files:
+      #
+      #     css_include "#{File.dirname(__FILE__)}/my_component/one.css", "#{File.dirname(__FILE__)}/my_component/two.css"
+      #
+      # Symbols will be expanded following a convention, e.g.:
+      #
+      #     class MyComponent < Netzke::Base
+      #       css_include :some_library
+      #       # ...
+      #     end
+      #
+      # This will "include" a stylesheet file +{component_location}/my_component/stylesheets/some_library.js+
       def css_include(*args)
-        self.css_included_files += args
+        callr = caller.first
+
+        self.css_included_files += args.map{ |a| a.is_a?(Symbol) ? expand_css_include_path(a, callr) : a }
       end
 
+      protected
+
+        def expand_css_include_path(sym, callr) # :nodoc:
+          %Q(#{callr.split(".rb:").first}/stylesheets/#{sym}.css)
+        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)
+          cached.include?(k.js_xtype) ? r : r + k.css_code(cached)
         end
         code.blank? ? nil : code
       end

data/lib/netzke-core.rb

@@ -1,7 +1,5 @@
 $LOAD_PATH << File.dirname(__FILE__)
 
-# require 'netzke/core_ext'
-
 require 'netzke/core'
 require 'netzke/base'
 
@@ -9,30 +7,39 @@ 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?
-      Netzke::Core.persistence_manager_class = Netzke::Core.persistence_manager.constantize rescue nil
+  module Core
+    class Engine < ::Rails::Engine
+      # before loading initializers and classes (in app/**)
+      config.before_initialize do
+        Netzke::Core.ext_location = Rails.root.join("public", "extjs")
+        Netzke::Core.touch_location = Rails.root.join("public", "sencha-touch")
+        Netzke::Core.persistence_manager_class = Netzke::Core.persistence_manager.constantize rescue nil
+      end
+
+      # after loading initializers and classes
+      config.after_initialize do
+        Netzke::Core.with_icons = File.exists?("#{::Rails.root}/public#{Netzke::Core.icons_uri}") if Netzke::Core.with_icons.nil?
+
+        # If need to cache classes, memoize Netzke::Base.constantize_class_name for performance
+        if Rails.configuration.cache_classes
+          class << Netzke::Base
+            memoize :constantize_class_name
+          end
+        end
+      end
     end
   end
 end
 
 # Rails specific
 if defined? Rails
-  require 'netzke/rails/routes'
+  require 'netzke/railz'
 
   ActiveSupport.on_load(:action_controller) do
-    require 'netzke/rails/controller_extensions'
-    include Netzke::ControllerExtensions
+    include Netzke::Railz::ControllerExtensions
   end
 
   ActiveSupport.on_load(:action_view) do
-    require 'netzke/rails/action_view_ext'
-    include Netzke::ActionViewExt
+    include Netzke::Railz::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,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.6.4"
+  s.version = "0.6.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2010-11-05}
+  s.date = %q{2011-01-14}
   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",
+    "README.markdown",
     "TODO"
   ]
   s.files = [
@@ -22,12 +22,13 @@ Gem::Specification.new do |s|
     "CHANGELOG.rdoc",
     "LICENSE",
     "Manifest",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "TODO",
     "app/controllers/netzke_controller.rb",
     "app/models/netzke_preference.rb",
     "autotest/discover.rb",
+    "config/database.yml",
     "features/actions.feature",
     "features/basic.feature",
     "features/client-server.feature",
@@ -38,6 +39,8 @@ Gem::Specification.new do |s|
     "features/custom_css.feature",
     "features/file_inclusion.feature",
     "features/inheritance.feature",
+    "features/js_include.feature",
+    "features/nested_views.feature",
     "features/persistence.feature",
     "features/scopes.feature",
     "features/step_definitions/custom_css_steps.rb",
@@ -48,6 +51,8 @@ Gem::Specification.new do |s|
     "init.rb",
     "install.rb",
     "javascripts/core.js",
+    "javascripts/ext.js",
+    "javascripts/touch.js",
     "lib/netzke-core.rb",
     "lib/netzke/actions.rb",
     "lib/netzke/base.rb",
@@ -66,9 +71,13 @@ Gem::Specification.new do |s|
     "lib/netzke/embedding.rb",
     "lib/netzke/ext_component.rb",
     "lib/netzke/javascript.rb",
-    "lib/netzke/rails/action_view_ext.rb",
-    "lib/netzke/rails/controller_extensions.rb",
-    "lib/netzke/rails/routes.rb",
+    "lib/netzke/javascript/scopes.rb",
+    "lib/netzke/railz.rb",
+    "lib/netzke/railz/action_view_ext.rb",
+    "lib/netzke/railz/action_view_ext/ext.rb",
+    "lib/netzke/railz/action_view_ext/touch.rb",
+    "lib/netzke/railz/controller_extensions.rb",
+    "lib/netzke/railz/routes.rb",
     "lib/netzke/services.rb",
     "lib/netzke/session.rb",
     "lib/netzke/state.rb",
@@ -79,6 +88,7 @@ Gem::Specification.new do |s|
     "spec/component/base_spec.rb",
     "spec/component/composition_spec.rb",
     "spec/component/javascript_spec.rb",
+    "spec/component/state_spec.rb",
     "spec/core_ext_spec.rb",
     "spec/spec.opt",
     "spec/spec_helper.rb",
@@ -94,12 +104,20 @@ Gem::Specification.new do |s|
     "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_custom_css/stylesheets/custom.css",
     "test/rails_app/app/components/component_with_included_js.rb",
+    "test/rails_app/app/components/component_with_js_mixin.rb",
+    "test/rails_app/app/components/component_with_js_mixin/javascripts/extra_one.js",
+    "test/rails_app/app/components/component_with_js_mixin/javascripts/extra_two.js",
+    "test/rails_app/app/components/component_with_js_mixin/javascripts/method_set_one.js",
+    "test/rails_app/app/components/component_with_js_mixin/javascripts/method_set_two.js",
     "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_component_with_js_mixin.rb",
+    "test/rails_app/app/components/extended_component_with_js_mixin/javascripts/some_method_set.js",
     "test/rails_app/app/components/extended_server_caller.rb",
+    "test/rails_app/app/components/hello_world_component.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",
@@ -110,16 +128,26 @@ Gem::Specification.new do |s|
     "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_panel.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/components/touch/hello_world_component.rb",
+    "test/rails_app/app/components/touch/server_caller.rb",
+    "test/rails_app/app/components/touch/simple_carousel.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/touch_controller.rb",
     "test/rails_app/app/controllers/welcome_controller.rb",
     "test/rails_app/app/helpers/application_helper.rb",
+    "test/rails_app/app/helpers/touch_helper.rb",
+    "test/rails_app/app/views/components/panel_with_autoload.html.erb",
+    "test/rails_app/app/views/components/some_tab_panel.html.erb",
     "test/rails_app/app/views/layouts/application.html.erb",
+    "test/rails_app/app/views/layouts/nested.html.erb",
+    "test/rails_app/app/views/layouts/touch.html.erb",
     "test/rails_app/app/views/multiple_components/set_one.html.erb",
     "test/rails_app/config.ru",
     "test/rails_app/config/application.rb",
@@ -138,7 +166,7 @@ Gem::Specification.new do |s|
     "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/migrate/20110110132720_create_netzke_component_states.rb",
     "test/rails_app/db/schema.rb",
     "test/rails_app/db/seeds.rb",
     "test/rails_app/lib/tasks/.gitkeep",
@@ -149,6 +177,8 @@ Gem::Specification.new do |s|
     "test/rails_app/public/images/rails.png",
     "test/rails_app/public/robots.txt",
     "test/rails_app/script/rails",
+    "test/rails_app/spec/controllers/touch_controller_spec.rb",
+    "test/rails_app/spec/helpers/touch_helper_spec.rb",
     "test/rails_app/vendor/plugins/.gitkeep",
     "test/test_helper.rb",
     "test/unit/core_ext_test.rb",
@@ -177,6 +207,7 @@ Gem::Specification.new do |s|
     "spec/component/base_spec.rb",
     "spec/component/composition_spec.rb",
     "spec/component/javascript_spec.rb",
+    "spec/component/state_spec.rb",
     "spec/core_ext_spec.rb",
     "spec/spec_helper.rb",
     "test/rails_app/app/components/border_layout_panel.rb",
@@ -184,10 +215,13 @@ Gem::Specification.new do |s|
     "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_js_mixin.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_component_with_js_mixin.rb",
     "test/rails_app/app/components/extended_server_caller.rb",
+    "test/rails_app/app/components/hello_world_component.rb",
     "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",
@@ -197,15 +231,21 @@ Gem::Specification.new do |s|
     "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_panel.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/components/touch/hello_world_component.rb",
+    "test/rails_app/app/components/touch/server_caller.rb",
+    "test/rails_app/app/components/touch/simple_carousel.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/touch_controller.rb",
     "test/rails_app/app/controllers/welcome_controller.rb",
     "test/rails_app/app/helpers/application_helper.rb",
+    "test/rails_app/app/helpers/touch_helper.rb",
     "test/rails_app/config/application.rb",
     "test/rails_app/config/boot.rb",
     "test/rails_app/config/environment.rb",
@@ -219,9 +259,11 @@ Gem::Specification.new do |s|
     "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/migrate/20110110132720_create_netzke_component_states.rb",
     "test/rails_app/db/schema.rb",
     "test/rails_app/db/seeds.rb",
+    "test/rails_app/spec/controllers/touch_controller_spec.rb",
+    "test/rails_app/spec/helpers/touch_helper_spec.rb",
     "test/test_helper.rb",
     "test/unit/core_ext_test.rb",
     "test/unit/netzke_core_test.rb",