datagrid 1.0.1 → 1.0.2

data/Gemfile

@@ -1,11 +1,9 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "rails", ">= 3.0"
 
-
 group :development do
 
-  gem "rake"
   gem "bundler"
   gem "jeweler"
 

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-10-14"
+  s.date = "2013-11-25"
   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 = [
@@ -114,7 +114,6 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.0"])
-      s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<debugger>, [">= 0"])
@@ -129,7 +128,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<fastercsv>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 3.0"])
-      s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<debugger>, [">= 0"])
@@ -145,7 +143,6 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<rails>, [">= 3.0"])
-    s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<debugger>, [">= 0"])

data/lib/datagrid/columns.rb

@@ -15,12 +15,36 @@ module Datagrid
         class_attribute :default_column_options
         self.default_column_options = {}
 
+        class_attribute :batch_size
+        self.batch_size = 1000
+
       end
       base.send :include, InstanceMethods
     end # self.included
 
     module ClassMethods
 
+      ##
+      # :method: batch_size=
+      #
+      # :call-seq: batch_size=(size)
+      #
+      # Specify a default batch size when generating CSV or just data
+      # Default: 1000
+      #
+      #   self.batch_size = 500
+      #   # Disable batches
+      #   self.batch_size = nil
+      #
+
+      ##
+      # :method: batch_size
+      #
+      # :call-seq: batch_size
+      #
+      # Returns specified batch_size configuration variable
+      # See <tt>batch_size=</tt> for more information
+      #
 
       ##
       # :method: default_column_options=
@@ -83,6 +107,7 @@ module Datagrid
       #     Warning: using ruby to order large datasets is very unrecommended. 
       #     If set to true - datagrid will use column value to order by this column
       #     If block is given - datagrid will use value returned from block
+      #   * <tt>:mandatory</tt> - if true, column will never be hidden with #column_names selection
       #   * <tt>:url</tt> - a proc with one argument, pass this option to easily convert the value into an URL
       #   * <tt>:before</tt> - determines the position of this column, by adding it before the column passed here
       #   * <tt>:after</tt> - determines the position of this column, by adding it after the column passed here
@@ -173,8 +198,7 @@ module Datagrid
       #
       #   * <tt>column_names</tt> - list of column names if you want to limit data only to specified columns
       def rows(*column_names)
-        #TODO: find in batches
-        driver.batch_map(assets) do |asset|
+        map_with_batches do |asset|
           self.row_for(asset, *column_names)
         end
       end
@@ -205,7 +229,7 @@ module Datagrid
       #     MyGrid.new.data_hash # => [{:name => "One"}, {:name => "Two"}]
       #
       def data_hash
-        driver.batch_map(assets) do |asset|
+        map_with_batches do |asset|
           hash_for(asset)
         end
       end
@@ -297,6 +321,16 @@ module Datagrid
         end
       end
 
+      protected
+
+      def map_with_batches(&block)
+        if batch_size && batch_size > 0
+          driver.batch_map(assets, batch_size, &block)
+        else
+          assets.map(&block)
+        end
+      end
+
     end # InstanceMethods
 
   end

data/lib/datagrid/core.rb

@@ -159,6 +159,7 @@ module Datagrid
         self.class.send :check_scope_defined!, message
       end
 
+
     end # InstanceMethods
   end
 end

data/lib/datagrid/drivers/abstract_driver.rb

@@ -78,7 +78,7 @@ module Datagrid
         raise NotImplementedError
       end
 
-      def batch_map(scope)
+      def batch_map(scope, batch_size, &block)
         raise NotImplementedError
       end
 

data/lib/datagrid/drivers/active_record.rb

@@ -90,9 +90,9 @@ module Datagrid
         end
       end
 
-      def batch_map(scope, &block)
+      def batch_map(scope, batch_size, &block)
         result = []
-        scope.find_each do |record|
+        scope.find_each(batch_size ? { :batch_size => batch_size} : {}) do |record|
           result << yield(record)
         end
         result

data/lib/datagrid/drivers/array.rb

@@ -65,7 +65,7 @@ module Datagrid
         []
       end
 
-      def batch_map(scope, &block)
+      def batch_map(scope, batch_size, &block)
         scope.map(&block)
       end
     end

data/lib/datagrid/drivers/mongo_mapper.rb

@@ -56,8 +56,17 @@ module Datagrid
         [] # TODO: implement support
       end
 
-      def batch_map(scope, &block)
-        scope.map(&block)
+      def batch_map(scope, batch_size, &block)
+        current_page = 0
+        result = []
+        loop do
+          batch = scope.skip(current_page * batch_size).limit(batch_size).to_a
+          return result if batch.empty?
+          scope.skip(current_page * batch_size).limit(batch_size).each do |item|
+            result << yield(item)
+          end
+          current_page+=1
+        end
       end
     end
   end

