datagrid 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 652aabb87668eb9c636d3a0b03249f79f8df4c1b
-  data.tar.gz: 71de05a4267561305a3e2badc2aa33e1eb88cf35
+  metadata.gz: 6dff6baaffd8e634c9e7d93754752f3389860060
+  data.tar.gz: f4f7c4d3092942e52f5d9c365c914e32b36b4fb3
 SHA512:
-  metadata.gz: 5db3557c03071721e24d355ac939ab76f29167c252c9cfda160a618e4f1b7737dfc241c808de1ccd1a75a8c7b2a9c16490a1d96500065c196413f6548e47b9ed
-  data.tar.gz: c34e6068303b5aa6d351869fe7d734cc4034305de5e649ea9480e74ec3dddb39b2d34ff16277f1f4a792c670d36b09cf8b826a0888a8d23906c1682facd68ac9
+  metadata.gz: aa1c966c59b28eb7247e8fb8c660765e22608f3308153d3715610e5e45590b210cef2cd951dc1fe8f4e1489c3b4894623fd057b90f66be9b184b16bb510896de
+  data.tar.gz: 8a673590ea08d5618fac8f984ee56c5fbd61d8287aacf37caf7ff3cb2090c8b448d217603a67485aa28fc1d8402fe5fb8536cc1c75976369061a0362298e7829

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 #bundler_args: --without development
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.1
   - 2.2.0

data/Gemfile

@@ -5,11 +5,11 @@ gem "rails", ">= 3.2.22.2"
 group :development do
 
   gem "bundler"
-  gem "jeweler"
+  gem "jeweler", github: "technicalpickles/jeweler"
 
 
   gem "debugger", :platform => :ruby_19
-  gem "byebug", :platform => [:ruby_20, :ruby_21, :ruby_22, :ruby_23] & Bundler::Dsl::VALID_PLATFORMS
+  gem "pry-byebug", :platform => [:ruby_20, :ruby_21, :ruby_22, :ruby_23] & Bundler::Dsl::VALID_PLATFORMS
 
   gem "rspec", ">= 3"
   gem "nokogiri" # used to test html output

data/Rakefile

@@ -21,6 +21,7 @@ Jeweler::Tasks.new do |gem|
   gem.description = %Q{This allows you to easily build datagrid aka data tables with sortable columns and filters}
   gem.email = "agresso@gmail.com"
   gem.authors = ["Bogdan Gusiev"]
+  gem.required_ruby_version = '>= 2.0'
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/Readme.markdown

@@ -20,6 +20,12 @@ Ruby library that helps you to build and represent table-like data with:
 
 [Create an issue](https://github.com/bogdan/datagrid/issues/new) if you want more.
 
+
+### Dependencies
+
+* Ruby >= 2.0
+* Rails >= 3.2
+
 ### Live Demo
 
 [Datagrid DEMO application](http://datagrid.herokuapp.com) is available live!

data/VERSION

@@ -1 +1 @@
-1.4.4
+1.5.0

data/datagrid.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: datagrid 1.4.4 ruby lib
+# stub: datagrid 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "datagrid"
-  s.version = "1.4.4"
+  s.name = "datagrid".freeze
+  s.version = "1.5.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 = "2016-07-22"
-  s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
-  s.email = "agresso@gmail.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Bogdan Gusiev".freeze]
+  s.date = "2016-10-13"
+  s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters".freeze
+  s.email = "agresso@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt"
   ]
@@ -126,57 +126,97 @@ Gem::Specification.new do |s|
     "templates/grid.rb.erb",
     "templates/index.html.erb"
   ]
