datagrid 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae619097e4bcae30de30bf2b5e9dc949f197146f3b17c01f5a2e4edb17e5ecc
-  data.tar.gz: 61751f34844c4127b7fc47bbacdbb2656d61aa015f574855de2a23bfc2dffe4a
+  metadata.gz: 6b7756de5445c9c99d265a897b609b9f3dcf6dbf0b03e32455ca96518bf01eea
+  data.tar.gz: 7f748c1a7075331672e749d582145deacc1d38977ada1770b6d7b548d9bb17c9
 SHA512:
-  metadata.gz: 8bcea069b9bafc8b573226366a1abf194910d3fa5798711568b7106428d94ec915b141f23986094d8579ce8450328e1eb5b71932646c4224c0f1f7ac01f9718b
-  data.tar.gz: 7a40443171fe84d7b9f22daabdf2d1c182926fc69c9b47fde54e5a2271c394b8b5f7541a512e898c4e1472f93f4e94cf9cb90a7d47a9ad51113ee65efaf80610
+  metadata.gz: 8acee3003f7a9e63ec80808221667fa530f74d882c88d06ce20855b97bf75ec806a6eb5ddf89c9f47044d943238d74c33fcfd290c78d8d4e6e31a3081f4f6e83
+  data.tar.gz: 54d4cb553c0a82068d905e8367bffb18298d215b3a0ae09be4b09fa2f77dfe1cc299e019c080d3b689d897f2f38dba217bdef5200284bebadc8ccb1b9ce83644

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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

data/Readme.markdown

@@ -4,9 +4,9 @@
 
 [![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
@@ -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/lib/datagrid/column_names_attribute.rb

@@ -17,7 +17,7 @@ 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
@@ -47,7 +47,7 @@ module Datagrid
       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

data/lib/datagrid/columns/column.rb

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

data/lib/datagrid/columns.rb

@@ -44,13 +44,11 @@ module Datagrid
         class_attribute :cached, default: false
         class_attribute :decorator, instance_writer: false
       end
-      base.send :include, InstanceMethods
+      base.include InstanceMethods
     end
 
     module ClassMethods
 
-
-
       # @param data [Boolean] if true returns only columns with data representation. Default: false.
       # @param html [Boolean] if true returns only columns with html columns. Default: false.
       # @param column_names [Array<String>] list of column names if you want to limit data only to specified columns
@@ -446,8 +444,8 @@ module Datagrid
 
       protected
 
-      def append_column_preload(scope)
-        columns.inject(scope) do |current, column|
+      def append_column_preload(relation)
+        columns.inject(relation) do |current, column|
           column.append_preload(current)
         end
       end

data/lib/datagrid/core.rb

@@ -6,7 +6,7 @@ module Datagrid
 
     # @!visibility private
     def self.included(base)
-      base.extend         ClassMethods
+      base.extend ClassMethods
       base.class_eval do
         class_attribute :scope_value
 
@@ -20,7 +20,7 @@ module Datagrid
           include ::ActiveModel::AttributeAssignment
         end
       end
-      base.send :include, InstanceMethods
+      base.include InstanceMethods
     end
 
     module ClassMethods
@@ -56,14 +56,20 @@ module Datagrid
           }
           self
         else
-          check_scope_defined!
-          scope_value.call
+          scope = original_scope
+          driver.to_scope(scope)
         end
       end
 
+      # @!visibility private
+      def original_scope
+        check_scope_defined!
+        scope_value.call
+      end
+
       # @!visibility private
       def driver
-        @driver ||= Drivers::AbstractDriver.guess_driver(scope).new
+        @driver ||= Drivers::AbstractDriver.guess_driver(scope_value.call).new
       end
 
       # Allows dynamic columns definition, that could not be defined at class level
@@ -162,7 +168,7 @@ module Datagrid
 
       # @return [Object] a scope relation (e.g ActiveRecord::Relation) with all applied filters
       def assets
-        driver.to_scope(scope)
+        scope
       end
 
       # Updates datagrid attributes with a passed hash argument
@@ -222,11 +228,17 @@ module Datagrid
           }
           self
         else
