actionset 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1eb88ba89dc96b42af254762a42011c32153b788
-  data.tar.gz: 174a5c1c743fff20cf343ca82abe3461a040d342
+  metadata.gz: 6cb8d92535baa9047efc45d77b0b7093348eb0ab
+  data.tar.gz: efc763790124d2130deb03b5a54656d4a8bc35cc
 SHA512:
-  metadata.gz: 5c39ddbc29032e67bb292ce87c79734a399dab2cf4467aa0e63168036a794908b840cc544394e24eb6da3c238293cded4a18b867591a0cfbef7e72b812990404
-  data.tar.gz: e982edf3262db42fcb15d871047a33d79a35344841e8a218d6b485d10315fc2cdf3b52d8f63303f9def653220a52ff318b05e69c94f9e8bf352dc59492ffb301
+  metadata.gz: b34b291f7d8ec64de74565e81c451c27b91819263fea54385cabbe08d0367a253e26e6ea52350f0429def47d5e1803cee7f8795e1b6d1368af2db4ed499997b0
+  data.tar.gz: a15050e490ac28036860fe2d8c93ea4e856ee0814424fafec168f1042c078cde849fb4fb50eb8d0df4c7d4fc368519246646fa020012a3e7f8d054fb5800ade6

data/CHANGELOG

@@ -1,3 +1,37 @@
+v 0.9.2
+  - allow for form-friendly filter parameters
+    ```
+      {
+        '0': {
+          attribute: :foo,
+          operator: :EQ,
+          query: 'query'
+        },
+        '1': {
+          attribute: :bar,
+          operator: :GT,
+          query: 'value'
+        }
+      }
+
+      { foo: 'query', bar(GT): 'value' }
+    ```
+  - allow for form-friendly sort parameters
+    ```
+      {
+        '0': {
+          attribute: :foo,
+          direction: :desc
+        },
+        '1': {
+          attribute: :bar,
+          direction: :asc
+        }
+      }
+
+      { foo: 'desc', bar: 'asc' }
+    ```
+
 v 0.9.1
   - ensure that our RubyGems build is stable, since we had a TravisCI build problem in the last version
 v 0.9.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionset (0.9.1)
+    actionset (0.9.2)
       activesupport (>= 4.0.2)
       railties
 

data/actionset.gemspec

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.name          = 'actionset'
-  spec.version       = '0.9.1'
+  spec.version       = '0.9.2'
   spec.authors       = ['Stephen Margheim']
   spec.email         = ['stephen.margheim@gmail.com']
 

data/lib/action_set.rb

@@ -5,7 +5,8 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/lazy_load_hooks'
 require 'active_set'
 
-require_relative './action_set/attribute_value'
+require_relative './action_set/filter_instructions'
+require_relative './action_set/sort_instructions'
 require_relative './action_set/helpers/helper_methods'
 
 module ActionSet
@@ -24,13 +25,13 @@ module ActionSet
 
     def filter_set(set)
       active_set = ensure_active_set(set)
-      active_set = active_set.filter(filter_instructions_for(set)) if filter_params.any?
+      active_set = active_set.filter(FilterInstructions.new(filter_params, set, self).get) if filter_params.any?
       active_set
     end
 
     def sort_set(set)
       active_set = ensure_active_set(set)
-      active_set = active_set.sort(sort_instructions) if sort_params.any?
+      active_set = active_set.sort(SortInstructions.new(sort_params, set, self).get) if sort_params.any?
       active_set
     end
 
@@ -52,26 +53,6 @@ module ActionSet
 
     private
 
-    def filter_instructions_for(set)
-      flatten_keys_of(filter_params).reject { |_, v| v.try(:empty?) }.each_with_object({}) do |(keypath, value), memo|
-        typecast_value = if value.respond_to?(:each)
-                           value.map { |v| filter_typecasted_value_for(keypath, v, set) }
-                         else
-                           filter_typecasted_value_for(keypath, value, set)
-                         end
-
-        memo[keypath] = typecast_value
-      end
-    end
-
-    def sort_instructions
-      if sort_params.key?(:attribute) && sort_params.key?(:direction)
-        { sort_params[:attribute] => sort_params[:direction] }
-      else
-        sort_params.transform_values { |v| v.remove('ending') }
-      end
-    end
-
     def paginate_instructions
       paginate_params.transform_values(&:to_i)
     end
@@ -102,31 +83,6 @@ module ActionSet
     end
     # rubocop:enable Metrics/AbcSize
 
-    def filter_typecasted_value_for(keypath, value, set)
-      klass = klass_for_keypath(keypath, value, set)
-      ActionSet::AttributeValue.new(value)
-                               .cast(to: klass)
-    end
-
-    def klass_for_keypath(keypath, value, set)
-      if respond_to?(:filter_set_types, true)
-        type_declarations = public_send(:filter_set_types)
-        types = type_declarations['types'] || type_declarations[:types]
-        klass = types[keypath.join('.')]
-        return klass if klass
-      end
-
-      if set.is_a?(ActiveRecord::Relation) || set.view.is_a?(ActiveRecord::Relation)
-        klass_type = set.model.columns_hash.fetch(keypath, nil)&.type
-        return klass_type.class if klass_type
-      end
-
-      instruction = ActiveSet::AttributeInstruction.new(keypath, value)
-      item_with_value = set.find { |i| !instruction.value_for(item: i).nil? }
-      item_value = instruction.value_for(item: item_with_value)
-      item_value.class
-    end
-
     def filter_params
       params.fetch(:filter, {}).to_unsafe_hash
     end

