netzke-core 0.2.8 → 0.2.9

data/CHANGELOG

@@ -1,3 +1,10 @@
+v0.2.9
+Actions, toolbars and tools reworked for easier configuration.
+Menus introduced (based on actions).
+Significant code clean-up.
+Bug fix (nasty one): Ext.widgetMixIn was getting messed up along with dynamic widget loading.
+Must work in IE now.
+
 v0.2.8
 Support for extra javascripts and stylesheets per widget.
 

data/Manifest

@@ -1,5 +1,4 @@
 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
@@ -25,6 +24,7 @@ Manifest
 netzke-core.gemspec
 Rakefile
 README.mdown
+stylesheets/core.css
 tasks/netzke_core_tasks.rake
 test/app_root/app/controllers/application.rb
 test/app_root/config/boot.rb
@@ -42,4 +42,5 @@ test/core_ext_test.rb
 test/netzke_core_test.rb
 test/netzke_preference_test.rb
 test/test_helper.rb
+TODO
 uninstall.rb

data/README.mdown

@@ -10,4 +10,4 @@ The tutorials: http://blog.writelesscode.com
 
 Also see the netzke-basepack project: http://github.com/skozlov/netzke-basepack/tree/master
 
-Copyright (c) 2008-2009 Sergei Kozlov, released under GNU GPL license v3
+Copyright (c) 2008-2009 Sergei Kozlov, released under LGPL 3.0

data/TODO

@@ -0,0 +1 @@
+* Re-factor JS-level inheritance mechanisms

data/javascripts/core.js

@@ -1,8 +1,12 @@
+/*
+This file gets loaded along with the rest of Ext library at the initial load
+*/
+
 Ext.BLANK_IMAGE_URL = "/extjs/resources/images/default/s.gif";
 Ext.namespace('Ext.netzke');
 Ext.netzke.cache = {};
 
