datagrid 1.5.8 → 1.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa302439fb009cb596541a3cd2c6d5d584dc973c
-  data.tar.gz: 53a5b714ec1ecc3279c7cd0fb278c7c4c150785d
+SHA256:
+  metadata.gz: 4accb02f36dc5af245b6dd84008c22293e9bc0f6105b7fdfebe9458b6a7fa1e1
+  data.tar.gz: 4ca75ebff1804e8eaba5b0e41cae04e32f63c24211baffdc501a93870e1ba7e2
 SHA512:
-  metadata.gz: 72b9bb255878dafebf1a932ee8908fedeba902e306480ebe3a1792267c63f19ff61959336be9d7c48f4df9b8f922f24ba21c781e9c000708a632d1b45577f1ac
-  data.tar.gz: ec7577b30d0579b9ba106e220d4c89c2d2fb70bb83f33d31fce3feb4396a7bb28850ef81664187567696b585b26c2ef0873f2165859f36fe9d6233e3e092409d
+  metadata.gz: e8ab20bbbaec525f993c7e20a1ed5bd0105f6d2fc0c9ab098570401e610b7030a696c263959478b0cb4a39ecf921c81e5621bb76198cbc96060f433f23cbcaa5
+  data.tar.gz: 9158b9d0f26ee862292a5fdc0d9b596ee2ac70e52006cb559af1bfc043a5d43419c476e1b5a796a42a19e7bc5efcfb9e2b4e37e0fdfa9a8286c795a505aad573

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.6.2
+
+* Add `input_options` and `label_options` to `filter` method [#294](https://github.com/bogdan/datagrid/issues/294)
+* Fix `<option>` tag rendering for Rails 6.0
+
+## 1.6.1 and before
+
+Changes are not tracked

data/Readme.markdown

@@ -1,6 +1,7 @@
 # Datagrid
 
 [![Build Status](https://travis-ci.org/bogdan/datagrid.svg?branch=master)](https://travis-ci.org/bogdan/datagrid)
+
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_shield)
 
 Ruby library that helps you to build and represent table-like data with:
@@ -201,4 +202,4 @@ Read [author blog](http://gusiev.com).
 
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_large)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_large)

data/app/views/datagrid/_table.html.erb

@@ -11,7 +11,7 @@ Local variables:
     </thead>
     <tbody>
       <% if assets.any? %>
-        <%= datagrid_rows(grid, assets, options) %>
+        <%= datagrid_rows(grid, assets, **options) %>
       <% else %>
         <tr><td class="noresults" colspan="100%"><%= I18n.t('datagrid.no_results').html_safe %></td></tr>
       <% end %>

data/datagrid.gemspec

@@ -1,178 +1,41 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
-# stub: datagrid 1.5.8 ruby lib
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "datagrid/version"
 
 Gem::Specification.new do |s|
-  s.name = "datagrid".freeze
-  s.version = "1.5.8"
-
-  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 = "2017-12-12"
-  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.name = "datagrid"
+  s.version = Datagrid::VERSION
+  s.require_paths = ["lib"]
+  s.authors = ["Bogdan Gusiev"]
+  s.date = "2020-09-07"
+  s.summary = "Ruby gem to create datagrids"
+  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 = [
-    "LICENSE.txt"
+    "LICENSE.txt",
+    "Readme.markdown"
   ]
   s.files = [
-    ".document",
-    ".rspec",
-    ".travis.yml",
-    "Gemfile",
     "LICENSE.txt",
-    "Rakefile",
+    "CHANGELOG.md",
     "Readme.markdown",
-    "VERSION",
-    "app/assets/stylesheets/datagrid.sass",
-    "app/views/datagrid/_enum_checkboxes.html.erb",
-    "app/views/datagrid/_form.html.erb",
-    "app/views/datagrid/_head.html.erb",
-    "app/views/datagrid/_order_for.html.erb",
-    "app/views/datagrid/_range_filter.html.erb",
-    "app/views/datagrid/_row.html.erb",
-    "app/views/datagrid/_table.html.erb",
     "datagrid.gemspec",
-    "lib/datagrid.rb",
-    "lib/datagrid/active_model.rb",
-    "lib/datagrid/column_names_attribute.rb",
-    "lib/datagrid/columns.rb",
-    "lib/datagrid/columns/column.rb",
-    "lib/datagrid/configuration.rb",
-    "lib/datagrid/core.rb",
-    "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/drivers/sequel.rb",
-    "lib/datagrid/engine.rb",
-    "lib/datagrid/filters.rb",
-    "lib/datagrid/filters/base_filter.rb",
-    "lib/datagrid/filters/boolean_enum_filter.rb",
-    "lib/datagrid/filters/boolean_filter.rb",
-    "lib/datagrid/filters/composite_filters.rb",
-    "lib/datagrid/filters/date_filter.rb",
-    "lib/datagrid/filters/date_time_filter.rb",
-    "lib/datagrid/filters/default_filter.rb",
-    "lib/datagrid/filters/dynamic_filter.rb",
-    "lib/datagrid/filters/enum_filter.rb",
-    "lib/datagrid/filters/extended_boolean_filter.rb",
-    "lib/datagrid/filters/float_filter.rb",
-    "lib/datagrid/filters/integer_filter.rb",
-    "lib/datagrid/filters/ranged_filter.rb",
-    "lib/datagrid/filters/select_options.rb",
-    "lib/datagrid/filters/string_filter.rb",
-    "lib/datagrid/form_builder.rb",
-    "lib/datagrid/helper.rb",
-    "lib/datagrid/locale/en.yml",
-    "lib/datagrid/ordering.rb",
-    "lib/datagrid/renderer.rb",
-    "lib/datagrid/rspec.rb",
-    "lib/datagrid/scaffold.rb",
-    "lib/datagrid/utils.rb",
-    "lib/tasks/datagrid_tasks.rake",
-    "spec/datagrid/active_model_spec.rb",
-    "spec/datagrid/column_names_attribute_spec.rb",
-    "spec/datagrid/columns/column_spec.rb",
-    "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/drivers/sequel_spec.rb",
-    "spec/datagrid/filters/base_filter_spec.rb",
-    "spec/datagrid/filters/boolean_enum_filter_spec.rb",
-    "spec/datagrid/filters/composite_filters_spec.rb",
-    "spec/datagrid/filters/date_filter_spec.rb",
-    "spec/datagrid/filters/date_time_filter_spec.rb",
-    "spec/datagrid/filters/dynamic_filter_spec.rb",
-    "spec/datagrid/filters/enum_filter_spec.rb",
-    "spec/datagrid/filters/extended_boolean_filter_spec.rb",
-    "spec/datagrid/filters/float_filter_spec.rb",
-    "spec/datagrid/filters/integer_filter_spec.rb",
-    "spec/datagrid/filters/string_filter_spec.rb",
-    "spec/datagrid/filters_spec.rb",
-    "spec/datagrid/form_builder_spec.rb",
-    "spec/datagrid/helper_spec.rb",
-    "spec/datagrid/ordering_spec.rb",
-    "spec/datagrid/scaffold_spec.rb",
-    "spec/datagrid/stylesheet_spec.rb",
-    "spec/datagrid/utils_spec.rb",
-    "spec/datagrid_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/support/active_record.rb",
-    "spec/support/configuration.rb",
-    "spec/support/i18n_helpers.rb",
-    "spec/support/matchers.rb",
-    "spec/support/mongo_mapper.rb",
-    "spec/support/mongoid.rb",
-    "spec/support/sequel.rb",
-    "spec/support/simple_report.rb",
-    "spec/support/test_partials/_actions.html.erb",
-    "spec/support/test_partials/client/datagrid/_form.html.erb",
-    "spec/support/test_partials/client/datagrid/_head.html.erb",
-    "spec/support/test_partials/client/datagrid/_order_for.html.erb",
-    "spec/support/test_partials/client/datagrid/_row.html.erb",
-    "spec/support/test_partials/client/datagrid/_table.html.erb",
-    "spec/support/test_partials/custom_checkboxes/_enum_checkboxes.html.erb",
-    "spec/support/test_partials/custom_form/_form.html.erb",
-    "spec/support/test_partials/custom_range/_range_filter.html.erb",
-    "templates/base.rb.erb",
-    "templates/controller.rb.erb",
-    "templates/grid.rb.erb",
-    "templates/index.html.erb"
   ]
-  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.14".freeze
-  s.summary = "Ruby gem to create datagrids".freeze
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
+  s.files += `git ls-files | grep -E '^(app|lib|templates)'`.split("\n")
+  s.homepage = "http://github.com/bogdan/datagrid"
+  s.licenses = ["MIT"]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.0")
+  s.rubygems_version = "3.0.8"
+  url = 'https://github.com/bogdan/datagrid'
+  s.metadata = {
+    "homepage_uri" => url,
+    "bug_tracker_uri" => "#{url}/issues",
+    "documentation_uri" => "#{url}/wiki",
+    "changelog_uri" => "#{url}/blob/master/CHANGELOG.md",
+    "source_code_uri" => url,
+  }
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rails>.freeze, [">= 4.0"])
-      s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
-      s.add_development_dependency(%q<jeweler>.freeze, [">= 2.1.2"])
-      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, [">= 0"])
-      s.add_development_dependency(%q<bson>.freeze, [">= 0"])
-      s.add_development_dependency(%q<bson_ext>.freeze, [">= 0"])
-    else
-      s.add_dependency(%q<rails>.freeze, [">= 4.0"])
-      s.add_dependency(%q<bundler>.freeze, [">= 0"])
-      s.add_dependency(%q<jeweler>.freeze, [">= 2.1.2"])
-      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, [">= 0"])
-      s.add_dependency(%q<bson>.freeze, [">= 0"])
-      s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rails>.freeze, [">= 4.0"])
-    s.add_dependency(%q<bundler>.freeze, [">= 0"])
-    s.add_dependency(%q<jeweler>.freeze, [">= 2.1.2"])
-    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, [">= 0"])
-    s.add_dependency(%q<bson>.freeze, [">= 0"])
-    s.add_dependency(%q<bson_ext>.freeze, [">= 0"])
-  end
+  s.add_dependency(%q<rails>, [">= 4.0"])
 end
 

