datagrid 1.5.9 → 1.6.3

data/lib/datagrid/columns/column.rb

@@ -106,6 +106,10 @@ class Datagrid::Columns::Column
     !! options[:mandatory]
   end
 
+  def mandatory_explicitly_set?
+    options.key?(:mandatory)
+  end
+
   def enabled?(grid)
     ::Datagrid::Utils.process_availability(grid, options[:if], options[:unless])
   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

@@ -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

@@ -84,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

data/lib/datagrid/filters/composite_filters.rb

@@ -16,10 +16,10 @@ module Datagrid
           from_options = normalize_composite_filter_options(from_options, field)
           to_options = normalize_composite_filter_options(to_options, field)
 
-          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :date, from_options) do |date, scope, grid|
+          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :date, **from_options) do |date, scope, grid|
             grid.driver.greater_equal(scope, field, date)
           end
-          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :date, to_options) do |date, scope, grid|
+          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :date, **to_options) do |date, scope, grid|
             grid.driver.less_equal(scope, field, date)
           end
         end
@@ -27,10 +27,10 @@ module Datagrid
         def integer_range_filters(field, from_options = {}, to_options = {})
           from_options = normalize_composite_filter_options(from_options, field)
           to_options = normalize_composite_filter_options(to_options, field)
-          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :integer, from_options) do |value, scope, grid|
+          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :integer, **from_options) do |value, scope, grid|
             grid.driver.greater_equal(scope, field, value)
           end
-          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :integer, to_options) do |value, scope, grid|
+          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :integer, **to_options) do |value, scope, grid|
             grid.driver.less_equal(scope, field, value)
           end
         end

data/lib/datagrid/form_builder.rb

@@ -6,17 +6,19 @@ module Datagrid
     # Returns a form input html for the corresponding filter name
     def datagrid_filter(filter_or_attribute, options = {}, &block)
       filter = datagrid_get_filter(filter_or_attribute)
-      options = add_html_classes(options, filter.name, datagrid_filter_html_class(filter))
+      options = {
+        **filter.input_options,
+        **add_html_classes(options, filter.name, datagrid_filter_html_class(filter)),
+      }
       # Prevent partials option from appearing in HTML attributes
       options.delete(:partials) # Legacy option
       self.send(filter.form_builder_helper_name, filter, options, &block)
     end
 
     # Returns a form label html for the corresponding filter name
-    def datagrid_label(filter_or_attribute, options_or_text = {}, options = {}, &block)
+    def datagrid_label(filter_or_attribute, text = nil, **options, &block)
       filter = datagrid_get_filter(filter_or_attribute)
-      text, options = options_or_text.is_a?(Hash) ? [filter.header, options_or_text] : [options_or_text, options]
-      label(filter.name, text, options, &block)
+      label(filter.name, text || filter.header, **filter.label_options, **options, &block)
     end
 
     protected
@@ -42,7 +44,7 @@ module Datagrid
 
     def datagrid_default_filter(attribute_or_filter, options = {})
       filter = datagrid_get_filter(attribute_or_filter)
-      text_field filter.name, options.reverse_merge(:value => object.filter_value_as_string(filter))
+      text_field filter.name, value: object.filter_value_as_string(filter), **options
     end
 
     def datagrid_enum_filter(attribute_or_filter, options = {}, &block)
@@ -65,16 +67,17 @@ module Datagrid
           }
         )
       else
-        if !options.has_key?(:multiple) && filter.multiple?
-          options[:multiple] = true
-        end
         select(
           filter.name,
           object.select_options(filter) || [],
-          {:include_blank => filter.include_blank,
-           :prompt => filter.prompt,
-           :include_hidden => false},
-           options, &block
+          {
+            include_blank: filter.include_blank,
+            prompt: filter.prompt,
+            include_hidden: false
+          },
+           multiple: filter.multiple?,
+           **options,
+           &block
         )
       end
     end
@@ -119,7 +122,7 @@ module Datagrid
         {:include_blank => false, :include_hidden => false, :prompt => false, :selected => operation },
         add_html_classes(options, "operation")
       )
-      value_input = text_field(filter.name, add_html_classes(options, "value").merge(:value => value))
+      value_input = text_field(filter.name, **add_html_classes(options, "value"), value: value)
       [field_input, operation_input, value_input].join("\n").html_safe
     end
 
