datagrid 1.8.2 → 2.0.0

data/lib/datagrid/ordering.rb

@@ -1,42 +1,38 @@
+# frozen_string_literal: true
+
 require "datagrid/columns"
 
 module Datagrid
   # Raised when grid order value is incorrect
   class OrderUnsupported < StandardError
   end
-  module Ordering
 
+  # Module adds support for ordering by defined columns for Datagrid.
+  module Ordering
     # @!visibility private
     def self.included(base)
-      base.extend         ClassMethods
+      base.extend ClassMethods
       base.class_eval do
         include Datagrid::Columns
 
         datagrid_attribute :order do |value|
-          if value.present?
-            value.to_sym
-          else
-            nil
-          end
-
+          value.to_sym if value.present?
         end
 
         datagrid_attribute :descending do |value|
           Datagrid::Utils.booleanize(value)
         end
-        alias descending? descending
-
+        alias_method :descending?, :descending
       end
     end
 
     # @!visibility private
     module ClassMethods
       def order_unsupported(name, reason)
-        raise Datagrid::OrderUnsupported, "Can not sort #{self.inspect} by ##{name}: #{reason}"
+        raise Datagrid::OrderUnsupported, "Can not sort #{inspect} by ##{name}: #{reason}"
       end
     end
 
-
     # @!visibility private
     def assets
       check_order_valid!
@@ -56,42 +52,42 @@ module Datagrid
     end
 
     # @param column [String, Datagrid::Columns::Column]
+    # @param desc [nil, Boolean] confirm order direction as well if specified
     # @return [Boolean] true if given grid is ordered by given column.
-    def ordered_by?(column)
-      order_column == column_by_name(column)
+    def ordered_by?(column, desc = nil)
+      order_column == column_by_name(column) &&
+        (desc.nil? || (desc ? descending? : !descending?))
     end
 
     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
+      elsif 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
 
     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
+      self.class.order_unsupported(order, "no column #{order} in #{self.class}") unless column
+      return if column.supports_order?
+
+      self.class.order_unsupported(column.name, "column don't support order")
     end
 
     def apply_asc_order(assets, order)
@@ -113,7 +109,8 @@ module Datagrid
     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")
+      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)

data/lib/datagrid/rspec.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 require "datagrid"
 
-#TODO: refactor this experimental shit
+# TODO: refactor this experimental shit
 shared_examples_for "Datagrid" do
   describe "as Datagrid" do
-
     it "should have at least one entry if assets" do
       subject.assets.should_not be_empty
     end
 
-    described_class.columns(:data => true).each do |column|
+    described_class.columns(data: true).each do |column|
       describe "column ##{column.name}" do
-
         it "should has value in #data_hash" do
           subject.data_hash.first.should have_key(column.name)
         end
@@ -25,14 +25,11 @@ shared_examples_for "Datagrid" do
           subject.assets.first.should_not be_nil
         end
       end
-
     end
 
     described_class.filters.each do |filter|
       describe "filter ##{filter.name}" do
-
         let(:filter_value) do
-
           case Datagrid::Filters::FILTER_TYPES.invert[filter.class]
           when :default, :string
             "text"
@@ -53,16 +50,15 @@ shared_examples_for "Datagrid" do
         end
 
         before(:each) do
-          subject.attributes = {filter.name => filter_value}
+          subject.attributes = { filter.name => filter_value }
           subject.public_send(filter.name).should_not be_nil
         end
 
         it "should be supported" do
           subject.assets.should_not be_nil
-          #TODO: better matcher.
+          # TODO: better matcher.
         end
       end
     end
-
   end
 end

data/lib/datagrid/utils.rb

@@ -1,44 +1,49 @@
+# frozen_string_literal: true
+
 module Datagrid
   # @!visibility private
-  module Utils # :nodoc:
+  module Utils
     class << self
