netzke-core 0.6.6 → 0.6.7

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+= v0.6.7 - 2011-08-16
+* enhancements
+  * No more using +method_missing+ for invoking endpoints.
+  * New "cache" option for `netzke_init` which gets passed to `javascript_include_tag` (no support for css caching of this type yet)
+  * Netzke dynamic js and css-files such as ext.js, touch.css, now get generated at the application start, and put into "public/netzke". Solves a long standing problem with serving those files by HTTP servers in some cases. Enables caching naturally.
+  * Moved features and specs to test/rails_app (tests should be run from that folder from now on)
+
 = v0.6.6 - 2011-02-26
 * enhancements
   * Client-server communication is updated to use Ext.Direct (many thanks to @pschyska)

data/app/controllers/netzke_controller.rb

@@ -1,91 +1,25 @@
 class NetzkeController < ApplicationController
 
-  def ext
-    respond_to do |format|
-      format.js {
-        res = initial_dynamic_javascript << "\n"
-
-        # Core JavaScript
-        res << File.new(File.expand_path("../../../javascripts/core.js", __FILE__)).read
-        # 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
-      }
-
-      format.css {
-        res = File.new(File.expand_path("../../../stylesheets/core.css", __FILE__)).read
-
-        # Pluggable stylesheets (may be used by other Netzke-powered gems like netzke-basepack)
-        Netzke::Core.ext_stylesheets.each do |path|
-          f = File.new(path)
-          res << f.read
-        end
-
-        render :text => res
-      }
-    end
-  end
-
-  def touch
-    respond_to do |format|
-      format.js {
-        res = initial_dynamic_javascript << "\n"
-
-        # Core JavaScript
-        res << File.new(File.expand_path("../../../javascripts/core.js", __FILE__)).read
-        # Touch-specific JavaScript
-        res << File.new(File.expand_path("../../../javascripts/touch.js", __FILE__)).read
-
-        # Pluggable JavaScript (may be used by other Netzke-powered gems like netzke-basepack)
-        Netzke::Core.touch_javascripts.each do |path|
-          f = File.new(path)
-          res << f.read
-        end
-
-        render :text => defined?(::Rails) && ::Rails.env.production? ? res.strip_js_comments : res
-      }
-
-      format.css {
-        res = File.new(File.expand_path("../../../stylesheets/core.css", __FILE__)).read
-
-        # Pluggable stylesheets (may be used by other Netzke-powered gems like netzke-basepack)
-        Netzke::Core.touch_stylesheets.each do |path|
-          f = File.new(path)
-          res << f.read
-        end
-
-        render :text => res
-      }
-    end
-  end
-
   # Action for Ext.Direct RPC calls
   def direct
     result=""
     error=false
     if params['_json'] # this is a batched request
       params['_json'].each do |batch|
-        result+= result.blank? ? '[' : ', '
+        result += result.blank? ? '[' : ', '
         begin
-          result+=invoke_endpoint batch[:act], batch[:method].underscore, batch[:data], batch[:tid]
+          result += invoke_endpoint(batch[:act], batch[:method].underscore, batch[:data].first, batch[:tid])
         rescue Exception  => e
           Rails.logger.error "!!! Netzke: Error invoking endpoint: #{batch[:act]} #{batch[:method].underscore} #{batch[:data].inspect} #{batch[:tid]}\n"
           Rails.logger.error e.message
-          Rails.logger.error e.backtrace
+          Rails.logger.error e.backtrace.join("\n")
           error=true
           break;
         end
       end
       result+=']'
     else # this is a single request
-      result=invoke_endpoint params[:act], params[:method].underscore, params[:data], params[:tid]
+      result=invoke_endpoint params[:act], params[:method].underscore, params[:data].first, params[:tid]
     end
     render :text => result, :layout => false, :status => error ? 500 : 200
   end
@@ -95,60 +29,59 @@ class NetzkeController < ApplicationController
     endpoint_dispatch(params[:address])
   end
 
