actionset 0.8.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dffd9096dbb67844e4cee728dee2dbea434a32e2
-  data.tar.gz: a6bcb0b49df525a8d3e6e74f06a067310674fd87
+  metadata.gz: 1eb88ba89dc96b42af254762a42011c32153b788
+  data.tar.gz: 174a5c1c743fff20cf343ca82abe3461a040d342
 SHA512:
-  metadata.gz: f7400ae1649bde246c247752feabb37adc3c290ce464aee8271980c265965be920ac2cdae6c06b009fbbc59df371ec7e1aad075f4035a2e624ead3f6254e0011
-  data.tar.gz: ca373cfc982b4455ec40c5df823c94ccc4a16e0c2fc1fafeb2eb3cc9ea65b8be664df7135d6ef52c9e1b5cca12e959ae23eda6815809cb62e93baae0acec5d96
+  metadata.gz: 5c39ddbc29032e67bb292ce87c79734a399dab2cf4467aa0e63168036a794908b840cc544394e24eb6da3c238293cded4a18b867591a0cfbef7e72b812990404
+  data.tar.gz: e982edf3262db42fcb15d871047a33d79a35344841e8a218d6b485d10315fc2cdf3b52d8f63303f9def653220a52ff318b05e69c94f9e8bf352dc59492ffb301

data/CHANGELOG

@@ -1,3 +1,27 @@
+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
+  - Add Enumerable support for the base filtering operations
+    + EQ, NOT_EQ, EQ_ANY, EQ_ALL, NOT_EQ_ANY, NOT_EQ_ALL
+    + IN, NOT_IN, IN_ANY, IN_ALL, NOT_IN_ANY, NOT_IN_ALL
+    + MATCHES, DOES_NOT_MATCH, MATCHES_ANY, MATCHES_ALL, DOES_NOT_MATCH_ANY, DOES_NOT_MATCH_ALL
+    + LT, LTEQ, LT_ANY, LT_ALL, LTEQ_ANY, LTEQ_ALL
+    + GT, GTEQ, GT_ANY, GT_ALL, GTEQ_ANY, GTEQ_ALL
+    + BETWEEN, NOT_BETWEEN
+  - Add unary predicate filtering operators, for both ActiveRecord and Enumerable
+    + IS_TRUE, IS_FALSE
+    + IS_NULL, NOT_NULL
+    + IS_PRESENT, IS_BLANK
+  - Add computed matcher filtering operators, for both ActiveRecord and Enumerable
+    + MATCH_START, MATCH_START_ANY, MATCH_START_ALL, MATCH_NOT_START, MATCH_NOT_START_ANY, MATCH_NOT_START_ALL
+    + MATCH_END, MATCH_END_ANY, MATCH_END_ALL, MATCH_NOT_END, MATCH_NOT_END_ANY, MATCH_NOT_END_ALL
+    + MATCH_CONTAIN, MATCH_CONTAIN_ANY, MATCH_CONTAIN_ALL, MATCH_NOT_CONTAIN, MATCH_NOT_CONTAIN_ANY, MATCH_NOT_CONTAIN_ALL
+  - Add view helpers for the range of records shown on the current page
+  - Use ActiveRecord's data dictionary to look up database column types when converting filter params to filter instructions
+  - Allow app to define type hints for filter attributes when converting filter params to filter instructions
+  - Allow sort params to be passed in short or long form
+    + e.g. { attribute: x, direction: x } or { attribute: direction }
+  - Fix enumerable intersection filtering when working across associations
 v 0.8.2
   - add `ActiveSet.configuration.on_asc_sort_nils_come` configuration
 v 0.8.1

data/Gemfile.lock

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

data/Rakefile

@@ -5,4 +5,10 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :full_spec do
+  ENV['COVERAGE'] = 'true'
+  ENV['INSPECT_FAILURE'] = 'true'
+  Rake::Task['spec'].invoke
+end
+
+task default: :full_spec

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.8.2'
+  spec.version       = '0.9.1'
   spec.authors       = ['Stephen Margheim']
   spec.email         = ['stephen.margheim@gmail.com']
 

data/lib/action_set.rb

@@ -30,7 +30,7 @@ module ActionSet
 
     def sort_set(set)
       active_set = ensure_active_set(set)
-      active_set = active_set.sort(sort_params) if sort_params.any?
+      active_set = active_set.sort(sort_instructions) if sort_params.any?
       active_set
     end
 
@@ -64,18 +64,19 @@ module ActionSet
       end
     end
 
-    def filter_typecasted_value_for(keypath, value, set)
-      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)
-      ActionSet::AttributeValue.new(value)
-                               .cast(to: item_value.class)
+    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
 
+    # rubocop:disable Metrics/AbcSize
     def export_instructions
       {}.tap do |struct|
         struct[:format] = export_params[:format] || request.format.symbol
@@ -93,10 +94,38 @@ module ActionSet
                            elsif respond_to?(:export_set_columns, true)
                              send(:export_set_columns)
                            else
+                             # :nocov:
                              [{}]