data/lib/datagrid/drivers/mongoid.rb

@@ -79,8 +79,17 @@ module Datagrid
         return :string
       end
 
-      def batch_map(scope, &block)
-        scope.map(&block)
+      def batch_map(scope, batch_size, &block)
+        current_page = 0
+        result = []
+        loop do
+          batch = scope.skip(current_page * batch_size).limit(batch_size).to_a
+          return result if batch.empty?
+          scope.skip(current_page * batch_size).limit(batch_size).each do |item|
+            result << yield(item)
+          end
+          current_page+=1
+        end
       end
     end
   end

data/lib/datagrid/form_builder.rb

@@ -36,17 +36,17 @@ module Datagrid
 
     def datagrid_enum_filter(attribute_or_filter, options = {})
       filter = datagrid_get_filter(attribute_or_filter)
-      if !options.has_key?(:multiple) && filter.multiple?
-        options[:multiple] = true
-      end
       if filter.checkboxes?
-        filter.select(options).map do |element|
+        filter.select(object).map do |element|
           text, value = @template.send(:option_text_and_value, element)
-          id = [object_name, filter.name, value.underscore].join('_')
-          input = check_box(filter.name, options.merge(datagrid_extra_checkbox_options).reverse_merge(:id => id, :multiple => true), value, nil)
-          label(filter.name, input + text, :for => id)
+          id = [object_name, filter.name, value].join('_').underscore
+          input = check_box(filter.name, datagrid_extra_checkbox_options.reverse_merge(:id => id, :multiple => true), value.to_s, nil)
+          label(filter.name, input + text, options.reverse_merge(:for => id))
         end.join("\n").html_safe
       else
+        if !options.has_key?(:multiple) && filter.multiple?
+          options[:multiple] = true
+        end
         select filter.name, filter.select(object) || [], {:include_blank => filter.include_blank, :prompt => filter.prompt, :include_hidden => false}, options
       end
     end

data/spec/datagrid/columns_spec.rb

@@ -177,4 +177,33 @@ describe Datagrid::Columns do
       report.assets.should == [second, first]
     end
   end
+
+  describe "fetching data in batches" do
+    it "should pass the batch size to the find_each method" do
+      report = test_report do
+        scope { Entry }
+        column :id
+        self.batch_size = 25
+      end
+
+      fake_assets = double(:assets)
+      report.should_receive(:assets) { fake_assets }
+      fake_assets.should_receive(:find_each).with(batch_size: 25)
+      report.rows
+    end
+    it "should be able to disable batches" do
+      report = test_report do
+        scope { Entry }
+        column :id
+        self.batch_size = 0
+      end
+
+      fake_assets = double(:assets)
+
+      report.should_receive(:assets) { fake_assets }
+      fake_assets.should_receive(:map)
+      fake_assets.should_not_receive(:find_each)
+      report.rows
+    end
+  end
 end

data/spec/datagrid/drivers/mongoid_spec.rb

@@ -61,5 +61,15 @@ describe Datagrid::Drivers::Mongoid do
         end
       }.should raise_error(Datagrid::OrderUnsupported)
     end
+
+    it "should support batch_size" do
+      report = test_report do
+        scope { MongoidEntry }
+        self.batch_size = 1 
+        column(:name)
+      end
+
+      report.data.should == [["Name"], ["Main First"], ["Main Second"]]
+    end
   end
 end

data/spec/datagrid/form_builder_spec.rb

@@ -236,8 +236,8 @@ describe Datagrid::FormBuilder do
         let(:_filter) { :category }
         it { should equal_to_dom(
           '
-<label for="report_category_first"><input class="category enum_filter" id="report_category_first" name="report[category][]" type="checkbox" value="first" />first</label>
-<label for="report_category_second"><input class="category enum_filter" id="report_category_second" name="report[category][]" type="checkbox" value="second" />second</label>
+<label class="category enum_filter" for="report_category_first"><input id="report_category_first" name="report[category][]" type="checkbox" value="first" />first</label>
+<label class="category enum_filter" for="report_category_second"><input id="report_category_second" name="report[category][]" type="checkbox" value="second" />second</label>
 '
         )}
       end

data/spec/datagrid_spec.rb

@@ -53,6 +53,26 @@ describe SimpleReport do
     end
   end
 
+  describe ".batch_size" do
+    context "when not defined on class level" do
+      it "returns nil" do
+        subject.batch_size.should == 1000
+      end
+    end
+
+    context "when defined in the grid class" do
+      subject do
+        test_report do
+          self.batch_size = 25
+        end
+      end
+
+      it "returns the configured batch size" do
+        subject.batch_size.should == 25
+      end
+    end
+
+  end
 
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -344,7 +328,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1961249610796694956
+      hash: -4547966346096518826
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: