netzke-basepack 0.5.14 → 0.6.0

data/.gitignore

@@ -5,5 +5,6 @@ doc
 Manifest
 test/app_root/vendor/plugins/netzke-core
 rdoc
-netzke-basepack.gemspec
-netzke-basepack-*.gem
+netzke-basepack-*.gem
+icons
+extjs

data/CHANGELOG.rdoc

@@ -1,3 +1,18 @@
+= v0.6.0 - 2010-10-24
+* netzke-core 0.6.0 compatibility, thorough refactoring
+* Much more thorough testing (cucumber and rspec)
+* FormPanel/GridPanel dynamic column/field configuration has been left out (planned for a separate gem)
+* different bug fixes
+
+* enhancements
+  * if omitted in config, a column for the primary key is automatically added to Grid/FormPanel
+  
+* API incompatibilities
+  * in FormPanel, define the fields layout directly in :items, not in :fields or :columns
+  
+* new
+  * FormPanel allows for arbitrary layout of fields  
+
 = v0.5.14 - 2010-09-08
 * bug fix
   * fields configurator wouldn't open in some cases

data/README.rdoc

@@ -1,87 +1,82 @@
 = netzke-basepack
-A pack of basic Rails/ExtJS widgets as a part of the Netzke framework. Live demo/tutorials on http://blog.writelesscode.com. Introduction to the Netzke framework and the Wiki: http://github.com/skozlov/netzke
 
-== Prerequisites
-1. Rails >= 2.2
-2. Netzke assumes that your ExtJS library is in public/extjs, which may be a symbolic link, e.g:
-
-    cd public && ln -s ~/Developer/extjs/ext-3.1.1 extjs
-
-3. acts_as_list plugin: 
+A pack of pre-built Netzke components, such as grid, form, tab panel, etc.
+Learn about Netzke on http://netzke.org.
 
-    ./script/plugin install git://github.com/rails/acts_as_list.git
+== Prerequisites
 
-4. netzke-core gem or plugin. Gem:
-  
-    gem install netzke-core
-    
-Plugin (for the "edge" stuff, recommended):
+1. Rails >= 3.0, Ext JS >= 3.3.0
+2. Netzke assumes that your ExtJS library is in public/extjs, which may be a symbolic link, e.g (from your app root):
 
-    ./script/plugin install git://github.com/skozlov/netzke-core.git
+    ln -s ~/code/sencha/extjs/ext-3.3.0 public/extjs
 
 = Installation
-For the "edge" stuff, install as plugin (recommended):
 
-    ./script/plugin install git://github.com/skozlov/netzke-basepack.git
+For the latest ("edge") stuff, install as plugin:
 
-Or install as gem:
+    rails plugin install git://github.com/skozlov/netzke-basepack.git
+    
+Or tell bundler to get the gem straight from github:
 
-    gem install netzke-basepack
+    gem 'netzke-basepack', :git => "git://github.com/skozlov/netzke-basepack.git"
 
 == Usage
-If using as gem, include it into environment.rb:
 
-    config.gem "netzke-basepack"
+Add Netzke routes (in routes.rb):
+
+    # in routes.rb
+    RailsApp::Application.routes.draw do
+      netzke
+      ...
+    end
 
-Include mapping for Netzke controller providing Netzke javascripts and styles (in routes.rb):
+== Embedding components into Rails' view
 
-    map.netzke
+Before you can use Netzke components in Rails' views, you need to add the following helper into your layout template, inside the "head" tag:
 
-Run the generators (some assets and a migration for dynamically configured columns/fields):
+    <%= netzke_init %>
     
-    ./script/generate netzke_basepack
+This will include both ExtJS-related files (JavaScript and styles), and Netzke-related files.
 
-To be able to use persistent on-the-fly configuration of widgets, run netzke-core generators:
+To embed a component into a view, use the +netzke+ helper, e.g.:
 
-    ./script/generate netzke_core
-    
-... then run the migrations:
+  <%= netzke :books, :class_name => 'Basepack::GridPanel', :model => 'Book' %>
+  
+(assuming the existence of model 'Book')
 
-    rake db:migrate
+For more examples, see http://demo.netzke.com, and look into test/rails_app
 
-== Embedding widgets into Rails' view
-To enable Netzke widgets in Rails' views, you need to add the following helper into your layout template, inside the "head" tag:
+== Running tests
 
-    <%= netzke_init %>
-    
-This will include both ExtJS-related files (JavaScript and styles), and Netzke-related files.
+Netzke-basepack is bundled with automated tests. To run them, you need to set up test/rails_app a similar way as you did with your own Rails app that is using Netzke, i.e.: 1) link Ext JS into the "public" folder, 2) link netzke-core into vendor/plugins, 3) run migrations and clone the development database structure into the test database.
 
