datagrid 0.3.4 → 0.3.5

data/Gemfile

@@ -23,5 +23,6 @@ group :development do
   gem "fastercsv"
   gem "nokogiri"
   gem 'will_paginate', '2.3.15'
+  gem "accept_values_for"
 
 end

data/Gemfile.lock

@@ -2,6 +2,9 @@ GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
+    accept_values_for (0.4.3)
+      activemodel (>= 3.0.0)
+      rspec
     actionmailer (3.0.7)
       actionpack (= 3.0.7)
       mail (~> 2.2.15)
@@ -97,6 +100,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  accept_values_for
   bundler (~> 1.0.0)
   fastercsv
   jeweler (~> 1.6.0)

data/Readme.markdown

@@ -20,15 +20,15 @@ In order to create a report, you need to define:
 
 ### Working grid example
 
+[Datagrid DEMO application](https://github.com/bogdan/datagrid-demo) is available.
+
 In order to create a grid:
 
 ``` ruby
-
 class SimpleReport
 
   include Datagrid
 
-
   scope do
     User.includes(:group)
   end
@@ -42,7 +42,6 @@ class SimpleReport
     self.joins(:group).where(:groups => {:name => value})
   end
 
-
   column(:name)
   column(:group, :order => "groups.name") do |user|
     user.name
@@ -51,11 +50,7 @@ class SimpleReport
     !user.disabled
   end
 
-
-
 end
-
-
 ```
 
 Basic grid api:
@@ -136,18 +131,18 @@ Each column is sortable.
 
 
 In order to create form for your report you can use all set of rails built-in tools.
-
 More over Datagrid provides you two additional form helpers:
 
 * datagrid\_label
 * datagrid\_filter
 
-The easiest way to create a report form:
 
+The easiest way to create a report form:
 (haml for readablity)
 
 ``` haml
-- form_for @report do |f|
+# Method `GET` is recommended for all report forms by default.
+- form_for @report, :html => {:method => :get} do |f|
   - @report.filters.each do |filter|
     %div
       = f.datagrid_label filter
@@ -155,14 +150,25 @@ The easiest way to create a report form:
   = f.submit
 ```
 
-There is a simple helper set of helpers that allows you display report:
+Your controller:
 
+``` ruby
+map.resources :simple_reports, :only => [:index]
+
+class SimpleReportsController < ApplicationController
+  def index
+    @report = SimpleReport.new(params[:simple_report])
+  end
+end
+```
+
+There is a simple helper set of helpers that allows you display report:
 (require will_paginate)
 
 ``` haml
 - assets = @report.assets.paginate(:page => params[:page])
 
-%div== Total #{assets.total}
+%div== Total #{assets.total_entries}
 = datagrid_table(@report, assets)
 = will_paginate assets
 ```

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{datagrid}
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = %q{2011-08-10}
+  s.date = %q{2011-08-15}
   s.description = %q{This allows you to easily build datagrid aka data tables with sortable columns and filters}
   s.email = %q{agresso@gmail.com}
   s.extra_rdoc_files = [
@@ -26,9 +26,9 @@ Gem::Specification.new do |s|
     "VERSION",
     "datagrid.gemspec",
     "lib/datagrid.rb",
+    "lib/datagrid/active_model.rb",
     "lib/datagrid/columns.rb",
     "lib/datagrid/columns/column.rb",
-    "lib/datagrid/conversion.rb",
     "lib/datagrid/core.rb",
     "lib/datagrid/filters.rb",
     "lib/datagrid/filters/base_filter.rb",
@@ -46,10 +46,13 @@ Gem::Specification.new do |s|
     "lib/datagrid/ordering.rb",
     "lib/datagrid/rspec.rb",
     "lib/datagrid/utils.rb",
+    "spec/datagrid/active_model_spec.rb",
     "spec/datagrid/columns_spec.rb",
+    "spec/datagrid/filters/enum_filter_spec.rb",
     "spec/datagrid/filters_spec.rb",
     "spec/datagrid/form_builder_spec.rb",
     "spec/datagrid/helper_spec.rb",
+    "spec/datagrid/ordering_spec.rb",
     "spec/datagrid_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/equal_to_dom.rb",
@@ -79,6 +82,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<fastercsv>, [">= 0"])
       s.add_development_dependency(%q<nokogiri>, [">= 0"])
       s.add_development_dependency(%q<will_paginate>, ["= 2.3.15"])
+      s.add_development_dependency(%q<accept_values_for>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 0"])
       s.add_dependency(%q<rake>, ["= 0.8.7"])
@@ -92,6 +96,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<fastercsv>, [">= 0"])
       s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<will_paginate>, ["= 2.3.15"])