-  protected
+  # Used in development mode for on-the-fly generation of public/netzke/ext.[js|css]
+  def ext
+    respond_to do |format|
+      format.js {
+        render :text => Netzke::Core::DynamicAssets.ext_js
+      }
 
-    def invoke_endpoint component_name, action, data, tid
-      data=data[0] || {} # we get data as an array, extract the single argument if available
+      format.css {
+        render :text => Netzke::Core::DynamicAssets.ext_css
+      }
+    end
+  end
 
-      root_component_name, *sub_components = component_name.split('__')
-      root_component = Netzke::Base.instance_by_config Netzke::Core.session[:netzke_components][root_component_name.to_sym]
-      if sub_components.empty?
-        # we need to dispatch to root component, send it _#{action}_ep_wrapper
-        endpoint_action = "_#{action}_ep_wrapper"
-      else
-        # we need to dispatch to one or more sub_components, send subcomp__subsubcomp__endpoint to root component
-        endpoint_action = sub_components.join('__')+'__'+action
-      end
-      # send back JSON as specified in Ext.direct spec
-      #  => type: rpc
-      #  => tid, action, method as in the request, so that the client can mark the transaction and won't retry it
-      #  => result: JavaScript code from he endpoint result which gets applied to the client-side component instance
-      result = root_component.send(endpoint_action, data)
+  # Used in development mode for on-the-fly generation of public/netzke/touch.[js|css]
+  def touch
+    respond_to do |format|
+      format.js {
+        render :text => Netzke::Core::DynamicAssets.touch_js
+      }
+
+      format.css {
+        render :text => Netzke::Core::DynamicAssets.touch_css
+      }
+    end
+  end
 
-      {:type => "rpc", :tid => tid, :action => component_name, :method => action, :result => result.present? && result.l || {}}.to_json
+  protected
+    def invoke_endpoint(endpoint_path, action, params, tid) #:nodoc:
+      component_name, *sub_components = endpoint_path.split('__')
+      component_instance = Netzke::Base.instance_by_config(Netzke::Core.session[:netzke_components][component_name.to_sym])
+
+      result = component_instance.invoke_endpoint((sub_components + [action]).join("__"), params)
+
+      {
+        :type => "rpc",
+        :tid => tid,
+        :action => component_name,
+        :method => action,
+        :result => result.present? && result.l || {}
+      }.to_json
     end
 
     # Main dispatcher of old-style (Sencha Touch) HTTP requests. The URL contains the name of the component,
     # as well as the method of this component to be called, according to the double underscore notation.
     # E.g.: some_grid__post_grid_data.
