skozlov-netzke-basepack 0.1.0.1 → 0.1.1

data/CHANGELOG

@@ -1,3 +1,8 @@
+v0.1.1
+Cleaner exception handling while loading data to grid
+Column resize & move functionality enabled by default
+Column filters added
+
 v0.1.0.1 Meta work: replacing underscore with dash in the name
 
 v0.1.0 Initial release

data/Manifest

@@ -6,6 +6,7 @@ generators/netzke_basepack/USAGE
 init.rb
 install.rb
 javascripts/basepack.js
+javascripts/filters.js
 lib/app/models/netzke_grid_column.rb
 lib/netzke/accordion.rb
 lib/netzke/ar_ext.rb

data/javascripts/basepack.js

@@ -33,9 +33,20 @@ Ext.netzke.editors = {
 		})
 	},
 	
+	// TODO: it's simply a text field for now
 	datetime: function(c, config){
 		return new Ext.form.TextField({
 			selectOnFocus:true
 		})
 	}
+};
+
+// Mapping of showsAs field to grid filters
+Ext.netzke.filterMap = {
+	number_field:'Numeric',
+	text_field:'String',
+	datetime:'String',
+	checkbox:'Boolean',
+	combo_box:'String',
+	date:'Date'
 }

data/javascripts/filters.js

@@ -0,0 +1,7 @@
+Ext.menu.RangeMenu.prototype.icons = {
+  gt: '/extjs/examples/grid-filtering/img/greater_then.png', 
+  lt: '/extjs/examples/grid-filtering/img/less_then.png',
+  eq: '/extjs/examples/grid-filtering/img/equals.png'
+};
+
+Ext.grid.filter.StringFilter.prototype.icon = '/extjs/examples/grid-filtering/img/find.png';

data/lib/netzke-basepack.rb

@@ -11,4 +11,18 @@ require 'netzke/ar_ext'
   ActiveSupport::Dependencies.load_once_paths.delete(path)
 end
 
-Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
+# Include the javascript
+Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/basepack.js"
+
+# TODO: implement configurable loading of JS, to spare the traffic at the initial loading
+extjs_dir = "#{File.dirname(RAILS_ROOT)}/netzke_tutorial/public/extjs"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/EditableItem.js"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/menu/RangeMenu.js"
+Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/GridFilters.js"
+%w{Boolean Date List Numeric String}.unshift("").each do |f|
+  Netzke::Base.config[:javascripts] << "#{extjs_dir}/examples/grid-filtering/grid/filter/#{f}Filter.js"
+end
+Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/filters.js"
+
+# Make this plugin reloadable for easier development
+ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))

data/lib/netzke/grid.rb

@@ -18,8 +18,10 @@ module Netzke
 
     def initial_config
       {
-        :ext_config => {:properties => true},
-        :layout_manager => "NetzkeLayout"
+        :ext_config => {:properties => true, :column_filters => true},
+        :layout_manager => "NetzkeLayout",
+        :column_resize => true,
+        :column_move => true
       }
     end
 
@@ -54,20 +56,6 @@ module Netzke
       w.interface_load_source(params)
     end
     
-    # we pass column config at the time of instantiating the JS class
-    def js_config
-      res = super
-      res.merge!(:columns => get_columns || config[:columns]) # first try to get columns from DB, then from config
-      res.merge!(:data_class_name => config[:data_class_name])
-      res
-    end
-
-    def js_listeners
-      super.merge({
-        :columnresize => (config[:column_resize] ? {:fn => "this.onColumnResize".l, :scope => this} : nil),
-        :columnmove => (config[:column_move] ? {:fn => "this.onColumnMove".l, :scope => this} : nil)
-      })
-    end
 
 
     protected

data/lib/netzke/grid_interface.rb

@@ -95,9 +95,9 @@ module Netzke::GridInterface
   
   # get records
   def get_records(params)
-    conditions = normalize_params(params)
+    search_params = normalize_params(params)
     raise ArgumentError, "No data_class_name specified for widget '#{config[:name]}'" if !config[:data_class_name]
-    records = config[:data_class_name].constantize.all(conditions)
+    records = config[:data_class_name].constantize.all(search_params.clone) # clone needed as searchlogic removes :conditions key from the hash
     output_array = []
     records.each do |r|
       r_array = []