+                             # :nocov:
                            end
       end
     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

data/lib/action_set/attribute_value.rb

@@ -11,7 +11,7 @@ module ActionSet
     def cast(to:)
       adapters.reduce(nil) do |_, adapter|
         mayble_value_or_nil = adapter.new(@raw, to).process
-        next if mayble_value_or_nil.nil?
+        next nil if mayble_value_or_nil.nil?
 
         return mayble_value_or_nil
       end
@@ -62,7 +62,9 @@ module ActionSet
       begin
         require 'active_model/type'
       rescue LoadError
+        # :nocov:
         require 'active_record/type'
+        # :nocov:
       end
 
       def initialize(raw, target)
@@ -106,13 +108,17 @@ module ActionSet
       def init_typecaster(const_name)
         type_class.const_get(const_name).new
       rescue StandardError
+        # :nocov:
         nil
+        # :nocov:
       end
 
       def type_class
         ActiveModel::Type
       rescue NameError
+        # :nocov:
         ActiveRecord::Type
+        # :nocov:
       end
     end
 

data/lib/action_set/helpers/helper_methods.rb

@@ -2,7 +2,7 @@
 
 require_relative './sort/link_for_helper'
 require_relative './pagination/links_for_helper'
-require_relative './pagination/path_for_helper'
+require_relative './pagination/record_description_for_helper'
 require_relative './params/form_for_object_helper'
 require_relative './export/path_for_helper'
 
@@ -11,6 +11,7 @@ module ActionSet
     module HelperMethods
       include Sort::LinkForHelper
       include Pagination::LinksForHelper
+      include Pagination::RecordDescriptionForHelper
       include Params::FormForObjectHelper
       include Export::PathForHelper
     end

data/lib/action_set/helpers/pagination/record_description_for_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './record_range_for_helper'
+require_relative './record_size_for_helper'
+
+module Pagination
+  module RecordDescriptionForHelper
+    include Pagination::RecordRangeForHelper
+    include Pagination::RecordSizeForHelper
+
+    def pagination_record_description_for(set)
+      [
+        pagination_record_range_for(set),
+        'of',
+        "<strong>#{pagination_record_size_for(set)}</strong>",
+        'records'
+      ].join('&nbsp;').html_safe
+    end
+  end
+end

data/lib/action_set/helpers/pagination/record_first_for_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './current_page_for_helper'
+require_relative './page_size_for_helper'
+
+module Pagination
+  module RecordFirstForHelper
+    include Pagination::CurrentPageForHelper
+    include Pagination::PageSizeForHelper
+
+    def pagination_record_first_for(set)
+      current_page = pagination_current_page_for(set)
+      page_size = pagination_page_size_for(set)
+
+      return 1 if current_page == 1
+
+      ((current_page - 1) * page_size) + 1
+    end
+  end
+end

data/lib/action_set/helpers/pagination/record_last_for_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative './current_page_for_helper'
+require_relative './record_size_for_helper'
+require_relative './page_size_for_helper'
+require_relative './total_pages_for_helper'
+
+module Pagination
+  module RecordLastForHelper
+    include Pagination::RecordSizeForHelper
+    include Pagination::CurrentPageForHelper
+    include Pagination::PageSizeForHelper
+    include Pagination::TotalPagesForHelper
+
+    def pagination_record_last_for(set)
+      record_size = pagination_record_size_for(set)
+      current_page = pagination_current_page_for(set)
+      page_size = pagination_page_size_for(set)
+      total_pages = pagination_total_pages_for(set)
+
+      return record_size if current_page >= total_pages
+
+      current_page * page_size
+    end
+  end
+end

data/lib/action_set/helpers/pagination/record_range_for_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative './record_first_for_helper'
+require_relative './record_last_for_helper'
+
+module Pagination
+  module RecordRangeForHelper
+    include Pagination::CurrentPageForHelper
+    include Pagination::TotalPagesForHelper
+    include Pagination::RecordFirstForHelper
+    include Pagination::RecordLastForHelper
+
+    def pagination_record_range_for(set)
+      current_page = pagination_current_page_for(set)
+      total_pages = pagination_total_pages_for(set)
+      return 'None' if current_page > total_pages
+
+      [
+        pagination_record_first_for(set),
+        '–',
+        pagination_record_last_for(set)
+      ].join(' ').html_safe
+    end
+  end
+end

data/lib/action_set/helpers/pagination/record_size_for_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Pagination
+  module RecordSizeForHelper
+    def pagination_record_size_for(set)
+      set.instructions.dig(:paginate, :count)
+    end
+  end
+end

data/lib/action_set/helpers/pagination/total_pages_for_helper.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+require_relative './record_size_for_helper'
 require_relative './page_size_for_helper'
 
 module Pagination
   module TotalPagesForHelper
+    include Pagination::RecordSizeForHelper
     include Pagination::PageSizeForHelper
 
     def pagination_total_pages_for(set)
-      total_set_size = set.instructions.dig(:paginate, :count)
+      total_set_size = pagination_record_size_for(set)
       return 1 if total_set_size.zero?
 
       (total_set_size.to_f / pagination_page_size_for(set)).ceil