@@ -129,7 +132,7 @@ module Datagrid
         # select options format may vary
         value = value.last if value.is_a?(Array)
         # don't render any visible input when there is nothing to choose from
-        hidden_field(name, html_options.merge(value: value))
+        hidden_field(name, **html_options, value: value)
       else
         select(name, variants, select_options, html_options)
       end
@@ -177,7 +180,7 @@ module Datagrid
     end
 
     def datagrid_get_attribute(attribute_or_filter)
-      Utils.string_like?(attribute_or_filter) ?  attribute_or_filter : attribute_or_filter.name
+      Utils.string_like?(attribute_or_filter) ? attribute_or_filter : attribute_or_filter.name
     end
 
     def datagrid_get_filter(attribute_or_filter)

data/lib/datagrid/helper.rb

@@ -38,8 +38,8 @@ module Datagrid
     #   and needs different columns. Default: all defined columns.
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
-    def datagrid_table(grid, *args)
-      datagrid_renderer.table(grid, *args)
+    def datagrid_table(grid, assets = grid.assets, **options)
+      datagrid_renderer.table(grid, assets, **options)
     end
 
     # Renders HTML table header for given grid instance using columns defined in it
@@ -73,7 +73,7 @@ module Datagrid
     #       %td= row.project_name
     #       %td.project-status{class: row.status}= row.status
     def datagrid_rows(grid, assets = grid.assets, **options, &block)
-      datagrid_renderer.rows(grid, assets, options, &block)
+      datagrid_renderer.rows(grid, assets, **options, &block)
     end
 
     # Renders ordering controls for the given column name

data/lib/datagrid/renderer.rb

@@ -34,11 +34,9 @@ module Datagrid
       _render_partial('form', options[:partials], {:grid => grid, :options => options})
     end
 
-    def table(grid, *args)
-      options = args.extract_options!
+    def table(grid, assets, **options)
       options[:html] ||= {}
       options[:html][:class] ||= "datagrid #{@template.dom_class(grid)}"
-      assets = args.any? ? args.shift : grid.assets
 
       _render_partial('table', options[:partials],
                       {
@@ -81,10 +79,9 @@ module Datagrid
     def order_path(grid, column, descending, request)
       column = grid.column_by_name(column)
       query = request ? request.query_parameters : {}
-      order_parameter = {grid.param_name => grid.as_query.merge(:order => column.name, :descending => descending)}
       ActionDispatch::Http::URL.path_for(
         path: request ? request.path : '/',
-        params: query.merge(order_parameter)
+        params: query.merge(grid.query_params(order: column.name, descending: descending))
       )
     end
 

data/lib/datagrid/utils.rb

@@ -72,12 +72,8 @@ module Datagrid
       end
 
       def apply_args(*args, &block)
-        return block.call(*args) if block.arity < 0
-        args = args.clone
-        (args.size - block.arity).times do
-          args.pop
-        end
-        block.call(*args)
+        size = block.arity < 0 ? args.size : block.arity
+        block.call(*args.slice(0, size))
       end
 
       def parse_date(value)

data/lib/datagrid/version.rb

@@ -0,0 +1,3 @@
+module Datagrid
+  VERSION = "1.6.3"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.3
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,146 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.2
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.6
-- !ruby/object:Gem::Dependency
-  name: sequel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mongoid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bson
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: bson_ext
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: This allows you to easily build datagrid aka data tables with sortable
   columns and filters
 email: agresso@gmail.com
@@ -171,15 +31,11 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
+- Readme.markdown
 files:
-- ".document"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
-- Rakefile
 - Readme.markdown
-- VERSION
 - app/assets/stylesheets/datagrid.sass
 - app/views/datagrid/_enum_checkboxes.html.erb
 - app/views/datagrid/_form.html.erb
@@ -228,54 +84,8 @@ files:
 - lib/datagrid/rspec.rb
 - lib/datagrid/scaffold.rb
 - lib/datagrid/utils.rb
+- lib/datagrid/version.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
@@ -283,8 +93,13 @@ files:
 homepage: http://github.com/bogdan/datagrid
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bogdan/datagrid
+  bug_tracker_uri: https://github.com/bogdan/datagrid/issues
+  documentation_uri: https://github.com/bogdan/datagrid/wiki
+  changelog_uri: https://github.com/bogdan/datagrid/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/bogdan/datagrid
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -299,9 +114,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Ruby gem to create datagrids
 test_files: []