-Ext.QuickTips.init(); // seems obligatory in Ext v2.2.1, otherwise destroy() stops working properly
+Ext.QuickTips.init(); // seems obligatory in Ext v2.2.1, otherwise Ext.Component#destroy() stops working properly
 
 // to comply with Rails' forgery protection
 Ext.Ajax.extraParams = {
@@ -16,7 +20,50 @@ Ext.chainApply = function(objectArray){
   return res;
 };
 
-// implementation of totalProperty, successProperty and root configuration options for ArrayReader
+// Type detection functions
+function isArray(o) {
+  return (o != null && typeof o == "object" && o.constructor.toString() == Array.toString());
+}
+
+function isObject(o) {
+  return (o != null && typeof o == "object" && o.constructor.toString() == Object.toString());
+}
+
+// Some Rubyish String extensions
+// from http://code.google.com/p/inflection-js/
+String.prototype.camelize=function(lowFirstLetter)
+{
+  var str=this.toLowerCase();
+  var str_path=str.split('/');
+  for(var i=0;i<str_path.length;i++)
+  {
+    var str_arr=str_path[i].split('_');
+    var initX=((lowFirstLetter&&i+1==str_path.length)?(1):(0));
+    for(var x=initX;x<str_arr.length;x++)
+      str_arr[x]=str_arr[x].charAt(0).toUpperCase()+str_arr[x].substring(1);
+    str_path[i]=str_arr.join('');
+  }
+  str=str_path.join('::');
+  return str;
+};
+
+String.prototype.capitalize=function()
+{
+  var str=this.toLowerCase();
+  str=str.substring(0,1).toUpperCase()+str.substring(1);
+  return str;
+};
+
+String.prototype.humanize=function(lowFirstLetter)
+{
+  var str=this.toLowerCase();
+  str=str.replace(new RegExp('_id','g'),'');
+  str=str.replace(new RegExp('_','g'),' ');
+  if(!lowFirstLetter)str=str.capitalize();
+  return str;
+};
+
+// Implementation of totalProperty, successProperty and root configuration options for ArrayReader
 Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
   readRecords : function(o){
     var sid = this.meta ? this.meta.id : null;
@@ -49,68 +96,151 @@ Ext.data.ArrayReader = Ext.extend(Ext.data.JsonReader, {
 
 // Methods common to all widget classes
 Ext.widgetMixIn = {
+  // Common handler for actions
   actionHandler : function(action){
-    if (this.fireEvent(action.handlerName+'click', action)) this[action.handlerName](action);
+    // If firing corresponding event doesn't return false, call the handler
+    if (this.fireEvent(action.name+'click', action)) {
+      this[(action.fn || action.name)](action);
+    }
   },
 
-  widgetInit : function(config){
-    this.app = Ext.getCmp('feedback_ghost');
+  // Common handler for tools
+  toolActionHandler : function(tool){
+    // If firing corresponding event doesn't return false, call the handler
+    if (this.fireEvent(tool.id+'click')) {
+      this[tool]();
+    }
+  },
 
-    if (config.tools) Ext.each(config.tools, function(i){
-      i.on.click = this[i.on.click].createDelegate(this);
-    }, this);
+  beforeConstructor : function(config){
+    this.actions = {};
 
-    if (config.actions) Ext.each(config.actions, function(i){
-      this.addEvents(i.handlerName + 'click');
-      i.handler = this.actionHandler.createDelegate(this);
-    }, this);
+    // Create Ext.Actions based on config.actions
+    if (config.actions) {
+      for (var name in config.actions) {
+        // Create an event for each action (so that higher-level widgets could interfere)
+        this.addEvents(name+'click');
 
-    if (config.menu) Ext.each(config.menu, function(i){
-      this.addMenuItem(i)
-    }, this);
+        // Configure the action
+        var actionConfig = config.actions[name];
+        actionConfig.handler = this.actionHandler.createDelegate(this);
+        actionConfig.name = name;
+        this.actions[name] = new Ext.Action(actionConfig);
+      }
 
-    // set events
-    this.on('beforedestroy', function(){
-      // clean-up menus
-      if (this.app && !!this.app.unhostMenus) {
-        this.app.unhostMenus(this)
+      /* Parse the bbar and tbar (both Arrays), replacing the strings with the corresponding methods. For example:
+        replaceStringsWithActions( ['add', {text:'Menu', menu:['edit', 'delete']}] )
+        => [scope.actions['add'], {text:'Menu', menu:[scope.actions['edit'], scope.actions['delete']]}]
+      */
+      var replaceStringsWithActions = function(arry, scope){
+        var res = []; // new array
+        Ext.each(arry, function(o){
+          if (typeof o === "string") {
+            var camelized = o.camelize(true);
+            if (scope.actions[camelized]){
+              res.push(scope.actions[camelized]);
+            } else {
+              // if there's no action with this name, maybe it's a separator or something
+              res.push(o);
+            }
+          } else if (isObject(o)) {
+            // look inside the objects...
+            for (var key in o) {
+              if (isArray(o[key])) {
+                // ... and recursively process inner arrays found
+                o[key] = replaceStringsWithActions(o[key], scope);
+              }
+            }
+            res.push(o);
+          }
+        });
+        return res;
       }
+      config.bbar = config.bbar && replaceStringsWithActions(config.bbar, this);
+      config.tbar = config.tbar && replaceStringsWithActions(config.tbar, this);
+      config.menu = config.menu && replaceStringsWithActions(config.menu, this);
+      
+    }
+
+    // Normalize tools
+    if (config.tools) {
+      var normTools = [];
+      Ext.each(config.tools, function(tool){
+        // Create an event for each action (so that higher-level widgets could interfere)
+        this.addEvents(tool.id+'click');
+
+        var handler = this.toolActionHandler.createDelegate(this, [tool]);
+        normTools.push({id : tool, handler : handler, scope : this});
+      }, this);
+      config.tools = normTools;
+    }
+    
+  },
+
+  afterConstructor : function(config){
+    this.feedbackGhost = Ext.getCmp('feedback_ghost');
+
+    // cleaning up
+    this.on('beforedestroy', function(){
+      this.cleanUpMenu(this);
     }, this);
     
+    // After render, add the menus
+    this.on('render', function(){
+      if (this.initialConfig.menu) {this.addMenu(this.initialConfig.menu);}
+    }, this);
+
     this.on('render', this.onWidgetLoad, this);
   },
 
   feedback:function(msg){
-    if (this.initialConfig && this.initialConfig.quiet) return false;
-    if (this.app && !!this.app.showFeedback) {
-      this.app.showFeedback(msg)
+    if (this.initialConfig && this.initialConfig.quiet) {
+      return false;
+    }
+    
+    if (this.feedbackGhost) {
+      this.feedbackGhost.showFeedback(msg);
     } else {
       // there's no application to show the feedback - so, we do it ourselves
       if (typeof msg == 'string'){
-        alert(msg)
+        alert(msg);
       } else {
-        var compoundResponse = ""
+        var compoundResponse = "";
         Ext.each(msg, function(m){
           compoundResponse += m.msg + "\n"
-        })
-        if (compoundResponse != "") alert(compoundResponse);
+        });
+        if (compoundResponse != "") {
+          alert(compoundResponse);
+        }
       }
-    };
+    }
   },
 
-  addMenuItem : function(item){
-    if (this.hostMenuItem) { 
-      this.hostMenuItem(item, this); 
+  addMenu : function(menu, owner){
+    if (!owner) {
+      owner = this;
+    }
+    
+    if (!!this.hostMenu) { 
+      this.hostMenu(menu, owner); 
     } else {
-      if (this.ownerCt && this.ownerCt.ownerCt) {
-        this.ownerCt.ownerCt.addMenuItem(item)
+      if (this.parent) {
+        this.parent.addMenu(menu, owner);
       }
     }
   },
-
-  addMenus:function(menus){
-    if (this.app && !!this.app.hostMenu) {
-      Ext.each(menus, function(menu){this.app.hostMenu(menu, this)}, this)
+  
+  cleanUpMenu : function(owner){
+    if (!owner) {
+      owner = this;
+    }
+    
+    if (!!this.unhostMenu) { 
+      this.unhostMenu(owner); 
+    } else {
+      if (this.parent) {
+        this.parent.cleanUpMenu(owner);
+      }
     }
   },
   
@@ -120,11 +250,13 @@ Ext.widgetMixIn = {
 // Make Panel with layout 'fit' capable to dynamically load widgets
 Ext.override(Ext.Panel, {
   getWidget: function(){
-    return this.items.get(0)
+    return this.items.get(0);
   },
   
   loadWidget: function(url, params){
-    if (!params) params = {}
+    if (!params) {
+      params = {};
+    }
     
     this.remove(this.getWidget()); // first delete previous widget 
     
@@ -149,7 +281,7 @@ Ext.override(Ext.Panel, {
 
             // evaluate widget's stylesheets
             if (responseObj.css){
-              var linkTag = document.createElement('style')
+              var linkTag = document.createElement('style');
               linkTag.type = 'text/css';
               linkTag.innerHTML = responseObj.css;
               document.body.appendChild(linkTag);
@@ -160,14 +292,14 @@ Ext.override(Ext.Panel, {
               eval(responseObj.js);
             }
           
-            responseObj.config.parent = this // we might want to know the parent panel in advance (e.g. to know its size)
+            responseObj.config.parent = this.ownerCt; // 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();
           } else {
             // we didn't get normal response - desplay the flash with eventual errors
-            this.ownerCt.feedback(responseObj.flash)
+            this.ownerCt.feedback(responseObj.flash);
           }
           
           // reenable the panel
@@ -178,20 +310,3 @@ Ext.override(Ext.Panel, {
   }
 });
 
-// Some Rubyish String extensions
-// from http://code.google.com/p/inflection-js/
-String.prototype.capitalize=function()
-{
-  var str=this.toLowerCase();
-  str=str.substring(0,1).toUpperCase()+str.substring(1);
-  return str;
-};
-
-String.prototype.humanize=function(lowFirstLetter)
-{
-  var str=this.toLowerCase();
-  str=str.replace(new RegExp('_id','g'),'');
-  str=str.replace(new RegExp('_','g'),' ');
-  if(!lowFirstLetter)str=str.capitalize();
-  return str;
-};

data/lib/app/controllers/netzke_controller.rb

@@ -14,7 +14,7 @@ class NetzkeController < ActionController::Base
       
       format.css {
         res = ""
-        Netzke::Base.config[:css].each do |path|
+        Netzke::Base.config[:stylesheets].each do |path|
           f = File.new(path)
           res << f.read
         end

data/lib/app/models/netzke_layout.rb

@@ -1,16 +1,9 @@
 class NetzkeLayout < ActiveRecord::Base
   EXT_UNRELATED_ATTRIBUTES = %w{ id layout_id position created_at updated_at }
+
   # Multi user support
-  def self.user
-    @@user ||= nil
-  end
-  
-  def self.user=(user)
-    @@user = user
-  end
-  
   def self.user_id
-    user && user.id
+    Netzke::Base.user && Netzke::Base.user.id
   end
   
   # normal create, but with a user_id merged-in

data/lib/app/models/netzke_preference.rb

@@ -6,19 +6,12 @@
 # etc
 #
 class NetzkePreference < ActiveRecord::Base
-  ELEMENTARY_CONVERTION_METHODS= {'Fixnum' => 'to_i', 'String' => 'to_s', 'Float' => 'to_f', 'Symbol' => 'to_sym'}
-  
-  # Multi user support
-  def self.user
-    @@user ||= nil
-  end
+  named_scope :for_current_user, lambda { {:conditions => {:user_id => user_id}} }
   
-  def self.user=(user)
-    @@user = user
-  end
+  ELEMENTARY_CONVERTION_METHODS= {'Fixnum' => 'to_i', 'String' => 'to_s', 'Float' => 'to_f', 'Symbol' => 'to_sym'}
   
   def self.user_id
-    user && user.id
+    Netzke::Base.user && Netzke::Base.user.id
   end
   
   def self.widget_name=(value)
@@ -54,14 +47,14 @@ class NetzkePreference < ActiveRecord::Base
   end
   
   def self.[](pref_name)
-    pref_name  = pref_name.to_s
+    pref_name  = normalize_preference_name(pref_name)
     conditions = {:name => pref_name, :user_id => user_id, :widget_name => self.widget_name}
     pref       = self.find(:first, :conditions => conditions)
     pref && pref.normalized_value
   end
   
   def self.[]=(pref_name, new_value)
-    pref_name  = pref_name.to_s
+    pref_name  = normalize_preference_name(pref_name)
     conditions = {:name => pref_name, :user_id => user_id, :widget_name => self.widget_name}
     pref       = self.find(:first, :conditions => conditions)
     
@@ -75,4 +68,9 @@ class NetzkePreference < ActiveRecord::Base
     end
   end
   
+  private
+  def self.normalize_preference_name(name)
+    name.to_s.gsub(".", "__").gsub("/", "__")
+  end
+  
 end

data/lib/netzke/base.rb

@@ -1,4 +1,5 @@
-require 'json'
+require 'netzke/base_extras/js_builder'
+require 'netzke/base_extras/interface'
 
 module Netzke
   # 
@@ -8,48 +9,38 @@ module Netzke
   # should be aware of this constant.
   #
   class Base
-    module ClassMethods
-
-      # Used to get access to the location of the source file of a Widget, e.g. to automatically include
-      # <widget_name>_extras/*.rb files
-      def widget_file=(file)
-        write_inheritable_attribute(:widget_file, file)
-      end
-      
-      def widget_file
-        read_inheritable_attribute(:widget_file) || __FILE__
-      end
-      #
-      #
+    
+    # Class-level Netzke::Base configuration. The defaults also get specified here.
+    def self.config
+      set_default_config({
+        # which javascripts and stylesheets must get included at the initial load (see netzke-core.rb)
+        :javascripts               => [],
+        :stylesheets               => [],
+        
+        :layout_manager            => "NetzkeLayout",
+        :persistent_config_manager => "NetzkePreference",
+        
+        :ext_location              => defined?(RAILS_ROOT) && "#{RAILS_ROOT}/public/extjs"
+      })
+    end
 
-      # Global Netzke::Base configuration
-      def config
-        set_default_config({
-          :javascripts               => [],
-          :css                       => [],
-          :layout_manager            => "NetzkeLayout",
-          :persistent_config_manager => "NetzkePreference"
-        })
-      end
+    include Netzke::BaseExtras::JsBuilder
+    include Netzke::BaseExtras::Interface
+    
+    module ClassMethods
 
+      # "Netzke::SomeWidget" => "SomeWidget"
       def short_widget_class_name
-        name.split("::").last
+        self.name.split("::").last
       end
 
+      # Multi-user support
       def user
         @@user ||= nil
       end
 
       def user=(user)
         @@user = user
-
-        # also set up the managers
-        persistent_config_manager_class && persistent_config_manager_class.user = user
-        layout_manager_class && layout_manager_class.user = user
-      end
-
-      def user_has_role?(role)
-        user.login == 'sergei' && role.to_s == 'configurator'
       end
 
       #
@@ -78,32 +69,6 @@ module Netzke
         read_inheritable_attribute(:interface_points)
       end
       
-      #
-      # Include extra code from Ext js library (e.g. examples)
-      #
-      def ext_js_include(*args)
-        included_ext_js = read_inheritable_attribute(:included_ext_js) || []
-        args.each {|f| included_ext_js << f}
-        write_inheritable_attribute(:included_ext_js, included_ext_js)
-      end
-      
-      # def js_include(*args)
-      #   included_js = read_inheritable_attribute(:included_js) || []
-      #   args.each {|f| included_js << f}
-      #   write_inheritable_attribute(:included_js, included_js)
-      # end
-      
-      # include eventual extra modules
-      def include_extras
-        extras_dir = File.join(File.dirname(widget_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
-
       # returns an instance of a widget defined in the config
       def instance_by_config(config)
         widget_class = "Netzke::#{config[:widget_class_name]}".constantize
@@ -123,7 +88,6 @@ module Netzke
         nil
       end
       
-      
       private
       def set_default_config(default_config)
         @@config ||= {}
@@ -134,9 +98,6 @@ module Netzke
     end
     extend ClassMethods
     
-    # include extra modules
-    include_extras
-    
     attr_accessor :config, :server_confg, :parent, :logger, :id_name, :permissions
     attr_reader :pref
 
@@ -171,9 +132,14 @@ module Netzke
     #     persistent_config["window.size"] => 100
     # 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
-      config_klass || {} # if we don't have the presistent config manager, all the calls to it will always return nil, and the "="-operation will be ignored
+      config_klass = config[:persistent_config] && self.class.persistent_config_manager_class
+      if config_klass
+        config_klass.widget_name = id_name # pass to the config class our unique name
+        config_klass
+      else
+        # if we can't use presistent config, all the calls to it will always return nil, and the "="-operation will be ignored
+        {}
+      end
     end
     
     def initial_config
@@ -272,7 +238,11 @@ module Netzke
         
         # ... and then merge it with NetzkePreferences
         available_permissions.each do |p|
-          persistent_permisson = persistent_config["permissions.#{p}"]
+          # if nothing is stored in persistent_config, store the permission from the config; otherwise leave what's there
+          persistent_config["permissions/#{p}"].nil? && persistent_config["permissions/#{p}"] = @permissions[p.to_sym]
+
+          # what's stored in persistent_config has higher priority, so, if there's something there, use that
+          persistent_permisson = persistent_config["permissions/#{p}"]
           @permissions[p.to_sym] = persistent_permisson unless persistent_permisson.nil?
         end
       end
@@ -303,5 +273,30 @@ module Netzke
       {:success => false, :flash => @flash}.to_json
     end
 
+    def tools
+      persistent_config[:tools] ||= config[:tools] == false ? nil : config[:tools]
+    end
+
+    def bbar
+      persistent_config[:bottom_bar] ||= config[:bbar] == false ? nil : config[:bbar]
+    end
+
+    def tbar
+      persistent_config[:top_bar] ||= config[:tbar] == false ? nil : config[:tbar]
+    end
+
+    def menu
+      persistent_config[:menu] ||= config[:menu] == false ? nil : config[:menu]
+    end
+    
+    # some convenience for instances
+    def layout_manager_class
+      self.class.layout_manager_class
+    end
+
+    def persistent_config_manager_class
+      self.class.persistent_config_manager_class
+    end
+
   end
 end

data/lib/netzke/base_extras/interface.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Netzke
   module BaseExtras
     module Interface

data/lib/netzke/base_extras/js_builder.rb

@@ -17,29 +17,35 @@ module Netzke
       # The config that is sent from the server and is used for instantiating a widget
       def js_config
         res = {}
+        
+        # Unique id of the widget
+        res.merge!(:id => @id_name)
     
-        # recursively include configs of all (non-late) aggregatees, so that the widget can instantiate them
+        # Recursively include configs of all non-late aggregatees, so that the widget can instantiate them in
+        # in the browser immediately.
         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
         interface = self.class.interface_points.inject({}){|h,interfacep| h.merge(interfacep => widget_action(interfacep))}
         res.merge!(:interface => interface)
     
+        # Widget class name
         res.merge!(:widget_class_name => short_widget_class_name)
-
+        
+        # Include
         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
+        # Actions, toolbars and menus
+        tools   && res.merge!(:tools   => tools)
+        actions && res.merge!(:actions => actions)
+        tbar    && res.merge!(:tbar    => tbar)
+        bbar    && res.merge!(:bbar    => bbar)
+        menu    && res.merge!(:menu    => menu)
 
-        # include permissions
+        # Permissions
         res.merge!(:permissions => permissions) unless available_permissions.empty?
       
         res
@@ -69,7 +75,7 @@ module Netzke
 
       # instantiating
       def js_widget_instance
-        %Q{var #{config[:name].to_js} = new Ext.netzke.cache['#{short_widget_class_name}'](#{js_config.to_js});}
+        %Q{var #{config[:name].to_js} = new Ext.netzke.cache.#{short_widget_class_name}(#{js_config.to_js});}
       end
 
       # rendering
@@ -88,9 +94,10 @@ module Netzke
    
       # 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
+      def menu; nil; end
+      def tools; nil; end
 
       # little helpers
       def this; "this".l; end
@@ -150,50 +157,97 @@ module Netzke
         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}]))
+Ext.netzke.cache.#{short_widget_class_name} = function(config){
+  Ext.netzke.cache.#{short_widget_class_name}.superclass.constructor.call(this, config);
+};
+Ext.extend(Ext.netzke.cache.#{short_widget_class_name}, Ext.netzke.cache.#{js_base_class.short_widget_class_name}, Ext.applyIf(#{js_extend_properties.to_js}, Ext.widgetMixIn));
 
 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
+Ext.netzke.cache.#{short_widget_class_name} = function(config){
+    this.beforeConstructor(config);
     #{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);
+    Ext.netzke.cache.#{short_widget_class_name}.superclass.constructor.call(this, Ext.apply(#{js_default_config.to_js}, config));
+    this.afterConstructor(config);
     #{js_after_constructor}
     #{js_add_menus}
-  }
-}, #{js_extend_properties.to_js}]))
+};
+Ext.extend(Ext.netzke.cache.#{short_widget_class_name}, #{js_base_class}, Ext.applyIf(#{js_extend_properties.to_js}, Ext.widgetMixIn));
 JS
           end
         end
         
+        #
+        # Include extra code from Ext js library (e.g. examples)
+        #
+        def ext_js_include(*args)
+          included_ext_js = read_inheritable_attribute(:included_ext_js) || []
+          args.each {|f| included_ext_js << f}
+          write_inheritable_attribute(:included_ext_js, included_ext_js)
+        end
+
+        #
+        # Include extra Javascript code. This code will be loaded along with the widget's class and in front of it.
+        #
+        # Example usage:
+        # js_include "File.dirname(__FILE__)/form_panel_extras/javascripts/xdatetime.js", 
+        #     :ext_examples => ["grid-filtering/menu/EditableItem.js", "grid-filtering/menu/RangeMenu.js"],
+        #     "File.dirname(__FILE__)/form_panel_extras/javascripts/xcheckbox.js"
+        #
+        def js_include(*args)
+          included_js = read_inheritable_attribute(:included_js) || []
+          args.each do |inclusion|
+            if inclusion.is_a?(Hash)
+              # we are signalized a non-default file location (e.g. Ext examples)
+              case inclusion.keys.first
+              when :ext_examples
+                location = Netzke::Base.config[:ext_location] + "/examples/"
+              end
+              files = inclusion.values.first
+            else
+              location = ""
+              files = inclusion
+            end
+            
+            files = [files] if files.is_a?(String)
+            
+            for f in files
+              included_js << location + f
+            end
+          end
+          write_inheritable_attribute(:included_js, included_js)
+        end
+
         # returns all extra js-code (as string) required by this widget's class
         def js_included
           # from extjs - defined in the widget class with ext_js_include
-          extjs_dir = "#{RAILS_ROOT}/public/extjs" # TODO: make extjs location configurable
-          included_ext_js = read_inheritable_attribute(:included_ext_js) || []
-          res = included_ext_js.inject("") do |r, path|
-            f = File.new("#{extjs_dir}/#{path}")
-            r << f.read
-          end
+          # extjs_dir = "#{RAILS_ROOT}/public/extjs" # TODO: make extjs location configurable
+          # begin
+          # res = super
+          # rescue
+          #   raise self.superclass.to_s
+          # end
 
-          res << "\n"
+          res = ""
           
-          # from <widget_name>_extras/javascripts - all *.js files found there
-          js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "javascripts") 
-          file_list = Dir.glob("#{js_dir}/*.js")
-
-          for file_name in file_list
-            f = File.new(file_name)
-            res << f.read
+          included_js = read_inheritable_attribute(:included_js) || []
+          res << included_js.inject("") do |r, path|
+            f = File.new(path)
+            r << f.read
           end
+
+          # res << "\n"
+          # 
+          # # from <widget_name>_extras/javascripts - all *.js files found there
+          # js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "javascripts") 
+          # file_list = Dir.glob("#{js_dir}/*.js")
+          # 
+          # for file_name in file_list
+          #   f = File.new(file_name)
+          #   res << f.read
+          # end
           
           res
         end
@@ -214,19 +268,19 @@ JS
         end
 
         # returns all css code require by this widget's class
-        def css_included
-          res = ""
-          # from <widget_name>_extras/stylesheets - all *.css files found there
-          js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "stylesheets") 
-          file_list = Dir.glob("#{js_dir}/*.css")
-
-          for file_name in file_list
-            f = File.new(file_name)
-            res << f.read
-          end
-          
-          res
-        end
+        # def css_included
+        #   res = ""
+        #   # from <widget_name>_extras/stylesheets - all *.css files found there
+        #   js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "stylesheets") 
+        #   file_list = Dir.glob("#{js_dir}/*.css")
+        # 
+        #   for file_name in file_list
+        #     f = File.new(file_name)
+        #     res << f.read
+        #   end
+        #   
+        #   res
+        # end
 
         # all JS code needed for this class including the one from the ancestor widget
         def css_code(cached_dependencies = [])
@@ -235,7 +289,7 @@ JS
           # include the base-class javascript if doing JS inheritance
           res << js_base_class.css_code << "\n" if js_inheritance && !cached_dependencies.include?(js_base_class.short_widget_class_name)
           
-          res << css_included << "\n"
+          # res << css_included << "\n"
           
           res
         end

data/lib/netzke/controller_extensions.rb

@@ -117,7 +117,7 @@ module Netzke
     Ext.onReady(function(){
     	<%= #{name}_widget_instance %>
     	<%= #{name}_widget_render %>
-    })
+    });
 	</script>
 </head>
 <body>

data/lib/netzke/core_ext.rb

@@ -12,7 +12,6 @@ class Hash
   
   # First camelizes the keys, then convert the whole hash to JSON
   def to_js
-    # self.delete_if{ |k,v| v.nil? } # we don't need to explicitely pass null values to javascript
     self.recursive_delete_if_nil.convert_keys{|k| k.camelize(:lower)}.to_json
   end
 
@@ -21,6 +20,7 @@ class Hash
     self.each_pair{|k,v| self[k] = v.to_s if v.is_a?(Symbol)}
   end
   
+  # We don't need to pass null values in JSON, they are null by simply being absent
   def recursive_delete_if_nil
     self.inject({}) do |h,(k,v)|
       if !v.nil?

data/lib/netzke-core.rb

@@ -1,5 +1,8 @@
+require 'active_support'
+
 # NetzkeCore
 require 'netzke/base'
+
 require 'netzke/action_view_ext'
 require 'netzke/controller_extensions'
 require 'netzke/core_ext'
@@ -34,6 +37,7 @@ end
 # Make this plugin auto-reloadable for easier development
 ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
 
-# Include javascript & styles
+# Include javascript & styles required by all Netzke widgets. 
+# These files will get loaded at the initial load of the framework (along with Ext).
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/core.js"
-Netzke::Base.config[:css] << "#{File.dirname(__FILE__)}/../css/core.css"
+Netzke::Base.config[:stylesheets] << "#{File.dirname(__FILE__)}/../stylesheets/core.css"

data/netzke-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.2.8"
+  s.version = "0.2.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2009-03-03}
+  s.date = %q{2009-03-19}
   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/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.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", "TODO"]
+  s.files = ["CHANGELOG", "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", "stylesheets/core.css", "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", "TODO", "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/{css → stylesheets}/core.css

@@ -1,3 +1,7 @@
+/*
+This file gets loaded along with the rest of Ext library at the initial load
+*/
+
 /* feedback */
 .netzke-feedback {
     position:fixed;

data/test/netzke_core_test.rb

@@ -160,8 +160,8 @@ class NetzkeCoreTest < ActiveSupport::TestCase
   
   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']"))
+    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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-03 00:00:00 +01:00
+date: 2009-03-19 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -37,9 +37,9 @@ extra_rdoc_files:
 - LICENSE
 - README.mdown
 - tasks/netzke_core_tasks.rake
+- TODO
 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
@@ -65,6 +65,7 @@ files:
 - netzke-core.gemspec
 - Rakefile
 - README.mdown
+- stylesheets/core.css
 - tasks/netzke_core_tasks.rake
 - test/app_root/app/controllers/application.rb
 - test/app_root/config/boot.rb
@@ -82,6 +83,7 @@ files:
 - test/netzke_core_test.rb
 - test/netzke_preference_test.rb
 - test/test_helper.rb
+- TODO
 - uninstall.rb
 has_rdoc: true
 homepage: http://writelesscode.com