actionset 0.8.1 → 0.11.0

data/README.md

@@ -108,6 +108,32 @@ For pagination, like filtering, we don't enforce any view-layer specifics. You s
 </nav>
 ```
 
+## Configuration
+
+### ActiveSet.configuration.on_asc_sort_nils_come
+
+Example usage in an initializer:
+
+```
+  ActiveSet.configure do |c|
+    c.on_asc_sort_nils_come = :first
+  end
+```
+
+When `ActiveSet.configuration.on_asc_sort_nils_come == :last` (this is the default), null values will be sorted as if larger than any non-null value.
+
+```
+ASC => [-2, -1, 1, 2, nil]
+DESC => [nil, 2, 1, -1, -2]
+```
+
+Otherwise sort nulls as if smaller than any non-null value.
+
+```
+ASC => [nil, -2, -1, 1, 2]
+DESC => [2, 1, -1, -2, nil]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -5,4 +5,11 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task :full_spec do
+  ENV['COVERAGE'] = 'true'
+  ENV['INSPECT_FAILURE'] = 'true'
+  ENV['LOGICALLY_EXHAUSTIVE_REQUEST_SPECS'] = '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.1'
+  spec.version       = '0.11.0'
   spec.authors       = ['Stephen Margheim']
   spec.email         = ['stephen.margheim@gmail.com']
 
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'faker'
-  spec.add_development_dependency 'rails', '~> 5.1.0'
+  spec.add_development_dependency 'rails', '~> 5.2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'ransack'
   spec.add_development_dependency 'rspec'

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_params) if sort_params.any?
+      active_set = active_set.sort(SortInstructions.new(sort_params, set, self).get) if sort_params.any?
       active_set
     end
 
@@ -52,30 +53,11 @@ module ActionSet
 
     private
 
-    def filter_instructions_for(set)
-      filter_params.flatten_keys.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 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)
-    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 +75,13 @@ 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_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/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/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/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.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/hash/reverse_merge'
-require 'patches/core_ext/hash/flatten_keys'
-require 'helpers/throws'
+require 'helpers/flatten_keys_of'
 require 'active_set/attribute_instruction'
 require 'active_set/filtering/operation'
 require 'active_set/sorting/operation'
@@ -12,6 +11,30 @@ require 'active_set/exporting/operation'
 class ActiveSet
   include Enumerable
 
+  class Configuration
+    attr_accessor :on_asc_sort_nils_come
+
+    def initialize
+      @on_asc_sort_nils_come = :last
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
   attr_reader :set, :view, :instructions
 
   def initialize(set, view: nil, instructions: {})