datagrid 0.9.2 → 0.9.3

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.9.3

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "0.9.2"
+  s.version = "0.9.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-08-23"
+  s.date = "2013-08-26"
   s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [
@@ -99,7 +99,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
+  s.rubygems_version = "1.8.24"
   s.summary = "Ruby gem to create datagrids"
 
   if s.respond_to? :specification_version then

data/lib/datagrid/columns/column.rb

@@ -108,10 +108,8 @@ class Datagrid::Columns::Column
   end
 
   def generic_value(model, grid)
-    if self.data_block.arity == 1
-      self.data_block.call(model)
-    elsif self.data_block.arity == 2
-      self.data_block.call(model, grid)
+    if self.data_block.arity >= 1
+      Datagrid::Utils.apply_args(model, grid, &data_block)
     else
       model.instance_eval(&self.data_block)
     end

data/lib/datagrid/core.rb

@@ -69,10 +69,12 @@ module Datagrid
         end
 
         if block_given?
-          self.scope_value = block
+          self.scope(&block)
         end
       end
 
+      # Returns a hash of grid attributes including filter values 
+      # and ordering values
       def attributes
         result = {}
         self.datagrid_attributes.each do |name|
@@ -81,6 +83,7 @@ module Datagrid
         result
       end
 
+      # Alias for <tt>send</tt> method
       def [](attribute)
         self.send(attribute)
       end
@@ -89,6 +92,7 @@ module Datagrid
         self.send(:"#{attribute}=", value)
       end
 
+      # Returns a scope(e.g ActiveRecord::Relation) with all applied filters
       def assets
         driver.to_scope(scope)
       end
@@ -110,23 +114,43 @@ module Datagrid
         attributes
       end
 
-      def paginate(*args, &block)
+      def paginate(*args, &block) # :nodoc:
         ::Datagrid::Utils.warn_once("#paginate is deprecated. Call it like object.assets.paginate(...).")
         self.assets.paginate(*args, &block)
       end
 
+      # Redefines scope at instance level
+      # 
+      #   class MyGrid
+      #     scope { Article.order('created_at desc') }
+      #   end
+      # 
+      #   grid = MyGrid.new
+      #   grid.scope do |scope|
+      #     scope.where(:author_id => current_user.id)
+      #   end
+      #   grid.assets 
+      #       # => SELECT * FROM articles WHERE author_id = ? 
+      #       #    ORDER BY created_at desc
+      #
       def scope(&block)
         if block_given?
-          self.scope_value = block
+          current_scope = scope
+          self.scope_value = proc {
+            Datagrid::Utils.apply_args(current_scope, &block)
+          }
           self
-        elsif scope_value
-          scope_value.call
         else
           check_scope_defined!
           scope_value.call
         end
       end
 
+      # Resets current instance scope to default scope defined in a class
+      def reset_scope
+        scope(&self.class.scope_value)
+      end
+
       def driver #:nodoc:
         self.class.driver
       end

data/lib/datagrid/filters.rb

@@ -25,7 +25,7 @@ module Datagrid
       :float => Filters::FloatFilter,
     }
 
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.extend         ClassMethods
       base.class_eval do
 
@@ -40,43 +40,53 @@ module Datagrid
 
     module ClassMethods
 
+      # Returns filter definition object by name
       def filter_by_name(attribute)
         self.filters.find do |filter|
           filter.name.to_sym == attribute.to_sym
         end
       end
 
-      # Defines new datagrid filter
+      # Defines new datagrid filter.
+      # This method automatically generates <tt>attr_accessor</tt> for filter name
+      # and adds it to the list of datagrid attributes.
       # 
       # Arguments:
       #
       #   * <tt>name</tt> - filter name
+      #   * <tt>type</tt> - filter type that defines type case and GUI representation of a filter
       #   * <tt>options</tt> - hash of options
       #   * <tt>block</tt> - proc to apply the filter
       #
       # Available options:
       #   
       #   * <tt>:header</tt> - determines the header of the filter
-      #   * <tt>:default</tt> - the default filter value
+      #   * <tt>:default</tt> - the default filter value. Able to accept a <tt>Proc</tt> in case default should be recalculated
       #   * <tt>:multiple</tt> - determines if more than one option can be selected
       #   * <tt>:allow_nil</tt> - determines if the value can be nil
       #   * <tt>:allow_blank</tt> - determines if the value can be blank
-      #   * <tt>:before</tt> - determines the position of this filter, by adding it before the filter passed here (when using datagrid_form_for helper)
-      #   * <tt>:after</tt> - determines the position of this filter, by adding it after the filter passed here (when using datagrid_form_for helper)
+      #   * <tt>:before</tt> - determines the position of this filter, 
+      #     by adding it before the filter passed here (when using datagrid_form_for helper)
+      #   * <tt>:after</tt> - determines the position of this filter, 
+      #     by adding it after the filter passed here (when using datagrid_form_for helper)
+      #   * <tt>:dummy</tt> - if true, this filter will not be applied automatically 
+      #     and will just be displayed in form. In case you may want to apply it manually.
       #
       # See: https://github.com/bogdan/datagrid/wiki/Columns for examples
-      def filter(attribute, *args, &block)
-        options = args.extract_options!
-        type = args.shift || :default
+      def filter(name, type = :default, options = {}, &block)
+        if type.is_a?(Hash)
+          options = type
+          type = :default
+        end
 
         klass = type.is_a?(Class) ? type : FILTER_TYPES[type]
         raise ConfigurationError, "filter class #{type.inspect} not found" unless klass
 
         position = Datagrid::Utils.extract_position_from_options(self.filters, options)
