datagrid 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5f1043a8a905be92c309d00b6c0b107ebec35939c89b5766f5d7c43dbe2c584
-  data.tar.gz: 8b4bd8b0130ef2fa83cebe7012386ffcdb4d9ba32d3e803080e4345d6eb74dee
+  metadata.gz: 6b7756de5445c9c99d265a897b609b9f3dcf6dbf0b03e32455ca96518bf01eea
+  data.tar.gz: 7f748c1a7075331672e749d582145deacc1d38977ada1770b6d7b548d9bb17c9
 SHA512:
-  metadata.gz: 4c42259fe4c806e235d10610ab4b3681319d8f5712c73addc1d54f61d6e6cbd0447a967464f878464da2b54f60dc376acef5238cce1467a097d7cbf799beb51d
-  data.tar.gz: 1ac692930c8a269190bc36ecce7c50cf1c1696fe5b9b6dc0644adfa59eb15a2bab77f4dac70a29633693e707e53ef29ed874eda6f6c82533ed441afe72a5d304
+  metadata.gz: 8acee3003f7a9e63ec80808221667fa530f74d882c88d06ce20855b97bf75ec806a6eb5ddf89c9f47044d943238d74c33fcfd290c78d8d4e6e31a3081f4f6e83
+  data.tar.gz: 54d4cb553c0a82068d905e8367bffb18298d215b3a0ae09be4b09fa2f77dfe1cc299e019c080d3b689d897f2f38dba217bdef5200284bebadc8ccb1b9ce83644

data/CHANGELOG.md

