netzke-core 0.6.7 → 0.7.0

data/lib/netzke/core.rb

@@ -23,11 +23,14 @@ module Netzke
     extend Session
     extend Masquerading
 
+    # Use Ext 3 compatibility layer
+    mattr_accessor :ext3_compat_uri
+
     # Configuration specified at the initialization times (set in the Engine in case of Rails)
     mattr_accessor :config
     @@config = {}
 
-    # Ext or Touch
+    # :ext or :touch
     mattr_accessor :platform
     @@platform = :ext
 
@@ -44,12 +47,6 @@ module Netzke
     mattr_accessor :ext_stylesheets
     @@ext_stylesheets = []
 
-    mattr_accessor :touch_javascripts
-    @@touch_javascripts = []
-
-    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 = []
@@ -57,22 +54,35 @@ module Netzke
     mattr_accessor :icons_uri
     @@icons_uri = "/images/icons"
 
+    mattr_accessor :ext_uri
+    @@ext_uri = "/extjs"
+
+    mattr_accessor :ext_path
+
+    mattr_accessor :current_user_method
+    @@current_user_method = :current_user
+
     mattr_accessor :persistence_manager
     @@persistence_manager = "NetzkeComponentState"
 
     # The amount of retries that the direct remoting provider will attempt in case of failure
     mattr_accessor :js_direct_max_retries
-    @@js_direct_max_retries = 0
-
-    # Set in the Engine after_initialize callback
-    mattr_accessor :ext_location # TODO: rename to ext_path
-
-    mattr_accessor :touch_location # TODO: rename to touch_path
+    @@js_direct_max_retries = 2
 
     mattr_accessor :with_icons
 
     mattr_accessor :persistence_manager_class
 
+    # Sencha Touch specific
+    mattr_accessor :touch_javascripts
+    @@touch_javascripts = []
+
+    mattr_accessor :touch_stylesheets
+    @@touch_stylesheets = []
+
+    mattr_accessor :touch_uri
+    @@touch_uri = "/sencha-touch"
+
     def self.setup
       yield self
     end
@@ -80,22 +90,5 @@ module Netzke
     def self.reset_components_in_session
       Netzke::Core.session[:netzke_components].try(:clear)
     end
-
-    def self.ext_js
-      res = initial_dynamic_javascript << "\n"
-
-      include_base_js(res)
-
-      # Ext-specific JavaScript
-      res << File.new(File.expand_path("../../../javascripts/ext.js", __FILE__)).read
-
-      # Pluggable JavaScript (used by other Netzke-powered gems like netzke-basepack)
-      Netzke::Core.ext_javascripts.each do |path|
-        f = File.new(path)
-        res << f.read
-      end
-
-      render :text => defined?(::Rails) && ::Rails.env.production? ? res.strip_js_comments : res
-    end
   end
 end

data/lib/netzke/core_ext/symbol.rb

@@ -12,6 +12,6 @@ class Symbol
   end
 
   def component(config = {})
-    config.merge(:component => self)
+    config.merge(:netzke_component => self)
   end
 end

data/lib/netzke/embedding.rb

@@ -4,7 +4,7 @@ module Netzke
 
     # Instantiating
     def js_component_instance