data/lib/datagrid/columns.rb

@@ -16,6 +16,7 @@ module Datagrid
         self.default_column_options = {}
 
         class_attribute :batch_size
+        self.batch_size = 1000
 
         class_attribute :columns_array
         self.columns_array = []
@@ -120,8 +121,8 @@ module Datagrid
       # * <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)
-        define_column(columns_array, name, options_or_query, options, &block)
+      def column(name, query = nil, **options, &block)
+        define_column(columns_array, name, query, options, &block)
       end
 
       # Returns column definition with given name
@@ -194,12 +195,7 @@ module Datagrid
         end
       end
 
-      def define_column(columns, name, options_or_query = {}, options = {}, &block) #:nodoc:
-        if options_or_query.is_a?(String)
-          query = options_or_query
-        else
-          options = options_or_query
-        end
+      def define_column(columns, name, query = nil, **options, &block) #:nodoc:
         check_scope_defined!("Scope should be defined before columns")
         block ||= lambda do |model|
           model.send(name)
@@ -315,9 +311,8 @@ module Datagrid
       def to_csv(*column_names)
         require "csv"
         options = column_names.extract_options!
-        CSV.generate(
-          {:headers => self.header(*column_names), :write_headers => true}.merge!(options)
-        ) do |csv|
+        options = {:headers => self.header(*column_names), :write_headers => true}.merge!(options)
+        CSV.generate(**options) do |csv|
           each_with_batches do |asset|
             csv << row_for(asset, *column_names)
           end
