netzke-core 0.6.4 → 0.6.5

data/lib/netzke/base.rb

@@ -1,4 +1,5 @@
 require 'active_support/core_ext'
+require 'active_support/memoizable'
 require 'netzke/core_ext'
 require 'netzke/javascript'
 require 'netzke/stylesheets'
@@ -47,20 +48,29 @@ module Netzke
     attr_reader :global_id
 
     class << self
+      extend ActiveSupport::Memoizable
+
       # Component's short class name, e.g.:
       # "Netzke::Module::SomeComponent" => "Module::SomeComponent"
       def short_component_class_name
         self.name.sub(/^Netzke::/, "")
       end
 
-      # Component's class, given its name
+      # Component's class, given its name.
+      # Note: this method will be memoized if Rails.configuration.cache_classes is true.
       def constantize_class_name(class_name)
-        "#{class_name}".constantize rescue "Netzke::#{class_name}".constantize
+        "#{class_name}".constantize
+      rescue NameError
+        begin
+          "Netzke::#{class_name}".constantize
+        rescue NameError
+          nil
+        end
       end
 
       # Instance of component by config
       def instance_by_config(config)
-        constantize_class_name(config[:class_name]).new(config)
+        (config[:klass] || constantize_class_name(config[:class_name])).new(config)
       end
 
       # All ancestor classes in the Netzke class hierarchy (i.e. up to Netzke::Base)
@@ -78,6 +88,27 @@ module Netzke
         # We don't want here any values from the superclass (which is the consequence of using inheritable attributes).
         res == self.superclass.read_inheritable_attribute(attr_name) ? {} : res
       end
+
+      # Same as +read_inheritable_attribute+ returning a hash, but returns empty hash when it's equal to superclass's
+      def read_clean_inheritable_array(attr_name)
+        res = read_inheritable_attribute(attr_name) || []
+        # We don't want here any values from the superclass (which is the consequence of using inheritable attributes).
+        res == self.superclass.read_inheritable_attribute(attr_name) ? [] : res
+      end
+    end
+
+
+    def self.total_instances
+      @@instances || 0
+    end
+
+    def self.reset_total_instances
+      @@instances = 0
+    end
+
+    def self.increase_total_instances
+      @@instances ||= 0
+      @@instances += 1
     end
 
     # Instantiates a component instance. A parent can optionally be provided.
@@ -92,6 +123,8 @@ module Netzke
       # initialize @components and @items
       normalize_components_in_items
       # auto_collect_actions_from_config_and_js_properties
+
+      self.class.increase_total_instances
     end
 
     # Proxy to the equally named class method
@@ -108,11 +141,20 @@ module Netzke
     def before_load
     end
 
+    def clean_up
+      component_session.clear
+      components.keys.each { |k| component_instance(k).clean_up }
+    end
+
+    def i18n_id
+      self.class.name.split("::").map{|c| c.underscore}.join(".")
+    end
+
     private
 
       def logger #:nodoc:
-        if defined?(Rails)
-          Rails.logger
+        if defined?(::Rails)
+          ::Rails.logger
         else
           require 'logger'
           Logger.new(STDOUT)
@@ -126,4 +168,4 @@ module Netzke
       end
 
   end
-end
+end

data/lib/netzke/composition.rb

@@ -1,6 +1,21 @@
 # require 'active_support/core_ext/class/inheritable_attributes'
 
 module Netzke
+  # You can define a nested components by calling the class method +component+:
+  #
+  #     component :users, :data_class => "GridPanel", :model => "User"
+  #
+  # The method also accepts a block in case you want access to the component's instance:
+  #
+  #     component :books do
+  #       {:data_class => "Book", :title => build_title}
+  #     end
+  #
+  # To override a component, define a method {component_name}_component, e.g.:
+  #
+  #     def books_component
+  #       super.merge(:title => "Modified Title")
+  #     end
   module Composition
     extend ActiveSupport::Concern
 
@@ -14,8 +29,8 @@ module Netzke
       # * <tt>:id</tt> - reference to the component
       # * <tt>:container</tt> - Ext id of the container where in which the component will be rendered
       endpoint :deliver_component do |params|
-        cache = params[:cache].gsub(".", "::").split(",") # array of cached class names (in Ruby)
-        component_name = params.delete(:name).underscore.to_sym
+        cache = params[:cache].split(",") # array of cached xtypes
+        component_name = params[:name].underscore.to_sym
         component = components[component_name] && component_instance(component_name)
 
         if component
@@ -38,15 +53,6 @@ module Netzke
     module ClassMethods
 
       # Defines a nested component.
-      # For example:
-      #
-      #     component :users, :data_class => "GridPanel", :model => "User"
-      #
-      # It can also accept a block (receiving as parameter the eventual definition from super class):
-      #
-      #     component :books do |orig|
-      #       {:data_class => "Book", :title => orig[:title] + ", extended"}
-      #     end
       def component(name, config = {}, &block)
         register_component(name)
         config = config.dup
@@ -69,6 +75,7 @@ module Netzke
         end
       end
 