-
-
-      TRUTH = [true, 1, "1", "true", "yes", "on"]
+      TRUTH = [true, 1, "1", "true", "yes", "on"].freeze
 
       def booleanize(value)
-        if value.respond_to?(:downcase)
-          value = value.downcase
-        end
+        value = value.downcase if value.respond_to?(:downcase)
         TRUTH.include?(value)
       end
 
       def translate_from_namespace(namespace, grid_class, key)
-
         lookups = []
         namespaced_key = "#{namespace}.#{key}"
 
         grid_class.ancestors.each do |ancestor|
-          if ancestor.respond_to?(:model_name)
-            lookups << :"datagrid.#{ancestor.model_name.i18n_key}.#{namespaced_key}"
-          end
+          lookups << :"datagrid.#{ancestor.model_name.i18n_key}.#{namespaced_key}" if ancestor.respond_to?(:model_name)
         end
         lookups << :"datagrid.defaults.#{namespaced_key}"
         lookups << key.to_s.humanize
         I18n.t(lookups.shift, default: lookups).presence
       end
 
+      def deprecator
+        if defined?(Rails) && Rails.version >= "7.1.0"
+          Rails.deprecator
+        else
+          ActiveSupport::Deprecation
+        end
+      end
+
       def warn_once(message, delay = 5)
         @warnings ||= {}
         timestamp = @warnings[message]
         return false if timestamp && timestamp >= Time.now - delay
-        warn message
+
+        deprecator.warn(message)
         @warnings[message] = Time.now
         true
       end
 
       def add_html_classes(options, *classes)
         return options if classes.empty?
+
         options = options.clone
         options[:class] ||= []
         array = options[:class].is_a?(Array)
@@ -52,41 +57,42 @@ module Datagrid
       end
 
       def extract_position_from_options(array, options)
-        before, after = options[:before], options[:after]
-        if before && after
-          raise Datagrid::ConfigurationError, "Options :before and :after can not be used together"
-        end
+        before = options[:before]
+        after = options[:after]
+        raise Datagrid::ConfigurationError, "Options :before and :after can not be used together" if before && after
         # Consider as before all
         return 0 if before == true
+
         if before
           before = before.to_sym
-          array.index {|c| c.name.to_sym == before }
+          array.index { |c| c.name.to_sym == before }
         elsif after
           after = after.to_sym
-          array.index {|c| c.name.to_sym == after } + 1
+          array.index { |c| c.name.to_sym == after } + 1
         else
           -1
         end
       end
 
       def apply_args(*args, &block)
-        size = block.arity < 0 ? args.size : block.arity
+        size = block.arity.negative? ? args.size : block.arity
         block.call(*args.slice(0, size))
       end
 
       def parse_date(value)
         return nil if value.blank?
         return value if value.is_a?(Range)
+
         if value.is_a?(String)
           Array(Datagrid.configuration.date_formats).each do |format|
-            begin
-              return Date.strptime(value, format)
-            rescue ::ArgumentError
-            end
+            return Date.strptime(value, format)
+          rescue ::ArgumentError
+            nil
           end
         end
         return Date.parse(value) if value.is_a?(String)
         return value.to_date if value.respond_to?(:to_date)
+
         value
       rescue ::ArgumentError
         nil
@@ -95,16 +101,18 @@ module Datagrid
       def parse_datetime(value)
         return nil if value.blank?
         return value if value.is_a?(Range)
+        return value if defined?(ActiveSupport::TimeWithZone) && value.is_a?(ActiveSupport::TimeWithZone)
+
         if value.is_a?(String)
           Array(Datagrid.configuration.datetime_formats).each do |format|
-            begin
-              return Time.strptime(value, format)
-            rescue ::ArgumentError
-            end
+            return Time.strptime(value, format)
+          rescue ::ArgumentError
+            nil
           end
         end
         return Time.parse(value) if value.is_a?(String)
         return value.to_time if value.respond_to?(:to_time)
+
         value
       rescue ::ArgumentError
         nil
