netzke-core 0.6.7 → 0.7.0

data/CHANGELOG.rdoc

@@ -1,9 +1,44 @@
-= v0.6.7 - 2011-08-16
+= v0.7.0 - 2011-08-09
+* Ext JS 4 compatibility
+
+* API changes
+  * New +ext_uri+ config option (defaults to "extjs") - relative URI to the Ext JS library on the server.
+  * New +ext3_compat_uri+ config option (defaults to +nil+) - relative URI to the Ext 3 compatibility layer. When nil, no compatibility layer is loaded.
+  * New +current_user_method+ config option (defaults to :current_user) to let Netzke::Core know which method to call on Rails controller to retrieve the current user.
+  * New +Netzke::Core.current_user+ method to retrieve the current user.
+  * Passing instructions from server back to the client now is only meant for single-argument methods on client; arrays are not expanded into arguments any longer.
+  * New +instantiateChildNetzkeComponent+ method to instantiate a Netzke component by name.
+  * Default component height (400) and border (false) are no longer set.
+
+* broken API
+  * The +ext_location+ config option renamed to +ext_path+
+  * loadNetzkeComponent (ex loadComponent) won't automatically show a component with xtype 'window' any longer; use the callback to do  that manually
+
+* enhancements
+  * +js_mixin+ without parameters will assume :component_class_name_underscored
+  * Ext locale file is automatically included when I18n.locale is not :en
+  * Child components now have +itemId+ set to component's name, so that +getComponent(component_name)+ can be used to retrieve immediate child components
+  * +loadNetzkeComponent+ that should be used instead of loadComponent won't render the loaded component unless the container is specified (which can be an id or an instance)
+  * JS: +componentDeliveryFailed+ method added that is called by the +deliver_component+ endpoint
+
+* bug fix
+  * Tolerate relative_url_root when calculating the URI to icons in actions
+
+* deprecations
+  * instantiateAndRenderComponent
+  * getParent in favor of getParentNetzkeComponent
+  * getChildComponent in favor of getChildNetzkeComponent
+  * loadComponent in favor of loadNetzkeComponent
+  * feedback in favor of netzkeFeedback
+  * Ext.container.Container#instantiateChild should not be used
+
+= v0.6.7 - to be released
 * 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)
+  * Introduced plugin functionality. We can create Netzke components that are pluggable into other components as Ext JS plugins.
 
 = v0.6.6 - 2011-02-26
 * enhancements

data/{README.markdown → README.md}

