datagrid 1.2.3 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8de0a49e930204781d435c0511d30f851660187e
+  data.tar.gz: b078647180e79a1b9bbcb2f76af728f39c2af9ea
+SHA512:
+  metadata.gz: eaa488b20a9949bbb4e94876b376bdcdea83560ff1e254509e464f7087d6e3bc07e77f0b024bd758fa163f5e81fdd28732b26e68e4059dc460f2761015bd7a01
+  data.tar.gz: ad2ea23cbf87bb2ec73fdf776904c524b8444e16db9df85a7be20aed445c4e15be624ce9d198f66f4b84168dcff5a91f9df402a4872dbef2c572f0fb1ac9477c

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/datagrid.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: datagrid 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "1.2.3"
+  s.version = "1.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2014-07-01"
+  s.date = "2014-07-23"
   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 = [
@@ -117,12 +119,11 @@ 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 = "2.2.2"
   s.summary = "Ruby gem to create datagrids"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>, [">= 3.0"])

data/lib/datagrid/columns.rb

@@ -21,6 +21,9 @@ module Datagrid
         self.columns_array = []
 
         class_attribute :dynamic_block, :instance_writer => false
+        
+        class_attribute :cached
+        self.cached = false
 
       end
       base.send :include, InstanceMethods
@@ -302,7 +305,7 @@ module Datagrid
         end
       end
 
-      # Returns a CSV representation of the data in the table
+      # Returns a CSV representation of the data in the grid
       # You are able to specify which columns you want to see in CSV.
       # All data columns are included by default
       # Also you can specify options hash as last argument that is proxied to
@@ -382,7 +385,7 @@ module Datagrid
         end
       end
 
-      # Returns an object representing a table row.
+      # Returns an object representing a grid row.
       # Allows to access column values
       #
       # Example:
@@ -439,16 +442,71 @@ module Datagrid
 
       # Return a cell data value for given column name and asset
       def data_value(column_name, asset)
-        column_by_name(column_name).data_value(asset, self)
+        column = column_by_name(column_name)
+        cache(column, asset, :data_value) do
+          raise "no data value for #{column.name} column" unless column.data?
+          result = generic_value(column, asset)
+          result.is_a?(Datagrid::Columns::Column::ResponseFormat) ? result.call_data : result
+        end
       end
 
       # Return a cell HTML value for given column name and asset and view context
       def html_value(column_name, context, asset)
-        column_by_name(column_name).html_value(context, asset, self)
+        column  = column_by_name(column_name)
+        cache(column, asset, :html_value) do
+          if column.html? && column.html_block
+            value_from_html_block(context, asset, column)
+          else
+            result = generic_value(column, asset)
+            result.is_a?(Datagrid::Columns::Column::ResponseFormat) ? result.call_html(context) : result
+          end
+        end
+      end
+
+
+      def generic_value(column, model) #:nodoc:
+        cache(column, model, :generic_value) do
+          unless column.enabled?(self)
+            raise Datagrid::ColumnUnavailableError, "Column #{column.name} disabled for #{inspect}"
+          end
+
+          if column.data_block.arity >= 1
+            Datagrid::Utils.apply_args(model, self, data_row(model), &column.data_block)
+          else
+            model.instance_eval(&column.data_block)
+          end
+        end
+
       end
 
       protected
 
+      def cache(column, asset, type)
+        @cache ||= {}
+        unless cached?
+          @cache.clear
+          return yield
+        end
+        key = cache_key(asset)
+        unless key
+          raise(Datagrid::CacheKeyError, "Datagrid Cache key is #{key.inspect} for #{asset.inspect}.")
+        end
+        @cache[column.name] ||= {}
+        @cache[column.name][key] ||= {}
+        @cache[column.name][key][type] ||= yield
+      end
+
+      def cache_key(asset)
+        if cached.respond_to?(:call)
+          cached.call(asset)
+        else
+          driver.default_cache_key(asset)
+        end
+      rescue NotImplementedError
+        raise Datagrid::ConfigurationError, "#{self} is setup to use cache. But there was appropriate cache key found for #{asset.inspect}. Please set cached option to block with asset as argument and cache key as returning value to resolve the issue."
+      end
+
+
       def map_with_batches(&block)
         result = []
         each_with_batches do |asset|