+      # DEPRECATED in favor of Symbol#component
       # Component's js config used when embedding components as Container's items
       # (see some_composite.rb for an example)
       def js_component(name, config = {})
@@ -91,11 +98,13 @@ module Netzke
     end
 
     module InstanceMethods
+      extend ActiveSupport::Memoizable
 
-      def items
+      def items #:nodoc:
         @items_with_normalized_components
       end
 
+      # DEPRECATED in favor of Base.component
       def initial_components
         {}
       end
@@ -105,14 +114,16 @@ module Netzke
         @components ||= self.class.registered_components.inject({}){ |res, name| res.merge(name.to_sym => send(COMPONENT_METHOD_NAME % name)) }
       end
 
-      def non_late_components
+      def eager_loaded_components
         components.reject{|k,v| v[:lazy_loading]}
       end
 
+      # DEPRECATED
       def add_component(aggr)
         components.merge!(aggr)
       end
 
+      # DEPRECATED
       def remove_component(aggr)
         if config[:persistent_config]
           persistence_manager_class.delete_all_for_component("#{global_id}__#{aggr}")
@@ -120,51 +131,41 @@ module Netzke
         components[aggr] = nil
       end
 
-      # The difference between components and late components is the following: the former gets instantiated together with its composite and is normally *instantly* visible as a part of it (for example, the component in the initially expanded panel in an Accordion). A late component doesn't get instantiated along with its composite. Until it gets requested from the server, it doesn't take any part in its composite's life. An example of late component could be a component that is loaded dynamically into a previously collapsed panel of an Accordion, or a preferences window (late component) for a component (composite) that only gets shown when user wants to edit component's preferences.
-      def initial_late_components
-        {}
-      end
-
-      def add_late_component(aggr)
-        components.merge!(aggr.merge(:lazy_loading => true))
-      end
-
-      # called when the method_missing tries to processes a non-existing component
+      # Called when the method_missing tries to processes a non-existing component
       def component_missing(aggr)
         flash :error => "Unknown component #{aggr} for component #{name}"
         {:feedback => @flash}.to_nifty_json
       end
 
-      # recursively instantiates an component based on its "path": e.g. if we have an component :aggr1 which in its turn has an component :aggr10, the path to the latter would be "aggr1__aggr10"
+      # Recursively instantiates a component based on its "path": e.g. if we have component :component1 which in its turn has component :component2, the path to the latter would be "component1__component2"
       def component_instance(name, strong_config = {})
-        @cached_component_instances ||= {}
-        @cached_component_instances[name] ||= begin
-          composite = self
-          name.to_s.split('__').each do |aggr|
-            aggr = aggr.to_sym
-            component_config = composite.components[aggr]
-            raise ArgumentError, "No component '#{aggr}' defined for component '#{composite.global_id}'" if component_config.nil?
-            short_component_class_name = component_config[:class_name]
-            raise ArgumentError, "No class_name specified for component #{aggr} of #{composite.global_id}" if short_component_class_name.nil?
-            component_class = constantize_class_name(short_component_class_name)
-
-            conf = weak_children_config.
-              deep_merge(component_config).
-              deep_merge(strong_config). # we may want to reconfigure the component at the moment of instantiation
-              merge(:name => aggr)
-
-            composite = component_class.new(conf, composite) # params: config, parent
-            # composite.weak_children_config = weak_children_config
-            # composite.strong_children_config = strong_children_config
-          end
-          composite
+        composite = self
+        name.to_s.split('__').each do |cmp|
+          cmp = cmp.to_sym
+
+          component_config = composite.components[cmp]
+          raise ArgumentError, "No child component '#{cmp}' defined for component '#{composite.global_id}'" if component_config.nil?
+
+          component_class_name = component_config[:class_name]
+          raise ArgumentError, "No class_name specified for component #{cmp} of #{composite.global_id}" if component_class_name.nil?
+
+          component_class = constantize_class_name(component_class_name)
+          raise ArgumentError, "Unknown constant #{component_class_name}" if component_class.nil?
+
+          instance_config = weak_children_config.merge(component_config).merge(strong_config).merge(:name => cmp)
+
+          composite = component_class.new(instance_config, composite) # params: config, parent
         end
+        composite
       end
 
+      memoize :component_instance # for performance
+
+      # All components that we depend on (used to render all necessary JavaScript and stylesheets)
       def dependency_classes
         res = []
 
-        non_late_components.keys.each do |aggr|
+        eager_loaded_components.keys.each do |aggr|
           res += component_instance(aggr).dependency_classes
         end
 
@@ -174,19 +175,7 @@ module Netzke
         res.uniq
       end
 
-      ## Dependencies
-      # def dependencies
-      #   @dependencies ||= begin
-      #     non_late_components_component_classes = non_late_components.values.map{|v| v[:class_name]}
-      #     (initial_dependencies + non_late_components_component_classes << self.class.short_component_class_name).uniq
-      #   end
-      # end
-
-      # override this method if you need some extra dependencies, which are not the components
-      def initial_dependencies
-        []
-      end
-
+      # DEPRECATED
       def js_component(*args)
         self.class.js_component(*args)
       end