+      s.add_dependency(%q<accept_values_for>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 0"])
@@ -106,6 +111,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<fastercsv>, [">= 0"])
     s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<will_paginate>, ["= 2.3.15"])
+    s.add_dependency(%q<accept_values_for>, [">= 0"])
   end
 end
 

data/lib/datagrid.rb

@@ -1,5 +1,5 @@
 require "datagrid/core"
-require "datagrid/conversion"
+require "datagrid/active_model"
 require "datagrid/filters"
 require "datagrid/columns"
 require "datagrid/ordering"
@@ -14,7 +14,7 @@ module Datagrid
     base.class_eval do
 
       include ::Datagrid::Core
-      include ::Datagrid::Conversion
+      include ::Datagrid::ActiveModel
       include ::Datagrid::Filters
       include ::Datagrid::Columns
       include ::Datagrid::Ordering

data/lib/datagrid/{conversion.rb → active_model.rb}

@@ -1,12 +1,17 @@
+
 module Datagrid
 
   # Required to be ActiveModel compatible
-  module Conversion
+  module ActiveModel
   
     def self.included(base)
       base.extend         ClassMethods
       base.class_eval do
-        
+        begin
+          require 'active_model/naming'
+          extend ::ActiveModel::Naming
+        rescue LoadError
+        end
       end
       base.send :include, InstanceMethods
     end # self.included
@@ -17,9 +22,6 @@ module Datagrid
         self.to_s.underscore.split('/').last
       end
 
-      def model_name
-        self.param_name
-      end
 
     end # ClassMethods
   
@@ -29,6 +31,10 @@ module Datagrid
         self.class.param_name
       end
 
+      def param_key
+        param_name
+      end
+
       def to_key
         [self.class.param_name]
       end

data/lib/datagrid/columns/column.rb

@@ -5,7 +5,7 @@ class Datagrid::Columns::Column
 
   def initialize(grid, name, options = {}, &block)
     self.grid = grid
-    self.name = name
+    self.name = name.to_sym
     self.options = options
     self.block = block
   end
@@ -45,9 +45,9 @@ class Datagrid::Columns::Column
     end
   end
 
-  def desc_order
+  def order_desc
     return nil unless order
-    self.options[:desc_order]  
+    self.options[:order_desc]  
   end
 
 end

data/lib/datagrid/filters/base_filter.rb

@@ -16,8 +16,11 @@ class Datagrid::Filters::BaseFilter
   end
 
   def apply(scope, value)
-    return scope if value.nil? && !options[:allow_nil]
-    return scope if value.blank? && !options[:allow_blank]
+    if value.nil?
+      return scope if !allow_nil?
+    else
+      return scope if value.blank? && !allow_blank?
+    end
     ::Datagrid::Filters::FilterEval.new(self, scope, value).run
   end
 
@@ -25,7 +28,7 @@ class Datagrid::Filters::BaseFilter
     if !self.multiple && value.is_a?(Array) 
       raise Datagrid::ArgumentError, "#{grid.class}.#{name} filter can not accept Array argument. Use :multiple option." 
     end