-    def endpoint_dispatch(method_name)
-      component_name, *action = method_name.to_s.split('__')
-      component_name = component_name.to_sym
-      action = !action.empty? && action.join("__").to_sym
-
-      if action
-        w_instance = Netzke::Base.instance_by_config(Netzke::Core.session[:netzke_components][component_name])
-        # only component's actions starting with "endpoint_" are accessible from outside (security)
-        endpoint_action = action.to_s.index('__') ? action : "_#{action}_ep_wrapper"
-        render :text => w_instance.send(endpoint_action, params), :layout => false
-      else
-        super
-      end
-    end
-
-    # Generates initial javascript code that is dependent on Rails environement
-    def initial_dynamic_javascript
-      res = []
-      res << %(Ext.Ajax.extraParams = {authenticity_token: '#{form_authenticity_token}'}; // Rails' forgery protection)
-      res << %{Ext.ns('Netzke');}
-      res << %{Ext.ns('Netzke.core');}
-      res << %{Netzke.RelativeUrlRoot = '#{ActionController::Base.config.relative_url_root}';}
-      res << %{Netzke.RelativeExtUrl = '#{ActionController::Base.config.relative_url_root}/extjs';}
+    def endpoint_dispatch(endpoint_path)
+      component_name, *sub_components = endpoint_path.split('__')
+      component_instance = Netzke::Base.instance_by_config(Netzke::Core.session[:netzke_components][component_name.to_sym])
 
-      # TODO: this will needs some DRYing
-      res << %{Netzke.core.directMaxRetries = '#{Netzke::Core.js_direct_max_retries}';}
+      # We render text/plain, so that the browser never modifies our response
+      response.headers["Content-Type"] = "text/plain; charset=utf-8"
 
-      res.join("\n")
+      render :text => component_instance.invoke_endpoint(sub_components.join("__"), params), :layout => false
     end
 
 end

data/javascripts/{core.js → base.js}

@@ -9,11 +9,9 @@ At this time the following constants have been set by Rails:
 // Initial stuff
 Ext.BLANK_IMAGE_URL = Netzke.RelativeExtUrl + "/resources/images/default/s.gif";
 Ext.ns('Ext.netzke'); // namespace for extensions that depend on Ext
-
-Netzke.isLoading=function () {
-  return Netzke.runningRequests != 0;
-}
-Netzke.runningRequests = 0;
+Ext.ns('Netzke.page'); // namespace for all component instantces on the page
+Ext.ns('Netzke.classes'); // namespace for all component classes
+Ext.ns('Netzke.classes.Core'); // namespace for Core mixins
 
 Netzke.deprecationWarning = function(msg){
   if (typeof console == 'undefined') {
@@ -23,10 +21,15 @@ Netzke.deprecationWarning = function(msg){
   }
 };
 
-Ext.ns('Netzke.page'); // namespace for all component instantces on the page
-Ext.ns('Netzke.classes'); // namespace for all component classes
-Ext.ns('Netzke.classes.Core'); // namespace for all component classes
+// Used in testing
+Netzke.runningRequests = 0;
+Netzke.isLoading=function () {
+  return Netzke.runningRequests != 0;
+}
 
+// Similar to Ext.apply, but can accept any number of parameters, e.g.
+//
+//     Netzke.chainApply(targetObject, {...}, {...}, {...});
 Netzke.chainApply = function(){
   var res = {};
   Ext.each(arguments, function(o){
@@ -35,55 +38,18 @@ Netzke.chainApply = function(){
   return res;
 };
 
-// Some Ruby-ish 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;
-};
+/* Similar to Rails' alias_method_chain. Usefull when using mixins. E.g.:
 
-// This one is borrowed from prototype.js
-String.prototype.underscore = function() {
-  return this.replace(/::/g, '/')
-             .replace(/([A-Z]+)([A-Z][a-z])/g, '$1_$2')
-             .replace(/([a-z\d])([A-Z])/g, '$1_$2')
-             .replace(/-/g, '_')
-             .toLowerCase();
-};
+    Netzke.aliasMethodChain(this, "initComponent", "netzke")
 
-// Usefull when using mixins
+    will result in 2 new methods on this.initComponentWithNetzke and this.initComponentWithoutNetzke
+*/
 Netzke.aliasMethodChain = function(klass, method, feature) {
   klass[method + "Without" + feature.capitalize()] = klass[method];
   klass[method] = klass[method + "With" + feature.capitalize()];
 };
 
+// xtypes of cached Netzke classes
 Netzke.cache = [];
 
 // Registering a Netzke component
@@ -99,14 +65,6 @@ Netzke.classes.Core.Mixin = {};
 // Properties/methods common to all Netzke component classes
 Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
   isNetzke: true, // to distinguish Netzke components from regular Ext components
-  latestResult: {}, // latest result returned from the server via an API call
-  /*
-  Overriding the constructor to only apply an "alias method chain" to initComponent
-  */
-  // constructor: function(config){
-    // Netzke.aliasMethodChain(this, "initComponent", "netzke");
-    // receiver.superclass.constructor.call(this, config);
-  // },
 
   /*
   Detects component placeholders in the passed object (typically, "items"),
@@ -149,7 +107,7 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
   /*
   Gets id in the context of provided parent.
   For example, the components "properties", being a child of "books" has global id "books__properties",
-  which *is* its widegt's real id. This methods, with the instance of "books" passed as parameter,
+  which *is* its component's real id. This methods, with the instance of "books" passed as parameter,
   returns "properties".
   */
   localId : function(parent){
@@ -296,37 +254,3 @@ Ext.override(Ext.Container, {
     this.remove(this.getNetzkeComponent());
   }
 });
-
-
-// Feedback Ghost
-Netzke.FeedbackGhost = function(){};
-Ext.apply(Netzke.FeedbackGhost.prototype, {
-  showFeedback: 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.get('netzke-feedback') || Ext.DomHelper.insertFirst(document.body, {id: 'netzke-feedback', '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') {
-      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);
-    }
-  }
-});

data/javascripts/core_extensions.js

@@ -0,0 +1,42 @@
+// Some Ruby-ish String extensions
+// from http://code.google.com/p/inflection-js/
+if (!String.prototype.camelize) 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;
+};
+
+if (!String.prototype.capitalize) String.prototype.capitalize = function()
+{
+  var str=this.toLowerCase();
+  str=str.substring(0,1).toUpperCase()+str.substring(1);
+  return str;
+};
+
+if (!String.prototype.humanize) 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;
+};
+
+// This one is borrowed from prototype.js
+if (!String.prototype.underscore) String.prototype.underscore = function() {
+  return this.replace(/::/g, '/')
+             .replace(/([A-Z]+)([A-Z][a-z])/g, '$1_$2')
+             .replace(/([a-z\d])([A-Z])/g, '$1_$2')
+             .replace(/-/g, '_')
+             .toLowerCase();
+};

data/javascripts/ext.js

@@ -15,7 +15,7 @@ Ext.state.Provider.prototype.set = function(){};
   }
 })();
 