-          check_scope_defined!
-          scope_value.call
+          scope = original_scope
+          driver.to_scope(scope)
         end
       end
 
+      # @!visibility private
+      def original_scope
+        check_scope_defined!
+        scope_value.call
+      end
+
       # Resets current instance scope to default scope defined in a class
       # @return [void]
       def reset_scope

data/lib/datagrid/drivers/active_record.rb

@@ -19,7 +19,7 @@ module Datagrid
         # We can only reveal it by checking if it respond to some specific
         # to ActiveRecord method like #scoped
         if scope.is_a?(Class)
-          Rails.version >= "4.0" ? scope.all : scope.scoped({})
+          scope.all
         elsif scope.respond_to?(:scoped)
           scope.scoped
         else
@@ -43,7 +43,7 @@ module Datagrid
       end
 
       def asc(scope, order)
-        # Rails 3.x.x don't able to override already applied order
+        # Relation#order isn't able to override already applied order
         # Using #reorder instead
         scope.reorder(order)
       end

data/lib/datagrid/drivers/sequel.rb

@@ -82,8 +82,12 @@ module Datagrid
       end
 
       def batch_each(scope, batch_size, &block)
-        scope.extension(:pagination).each_page(batch_size) do |page|
-          page.each(&block)
+        if scope.opts[:limit]
+          scope.each(&block)
+        else
+          scope.extension(:pagination).each_page(batch_size) do |page|
+            page.each(&block)
+          end
         end
       end
 

data/lib/datagrid/filters/base_filter.rb

@@ -6,6 +6,7 @@ end
 # @!visibility private
 class Datagrid::Filters::BaseFilter
 
+  class_attribute :input_helper_name, instance_writer: false
   attr_accessor :grid_class, :options, :block, :name
 
   def initialize(grid_class, name, options = {}, &block)
@@ -172,8 +173,8 @@ class Datagrid::Filters::BaseFilter
 
   def default_filter(value, scope, grid)
     return nil if dummy?
-    if !driver.has_column?(scope, name) && driver.to_scope(scope).respond_to?(name)
-      driver.to_scope(scope).send(name, value)
+    if !driver.has_column?(scope, name) && scope.respond_to?(name)
+      scope.send(name, value)
     else
       default_filter_where(scope, value)
     end

data/lib/datagrid/filters/composite_filters.rb

@@ -13,6 +13,7 @@ module Datagrid
       module ClassMethods
 
         def date_range_filters(field, from_options = {}, to_options = {})
+          Utils.warn_once('date_range_filters is deprecated in favor of range option for date filter')
           from_options = normalize_composite_filter_options(from_options, field)
           to_options = normalize_composite_filter_options(to_options, field)
 
@@ -25,6 +26,7 @@ module Datagrid
         end
 
         def integer_range_filters(field, from_options = {}, to_options = {})
+          Utils.warn_once('integer_range_filters is deprecated in favor of range option for integer filter')
           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|
@@ -37,7 +39,7 @@ module Datagrid
 
         def normalize_composite_filter_options(options, field)
           if options.is_a?(String) || options.is_a?(Symbol)
-            options = {:name => options}
+            options = {name: options}
           end
           options
         end

data/lib/datagrid/filters/dynamic_filter.rb

@@ -80,7 +80,7 @@ class Datagrid::Filters::DynamicFilter < Datagrid::Filters::BaseFilter
 
   def operations_select
     operations.map do |operation|
-      [I18n.t(operation, :scope => "datagrid.filters.dynamic.operations").html_safe, operation]
+      [I18n.t(operation, scope: "datagrid.filters.dynamic.operations").html_safe, operation]
     end
   end
 

data/lib/datagrid/filters.rb

@@ -5,7 +5,6 @@ module Datagrid
 
     require "datagrid/filters/base_filter"
     require "datagrid/filters/enum_filter"
