datagrid 2.0.5 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c86512c8f1419a81e769bc5341867e20071dcf1424ce55200a496e529a3b275c
-  data.tar.gz: b192c0bd6a90ce4085255de178ef732cbef691c7e529905138b47b6edd122fa1
+  metadata.gz: f5ac6077bea5b3ee95001a94f7c862a2430dec10d5d35602ac763ad748b2bd6f
+  data.tar.gz: 86a7e62eebc8044e215708ce2aa29f63955e5c7c0635a4e48e1e41f35bffc291
 SHA512:
-  metadata.gz: da1baacc64d7e8502ce8738ff4de3c6346f2e1b486a49337c7194a64fcabbf9c38ba8839e1cd1f1be181419b185b79b41147cc0536581846625ca6386c21e1fd
-  data.tar.gz: af4ababb2213b465ef1fbac48a406166d336d917becbde4cb58ad0643aa78032f0f23fcf4461c730582cf5a162edfec5817f794bea54d9b3310d9801ba5aca63
+  metadata.gz: 3f695cc908307c31ae745621b6afe99ef86422b685549d3084e9b5610c7420eea8c0de9318a25849f0e0042bdc0c95d11b6163ebf0d01ea1b4d62d6de8bd2b81
+  data.tar.gz: 3fe0c0cde94487679ec67ba563b8668f26fa4f977700a25ae58c35a1908bdc73d1558b83a4593eaaf51810844baa26e99e834f7a280edae01ad55f6bc83c3051

data/CHANGELOG.md

@@ -1,5 +1,50 @@
 # Changelog
 