-Netzke.classes.NetzkeRemotingProvider=Ext.extend(Ext.direct.RemotingProvider,{
+Netzke.classes.NetzkeRemotingProvider = Ext.extend(Ext.direct.RemotingProvider, {
   getCallData: function(t){
     return {
       act: t.action, // rails doesn't really support having a parameter named "action"
@@ -115,9 +115,6 @@ Ext.apply(Netzke.classes.Core.Mixin, {
       }
     }
 
-    // From everywhere accessible FeedbackGhost
-    this.feedbackGhost = new Netzke.FeedbackGhost();
-
     // Call the original initComponent
     this.initComponentWithoutNetzke();
   },
@@ -133,7 +130,6 @@ Ext.apply(Netzke.classes.Core.Mixin, {
 
     Ext.each(endpoints, function(intp){
       directActions.push({"name":intp.camelize(true), "len":1});
-      //this[intp.camelize(true)] = function(args, callback, scope){ this.callServer(intp, args, callback, scope); }
       this[intp.camelize(true)] = function(arg, callback, scope) {
         Netzke.runningRequests++;
         scope=scope || that;

data/lib/netzke/composition.rb

@@ -1,7 +1,9 @@
 # require 'active_support/core_ext/class/inheritable_attributes'
 
 module Netzke
-  # You can define a nested components by calling the class method +component+:
+  # This module takes care of components composition.
+  #
+  # You can define a nested component by calling the +component+ class method:
   #
   #     component :users, :data_class => "GridPanel", :model => "User"
   #
@@ -198,30 +200,6 @@ module Netzke
         end
       end
 
-      # Method dispatcher - instantiates an component and calls the method on it
-      # E.g.:
-      #   users__center__get_data
-      #     instantiates component "users", and calls "center__get_data" on it
-      #   books__move_column
-      #     instantiates component "books", and calls "endpoint_move_column" on it
-      def method_missing(method_name, params = {})
-        component, *action = method_name.to_s.split('__')
-        component = component.to_sym
-        action = !action.empty? && action.join("__").to_sym
-
-        if action
-          if components[component]
-            # only actions starting with "endpoint_" are accessible
-            endpoint_action = action.to_s.index('__') ? action : "_#{action}_ep_wrapper"
-            component_instance(component).send(endpoint_action, params)
-          else
-            component_missing(component)
-          end
-        else
-          super
-        end
-      end
-
       protected
 
         def normalize_components(items) #:nodoc:
@@ -250,4 +228,4 @@ module Netzke
     end
 
   end
-end
+end