-    require "datagrid/filters/boolean_enum_filter"
     require "datagrid/filters/extended_boolean_filter"
     require "datagrid/filters/boolean_filter"
     require "datagrid/filters/date_filter"
@@ -18,24 +17,23 @@ module Datagrid
     require "datagrid/filters/dynamic_filter"
 
     FILTER_TYPES = {
-      :date => Filters::DateFilter,
-      :datetime => Filters::DateTimeFilter,
-      :string => Filters::StringFilter,
-      :default => Filters::DefaultFilter,
-      :eboolean => Filters::BooleanEnumFilter ,
-      :xboolean => Filters::ExtendedBooleanFilter ,
-      :boolean => Filters::BooleanFilter ,
-      :integer => Filters::IntegerFilter,
-      :enum => Filters::EnumFilter,
-      :float => Filters::FloatFilter,
-      :dynamic => Filters::DynamicFilter
+      date: Filters::DateFilter,
+      datetime: Filters::DateTimeFilter,
+      string: Filters::StringFilter,
+      default: Filters::DefaultFilter,
+      xboolean: Filters::ExtendedBooleanFilter ,
+      boolean: Filters::BooleanFilter ,
+      integer: Filters::IntegerFilter,
+      enum: Filters::EnumFilter,
+      float: Filters::FloatFilter,
+      dynamic: Filters::DynamicFilter
     }
 
     DEFAULT_FILTER_BLOCK = Object.new
 
     # @!visibility private
     def self.included(base)
-      base.extend         ClassMethods
+      base.extend ClassMethods
       base.class_eval do
 
         include Datagrid::Core
@@ -44,7 +42,7 @@ module Datagrid
         self.filters_array = []
 
       end
-      base.send :include, InstanceMethods
+      base.include InstanceMethods
     end
 
     module ClassMethods
@@ -95,7 +93,8 @@ 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>:input_options</tt> - options passed when rendering html input tag attributes.
+      #   Use <tt>input_options.type</tt> to control input type including <tt>textarea</tt>.
       # * <tt>:label_options</tt> - options passed when rendering html label tag attributes
       #
       # See: https://github.com/bogdan/datagrid/wiki/Filters for examples

data/lib/datagrid/form_builder.rb

@@ -8,15 +8,14 @@ module Datagrid
     #   * <tt>select</tt> for enum, xboolean filter types
     #   * <tt>check_box</tt> for boolean filter type
     #   * <tt>text_field</tt> for other filter types
-    def datagrid_filter(filter_or_attribute, options = {}, &block)
+    def datagrid_filter(filter_or_attribute, partials: nil, **options, &block)
       filter = datagrid_get_filter(filter_or_attribute)
-      options = {
+      self.send(
+        filter.form_builder_helper_name, filter,
         **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)
+        &block
+      )
     end
 
     # @param filter_or_attribute [Datagrid::Filters::BaseFilter, String, Symbol] filter object or filter name
@@ -28,11 +27,17 @@ module Datagrid
       label(filter.name, text || filter.header, **filter.label_options, **options, &block)
     end
 
-    protected
-    def datagrid_boolean_enum_filter(attribute_or_filter, options = {})
-      datagrid_enum_filter(attribute_or_filter, options)
+    def datagrid_filter_input(attribute_or_filter, **options)
+      filter = datagrid_get_filter(attribute_or_filter)
+      value = object.filter_value_as_string(filter)
+      if options[:type]&.to_sym == :textarea
+        text_area filter.name, value: value, **options, type: nil
+      else
+        text_field filter.name, value: value, **options
+      end
     end
 
+    protected
     def datagrid_extended_boolean_filter(attribute_or_filter, options = {})
       datagrid_enum_filter(attribute_or_filter, options)
     end
@@ -50,27 +55,25 @@ module Datagrid
     end
 
     def datagrid_default_filter(attribute_or_filter, options = {})
-      filter = datagrid_get_filter(attribute_or_filter)
-      text_field filter.name, value: object.filter_value_as_string(filter), **options
+      datagrid_filter_input(attribute_or_filter, **options)
     end
 
     def datagrid_enum_filter(attribute_or_filter, options = {}, &block)
       filter = datagrid_get_filter(attribute_or_filter)
       if filter.checkboxes?
