netzke-basepack 0.6.0 → 0.6.1

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+= v0.6.1 - 2010-11-04
+* enhancements
+  * BorderLayoutPanel persistence: remembers region sizes and collapsed/expanded states
+  * tooltips for grid buttons
+  
+* bug fix
+  * auto-detection of association's method when the latter is virtual was broken in 1.9.2
+
 = v0.6.0 - 2010-10-24
 * netzke-core 0.6.0 compatibility, thorough refactoring
 * Much more thorough testing (cucumber and rspec)
@@ -6,12 +14,12 @@
 
 * 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  
+  * FormPanel allows for arbitrary layout of fields
 
 = v0.5.14 - 2010-09-08
 * bug fix
@@ -31,11 +39,11 @@
 = v0.5.13 - 2010-08-11
 * regression
   * combobox options configuration again has effect
-  
+
 * bug fix
   * when a TabPanel was used as a standalone widget, the first tab was rendered empty
   * Grid/FormPanel: dynamically changing of columns doesn't erase those column settings that are not configurable via GUI, but which were specified in the code
-  
+
 * enhancements
   * scopes can now be specified for an association combobox in Grid/FormPanels
   * GridPanel: you can now configure add/edit/multi_edit/search panels (e.g. to override the fields) and corresponding windows (e.g. to override the title)
@@ -304,7 +312,7 @@
 * Column resize & move functionality enabled by default
 * Column filters added
 
-= v0.1.0.1 
+= v0.1.0.1
 * Meta work: replacing underscore with dash in the name
 
 = v0.1.0 - 2008-12-20

data/README.rdoc

@@ -3,46 +3,31 @@
 A pack of pre-built Netzke components, such as grid, form, tab panel, etc.
 Learn about Netzke on http://netzke.org.
 
-== Prerequisites
+== Requirements
 
-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):
+* Ruby 1.9.2 (1.8.7 may work, too)
+* Rails >= 3.0.0
+* Ext JS >= 3.3.0
 
-    ln -s ~/code/sencha/extjs/ext-3.3.0 public/extjs
+== Installation
 
-= Installation
+In your Gemfile:
 
-For the latest ("edge") stuff, install as plugin:
+    gem 'netzke-basepack'
 
-    rails plugin install git://github.com/skozlov/netzke-basepack.git
-    
-Or tell bundler to get the gem straight from github:
+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
 
-Add Netzke routes (in routes.rb):
+Read the "Embedding components into Rails views" section on http://github.com/skozlov/netzke-core
 
-    # in routes.rb
-    RailsApp::Application.routes.draw do
-      netzke
-      ...
-    end
-
-== Embedding components into Rails' view
-
-Before you can use Netzke components in Rails' views, you need to add the following helper into your layout template, inside the "head" tag:
-
-    <%= netzke_init %>
-    
-This will include both ExtJS-related files (JavaScript and styles), and Netzke-related files.
-
-To embed a component into a view, use the +netzke+ helper, e.g.:
+Embed a basepack component into a view as any other Netzke component, e.g.:
 
   <%= netzke :books, :class_name => 'Basepack::GridPanel', :model => 'Book' %>
-  
-(assuming the existence of model 'Book')
+
+(assuming model 'Book' exists)
 
 For more examples, see http://demo.netzke.com, and look into test/rails_app
 
@@ -53,7 +38,7 @@ Netzke-basepack is bundled with automated tests. To run them, you need to set up
 After this you may run (*from the netzke-basepack folder*):
 
     cucumber features
-    
+
 and
 
     rspec spec
@@ -63,18 +48,18 @@ and
 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:
 
     http://localhost:3000/components/<name of the 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.
 
 == More info
 Official project site: http://netzke.org
 
-Twitter (I try to only tweet about useful stuff): http://twitter.com/skozlov
+Twitter (latest news about Netzke): http://twitter.com/skozlov
 
 Many (if a bit outdated) tutorials: http://blog.writelesscode.com
 

data/Rakefile

@@ -7,9 +7,9 @@ begin
     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.homepage = "http://netzke.org"
     gemspec.authors = ["Sergei Kozlov"]
-    gemspec.add_dependency("netzke-core", "~>0.6.0")
+    gemspec.add_dependency("netzke-core", "~>0.6.2")
     gemspec.add_dependency("meta_where", ">=0.9.3")
     gemspec.add_dependency("will_paginate", "~>3.0.pre2")
     gemspec.add_dependency("acts_as_list")
@@ -18,8 +18,8 @@ begin
 ========================================================================
 
            Thanks for installing Netzke Basepack!
-           
-  Don't forget to run "./script/generate netzke_basepack" for each 
+
+  Don't forget to run "./script/generate netzke_basepack" for each
   Rails app that will be using this gem.
 
   Netzke home page:     http://netzke.org
@@ -29,30 +29,36 @@ begin
 ========================================================================
 
     MESSAGE
