netzke-core 0.2.4 → 0.2.6

data/CHANGELOG

@@ -1,3 +1,16 @@
+v0.2.6
+FeedackGhost is now capable of displaying multiple flash messages.
+Dependencies slightly refactored.
+An informative exception added to Base#aggregatee_instance.
+JS-level inheritance enabled.
+Work-around for the problem with Ext 2.2.1 in loadWidget.
+Events "<action_id>click" added to the widgets along with the actions.
+aggregatee_missing method added to Netzke::Base - called when a non-existing aggregate of a widget is tried to be invoked
+Code readability improvements.
+
+v0.2.5
+Minor code restructuring.
+
 v0.2.4
 Some minor improvements.
 

data/Manifest

@@ -12,10 +12,11 @@ lib/app/models/netzke_layout.rb
 lib/app/models/netzke_preference.rb
 lib/netzke/action_view_ext.rb
 lib/netzke/base.rb
+lib/netzke/base_extras/interface.rb
+lib/netzke/base_extras/js_builder.rb
 lib/netzke/controller_extensions.rb
 lib/netzke/core_ext.rb
 lib/netzke/feedback_ghost.rb
-lib/netzke/js_class_builder.rb
 lib/netzke/routing.rb
 lib/netzke-core.rb
 lib/vendor/facets/hash/recursive_merge.rb

data/README.mdown

@@ -4,9 +4,10 @@ Create Ext JS + Rails reusable components (widgets) with minimum effort.
 Note that if you would like to modify this code or experiment with it, you may be better off cloning this project into your app's vendor/plugin directory - it will then behave as a Rails plugin.
 
 # Example
+See the introduction to the Netzke framework at http://github.com/skozlov/netzke/tree/master
 
-See the tutorials on http://blog.writelesscode.com
+The tutorials: http://blog.writelesscode.com
 
-Also see the netzke-basepack project.
+Also see the netzke-basepack project: http://github.com/skozlov/netzke-basepack/tree/master
 
 Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license

data/javascripts/core.js

@@ -1,7 +1,6 @@
 Ext.BLANK_IMAGE_URL = "/extjs/resources/images/default/s.gif";
-Ext.componentCache = {};
-
 Ext.namespace('Ext.netzke');