-    values = Array(value)
+    values = Array.wrap(value)
     values.map! do |value|
       self.format(value)
     end
@@ -45,5 +48,14 @@ class Datagrid::Filters::BaseFilter
   def multiple
     self.options[:multiple]
   end
+
+  def allow_nil?
+    options.has_key?(:allow_nil) ? options[:allow_nil] : options[:allow_blank]
+  end
+
+  def allow_blank?
+    options[:allow_blank]
+  end
+
 end
 

data/lib/datagrid/filters/enum_filter.rb

@@ -11,7 +11,8 @@ class Datagrid::Filters::EnumFilter < Datagrid::Filters::BaseFilter
   end
 
   def select
-    self.options[:select]
+    option = self.options[:select]
+    option.respond_to?(:call) ? option.call : option
   end
 
 

data/lib/datagrid/filters/string_filter.rb

@@ -1,5 +1,5 @@
 class Datagrid::Filters::StringFilter < Datagrid::Filters::BaseFilter
   def format(value)
-    value.to_s
+    value.nil? ? nil : value.to_s
   end
 end

data/spec/datagrid/active_model_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Datagrid::ActiveModel do
+
+  class ActiveReport
+    include Datagrid::ActiveModel
+  end
+
+  describe ".model_name" do
+    it "should be generate from class name " do
+      ActiveReport.model_name.should == "ActiveReport"
+    end
+    it "should have ActiveModel naming conventions" do
+      ActiveReport.model_name.i18n_key.should == :active_report
+    end
+  end
+
+  
+end

data/spec/datagrid/columns_spec.rb

@@ -49,37 +49,5 @@ describe Datagrid::Columns do
     report.rows.last.first.should be_false
   end
 
-  describe "ordering" do
-
-
-    it "should raise error if ordered by not existing column" do
-      lambda {
-        test_report(:order => :hello)
-      }.should raise_error(Datagrid::OrderUnsupported)
-    end
-
-    it "should raise error if ordered by column without order" do
-      lambda do
-        test_report(:order => :category) do
-          filter(:category, :default, :order => false) do |value|
-            self
-          end
-        end
-      end.should raise_error(Datagrid::OrderUnsupported)
-    end
-
-    it "should override default order" do
-      Entry.all.should be_empty
-      e1 = Entry.create!
-      e2 = Entry.create!
-      test_report(:order => :id) do
-        scope { Entry.order("id desc")}
-        column(:id) do
-          self.order("id asc")
-        end
-      end.assets.all.should == [e1, e2]
-    end
-
-  end
 
 end

data/spec/datagrid/filters/enum_filter_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Datagrid::Filters::EnumFilter do
+
+  it "should support select option" do
+    test_report do
+      scope {Entry}
+      filter(:group_id, :enum, :select =>  [1,2] )
+    end.class.filter_by_name(:group_id).select.should == [1,2]
+  end
+
+  it "should support select option as proc" do
+    test_report do
+      scope {Entry}
+      filter(:group_id, :enum, :select => proc { [1,2] })
+    end.class.filter_by_name(:group_id).select.should == [1,2]
+  end
+  
+end

data/spec/datagrid/filters_spec.rb

@@ -18,7 +18,7 @@ describe Datagrid::Filters do
       report.group_id = [1,2]
     }.should raise_error(Datagrid::ArgumentError)
   end
-  
+
 
   it "should initialize report Scope table not exists" do
     class ModelWithoutTable < ActiveRecord::Base; end
@@ -31,7 +31,40 @@ describe Datagrid::Filters do
       filter(:name)
     end
     TheReport.new(:name => 'hello')
+  end
+
+  describe "allow_blank and allow_nil options" do
+    before(:each) do
+      $FILTER_PERFORMED = false
+    end
+
+    def check_performed(value, result, options)
+      report = test_report(:name => value) do
+        scope {Entry}
+        filter(:name, options) do |value|
+          $FILTER_PERFORMED = true
+          self
+        end
+      end
+      report.name.should == value
+      report.assets
+      $FILTER_PERFORMED.should == result
+    end
 
+    it "should support allow_blank argument" do
+      [nil, "", " "].each do |value|
+        check_performed(value, true, :allow_blank => true)
+      end
+    end
+
+    it "should support allow_blank argument" do
+      check_performed(nil, true, :allow_nil => true)
+    end
+
+    it "should support combination on allow_nil and allow_blank" do
+      check_performed(nil, false, :allow_nil => false, :allow_blank => true)
+      check_performed("", true, :allow_nil => false, :allow_blank => true)
+      check_performed(nil, true, :allow_nil => true, :allow_blank => false)
+    end
   end
-  
 end

data/spec/datagrid/ordering_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Datagrid::Ordering do
+
+
+  let!(:first) { Entry.create!(:name => "aa")}
+  let!(:second) { Entry.create!(:name => "bb")}
+  let!(:third) { Entry.create!(:name => "cc")}
+
+
+  it "should support order" do
+    test_report(:order => "name") do
+      scope do
+        Entry
+      end
+      column :name
+    end.assets.should discover(first, second, third).with_exact_order
+
+  end
+
+  it "should support desc order" do
+    test_report(:order => "name", :descending => true) do
+      scope do
+        Entry
+      end
+      column :name
+    end.assets.should discover(third, second, first).with_exact_order
+
+
+  end
+
+
+  it "should raise error if ordered by not existing column" do
+    lambda {
+      test_report(:order => :hello)
+    }.should raise_error(Datagrid::OrderUnsupported)
+  end
+
+  it "should raise error if ordered by column without order" do
+    lambda do
+      test_report(:order => :category) do
+        filter(:category, :default, :order => false) do |value|
+          self
+        end
+      end
+    end.should raise_error(Datagrid::OrderUnsupported)
+  end
+
+  it "should override default order" do
+
+    test_report(:order => :id) do
+      scope { Entry.order("id desc")}
+      column(:id) do
+        self.order("id asc")
+      end
+    end.assets.should discover(first, second, third).with_exact_order
+  end
+
+end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require "active_record"
 require "will_paginate"
 require 'datagrid'
+require "discover"
 begin
   #require 'ruby-debug'
 rescue

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: datagrid
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 3
-  - 4
-  version: 0.3.4
+  - 5
+  version: 0.3.5
 platform: ruby
 authors: 
 - Bogdan Gusiev
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-10 00:00:00 +03:00
+date: 2011-08-15 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -196,6 +196,20 @@ dependencies:
   type: :development
   name: will_paginate
   prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id013
+  type: :development
+  name: accept_values_for
+  prerelease: false
 description: This allows you to easily build datagrid aka data tables with sortable columns and filters
 email: agresso@gmail.com
 executables: []
@@ -215,9 +229,9 @@ files:
 - VERSION
 - datagrid.gemspec
 - lib/datagrid.rb
+- lib/datagrid/active_model.rb
 - lib/datagrid/columns.rb
 - lib/datagrid/columns/column.rb
-- lib/datagrid/conversion.rb
 - lib/datagrid/core.rb
 - lib/datagrid/filters.rb
 - lib/datagrid/filters/base_filter.rb
@@ -235,10 +249,13 @@ files:
 - lib/datagrid/ordering.rb
 - lib/datagrid/rspec.rb
 - lib/datagrid/utils.rb
+- spec/datagrid/active_model_spec.rb
 - spec/datagrid/columns_spec.rb
+- spec/datagrid/filters/enum_filter_spec.rb
 - spec/datagrid/filters_spec.rb
 - spec/datagrid/form_builder_spec.rb
 - spec/datagrid/helper_spec.rb
+- spec/datagrid/ordering_spec.rb
 - spec/datagrid_spec.rb
 - spec/spec_helper.rb
 - spec/support/equal_to_dom.rb