datagrid 0.8.0 → 0.8.1

data/Readme.markdown

@@ -141,6 +141,26 @@ Each column is sortable.
 
 ### Front end
 
+### Using Generator
+
+Datagrid has a builtin generator:
+
+```
+rails g datagrid:scaffold skills
+```
+
+That gives you some code to play with out of the box:
+
+```
+create  app/grids/skills_grid.rb
+create  app/controllers/skills_controller.rb
+create  app/views/skills/index.html.erb
+route  resources :skills
+```
+
+### Manually
+
+If you want to be a true ninja you can build everything from scratch on your own.
 
 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:
@@ -149,8 +169,7 @@ More over Datagrid provides you two additional form helpers:
 * datagrid\_filter
 
 
-The easiest way to create a report form:
-(haml for readablity)
+The easiest way to create a report form (haml for readablity):
 
 ``` haml
 # Method `GET` is recommended for all report forms by default.

data/VERSION

@@ -1 +1 @@
-0.8.0
+0.8.1

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "0.8.0"
+  s.version = "0.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-04-07"
+  s.date = "2013-04-28"
   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 = [
@@ -36,6 +36,7 @@ Gem::Specification.new do |s|
     "lib/datagrid/drivers.rb",
     "lib/datagrid/drivers/abstract_driver.rb",
     "lib/datagrid/drivers/active_record.rb",
+    "lib/datagrid/drivers/array.rb",
     "lib/datagrid/drivers/mongo_mapper.rb",
     "lib/datagrid/drivers/mongoid.rb",
     "lib/datagrid/engine.rb",
@@ -63,6 +64,7 @@ Gem::Specification.new do |s|
     "spec/datagrid/columns_spec.rb",
     "spec/datagrid/core_spec.rb",
     "spec/datagrid/drivers/active_record_spec.rb",
+    "spec/datagrid/drivers/array_spec.rb",
     "spec/datagrid/drivers/mongo_mapper_spec.rb",
     "spec/datagrid/drivers/mongoid_spec.rb",
     "spec/datagrid/filters/boolean_enum_filter_spec.rb",
@@ -75,6 +77,7 @@ Gem::Specification.new do |s|
     "spec/datagrid/form_builder_spec.rb",
     "spec/datagrid/helper_spec.rb",
     "spec/datagrid/ordering_spec.rb",
+    "spec/datagrid/scaffold_spec.rb",
     "spec/datagrid/utils_spec.rb",
     "spec/datagrid_spec.rb",
     "spec/spec_helper.rb",
@@ -84,8 +87,6 @@ Gem::Specification.new do |s|
     "spec/support/mongoid.rb",
     "spec/support/simple_report.rb",
     "spec/support/test_partials/_actions.html.erb",
-    "template/controller.rb.erb",
-    "template/grid.rb.erb",
     "templates/controller.rb.erb",
     "templates/grid.rb.erb",
     "templates/index.html.erb"

data/lib/datagrid/core.rb

@@ -102,6 +102,7 @@ module Datagrid
       def scope(&block)
         if block_given?
           self.scope_value = block
+          self
         else
           check_scope_defined!
           scope_value.call

data/lib/datagrid/drivers.rb

@@ -1,5 +1,6 @@
 require "datagrid/drivers/abstract_driver"
 require "datagrid/drivers/active_record"
+require "datagrid/drivers/array"
 require "datagrid/drivers/mongoid"
 require "datagrid/drivers/mongo_mapper"
 

data/lib/datagrid/drivers/abstract_driver.rb

@@ -11,21 +11,24 @@ module Datagrid
       end
 
       def self.guess_driver(scope)
-        klass = self.subclasses.find do |driver_class|
+        self.subclasses.find do |driver_class|
           driver_class.match?(scope)
         end || raise(Datagrid::ConfigurationError, "ORM Driver not found for scope: #{scope.inspect}.")
       end
 
-
       def self.match?(scope)
         raise NotImplementedError
       end
 
+      def match?(scope)
+        self.class.match?(scope)
+      end
+
       def to_scope(scope)
         raise NotImplementedError
       end
 
-      def where(scope, condition)
+      def where(scope, attribute, value)
         raise NotImplementedError
       end
 

data/lib/datagrid/drivers/active_record.rb

@@ -12,21 +12,22 @@ module Datagrid
       end
 
       def to_scope(scope)
+        return scope if scope.is_a?(::ActiveRecord::Relation)
         # Model class or Active record association
         # ActiveRecord association class hides itself under an Array 
         # We can only reveal it by checking if it respond to some specific
         # to ActiveRecord method like #scoped
         if scope.is_a?(Class) 
           scope.scoped({})
-        elsif (scope.is_a?(Array) && scope.respond_to?(:scoped))
+        elsif scope.respond_to?(:scoped)
           scope.scoped
         else
           scope
         end
       end
 
-      def where(scope, condition)
-        scope.where(condition)
+      def where(scope, attribute, value)
+        scope.where(attribute => value)
       end
 
       def asc(scope, order)

data/lib/datagrid/drivers/array.rb

@@ -0,0 +1,52 @@
+module Datagrid
+  module Drivers
+    class Array < AbstractDriver
+
+      def self.match?(scope)
+        !Datagrid::Drivers::ActiveRecord.match?(scope) && scope.is_a?(::Array)
+      end
+
+      def to_scope(scope)
+        scope
+      end
+
+      def where(scope, attribute, value)
+        scope.select do |object|
+          object.send(attribute) == value
+        end
+      end
+
+      def asc(scope, order)
+        return scope unless order
+        return scope if order.empty?
+        scope.sort_by do |object|
+          object.send(order)
+        end
+      end
+
+      def desc(scope, order)
+        asc(scope, order).reverse
+      end
+
+      def default_order(scope, column_name)
+        column_name
+      end
+
+      def greater_equal(scope, field, value)
+        scope.select do |object|
+          object.send(field) >= value
+        end
+      end
+
+      def less_equal(scope, field, value)
+        scope.select do |object|
+          object.send(field) <= value
+        end
+      end
+
+      def has_column?(scope, column_name)
+        scope.first.respond_to?(column_name)
+      end
+    end
+  end
+end

data/lib/datagrid/drivers/mongo_mapper.rb

@@ -15,8 +15,8 @@ module Datagrid
         scope.where
       end
 
-      def where(scope, condition)
-        scope.where(condition)
+      def where(scope, attribute, value)
+        scope.where(attribute => value)
       end
 
       def asc(scope, order)

data/lib/datagrid/drivers/mongoid.rb

@@ -15,8 +15,8 @@ module Datagrid
         scope.where(nil)
       end
 
-      def where(scope, condition)
-        scope.where(condition)
+      def where(scope, attribute, value)
+        scope.where(attribute => value)
       end
 
       def asc(scope, order)

data/lib/datagrid/filters.rb

@@ -84,8 +84,7 @@ module Datagrid
       def assets
         result = super
         self.class.filters.each do |filter|
-          result_filter = filter.apply(self, result, filter_value(filter))
-          result = result_filter if result_filter
+          result = filter.apply(self, result, filter_value(filter))
         end
         result
       end

data/lib/datagrid/filters/base_filter.rb

@@ -1,3 +1,5 @@
+class Datagrid::FilteringError < StandardError
+end
 
 class Datagrid::Filters::BaseFilter
 
@@ -7,7 +9,7 @@ class Datagrid::Filters::BaseFilter
     self.grid = grid_class
     self.name = name
     self.options = options
-    self.block = block || default_filter_block 
+    self.block = block || default_filter_block
   end
 
   def format(value)
@@ -21,18 +23,17 @@ class Datagrid::Filters::BaseFilter
       return scope if value.blank? && !allow_blank?
     end
 
-    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
-      scope.instance_exec(value, &block)
+    result = execute(value, scope, grid_object, &block)
+    return scope unless result
+    unless grid_object.driver.match?(result)
+      raise Datagrid::FilteringError, "Can not apply #{name.inspect} filter: result #{result.inspect} no longer match #{grid_object.driver.class}."
     end
+    result
   end
 
   def format_values(value)
-    if !self.multiple && value.is_a?(Array) 
-      raise Datagrid::ArgumentError, "#{grid}##{name} filter can not accept Array argument. Use :multiple option." 
+    if !self.multiple && value.is_a?(Array)
+      raise Datagrid::ArgumentError, "#{grid}##{name} filter can not accept Array argument. Use :multiple option."
     end
     values = Array.wrap(value)
     values.map! do |v|
@@ -42,7 +43,7 @@ class Datagrid::Filters::BaseFilter
   end
 
   def header
-    options[:header] || 
+    options[:header] ||
       I18n.translate(self.name, :scope => "datagrid.#{grid.param_name}.filters", :default => self.name.to_s.humanize)
   end
 
@@ -73,9 +74,9 @@ class Datagrid::Filters::BaseFilter
 
   def default_filter_block
     filter = self
-    lambda do |value, scope, grid| 
+    lambda do |value, scope, grid|
       filter.default_filter(value, scope, grid)
-    end                                         
+    end
   end
 
   def default_filter(value, scope, grid)
@@ -87,8 +88,20 @@ class Datagrid::Filters::BaseFilter
     end
   end
 
+  protected
+
   def default_filter_where(driver, scope, value)
-    driver.where(scope, name => value)
+    driver.where(scope, name, value)
+  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
+      scope.instance_exec(value, &block)
+    end
   end
 
 end

data/lib/datagrid/scaffold.rb

@@ -33,7 +33,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
   def paginate_code
     if defined?(Kaminari)
       "page(params[:page])"
-    elsif defned?(WillPaginate)
+    elsif defined?(WillPaginate)
       "paginate(:page => params[:page])"
     else
       "paginate_somehow"
@@ -43,7 +43,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
   def pagination_helper_code
     if defined?(Kaminari)
       "paginate(@assets)"
-    elsif defned?(WillPaginate)
+    elsif defined?(WillPaginate)
       "will_paginate(@assets)"
     else
       "some_pagination_helper(@assets)"

data/spec/datagrid/drivers/array_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe Datagrid::Drivers::Array do
+
+  describe ".match?" do
+    subject { described_class }
+
+    it {should be_match(Array.new)}
+    it {should_not be_match({})}
+  end
+  
+  describe "api" do
+  
+    class ArrayGrid
+      class User < Struct.new(:name, :age); end
+      include Datagrid
+      scope do
+        []
+      end
+
+      filter(:name)
+      filter(:age, :integer, :range => true)
+
+      column(:name)
+      column(:age)
+    end
+
+    let(:first) { ArrayGrid::User.new("Vasya", 15) }
+    let(:second) { ArrayGrid::User.new("Petya", 12) }
+    let(:third) { ArrayGrid::User.new("Vova", 13) }
+
+    subject do
+      ArrayGrid.new(
+        defined?(_attributes) ? _attributes : {}
+      ).scope do
+        [ first, second, third ]
+      end
+    end
+  
+          
+    its(:"assets.size") {should == 3}
+    its(:rows) {should == [["Vasya", 15], ["Petya", 12], ["Vova", 13]]}
+    its(:header) {should ==[ "Name", "Age"]}
+      
+    its(:data) {should == [[ "Name", "Age"], ["Vasya", 15], ["Petya", 12], ["Vova", 13]]}
+      
+      
+    describe "when some filters specified" do
+      let(:_attributes) { {:age => [12,14]} }
+      its(:assets) {should_not include(first)}
+      its(:assets) {should include(second)}
+      its(:assets) {should include(third)}
+    end
+      
+    describe "when reverse ordering is specified" do
+      let(:_attributes) { {:order => :name, :descending => true} }
+      its(:assets) {should == [third, first, second]}
+    end
+  end
+end

data/spec/datagrid/scaffold_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Datagrid::Scaffold do
+  subject { Datagrid::Scaffold.new([""]) }
+
+  describe '.paginate_code' do
+    it 'should fall through options successfully' do
+      subject.paginate_code.should eql('paginate_somehow')
+    end
+  end
+
+  describe '.pagination_helper_code' do
+    it 'should fall through options successfully' do
+      subject.pagination_helper_code.should eql('some_pagination_helper(@assets)')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-07 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -263,6 +263,7 @@ files:
 - lib/datagrid/drivers.rb
 - lib/datagrid/drivers/abstract_driver.rb
 - lib/datagrid/drivers/active_record.rb
+- lib/datagrid/drivers/array.rb
 - lib/datagrid/drivers/mongo_mapper.rb
 - lib/datagrid/drivers/mongoid.rb
 - lib/datagrid/engine.rb
@@ -290,6 +291,7 @@ files:
 - spec/datagrid/columns_spec.rb
 - spec/datagrid/core_spec.rb
 - spec/datagrid/drivers/active_record_spec.rb
+- spec/datagrid/drivers/array_spec.rb
 - spec/datagrid/drivers/mongo_mapper_spec.rb
 - spec/datagrid/drivers/mongoid_spec.rb
 - spec/datagrid/filters/boolean_enum_filter_spec.rb
@@ -302,6 +304,7 @@ files:
 - spec/datagrid/form_builder_spec.rb
 - spec/datagrid/helper_spec.rb
 - spec/datagrid/ordering_spec.rb
+- spec/datagrid/scaffold_spec.rb
 - spec/datagrid/utils_spec.rb
 - spec/datagrid_spec.rb
 - spec/spec_helper.rb
@@ -311,8 +314,6 @@ files:
 - spec/support/mongoid.rb
 - spec/support/simple_report.rb
 - spec/support/test_partials/_actions.html.erb
-- template/controller.rb.erb
-- template/grid.rb.erb
 - templates/controller.rb.erb
 - templates/grid.rb.erb
 - templates/index.html.erb
@@ -331,7 +332,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1083654781262067166
+      hash: 3628850104894180281
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/template/controller.rb.erb

@@ -1,9 +0,0 @@
-class <%= class_name %>Controller < ApplicationController
-
-  def index
-    @grid = <%= class_name %>Grid.new(params[:<%= (class_name + "Grid").underscore %>])
-    @assets = @grid.assets.page(params[:page])
-  end
-
-end
-

data/template/grid.rb.erb

@@ -1,10 +0,0 @@
-class <%= class_name %>Grid
-
-  include Datagrid
-
-  scope do
-    <%= class_name.singularize %>
-  end
-
-  column(:id)
-end