-      %Q{Netzke.page.#{name.jsonify} = Ext.create(#{js_config.to_nifty_json});}
+      %Q{Netzke.page.#{name.jsonify} = Ext.create("#{self.class.js_alias}", #{js_config.to_nifty_json});}
     end
 
     # Rendering

data/lib/netzke/ext_component.rb

@@ -13,7 +13,7 @@ module Netzke
 
     # Rendering
     def js_component_render
-      %Q{Ext.ComponentMgr.create(#{config.to_nifty_json}).render("ext-#{name.to_s.split('_').join('-')}");}
+      %Q{Ext.ComponentManager.create("#{js_full_class_name}", #{config.to_nifty_json}).render("ext-#{name.to_s.split('_').join('-')}");}
     end
 
     # Container for rendering
@@ -22,4 +22,4 @@ module Netzke
     end
 
   end
-end
+end

data/lib/netzke/javascript.rb

@@ -157,7 +157,9 @@ module Netzke
       #     }
       #
       # Also accepts a string, which will be interpreted as a full path to the file (useful for sharing mixins between classes).
+      # With no parameters, will assume :component_class_name_underscored.
       def js_mixin(*args)
+        args << name.split("::").last.underscore.to_sym if args.empty? # if no args provided, component_class_underscored_name is assumed
         current_mixins = read_clean_inheritable_array(:js_mixins) || []
         callr = caller.first
         args.each{ |a| current_mixins << (a.is_a?(Symbol) ? File.read(expand_js_include_path(a, callr)) : File.read(a))}
@@ -175,6 +177,20 @@ module Netzke
         name.gsub("::", "").downcase
       end
 
+      # Alias prefix. Overridden for plugins.
+      def js_alias_prefix
+        "widget"
+      end
+
+      # Builds this component's alias
+      # E.g.: netzke.basepack.window, netzke.basepack.gridpanel
+      #
+      # MAV from http://stackoverflow.com/questions/5380770/replacing-ext-reg-xtype-in-extjs4
+      # "When you use an xtype in Ext JS 4 it looks for a class with an alias of 'widget.[xtype]'"
+      def js_alias
+        [js_alias_prefix, js_xtype].join(".")
+      end
+
       # Component's JavaScript class declaration.
       # It gets stored in the JS class cache storage (Netzke.classes) at the client side to be reused at the moment of component instantiation.
       def js_class
@@ -184,7 +200,10 @@ module Netzke
 
         res << (extends_netzke_component? ? js_class_declaration_extending_component : js_class_declaration_new_component)
 
-        res << %(Netzke.reg("#{js_xtype}", #{js_full_class_name});)
+        # Store created class xtype in the cache
+        res << %(
+Netzke.cache.push('#{js_xtype}');
+)
 
         res.join("\n")
       end
@@ -232,13 +251,16 @@ module Netzke
         # Generates declaration of the JS class as direct extension of a Ext component
         def js_class_declaration_new_component
           mixins = js_mixins.empty? ? "" : %(#{js_mixins.join(", \n")}, )
-          %(#{js_full_class_name} = function(config){
-            Netzke.aliasMethodChain(this, "initComponent", "netzke");
-            #{js_full_class_name}.superclass.constructor.call(this, config);
-          };
 
-          Ext.extend(#{js_full_class_name}, #{js_base_class}, Netzke.chainApply(Netzke.componentMixin, #{mixins}
-  #{js_extend_properties.to_nifty_json}));)
+          # Resulting JS:
+%(Ext.define('#{js_full_class_name}', Netzke.chainApply({
+  extend: '#{js_base_class}',
+  alias: '#{js_alias}',
+  constructor: function(config) {
+    Netzke.aliasMethodChain(this, "initComponent", "netzke");
+    #{js_full_class_name}.superclass.constructor.call(this, config);
+  }
+}, Netzke.componentMixin,\n#{mixins} #{js_extend_properties.to_nifty_json}));)
         end
 
         # Generates declaration of the JS class as extension of another Netzke component
@@ -247,7 +269,11 @@ module Netzke
 
           mixins = js_mixins.empty? ? "" : %(#{js_mixins.join(", \n")}, )
 
-          %{#{js_full_class_name} = Ext.extend(#{base_class}, Netzke.chainApply(#{mixins}#{js_extend_properties.to_nifty_json}));}
+          # Resulting JS:
+%(Ext.define('#{js_full_class_name}', Netzke.chainApply(#{mixins}#{js_extend_properties.to_nifty_json}, {
+  extend: '#{base_class}',
+  alias: '#{js_alias}'
+}));)
         end
 
         def expand_js_include_path(sym, callr) # :nodoc:
@@ -261,51 +287,56 @@ module Netzke
     end
 
     module InstanceMethods
-      # The result of this method (a hash) is converted to a JSON object and passed as the configuration parameter
+      # The result of this method (a hash) is converted to a JSON object and passed as options
       # to the constructor of our JavaScript class. Override it when you want to pass any extra configuration
       # to the JavaScript side.
       def js_config
-        res = {}
+        {}.tap do |res|
+          # Unique id of the component
+          res[:id] = global_id
+
+          # Non-lazy-loaded components
+          comp_hash = {}
+          eager_loaded_components.each_pair do |comp_name, comp_config|
+            comp_instance = component_instance(comp_name.to_sym)
+            comp_instance.before_load
+            comp_hash[comp_name] = comp_instance.js_config
+          end
 
-        # Unique id of the component
-        res[:id] = global_id
+          # Configuration for all of our non-lazy-loaded children specified here. We can refer to them in +items+ so they get instantiated by Ext.
+          res[:netzke_components] = comp_hash unless comp_hash.empty?
 
-        # Non-lazy-loaded components
-        comp_hash = {}
-        eager_loaded_components.each_pair do |comp_name, comp_config|
-          comp_instance = component_instance(comp_name.to_sym)
-          comp_instance.before_load
-          comp_hash[comp_name] = comp_instance.js_config
-        end
+          # Endpoints (besides the default "deliver_component" - JavaScript side already knows about it)
+          endpoints = self.class.endpoints.keys - [:deliver_component]
+          res[:endpoints] = endpoints unless endpoints.empty?
 
-        # All our non-lazy-loaded children are specified here, while in +items+ we barely reference them, because
-        # +items+, generally, only contain a subset of all non-lazy-loaded children.
-        res[:components] = comp_hash unless comp_hash.empty?
+          # Inform the JavaScript side if persistent_config is enabled
+          # res[:persistent_config] = persistence_enabled?
 
-        # Endpoints (besides the default "deliver_component" - JavaScript side already knows about it)
-        endpoints = self.class.endpoints.keys - [:deliver_component]
-        res[:endpoints] = endpoints unless endpoints.empty?
+          # Include our xtype
+          res[:xtype] = self.class.js_xtype
 
-        # Inform the JavaScript side if persistent_config is enabled
-        # res[:persistent_config] = persistence_enabled?
+          # Include our alias: Ext.createByAlias may be used to instantiate the component.
+          res[:alias] = self.class.js_alias
 
-        # Include our xtype
-        res[:xtype] = self.class.js_xtype
+          # Merge with the rest of config options, besides those that are only meant for the server side
+          res.merge!(config.reject{ |k,v| self.class.server_side_config_options.include?(k.to_sym) })
 
-        # Merge with the rest of config options, besides those that are only meant for the server side
-        res.merge!(config.reject{ |k,v| self.class.server_side_config_options.include?(k.to_sym) })
+          if config[:ext_config].present?
+            ::ActiveSupport::Deprecation.warn("Using ext_config option is deprecated. All config options must be specified at the same level in the hash.", caller)
+            res.merge!(config[:ext_config])
+          end
 
-        if config[:ext_config].present?
-          ::ActiveSupport::Deprecation.warn("Using ext_config option is deprecated. All config options must be specified at the same level in the hash.", caller)
-          res.merge!(config[:ext_config])
-        end
+          # Items (nested Ext/Netzke components)
+          res[:items] = items unless items.blank?
 
-        # Items (nested Ext/Netzke components)
-        res[:items] = items unless items.blank?
+          # So we can use getComponent(<component_name>) to retrieve a child component
+          res[:item_id] ||= name
 
-        res[:i18n] = js_translate_properties if js_translate_properties.present?
+          res[:i18n] = js_translate_properties if js_translate_properties.present?
 
-        res
+          res[:netzke_plugins] = plugins.map{ |p| p.to_s.camelcase(:lower) } if plugins.present?
+        end
       end
 
       # All the JS-code required by this instance of the component to be instantiated in the browser.

data/lib/netzke/plugin.rb

@@ -0,0 +1,15 @@
+module Netzke
+  class Plugin < Base
+    js_base_class "Ext.Component"
+
+    def self.js_alias_prefix
+      "plugin"
+    end
+
+    js_method :init, <<-JS
+      function(cmp){
+        this.cmp = cmp;
+      }
+    JS
+  end
+end

data/lib/netzke/plugins.rb

@@ -0,0 +1,29 @@
+module Netzke
+  module Plugins
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Defines a plugin
+      def plugin(name, config = {}, &block)
+        component(name, config, &block)
+        register_plugin(name)
+      end
+
+      # Register a plugin
+      def register_plugin(name)
+        current_plugins = read_inheritable_attribute(:plugins) || []
+        current_plugins << name
+        write_inheritable_attribute(:plugins, current_plugins.uniq)
+      end
+
+      # Returns registered plugins
+      def registered_plugins
+        read_inheritable_attribute(:plugins) || []
+      end
+    end
+
+    def plugins
+      self.class.registered_plugins
+    end
+  end
+end

data/lib/netzke/railz/action_view_ext/ext.rb

@@ -8,10 +8,7 @@ module Netzke
 
           def netzke_ext_css_include(params)
             # ExtJS base
-            res = ["/extjs/resources/css/ext-all"]
-
-            # ExtJS theming
-            res << "/extjs/resources/css/xtheme-#{params[:theme]}" if params[:theme]
+            res = ["#{Netzke::Core.ext_uri}/resources/css/ext-all"]
 
             # Netzke-related dynamic css
             res << "/netzke/ext"
@@ -22,19 +19,20 @@ module Netzke
           end
 
           def netzke_ext_js_include(params)
-            # ExtJS stuff
-            res = if ENV['RAILS_ENV'] == 'development'
-              [
-                "/extjs/adapter/ext/ext-base-debug",
-                "/extjs/ext-all-debug"
-              ]
-            else
-              [
-                "/extjs/adapter/ext/ext-base",
-                "/extjs/ext-all"
-              ]
+            res = []
+
+            # ExtJS
+            res << (ENV['RAILS_ENV'] == 'development' ? ["#{Netzke::Core.ext_uri}/ext-all-debug"] : ["#{Netzke::Core.ext_uri}/ext-all"])
+
+            # ExtJS 3 compatibility layer
+            if compat_uri = Netzke::Core.ext3_compat_uri
+              res << "#{compat_uri}/ext3-core-compat"
+              res << "#{compat_uri}/ext3-compat"
             end
 
+            # Ext I18n
+            res << "#{Netzke::Core.ext_uri}/locale/ext-lang-#{I18n.locale}" if I18n.locale != :en
+
             # Netzke-related dynamic JavaScript
             res << "/netzke/ext"
 
@@ -44,7 +42,6 @@ module Netzke
           def netzke_ext_js(params)
             res = []
             res << content_for(:netzke_js_classes)
-            res << "\n"
 
             res << "Ext.onReady(function(){"
             res << content_for(:netzke_on_ready)

data/lib/netzke/railz/action_view_ext/touch.rb

@@ -9,7 +9,7 @@ module Netzke
           def netzke_touch_css_include(params)
             # Note: no themes for now
 
-            res = stylesheet_link_tag("/sencha-touch/resources/css/sencha-touch")
+            res = stylesheet_link_tag("#{Netzke::Core.touch_uri}/resources/css/sencha-touch")
 
             # Netzke-related (dynamically generated by NetzkeController)
             res << "\n" << stylesheet_link_tag("/netzke/touch")
@@ -35,9 +35,9 @@ module Netzke
           def netzke_touch_js_include(params)
             # ExtJS
             res = if ENV['RAILS_ENV'] == 'development'
-              ["/sencha-touch/sencha-touch-debug.js"]
+              ["#{Netzke::Core.touch_uri}/sencha-touch-debug.js"]
             else
-              ["/sencha-touch/sencha-touch"]
+              ["#{Netzke::Core.touch_uri}/sencha-touch"]
             end
 
             # Netzke

data/lib/netzke/railz/action_view_ext.rb

@@ -22,9 +22,6 @@ module Netzke
         Netzke::Core.platform = params[:platform] || :ext
         theme = params[:theme] || params[:ext_theme]
 
-        # Rails' forgery protection
-        content_for :netzke_js_classes, %Q(\n\nExt.Ajax.extraParams = {authenticity_token: '#{form_authenticity_token}'};)
-
         raw([netzke_css_include(params), netzke_css(params), netzke_js_include(params), netzke_js(params)].join("\n"))
       end
 

data/lib/netzke/railz/engine.rb

@@ -3,41 +3,46 @@ module Netzke
     class Engine < Rails::Engine
       config.netzke = Netzke::Core::OptionsHash.new
 
-      # before loading initializers and classes (in app/**)
-      config.before_initialize do
-        Netzke::Core.config = config.netzke
-        Netzke::Core.ext_location = Rails.root.join("public", "extjs")
-        Netzke::Core.touch_location = Rails.root.join("public", "sencha-touch")
+      initializer "netzke.core" do |app|
+        app.config.eager_load_paths -= ["#{app.config.root}/app/components"]
+        app.config.autoload_paths += ["#{app.config.root}/app/components"]
+      end
+
+      # before loading initializers
+      config.before_initialize do |app|
+        Netzke::Core.config = config.netzke # passing app-level config to Netzke::Core
         Netzke::Core.persistence_manager_class = Netzke::Core.persistence_manager.constantize rescue nil
       end
 
-      # after loading initializers and classes
+      # after loading initializers
       config.after_initialize do
+        Netzke::Core.ext_path = Rails.root.join('public', Netzke::Core.ext_uri[1..-1])
         Netzke::Core.with_icons = File.exists?("#{::Rails.root}/public#{Netzke::Core.icons_uri}") if Netzke::Core.with_icons.nil?
 
-        dynamic_assets = %w[ext.js ext.css touch.js touch.css]
-
-        if Rails.configuration.cache_classes
-          # Memoize Netzke::Base.constantize_class_name for performance
-          class << Netzke::Base
-            memoize :constantize_class_name
-          end
-
-          # Generate dynamic assets and put them into public/netzke
-          require 'fileutils'
-          FileUtils.mkdir_p(Rails.root.join('public', 'netzke'))
-
-          dynamic_assets.each do |asset|
-            File.open(Rails.root.join('public', 'netzke', asset), 'w') {|f| f.write(Netzke::Core::DynamicAssets.send(asset.sub(".", "_"))) }
-          end
-        else
-          dynamic_assets.each do |asset|
-            file_path = Rails.root.join('public', 'netzke', asset)
-            File.delete(file_path) if File.exists?(file_path)
-          end
-        end
-
+        # Dynamic generation of Netzke js and css.
+        # WIP: the problem with this is that on Heroku, for example, you don't have write access to 'public'.
+        # dynamic_assets = %w[ext.js ext.css touch.js touch.css]
+        #
+        # if Rails.configuration.cache_classes
+        #   # Memoize Netzke::Base.constantize_class_name for performance
+        #   class << Netzke::Base
+        #     memoize :constantize_class_name
+        #   end
+        #
+        #   # Generate dynamic assets and put them into public/netzke
+        #   require 'fileutils'
+        #   FileUtils.mkdir_p(Rails.root.join('public', 'netzke'))
+        #
+        #   dynamic_assets.each do |asset|
+        #     File.open(Rails.root.join('public', 'netzke', asset), 'w') {|f| f.write(Netzke::Core::DynamicAssets.send(asset.sub(".", "_"))) }
+        #   end
+        # else
+        #   dynamic_assets.each do |asset|
+        #     file_path = Rails.root.join('public', 'netzke', asset)
+        #     File.delete(file_path) if File.exists?(file_path)
+        #   end
+        # end
       end
     end
   end
-end
+end

data/lib/netzke/services.rb

@@ -99,4 +99,4 @@ module Netzke
     end
 
   end
-end
+end

data/lib/netzke/state.rb

@@ -71,7 +71,7 @@ module Netzke
 
     # 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 && Netzke::Core.persistence_manager_class.init({
+      Netzke::Core.persistence_manager_class && Netzke::Core.persistence_manager_class.init({
         :component => persistence_key,
         :current_user => Netzke::Core.controller.respond_to?(:current_user) && Netzke::Core.controller.current_user,
         :session => Netzke::Core.session
@@ -80,7 +80,7 @@ module Netzke
 
     # 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 && Netzke::Core.persistence_manager_class.init({
+      Netzke::Core.persistence_manager_class && Netzke::Core.persistence_manager_class.init({
         :current_user => Netzke::Core.controller.respond_to?(:current_user) && Netzke::Core.controller.current_user,
         :session => Netzke::Core.session
       })

data/lib/netzke-core.rb

@@ -2,6 +2,7 @@ $LOAD_PATH << File.dirname(__FILE__)
 
 require 'netzke/core'
 require 'netzke/base'
+require 'netzke/plugin'
 
 module Netzke
   autoload :Core, 'netzke/core'