@@ -111,14 +111,39 @@ module Netzke::GridInterface
     class << output_array
       attr :total_records, true
     end
-    total_records_count = config[:data_class_name].constantize.count(conditions)
+    total_records_count = config[:data_class_name].constantize.count(search_params)
     output_array.total_records = total_records_count
 
     output_array
   end
   
+  def convert_filters(column_filter)
+    res = {}
+    column_filter.each_pair do |k,v|
+      field = v["field"]
+      case v["data"]["type"]
+      when "string"
+        field << "_contains"
+      when "numeric"
+        field << "_#{v["data"]["comparison"]}"
+      end
+      value = v["data"]["value"]
+      res.merge!({field => value})
+    end
+    res
+  end
+  
   # make params understandable to searchlogic
   def normalize_params(params)
+    # filters
+    conditions = params[:filter] && convert_filters(params[:filter])
+    
+    normalized_conditions = {}
+    conditions && conditions.each_pair do |k, v|
+      assoc, method = k.split('__')
+      normalized_conditions.merge!(method.nil? ? {assoc => v} : {assoc => {method => v}})
+    end
+    
     # sorting
     order_by = if params[:sort]
       assoc, method = params[:sort].split('__')
@@ -126,6 +151,6 @@ module Netzke::GridInterface
     end
     
     page = params[:start].to_i/params[:limit].to_i + 1 if params[:limit]
-    {:per_page => params[:limit], :page => page, :order_by => order_by, :order_as => params[:dir]}
+    {:per_page => params[:limit], :page => page, :order_by => order_by, :order_as => params[:dir], :conditions => normalized_conditions}
   end
 end

data/lib/netzke/grid_js_builder.rb

@@ -23,6 +23,7 @@ module Netzke::GridJsBuilder
       :track_mouse_over => true,
       # :bbar => "config.actions".l,
       :bbar => js_bbar,
+      :plugins => "plugins".l,
       
       #custom configs
       :auto_load_data => true
@@ -31,20 +32,22 @@ module Netzke::GridJsBuilder
   
   def js_before_constructor
     <<-JS
+    var plugins = [];
+  	if (!config.columns) this.feedback('No columns defined for grid '+config.id);
     this.recordConfig = [];
-
-  	if (!config.columns) {
-  	  this.feedback('No columns defined for grid '+config.id);
-	  }
-    
     Ext.each(config.columns, function(column){this.recordConfig.push({name:column.name})}, this);
     this.Row = Ext.data.Record.create(this.recordConfig);
+
     var ds = new Ext.data.Store({
         proxy: this.proxy = new Ext.data.HttpProxy({url:config.interface.getData}),
         reader: new Ext.data.ArrayReader({root: "data", totalProperty: "total", successProperty: "succes", id:0}, this.Row),
-        remoteSort: true
+        remoteSort: true,
+        listeners:{'loadexception':{
+          fn:this.loadExceptionHandler,
+          scope:this
+        }}
     });