@@ -233,9 +222,9 @@ module Netzke
         end
       end
 
-      private
+      protected
 
-        def normalize_components(items)
+        def normalize_components(items) #:nodoc:
           @component_index ||= 0
           @items_with_normalized_components = items.each_with_index.map do |item, i|
             if is_component_config?(item)
@@ -251,11 +240,11 @@ module Netzke
           end
         end
 
-        def normalize_components_in_items
+        def normalize_components_in_items #:nodoc:
           normalize_components(config[:items]) if config[:items]
         end
 
-        def is_component_config?(c)
+        def is_component_config?(c) #:nodoc:
           !!(c.is_a?(Hash) && c[:class_name])
         end
     end

data/lib/netzke/configuration.rb

@@ -60,6 +60,10 @@ module Netzke
         @strong_config ||= session_config.merge(weak_final_options).merge(strong_parent_config)
       end
 
+      def configuration
+        final_config
+      end
+
       # Resulting config that takes into account all possible ways to configure a component. *Read only*.
       # Translates into something like this:
       #
@@ -72,7 +76,7 @@ module Netzke
       # Moved out to a separate method in order to provide for easy caching.
       # *Do not override this method*, use +Base.config+ instead.
       def config
-        @config ||= final_config
+        @config ||= configuration
       end
 
       def flat_config(key = nil)
@@ -131,4 +135,4 @@ module Netzke
 
     end
   end
-end
+end

data/lib/netzke/core/version.rb

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

data/lib/netzke/core.rb

@@ -15,41 +15,48 @@ module Netzke
   # The following configuration options are available:
   # * ext_location - absolute path to your Ext code root
   # * icons_uri - relative URI to the icons
-  # * javascript_on_main_page (true/false, defaults to false) - if you want the JS classes to be inserted into the code of the page,
-  # rather than into netzke.js (setting to true can be handy for debugging)
   module Core
     extend Session
     extend Masquerading
 
+    # Ext or Touch
+    mattr_accessor :platform
+    @@platform = :ext
+
     # set in Netzke::ControllerExtensions
     mattr_accessor :controller
-    
+
     # set in Netzke::ControllerExtensions
     mattr_accessor :session
     @@session = {}
 
-    mattr_accessor :javascripts
-    @@javascripts = ["#{File.dirname(__FILE__)}/../../javascripts/core.js"]
+    mattr_accessor :ext_javascripts
+    @@ext_javascripts = []
+
+    mattr_accessor :ext_stylesheets
+    @@ext_stylesheets = []
 
-    mattr_accessor :stylesheets
-    @@stylesheets = ["#{File.dirname(__FILE__)}/../../stylesheets/core.css"]
+    mattr_accessor :touch_javascripts
+    @@touch_javascripts = []
 
-    mattr_accessor :external_css
-    @@external_css = []
+    mattr_accessor :touch_stylesheets
+    @@touch_stylesheets = []
+
+    # Stylesheets that cannot be loaded dynamically along with the rest of the component, e.g. due to that relative paths are used in them
+    mattr_accessor :external_ext_css
+    @@external_ext_css = []
 
     # Set in the Engine after_initialize callback
-    mattr_accessor :ext_location
+    mattr_accessor :ext_location # TODO: rename to ext_path
+    mattr_accessor :touch_location # TODO: rename to touch_path
     mattr_accessor :with_icons
 
     mattr_accessor :icons_uri
     @@icons_uri = "/images/icons"
 
-    mattr_accessor :javascript_on_main_page
-    @@javascript_on_main_page = true
-
     mattr_accessor :persistence_manager
     @@persistence_manager = "NetzkeComponentState"
-    
+
     # Set in the Engine after_initialize callback
     mattr_accessor :persistence_manager_class
 
@@ -61,4 +68,4 @@ module Netzke
       Netzke::Core.session[:netzke_components].try(:clear)
     end
   end
-end
+end

data/lib/netzke/javascript/scopes.rb

@@ -0,0 +1,39 @@
+module Netzke
+  module Javascript
+    module Scopes
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # 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(".")
+        end
+
+        # Top level scope which will be used to scope out Netzke classes
+        def js_default_scope
+          "Netzke.classes"
+        end
+
+        # Scope of this component without default scope
+        # e.g.: GridPanelLib.Components
+        def js_scope
+          js_class_name_to_scope(short_component_class_name)
+        end
+
+        # Returns the scope of this component
+        # e.g. "Netzke.classes.GridPanelLib"
+        def js_full_scope
+          js_scope.empty? ? js_default_scope : [js_default_scope, js_scope].join(".")
+        end
+
+        # Returns the full name of the JavaScript class, including the scopes *and* the common scope, which is
+        # Netzke.classes.
+        # E.g.: "Netzke.classes.Netzke.GridPanelLib.RecordFormWindow"
+        def js_full_class_name
+          [js_full_scope, short_component_class_name.split("::").last].join(".")
+        end
+      end
+    end
+  end
+end