+Ext.netzke.cache = {};
 
 // to comply with Rails' forgery protection
 Ext.Ajax.extraParams = {
@@ -48,18 +47,24 @@ Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
 
 // Methods common to all widget classes
 Ext.widgetMixIn = {
-  widgetInit:function(config){
-    this.app = Ext.getCmp('feedback_ghost');
-    // this.app = Ext.getCmp('application');
-    if (config.tools) Ext.each(config.tools, function(i){i.on.click = this[i.on.click].createDelegate(this)}, this);
-    if (config.actions) Ext.each(config.actions, function(i){i.handler = this[i.handler].createDelegate(this);}, this);
+  actionHandler : function(action){
+    if (this.fireEvent(action.handlerName+'click', action)) this[action.handlerName](action);
   },
 
-  setEvents: function(){
+  widgetInit : function(config){
+    this.app = Ext.getCmp('feedback_ghost');
+    if (config.tools) Ext.each(config.tools, function(i){
+      i.on.click = this[i.on.click].createDelegate(this);
+    }, this);
+    if (config.actions) Ext.each(config.actions, function(i){
+      this.addEvents(i.handlerName + 'click');
+      i.handler = this.actionHandler.createDelegate(this);
+    }, this);
+
+    // set events
     this.on('beforedestroy', function(){
       // clean-up menus
       if (this.app && !!this.app.unhostMenus) {
-        // alert('beforedestroy');
         this.app.unhostMenus(this)
       }
     }, this);
@@ -68,7 +73,7 @@ Ext.widgetMixIn = {
   },
 
   feedback:function(msg){
-    if (this.initialConfig.quiet) return false;
+    if (this.initialConfig && this.initialConfig.quiet) return false;
     if (this.app && !!this.app.showFeedback) {
       this.app.showFeedback(msg)
     } else {
@@ -103,32 +108,48 @@ Ext.override(Ext.Panel, {
   loadWidget: function(url, params){
     if (!params) params = {}
     
-    this.remove(this.getWidget()); // first delete previous widget
+    // FIXME: a nasty bug: with autoDestroy set to true, it stops working in Ext 2.2.1!
+    this.remove(this.getWidget(), false); // first delete previous widget 
     
     if (!url) return false; // don't load any widget if the url is null
 
     // we will let the server know which components we have cached
     var cachedComponentNames = [];
-    for (name in Ext.componentCache) {
+    for (name in Ext.netzke.cache) {
       cachedComponentNames.push(name);
     }
     
     this.disable(); // to visually emphasize loading
     
-    Ext.Ajax.request(
-      {url:url, params:Ext.apply(params, {components_cache:Ext.encode(cachedComponentNames)}), script:false, callback:function(panel, success, response){
-        var response = Ext.decode(response.responseText);
-        if (response['classDefinition']) eval(response['classDefinition']); // evaluate widget's class if it was sent
-
-        response.config.parent = this // we might want to know the parent panel in advance (e.g. to know its size)
-        var instance = new Ext.componentCache[response.config.widgetClassName](response.config)
+    Ext.Ajax.request({
+        url:url, 
+        params:Ext.apply(params, {components_cache:Ext.encode(cachedComponentNames)}), 
+        script:false,
+        callback:function(panel, success, response){
+          var responseObj = Ext.decode(response.responseText);
+          if (responseObj.config) {
+            // we got a normal response
+            
+            // evaluate widget's class if it was sent
+            if (responseObj.classDefinition) {
+              eval(responseObj.classDefinition);
+            }
+          
+            responseObj.config.parent = this // we might want to know the parent panel in advance (e.g. to know its size)
+            var instance = new Ext.netzke.cache[responseObj.config.widgetClassName](responseObj.config)
         
-        this.add(instance);
-        this.doLayout();
-        this.enable();
-      }, scope:this}
-    )
-    
+            this.add(instance);
+            this.doLayout();
+          } else {
+            // we didn't get normal response - desplay the flash with eventual errors
+            this.ownerCt.feedback(responseObj.flash)
+          }
+          
+          // reenable the panel
+          this.enable();
+        },
+        scope:this
+    })
   }
 });
 

data/lib/app/models/netzke_layout.rb

@@ -1,6 +1,5 @@
 class NetzkeLayout < ActiveRecord::Base
-  UNRELATED_ATTRS = %w(created_at updated_at position layout_id)
-
+  EXT_UNRELATED_ATTRIBUTES = %w{ id layout_id position created_at updated_at }
   # Multi user support
   def self.user
     @@user ||= nil
@@ -19,7 +18,7 @@ class NetzkeLayout < ActiveRecord::Base
     create(config.merge(:user_id => user_id))
   end
   
-  def layout_items
+  def items
     items_class.constantize.find_all_by_layout_id(id, :order => 'position')
   end
   
@@ -28,13 +27,21 @@ class NetzkeLayout < ActiveRecord::Base
   end
 
   def move_item(old_index, new_index)
-    layout_item = layout_items[old_index]
+    layout_item = items[old_index]
     layout_item.remove_from_list
     layout_item.insert_at(new_index + 1)
   end
 
-  def items_hash
-    layout_items.map(&:attributes).map{|item| item.delete_if{|k,v| UNRELATED_ATTRS.include?(k)}}.map{ |i| i.convert_keys{ |k| k.to_sym } }
+  def items_arry
+    unrelated_attrs_eraser = EXT_UNRELATED_ATTRIBUTES.inject({}){|h,el| h.merge(el => nil)} # => {:id => nil, :layout_id => nil, ...}
+    items.map(&:attributes).map do |i| 
+      # delete unrelated attributes
+      i.merge(unrelated_attrs_eraser).convert_keys {|k| k.to_sym}
+    end
   end
   
+  def items_arry_without_hidden
+    items_arry.reject{|i| i[:hidden] && !i[:name] == :id} # 'id' is exceptional, should always be sent
+  end
+
 end

data/lib/netzke/base.rb

@@ -8,9 +8,6 @@ module Netzke
   # should be aware of this constant.
   #
   class Base
-    # Client-side code (generates JS-class of the widget)
-    include Netzke::JsClassBuilder
-
     module ClassMethods
 
       # Global Netzke::Base configuration
@@ -83,6 +80,17 @@ module Netzke
         nil
       end
       
+      # include eventual extra modules
+      def include_extras(file = __FILE__)
+        extras_dir = File.join(File.dirname(file), short_widget_class_name.underscore + "_extras")
+        file_list = Dir.glob("#{extras_dir}/*.rb")
+        for file_name in file_list
+          require file_name
+          module_name = "#{self.name}Extras::#{File.basename(file_name, ".rb").classify}"
+          include module_name.constantize
+        end
+      end
+      
       private
       def set_default_config(default_config)
         @@config ||= {}
@@ -93,6 +101,9 @@ module Netzke
     end
     extend ClassMethods
     
+    # include extra modules
+    include_extras
+    
     attr_accessor :config, :server_confg, :parent, :logger, :id_name, :permissions
     attr_reader :pref
 
@@ -113,10 +124,19 @@ module Netzke
       Rails.logger
     end
     
+    def dependency_classes
+      res = []
+      non_late_aggregatees.keys.each do |aggr|
+        res += aggregatee_instance(aggr).dependency_classes
+      end
+      res << short_widget_class_name
+      res.uniq
+    end
+    
     # Store some setting in the database as if it was a hash, e.g.:
     #     persistent_config["window.size"] = 100
     #     persistent_config["window.size"] => 100
-    # This method is current_user-aware
+    # This method is user-aware
     def persistent_config
       config_klass = self.class.persistent_config_manager_class
       config_klass && config_klass.widget_name = id_name # pass to the config class our unique name
@@ -178,9 +198,9 @@ module Netzke
       aggregator = self
       name.to_s.split('__').each do |aggr|
         aggr = aggr.to_sym
-        # TODO: should we put all the classes under Netzke::-scope?
-        # widget_class = full_widget_class_name(aggregator.aggregatees[aggr][:widget_class_name]).constantize
-        widget_class = "Netzke::#{aggregator.aggregatees[aggr][:widget_class_name]}".constantize
+        short_class_name = aggregator.aggregatees[aggr][:widget_class_name]
+        raise ArgumentError, "No widget_class_name specified for aggregatee #{aggr} of #{aggregator.config[:name]}" if short_class_name.nil?
+        widget_class = "Netzke::#{short_class_name}".constantize
         aggregator = widget_class.new(aggregator.aggregatees[aggr].merge(:name => aggr), aggregator)
       end
       aggregator
@@ -225,28 +245,30 @@ module Netzke
       end
     end
 
-    ## method dispatcher - sends method to the proper aggregatee
+    # method dispatcher - sends method to the proper aggregatee
     def method_missing(method_name, params = {})
       widget, *action = method_name.to_s.split('__')
       widget = widget.to_sym
       action = !action.empty? && action.join("__").to_sym
       
-      if action && aggregatees[widget]
-        # only actions starting with "interface_" are accessible
-        interface_action = action.to_s.index('__') ? action : "interface_#{action}"
-        aggregatee_instance(widget).send(interface_action, params)
+      if action
+        if aggregatees[widget]
+          # only actions starting with "interface_" are accessible
+          interface_action = action.to_s.index('__') ? action : "interface_#{action}"
+          aggregatee_instance(widget).send(interface_action, params)
+        else
+          aggregatee_missing(widget)
+        end
       else
         super
       end
     end
 
-    #### Interface
-    def get_widget(params = {})
-      # if browser does not have our component class cached (and all dependencies), send it to him
-      components_cache = (JSON.parse(params[:components_cache]) if params[:components_cache]) || []
-      
-      {:config => js_config, :class_definition => js_missing_code(components_cache)}
+    # called when the method_missing tries to processes a non-existing aggregatee
+    def aggregatee_missing(aggr)
+      flash :error => "Unknown aggregatee #{aggr} for widget #{config[:name]}"
+      {:success => false, :flash => @flash}.to_json
     end
-   
+
   end
 end

data/lib/netzke/base_extras/interface.rb

@@ -0,0 +1,11 @@
+module Netzke
+  module BaseExtras
+    module Interface
+      def get_widget(params = {})
+        # if browser does not have our component class cached (and all dependencies), send it to him
+        components_cache = (JSON.parse(params[:components_cache]) if params[:components_cache]) || []
+        {:config => js_config, :class_definition => js_missing_code(components_cache)}
+      end
+    end
+  end
+end

data/lib/netzke/base_extras/js_builder.rb

@@ -0,0 +1,197 @@
+module Netzke
+  module BaseExtras
+    # 
+    # Module which provides JS-class generation functionality for the widgets ("client-side"). This code is executed only once per widget class, and the results are cached at the server (unless widget specifies config[:no_caching] => true).
+    # Included into Netzke::Base class
+    # Most of the methods below are meant to be overwritten by a concrete widget class.
+    # 
+    module JsBuilder
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      #
+      # Instance methods
+      #
+
+      # The config that is sent from the server and is used for instantiating a widget
+      def js_config
+        res = {}
+    
+        # recursively include configs of all (non-late) aggregatees, so that the widget can instantiate them
+        aggregatees.each_pair do |aggr_name, aggr_config|
+          next if aggr_config[:late_aggregation]
+          res["#{aggr_name}_config".to_sym] = aggregatee_instance(aggr_name.to_sym).js_config
+        end
+    
+        # interface
+        interface = self.class.interface_points.inject({}){|h,interfacep| h.merge(interfacep => widget_action(interfacep))}
+        res.merge!(:interface => interface)
+    
+        res.merge!(:widget_class_name => short_widget_class_name)
+
+        res.merge!(js_ext_config)
+        res.merge!(:id => @id_name)
+    
+        # include tools and actions
+        res.merge!(:tools   => tools)   if tools
+        res.merge!(:actions => actions) if actions
+        res.merge!(:bbar    => tbar)    if tbar
+        res.merge!(:tbar    => bbar)    if bbar
+
+        # include permissions
+        res.merge!(:permissions => permissions) unless available_permissions.empty?
+      
+        res
+      end
+   
+      def js_ext_config
+        config[:ext_config] || {}
+      end
+    
+      # All the JS-code required by this instance of the widget to be instantiated in the browser.
+      # It includes the JS-class for the widget itself, as well as JS-classes for all widgets' (non-late) aggregatees.
+      def js_missing_code(cached_dependencies = [])
+        dependency_classes.inject("") do |r,k| 
+          cached_dependencies.include?(k) ? r : r + "Netzke::#{k}".constantize.js_code(cached_dependencies).strip_js_comments
+        end
+      end
+    
+      def dependency_classes
+        res = []
+        non_late_aggregatees.each_key do |aggr|
+          res << aggregatee_instance(aggr).short_widget_class_name
+        end
+        res.uniq
+      end
+    
+      #
+      # The following methods are used when a widget is generated stand-alone (as a part of a HTML page)
+      #
+
+      # instantiating
+      def js_widget_instance
+        %Q{var #{config[:name].to_js} = new Ext.netzke.cache['#{short_widget_class_name}'](#{js_config.to_js});}
+      end
+
+      # rendering
+      def js_widget_render
+        %Q{#{config[:name].to_js}.render("#{config[:name].to_s.split('_').join('-')}");}
+      end
+
+      # container for rendering
+      def js_widget_html
+        %Q{<div id="#{config[:name].to_s.split('_').join('-')}"></div>}
+      end
+
+      #
+      #
+      #
+   
+      # widget's actions, tools and toolbars that are loaded at the moment of instantiating a widget
+      def actions; nil; end
+      def tools; nil; end
+      def tbar; nil; end
+      def bbar; nil; end
+
+      # little helpers
+      def this; "this".l; end
+      def null; "null".l; end
+
+
+      # Methods used to create the javascript class (only once per widget class). 
+      # The generated code gets cached at the browser, and the widget intstances (at the browser side)
+      # get instantiated from it.
+      # All these methods can be overwritten in case you want to extend the functionality of some pre-built widget
+      # instead of using it as is (using both would cause JS-code duplication)
+      module ClassMethods
+        # the JS (Ext) class that we inherit from on JS-level
+        def js_base_class; "Ext.Panel"; end
+
+        # default config that gets merged with Base#js_config
+        def js_default_config
+          {
+            :title     => "config.id.humanize()".l,
+            :listeners => js_listeners,
+            :tools     => "config.tools".l,
+            :actions   => "config.actions".l,
+            :tbar      => "config.tbar".l,
+            :bbar      => "config.bbar".l,
+            # :items   => "config.items".l,
+            # :items   => js_items,
+            :height    => 400,
+            :width     => 800,
+            :border    => false
+          }
+        end
+
+        # functions and properties that will be used to extend the functionality of (Ext) JS-class specified in js_base_class
+        def js_extend_properties; {}; end
+    
+        # code executed before and after the constructor
+        def js_before_constructor; ""; end
+        def js_after_constructor; ""; end
+
+        # widget's listeners
+        def js_listeners; {}; end
+    
+        # widget's menus
+        def js_menus; []; end
+    
+        # items
+        def js_items; null; end
+        
+        # are we using JS inheritance? for now, if js_base_class is a Netzke class - yes
+        def js_inheritance
+          js_base_class.is_a?(Class)
+        end
+
+        # Declaration of widget's class (stored in the cache storage (Ext.netzke.cache) at the client side 
+        # to be reused at the moment of widget instantiation)
+        def js_class
+          if js_inheritance
+<<-JS
+Ext.netzke.cache['#{short_widget_class_name}'] = Ext.extend(Ext.netzke.cache.#{js_base_class.short_widget_class_name}, Ext.chainApply([Ext.widgetMixIn, {
+  constructor: function(config){
+    Ext.netzke.cache['#{short_widget_class_name}'].superclass.constructor.call(this, config);
+  }
+}, #{js_extend_properties.to_js}]))
+
+JS
+          else
+            js_add_menus = "this.addMenus(#{js_menus.to_js});" unless js_menus.empty?
+<<-JS
+Ext.netzke.cache['#{short_widget_class_name}'] = Ext.extend(#{js_base_class}, Ext.chainApply([Ext.widgetMixIn, {
+  constructor: function(config){
+    // comment
+    #{js_before_constructor}
+    Ext.netzke.cache['#{short_widget_class_name}'].superclass.constructor.call(this, Ext.apply(#{js_default_config.to_js}, config));
+    this.widgetInit(config);
+    #{js_after_constructor}
+    #{js_add_menus}
+  }
+}, #{js_extend_properties.to_js}]))
+JS
+          end
+        end
+        
+        # all the JS code needed for this class
+        def js_code(cached_dependencies)
+          res = ""
+
+          # include the dependency if doing JS
+          res << js_base_class.js_class if js_inheritance && !cached_dependencies.include?(js_base_class.short_widget_class_name)
+
+          # our own JS class definition
+          res << js_class
+          res
+        end
+
+        def this; "this".l; end
+        def null; "null".l; end
+      
+      end
+   
+    end
+  end
+end

data/lib/netzke/core_ext.rb

@@ -63,10 +63,14 @@ class String
     self.camelize(:lower)
   end
   
-  # removes JS-comments (both single-line and multiple-line) from the string
+  # removes JS-comments (both single- and multi-line) from the string
   def strip_js_comments
     regexp = /\/\/.*$|(?m:\/\*.*?\*\/)/
-    self.gsub(regexp, '')
+    self.gsub!(regexp, '')
+
+    # also remove empty lines
+    regexp = /^\s*\n/
+    self.gsub!(regexp, '')
   end
 end
 

data/lib/netzke/feedback_ghost.rb

@@ -3,41 +3,41 @@ module Netzke
   # An invisible component that provides feedback service for all Netzke widgets
   #
   class FeedbackGhost < Base
-    class << self
-      def js_base_class
-        "Ext.Component" # yes, invisible
-      end
+    def self.js_base_class
+      "Ext.Component" # yes, invisible
+    end
 
-      def js_extend_properties
-        {
-          :show_feedback => <<-JS.l,
-            function(msg){
-              var createBox = function(s, l){
-                  return ['<div class="msg">',
-                          '<div class="x-box-tl"><div class="x-box-tr"><div class="x-box-tc"></div></div></div>',
-                          '<div class="x-box-ml"><div class="x-box-mr"><div class="x-box-mc">', s, '</div></div></div>',
-                          '<div class="x-box-bl"><div class="x-box-br"><div class="x-box-bc"></div></div></div>',
-                          '</div>'].join('');
-              }
+    def self.js_extend_properties
+      {
+        :show_feedback => <<-JS.l,
+          function(msg){
+            var createBox = function(s, l){
+                return ['<div class="msg">',
+                        '<div class="x-box-tl"><div class="x-box-tr"><div class="x-box-tc"></div></div></div>',
+                        '<div class="x-box-ml"><div class="x-box-mr"><div class="x-box-mc">', s, '</div></div></div>',
+                        '<div class="x-box-bl"><div class="x-box-br"><div class="x-box-bc"></div></div></div>',
+                        '</div>'].join('');
+            }
 
-              var showBox = function(msg, lvl){
-                if (!lvl) lvl = 'notice';
-                var msgCt = Ext.DomHelper.insertFirst(document.body, {'class':'netzke-feedback'}, true);
-                var m = Ext.DomHelper.append(msgCt, {html:createBox(msg,lvl)}, true);
-                m.slideIn('t').pause(2).ghost("b", {remove:true});
-              }
+            var showBox = function(msg, lvl){
+              if (!lvl) lvl = 'notice';
+              var msgCt = Ext.DomHelper.insertFirst(document.body, {'class':'netzke-feedback'}, true);
+              var m = Ext.DomHelper.append(msgCt, {html:createBox(msg,lvl)}, true);
+              m.slideIn('t').pause(2).ghost("b", {remove:true});
+            }
 
-              if (typeof msg != 'string') {
-                Ext.each(msg, function(m){
-                  showBox(m.msg, m.level)
-                })
-              } else {
-                showBox(msg)
-              }
-          	}
-          JS
-        }
-      end
+            if (typeof msg != 'string') {
+              var compoundMsg = "";
+              Ext.each(msg, function(m){
+                compoundMsg += m.msg + '<br>';
+              })
+              if (compoundMsg != "") showBox(compoundMsg, null) // the second parameter will be level
+            } else {
+              showBox(msg)
+            }
+        	}
+        JS
+      }
     end
   end
 end

data/lib/netzke-core.rb

@@ -1,12 +1,12 @@
 # NetzkeCore
-require 'netzke/js_class_builder'
 require 'netzke/base'
-require 'netzke/feedback_ghost'
 require 'netzke/action_view_ext'
 require 'netzke/controller_extensions'
 require 'netzke/core_ext'
 require 'netzke/routing'
 
+require 'netzke/feedback_ghost'
+
 # Vendor
 require 'vendor/facets/hash/recursive_merge'
 

data/netzke-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.2.4"
+  s.version = "0.2.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2009-01-28}
+  s.date = %q{2009-02-12}
   s.description = %q{Build ExtJS/Rails widgets with minimum effort}
   s.email = %q{sergei@writelesscode.com}
-  s.extra_rdoc_files = ["CHANGELOG", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_layout.rb", "lib/app/models/netzke_preference.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/js_class_builder.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "README.mdown", "tasks/netzke_core_tasks.rake"]
-  s.files = ["CHANGELOG", "css/core.css", "generators/netzke_core/netzke_core_generator.rb", "generators/netzke_core/templates/create_netzke_layouts.rb", "generators/netzke_core/templates/create_netzke_preferences.rb", "generators/netzke_core/USAGE", "init.rb", "install.rb", "javascripts/core.js", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_layout.rb", "lib/app/models/netzke_preference.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/js_class_builder.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "Manifest", "netzke-core.gemspec", "Rakefile", "README.mdown", "tasks/netzke_core_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb", "test/app_root/script/console", "test/core_ext_test.rb", "test/netzke_core_test.rb", "test/netzke_preference_test.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.extra_rdoc_files = ["CHANGELOG", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_layout.rb", "lib/app/models/netzke_preference.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/base_extras/interface.rb", "lib/netzke/base_extras/js_builder.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "README.mdown", "tasks/netzke_core_tasks.rake"]
+  s.files = ["CHANGELOG", "css/core.css", "generators/netzke_core/netzke_core_generator.rb", "generators/netzke_core/templates/create_netzke_layouts.rb", "generators/netzke_core/templates/create_netzke_preferences.rb", "generators/netzke_core/USAGE", "init.rb", "install.rb", "javascripts/core.js", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_layout.rb", "lib/app/models/netzke_preference.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/base_extras/interface.rb", "lib/netzke/base_extras/js_builder.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "Manifest", "netzke-core.gemspec", "Rakefile", "README.mdown", "tasks/netzke_core_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb", "test/app_root/script/console", "test/core_ext_test.rb", "test/netzke_core_test.rb", "test/netzke_preference_test.rb", "test/test_helper.rb", "uninstall.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://writelesscode.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netzke-core", "--main", "README.mdown"]

data/test/netzke_core_test.rb

@@ -38,6 +38,12 @@ module Netzke
 
   class DeepNestedWidget < Base
   end
+
+  class JsInheritanceWidget < Base
+    def self.js_base_class
+      Widget
+    end
+  end
 end
 
 # mocking the User class
@@ -129,12 +135,19 @@ class NetzkeCoreTest < ActiveSupport::TestCase
   end
   
   # test "dependencies in JS class generators" do
-  #   js_code = Widget.js_class
-  #   assert(js_code.index("Ext.componentCache['NestedWidgetOne']"))
-  #   assert(js_code.index("Ext.componentCache['NestedWidgetTwo']"))
-  #   assert(js_code.index("Ext.componentCache['DeepNestedWidget']"))
+  #   widget = Widget.new
+  #   assert(widget.js_missing_code.index("Ext.netzke.cache['NestedWidgetOne']"))
+  #   assert(widget.js_missing_code.index("Ext.netzke.cache['NestedWidgetTwo']"))
+  #   assert(widget.js_missing_code.index("Ext.netzke.cache['DeepNestedWidget']"))
+  #   assert(widget.js_missing_code.index("Ext.netzke.cache['Widget']"))
   # end
 
+  test "dependency classes" do
+    widget = Widget.new
+    # not testing the order
+    assert(%w{DeepNestedWidget NestedWidgetOne NestedWidgetTwo Widget}.inject(true){|r, k| r && widget.dependency_classes.include?(k)})
+  end
+
   test "widget instance by config" do
     widget = Netzke::Base.instance_by_config({:widget_class_name => 'Widget', :name => 'a_widget'})
     assert(Widget, widget.class)
@@ -145,6 +158,11 @@ class NetzkeCoreTest < ActiveSupport::TestCase
     assert_equal(NetzkeLayout, Netzke::Base.layout_manager_class)
   end
   
+  test "js inheritance" do
+    widget = JsInheritanceWidget.new
+    assert(widget.js_missing_code.index("Ext.netzke.cache['JsInheritanceWidget']"))
+    assert(widget.js_missing_code.index("Ext.netzke.cache['Widget']"))
+  end
   # test "multiuser" do
   #   Netzke::Base.current_user = User.new(1)
   #   Widget.new(:prohibit => :all, :name => 'widget')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-28 00:00:00 -06:00
+date: 2009-02-12 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -26,10 +26,11 @@ extra_rdoc_files:
 - lib/app/models/netzke_preference.rb
 - lib/netzke/action_view_ext.rb
 - lib/netzke/base.rb
+- lib/netzke/base_extras/interface.rb
+- lib/netzke/base_extras/js_builder.rb
 - lib/netzke/controller_extensions.rb
 - lib/netzke/core_ext.rb
 - lib/netzke/feedback_ghost.rb
-- lib/netzke/js_class_builder.rb
 - lib/netzke/routing.rb
 - lib/netzke-core.rb
 - lib/vendor/facets/hash/recursive_merge.rb
@@ -51,10 +52,11 @@ files:
 - lib/app/models/netzke_preference.rb
 - lib/netzke/action_view_ext.rb
 - lib/netzke/base.rb
+- lib/netzke/base_extras/interface.rb
+- lib/netzke/base_extras/js_builder.rb
 - lib/netzke/controller_extensions.rb
 - lib/netzke/core_ext.rb
 - lib/netzke/feedback_ghost.rb
-- lib/netzke/js_class_builder.rb
 - lib/netzke/routing.rb
 - lib/netzke-core.rb
 - lib/vendor/facets/hash/recursive_merge.rb

data/lib/netzke/js_class_builder.rb

@@ -1,174 +0,0 @@
-module Netzke
-  # 
-  # Module which provides JS-class generation functionality for the widgets ("client-side"). This code is executed only once per widget class, and the results are cached at the server (unless widget specifies config[:no_caching] => true).
-  # Included into Netzke::Base class
-  # Most of the methods below are meant to be overwritten by a concrete widget class.
-  # 
-  module JsClassBuilder
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
-    #
-    # Instance methods
-    #
-
-    # The config that is sent from the server and is used for instantiating a widget
-    def js_config
-      res = {}
-    
-      # recursively include configs of all (non-late) aggregatees, so that the widget can instantiate them
-      aggregatees.each_pair do |aggr_name, aggr_config|
-        next if aggr_config[:late_aggregation]
-        res["#{aggr_name}_config".to_sym] = aggregatee_instance(aggr_name.to_sym).js_config
-      end
-    
-      # interface
-      interface = self.class.interface_points.inject({}){|h,interfacep| h.merge(interfacep => widget_action(interfacep))}
-      res.merge!(:interface => interface)
-    
-      res.merge!(:widget_class_name => short_widget_class_name)
-
-      res.merge!(js_ext_config)
-      res.merge!(:id => @id_name)
-    
-      # include tools and actions
-      res.merge!(:tools   => tools)   if tools
-      res.merge!(:actions => actions) if actions
-      res.merge!(:bbar    => tbar)    if tbar
-      res.merge!(:tbar    => bbar)    if bbar
-
-      # include permissions
-      res.merge!(:permissions => permissions) unless available_permissions.empty?
-      
-      res
-    end
-   
-    def js_ext_config
-      config[:ext_config] || {}
-    end
-    
-    #
-    # The following methods are used when a widget is generated stand-alone (as a part of a HTML page)
-    #
-
-    # instantiating
-    def js_widget_instance
-      %Q{var #{config[:name].to_js} = new Ext.componentCache['#{short_widget_class_name}'](#{js_config.to_js});}
-    end
-
-    # rendering
-    def js_widget_render
-      %Q{#{config[:name].to_js}.render("#{config[:name].to_s.split('_').join('-')}");}
-    end
-
-    # container for rendering
-    def js_widget_html
-      %Q{<div id="#{config[:name].to_s.split('_').join('-')}"></div>}
-    end
-
-    #
-    #
-    #
-
-    # All the JS-code required by this *instance* of the widget. It includes the JS-class for the widget
-    # itself, as well as JS-classes for all widgets (non-late) aggregatees.
-    def js_missing_code(cached_dependencies = [])
-      result = ""
-      dependencies.each do |dep_name|
-        unless cached_dependencies.include?(dep_name)
-          dependency_class = "Netzke::#{dep_name}".constantize
-          result << dependency_class.js_class
-        end
-      end
-      result
-    end
-   
-    # widget's actions, tools and toolbars that are loaded at the moment of instantiating a widget
-    def actions; nil; end
-    def tools; nil; end
-    def tbar; nil; end
-    def bbar; nil; end
-
-    # little helpers
-    def this; "this".l; end
-    def null; "null".l; end
-
-
-    # Methods used to create the javascript class (only once per widget class). 
-    # The generated code gets cached at the browser, and the widget intstances (at the browser side)
-    # get instantiated from it.
-    # All these methods can be overwritten in case you want to extend the functionality of some pre-built widget
-    # instead of using it as is (using both would cause JS-code duplication)
-    module ClassMethods
-      # the JS (Ext) class that we inherit from on JS-level
-      def js_base_class; "Ext.Panel"; end
-
-      # functions and properties that will be used to extend the functionality of (Ext) JS-class specified in js_base_class
-      def js_extend_properties; {}; end
-    
-      # code executed before and after the constructor
-      def js_before_constructor; ""; end
-      def js_after_constructor; ""; end
-
-      # widget's listeners
-      def js_listeners; {}; end
-    
-      # widget's menus
-      def js_menus; []; end
-    
-      # items
-      def js_items; null; end
-
-      # default config that is always passed into the constructor
-      def js_default_config
-        {
-          :title     => "config.id.humanize()".l,
-          :listeners => js_listeners,
-          :tools     => "config.tools".l,
-          :actions   => "config.actions".l,
-          :tbar      => "config.tbar".l,
-          :bbar      => "config.bbar".l,
-          # :items   => "config.items".l,
-          # :items   => js_items,
-          :height    => 400,
-          :width     => 800,
-          :border    => false
-        }
-      end
-
-      # Declaration of widget's class (stored in the cache storage (Ext.componentCache) at the client side 
-      # to be reused at the moment of widget instantiation)
-      def js_class
-        <<-JS
-        Ext.componentCache['#{short_widget_class_name}'] = Ext.extend(#{js_base_class}, Ext.chainApply([Ext.widgetMixIn, {
-          constructor: function(config){
-            this.widgetInit(config);
-            #{js_before_constructor}
-            Ext.componentCache['#{short_widget_class_name}'].superclass.constructor.call(this, Ext.apply(#{js_default_config.to_js}, config));
-            #{js_after_constructor}
-            this.setEvents();
-            this.addMenus(#{js_menus.to_js});
-          }
-        }, #{js_extend_properties.to_js}]))
-        JS
-      end
-
-      # class definition of the widget plus that of all the dependencies, minus those that are specified as cached_dependencies
-      def js_missing_code(cached_dependencies = [])
-        result = ""
-        dependencies.each do |dep_name|
-          dependency_class = "Netzke::#{dep_name}".constantize
-          result << dependency_class.js_class_code(cached_dependencies)
-        end
-        result << js_class.strip_js_comments unless cached_dependencies.include?(short_widget_class_name) && !config[:no_caching]
-        result
-      end
-      
-      def this; "this".l; end
-      def null; "null".l; end
-      
-    end
-   
-  end
-end