-
+    
     this.cmConfig = [];
     Ext.each(config.columns, function(c){
       var editor = c.readOnly ? null : Ext.netzke.editors[c.showsAs](c, config);
@@ -62,41 +65,62 @@ module Netzke::GridJsBuilder
     var cm = new Ext.grid.ColumnModel(this.cmConfig);
     
     this.addEvents("refresh");
-  	
+    
+    // Filters
+    if (config.columnFilters) {
+      var filters = []
+      Ext.each(config.columns, function(c){
+        filters.push({type:Ext.netzke.filterMap[c.showsAs], dataIndex:c.name})
+      })
+    	var gridFilters = new Ext.grid.GridFilters({filters:filters});
+      plugins.push(gridFilters);
+    }
+    
     JS
   end
   
+  def js_config
+    res = super
+    # we pass column config at the time of instantiating the JS class
+    res.merge!(:columns => get_columns || config[:columns]) # first try to get columns from DB, then from config
+    res.merge!(:data_class_name => config[:data_class_name])
+    res
+  end
+
+  def js_listeners
+    super.merge({
+      :columnresize => (config[:column_resize] ? {:fn => "this.onColumnResize".l, :scope => this} : nil),
+      :columnmove => (config[:column_move] ? {:fn => "this.onColumnMove".l, :scope => this} : nil)
+    })
+  end
+  
+  
   def js_extend_properties
     {
       :on_widget_load => <<-JS.l,
         function(){
+          // auto-load
           if (this.initialConfig.autoLoadData) {
-            this.loadWithFeedback({start:0, limit: this.initialConfig.rowsPerPage})
+            // if we have a paging toolbar, load the first page, otherwise
+            if (this.getBottomToolbar().changePage) this.getBottomToolbar().changePage(0); else this.store.load();
           }
         }
       JS
-    
-      :load_with_feedback => <<-JS.l,
-        function(params){
-          if (!params) params = {};
-      	  var exceptionHandler = function(proxy, options, response, error){
-            if (response.status == 200 && (responseObject = Ext.decode(response.responseText)) && responseObject.flash){
-              this.feedback(responseObject.flash)
-            } else {
-              if (error){
-                this.feedback(error.message);
-              } else {
-                this.feedback(response.statusText)
-              }  
-            }
-          }.createDelegate(this);
-      	  this.store.proxy.on('loadexception', exceptionHandler);
-      		this.store.load({callback:function(r, options, success){
-      			this.store.proxy.un('loadexception', exceptionHandler);
-      		}, params: params, scope:this});
-      	}
-      JS
       
+      :load_exception_handler => <<-JS.l,
+      function(proxy, options, response, error){
+        if (response.status == 200 && (responseObject = Ext.decode(response.responseText)) && responseObject.flash){
+          this.feedback(responseObject.flash)
+        } else {
+          if (error){
+            this.feedback(error.message);
+          } else {
+            this.feedback(response.statusText)
+          }  
+        }
+      }        
+      JS
+    
       :add => <<-JS.l,
         function(){
           var rowConfig = {};
@@ -153,7 +177,8 @@ module Netzke::GridJsBuilder
             			params: {records: Ext.encode(records)},
             			success:function(r){ 
             				var m = Ext.decode(r.responseText);
-            				this.loadWithFeedback();
+            				this.store.reload();
+                    // this.loadWithFeedback();
             				this.feedback(m.flash);
             			},
             			scope:this
@@ -195,7 +220,8 @@ module Netzke::GridJsBuilder
         			success:function(response){
         				var m = Ext.decode(response.responseText);
         				if (m.success) {
-        					this.loadWithFeedback();
+        					this.store.reload();
+                  // this.loadWithFeedback();
         					this.store.commitChanges();
         					this.feedback(m.flash);
         				} else {
@@ -215,7 +241,8 @@ module Netzke::GridJsBuilder
       :refresh_click => <<-JS.l,
         function() {
           // console.info(this);
-          if (this.fireEvent('refresh', this) !== false) this.loadWithFeedback();
+          // if (this.fireEvent('refresh', this) !== false) this.loadWithFeedback();
+          if (this.fireEvent('refresh', this) !== false) this.store.reload();
         }
       JS
       

data/netzke-basepack.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-basepack}
-  s.version = "0.1.0.1"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2008-12-27}
+  s.date = %q{2008-12-28}
   s.description = %q{Base Netzke widgets - grid, form, tree, and more}
   s.email = %q{sergei@writelesscode.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/app/models/netzke_grid_column.rb", "lib/netzke/accordion.rb", "lib/netzke/ar_ext.rb", "lib/netzke/column.rb", "lib/netzke/container.rb", "lib/netzke/grid.rb", "lib/netzke/grid_interface.rb", "lib/netzke/grid_js_builder.rb", "lib/netzke/preference_grid.rb", "lib/netzke/properties_tool.rb", "lib/netzke/property_grid.rb", "lib/netzke-basepack.rb", "LICENSE", "README.mdown", "tasks/netzke_basepack_tasks.rake"]
-  s.files = ["CHANGELOG", "generators/netzke_basepack/netzke_basepack_generator.rb", "generators/netzke_basepack/netzke_grid_generator.rb", "generators/netzke_basepack/templates/create_netzke_grid_columns.rb", "generators/netzke_basepack/USAGE", "init.rb", "install.rb", "javascripts/basepack.js", "lib/app/models/netzke_grid_column.rb", "lib/netzke/accordion.rb", "lib/netzke/ar_ext.rb", "lib/netzke/column.rb", "lib/netzke/container.rb", "lib/netzke/grid.rb", "lib/netzke/grid_interface.rb", "lib/netzke/grid_js_builder.rb", "lib/netzke/preference_grid.rb", "lib/netzke/properties_tool.rb", "lib/netzke/property_grid.rb", "lib/netzke-basepack.rb", "LICENSE", "Manifest", "netzke-basepack.gemspec", "Rakefile", "README.mdown", "tasks/netzke_basepack_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/app/models/book.rb", "test/app_root/app/models/category.rb", "test/app_root/app/models/city.rb", "test/app_root/app/models/continent.rb", "test/app_root/app/models/country.rb", "test/app_root/app/models/genre.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/db/migrate/20081222033343_create_books.rb", "test/app_root/db/migrate/20081222033440_create_genres.rb", "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb", "test/app_root/db/migrate/20081223024935_create_categories.rb", "test/app_root/db/migrate/20081223025635_create_countries.rb", "test/app_root/db/migrate/20081223025653_create_continents.rb", "test/app_root/db/migrate/20081223025732_create_cities.rb", "test/app_root/script/console", "test/ar_ext_test.rb", "test/column_test.rb", "test/console_with_fixtures.rb", "test/fixtures/books.yml", "test/fixtures/categories.yml", "test/fixtures/cities.yml", "test/fixtures/continents.yml", "test/fixtures/countries.yml", "test/fixtures/genres.yml", "test/grid_test.rb", "test/netzke_basepack_test.rb", "test/schema.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.files = ["CHANGELOG", "generators/netzke_basepack/netzke_basepack_generator.rb", "generators/netzke_basepack/netzke_grid_generator.rb", "generators/netzke_basepack/templates/create_netzke_grid_columns.rb", "generators/netzke_basepack/USAGE", "init.rb", "install.rb", "javascripts/basepack.js", "javascripts/filters.js", "lib/app/models/netzke_grid_column.rb", "lib/netzke/accordion.rb", "lib/netzke/ar_ext.rb", "lib/netzke/column.rb", "lib/netzke/container.rb", "lib/netzke/grid.rb", "lib/netzke/grid_interface.rb", "lib/netzke/grid_js_builder.rb", "lib/netzke/preference_grid.rb", "lib/netzke/properties_tool.rb", "lib/netzke/property_grid.rb", "lib/netzke-basepack.rb", "LICENSE", "Manifest", "netzke-basepack.gemspec", "Rakefile", "README.mdown", "tasks/netzke_basepack_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/app/models/book.rb", "test/app_root/app/models/category.rb", "test/app_root/app/models/city.rb", "test/app_root/app/models/continent.rb", "test/app_root/app/models/country.rb", "test/app_root/app/models/genre.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/db/migrate/20081222033343_create_books.rb", "test/app_root/db/migrate/20081222033440_create_genres.rb", "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb", "test/app_root/db/migrate/20081223024935_create_categories.rb", "test/app_root/db/migrate/20081223025635_create_countries.rb", "test/app_root/db/migrate/20081223025653_create_continents.rb", "test/app_root/db/migrate/20081223025732_create_cities.rb", "test/app_root/script/console", "test/ar_ext_test.rb", "test/column_test.rb", "test/console_with_fixtures.rb", "test/fixtures/books.yml", "test/fixtures/categories.yml", "test/fixtures/cities.yml", "test/fixtures/continents.yml", "test/fixtures/countries.yml", "test/fixtures/genres.yml", "test/grid_test.rb", "test/netzke_basepack_test.rb", "test/schema.rb", "test/test_helper.rb", "uninstall.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://writelesscode.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netzke-basepack", "--main", "README.mdown"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: skozlov-netzke-basepack
 version: !ruby/object:Gem::Version 
-  version: 0.1.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-27 00:00:00 -08:00
+date: 2008-12-28 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,6 +77,7 @@ files:
 - init.rb
 - install.rb
 - javascripts/basepack.js
+- javascripts/filters.js
 - lib/app/models/netzke_grid_column.rb
 - lib/netzke/accordion.rb
 - lib/netzke/ar_ext.rb