@@ -406,8 +401,8 @@ module Datagrid
       # Defines a column at instance level
       #
       # See Datagrid::Columns::ClassMethods#column for more info
-      def column(name, options_or_query = {}, options = {}, &block) #:nodoc:
-        self.class.define_column(columns_array, name, options_or_query, options, &block)
+      def column(name, query = nil, **options, &block)
+        self.class.define_column(columns_array, name, query, options, &block)
       end
 
       def initialize(*) #:nodoc:
@@ -415,7 +410,7 @@ module Datagrid
         super
       end
 
-      # Returns all columns available for current grid configuration.
+      # Returns all columns that are possible to be displayed for the current grid object
       #
       #   class MyGrid
       #     filter(:search) {|scope, value| scope.full_text_search(value)}
@@ -535,6 +530,8 @@ module Datagrid
       def value_from_html_block(context, asset, column)
         args = []
         remaining_arity = column.html_block.arity
+        remaining_arity = 1 if remaining_arity < 0
+
         asset = decorate(asset)
 
         if column.data?

data/lib/datagrid/columns/column.rb

@@ -123,11 +123,6 @@ class Datagrid::Columns::Column
   end
 
 
-  def block
-    Datagrid::Utils.warn_once("Datagrid::Columns::Column#block is deprecated. Use #html_block or #data_block instead")
-    data_block
-  end
-
   def generic_value(model, grid)
     grid.generic_value(self, model)
   end

data/lib/datagrid/core.rb

@@ -9,7 +9,7 @@ module Datagrid
       base.class_eval do
         class_attribute :scope_value
 
-        class_attribute :datagrid_attributes
+        class_attribute :datagrid_attributes, instance_writer: false
         self.datagrid_attributes = []
 
         class_attribute :dynamic_block, :instance_writer => false
@@ -163,6 +163,9 @@ module Datagrid
       end
 
       # Returns serializable query arguments skipping all nil values