-  s.homepage = "http://github.com/bogdan/datagrid"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "Ruby gem to create datagrids"
+  s.homepage = "http://github.com/bogdan/datagrid".freeze
+  s.licenses = ["MIT".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.0".freeze)
+  s.rubygems_version = "2.6.7".freeze
+  s.summary = "Ruby gem to create datagrids".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>, [">= 3.2.22.2"])
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<debugger>, [">= 0"])
-      s.add_development_dependency(%q<byebug>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 3"])
-      s.add_development_dependency(%q<nokogiri>, [">= 0"])
-      s.add_development_dependency(%q<sqlite3>, [">= 0"])
-      s.add_development_dependency(%q<sequel>, [">= 0"])
-      s.add_development_dependency(%q<mongoid>, ["= 3.1.7"])
-      s.add_development_dependency(%q<mongo_mapper>, ["~> 0.13.0"])
-      s.add_development_dependency(%q<bson>, [">= 0"])
-      s.add_development_dependency(%q<bson_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+      s.add_runtime_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<debugger>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<rspec>.freeze, [">= 3"])
+      s.add_runtime_dependency(%q<nokogiri>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<sqlite3>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<sequel>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+      s.add_runtime_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+      s.add_runtime_dependency(%q<bson>.freeze, [">= 0"])
+      s.add_runtime_dependency(%q<bson_ext>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+      s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<debugger>.freeze, [">= 0"])
+      s.add_development_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 3"])
+      s.add_development_dependency(%q<nokogiri>.freeze, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>.freeze, [">= 0"])
+      s.add_development_dependency(%q<sequel>.freeze, [">= 0"])
+      s.add_development_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+      s.add_development_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+      s.add_development_dependency(%q<bson>.freeze, [">= 0"])
+      s.add_development_dependency(%q<bson_ext>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<rails>, [">= 3.2.22.2"])
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<debugger>, [">= 0"])
-      s.add_dependency(%q<byebug>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 3"])
-      s.add_dependency(%q<nokogiri>, [">= 0"])
-      s.add_dependency(%q<sqlite3>, [">= 0"])
-      s.add_dependency(%q<sequel>, [">= 0"])
-      s.add_dependency(%q<mongoid>, ["= 3.1.7"])
-      s.add_dependency(%q<mongo_mapper>, ["~> 0.13.0"])
-      s.add_dependency(%q<bson>, [">= 0"])
-      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+      s.add_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<debugger>.freeze, [">= 0"])
+      s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 3"])
+      s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
+      s.add_dependency(%q<sqlite3>.freeze, [">= 0"])
+      s.add_dependency(%q<sequel>.freeze, [">= 0"])
+      s.add_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+      s.add_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+      s.add_dependency(%q<bson>.freeze, [">= 0"])
+      s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
+      s.add_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+      s.add_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+      s.add_dependency(%q<debugger>.freeze, [">= 0"])
+      s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+      s.add_dependency(%q<rspec>.freeze, [">= 3"])
+      s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
+      s.add_dependency(%q<sqlite3>.freeze, [">= 0"])
+      s.add_dependency(%q<sequel>.freeze, [">= 0"])
+      s.add_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+      s.add_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+      s.add_dependency(%q<bson>.freeze, [">= 0"])
+      s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<rails>, [">= 3.2.22.2"])
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<debugger>, [">= 0"])
-    s.add_dependency(%q<byebug>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 3"])
-    s.add_dependency(%q<nokogiri>, [">= 0"])
-    s.add_dependency(%q<sqlite3>, [">= 0"])
-    s.add_dependency(%q<sequel>, [">= 0"])
-    s.add_dependency(%q<mongoid>, ["= 3.1.7"])
-    s.add_dependency(%q<mongo_mapper>, ["~> 0.13.0"])
-    s.add_dependency(%q<bson>, [">= 0"])
-    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+    s.add_dependency(%q<bundler>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<debugger>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 3"])
+    s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
+    s.add_dependency(%q<sqlite3>.freeze, [">= 0"])
+    s.add_dependency(%q<sequel>.freeze, [">= 0"])
+    s.add_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+    s.add_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+    s.add_dependency(%q<bson>.freeze, [">= 0"])
+    s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
+    s.add_dependency(%q<rails>.freeze, [">= 3.2.22.2"])
+    s.add_dependency(%q<bundler>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
+    s.add_dependency(%q<debugger>.freeze, [">= 0"])
+    s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
+    s.add_dependency(%q<rspec>.freeze, [">= 3"])
+    s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
+    s.add_dependency(%q<sqlite3>.freeze, [">= 0"])
+    s.add_dependency(%q<sequel>.freeze, [">= 0"])
+    s.add_dependency(%q<mongoid>.freeze, ["= 3.1.7"])
+    s.add_dependency(%q<mongo_mapper>.freeze, ["~> 0.13.0"])
+    s.add_dependency(%q<bson>.freeze, [">= 0"])
+    s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
   end
 end
 

data/lib/datagrid/columns.rb

@@ -119,6 +119,7 @@ module Datagrid
       #   * <tt>:after</tt> - determines the position of this column, by adding it after the column passed here
       #   * <tt>:if</tt> - the column is shown if the reult of calling this argument is true
       #   * <tt>:unless</tt> - the column is shown unless the reult of calling this argument is true
+      #   * <tt>:preload</tt> - spefies which associations of the scope should be preloaded for this column
       #
       # See: https://github.com/bogdan/datagrid/wiki/Columns for examples
       def column(name, options_or_query = {}, options = {}, &block)
@@ -225,7 +226,9 @@ module Datagrid
         args.compact!
         args.map!(&:to_sym)
         columns.select do |column|
-          (!options[:data] || column.data?) && (!options[:html] || column.html?) && (column.mandatory? || args.empty? || args.include?(column.name))
+          (!options[:data] || column.data?) &&
+            (!options[:html] || column.html?) &&
+            (column.mandatory? || args.empty? || args.include?(column.name))
         end
       end
 
@@ -240,7 +243,9 @@ module Datagrid
           model.send(name)
         end
         position = Datagrid::Utils.extract_position_from_options(columns, options)
-        column = Datagrid::Columns::Column.new(self, name, query, default_column_options.merge(options), &block)
+        column = Datagrid::Columns::Column.new(
+          self, name, query, default_column_options.merge(options), &block
+        )
         columns.insert(position, column)
       end
 
@@ -256,7 +261,11 @@ module Datagrid
     module InstanceMethods
 
       def assets
-        driver.append_column_queries(super, columns.select(&:query))
+        append_column_preload(
+          driver.append_column_queries(
+            super, columns.select(&:query)
+          )
+        )
       end
 
       # Returns <tt>Array</tt> of human readable column names. See also "Localization" section
@@ -513,6 +522,12 @@ module Datagrid
 
       protected
 
+      def append_column_preload(scope)
+        columns.inject(scope) do |current, column|
+          column.append_preload(current)
+        end
+      end
+
       def cache(column, asset, type)
         @cache ||= {}
         unless cached?

data/lib/datagrid/columns/column.rb

@@ -69,7 +69,7 @@ class Datagrid::Columns::Column
     if options.has_key?(:order) && options[:order] != true
       self.options[:order]
     else
-      grid_class.driver.default_order(grid_class.scope, name)
+      driver.default_order(grid_class.scope, name)
     end
   end
 
@@ -107,8 +107,7 @@ class Datagrid::Columns::Column
   end
 
   def enabled?(grid)
-    column_availability(grid, options[:if], true) &&
-      !column_availability(grid, options[:unless], false)
+    ::Datagrid::Utils.process_availability(grid, options[:if], options[:unless])
   end
 
   def inspect
@@ -133,21 +132,36 @@ class Datagrid::Columns::Column
     grid.generic_value(self, model)
   end
 
-  private
-  def column_availability(grid, option, default)
-    case option
-    when nil
-      default
-    when Proc
-      option.call(grid)
-    when Symbol, String
-      grid.send(option.to_sym)
+  def append_preload(scope)
+    return scope unless preload
+    if preload.respond_to?(:call)
+      return scope unless preload
+      if preload.arity == 1
+        preload.call(scope)
+      else
+        scope.instance_exec(&preload)
+      end
     else
-      raise Datagrid::ConfigurationError, "Incorrect column availability option: #{option.insepct}"
+      driver.default_preload(scope, preload)
     end
   end
 
+  def preload
+    preload = options[:preload]
+
+    if [nil, true].include?(preload) && driver.can_preload?(driver.to_scope(grid_class.scope), name)
+      name
+    else
+      preload
+    end
+
+  end
+
   def callable(value)
     value.respond_to?(:call) ? value.call : value
   end
+
+  def driver
+    grid_class.driver
+  end
 end

data/lib/datagrid/core.rb

@@ -35,7 +35,11 @@ module Datagrid
       # Defines a scope at class level
       def scope(&block)
         if block
-          self.scope_value = block
+          current_scope = scope_value
+          self.scope_value = proc {
+            Datagrid::Utils.apply_args(current_scope ? current_scope.call : nil, &block)
+          }
+          self
         else
           check_scope_defined!
           scope_value.call
@@ -144,7 +148,12 @@ module Datagrid
 
       # Resets current instance scope to default scope defined in a class
       def reset_scope
-        scope(&self.class.scope_value)
+        self.scope_value = self.class.scope_value
+      end
+
+      # Returns true if the scope was redefined for this instance of grid object
+      def redefined_scope?
+        self.class.scope_value != scope_value
       end
 
       def driver #:nodoc:

data/lib/datagrid/drivers/abstract_driver.rb

@@ -105,6 +105,14 @@ module Datagrid
         scope
       end
 
+      def default_preload(scope, value)
+        raise NotImplementedError
+      end
+
+      def can_preload?(scope, association)
+        raise NotImplementedError
+      end
+
       protected
       def timestamp_class?(klass)
         TIMESTAMP_CLASSES.include?(klass)

data/lib/datagrid/drivers/active_record.rb

@@ -116,6 +116,14 @@ module Datagrid
         asset.id || raise(NotImplementedError)
       end
 
+      def default_preload(scope, value)
+        scope.preload(value)
+      end
+
+      def can_preload?(scope, association)
+        !! scope.klass.reflect_on_association(association)
+      end
+
       protected
 
       def prefix_table_name(scope, field)

data/lib/datagrid/drivers/array.rb

@@ -68,10 +68,14 @@ module Datagrid
       def batch_each(scope, batch_size, &block)
         scope.each(&block)
       end
-      
+
       def default_cache_key(asset)
         asset
       end
+
+      def can_preload?(scope, association)
+        false
+      end
     end
   end
 end

data/lib/datagrid/drivers/mongo_mapper.rb

@@ -71,6 +71,14 @@ module Datagrid
       def default_cache_key(asset)
         raise NotImplementedError
       end
+
+      def default_preload(scope, value)
+        raise NotImplementedError
+      end
+
+      def can_preload?(scope, association)
+        false
+      end
     end
   end
 end

data/lib/datagrid/drivers/mongoid.rb

@@ -94,6 +94,15 @@ module Datagrid
       def default_cache_key(asset)
         asset.id || raise(NotImplementedError)
       end
+
+      def default_preload(scope, value)
+        scope.includes(value)
+      end
+
+      def can_preload?(scope, association)
+        !! scope.klass.reflect_on_association(association)
+      end
+
     end
   end
 end