-        partial = partial_path('enum_checkboxes')
         options = add_html_classes(options, 'checkboxes')
         elements = object.select_options(filter).map do |element|
           text, value = @template.send(:option_text_and_value, element)
           checked = enum_checkbox_checked?(filter, value)
           [value, text, checked]
         end
-        @template.render(
-          :partial => partial,
-          :locals => {
-            :elements => elements,
-            :form => self,
-            :filter => filter,
-            :options => options,
+        render_partial(
+          'enum_checkboxes',
+          {
+            elements: elements,
+            form: self,
+            filter: filter,
+            options: options,
           }
         )
       else
@@ -112,21 +115,26 @@ module Datagrid
       filter = datagrid_get_filter(attribute_or_filter)
       input_name = "#{object_name}[#{filter.name.to_s}][]"
       field, operation, value = object.filter_value(filter)
-      options = options.merge(:name => input_name)
+      options = options.merge(name: input_name)
       field_input = dynamic_filter_select(
         filter.name,
         object.select_options(filter) || [],
         {
-          :include_blank => filter.include_blank,
-          :prompt => filter.prompt,
-          :include_hidden => false,
-          :selected => field
+          include_blank: filter.include_blank,
+          prompt: filter.prompt,
+          include_hidden: false,
+          selected: field
         },
         add_html_classes(options, "field")
       )
       operation_input = dynamic_filter_select(
         filter.name, filter.operations_select,
-        {:include_blank => false, :include_hidden => false, :prompt => false, :selected => operation },
+        {
+          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"), value: value)
@@ -148,20 +156,19 @@ module Datagrid
     def datagrid_range_filter(type, attribute_or_filter, options = {})
       filter = datagrid_get_filter(attribute_or_filter)
       if filter.range?
-        partial = partial_path('range_filter')
-        options = options.merge(:multiple => true)
+        options = options.merge(multiple: true)
         from_options = datagrid_range_filter_options(object, filter, :from, options)
         to_options = datagrid_range_filter_options(object, filter, :to, options)
-        @template.render :partial => partial, :locals => {
-          :from_options => from_options, :to_options => to_options, :filter => filter, :form => self
+        render_partial 'range_filter', {
+          from_options: from_options, to_options: to_options, filter: filter, form: self
         }
       else
-        datagrid_default_filter(filter, options)
+        datagrid_filter_input(filter, **options)
       end
     end
 
     def datagrid_range_filter_options(object, filter, type, options)
-      type_method_map = {:from => :first, :to => :last}
+      type_method_map = {from: :first, to: :last}
       options = add_html_classes(options, type)
       options[:value] = filter.format(object[filter.name].try(type_method_map[type]))
       # In case of datagrid ranged filter
@@ -179,7 +186,7 @@ module Datagrid
     end
 
     def datagrid_string_filter(attribute_or_filter, options = {})
-      datagrid_default_filter(attribute_or_filter, options)
+      datagrid_range_filter(:string, attribute_or_filter, options)
     end
 
     def datagrid_float_filter(attribute_or_filter, options = {})
@@ -218,6 +225,10 @@ module Datagrid
       File.join('datagrid', name)
     end
 
+    def render_partial(name, locals)
+      @template.render partial: partial_path(name), locals: locals
+    end
+
     class Error < StandardError
     end
   end

data/lib/datagrid/helper.rb

@@ -52,6 +52,9 @@ module Datagrid
     #
     # * <tt>:order</tt> - display ordering controls built-in into header
     #   Default: true
+    # * <tt>:columns</tt> - Array of column names to display.
+    #   Used in case when same grid class is used in different places
+    #   and needs different columns. Default: all defined columns.
     # * <tt>:partials</tt> - Path for partials lookup.
     #   Default: 'datagrid'.
     # @param grid [Datagrid] grid object
@@ -124,12 +127,10 @@ module Datagrid
     #   <% row = datagrid_row(grid, user) %>
     #   First Name: <%= row.first_name %>
     #   Last Name: <%= row.last_name %>
-    def datagrid_row(grid, asset, &block)
-      HtmlRow.new(self, grid, asset).tap do |row|
-        if block_given?
-          return capture(row, &block)
-        end
-      end
+    # @example
+    #   <%= datagrid_row(grid, user, columns: [:first_name, :last_name, :actions]) %>
+    def datagrid_row(grid, asset, **options, &block)
+      datagrid_renderer.row(grid, asset, **options, &block)
     end
 
     # Generates an ascending or descending order url for the given column
@@ -141,51 +142,6 @@ module Datagrid
       datagrid_renderer.order_path(grid, column, descending, request)
     end
 
-    # Represents a datagrid row that provides access to column values for the given asset
-    # @example
-    #   row = datagrid_row(grid, user)
-    #   row.class      # => Datagrid::Helper::HtmlRow
-    #   row.first_name # => "<strong>Bogdan</strong>"
-    #   row.grid       # => Grid object
-    #   row.asset      # => User object
-    #   row.each do |value|
-    #     puts value
-    #   end
-    class HtmlRow
-
-      include Enumerable
-
-      attr_reader :grid, :asset
-
-      # @!visibility private
-      def initialize(context, grid, asset)
-        @context = context
-        @grid = grid
-        @asset = asset
-      end
-
-      # @return [Object] a column value for given column name
-      def get(column)
-        @context.datagrid_value(@grid, column, @asset)
-      end
-
-      # Iterates over all column values that are available in the row
-      # param block [Proc] column value iterator
-      def each(&block)
-        @grid.columns.each do |column|
-          block.call(get(column))
-        end
-      end
-
-      protected
-      def method_missing(method, *args, &blk)
-        if column = @grid.column_by_name(method)
-          get(column)
-        else
-          super
-        end
-      end
-    end
 
     protected
 

data/lib/datagrid/locale/en.yml

@@ -2,22 +2,26 @@ en:
   datagrid:
     no_results:
       "――"
+
     table:
       order:
         asc: "↑"
         desc: "↓"
       no_columns: "No columns selected"
+
     form:
       search: "Search"
       reset: "Reset"
+
     filters:
       xboolean:
         "yes": "Yes"
         "no": "No"
-
       dynamic:
         operations:
           ">=": "≥"
           "<=": "≤"
           "=": "="
           "=~": "≈"
+      range:
+        separator: " - "

data/lib/datagrid/ordering.rb

@@ -27,7 +27,7 @@ module Datagrid
         alias descending? descending
 
       end
-      base.send :include, InstanceMethods
+      base.include InstanceMethods
     end
 
     # @!visibility private

data/lib/datagrid/renderer.rb

@@ -41,9 +41,9 @@ module Datagrid
 
       _render_partial('table', options[:partials],
                       {
-                        :grid => grid,
-                        :options => options,
-                        :assets => assets
+                        grid: grid,
+                        options: options,
+                        assets: assets
                       })
     end
 
@@ -56,22 +56,20 @@ module Datagrid
 
     def rows(grid, assets = grid.assets, **options, &block)
       result = assets.map do |asset|
-        if block_given?
-          @template.capture do
-            yield(Datagrid::Helper::HtmlRow.new(@template, grid, asset))
-          end
-        else
-          _render_partial( 'row', options[:partials], {
-            :grid => grid,
-            :options => options,
-            :asset => asset
-          })
-        end
+        row(grid, asset, **options, &block)
       end.to_a.join
 
       _safe(result)
     end
 
+    def row(grid, asset, **options, &block)
+      Datagrid::Helper::HtmlRow.new(self, grid, asset, options).tap do |row|
+        if block_given?
+          return @template.capture(row, &block)
+        end
+      end
+    end
+
     def order_for(grid, column, options = {})
       _render_partial('order_for', options[:partials],
                       { :grid => grid, :column => column })
@@ -99,4 +97,61 @@ module Datagrid
       })
     end
   end
+
+  module Helper
+    # Represents a datagrid row that provides access to column values for the given asset
+    # @example
+    #   row = datagrid_row(grid, user)
+    #   row.class      # => Datagrid::Helper::HtmlRow
+    #   row.first_name # => "<strong>Bogdan</strong>"
+    #   row.grid       # => Grid object
+    #   row.asset      # => User object
+    #   row.each do |value|
+    #     puts value
+    #   end
+    class HtmlRow
+
+      include Enumerable
+
+      attr_reader :grid, :asset, :options
+
+      # @!visibility private
+      def initialize(renderer, grid, asset, options)
+        @renderer = renderer
+        @grid = grid
+        @asset = asset
+        @options = options
+      end
+
+      # @return [Object] a column value for given column name
+      def get(column)
+        @renderer.format_value(@grid, column, @asset)
+      end
+
+      # Iterates over all column values that are available in the row
+      # param block [Proc] column value iterator
+      def each(&block)
+        (@options[:columns] || @grid.html_columns).each do |column|
+          block.call(get(column))
+        end
+      end
+
+      def to_s
+        @renderer.send(:_render_partial, 'row', options[:partials], {
+          :grid => grid,
+          :options => options,
+          :asset => asset
+        })
+      end
+
+      protected
+      def method_missing(method, *args, &blk)
+        if column = @grid.column_by_name(method)
+          get(column)
+        else
+          super
+        end
+      end
+    end
+  end
 end

data/lib/datagrid/rspec.rb

@@ -32,14 +32,14 @@ shared_examples_for "Datagrid" do
       describe "filter ##{filter.name}" do
 
         let(:filter_value) do
-          
+
           case Datagrid::Filters::FILTER_TYPES.invert[filter.class]
           when :default, :string
             "text"
           when :date
             1.day.ago
-          when :xboolean, :eboolean
-            Datagrid::Filters::BooleanEnumFilter::YES
+          when :xboolean
+            Datagrid::Filters::ExtendedBooleanFilter::YES
           when :boolean
             true
           when :integer
@@ -58,7 +58,7 @@ shared_examples_for "Datagrid" do
         end
 
         it "should be supported" do
-          subject.assets.should_not be_nil 
+          subject.assets.should_not be_nil
           #TODO: better matcher.
         end
       end

data/lib/datagrid/version.rb

@@ -1,3 +1,3 @@
 module Datagrid
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/templates/grid.rb.erb

@@ -5,7 +5,7 @@ class <%= grid_class_name %> < BaseGrid
   end
 
   filter(:id, :integer)
-  filter(:created_at, :date, :range => true)
+  filter(:created_at, :date, range: true)
 
   column(:id)
   column(:name)

data/templates/index.html.erb

@@ -1,4 +1,4 @@
-<%%= datagrid_form_for @grid, :method => :get, :url => <%= grid_route_name %> %>
+<%%= datagrid_form_for @grid, method: :get, url: <%= grid_route_name %> %>
 
 <%%= <%=pagination_helper_code%> %>
 <%%= datagrid_table @grid %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -62,7 +62,6 @@ files:
 - 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
@@ -114,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Ruby gem to create datagrids

data/lib/datagrid/filters/boolean_enum_filter.rb

@@ -1,19 +0,0 @@
-# @!visibility private
-class Datagrid::Filters::BooleanEnumFilter < Datagrid::Filters::EnumFilter
-
-  YES = "YES"
-  NO = "NO"
-
-  def initialize(report, attribute, options = {}, &block)
-    Datagrid::Utils.warn_once("Datagrid eboolean filter is deprecated in favor of xboolean filter")
-    options[:select] = [YES, NO].map do |key, value|
-      [I18n.t("datagrid.filters.eboolean.#{key.downcase}", default: key.downcase.capitalize), key]
-    end
-    super(report, attribute, options, &block)
-  end
-
-
-  def checkbox_id(value)
-    [object_name, name, value].join('_').underscore
-  end
-end