netzke-basepack 0.6.5 → 0.7.0

data/CHANGELOG.rdoc

@@ -1,12 +1,15 @@
-= v0.6.5 - 2011-08-16
-* changes
-  * Replaced tri-state checkbox with combobox in the multi-edit form and search form
+= 0.7.0 - 2011-08-09
+* Core 0.7.0 and Ext 4 compatibility
+* API changes
+  * [JS] Removed the helper BorderLayoutPanel#get<Region>Component method altogether. Use Ext 4 Container#child instead
+
+= v0.6.5 - to be released
 * enhancements
   * When columns states are saved in the persistent storage, adding/removing columns (e.g. in the code) will reset the saved states
   * Moved features and specs to test/rails_app
 * bug fix
   * FormPanel with multiple association fields wouldn't submit data correctly
-  * Fixed an old bug where tri-checkbox set to 'unchecked' had no effect in multi-edit
+  * GridPanel's forms take over the +text+ configuration option for columns as +fieldLabel+ for default fields
 
 = v0.6.4 - 2011-02-26
 * API changes

data/README.md

@@ -0,0 +1,63 @@
+# Netzke Basepack
+
+A pack of pre-built [Netzke](http://netzke.org) components - such as grid, form, tab panel, etc.
+
+## Requirements
+
+* Ruby 1.9.2 (1.8.7 may work, too)
+* Rails >= 3.0.0
+* Ext JS >= 4.0.0
+
+## Installation
+
+In your Gemfile:
+
+    gem 'netzke-basepack'
+
+For the "edge" stuff, tell bundler to get the gem straight from GitHub:
+
+    gem 'netzke-basepack', :git => "git://github.com/skozlov/netzke-basepack.git"
+
+## Usage
+
+Embed a basepack component into a view as any other Netzke component, e.g.:
+
+  <%= netzke :books, :class_name => 'Netzke::Basepack::GridPanel', :model => 'Book' %>
+
+For more examples, see http://demo.netzke.com, and look into test/rails_app.
+
+## Testing and playing with Netzke Basepack
+
+Netzke Basepack 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.
+
+After setting up the test application, you can access the test components (from test/rails_app/app/components) like this:
+
+    http://localhost:3000/components/<name_of_the_test_component_class>
+
+e.g.:
+
+    http://localhost:3000/components/UserGrid
+
+## Icons support
+Netzke Basepack can make use of FamFamFam Silk icon set (http://www.famfamfam.com/archive/silk-icons-thats-your-lot/). To enable this, download the icons and put the "icons" folder into your app's public/images folder. Then restart your application.
+
+## 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*)
+
+## More info
+Official project site: http://netzke.org
+
+Twitter:
+
+* latest news about Netzke: http://twitter.com/netzke
+* author's rambling about osx, productivity and what not:  http://twitter.com/nomadcoder
+
+Many (if a bit outdated) tutorials: http://blog.writelesscode.com
+
+---
+Copyright (c) 2008-2011 NomadCoder, released under the MIT license

data/Rakefile

@@ -9,10 +9,10 @@ begin
     gemspec.email = "sergei@playcode.nl"
     gemspec.homepage = "http://netzke.org"
     gemspec.authors = ["Sergei Kozlov"]
-    gemspec.add_dependency("netzke-core", "~>0.6.7")
-    gemspec.add_dependency("meta_where", ">=0.9.3")
-    gemspec.add_dependency("will_paginate", "~>3.0.pre2")
-    gemspec.add_dependency("acts_as_list")
+    gemspec.add_dependency("netzke-core",   "~>0.7.0")
+    gemspec.add_dependency("meta_where",    "~>1.0.0")
+    gemspec.add_dependency("will_paginate", "~>3.0.0")
+    gemspec.add_dependency("acts_as_list",  "~>0.1.4")
     gemspec.post_install_message = <<-MESSAGE
 
 ========================================================================

data/javascripts/basepack.js

@@ -5,164 +5,144 @@ Ext.ns("Ext.ux.grid");
 Ext.apply(Ext.History, new Ext.util.Observable());
 
 // A convenient passfield
-Ext.netzke.PassField = Ext.extend(Ext.form.TextField, {
-  inputType: 'password'
-});
-Ext.reg('passfield', Ext.netzke.PassField);
-
-Ext.override(Ext.ux.form.DateTimeField, {
-  format: "Y-m-d",
-  timeFormat: "g:i:s",
-  picker: {
-    minIncremenet: 15
-  }
-});
+// Ext.netzke.PassField = Ext.extend(Ext.form.TextField, {
+//   inputType: 'password'
+// });
+// Ext.reg('passfield', Ext.netzke.PassField);
+
+// Ext.override(Ext.ux.form.DateTimeField, {
+//   format: "Y-m-d",
+//   timeFormat: "g:i:s",
+//   picker: {
+//     minIncremenet: 15
+//   }
+// });
 
 // ComboBox that gets options from the server (used in both grids and panels)
-Ext.netzke.ComboBox = Ext.extend(Ext.form.ComboBox, {
+Ext.define('Ext.netzke.ComboBox', {
+  extend        : 'Ext.form.field.ComboBox',
+  alias         : 'widget.netzkeremotecombo',
   valueField    : 'field1',
   displayField  : 'field2',
   triggerAction : 'all',
-  typeAhead     : true,
+  // WIP: Breaking - should not be 'true' if combobox is not editable
+  // typeAhead     : true,
 
   initComponent : function(){
-    var row = Ext.data.Record.create(['field1', 'field2']); // defaults for local ComboBox; makes testing easier
+    var modelName = this.parentId + "_" + this.name;
+
+    Ext.define(modelName, {
+        extend: 'Ext.data.Model',
+        fields: ['field1', 'field2']
+    });
+
     var store = new Ext.data.Store({
-      proxy         : new Ext.data.DirectProxy({directFn: Netzke.providers[this.parentId].getComboboxOptions}),
-      reader        : new Ext.data.ArrayReader({root:'data', id:0}, row)
+      model: modelName,
+      proxy: {
+        type: 'direct',
+        directFn: Netzke.providers[this.parentId].getComboboxOptions,
+        reader: {
+          type: 'array',
+          root: 'data'
+        }
+      }
     });
-    store.proxy.on('beforeload', function (self, params) {
-      params.column = this.name;
+
+    // TODO: find a cleaner way to pass this.name to the server
+    store.on('beforeload', function(self, params) {
+      params.params.column = this.name;
     },this);
 
+    // If inline data was passed (TODO: is this actually working?)
     if (this.store) store.loadData({data: this.store});
 
     this.store = store;
 
-    Ext.netzke.ComboBox.superclass.initComponent.apply(this, arguments);
-
-    var parent = Ext.getCmp(this.parentId);
-    // Is parent a grid?
-    if (parent.getSelectionModel) {
-      this.on('beforequery',function(qe) {
-        delete qe.combo.lastQuery;
-      },this);
-    }
-
-    // A not-so-clean approach to submit the current record id
-    store.on('beforeload',function(store, options){
-      if (parent.getSelectionModel) {
-        var selected = parent.getSelectionModel().getSelected();
-        if (selected) options.params.id = selected.id;
-      } else {
-        // TODO: also for the FormPanel
-      }
-    }, this);
+    this.callParent();
+  },
+
+  collapse: function(){
+    // HACK: do not hide dropdown menu while loading items
+    if( !this.store.loading ) this.callParent();
   }
 });
 
-Ext.reg('netzkeremotecombo', Ext.netzke.ComboBox);
-
 Ext.util.Format.mask = function(v){
   return "********";
 };
 
-Ext.netzke.JsonField = Ext.extend(Ext.form.TextField, {
-  validator: function(value) {
-    try{
-      var d = Ext.decode(value);
-      return true;
-    } catch(e) {
-      return "Invalid JSON"
-    }
-  }
+// Ext.netzke.JsonField = Ext.extend(Ext.form.TextField, {
+//   validator: function(value) {
+//     try{
+//       var d = Ext.decode(value);
+//       return true;
+//     } catch(e) {
+//       return "Invalid JSON"
+//     }
+//   }
+//
+//   ,setValue: function(value) {
+//     this.setRawValue(Ext.encode(value));
+//   }
+//
+// });
+//
+// Ext.reg('jsonfield', Ext.netzke.JsonField);
+//
+// WIP: todo - rewrite Ext.lib calls below
+// Ext.grid.HeaderDropZone.prototype.onNodeDrop = function(n, dd, e, data){
+//     var h = data.header;
+//     if(h != n){
+//         var cm = this.grid.colModel;
+//         var x = Ext.lib.Event.getPageX(e);
+//         var r = Ext.lib.Dom.getRegion(n.firstChild);
+//         var pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before";
+//         var oldIndex = this.view.getCellIndex(h);
+//         var newIndex = this.view.getCellIndex(n);
+//         if(pt == "after"){
+//             newIndex++;
+//         }
+//         if(oldIndex < newIndex){
+//             newIndex--;
+//         }
+//         cm.moveColumn(oldIndex, newIndex);
+//         return true;
+//     }
+//     return false;
+// };
+//
+//
+// Ext.ns('Ext.ux.form');
+
+Ext.define('Ext.ux.form.TriCheckbox', {
+  extend: 'Ext.form.field.ComboBox',
+  alias: 'widget.tricheckbox',
+  store: [[true, "Yes"], [false, "No"]],
+  forceSelection: true
+});
 
-  ,setValue: function(value) {
-    this.setRawValue(Ext.encode(value));
+// Enabling checkbox submission when unchecked
+// TODO: it would be nice to standardize return values
+//  because currently checkboxes return "on", if checked,
+//  and boolean 'false' otherwise. It's not nice
+//  MAV
+//  TODO: maybe we should simply initialize 'uncheckedValue' somewhere else,
+//  instead
+Ext.override( Ext.form.field.Checkbox, {
+  getSubmitValue: function() {
+    return this.callOverridden() || false; // 'off';
   }
-
 });
 
-Ext.reg('jsonfield', Ext.netzke.JsonField);
-
-Ext.grid.HeaderDropZone.prototype.onNodeDrop = function(n, dd, e, data){
-    var h = data.header;
-    if(h != n){
-        var cm = this.grid.colModel;
-        var x = Ext.lib.Event.getPageX(e);
-        var r = Ext.lib.Dom.getRegion(n.firstChild);
-        var pt = (r.right - x) <= ((r.right-r.left)/2) ? "after" : "before";
-        var oldIndex = this.view.getCellIndex(h);
-        var newIndex = this.view.getCellIndex(n);
-        if(pt == "after"){
-            newIndex++;
-        }
-        if(oldIndex < newIndex){
-            newIndex--;
-        }
-        cm.moveColumn(oldIndex, newIndex);
-        return true;
-    }
-    return false;
-};
-
+/* We were missing the 'load' event on proxy, implementing it ourselves */
+Ext.override(Ext.data.proxy.Server, {
+  constructor: function() {
+    this.addEvents('load');
+    this.callOverridden([arguments]);
+  },
 
-Ext.ns('Ext.ux.form');
-Ext.ux.form.TriCheckbox = Ext.extend(Ext.form.ComboBox, {
-  store: [[true, "true"], [false, "false"]],
-  forceSelection: true,
-  triggerAction: 'all'
+  processResponse: function(success, operation, request, response, callback, scope){
+    this.callOverridden(arguments);
+    this.fireEvent('load', this, response, operation);
+  }
 });
-Ext.reg('tricheckbox', Ext.ux.form.TriCheckbox);
-
-
-// Enabling checkbox submission when unchecked
-(function() {
-  origCheckboxRender = Ext.form.Checkbox.prototype.onRender;
-  origCheckboxSetValue = Ext.form.Checkbox.prototype.setValue;
-
-  Ext.override(Ext.form.Checkbox, {
-    onRender: function() {
-      // call the original onRender() function
-      origCheckboxRender.apply(this, arguments);
-
-      if (this.getXType() === 'radio') return;
-
-      // Handle initial case based on this.checked
-      if (this.checked == false) {
-        this.noValEl = Ext.DomHelper.insertAfter(this.el, {
-            tag: 'input',
-            type: 'hidden',
-            value: false,
-            name: this.getName()
-        }, true);
-      }
-      else {
-        this.noValEl = null;
-      }
-    },
-    setValue: function() {
-      // call original setValue() function
-      origCheckboxSetValue.apply(this, arguments);
-
-      if (this.getXType() === 'radio') return;
-
-      if (this.checked) {
-        if (this.noValEl != null) {
-          // Remove the extra hidden element
-          this.noValEl.remove();
-          this.noValEl = null;
-        }
-      }
-      else {
-        // Add our hidden element for (unchecked) value
-        if (this.noValEl == null) this.noValEl = Ext.DomHelper.insertAfter(this.el, {
-            tag: 'input',
-            type: 'hidden',
-            value: false,
-            name: this.getName()
-        }, true);
-      }
-    }
-  });
-})();

data/lib/netzke-basepack.rb

@@ -10,10 +10,17 @@ require 'netzke/basepack'
 module Netzke
   module Basepack
     class Engine < Rails::Engine
+
+      I18n.load_path << File.dirname(__FILE__) + '/../locales/en.yml'
+      I18n.load_path << File.dirname(__FILE__) + '/../locales/de.yml'
+
+      config.after_initialize do
+        Netzke::Core.external_ext_css << "#{Netzke::Core.ext_uri}/examples/ux/grid/css/RangeMenu"
+        Netzke::Core.external_ext_css << "#{Netzke::Core.ext_uri}/examples/ux/grid/css/GridFilters"
+        Netzke::Core.external_ext_css << "#{Netzke::Core.ext_uri}/examples/ux/css/CheckHeader"
+      end
     end
   end
 end
 
-I18n.load_path << File.dirname(__FILE__) + '/../locales/en.yml'
-
 Netzke::Basepack.init

data/lib/netzke/basepack.rb

@@ -1,5 +1,12 @@
 require 'netzke/basepack/version'
-require 'netzke/active_record'
+
+if defined? ActiveRecord
+  require 'netzke/active_record'
+  require 'meta_where'
+end
+
+# will_paginate supports more than just ActiveRecord
+require 'will_paginate'
 
 module Netzke
   module Basepack
@@ -11,15 +18,11 @@ module Netzke
 
       # Called from netzke-basepack.rb
       def init
-        Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/feedback_ghost.js"
-        Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/datetimefield.js"
+        # Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/datetimefield.js"
         Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/basepack.js"
 
         Netzke::Core.ext_stylesheets << "#{File.dirname(__FILE__)}/../../stylesheets/datetimefield.css"
         Netzke::Core.ext_stylesheets << "#{File.dirname(__FILE__)}/../../stylesheets/basepack.css"
-
-        Netzke::Core.external_ext_css << "/extjs/examples/ux/gridfilters/css/RangeMenu"
-        Netzke::Core.external_ext_css << "/extjs/examples/ux/gridfilters/css/GridFilters"
       end
 
       # Use it to confirure Basepack in the initializers, e.g.:

data/lib/netzke/basepack/accordion_panel.rb

@@ -27,7 +27,7 @@ module Netzke
             item.on('expand', function(i){
               if (i && i.wrappedComponent && !i.items.first() && !i.beingLoaded) {
                 i.beingLoaded = true; // prevent more than one request per panel in case of fast clicking
-                this.loadComponent({name: i.wrappedComponent, container: i.id}, function(){i.beingLoaded = false});
+                this.loadNetzkeComponent({name: i.wrappedComponent, container: i.id}, function(){i.beingLoaded = false});
               }
             }, this);
           }, this);

data/lib/netzke/basepack/auth_app.rb

@@ -4,21 +4,28 @@ module Netzke
     # ** NOTE: it's WIP **
     class AuthApp < SimpleApp
 
-      class_attribute :login_url
-      self.login_url = "/login"
+      def default_config
+        super.tap do |c|
+          c[:login_url] = "/login"
+          c[:logout_url] = "/logout"
+        end
+      end
 
-      class_attribute :logout_url
-      self.logout_url = "/logout"
+      # class_config_option :login_url, "/login"
+      # # self.login_url = "/login"
+      #
+      # class_attribute :logout_url
+      # self.logout_url = "/logout"
 
       js_method :on_login, <<-JS
         function(){
-          window.location = "#{login_url}"
+          window.location = this.loginUrl;
         }
       JS
 
       js_method :on_logout, <<-JS
         function(){
-          window.location = "#{logout_url}"
+          window.location = this.logoutUrl;
         }
       JS
 
@@ -27,7 +34,7 @@ module Netzke
           this.toggleConfigMode();
         }
       JS
-
+# WIP: todo - rewrite Ext.lib calls below
       js_method :show_masquerade_selector, <<-JS
         function(){
           var w = new Ext.Window({
@@ -82,27 +89,27 @@ module Netzke
           });
 
           w.show(null, function(){
-            this.loadComponent({id:"masqueradeSelector", container:w.id})
+            this.loadNetzkeComponent({id:"masqueradeSelector", container:w.id})
           }, this);
 
         }
       JS
 
-      # Set the Logout button if Netzke::Base.user is set
+      # Set the Logout button if Netzke::Core.current_user is set
       def menu
-        res = []
-        user = User.find_by_id(session[:netzke_user_id])
-        if !user.nil?
-          user_name = user.respond_to?(:name) ? user.name : user.login # try to display user's name, fallback to login
-          res << "->" <<
-          {
-            :text => "#{user_name}",
-            :menu => user_menu
-          }
-        else
-          res << "->" << :login.action
+        [].tap do |menu|
+          user = Netzke::Core.current_user
+          if !user.nil?
+            user_name = user.respond_to?(:name) ? user.name : user.email # try to display user's name, fallback to email
+            menu << "->" <<
+            {
+              :text => user_name,
+              :menu => user_menu
+            }
+          else
+            menu << "->" << :login.action
+          end
         end
-        res
       end
 
       def user_menu