datagrid 1.8.0 → 1.8.2

data/lib/datagrid/ordering.rb

@@ -27,7 +27,6 @@ module Datagrid
         alias descending? descending
 
       end
-      base.include InstanceMethods
     end
 
     # @!visibility private
@@ -37,96 +36,94 @@ module Datagrid
       end
     end
 
-    module InstanceMethods
 
-      # @!visibility private
-      def assets
-        check_order_valid!
-        apply_order(super)
-      end
+    # @!visibility private
+    def assets
+      check_order_valid!
+      apply_order(super)
+    end
 
-      # @return [Datagrid::Columns::Column, nil] a column definition that is currently used to order assets
-      # @example
-      #   class MyGrid
-      #     scope { Model }
-      #     column(:id)
-      #     column(:name)
-      #   end
-      #   MyGrid.new(order: "name").order_column # => #<Column name: "name", ...>
-      def order_column
-        order ? column_by_name(order) : nil
-      end
+    # @return [Datagrid::Columns::Column, nil] a column definition that is currently used to order assets
+    # @example
+    #   class MyGrid
+    #     scope { Model }
+    #     column(:id)
+    #     column(:name)
+    #   end
+    #   MyGrid.new(order: "name").order_column # => #<Column name: "name", ...>
+    def order_column
+      order ? column_by_name(order) : nil
+    end
 
-      # @param column [String, Datagrid::Columns::Column]
-      # @return [Boolean] true if given grid is ordered by given column.
-      def ordered_by?(column)
-        order_column == column_by_name(column)
-      end
+    # @param column [String, Datagrid::Columns::Column]
+    # @return [Boolean] true if given grid is ordered by given column.
+    def ordered_by?(column)
+      order_column == column_by_name(column)
+    end
 
-      private
+    private
 
-      def apply_order(assets)
-        return assets unless order
-        if order_column.order_by_value?
-          assets = assets.sort_by do |asset|
-            order_column.order_by_value(asset, self)
-          end
-          descending? ? assets.reverse : assets
-        else
-          if descending?
-            if order_column.order_desc
-              apply_asc_order(assets, order_column.order_desc)
-            else
-              apply_desc_order(assets, order_column.order)
-            end
+    def apply_order(assets)
+      return assets unless order
+      if order_column.order_by_value?
+        assets = assets.sort_by do |asset|
+          order_column.order_by_value(asset, self)
+        end
+        descending? ? assets.reverse : assets
+      else
+        if descending?
+          if order_column.order_desc
+            apply_asc_order(assets, order_column.order_desc)
           else
-            apply_asc_order(assets, order_column.order)
+            apply_desc_order(assets, order_column.order)
           end
+        else
+          apply_asc_order(assets, order_column.order)
         end
       end
+    end
 
-      def check_order_valid!
-        return unless order
-        column = column_by_name(order)
-        unless column
-          self.class.order_unsupported(order, "no column #{order} in #{self.class}")
-        end
-        unless column.supports_order?
-          self.class.order_unsupported(column.name, "column don't support order" )
-        end
+    def check_order_valid!
+      return unless order
+      column = column_by_name(order)
+      unless column
+        self.class.order_unsupported(order, "no column #{order} in #{self.class}")
       end
-
-      def apply_asc_order(assets, order)
-        if order.respond_to?(:call)
-          apply_block_order(assets, order)
-        else
-          driver.asc(assets, order)
-        end
+      unless column.supports_order?
+        self.class.order_unsupported(column.name, "column don't support order" )
       end
+    end
 
-      def apply_desc_order(assets, order)
-        if order.respond_to?(:call)
-          reverse_order(apply_asc_order(assets, order))
-        else
-          driver.desc(assets, order)
-        end
+    def apply_asc_order(assets, order)
+      if order.respond_to?(:call)
+        apply_block_order(assets, order)
+      else
+        driver.asc(assets, order)
       end
+    end
 
-      def reverse_order(assets)
-        driver.reverse_order(assets)
-      rescue NotImplementedError
-        self.class.order_unsupported(order_column.name, "Your ORM do not support reverse order: please specify :order_desc option manually")
+    def apply_desc_order(assets, order)
+      if order.respond_to?(:call)
+        reverse_order(apply_asc_order(assets, order))
+      else
+        driver.desc(assets, order)
       end
+    end
 
-      def apply_block_order(assets, order)
-        case order.arity
-        when -1, 0
-          assets.instance_eval(&order)
-        when 1
-          order.call(assets)
-        else
-          self.class.order_unsupported(order_column.name, "Order option proc can not handle more than one argument")
-        end
+    def reverse_order(assets)
+      driver.reverse_order(assets)
+    rescue NotImplementedError
+      self.class.order_unsupported(order_column.name, "Your ORM do not support reverse order: please specify :order_desc option manually")
+    end
+
+    def apply_block_order(assets, order)
+      case order.arity
+      when -1, 0
+        assets.instance_eval(&order)
+      when 1
+        order.call(assets)
+      else
+        self.class.order_unsupported(order_column.name, "Order option proc can not handle more than one argument")
       end
     end
   end