data/lib/action_set/filter_instructions.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative './attribute_value'
+
+module ActionSet
+  class FilterInstructions
+    def initialize(params, set, controller)
+      @params = params
+      @set = set
+      @controller = controller
+    end
+
+    def get
+      instructions_hash = if form_friendly_complex_params?
+                            form_friendly_complex_params_to_hash
+                          elsif form_friendly_simple_params?
+                            form_friendly_simple_params_to_hash
+                          else
+                            @params
+                          end
+      flattened_instructions = flatten_keys_of(instructions_hash).reject { |_, v| v.try(:empty?) }
+      flattened_instructions.each_with_object({}) do |(keypath, value), memo|
+        memo[keypath] = if value.respond_to?(:map)
+                          value.map { |v| AttributeValue.new(v).cast(to: klass_for_keypath(keypath, v, @set)) }
+                        else
+                          AttributeValue.new(value).cast(to: klass_for_keypath(keypath, value, @set))
+                        end
+      end
+    end
+
+    private
+
+    def form_friendly_complex_params?
+      @params.key?(:'0')
+    end
+
+    def form_friendly_simple_params?
+      @params.key?(:attribute) &&
+        @params.key?(:operator) &&
+        @params.key?(:query)
+    end
+
+    def form_friendly_complex_params_to_hash
+      ordered_instructions = @params.sort_by(&:first)
+      array_of_instructions = ordered_instructions.map { |_, h| ["#{h[:attribute]}(#{h[:operator]})", h[:query]] }
+      Hash[array_of_instructions]
+    end
+
+    def form_friendly_simple_params_to_hash
+      { "#{@params[:attribute]}(#{@params[:operator]})" => @params[:query] }
+    end
+
+    def klass_for_keypath(keypath, value, set)
+      if @controller.respond_to?(:filter_set_types, true)
+        type_declarations = @controller.public_send(:filter_set_types)
+        types = type_declarations['types'] || type_declarations[:types]
+        klass = types[keypath.join('.')]
+        return klass if klass
+      end
+
+      if set.is_a?(ActiveRecord::Relation) || set.view.is_a?(ActiveRecord::Relation)
+        klass_type = set.model.columns_hash.fetch(keypath, nil)&.type
+        return klass_type.class if klass_type
+      end
+
+      instruction = ActiveSet::AttributeInstruction.new(keypath, value)
+      item_with_value = set.find { |i| !instruction.value_for(item: i).nil? }
+      item_value = instruction.value_for(item: item_with_value)
+      item_value.class
+    end
+  end
+end

data/lib/action_set/sort_instructions.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module ActionSet
+  class SortInstructions
+    def initialize(params, set, controller)
+      @params = params
+      @set = set
+      @controller = controller
+    end
+
+    def get
+      instructions_hash = if form_friendly_complex_params?
+                            form_friendly_complex_params_to_hash
+                          elsif form_friendly_simple_params?
+                            form_friendly_simple_params_to_hash
+                          else
+                            @params
+                          end
+
+      instructions_hash.transform_values { |v| v.remove('ending') }
+    end
+
+    private
+
+    def form_friendly_complex_params?
+      @params.key?(:'0')
+    end
+
+    def form_friendly_simple_params?
+      @params.key?(:attribute) &&
+        @params.key?(:direction)
+    end
+
+    def form_friendly_complex_params_to_hash
+      ordered_instructions = @params.sort_by(&:first)
+      array_of_instructions = ordered_instructions.map { |_, h| [h[:attribute], h[:direction]] }
+      Hash[array_of_instructions]
+    end
+
+    def form_friendly_simple_params_to_hash
+      { @params[:attribute] => @params[:direction] }
+    end
+  end
+end

data/lib/active_set/filtering/active_record/query_column.rb

@@ -24,7 +24,7 @@ class ActiveSet
         end
 
         def must_cast_numerical_column?
-          # The LIKE operator can’t be used if the column hosts numeric types.
+          # The LIKE operator can't be used if the column hosts numeric types.
           return false unless arel_type.presence_in(%i[integer float])
 
           arel_operator.to_s.downcase.include?('match')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionset
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -259,6 +259,7 @@ files:
 - config.ru
 - lib/action_set.rb
 - lib/action_set/attribute_value.rb
+- lib/action_set/filter_instructions.rb
 - lib/action_set/helpers/export/path_for_helper.rb
 - lib/action_set/helpers/helper_methods.rb
 - lib/action_set/helpers/pagination/current_page_description_for_helper.rb
@@ -284,6 +285,7 @@ files:
 - lib/action_set/helpers/sort/link_for_helper.rb
 - lib/action_set/helpers/sort/next_direction_for_helper.rb
 - lib/action_set/helpers/sort/path_for_helper.rb
+- lib/action_set/sort_instructions.rb
 - lib/active_set.rb
 - lib/active_set/active_record_set_instruction.rb
 - lib/active_set/attribute_instruction.rb