@@ -113,10 +121,8 @@ module Datagrid
       def format_date_as_timestamp(value)
         if !value
           value
-        elsif value.is_a?(Array)
-          [value.first&.beginning_of_day, value.last&.end_of_day]
         elsif value.is_a?(Range)
-          (value.begin&.beginning_of_day..value.end&.end_of_day)
+          value.begin&.beginning_of_day..value.end&.end_of_day
         else
           value.beginning_of_day..value.end_of_day
         end
@@ -132,6 +138,7 @@ module Datagrid
       end
 
       protected
+
       def property_availability(grid, option, default)
         case option
         when nil

data/lib/datagrid/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Datagrid
-  VERSION = "1.8.2"
+  VERSION = "2.0.0"
 end

data/lib/datagrid.rb

@@ -1,49 +1,29 @@
+# frozen_string_literal: true
+
 require "action_view"
 require "datagrid/configuration"
+require "datagrid/engine"
 
 module Datagrid
-
-  extend ActiveSupport::Autoload
-
-  autoload :Core
-  autoload :ActiveModel
-  autoload :Filters
-  autoload :Columns
-  autoload :ColumnNamesAttribute
-  autoload :Ordering
-  autoload :Configuration
-
-  autoload :Helper
-  ActionView::Base.send(:include, Datagrid::Helper)
-
-  autoload :FormBuilder
-  ActionView::Helpers::FormBuilder.send(:include, Datagrid::FormBuilder)
-
-  autoload :Renderer
-
-  autoload :Engine
-
   # @!visibility private
   def self.included(base)
+    Utils.warn_once("Including Datagrid is deprecated. Inherit Datagrid::Base instead.")
     base.class_eval do
-
       include ::Datagrid::Core
       include ::Datagrid::ActiveModel
       include ::Datagrid::Filters
       include ::Datagrid::Columns
       include ::Datagrid::ColumnNamesAttribute
       include ::Datagrid::Ordering
-
     end
   end
 
   class ConfigurationError < StandardError; end
   class ArgumentError < ::ArgumentError; end
   class ColumnUnavailableError < StandardError; end
-
 end
 
-require "datagrid/scaffold"
-I18n.load_path << File.expand_path('../datagrid/locale/en.yml', __FILE__)
-
-
+require "datagrid/base"
+require "datagrid/generators/scaffold"
+require "datagrid/generators/views"
+I18n.load_path << File.expand_path("datagrid/locale/en.yml", __dir__)

data/templates/base.rb.erb

