netzke-basepack 0.7.7 → 0.8.0

data/LICENSE

@@ -1 +1,7 @@
-Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license
+Copyright (c) 2012 nomadcoder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,12 +1,28 @@
-# Netzke Basepack
+# Netzke Basepack [![Build Status](https://secure.travis-ci.org/nomadcoder/netzke-basepack.png?branch=master)](http://travis-ci.org/nomadcoder/netzke-basepack) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/netzke/netzke-basepack)
 
-A pack of pre-built [Netzke](http://netzke.org) components - such as grid, form, tab panel, etc.
+[RDocs](http://rdoc.info/github/netzke/netzke-basepack)
+
+A pack of pre-built [Netzke](http://netzke.org) components that can be used as building blocks for your webapps.
+
+## Included components
+
+Basepack includes the following components:
+
+* [Grid](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Grid) - a grid panel with a thick bag of features
+* [Form](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Form) - a form panel with automatic binding of fields
+* [TabPanel](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/TabPanel) - a tab panel with support for lazy loading of nested components
+* [Accordion](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Accordion) - an accordion panel with support for lazy loading of nested components
+* [Window](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/Window) - a window which stores its size, position, and maximized state
+
+Besides, Basepack implements persistence of region sizes and collapsed states of an arbitrary component that uses [border layout](http://docs.sencha.com/ext-js/4-1/#!/api/Ext.layout.container.Border) (see [ItemPersistence](http://rdoc.info/github/netzke/netzke-basepack/Netzke/Basepack/ItemPersistence)).
+
+For more pre-built components refer to [Netzke Community-pack](https://github.com/netzke/netzke-communitypack).
 
 ## Requirements
 
-* Ruby 1.9.2
-* Rails ~> 3.1.0
-* Ext JS ~> 4.1.x
+* Ruby ~> 1.9.2
+* Rails ~> 3.2.0
+* Ext JS ~> 4.1.0
 
 ## Installation
 
@@ -16,79 +32,54 @@ In your Gemfile:
 
 For the "edge" stuff, tell bundler to get the gem straight from GitHub:
 
-    gem 'netzke-basepack', :git => "git://github.com/nomadcoder/netzke-basepack.git"
+    gem 'netzke-basepack', :git => "git://github.com/netzke/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/basepack_test_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/nomadcoder/netzke-core/wiki/Automated-testing).
+```erb
+<%= netzke :books, :class_name => 'Netzke::Basepack::Grid', :model => 'Book' %>
+```
 
-Besides, the bundled test application is a convenient [playground](https://github.com/nomadcoder/netzke-core/wiki/Playground) for those who search to experiment with the framework.
+For more examples, see http://netzke-demo.herokuapp.com ([source code](https://github.com/netzke/netzke-demo)), and look into `test/basepack_test_app`.
 
-After starting up the test app, you can see the list of functional test components on the index page (along with links to the source code):
+## Running tests
 
-    http://localhost:3000/
+The bundled `test/basepack_test_app` application used for automated testing can be easily run as a stand-alone Rails app. It's a good source of concise, focused examples. After starting the application, access any of the test components (located in `app/components`) by using the following url:
 
-## Note on testing with DataMapper/Sequel Support
-To install the test app with DataMapper or Sequel, put ORM=dm or ORM=sq
-into your environment.
-For example to set-up DataMapper support run
+    http://localhost:3000/components/{name of the component's class}
 
-    # in test/basepack_test_app
-    ORM=dm bundle install
+For example [http://localhost:3000/components/BookGrid](http://localhost:3000/components/BookGrid)
 
-To run the test app in DataMapper-Mode (will use DataMapper models instead of ActiveRecord models)
+Also, you can see the list of test components on the index page (along with links to the source code):
 
-    # in test/basepack_test_app
-    ORM=dm rails s
+    http://localhost:3000/
 
-To run the test suite
+Before being able run the test app and the tests themselves, you must link your Ext JS library to `test/basepack_test_app/public`, e.g. (from the gems's root):
 
-    # in test/basepack_test_app
-    ORM=dm bundle exec rake
+    $ ln -s ~/code/sencha/ext-4.1.1 test/basepack_test_app/public/extjs
 
-etc.
+For cucumber tests (from `test/basepack_test_app`):
 
-NOTE: netzke-basepack is not dependant on neither DataMapper nor Sequel.  It will pick the right DataAdapter for your models automatically.
-ActiveRecord is still included in Gemfile of the test app, as netzke-persistance is used which uses ActiveRecord.
-If you don't use netzke-persistence, then you don't need to include ActiveRecord.
+    $ cucumber features
 
-## DataMapper support
-DataMapper support is *incomplete*, as I didn't find a good way to sort by an association's column when the association needs a LEFT OUTER JOIN (i.e. nullable foreign key in many_to_one).
+## Using ORM other than ActiveRecord
 
-## Sequel support
+Using ActiveRecord as its default ORM, Basepack is designed to be extendable with data adapters for other ORMs. If you're thinking about implementing an adapter, `AbstractAdapter` and `ActiveRecordAdapter` classes can be used as a reference.
 
-CAVEATS:
-  - you can't use polymorphic associations for the time being, as the sequel_polymorphic plugin is not supported by netzke-basepack
-  - SearchPanel is broken atm. When it's fixed, Sequel support for
-    SearchPanel triggered queries should be implemented.
+There's some work being done in the direction of implementing [DataMapper](https://github.com/nomadcoder/netzke-basepack-dm) and [Sequel](https://github.com/nomadcoder/netzke-basepack-sequel) adapters, but at this moment the code is broken.
 
 ## 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 tweets on osx, productivity and what not:  http://twitter.com/nomadcoder
+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.
 
-Many (if a bit outdated) tutorials: http://blog.writelesscode.com
+## Useful links
+* [Project website](http://netzke.org)
+* [Live-demo](http://netzke-demo.herokuapp.com)
+* [Twitter](http://twitter.com/netzke) - latest news about the framework
 
 ---
-Copyright (c) 2008-2011 NomadCoder, released under the MIT license
-Note, that Ext JS itself is licensed [differently](http://www.sencha.com/products/extjs/license/)
+Copyright (c) 2008-2012 [nomadcoder](https://twitter.com/nomadcoder), released under the MIT license (see LICENSE).
+
+**Note** that Ext JS is licensed [differently](http://www.sencha.com/products/extjs/license/), and you may need to purchase a commercial license in order to use it in your projects!

data/Rakefile

@@ -4,12 +4,12 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.version = Netzke::Basepack::Version::STRING
     gemspec.name = "netzke-basepack"
-    gemspec.summary = "Pre-built Netzke for your RIA"
-    gemspec.description = "A set of full-featured extendible Netzke components (such as FormPanel, GridPanel, Window, etc) which can be used as building block for your RIA"
+    gemspec.summary = "Pre-built Netzke components"
+    gemspec.description = "A set of feature-rich extendible Netzke components (such as Form, Grid, Window, TabPanel, etc) which can be used as building block for your RIA"
     gemspec.email = "nmcoder@gmail.com"
     gemspec.homepage = "http://netzke.org"
+    gemspec.add_dependency("netzke-core",   "~>0.8.0")
     gemspec.authors = ["nomadcoder"]
-    gemspec.add_dependency("netzke-core",   "~>0.7.7")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -32,13 +32,13 @@ begin
 
   namespace :yard do
     desc "Publish docs to api.netzke.org"
-    task :publish => :yard do
+    task publish: :yard do
       dir = 'www/api.netzke.org/basepack'
       puts "Publishing to fl:#{dir}..."
       `ssh fl "mkdir -p #{dir}"`
       `scp -r doc/* fl:#{dir}`
     end
   end
-rescue LoadError
+rescue
   puts "To enable yard do 'gem install yard'"
 end

data/config/before-travis.sh

@@ -0,0 +1,10 @@
+# Start xvfb in preparation for cucumber
+sh -e /etc/init.d/xvfb start
+
+# fetch extjs
+wget http://cdn.sencha.io/ext-4.1.1a-gpl.zip
+unzip -q -d test/basepack_test_app/public/ -n ext-4.1.1a-gpl.zip
+mv test/basepack_test_app/public/ext-4.1.1a test/basepack_test_app/public/extjs
+
+# cp db configuration
+cp test/basepack_test_app/config/database.yml.travis  test/basepack_test_app/config/database.yml

data/javascripts/basepack.js

@@ -2,143 +2,13 @@ Ext.ns("Netzke.pre");
 Ext.ns("Netzke.pre.Basepack");
 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
-//   }
-// });
-
-// ComboBox that gets options from the server (used in both grids and panels)
-Ext.define('Ext.netzke.ComboBox', {
-  extend        : 'Ext.form.field.ComboBox',
-  alias         : 'widget.netzkeremotecombo',
-  valueField    : 'value',
-  displayField  : 'text',
-  triggerAction : 'all',
-  // WIP: Breaking - should not be 'true' if combobox is not editable
-  // typeAhead     : true,
-
-  // getDisplayValue: function() {
-  //   return this.getValue() == 0 ? this.emptyText : this.callOverridden();
-  // },
-
-  initComponent : function(){
-    var modelName = this.parentId + "_" + this.name;
-
-    if (this.blankLine == undefined) this.blankLine = "---";
-
-    Ext.define(modelName, {
-        extend: 'Ext.data.Model',
-        fields: ['value', 'text']
-    });
-
-    var store = new Ext.data.Store({
-      model: modelName,
-      proxy: {
-        type: 'direct',
-        directFn: Netzke.providers[this.parentId].getComboboxOptions,
-        reader: {
-          type: 'array',
-          root: 'data'
-        }
-      }
-    });
-
-    store.on('beforeload', function(self, params) {
-      params.params.column = this.name;
-    },this);
-
-    // insert a selectable "blank line" which allows to remove the associated record
-    if (this.blankLine) {
-      store.on('load', function(self, params) {
-        // append a selectable "empty line" which will allow remove the association
-        self.add(Ext.create(modelName, {value: -1, text: this.blankLine}));
-      }, this);
-    }
-
-    // If inline data was passed (TODO: is this actually working?)
-    if (this.store) store.loadData({data: this.store});
-
-    this.store = store;
-
-    this.callParent();
-  },
-
-});
-
 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"
-//     }
-//   }
-//
-//   ,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
 });
-
-// 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';
-  }
-});

data/javascripts/netzkeremotecombo.js

@@ -0,0 +1,59 @@
+// ComboBox that gets options from the server (used in both grids and panels)
+Ext.define('Ext.netzke.ComboBox', {
+  extend        : 'Ext.form.field.ComboBox',
+  alias         : 'widget.netzkeremotecombo',
+  valueField    : 'value',
+  displayField  : 'text',
+  triggerAction : 'all',
+  forceSelection: true,
+
+  // WIP: Breaking - should not be 'true' if combobox is not editable
+  // typeAhead     : true,
+
+  // getDisplayValue: function() {
+  //   return this.getValue() == 0 ? this.emptyText : this.callOverridden();
+  // },
+
+  initComponent : function(){
+    var modelName = this.parentId + "_" + this.name;
+
+    if (this.blankLine == undefined) this.blankLine = "---";
+
+    Ext.define(modelName, {
+        extend: 'Ext.data.Model',
+        fields: ['value', 'text']
+    });
+
+    var store = new Ext.data.Store({
+      model: modelName,
+      proxy: {
+        type: 'direct',
+        directFn: Netzke.providers[this.parentId].getComboboxOptions,
+        reader: {
+          type: 'array',
+          root: 'data'
+        }
+      }
+    });
+
+    store.on('beforeload', function(self, params) {
+      params.params.attr = this.name;
+    },this);
+
+    // insert a selectable "blank line" which allows to remove the associated record
+    if (this.blankLine) {
+      store.on('load', function(self, params) {
+        // append a selectable "empty line" which will allow remove the association
+        self.add(Ext.create(modelName, {value: -1, text: this.blankLine}));
+      }, this);
+    }
+
+    // If inline data was passed (TODO: is this actually working?)
+    if (this.store) store.loadData({data: this.store});
+
+    this.store = store;
+
+    this.callParent();
+  },
+
+});

data/lib/netzke/basepack.rb

@@ -1,19 +1,13 @@
 require 'netzke/basepack/version'
 
+require 'netzke/basepack/data_adapters/abstract_adapter'
+
 if defined? ActiveRecord
-  require 'netzke/active_record'
-end
-if defined? DataMapper
-  require 'netzke/data_mapper'
-end
-if defined? Sequel
-  require 'netzke/sequel'
+  require 'netzke/basepack/active_record'
+  require 'netzke/basepack/data_adapters/active_record_adapter'
 end
 
-require 'netzke/basepack/data_adapters/abstract_adapter'
-require 'netzke/basepack/data_adapters/active_record_adapter' if defined? ActiveRecord
-require 'netzke/basepack/data_adapters/data_mapper_adapter' if defined? DataMapper
-require 'netzke/basepack/data_adapters/sequel_adapter' if defined? Sequel
+require 'netzke/basepack/item_persistence'
 
 module Netzke
   module Basepack
@@ -25,13 +19,14 @@ module Netzke
 
       # Called from netzke-basepack.rb
       def init
-        Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/xdatetime.js"
-        Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/basepack.js"
+        %w[netzkeremotecombo xdatetime basepack].each do |name|
+          Netzke::Core.ext_javascripts << "#{File.dirname(__FILE__)}/../../javascripts/#{name}.js"
+        end
 
         Netzke::Core.ext_stylesheets << "#{File.dirname(__FILE__)}/../../stylesheets/basepack.css"
       end
 
-      # Use it to confirure Basepack in the initializers, e.g.:
+      # Use this to confirure Basepack in the initializers, e.g.:
       #
       #     Netzke::Basepack.setup do |config|
       #       config.icons_uri = "/images/famfamfam/icons"

data/lib/netzke/basepack/accordion.rb

@@ -0,0 +1,45 @@
+module Netzke
+  module Basepack
+    # A panel with the 'accordion' layout. By default, lazily loads its nested components. For example:
+    #
+    #   class MyAccordion < Netzke::Basepack::Accordion
+    #     def configure(c)
+    #       super
+    #       c.items = [{
+    #         # just an Ext panel
+    #         :html => "I'm a simple Ext.Panel",
+    #         :title => "Panel One"
+    #       },{
+    #         # a Netzke component
+    #         :component => :my_component,
+    #         :title => "Panel Two"
+    #       }]
+    #     end
+    #
+    #     component :my_component
+    #   end
+    class Accordion < Netzke::Base
+
+      include WrapLazyLoaded
+
+      js_configure do |c|
+        c.layout = :accordion
+
+        c.init_component = <<-JS
+          function(params){
+            this.callParent();
+            this.items.each(function(item){
+              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.netzkeLoadComponent(i.wrappedComponent, {container: i.id, callback: function(){i.beingLoaded = false}});
+                }
+              }, this);
+            }, this);
+          }
+        JS
+      end
+
+    end
+  end
+end