@@ -475,6 +533,20 @@ module Datagrid
         end
       end
 
+      def value_from_html_block(context, asset, column)
+        args = []
+        remaining_arity = column.html_block.arity
+
+        if column.data?
+          args << data_value(column, asset)
+          remaining_arity -= 1
+        end
+
+        args << asset if remaining_arity > 0
+        args << self if remaining_arity > 1
+
+        context.instance_exec(*args, &column.html_block)
+      end
     end # InstanceMethods
 
     class DataRow

data/lib/datagrid/columns/column.rb

@@ -46,9 +46,8 @@ class Datagrid::Columns::Column
   end
 
   def data_value(model, grid)
-    raise "no data value for #{name} column" unless data?
-    result = generic_value(model,grid)
-    result.is_a?(ResponseFormat) ? result.call_data : result
+    # backward compatibility method
+    grid.data_value(name, model)
   end
 
 
@@ -75,7 +74,7 @@ class Datagrid::Columns::Column
 
   def order_by_value(model, grid)
     if options[:order_by_value] == true
-      data_value(model, grid)
+      grid.data_value(self, model)
     else
       Datagrid::Utils.apply_args(model, grid, &options[:order_by_value])
     end
@@ -115,28 +114,9 @@ class Datagrid::Columns::Column
   end
 
   def html_value(context, asset, grid)
-    if html? && html_block
-      value_from_html_block(context, asset, grid)
-    else
-      result = generic_value(asset,grid)
-      result.is_a?(ResponseFormat) ? result.call_html(context) : result
-    end
+    grid.html_value(name, context, asset)
   end
 
-  def value_from_html_block(context, asset, grid)
-    args = []
-    remaining_arity = html_block.arity
-
-    if data?
-      args << data_value(asset,grid)
-      remaining_arity -= 1
-    end
-
-    args << asset if remaining_arity > 0
-    args << grid if remaining_arity > 1
-
-    return context.instance_exec(*args, &html_block)
-  end
 
   def block
     Datagrid::Utils.warn_once("Datagrid::Columns::Column#block is deprecated. Use #html_block or #data_block instead")
@@ -144,14 +124,7 @@ class Datagrid::Columns::Column
   end
 
   def generic_value(model, grid)
-    unless enabled?(grid)
-      raise Datagrid::ColumnUnavailableError, "Column #{name} disabled for #{grid.inspect}"
-    end
-    if self.data_block.arity >= 1
-      Datagrid::Utils.apply_args(model, grid, grid.data_row(model), &data_block)
-    else
-      model.instance_eval(&self.data_block)
-    end
+    grid.generic_value(self, model)
   end
 
   private

data/lib/datagrid/drivers/abstract_driver.rb

@@ -90,6 +90,10 @@ module Datagrid
         end
       end
 
+      def default_cache_key(asset)
+        raise NotImplementedError
+      end
+
       protected
       def timestamp_class?(klass)
         TIMESTAMP_CLASSES.include?(klass)

data/lib/datagrid/drivers/active_record.rb

@@ -105,6 +105,10 @@ module Datagrid
         scope.find_each(batch_size ? { :batch_size => batch_size} : {}, &block)
       end
 
+      def default_cache_key(asset)
+        asset.id || raise(NotImplementedError)
+      end
+
       protected
 
       def prefix_table_name(scope, field)

data/lib/datagrid/drivers/array.rb

@@ -68,6 +68,10 @@ module Datagrid
       def batch_each(scope, batch_size, &block)
         scope.each(&block)
       end
+      
+      def default_cache_key(asset)
+        asset
+      end
     end
   end
 end

data/lib/datagrid/drivers/mongo_mapper.rb

@@ -67,6 +67,10 @@ module Datagrid
           current_page+=1
         end
       end
+
+      def default_cache_key(asset)
+        raise NotImplementedError
+      end
     end
   end
 end

data/lib/datagrid/drivers/mongoid.rb

@@ -90,6 +90,10 @@ module Datagrid
           current_page+=1
         end
       end
+
+      def default_cache_key(asset)
+        asset.id || raise(NotImplementedError)
+      end
     end
   end
 end

data/spec/datagrid/columns_spec.rb

@@ -406,4 +406,22 @@ describe Datagrid::Columns do
       }.to raise_error(Datagrid::ColumnUnavailableError)
     end
   end