@@ -1,7 +1,4 @@
-class BaseGrid
-
-  include Datagrid
-
+class ApplicationGrid < Datagrid::Base
   self.default_column_options = {
     # Uncomment to disable the default order
     # order: false,
@@ -42,4 +39,9 @@ class BaseGrid
     end
   end
 
+  # Uncomment to shorten URL query string for all grids.
+  # May cause collisions if multiple grids are used on the same page.
+  # def param_name
+  #   'grid'
+  # end
 end

data/templates/grid.rb.erb

@@ -1,4 +1,4 @@
-class <%= grid_class_name %> < BaseGrid
+class <%= grid_class_name %> < <%= grid_base_class %>
 
   scope do
     <%= grid_model_name %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-22 00:00:00.000000000 Z
+date: 2024-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7.0'
 description: The library allows you to easily build datagrid aka data tables with
   sortable columns and filters
 email: agresso@gmail.com
@@ -31,12 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- Readme.markdown
+- README.md
 files:
+- ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
-- Readme.markdown
-- app/assets/stylesheets/datagrid.sass
+- README.md
+- app/assets/stylesheets/datagrid.css
 - app/views/datagrid/_enum_checkboxes.html.erb
 - app/views/datagrid/_form.html.erb
 - app/views/datagrid/_head.html.erb
@@ -47,11 +48,13 @@ files:
 - datagrid.gemspec
 - lib/datagrid.rb
 - lib/datagrid/active_model.rb
+- lib/datagrid/base.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/deprecated_object.rb
 - lib/datagrid/drivers.rb
 - lib/datagrid/drivers/abstract_driver.rb
 - lib/datagrid/drivers/active_record.rb
@@ -63,7 +66,6 @@ files:
 - lib/datagrid/filters.rb
 - lib/datagrid/filters/base_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
@@ -76,28 +78,26 @@ files:
 - lib/datagrid/filters/select_options.rb
 - lib/datagrid/filters/string_filter.rb
 - lib/datagrid/form_builder.rb
+- lib/datagrid/generators/scaffold.rb
+- lib/datagrid/generators/views.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/datagrid/version.rb
-- lib/tasks/datagrid_tasks.rake
 - templates/base.rb.erb
-- templates/controller.rb.erb
 - templates/grid.rb.erb
-- templates/index.html.erb
 homepage: https://github.com/bogdan/datagrid
 licenses:
 - MIT
 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
+  documentation_uri: https://rubydoc.info/gems/datagrid
+  changelog_uri: https://github.com/bogdan/datagrid/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/bogdan/datagrid
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -106,14 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Library that provides DSL to present table like data

data/app/assets/stylesheets/datagrid.sass

@@ -1,134 +0,0 @@
-$dg-form-label: 150px
-
-= clearfix
-  *zoom: 1
-
-  &:before,
-  &:after
-    display: table
-    content: ''
-
-  &:after
-    clear: both
-
-=inline-block
-  display: inline-block
-  zoom: 1
-  *display: inline
-
-table.datagrid
-  background-color: transparent
-  border-collapse: collapse
-  max-width: 100%
-
-  th
-    background-color: #eee
-    text-align: left
-
-  td,
-  th 
-    border: 1px solid #d6d6d6
-    padding: 5px 10px
-
-    .order
-      a.asc, a.desc
-        text-decoration: none
-        font-weight: normal
-
-    &.ordered
-      background-color: #fff7d5
-
-      &.asc
-        a.asc
-          font-weight: bold
-          color: #d00
-
-      &.desc
-        a.desc
-          font-weight: bold
-          color: #d00
-  .noresults
-    text-align: center
-    
-.datagrid-form
-  background-color: #f0f0f0
-  border-radius: 5px
-  padding: 20px
-
-.datagrid-filter
-  margin: 10px
-  +clearfix
-
-  label
-    width: $dg-form-label
-    float: left
-  a
-    float: left
-
-  input[class*='filter']
-    border: 2px solid #ccc
-    border-radius: 4px
-    float: left
-    padding: 5px 12px
-    width: 207px
-
-    &.from, &.to
-      width: 83px
-
-  select
-    float: left
-    width: 235px
-
-    &[multiple]
-      border: 2px solid #ccc
-      border-radius: 5px
-      height: 100px
-    &.dynamic_filter
-      &.field
-        width: 178px
-      &.operation
-        margin-left: 7px
-        width: 50px
-  input.dynamic_filter.value
-    margin: 10px 0 0 $dg-form-label
-    clear: both
-
-  .separator
-    float: left
-    margin: 6px 4px 0
-  .enum_filter.checkboxes 
-    float: none
-    display: block
-    input
-      margin: 7px
-    margin-left: 150px
-
-
-.datagrid-actions
-  padding-left: $dg-form-label + 10
-
-  input[type='submit']
-    background-color: #555
-    border: none
-    border-radius: 5px
-    color: white
-    cursor: pointer
-    font-size: 14px
-    font-weight: bold
-    line-height: normal
-    padding: 7px 15px
-    vertical-align: middle
-    +inline-block
-
-    &:hover,
-    &:focus
-      background-color: #333
-
-    &:active
-      background-color: #000
-
-  > a
-    font-size: 14px
-    padding: 7px 15px
-    vertical-align: middle
-    +inline-block