-        filter = klass.new(self, attribute, options, &block)
+        filter = klass.new(self, name, options, &block)
         self.filters.insert(position, filter)
 
-        datagrid_attribute(attribute) do |value|
+        datagrid_attribute(name) do |value|
           filter.parse_values(value)
         end
 
@@ -93,14 +103,14 @@ module Datagrid
 
     module InstanceMethods
 
-      def initialize(*args, &block)
+      def initialize(*args, &block) # :nodoc:
         self.filters.each do |filter|
           self[filter.name] = filter.default
         end
         super(*args, &block)
       end
 
-      def assets
+      def assets # :nodoc:
         result = super
         self.class.filters.each do |filter|
           result = filter.apply(self, result, filter_value(filter))
@@ -108,10 +118,12 @@ module Datagrid
         result
       end
 
+      # Returns all defined filters Array
       def filters
         self.class.filters
       end
 
+      # Returns filter valur for given filter definition
       def filter_value(filter)
         self[filter.name]
       end

data/lib/datagrid/filters/base_filter.rb

@@ -75,7 +75,7 @@ class Datagrid::Filters::BaseFilter
   def default_filter_block
     filter = self
     lambda do |value, scope, grid|
-      filter.default_filter(value, scope, grid)
+      filter.dummy? ? nil : filter.default_filter(value, scope, grid)
     end
   end
 
@@ -91,6 +91,10 @@ class Datagrid::Filters::BaseFilter
   def format(value)
     value.nil? ? nil : value.to_s
   end
+  
+  def dummy?
+    options[:dummy]
+  end
 
   protected
 
@@ -99,12 +103,10 @@ class Datagrid::Filters::BaseFilter
   end
 
   def execute(value, scope, grid_object, &block)
-    if block.arity >= 3 || block.arity < 0
-      scope.instance_exec(value, scope, grid_object, &block)
-    elsif block.arity == 2
-      scope.instance_exec(value, scope, &block)
-    else
+    if block.arity == 1
       scope.instance_exec(value, &block)
+    else
+      Datagrid::Utils.apply_args(value, scope, grid_object, &block)
     end
   end
 

data/lib/datagrid/filters/enum_filter.rb

@@ -15,7 +15,7 @@ class Datagrid::Filters::EnumFilter < Datagrid::Filters::BaseFilter
     if select.is_a?(Symbol)
       object.send(select)
     elsif select.respond_to?(:call)
-      select.arity == 1 ? select.call(object) : select.call
+      Datagrid::Utils.apply_args(object, &select)
     else
       select
     end

data/lib/datagrid/ordering.rb

@@ -48,7 +48,7 @@ module Datagrid
 
     module InstanceMethods
 
-      def assets
+      def assets # :nodoc:
         result = super
         if order
           column = column_by_name(order)

data/lib/datagrid/utils.rb

@@ -46,6 +46,15 @@ module Datagrid
           -1
         end
       end
+
+      def apply_args(*args, &block)
+        return block.call(*args) if block.arity < 0
+        args = args.clone
+        (args.size - block.arity).times do
+          args.pop
+        end
+        block.call(*args)
+      end
     end
   end
 end

data/spec/datagrid/columns_spec.rb

@@ -50,7 +50,8 @@ describe Datagrid::Columns do
           "'#{model.name}' filtered by '#{grid.name}'"
         end
       end
-      report.row_for(Entry.create!(:name => "Hello World")).should == [8, "'Hello World' filtered by 'Hello'"]
+      entry = Entry.create!(:name => "Hello World")
+      report.row_for(entry).should == [entry.id, "'Hello World' filtered by 'Hello'"]
     end
 
     it "should generate table data" do

data/spec/datagrid/core_spec.rb

@@ -5,10 +5,9 @@ describe Datagrid::Core do
   context 'with 2 persisted entries' do
     before { 2.times { Entry.create } }
 
-    let(:limit) { Entry.limit(1) }
     let(:report_class) do
       test_report_class do
-        scope { Entry }
+        scope { Entry.order("id desc") }
       end
     end
 
@@ -22,17 +21,30 @@ describe Datagrid::Core do
       context 'changes scope on the fly' do
         let(:report) do
           report_class.new.tap do |r|
-            r.scope { limit }
+            r.scope { Entry.limit(1)}
           end
         end
 
         it { expect(report.scope).to have(1).item }
       end
 
-      context 'changes scope by initializer' do
-        let(:report) { report_class.new { limit } }
+      context 'overriding scope by initializer' do
+        let(:report) { report_class.new { Entry.limit(1) } }
 
         it { expect(report.scope).to have(1).item }
+
+        context "reset scope to default" do
+          before do
+            report.reset_scope
+          end
+          it { expect(report.scope).to have(2).item }
+        end
+      end
+
+      context "appending scope by initializer " do
+        let(:report) { report_class.new {|scope| scope.limit(1)} }
+        it { expect(report.scope).to have(1).item }
+        it { expect(report.scope.order_values).to have(1).item }
       end
     end
   end

data/spec/datagrid/filters_spec.rb

@@ -152,4 +152,13 @@ describe Datagrid::Filters do
       grid.filters.index {|f| f.name == :group_id}.should == 1
     end
   end
+
+  it "should support dummy filter" do
+    grid = test_report do
+      scope { Entry }
+      filter(:period, :date, :dummy => true, :default => proc { Date.today })
+    end
+    Entry.create!(:created_at => 3.days.ago)
+    grid.assets.should_not be_empty
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -337,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3747985271557157131
+      hash: -2282688358265272109
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby gem to create datagrids