datagrid 1.5.9 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a9a3ff232cd83f323e280e35a805ebd4ec725b74b531c18328c4de27952f2f
-  data.tar.gz: c91f39764fa86f0d8b016de33eeabfd37b47d16411f3f52ec796f2bf1d14d534
+  metadata.gz: a5f1043a8a905be92c309d00b6c0b107ebec35939c89b5766f5d7c43dbe2c584
+  data.tar.gz: 8b4bd8b0130ef2fa83cebe7012386ffcdb4d9ba32d3e803080e4345d6eb74dee
 SHA512:
-  metadata.gz: b999afc64d7094dfd47a2e4f393824df58edf15769c445a9d16712dc6f531f3b30f872046cd657bc9323df6a460b4d1a74334fc4b498de141a9998d3aa6c34bc
-  data.tar.gz: 89d0e83bd75e28ee33dc890d2f5f82de6391a9d32b0723e77afa8dfc0856d126c1fe0ee4c8ab5b0b2f5491e5908b45e14de0bd18669c2786764faeac8c6fc0c2
+  metadata.gz: 4c42259fe4c806e235d10610ab4b3681319d8f5712c73addc1d54f61d6e6cbd0447a967464f878464da2b54f60dc376acef5238cce1467a097d7cbf799beb51d
+  data.tar.gz: 1ac692930c8a269190bc36ecce7c50cf1c1696fe5b9b6dc0644adfa59eb15a2bab77f4dac70a29633693e707e53ef29ed874eda6f6c82533ed441afe72a5d304

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 1.6.3
+
+* Fix usage of options spread operator for ruby 3.0 [#296](https://github.com/bogdan/datagrid/issues/296)
+
+## 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:
@@ -22,10 +23,11 @@ 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
+### Documentation
 
-* Ruby >= 2.0
-* Rails >= 3.2
+* [Readme](/Readme.markdown) - this read-me for basic information
+* [Wiki](https://github.com/bogdan/datagrid/wiki) - general reference on how to use the gem
+* [Rdoc](https://rdoc.info/github/bogdan/datagrid) - API reference
 
 ### Live Demo
 
@@ -201,4 +203,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.9 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.9"
-
-  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 = "2019-05-10"
-  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.7.8".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, ["~> 1.3.6"])
-      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, ["~> 1.3.6"])
-      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, ["~> 1.3.6"])
-    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/column_names_attribute.rb

@@ -23,23 +23,22 @@ module Datagrid
       # Accepts same options as <tt>:enum</tt> filter
       #
       # Examples:
-      # 
-      #   column_names_filter(:header => "Choose columns")
-      #   
-      def column_names_filter(options = {})
-        filter(:column_names, :enum, {
-          :select => :optional_columns_select,
-          :multiple => true,
-          :dummy => true
-        }.merge(options || {}))
+      #
+      #   column_names_filter(header: "Choose columns")
+      #
+      def column_names_filter(**options)
+        filter(
+          :column_names, :enum,
+          select: :optional_columns_select,
+          multiple: true,
+          dummy: true,
+          **options,
+        )
       end
     end
 
-    def columns(*args) #:nodoc:
-      options = args.extract_options!
-      column_names = selected_column_names(*args)
-      column_names << options
-      super(*column_names)
+    def columns(*args, **options) #:nodoc:
+      super(*selected_column_names(*args), **options)
     end
 
     # Returns a list of enabled columns with <tt>:mandatory => true</tt> option
@@ -59,7 +58,7 @@ module Datagrid
       optional_columns.map {|c| [c.header, c.name] }
     end
 
-    def selected_column_names(*args)                  
+    def selected_column_names(*args)
       if args.any?
         args.compact!
         args.map!(&:to_sym)
@@ -75,7 +74,7 @@ module Datagrid
 
     def columns_visibility_enabled?
       columns_array.any? do |column|
-        column.options.key?(:mandatory)
+        column.mandatory_explicitly_set?
       end
     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 = []
@@ -85,9 +86,10 @@ module Datagrid
       #
       # Supported options:
       #
-      # * :data - if true returns only non-html columns. Default: false.
-      def columns(*args)
-        filter_columns(columns_array, *args)
+      # * :data - if true returns only columns with data representation. Default: false.
+      # * :html - if true returns only columns with html columns. Default: false.
+      def columns(*args, data: false, html: false)
+        filter_columns(columns_array, *args, data: data, html: html)
       end
 
       # Defines new datagrid column
@@ -120,8 +122,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
@@ -183,23 +185,17 @@ module Datagrid
         child_class.columns_array = self.columns_array.clone
       end
 
-      def filter_columns(columns, *args) #:nodoc:
-        options = args.extract_options!
-        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))
+      def filter_columns(columns_array, *names, data: false, html: false) #:nodoc:
+        names.compact!
+        names.map!(&:to_sym)
+        columns_array.select do |column|
+          (!data || column.data?) &&
+            (!html || column.html?) &&
+            (column.mandatory? || names.empty? || names.include?(column.name))
         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)
@@ -312,11 +308,12 @@ module Datagrid
       #   grid.to_csv
       #   grid.to_csv(:id, :name)
       #   grid.to_csv(:col_sep => ';')
-      def to_csv(*column_names)
+      def to_csv(*column_names, **options)
         require "csv"
-        options = column_names.extract_options!
         CSV.generate(
-          {:headers => self.header(*column_names), :write_headers => true}.merge!(options)
+          headers: self.header(*column_names),
+          write_headers: true,
+          **options
         ) do |csv|
           each_with_batches do |asset|
             csv << row_for(asset, *column_names)
@@ -333,24 +330,22 @@ module Datagrid
       #   grid = MyGrid.new(:column_names => [:id, :name])
       #   grid.columns # => id and name columns
       #   grid.columns(:id, :category) # => id and category column
-      def columns(*args)
-        self.class.filter_columns(columns_array, *args).select {|column| column.enabled?(self)}
+      def columns(*args, data: false, html: false)
+        self.class.filter_columns(
+          columns_array, *args, data: data, html: html
+        ).select do |column|
+          column.enabled?(self)
+        end
       end
 
       # Returns all columns that can be represented in plain data(non-html) way
-      def data_columns(*names)
-        options = names.extract_options!
-        options[:data] = true
-        names << options
-        self.columns(*names)
+      def data_columns(*names, **options)
+        self.columns(*names, **options, data: true)
       end
 
       # Returns all columns that can be represented in HTML table
-      def html_columns(*names)
-        options = names.extract_options!
-        options[:html] = true
-        names << options
-        self.columns(*names)
+      def html_columns(*names, **options)
+        self.columns(*names, **options, html: true)
       end
 
       # Finds a column definition by name
@@ -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?