-Now let's embed a widget into a view. The following example will provide you with a grid-based scaffold for ActiveRecord-model called Book. You may generate it like this:
+After this you may run (*from the netzke-basepack folder*):
 
-    ./script/generate model Book title:string amount:integer
+    cucumber features
+    
+and
 
-(don't forget to re-run the migrations after it)
+    rspec spec
 
-Now embed a widget into a view like this:
+== Testing playground
 
-  <%= netzke :books, :class_name => 'GridPanel', :model => 'Book' %>
+The test/rails_app application is also a convenient playground, as it may be run as independent Rails 3 app. After starting it, access any of the lib/netzke widgets by using the following url:
 
-For more examples, see http://netzke-demo.writelesscode.com
+    http://localhost:3000/components/<name of the component class>
+    
+e.g.:
 
+    http://localhost:3000/components/UserGrid
+    
 == Icons support
-Netzke-basepack supports FamFamFam Silk icon set (http://www.famfamfam.com/archive/silk-icons-thats-your-lot/). To enable it, download it and put the "icons" folder into your app's public/images folder. Then restart your application.
+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.
 
 == More info
-Introduction to Netzke framework and wiki: http://github.com/skozlov/netzke
-
-Twitter: http://twitter.com/skozlov
-
-Tutorials: http://blog.writelesscode.com
+Official project site: http://netzke.org
 
-Live-demo with sample code: http://netzke-demo.writelesscode.com
+Twitter (I try to only tweet about useful stuff): http://twitter.com/skozlov
 
-= Credentials
-Testing done with the help of http://github.com/pluginaweek/plugin_test_helper
+Many (if a bit outdated) tutorials: http://blog.writelesscode.com
 
 ---
 Copyright (c) 2008-2010 Sergei Kozlov, released under the MIT license

data/Rakefile

@@ -1,18 +1,18 @@
 begin
   require 'jeweler'
+  require './lib/netzke/basepack/version'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.version = "0.5.14"
+    gemspec.version = Netzke::Basepack::Version::STRING
     gemspec.name = "netzke-basepack"
-    gemspec.summary = "Pre-built Rails + ExtJS widgets for your RIA"
-    gemspec.description = "A set of full-featured extendible Netzke widgets (such as FormPanel, GridPanel, Window, BorderLayoutPanel, etc) which can be used as building block for your RIA"
+    gemspec.summary = "Pre-built Rails + ExtJS components for your RIA"
+    gemspec.description = "A set of full-featured extendible Netzke components (such as FormPanel, GridPanel, Window, BorderLayoutPanel, etc) which can be used as building block for your RIA"
     gemspec.email = "sergei@playcode.nl"
     gemspec.homepage = "http://github.com/skozlov/netzke-basepack"
-    gemspec.rubyforge_project = "netzke-basepack"
     gemspec.authors = ["Sergei Kozlov"]
-    gemspec.add_dependency("netzke-core", ">=0.5.5")
-    gemspec.add_dependency("searchlogic", ">=2.0.0")
-    gemspec.add_dependency("will_paginate", ">=2.0.0")
-    gemspec.add_dependency("acts_as_list", ">=0.1.2")
+    gemspec.add_dependency("netzke-core", "~>0.6.0")
+    gemspec.add_dependency("meta_where", ">=0.9.3")
+    gemspec.add_dependency("will_paginate", "~>3.0.pre2")
+    gemspec.add_dependency("acts_as_list")
     gemspec.post_install_message = <<-MESSAGE
 
 ========================================================================

data/TODO.rdoc

@@ -1,20 +1,15 @@
 == Priority
 * Solve the confusion about columns being stored in the persistent config
 * On grid refresh, reset the dirty fields, so that the "Apply" button doesn't do anything
+* DataAccessor#to_array should not rescue exceptions, but rather check the availability of the attributes; `respond_to_with_basepack?` should be extended to also return true for association columns
 * GridPanel's read_only vs editable (doesn't work now) options
-* Inclusion of css in a stand-alone widget
 * Find a way to print the grid nicely (along with the column and rows that don't fit on the screen)
-* Auto-include the ID column into GridPanel by default
 
 == Foolproof
-* Should not be possible delete the "ID" field from grids/forms
 * Should not be possible to put the "ID" field on any place but first for grids (otherwise record ID is not correct)
 
 == Optimizations
 * Check persistent_config-related queries (aren't they too many?)
 
-== Code design
-* Replace <tt>initial_late_aggregatees</tt> method with a set of methods for each aggregatee, so that more logic would be possible at the moment of on-demand aggregatee loading.
-
 == One day
 * Replace xcheckbox with checkbox in FormPanel

data/app/components/netzke/basepack/accordion_panel.rb

@@ -0,0 +1,37 @@
+module Netzke
+  module Basepack
+    # = AccordionPanel
+    # 
+    # A panel with the 'accordion' layout. Can lazily load its nested components. For example:
+    # 
+    #     netzke :my_accordion, :items => [{
+    #         :html => "I'm a simple Ext.Panel",
+    #         :title => "Panel One"
+    #       },{
+    #         :class_name => "SimplePanel",
+    #         :update_text => "Update for Panel Two",
+    #         :title => "Panel Two",
+    #         :lazy_loading => true
+    #       }]
+    class AccordionPanel < Netzke::Base
+      
+      include WrapLazyLoaded
+      
+      js_property :layout, 'accordion'
+    
+      js_method :init_component, <<-JS
+        function(params){
+          #{js_full_class_name}.superclass.initComponent.call(this);
+          this.items.each(function(item){
+            item.on('expand', function(i){
+              if (i.wrappedComponent && !i.items.first()) {
+                this.loadComponent({name: i.wrappedComponent, container: i.id});
+              }
+            }, this);
+          }, this);
+        }
+      JS
+      
+    end
+  end
+end

data/app/components/netzke/basepack/basic_app.rb

@@ -0,0 +1,267 @@
+module Netzke
+  module Basepack
+    # == BasicApp
+    # Basis for a Ext.Viewport-based application
+    #
+    # Features:
+    # * dynamic loading of components
+    # * browser history support (press the "Back"-button to go to the previously loaded component)
+    # * AJAX activity indicator
+    # * (TODO) authentification support
+    # * (TODO) masquerade support
+    class BasicApp < Base
+      
+      js_base_class "Ext.Viewport"
+      
+      js_property :layout, :border
+
+      def self.include_js
+        res = []
+        ext_examples = Netzke::Core.ext_location.join("examples")
+        res << ext_examples.join("ux/statusbar/StatusBar.js")
+        res << "#{File.dirname(__FILE__)}/basic_app/statusbar_ext.js"
+      end
+
+      class_attribute :logout_url
+      self.logout_url = "/logout"
+
+      config do
+        # In status bar we want to show what we are masquerading as
+        if session[:masq_user]
+          user = User.find(session[:masq_user])
+          masq = %Q{user "#{user.login}"}
+        elsif session[:masq_role]
+          role = Role.find(session[:masq_role])
+          masq = %Q{role "#{role.name}"}
+        elsif session[:masq_world]
+          masq = %Q{World}
+        end
+              
+        {
+          :items => [{
+            :id => 'main-panel',
+            :region => 'center',
+            :layout => 'fit'
+          },{
+            :id => 'main-toolbar',
+            :xtype => 'toolbar',
+            :region => 'north',
+            :height => 25,
+            :items => menu
+          },{
+            :id => 'main-statusbar',
+            :xtype => 'statusbar',
+            :region => 'south',
+            :height => 22,
+            :statusAlign => 'right',
+            :busyText => 'Busy...',
+            :default_text => masq.nil? ? "Ready #{"(config mode)" if session[:config_mode]}" : "Masquerading as #{masq}",
+            :default_icon_cls => ""
+          }]
+        }
+      end
+
+      js_method :init_component, <<-JS
+        function(){
+          #{js_full_class_name}.superclass.initComponent.call(this);
+
+          // If we are given a token, load the corresponding component, otherwise load the last loaded component
+          var currentToken = Ext.History.getToken();
+          if (currentToken != "") {
+            this.processHistory(currentToken);
+          } else {
+            var lastLoaded = this.initialConfig.componentToLoad; // passed from the server
+            if (lastLoaded) Ext.History.add(lastLoaded);
+          }
+
+          Ext.History.on('change', this.processHistory, this);
+        
+          // Setting the "busy" indicator for Ajax requests
+          Ext.Ajax.on('beforerequest', function(){this.findById('main-statusbar').showBusy()}, this);
+          Ext.Ajax.on('requestcomplete', function(){this.findById('main-statusbar').hideBusy()}, this);
+          Ext.Ajax.on('requestexception', function(){this.findById('main-statusbar').hideBusy()}, this);
+        
+          // Initialize history
+          Ext.History.init();
+        }
+      JS
+    
+      js_method :on_login, <<-JS
+        function(){
+          window.location = "/login"
+        }
+      JS
+    
+      js_method :on_logout, <<-JS
+        function(){
+          window.location = "#{logout_url}"
+        }
+      JS
+    
+      js_method :process_history, <<-JS
+        function(token){
+          if (token){
+            this.loadComponent({name:token, container:'main-panel'});
+          } else {
+            Ext.getCmp('main-panel').removeChild();
+          }
+        }
+      JS
+    
+      js_method :instantiate_component, <<-JS
+        function(config){
+          this.findById('main-panel').instantiateChild(config);
+        }
+      JS
+    
+      js_method :app_load_component, <<-JS
+        function(name){
+          Ext.History.add(name);
+        }
+      JS
+
+      js_method :load_component_by_action, <<-JS
+        function(action){
+          this.appLoadComponent(action.component || action.name);
+        }
+      JS
+
+      js_method :on_toggle_config_mode, <<-JS
+        function(params){
+          this.toggleConfigMode();
+        }
+      JS
+    
+      js_method :show_masquerade_selector, <<-JS
+        function(){
+          var w = new Ext.Window({
+    				title: 'Masquerade as',
+    				modal: true,
+    				width: Ext.lib.Dom.getViewWidth() * 0.6,
+            height: Ext.lib.Dom.getViewHeight() * 0.6,
+            layout: 'fit',
+    	      closeAction :'destroy',
+            buttons: [{
+              text: 'Select',
+              handler : function(){
+                if (role = w.getNetzkeComponent().masquerade.role) {
+                  Ext.Msg.confirm("Masquerading as a role", "Individual preferences for all users with this role will get overwritten as you make changes. Continue?", function(btn){
+                    if (btn === 'yes') {
+                      w.close();
+                    }
+                  });
+                } else {
+                  w.close();
+                }
+              },
+              scope:this
+            },{
+              text:'As World',
+              handler:function(){
+                Ext.Msg.confirm("Masquerading as World", "Caution! All settings that you will modify will be overwritten for all roles and all users. Are you sure you know what you're doing?", function(btn){
+                  if (btn === "yes") {
+                    this.masquerade = {world:true};
+                    w.close();
+                  }
+                }, this);
+              },
+              scope:this
+            },{
+              text:'No masquerading',
+              handler:function(){
+                this.masquerade = {};
+                w.close();
+              },
+              scope:this
+            },{
+              text:'Cancel',
+              handler:function(){
+                w.hide();
+              },
+              scope:this
+            }],
+            listeners : {close: {fn: function(){
+              this.masqueradeAs(this.masquerade || w.getNetzkeComponent().masquerade || {});
+            }, scope: this}}
+    			});
+
+    			w.show(null, function(){
+    			  this.loadComponent({id:"masqueradeSelector", container:w.id})
+    			}, this);
+
+        }
+      JS
+
+      # Set the Logout button if Netzke::Base.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
+        end
+        res
+      end
+
+      def user_menu
+        [:logout.action]
+      end
+
+      def initialize(*args)
+        super
+
+        if session[:netzke_just_logged_in] || session[:netzke_just_logged_out]
+          session[:config_mode] = false
+          session[:masq_world] = session[:masq_user] = session[:masq_roles] = nil
+        end
+
+        strong_children_config.deep_merge!(:mode => :config) if session[:config_mode]
+      end
+    
+    
+      action :masquerade_selector, :text => "Masquerade as ...", :handler => :show_masquerade_selector
+      
+      action :toggle_config_mode do 
+        {:text => "#{session[:config_mode] ? "Leave" : "Enter"} config mode"}
+      end
+      
+      action :login, :icon => :door_in
+      
+      action :logout, :icon => :door_out
+    
+      # Html required for Ext.History to work
+      def js_component_html
+        super << %Q{
+  <form id="history-form" class="x-hidden">
+      <input type="hidden" id="x-history-field" />
+      <iframe id="x-history-frame"></iframe>
+  </form>
+        }
+      end
+
+      #
+      # Interface section
+      #
+      endpoint :toggle_config_mode do |params|
+        session = Netzke::Base.session
+        session[:config_mode] = !session[:config_mode]
+        {:js => "window.location.reload();"}
+      end
+
+      endpoint :masquerade_as do |params|
+        session = Netzke::Base.session
+        session[:masq_world] = params[:world] == "true"
+        session[:masq_role] = params[:role].try(:to_i)
+        session[:masq_user] = params[:user].try(:to_i)
+        {:js => "window.location.reload();"}
+      end
+
+    end
+  end
+end