-    
+
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  require './lib/netzke/basepack/version'
+  version = Netzke::Basepack::Version::STRING
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "netzke-basepack #{version}"
+  # rdoc.main = "README.rdoc"
   rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('CHANGELOG*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
+namespace :rdoc do
+  desc "Publish rdocs"
+  task :publish => :rdoc do
+    `scp -r rdoc/* fl:www/api.netzke.org/basepack`
+  end
+end

data/TODO.rdoc

@@ -1,5 +1,5 @@
 == Priority
-* Solve the confusion about columns being stored in the persistent config
+* Fix :meta => true config in columns work
 * 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

data/app/models/netzke_field_list.rb

@@ -20,7 +20,7 @@ class NetzkeFieldList < ActiveRecord::Base
     end
     update_attribute(:value, list.to_json)
   end
-  
+
   def append_attr(attr_hash)
     list = ActiveSupport::JSON.decode(self.value)
     list << attr_hash
@@ -41,7 +41,7 @@ class NetzkeFieldList < ActiveRecord::Base
       []
     end
   end
-  
+
   def self.find_all_lists_under_current_authority(model_name)
     authority_level, authority_id = Netzke::Base.authority_level
     case authority_level
@@ -59,11 +59,11 @@ class NetzkeFieldList < ActiveRecord::Base
     else
       []
     end
-    
+
   end
-  
-  
-  # Replaces the list with the data - only for the list found for the current authority. 
+
+
+  # Replaces the list with the data - only for the list found for the current authority.
   # If the list is not found, it's created.
   def self.update_list_for_current_authority(pref_name, data, model_name = nil)
     pref = find_or_create_pref_to_read(pref_name)
@@ -71,21 +71,21 @@ class NetzkeFieldList < ActiveRecord::Base
     pref.model_name = model_name
     pref.save!
   end
-  
+
 
   # If the <tt>model</tt> param is provided, then this preference will be assigned a parent preference
   # that configures the attributes for that model. This way we can track all preferences related to a model.
   def self.write_list(name, list, model = nil)
     pref_to_store_the_list = self.pref_to_write(name)
     pref_to_store_the_list.try(:update_attribute, :value, list.to_json)
-    
+
     # link this preference to the parent that contains default attributes for the same model
     if model
       model_level_attrs_pref = self.pref_to_read("#{model.tableize}_model_attrs")
       model_level_attrs_pref.children << pref_to_store_the_list if model_level_attrs_pref && pref_to_store_the_list
     end
   end
-  
+
   def self.read_list(name)
     json_encoded_value = self.pref_to_read(name).try(:value)
     ActiveSupport::JSON.decode(json_encoded_value).map(&:symbolize_keys) if json_encoded_value
@@ -96,26 +96,26 @@ class NetzkeFieldList < ActiveRecord::Base
   #   read_list(model_name)
   #   # read_list("#{model.tableize}_model_attrs")
   # end
-  
+
   # Write model-level attrs
   # def self.write_attrs_for_model(model_name, data)
   #   # write_list("#{model_name.tableize}_model_attrs", data)
   #   write_list(model_name, data)
   # end
-  
+
   # Options:
   # :attr - attribute to propagate. If not specified, all attrs found in configuration for the model
   # will be propagated.
   def self.update_children_on_attr(model, options = {})
     attr_name = options[:attr].try(:to_s)
-    
+
     parent_pref = pref_to_read("#{model.tableize}_model_attrs")
-    
+
     if parent_pref
       parent_list = ActiveSupport::JSON.decode(parent_pref.value)
       parent_pref.children.each do |ch|
         child_list = ActiveSupport::JSON.decode(ch.value)
-        
+
         if attr_name
           # propagate a certain attribute
           propagate_attr(attr_name, parent_list, child_list)
@@ -124,12 +124,12 @@ class NetzkeFieldList < ActiveRecord::Base
           all_attrs = parent_list.first.try(:keys)
           all_attrs && all_attrs.each{ |attr_name| propagate_attr(attr_name, parent_list, child_list) }
         end
-        
+
         ch.update_attribute(:value, child_list.to_json)
       end
     end
   end
-  
+
   # meta_attrs:
   #   {"city"=>{"included"=>true}, "building_number"=>{"default_value"=>100}}
   def self.update_children(model, meta_attrs)
@@ -139,26 +139,26 @@ class NetzkeFieldList < ActiveRecord::Base
     if parent_pref
       parent_pref.children.each do |ch|
         child_list = ActiveSupport::JSON.decode(ch.value)
-        
+
         meta_attrs.each_pair do |k,v|
           child_list.detect{ |child_attr| child_attr["name"] == k }.try(:merge!, v)
         end
-        
+
         ch.update_attribute(:value, child_list.to_json)
       end
     end
   end
 
   private
-  
+
     def self.propagate_attr(attr_name, src_list, dest_list)
       for src_field in src_list
         dest_field = dest_list.detect{ |df| df["name"] == src_field["name"] }
         dest_field[attr_name] = src_field[attr_name] if dest_field && src_field[attr_name]
       end
     end
-  
-    # Overwrite pref_to_read, pref_to_write methods, and find_all_for_component if you want a different way of 
+
+    # Overwrite pref_to_read, pref_to_write methods, and find_all_for_component if you want a different way of
     # identifying the proper preference based on your own authorization strategy.
     #
     # The default strategy is:
@@ -168,12 +168,12 @@ class NetzkeFieldList < ActiveRecord::Base
     #   2) if masq_user or masq_role is defined
     #     pref_to_read and pref_to_write will always take the masquerade into account, e.g. reads/writes will go to
     #     the user/role specified
-    #   
+    #
     def self.pref_to_read(name)
       name = name.to_s
       session = Netzke::Base.session
       cond = {:name => name}
-    
+
       if session[:masq_user]
         # first, get the prefs for this user it they exist
         res = self.find(:first, :conditions => cond.merge({:user_id => session[:masq_user]}))
@@ -200,17 +200,17 @@ class NetzkeFieldList < ActiveRecord::Base
       else
         res = self.find(:first, :conditions => cond)
       end
-    
-      res      
+
+      res
     end
-    
+
     def self.find_or_create_pref_to_read(name)
       name = name.to_s
       attrs = {:name => name}
       extend_attrs_for_current_authority(attrs)
       self.first(:conditions => attrs) || self.new(attrs)
     end
-    
+
     def self.extend_attrs_for_current_authority(hsh)
       authority_level, authority_id = Netzke::Base.authority_level
       case authority_level
@@ -224,12 +224,12 @@ class NetzkeFieldList < ActiveRecord::Base
         hsh.merge!(:user_id => authority_id)
       end
     end
-  
+
     def self.pref_to_write(name)
       name = name.to_s
       session = Netzke::Base.session
       cond = {:name => name}
-    
+
       if session[:masq_user]
         cond.merge!({:user_id => session[:masq_user]})
         # first, try to find the preference for masq_user

data/app/models/netzke_model_attr_list.rb

@@ -2,20 +2,20 @@
 # Is used to configure attributes in the layer between a model and its representation in the Netzke application, thus providing default attributes
 # for grids and panels.
 class NetzkeModelAttrList < NetzkeFieldList
-  
+
   # Updates attributes for all lists owned by owner_id and below the current authority level
   def self.update_fields(owner_id, attrs_hash)
     super
-    
+
     NetzkeFieldList.find_all_lists_under_current_authority(owner_id).each do |list|
       list.update_attrs(attrs_hash)
     end
   end
-  
+
   def self.add_attrs(attrs)
     NetzkeFieldList.find_all_lists_under_current_authority(owner_id).each do |list|
       attrs.each{ |attr_hash| list.append_attr(attr_hash) }
     end
   end
-  
+
 end

data/app/models/netzke_persistent_array_auto_model.rb

@@ -1,17 +1,17 @@
 require 'acts_as_list'
 class NetzkePersistentArrayAutoModel < ActiveRecord::Base
   set_table_name "netzke_temp_table"
-  connection.create_table(table_name){} if !connection.table_exists?(table_name)  
+  connection.create_table(table_name){} if !connection.table_exists?(table_name)
 
   acts_as_list
   default_scope :order => "position"
 
   cattr_accessor :config
-  
+
   def self.all_columns
     self.all.map{ |c| c.attributes.reject{ |k,v| k == 'id' || k == 'position' } }
   end
-  
+
   # Configuration
   def self.configure(config)
     self.config = config
@@ -20,7 +20,7 @@ class NetzkePersistentArrayAutoModel < ActiveRecord::Base
     end
     NetzkePreference.find_or_create_by_name("netzke_persistent_array_refresh_token").update_attribute(:value, refresh_token)
   end
-  
+
   def self.rebuild_table#(config)
     connection.drop_table(table_name) if connection.table_exists?(table_name)
     # create the table with the fields
@@ -36,23 +36,23 @@ class NetzkePersistentArrayAutoModel < ActiveRecord::Base
     # self.create config[:initial_data]
     self.replace_data(config[:initial_data])
   end
-  
+
   def self.replace_data(data)
     # only select those attributes that were provided to us as columns. The rest is ignored.
     column_names = config[:columns].map{ |c| c[:name] }
-    clean_data = data.collect{ |c| c.reject{ |k,v| !column_names.include?(k.to_s) } } 
+    clean_data = data.collect{ |c| c.reject{ |k,v| !column_names.include?(k.to_s) } }
     Rails.logger.debug "!!! clean_data: #{clean_data.inspect}\n"
     self.delete_all
     self.create(clean_data)
   end
-  
+
   private
-  
+
     def self.refresh_token
       @@refresh_token ||= begin
         session = Netzke::Base.session
         config[:owner] + (session[:masq_user] || session[:masq_role] || session[:masq_world] || session[:netzke_user_id]).to_s
       end
     end
-  
+
 end