+## [2.0.8]
+
+* Rescue StatementInvalid when guessing column type from a query
+* Prevent typecasting of date into timestamp when `:date` filter has a block
+
+``` ruby
+class MyGrid < Datagrid::Base
+  scope { User }
+
+  filter(:created_at, :date) do |scope, value|
+    value.is_a?(Date) # => true
+    scope.joins(:registration).where(registrations: { registration_date: value })
+  end
+end
+```
+
+## [2.0.7]
+
+* Raise `Datagrid::ConfigurationError` when column or filter name 
+  specified in `before` or `after` option not found.
+* Fixed `as_query` method when dynamic filter is used. Fixes [#344](https://github.com/bogdan/datagrid/issues/344)
+
+``` ruby
+grid = ProductsGrid.new(category: 'dresses', available: true, condition: ["price", ">=", 25])
+# Before
+grid.as_query 
+  # => {
+  #      category: 'dresses', 
+  #      available: true, 
+  #      condition: #<Object>
+  #    }
+# After
+grid.as_query 
+  # => {
+  #      "category" => 'dresses', 
+  #      "available" => true, 
+  #      "condition" => { "field" => "price", "operation" => ">=", "value" => "25" }
+  #    }
+```
+
+
+## [2.0.6]
+
+* Validate dummy filter can not accept block
+
 ## [2.0.5]
 
 * Add support for timestamptz ActiveRecord column type

data/lib/datagrid/columns.rb

@@ -378,6 +378,9 @@ module Datagrid
         end
 
         position = Datagrid::Utils.extract_position_from_options(columns, options)
+        unless position
+          raise Datagrid::ConfigurationError, "#{self}##{options[:before] || options[:after]} column not found"
+        end
         column = Datagrid::Columns::Column.new(
           self, name, query, options, &block
         )

data/lib/datagrid/core.rb

@@ -2,6 +2,7 @@
 
 require "datagrid/drivers"
 require "active_support/core_ext/class/attribute"
+require "active_support/core_ext/object/json"
 require "active_model/attribute_assignment"
 
 module Datagrid
@@ -210,16 +211,15 @@ module Datagrid
       scope
     end
 
-    # @return [Hash{Symbol => Object}] serializable query arguments skipping all nil values
+    # @return [Hash{String => Object}] serializable query arguments skipping all nil values
     # @example
     #   grid = ProductsGrid.new(category: 'dresses', available: true)
     #   grid.as_query # => {category: 'dresses', available: true}
     def as_query
-      attributes = self.attributes.clone
-      attributes.each do |key, value|
-        attributes.delete(key) if value.nil?
+      self.attributes.reduce({}) do |result, (k,v)|
+        result[k.to_s] = v.as_json unless v.nil?
+        result
       end
-      attributes
     end
 
     # @return [Hash{Symbol => Hash{Symbol => Object}}] query parameters to link this grid from a page
@@ -228,7 +228,18 @@ module Datagrid
     #   Rails.application.routes.url_helpers.products_path(grid.query_params)
     #     # => "/products?products_grid[category]=dresses&products_grid[available]=true"
     def query_params(attributes = {})
-      { param_name.to_sym => as_query.merge(attributes) }
+      { param_name.to_s => as_query.merge(attributes.stringify_keys) }
+    end
+
+    # @return [Hash{String => Object}] JSON representation of datagrid attributes
+    # @example
+    #   grid = ProductsGrid.new(category: 'dresses', available: true)
+    #   grid.as_json # => {"category" => 'dresses', "available" => true}
+    def as_json(options = nil)
+      attributes.reduce({}) do |result, (k,v)|
+        result[k.to_s] = v.as_json(options)
+        result
+      end
     end
 
     # @return [void] redefines scope at instance level

data/lib/datagrid/drivers/active_record.rb

@@ -31,12 +31,10 @@ module Datagrid
       end
 
       def append_column_queries(assets, columns)
-        if columns.present?
-          assets = assets.select(assets.klass.arel_table[Arel.star]) if assets.select_values.empty?
-          columns = columns.map { |c| "#{c.query} AS #{c.name}" }
-          assets = assets.select(*columns)
-        end
-        assets
+        return assets if columns.empty?
+        assets = assets.select(assets.klass.arel_table[Arel.star]) if assets.select_values.empty?
+        columns = columns.map { |c| "#{c.query} AS #{c.name}" }
+        assets.select(*columns)
       end
 
       def where(scope, attribute, value)
@@ -88,20 +86,34 @@ module Datagrid
         scope.where("#{field} #{contains_predicate} ?", "%#{value}%")
       end
 
+      def builtin_type(scope, field)
+        if scope_has_column?(scope, field)
+          scope.columns_hash[field.to_s].type
+        else
+          begin
+            scope.connection.select_all(
+              scope.unscope(:select, :order).select(field => "custom_field").limit(0).arel
+            ).column_types['custom_field']&.type
+          rescue ActiveRecord::StatementInvalid
+            nil
+          end
+        end
+      end
+
       def normalized_column_type(scope, field)
-        return nil unless scope_has_column?(scope, field)
-
-        builtin_type = scope.columns_hash[field.to_s].type
-        {
-          %i[string text time binary] => :string,
-          %i[integer primary_key] => :integer,
-          %i[float decimal] => :float,
-          [:date] => :date,
-          %i[datetime timestamp timestamptz] => :timestamp,
-          [:boolean] => :boolean,
-        }.each do |keys, value|
-          return value if keys.include?(builtin_type)
+        if builtin_type = builtin_type(scope, field)
+          {
+            %i[string text time binary] => :string,
+            %i[integer primary_key] => :integer,
+            %i[float decimal] => :float,
+            [:date] => :date,
+            %i[datetime timestamp timestamptz] => :timestamp,
+            [:boolean] => :boolean,
+          }.each do |keys, value|
+            return value if keys.include?(builtin_type)
+          end
         end
+        nil
       end
 
       def batch_each(scope, batch_size, &block)

data/lib/datagrid/filters/base_filter.rb

@@ -17,10 +17,13 @@ module Datagrid
         self.name = name.to_sym
         self.options = Datagrid::Utils.callable(grid_class.default_filter_options, self).merge(options)
         self.block = block
+        if dummy? && block
+          raise Datagrid::ConfigurationError, "#{grid_class}##{name} filter is dummy and can not accept block"
+        end
       end
 
       def parse(value)
-        raise NotImplementedError, "#parse(value) suppose to be overwritten"
+        raise NotImplementedError, "#{self.class}#parse(value) suppose to be overwritten"
       end
 
       def default_input_options
@@ -32,7 +35,7 @@ module Datagrid
       end
 
       def apply(grid_object, scope, value)
-        return scope if unapplicable_value?(value)
+        return scope if dummy? || unapplicable_value?(value)
 
         result = execute(value, scope, grid_object)
 

data/lib/datagrid/filters/date_filter.rb

@@ -12,7 +12,9 @@ module Datagrid
       end
 
       def apply(grid_object, scope, value)
-        value = Datagrid::Utils.format_date_as_timestamp(value) if grid_object.driver.timestamp_column?(scope, name)
+        if !dummy? && !block && grid_object.driver.timestamp_column?(scope, name)
+          value = Datagrid::Utils.format_date_as_timestamp(value)
+        end
         super
       end
 

data/lib/datagrid/filters/dynamic_filter.rb

@@ -128,7 +128,7 @@ module Datagrid
         end
 
         def inspect
-          { field: field, operation: operation, value: value }
+          "#<#{self.class} #{to_h.inspect}>"
         end
 
         def to_ary
@@ -143,6 +143,10 @@ module Datagrid
           { field: field, operation: operation, value: value }
         end
 
+        def as_json
+          { "field" => field, "operation" => operation, "value" => value }
+        end
+
         protected
 
         def type_cast(type, value)

data/lib/datagrid/filters.rb

@@ -244,6 +244,9 @@ module Datagrid
         raise ConfigurationError, "filter class #{type.inspect} not found" unless klass
 
         position = Datagrid::Utils.extract_position_from_options(filters_array, options)
+        unless position
+          raise Datagrid::ConfigurationError, "#{self}##{options[:before] || options[:after]} filter not found"
+        end
         filter = klass.new(self, name, **options, &block)
         filters_array.insert(position, filter)
 

data/lib/datagrid/helper.rb

@@ -436,7 +436,7 @@ module Datagrid
       query = request&.query_parameters || {}
       ActionDispatch::Http::URL.path_for(
         path: request&.path || "/",
-        params: query.merge(grid.query_params(order: column.name, descending: descending)),
+        params: query.merge(grid.query_params("order" => column.name, "descending" => descending)),
       )
     end
 

data/lib/datagrid/utils.rb

@@ -4,7 +4,7 @@ module Datagrid
   # @!visibility private
   module Utils
     class << self
-      TRUTH = [true, 1, "1", "true", "yes", "on"].freeze
+      TRUTH = [true, 1, "1", "true", "yes", "on", "y"].freeze
 
       def booleanize(value)
         value = value.downcase if value.respond_to?(:downcase)
@@ -68,7 +68,9 @@ module Datagrid
           array.index { |c| c.name.to_sym == before }
         elsif after
           after = after.to_sym
-          array.index { |c| c.name.to_sym == after } + 1
+          if index = array.index { |c| c.name.to_sym == after }
+            index + 1
+          end
         else
           -1
         end

data/lib/datagrid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Datagrid
-  VERSION = "2.0.5"
+  VERSION = "2.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.8
 platform: ruby
 authors:
 - Bogdan Gusiev