+
+  describe "caching" do
+    it "should work when enabled in class" do
+      grid = test_report do
+        scope {Entry}
+        self.cached = true
+        column(:random1) {rand(10**9)}
+        column(:random2) {rand(10**9)}
+      end
+
+      row = grid.data_row(Entry.create!)
+      expect(row.random1).to eq(row.random1)
+      expect(row.random2).to_not eq(row.random1)
+      grid.cached = false
+      expect(row.random2).to_not eq(row.random2)
+      expect(row.random2).to_not eq(row.random1)
+    end
+  end
 end

data/spec/datagrid/helper_spec.rb

@@ -16,7 +16,7 @@ describe Datagrid::Helper do
   before(:each) do
     allow(subject).to receive(:params).and_return({})
     allow(subject).to receive(:url_for) do |options|
-      options.to_param
+      options.is_a?(String) ? options : ["/location", options.to_param.presence].compact.join('?')
     end
 
   end
@@ -341,8 +341,8 @@ describe Datagrid::Helper do
         grid = OrderedGrid.new(:descending => true, :order => :category)
         expect(subject.datagrid_order_for(grid, grid.column_by_name(:category))).to equal_to_dom(<<-HTML)
 <div class="order">
-  <a href="ordered_grid%5Bdescending%5D=false&amp;ordered_grid%5Border%5D=category" class="asc">&uarr;</a>
-  <a href="ordered_grid%5Bdescending%5D=true&amp;ordered_grid%5Border%5D=category" class="desc">&darr;</a>
+  <a href="/location?ordered_grid%5Bdescending%5D=false&amp;ordered_grid%5Border%5D=category" class="asc">&uarr;</a>
+  <a href="/location?ordered_grid%5Bdescending%5D=true&amp;ordered_grid%5Border%5D=category" class="desc">&darr;</a>
 </div>
         HTML
       end
@@ -368,7 +368,7 @@ describe Datagrid::Helper do
           "form .filter label" => "Category",
           "form .filter input.category.default_filter[name='form_for_grid[category]'][value=hello]" => 1,
           "form input[name=commit][value=Search]" => 1,
-          "form a.datagrid-reset[href='']" => 1
+          "form a.datagrid-reset[href='/location']" => 1
         )
       end
       it "should support html classes for grid class with namespace" do
@@ -459,5 +459,28 @@ describe Datagrid::Helper do
       end
       expect(subject.datagrid_value(report, :name, entry)).to eq("<a href=\"/profile\">Star</a>")
     end
+
+    it "should use cache" do
+      grid = test_report do
+        scope {Entry}
+        self.cached = true
+        column(:random1, html: true) {rand(10**9)}
+        column(:random2) {|model| format(rand(10**9)) {|value| value}}
+      end
+
+      entry = Entry.create!
+
+      data_row = grid.data_row(entry)
+      html_row = subject.datagrid_row(grid, entry)
+      expect(html_row.random1).to eq(html_row.random1)
+      expect(html_row.random2).to_not eq(html_row.random1)
+      expect(data_row.random2).to eq(html_row.random2)
+      expect(data_row.random2).to_not eq(html_row.random1)
+      grid.cached = false
+      expect(html_row.random2).to_not eq(html_row.random2)
+      expect(html_row.random2).to_not eq(html_row.random1)
+      expect(data_row.random2).to_not eq(html_row.random2)
+      expect(data_row.random2).to_not eq(html_row.random1)
+    end
   end
 end

metadata

@@ -1,164 +1,144 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.2.3
-  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   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: jeweler
   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: debugger
   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: byebug
   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: ruby-debug
   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: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   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: sqlite3
   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: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -166,7 +146,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -174,23 +153,20 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: bson
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -198,7 +174,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -206,7 +181,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -214,7 +188,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - '='
       - !ruby/object:Gem::Version
@@ -222,17 +195,15 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: fastercsv
   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'
 description: This allows you to easily build datagrid aka data tables with sortable
@@ -243,9 +214,9 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 files:
-- .document
-- .rspec
-- .travis.yml
+- ".document"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - Rakefile
@@ -344,29 +315,25 @@ files:
 homepage: http://github.com/bogdan/datagrid
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1488750085625410873
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby gem to create datagrids
 test_files: []