@@ -1,4 +1,4 @@
-## Netzke Core
+# Netzke Core
 
 Netzke Core is the bare bones of the [Netzke framework](https://github.com/skozlov/netzke). For pre-built full-featured components (like grids, forms, tab/accordion panels, applications, etc), see [netzke-basepack](http://github.com/skozlov/netzke-basepack) (Ext JS).
 
@@ -15,29 +15,31 @@ Netzke Core takes the burden of implementing the following key aspects of the fr
 
 All this provides for fast, low-traffic, robust, highly maintainable applications.
 
-### Getting started
+## Getting started
 
 * Follow the simple [installation](https://github.com/skozlov/netzke-core/wiki/Installation) steps.
 * Learn how to build the [Hello World!](https://github.com/skozlov/netzke-core/wiki/Hello-world-extjs) component.
 * Dive into the [documentation](https://github.com/skozlov/netzke/wiki).
 * Get help on the [Google Groups](http://groups.google.com/group/netzke).
 
-### Sencha Touch support
-
-Netzke Core has support for Sencha Touch, so you can create components for mobile web apps as easily.
-
-* Learn how to build the [Hello World!](https://github.com/skozlov/netzke-core/wiki/Hello-world-touch) Sencha Touch component.
-
-### Testing and playing with Netzke Core
+## Testing and playing with Netzke Core
 
 Netzke Core is bundled with Cucumber and RSpec tests. If you would like to contribute to the project, you may want to learn how to [run the tests](https://github.com/skozlov/netzke-core/wiki/Automated-testing).
 
 Besides, the bundled test application is a convenient [playground](https://github.com/skozlov/netzke-core/wiki/Playground) for those who search to experiment with the framework.
 
-### Useful links
-* [Project website](http://netzke.org).
-* [Documentation](https://github.com/skozlov/netzke/wiki).
-* [Live-demo](http://demo.netzke.org) (with sample code).
-* [Twitter](http://twitter.com/skozlov).
+## Useful links
+* [Project website](http://netzke.org)
+* [Documentation](https://github.com/skozlov/netzke/wiki)
+* [Live-demo](http://demo.netzke.org) (features [Netzke Basepack](https://github.com/skozlov/netzke-basepack), with sample code)
+* [Twitter](http://twitter.com/netzke) - latest news about the framework
+* [Author's twitter](http://twitter.com/nomadcoder) - author's rambling about OS X, productivity, lifestyle, and what not
+
+## Ext 3 support
+Versions 0.6.x are for you if you're using Ext 3 (*hardly maintained*)
+
+## Rails 2 support
+With Rails 2 (and Ext 3 only), use versions 0.5.x (*not maintained*)
 
-*Copyright (c) 2008-2010 Sergei Kozlov, released under the MIT license*
+---
+Copyright (c) 2008-2011 NomadCoder, released under the MIT license

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gemspec.email = "sergei@playcode.nl"
     gemspec.homepage = "http://netzke.org"
     gemspec.authors = ["Sergei Kozlov"]
-    gemspec.add_dependency("activesupport", ">=3.0.1")
+    gemspec.add_dependency("activesupport", "~>3.0.0")
     gemspec.post_install_message = <<-MESSAGE
 
 ========================================================================

data/TODO

@@ -1,9 +1,9 @@
-Make :items option understand also a hash.
+= ToDo
+Make it possible to pass a constant (not a string) to the `class_name` option
+Make :lazy_loading "true" by default when defining a child component
+Make :items option also accept a hash.
 Caching for netzke_controller-provided JS and CSS.
 Caching - investigate reusing (fragment?) caching of Rails.
-Use Ext.Direct in the Netzke controller.
-Let specify per API point if it will use a GET or a POST request.
-
 
 
 = Ideas that didn't work out

data/app/controllers/netzke_controller.rb

@@ -33,7 +33,7 @@ class NetzkeController < ApplicationController
   def ext
     respond_to do |format|
       format.js {
-        render :text => Netzke::Core::DynamicAssets.ext_js
+        render :text => Netzke::Core::DynamicAssets.ext_js(form_authenticity_token)
       }
 
       format.css {
@@ -58,9 +58,14 @@ class NetzkeController < ApplicationController
   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])
+      components_in_session = Netzke::Core.session[:netzke_components]
 
-      result = component_instance.invoke_endpoint((sub_components + [action]).join("__"), params)
+      if components_in_session
+        component_instance = Netzke::Base.instance_by_config(components_in_session[component_name.to_sym])
+        result = component_instance.invoke_endpoint((sub_components + [action]).join("__"), params)
+      else
+        result = {:component_not_in_session => true}.to_nifty_json
+      end
 
       {
         :type => "rpc",

data/javascripts/base.js

@@ -7,9 +7,8 @@ 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
-Ext.ns('Netzke.page'); // namespace for all component instantces on the page
+Ext.ns('Netzke.page'); // namespace for all component instances on the page
 Ext.ns('Netzke.classes'); // namespace for all component classes
 Ext.ns('Netzke.classes.Core'); // namespace for Core mixins
 
@@ -21,7 +20,22 @@ Netzke.deprecationWarning = function(msg){
   }
 };
 
+Netzke.warning = Netzke.deprecationWarning;
+
+Netzke.exception = function(msg) {
+  throw("Netzke: " + msg);
+};
+
 // Used in testing
+if( Netzke.nLoadingFixRequests == undefined ){
+  Netzke.nLoadingFixRequests=0;
+  Ext.Ajax.on('beforerequest',    function(conn,opt) { Netzke.nLoadingFixRequests+=1; });
+  Ext.Ajax.on('requestcomplete',  function(conn,opt) { Netzke.nLoadingFixRequests-=1; });
+  Ext.Ajax.on('requestexception', function(conn,opt) { Netzke.nLoadingFixRequests-=1; });
+  Netzke.ajaxIsLoading = function() { return Netzke.nLoadingFixRequests > 0; };
+}
+
+// Used in testing, too
 Netzke.runningRequests = 0;
 Netzke.isLoading=function () {
   return Netzke.runningRequests != 0;
@@ -52,12 +66,8 @@ Netzke.aliasMethodChain = function(klass, method, feature) {
 // xtypes of cached Netzke classes
 Netzke.cache = [];
 
-// Registering a Netzke component
-Netzke.reg = function(xtype, klass) {
-  if (!Ext.ComponentMgr.types[xtype]) {
-    Ext.reg(xtype, klass);
-    Netzke.cache.push(xtype);
-  }
+Netzke.componentNotInSessionHandler = function() {
+  throw "Netzke: component not in Rails session. Define Netzke.componentNotInSessionHandler to handle this.";
 };
 
 Netzke.classes.Core.Mixin = {};
@@ -68,7 +78,7 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
 
   /*
   Detects component placeholders in the passed object (typically, "items"),
-  and merges them with the corresponding config from this.components.
+  and merges them with the corresponding config from this.netzkeComponents.
   This way it becomes ready to be instantiated properly by Ext.
   */
   detectComponents: function(o){
@@ -76,11 +86,11 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
       if (o.items) this.detectComponents(o.items);
     } else if (Ext.isArray(o)) {
       var a = o;
-      Ext.each(a, function(el, i){
-        if (el.component) {
-          a[i] = Ext.apply(this.components[el.component.camelize(true)], el);
+      Ext.each(a, function(c, i){
+        if (c.netzkeComponent) {
+          a[i] = Ext.apply(this.netzkeComponents[c.netzkeComponent.camelize(true)], c);
           delete a[i].component;
-        } else if (el.items) this.detectComponents(el.items);
+        } else if (c.items) this.detectComponents(c.items);
       }, this);
     }
   },
@@ -90,7 +100,7 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
   */
   evalCss : function(code){
     var head = Ext.fly(document.getElementsByTagName('head')[0]);
-    Ext.DomHelper.append(head, {
+    Ext.core.DomHelper.append(head, {
       tag: 'style',
       type: 'text/css',
       html: code
@@ -118,25 +128,21 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
   Executes a bunch of methods. This method is called almost every time a communication to the server takes place.
   Thus the server side of a component can provide any set of commands to its client side.
   Args:
-    - instructions: array of methods, in the order of execution.
-      Each item is an object in one of the following 2 formats:
-        1) {method1:args1, method2:args2}, where methodN is a name of a public method of this component; these methods are called in no particular order
-        2) {component:component_id, methods:arrayOfMethods}, used for recursive call to bulkExecute on some child component
-
-  Example:
-    - [
-        // the same as this.feedback("Your order is accepted")
-        {feedback: "You order is accepted"},
-
-        // the same as this.getChildComponent('users').bulkExecute([{setTitle:'Suprise!'}, {setDisabled:true}])
-        {component:'users', methods:[{setTitle:'Suprise!'}, {setDisabled:true}] },
-
-        // ... etc:
-        {updateStore:{records:[[1, 'Name1'],[2, 'Name2']], total:10}},
-        {setColums:[{},{}]},
-        {setMenus:[{},{}]},
-        ...
-      ]
+    - instructions: can be
+      1) a hash of instructions, where the key is the method name, and value - the argument that method will be called with (thus, these methods are expected to *only* receive 1 argument). In this case, the methods will be executed in no particular order.
+      2) an array of hashes of instructions. They will be executed in order.
+      Arrays and hashes may be nested at will.
+      If the key in the instructions hash refers to a child Netzke component, bulkExecute will be called on that component with the value passed as the argument.
+
+  Examples of the arguments:
+      // same as this.feedback("Your order is accepted");
+      {feedback: "You order is accepted"}
+
+      // same as: this.setTitle('Suprise!'); this.setDisabled(true);
+      [{setTitle:'Suprise!'}, {setDisabled:true}]
+
+      // the same as this.getChildNetzkeComponent('users').bulkExecute([{setTitle:'Suprise!'}, {setDisabled:true}]);
+      {users: [{setTitle:'Suprise!'}, {setDisabled:true}] }
   */
   bulkExecute : function(instructions){
     if (Ext.isArray(instructions)) {
@@ -144,10 +150,10 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
     } else {
       for (var instr in instructions) {
         if (Ext.isFunction(this[instr])) {
-          // Executing the method. If arguments are an array, expand that into arguments.
-          this[instr].apply(this, Ext.isArray(instructions[instr]) ? instructions[instr] : [instructions[instr]]);
+          // Executing the method.
+          this[instr].apply(this, [instructions[instr]]);
         } else {
-          var childComponent = this.getChildComponent(instr);
+          var childComponent = this.getChildNetzkeComponent(instr);
           if (childComponent) {
             childComponent.bulkExecute(instructions[instr]);
           } else {
@@ -158,17 +164,6 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
     }
   },
 
-  // Returns API url based on provided API point
-  buildApiUrl: function(endpoint){
-    Netzke.deprecationWarning("buildApiUrl() is deprecated. Use endpointUrl() instead.");
-    return this.endpointUrl(endpoint);
-  },
-
-  // endpointUrl: function(endpoint){
-  //   Netzke.deprecationWarning("endpointUrl() is deprecated. Use Ext.direct counterparts instead.\nFor example, specify a DirectProxy instead of HttpProxy ( proxy: new Ext.data.DirectProxy({directFn: Netzke.providers[this.id].endPoint}) ),\nor specify api instead of url config option for BasicForm ( api: { load: Netzke.providers[this.id].loadEndPoint, submit: Netzke.providers[this.id].submitEndPoint} )");
-  //   return Netzke.RelativeUrlRoot + "/netzke/" + this.id + "__" + endpoint;
-  // },
-
   // Used by Touch components
   endpointUrl: function(endpoint){
     return Netzke.RelativeUrlRoot + "/netzke/dispatcher?address=" + this.id + "__" + endpoint;
@@ -200,31 +195,35 @@ Netzke.componentMixin = Ext.applyIf(Netzke.classes.Core.Mixin, {
 
   setResult: function(result) {
     this.latestResult = result;
+  },
+
+  // When an endpoint call is issued while the session has expired, this method is called. Override it to do whatever is appropriate.
+  componentNotInSession: function() {
+    Netzke.componentNotInSessionHandler();
   }
 });
 
 
-// Netzke extensions for Ext.Container
+// DEPRECATED as whole. Netzke extensions for Ext.Container.
 Ext.override(Ext.Container, {
   // Instantiates an component by its config. If it appears to be a window, shows it instead of adding as item.
-  // TODO: there must be a method to just instantiate a component, but not to add/show it instantly.
-  instantiateChild : function(config){
-    var instance = Ext.create(config);
-    if (instance.isXType("window")) {
-      instance.show();
-    } else {
-      this.remove(this.getNetzkeComponent()); // first delete previous component
-      this.add(instance);
+  instantiateChild: function(config){
+    Netzke.deprecationWarning("instantiateChild is deprecated");
+    var instance = Ext.createByAlias( config.alias, config );
+    this.insertNetzkeComponent(instance);
+    return instance;
+  },
 
-      // Sometimes a child is getting loaded into a hidden container...
-      if (this.isVisible()) {
-        this.doLayout();
-      } else {
-        this.on('show', function(cmp){cmp.doLayout();}, {single: true});
-      }
+  insertNetzkeComponent: function(cmp) {
+    this.removeChild(); // first delete previous component
+    this.add(cmp);
 
+    // Sometimes a child is getting loaded into a hidden container...
+    if (this.isVisible()) {
+      this.doLayout();
+    } else {
+      this.on('show', function(cmp){cmp.doLayout();}, {single: true});
     }
-    return instance;
   },
 
   /**
@@ -232,25 +231,29 @@ Ext.override(Ext.Container, {
     It searches up the Ext.Container hierarchy until it finds a Container that has isNetzke property set to true
     (or until it reaches the top).
   */
-  getOwnerComponent : function(){
+  getOwnerComponent: function(){
+    Netzke.deprecationWarning("getOwnerComponent is deprecated");
     if (this.initialConfig.isNetzke) {
       return this;
     } else {
       if (this.ownerCt){
-        return this.ownerCt.getOwnerComponent()
+        return this.ownerCt.getOwnerComponent();
       } else {
-        return null
+        return null;
       }
     }
   },
 
   // Get the component that we are hosting
   getNetzkeComponent: function(){
+    Netzke.deprecationWarning("getNetzkeComponent is deprecated");
     return this.items ? this.items.first() : null; // need this check in case when the container is not yet rendered, like an inactive tab in the TabPanel
   },
 
   // Remove the child
-  removeChild : function(){
-    this.remove(this.getNetzkeComponent());
+  removeChild: function(){
+    Netzke.deprecationWarning("removeChild is deprecated");
+    var currentChild = this.getNetzkeComponent();
+    if (currentChild) {this.remove(currentChild);}
   }
 });