data/lib/active_set/active_record_set_instruction.rb

@@ -9,15 +9,41 @@ class ActiveSet
     end
 
     def initial_relation
-      return @set if @attribute_instruction.associations_array.empty?
+      return @initial_relation if defined? @initial_relation
 
-      @set.eager_load(@attribute_instruction.associations_hash)
+      @initial_relation = if @attribute_instruction.associations_array.empty?
+                            @set
+                          else
+                            @set.eager_load(@attribute_instruction.associations_hash)
+                          end
     end
 
+    def arel_column
+      return @arel_column if defined? @arel_column
+
+      arel_column = arel_table[@attribute_instruction.attribute]
+      arel_column = arel_column.lower if case_insensitive_operation?
+
+      @arel_column = arel_column
+    end
+
+    def attribute_model
+      return @set.klass if @attribute_instruction.associations_array.empty?
+      return @attribute_model if defined? @attribute_model
+
+      @attribute_model = @attribute_instruction
+                         .associations_array
+                         .reduce(@set) do |obj, assoc|
+        obj.reflections[assoc.to_s]&.klass
+      end
+    end
+
+    private
+
     def arel_type
       attribute_model
-        .columns_hash[@attribute_instruction.attribute]
-        .type
+        &.columns_hash[@attribute_instruction.attribute]
+        &.type
     end
 
     def arel_table
@@ -31,41 +57,8 @@ class ActiveSet
       end
     end
 
-    # rubocop:disable Lint/UnderscorePrefixedVariableName
-    def arel_column
-      _arel_column = arel_table[@attribute_instruction.attribute]
-      return _arel_column.lower if case_insensitive_operation?
-
-      _arel_column
-    end
-    # rubocop:enable Lint/UnderscorePrefixedVariableName
-
-    def arel_operator
-      @attribute_instruction.operator(default: :eq)
-    end
-
-    # rubocop:disable Lint/UnderscorePrefixedVariableName
-    def arel_value
-      _arel_value = @attribute_instruction.value
-      return _arel_value.downcase if case_insensitive_operation?
-
-      _arel_value
-    end
-    # rubocop:enable Lint/UnderscorePrefixedVariableName
-
     def case_insensitive_operation?
       @attribute_instruction.case_insensitive? && arel_type.presence_in(%i[string text])
     end
-
-    def attribute_model
-      return @set.klass if @attribute_instruction.associations_array.empty?
-      return @attribute_model if defined? @attribute_model
-
-      @attribute_model = @attribute_instruction
-                         .associations_array
-                         .reduce(@set) do |obj, assoc|
-        obj.reflections[assoc.to_s]&.klass
-      end
-    end
   end
 end

data/lib/active_set/attribute_instruction.rb

@@ -32,11 +32,11 @@ class ActiveSet
       @attribute = attribute
     end
 
-    def operator(default: '==')
+    def operator
       return @operator if defined? @operator
 
       attribute_instruction = @keypath.last
-      @operator = (attribute_instruction[operator_regex, 1] || default).to_sym
+      @operator = attribute_instruction[operator_regex, 1]&.to_sym
     end
 
     def options

data/lib/active_set/enumerable_set_instruction.rb

@@ -9,40 +9,27 @@ class ActiveSet
     end
 
     def attribute_value_for(item)
-      item_value = @attribute_instruction
-                   .value_for(item: item)
-      item_value = item_value.downcase if case_insensitive_operation_for?(item_value)
-      item_value
+      @item_values ||= Hash.new do |h, key|
+        item_value = @attribute_instruction.value_for(item: key)
+        item_value = item_value.downcase if case_insensitive_operation_for?(item_value)
+        h[key] = item_value
+      end
+
+      @item_values[item]
     end
 
-    # rubocop:disable Lint/UnderscorePrefixedVariableName
-    def attribute_value
-      _attribute_value = @attribute_instruction.value
-      _attribute_value = _attribute_value.downcase if case_insensitive_operation_for?(_attribute_value)
-      _attribute_value
+    def instruction_value
+      return @instruction_value if defined? @instruction_value
+
+      instruction_value = @attribute_instruction.value
+      instruction_value = instruction_value.downcase if case_insensitive_operation_for?(instruction_value)
+      @instruction_value = instruction_value
     end
-    # rubocop:enable Lint/UnderscorePrefixedVariableName
 
     def case_insensitive_operation_for?(value)
       return false unless @attribute_instruction.case_insensitive?
 
       value.is_a?(String) || value.is_a?(Symbol)
     end
-
-    def attribute_instance
-      set_item = @set.find(&:present?)
-      return set_item if @attribute_instruction.associations_array.empty?
-      return @attribute_model if defined? @attribute_model
-
-      @attribute_model = @attribute_instruction
-                         .associations_array
-                         .reduce(set_item) do |obj, assoc|
-        obj.public_send(assoc)
-      end
-    end
-
-    def attribute_class
-      attribute_instance&.class
-    end
   end
 end