@@ -1,6 +1,24 @@
+## master
+
+## 1.8.0
+
+* Support `input_options: {type: "textarea"}` as `<textarea/>` tag
+* Remove deprecated `eboolean` filter
+* Fixed scope wrapping to be universal
+* Deprecated `integer_range_filters` and `date_range_filters`. Use `filter(name, type, range: true)` instead.
+* Add `original_scope` method that returns scope as it was defined without any wrapping [#313](https://github.com/bogdan/datagrid/pull/313)
+* Add ability to specify `columns` option for `datagrid_row`. [#314](https://github.com/bogdan/datagrid/pull/314)
+
+## 1.7.0
+
+* Depend on `railties` instead of `rails` to prevent loading of unnecessary frameworks
+* Bugfix `File.exist?` usage for ruby 3.0 [#307](https://github.com/bogdan/datagrid/issues/307)
+* Drop support of old Ruby versions (< 2.7)
+* Drop support of old Rails versions (< 6.0)
+
 ## 1.6.3
 
-* Fix usage of options spread operator for ruby 3.0 [#296](https://github.com/bogdan/datagrid/issues/296)
+* Fix usage of options spread operator for Ruby 3.0 [#296](https://github.com/bogdan/datagrid/issues/296)
 
 ## 1.6.2
 

data/Readme.markdown

@@ -1,12 +1,12 @@
 # Datagrid
 
-[![Build Status](https://travis-ci.org/bogdan/datagrid.svg?branch=master)](https://travis-ci.org/bogdan/datagrid)
+[![Build Status](https://github.com/bogdan/datagrid/workflows/CI/badge.svg?branch=master)](https://github.com/bogdan/datagrid/actions)
 
 [![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:
+A really mighty and flexible ruby library that generates reports including admin panels, analytics and data representation:
 
-* Customizable filtering
+* Filtering
 * Columns
 * Sort order
 * Localization
@@ -27,7 +27,7 @@ Ruby library that helps you to build and represent table-like data with:
 
 * [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
+* [Rdoc](https://rubydoc.info/gems/datagrid) - API reference
 
 ### Live Demo
 
@@ -54,7 +54,7 @@ class UsersGrid
   filter(:group_id, :integer, multiple: true)
   filter(:logins_count, :integer, range: true)
   filter(:group_name, :string, header: "Group") do |value|
-    self.joins(:group).where(:groups => {:name => value})
+    self.joins(:group).where(groups: {name: value})
   end
 
   column(:name)
@@ -72,11 +72,11 @@ Basic grid api:
 
 ``` ruby
 report = UsersGrid.new(
-  :group_id => [1,2], 
-  :logins_count => [1, nil],
-  :category => "first",
-  :order => :group,
-  :descending => true
+  group_id: [1,2], 
+  logins_count: [1, nil],
+  category: "first",
+  order: :group,
+  descending: true
 )
 
 report.assets # => Array of User instances:
@@ -145,7 +145,7 @@ Datagrid supports different type of filters including:
 Each column is represented by name and code block to calculate the value.
 
 ``` ruby
-column(:activated, :header => "Active", :order => "activated", :after => :name) do
+column(:activated, header: "Active", order: "activated", after: :name) do
   self.activated?
 end
 ```

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

@@ -4,8 +4,8 @@ You can add indent if whitespace doesn't matter for you
 %>
 <%- elements.each do |value, text, checked| -%>
 <%- id = [form.object_name, filter.name, value].join('_').underscore -%>
-<%= form.label filter.name, options.merge(:for => id) do -%>
-<%= form.check_box(filter.name, {:multiple => true, :id => id, :checked => checked, :include_hidden => false}, value.to_s, nil) -%>
+<%= form.label filter.name, options.merge(for: id) do -%>
+<%= form.check_box(filter.name, {multiple: true, id: id, checked: checked, include_hidden: false}, value.to_s, nil) -%>
 <%= text -%>
 <%- end -%>
 <%- end -%>

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

@@ -6,9 +6,8 @@
     </div>
   <% end %>
   <div class="datagrid-actions">
-    <%= f.submit I18n.t("datagrid.form.search").html_safe, :class => "datagrid-submit" %>
+    <%= f.submit I18n.t("datagrid.form.search").html_safe, class: "datagrid-submit" %>
     <%# https://github.com/rails/rails/pull/14949 -%>
-    <% empty_parameter = Rails.version >= "4.1.0" && Rails.version <= '4.1.2' ? nil : {}-%>
-    <%= link_to I18n.t('datagrid.form.reset').html_safe, url_for(grid.to_param => empty_parameter), :class => "datagrid-reset" %>
+    <%= link_to I18n.t('datagrid.form.reset').html_safe, url_for(grid.to_param => {}), class: "datagrid-reset" %>
   </div>
 <% end -%>

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

@@ -2,9 +2,9 @@
   <%= link_to(
       I18n.t("datagrid.table.order.asc").html_safe,
       datagrid_order_path(grid, column, false),
-      :class => "asc") %>
+      class: "asc") %>
   <%= link_to(
       I18n.t("datagrid.table.order.desc").html_safe,
       datagrid_order_path(grid, column, true),
-      :class => "desc") %>
+      class: "desc") %>
 </div>

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

@@ -1,3 +1,3 @@
-<%= form.text_field(filter.name, from_options) %>
-<span class="separator <%= filter.type %>"> - </span>
-<%= form.text_field(filter.name, to_options) %>
+<%= form.datagrid_filter_input(filter, **from_options) %>
+<span class="separator <%= filter.type %>"><%= I18n.t('datagrid.filters.range.separator') %></span>
+<%= form.datagrid_filter_input(filter, **to_options) %>

data/datagrid.gemspec

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "datagrid/version"
+
+require_relative "lib/datagrid/version"
 
 Gem::Specification.new do |s|
   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"
@@ -23,19 +21,17 @@ Gem::Specification.new do |s|
     "datagrid.gemspec",
   ]
   s.files += `git ls-files | grep -E '^(app|lib|templates)'`.split("\n")
-  s.homepage = "http://github.com/bogdan/datagrid"
+  s.homepage = "https://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.required_ruby_version = Gem::Requirement.new(">= 2.7")
   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,
+    "homepage_uri" => s.homepage,
+    "bug_tracker_uri" => "#{s.homepage}/issues",
+    "documentation_uri" => "#{s.homepage}/wiki",
+    "changelog_uri" => "#{s.homepage}/blob/master/CHANGELOG.md",
+    "source_code_uri" => s.homepage,
   }
 
-  s.add_dependency(%q<rails>, [">= 4.0"])
+  s.add_dependency "railties", ">= 6.0"
 end
 

data/lib/datagrid/active_model.rb

@@ -1,10 +1,7 @@
-
 module Datagrid
-
   # Required to be ActiveModel compatible
-  # @private
-  module ActiveModel #:nodoc:
-
+  module ActiveModel
+    # @!visibility private
     def self.included(base)
       base.extend         ClassMethods
       base.class_eval do
@@ -18,41 +15,40 @@ module Datagrid
           extend ::ActiveModel::AttributesAssignment
         rescue LoadError
         end
-
       end
-      base.send :include, InstanceMethods
-    end # self.included
+    end
 
     module ClassMethods
+      # @return [String] URL query parameter name of the grid class
       def param_name
         self.to_s.underscore.tr('/', '_')
       end
-    end # ClassMethods
+    end
 
-    module InstanceMethods
-      def param_name
-        self.class.param_name
-      end
+    # @return [String] URL query parameter name of the grid class
+    def param_name
+      self.class.param_name
+    end
 
-      def param_key
-        param_name
-      end
+    # @return [String] URL query parameter name of the grid class
+    def param_key
+      param_name
+    end
 
-      def to_key
-        [self.class.param_name]
-      end
+    def to_key
+      [self.class.param_name]
+    end
 
-      def persisted?
-        false
-      end
+    def persisted?
+      false
+    end
 
-      def to_model
-        self
-      end
+    def to_model
+      self
+    end
 
-      def to_param
-        self.param_name
-      end
-    end # InstanceMethods
+    def to_param
+      self.param_name
+    end
   end
 end

data/lib/datagrid/column_names_attribute.rb

@@ -17,15 +17,13 @@ module Datagrid
       # Adds a filter that acts like a column selection
       # All defined columns will be available to select/deselect
       # as a multi-select enum filter.
-      # Columns with <tt>:mandatory => true</tt> option
+      # Columns with <tt>mandatory: true</tt> option
       # will always present in the grid table and won't be listed
       # in column names selection
       # Accepts same options as <tt>:enum</tt> filter
-      #
-      # Examples:
-      #
+      # @example
       #   column_names_filter(header: "Choose columns")
-      #
+      # @see Datagrid::Filters::ClassMethods#filter
       def column_names_filter(**options)
         filter(
           :column_names, :enum,
@@ -37,24 +35,28 @@ module Datagrid
       end
     end
 
-    def columns(*args, **options) #:nodoc:
+    # @!visibility private
+    def columns(*args, **options)
       super(*selected_column_names(*args), **options)
     end
 
-    # Returns a list of enabled columns with <tt>:mandatory => true</tt> option
+    # Returns a list of enabled columns with <tt>mandatory: true</tt> option
     # If no mandatory columns specified than all of them considered mandatory
+    # @return [Array<Datagrid::Columns::Column>]
     def mandatory_columns
       available_columns.select {|c| c.mandatory? }
     end
 
-    # Returns a list of enabled columns without <tt>:mandatory => true</tt> option
+    # Returns a list of enabled columns without <tt>mandatory: true</tt> option
+    # If no mandatory columns specified than all of them considered mandatory but not optional
+    # @return [Array<Datagrid::Columns::Column>]
     def optional_columns
       available_columns - mandatory_columns
     end
 
     protected
 
-    def optional_columns_select #:nodoc:
+    def optional_columns_select
       optional_columns.map {|c| [c.header, c.name] }
     end
 

data/lib/datagrid/columns/column.rb

@@ -1,6 +1,8 @@
 class Datagrid::Columns::Column
 
-  class ResponseFormat # :nodoc:
+  # Datagrid class holding an information of
+  # how a column should be rendered in data/console/csv format and HTML format
+  class ResponseFormat
 
     attr_accessor :data_block, :html_block
 
@@ -131,24 +133,24 @@ class Datagrid::Columns::Column
     grid.generic_value(self, model)
   end
 
-  def append_preload(scope)
-    return scope unless preload
+  def append_preload(relation)
+    return relation unless preload
     if preload.respond_to?(:call)
-      return scope unless preload
+      return relation unless preload
       if preload.arity == 1
-        preload.call(scope)
+        preload.call(relation)
       else
-        scope.instance_exec(&preload)
+        relation.instance_exec(&preload)
       end
     else
-      driver.default_preload(scope, preload)
+      driver.default_preload(relation, preload)
     end
   end
 
   def preload
     preload = options[:preload]
 
-    if preload == true && driver.can_preload?(driver.to_scope(grid_class.scope), name)
+    if preload == true && driver.can_preload?(grid_class.scope, name)
       name
     else
       preload