data/lib/datagrid/rspec.rb

@@ -46,7 +46,7 @@ shared_examples_for "Datagrid" do
             1
           when :enum
             select = subject.select_options(filter)
-            select.first.try(:last)
+            select.first&.last
           else
             raise "unknown filter type: #{filter.class}"
           end.to_s
@@ -54,7 +54,7 @@ shared_examples_for "Datagrid" do
 
         before(:each) do
           subject.attributes = {filter.name => filter_value}
-          subject.send(filter.name).should_not be_nil
+          subject.public_send(filter.name).should_not be_nil
         end
 
         it "should be supported" do

data/lib/datagrid/scaffold.rb

@@ -4,7 +4,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
 
   include Rails::Generators::ResourceHelpers
 
-  check_class_collision :suffix => "Grid"
+  check_class_collision suffix: "Grid"
   source_root File.expand_path(__FILE__ + "/../../../templates")
 
   def create_scaffold
@@ -13,7 +13,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
     end
     template "grid.rb.erb", "app/grids/#{grid_class_name.underscore}.rb"
     if file_exists?(grid_controller_file)
-      inject_into_file grid_controller_file, index_action, :after => %r{class .*#{grid_controller_class_name}.*\n}
+      inject_into_file grid_controller_file, index_action, after: %r{class .*#{grid_controller_class_name}.*\n}
     else
       template "controller.rb.erb", grid_controller_file
     end
@@ -30,7 +30,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
       }.each do |extension, string|
         file = "app/assets/stylesheets/application.#{extension}"
         if file_exists?(file)
-          inject_into_file file, string + "\n", {:before => %r{.*require_self}} # before all
+          inject_into_file file, string + "\n", {before: %r{.*require_self}} # before all
         end
       end
     end

data/lib/datagrid/utils.rb

@@ -38,15 +38,12 @@ module Datagrid
       end
 
       def add_html_classes(options, *classes)
+        return options if classes.empty?
         options = options.clone
-        options[:class] ||= ""
-        if options[:class].is_a?(Array)
-          options[:class] += classes
-        else
-          # suppose that it is a String
-          options[:class] += " " unless options[:class].blank?
-          options[:class] += classes.join(" ")
-        end
+        options[:class] ||= []
+        array = options[:class].is_a?(Array)
+        value = [*options[:class], *classes]
+        options[:class] = array ? value : value.join(" ")
         options
       end
 
@@ -117,9 +114,9 @@ module Datagrid
         if !value
           value
         elsif value.is_a?(Array)
-          [value.first.try(:beginning_of_day), value.last.try(:end_of_day)]
+          [value.first&.beginning_of_day, value.last&.end_of_day]
         elsif value.is_a?(Range)
-          (value.first.beginning_of_day..value.last.end_of_day)
+          (value.begin&.beginning_of_day..value.end&.end_of_day)
         else
           value.beginning_of_day..value.end_of_day
         end

data/lib/datagrid/version.rb

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

data/templates/base.rb.erb

@@ -11,11 +11,35 @@ class BaseGrid
   # Enable forbidden attributes protection
   # self.forbidden_attributes_protection = true
 
-  def self.date_column(name, *args)
+  # Makes a date column
+  # @param name [Symbol] Column name
+  # @param args [Array] Other column helper arguments
+  # @example
+  #   date_column(:created_at)
+  #   date_column(:owner_registered_at) do |model|
+  #     model.owner.registered_at
+  #   end
+  def self.date_column(name, *args, &block)
     column(name, *args) do |model|
-      format(block_given? ? yield : model.send(name)) do |date|
-        date.strftime("%m/%d/%Y")
+      format(block ? block.call(model) : model.public_send(name)) do |date|
+        date&.strftime("%m/%d/%Y") || "—".html_safe
       end
     end
   end
+
+  # Makes a boolean YES/NO column
+  # @param name [Symbol] Column name
+  # @param args [Array] Other column helper arguments
+  # @example
+  #   boolean_column(:approved)
+  #   boolean_column(:has_tasks, preload: :tasks) do |model|
+  #     model.tasks.unfinished.any?
+  #   end
+  def self.boolean_column(name, *args, &block)
+    column(name, *args) do |model|
+      value = block ? block.call(model) : model.public_send(name)
+      value ? "Yes" : "No"
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.2
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,16 +16,16 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-description: This allows you to easily build datagrid aka data tables with sortable
-  columns and filters
+        version: '6.1'
+description: The library allows you to easily build datagrid aka data tables with
+  sortable columns and filters
 email: agresso@gmail.com
 executables: []
 extensions: []
@@ -113,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Ruby gem to create datagrids
+summary: Library that provides DSL to present table like data
 test_files: []