+      #
+      #   grid = ProductsGrid.new(category: 'dresses', available: true)
+      #   grid.as_query # => {category: 'dresses', available: true}
       def as_query
         attributes = self.attributes.clone
         attributes.each do |key, value|
@@ -171,6 +174,15 @@ module Datagrid
         attributes
       end
 
+      # Returns query parameters to link this grid from a page
+      #
+      #   grid = ProductsGrid.new(category: 'dresses', available: true)
+      #   Rails.application.routes.url_helpers.products_path(grid.query_params)
+      #     # => "/products?products_grid[category]=dresses&products_grid[available]=true"
+      def query_params(attributes = {})
+        { param_name.to_sym => as_query.merge(attributes) }
+      end
+
       # Redefines scope at instance level
       #
       #   class MyGrid

data/lib/datagrid/drivers/active_record.rb

@@ -105,7 +105,8 @@ module Datagrid
         if scope.limit_value
           raise Datagrid::ConfigurationError, "ActiveRecord can not use batches in combination with SQL limit"
         end
-        scope.find_each(batch_size ? { :batch_size => batch_size} : {}, &block)
+        options = batch_size ? { batch_size: batch_size } : {}
+        scope.find_each(**options, &block)
       end
 
       def default_cache_key(asset)

data/lib/datagrid/drivers/mongoid.rb

@@ -12,7 +12,11 @@ module Datagrid
       end
 
       def to_scope(scope)
-        scope.where(nil)
+        if scope.respond_to?(:all)
+          scope.all
+        else
+          scope.where(nil)
+        end
       end
 
       def where(scope, attribute, value)

data/lib/datagrid/filters.rb

@@ -53,7 +53,7 @@ module Datagrid
       def filter_by_name(attribute)
         return attribute if attribute.is_a?(Datagrid::Filters::BaseFilter)
         self.filters.find do |filter|
-          filter.name.to_sym == attribute.to_sym
+          filter.name == attribute.to_sym
         end
       end
 
@@ -90,14 +90,11 @@ module Datagrid
       #   Accepts a block or a symbol with an instance method name
       # * <tt>:unless</tt> - specify the reverse condition when the filter can be dislayed and used.
       #   Accepts a block or a symbol with an instance method name
+      # * <tt>:input_options</tt> - options passed when rendering html input tag attributes
+      # * <tt>:label_options</tt> - options passed when rendering html label tag attributes
       #
       # See: https://github.com/bogdan/datagrid/wiki/Filters for examples
-      def filter(name, type = :default, options = {}, &block)
-        if type.is_a?(Hash)
-          options = type
-          type = :default
-        end
-
+      def filter(name, type = :default, **options, &block)
         klass = type.is_a?(Class) ? type : FILTER_TYPES[type]
         raise ConfigurationError, "filter class #{type.inspect} not found" unless klass
 

data/lib/datagrid/filters/base_filter.rb

@@ -7,7 +7,7 @@ class Datagrid::Filters::BaseFilter #:nodoc:
 
   def initialize(grid_class, name, options = {}, &block)
     self.grid_class = grid_class
-    self.name = name
+    self.name = name.to_sym
     self.options = options
     self.block = block || default_filter_block
   end
@@ -61,18 +61,10 @@ class Datagrid::Filters::BaseFilter #:nodoc:
     end
   end
 
-  def default(object = nil)
-    unless object
-      Datagrid::Utils.warn_once("#{self.class.name}#default without argument is deprecated")
-    end
+  def default(object)
     default = self.options[:default]
     if default.is_a?(Symbol)
-      if object.respond_to?(default)
-        object.send(default)
-      else
-        Datagrid::Utils.warn_once(":default as a Symbol is now treated as a method name. Use String instead or -> { default } if you really want default value to be a Symbol but not a String.")
-        default
-      end
+      object.send(default)
     elsif default.respond_to?(:call)
       Datagrid::Utils.apply_args(object, &default)
     else
@@ -80,11 +72,6 @@ class Datagrid::Filters::BaseFilter #:nodoc:
     end
   end
 
-  def multiple
-    Datagrid::Utils.warn_once("Filter#multiple method is deprecated. Use Filter#multiple? instead")
-    multiple?
-  end
-
   def multiple?
     self.options[:multiple]
   end
@@ -97,6 +84,14 @@ class Datagrid::Filters::BaseFilter #:nodoc:
     options[:allow_blank]
   end
 
+  def input_options
+    options[:input_options] || {}
+  end
+
+  def label_options
+    options[:label_options] || {}
+  end
+
   def form_builder_helper_name
     self.class.form_builder_helper_name
   end