actionset 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73b9e07ebc32c17686183161804a2a77bd2ec042
-  data.tar.gz: 1f6bd75368db46b4a756e9bfa50c9801f9cd0f51
+  metadata.gz: 702c887ea4be4ff151f1534bf9ff440843e018b7
+  data.tar.gz: 198cd7d817b312e55f8a1ac7cf162b8fa5551b27
 SHA512:
-  metadata.gz: 791855b210100bffcfd01295aee91dd6c72c34bfd3e33eb0461252d2efe58b79b9ac32a3387fa7831a6048ffb0c5e4cbc0650601670fb33d4a73af51c65230bf
-  data.tar.gz: c8ce69c65608139e3f9cb36883a5e279baf4fa70795c896ddcbaeac14c326fac0ff213cd56203c24e3e327f32ff5b899f0d7a4528eff971ab786c1c8ae7aa523
+  metadata.gz: 161afab0ca5e7277ce69adffc2ff593fe9f980418991f4b42514750c5eddc40eb09f57a5cc47d89c2a2a7e07125ab1d8619c6ab60c0a9665ebe5a08fe582f865
+  data.tar.gz: d90f23599901d6d9ab7c79633b16abb6efa5dcf03407509697383dfa84b0d6337f2bf130874ad4ce1319939e3d63051b79cdcbdc082efd49a6992e53900dc2d6

data/CHANGELOG

@@ -0,0 +1,6 @@
+v 0.1.0
+  - make ActionSet a Railtie
+  - add a view helper method for building sort links (`sort_link`)
+  - typecast all params values before passing to ActiveSet
+  - reject any blank param values
+  - instantiate a `@filters` ivar for use in building the filters form

data/Gemfile

@@ -6,3 +6,9 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in actionset.gemspec
 gemspec
+
+group :test do
+  gem 'activerecord'
+  gem 'rspec-rails'
+  gem 'sqlite3'
+end

data/actionset.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'actionset'
   spec.version       = ActionSet::VERSION
   spec.authors       = ['Stephen Margheim']
-  spec.email         = ['margheim@mail.med.upenn.edu']
+  spec.email         = ['stephen.margheim@gmail.com']
 
   spec.summary       = 'A toolkit to wire-up ActiveSet collections with a Rails controller.'
   spec.description   = 'Easily filter, sort, and paginate enumerable sets via web requests.'
@@ -22,9 +22,19 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activeset'
+  spec.add_dependency 'activeset', '~> 0.4.0'
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'railties'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.6'
+  spec.add_development_dependency 'database_cleaner', '~> 1.6.1'
+  spec.add_development_dependency 'capybara', '~> 2.15.1'
+  spec.add_development_dependency 'combustion', '~> 0.7.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.8.0'
+  spec.add_development_dependency 'faker', '~> 1.8.4'
+  spec.add_development_dependency 'simplecov', '~> 0.15.0'
+  spec.add_development_dependency 'simplecov-console', '~> 0.4.2'
 end

data/config.ru

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/action_set/instructions/entry_value.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module ActionSet
+  module Instructions
+    class EntryValue
+      attr_reader :raw
+
+      def initialize(value)
+        @raw = value
+      end
+
+      def cast(to:)
+        adapters.map do |adapter|
+          value = adapter.new(@raw, to).process
+          return value unless value.nil?
+        end.compact.first || @raw
+      end
+
+      private
+
+      def adapters
+        [ActiveModelAdapter, PlainRubyAdapter, BooleanAdapter, TimeWithZoneAdapter]
+      end
+
+      class PlainRubyAdapter
+        def initialize(raw, target)
+          @raw = raw
+          @target = target
+        end
+
+        def process
+          return @raw if @raw.is_a? @target
+          possible_values.find { |v| v.is_a? @target }
+        end
+
+        private
+
+        def possible_values
+          possible_typecasters.map { |m| typecast(m) }
+                              .compact
+        end
+
+        def possible_typecasters
+          @possible_typecasters ||= String.instance_methods
+                                          .map(&:to_s)
+                                          .select { |m| m.starts_with? 'to_' }
+                                          .reject { |m| %[to_v8].include? m }
+        end
+
+        def typecast(method_name)
+          @raw.send(method_name)
+        rescue
+          nil
+        end
+      end
+
+      class ActiveModelAdapter
+        require 'active_model/type'
+
+        def initialize(raw, target)
+          @raw = raw
+          @target = target
+        end
+
+        def process
+          return @raw if @raw.is_a? @target
+          possible_values.find { |v| v.is_a? @target }
+        end
+
+        private
+
+        def possible_values
+          possible_typecasters.map { |m| typecast(m, @raw) }
+        end
+
+        def possible_typecasters
+          @possible_typecasters ||= ActiveModel::Type.constants
+                                                     .map(&:to_s)
+                                                     .select { |t| can_typecast?(t) }
+                                                     .map { |t| init_typecaster(t) }
+                                                     .compact
+        end
+
+        def typecast(to_type, value)
+          return to_type.type_cast(value) if to_type.respond_to? :type_cast
+          to_type.cast(value)
+        end
+
+        def can_typecast?(const_name)
+          typecasting_class = ActiveModel::Type.const_get(const_name)
+          typecasting_class.instance_methods.include?(:cast) ||
+            typecasting_class.instance_methods.include?(:type_cast)
+        end
+
+        def init_typecaster(const_name)
+          ActiveModel::Type.const_get(const_name).new
+        rescue
+          nil
+        end
+      end
+
+      class BooleanAdapter
+        def initialize(raw, target)
+          @raw = raw
+          @target = target
+        end
+
+        def process
+          return if @raw.is_a? @target
+          return unless @target.eql?(TrueClass) || @target.eql?(FalseClass)
+          # ActiveModel::Type::Boolean is too expansive in its casting; will get false positives
+          to_bool
+        end
+
+        private
+
+        def to_bool
+          return @raw if @raw.is_a?(TrueClass) || @raw.is_a?(FalseClass)
+          return true if %w[true yes 1 t].include? @raw.to_s.downcase
+          return false if %w[false no 0 f].include? @raw.to_s.downcase
+          nil
+        end
+      end
+
+      class TimeWithZoneAdapter
+        def initialize(raw, target)
+          @raw = raw
+          @target = target
+        end
+
+        def process
+          return if @raw.is_a? @target
+          return unless @target.eql?(ActiveSupport::TimeWithZone)
+          time_value = ActiveModelAdapter.new(@raw, Time).process
+          return unless time_value.is_a?(Time)
+          return time_value unless time_value.respond_to?(:in_time_zone)
+          time_value.in_time_zone
+        end
+      end
+    end
+  end
+end

data/lib/action_set/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActionSet
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/lib/action_set/view_helpers.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module ActionSet
+  module ViewHelpers
+    def sort_link(column, title = nil)
+      column = column.to_s
+      title ||= sort_link_title(column)
+
+      link_to title, sort_link_url(column)
+    end
+
+    private
+
+    def sort_link_url(column)
+      request.query_parameters.merge(controller: controller.controller_path,
+                                     action: controller.action_name,
+                                     sort: {
+                                       column => sort_link_direction(column)
+                                     })
+    end
+
+    def sort_link_title(column)
+      I18n.t(column,
+             scope: :attributes,
+             default: default_sort_link_title(column))
+    end
+
+    def sort_link_direction(column)
+      return 'asc' unless params[:sort].keys.include?(column.to_s)
+
+      sort_direction_inverses = { 'asc' => 'desc', 'desc' => 'asc' }
+      sort_direction_inverses[params.dig(:sort, column)]
+    end
+
+    def default_sort_link_title(column)
+      ActiveSet::Instructions::Entry::KeyPath.new(column).titleized
+    end
+  end
+end

data/lib/action_set.rb

@@ -1,7 +1,66 @@
 # frozen_string_literal: true
 
+require 'rails/railtie'
+require 'active_support/core_ext/object/blank'
+require 'active_set'
+
 require 'action_set/version'
+require_relative './action_set/instructions/entry_value'
+require_relative './action_set/view_helpers'
 
 module ActionSet
-  # Your code goes here...
+  class Railtie < ::Rails::Railtie
+    initializer 'action_set.view_helpers' do
+      ActiveSupport.on_load :action_view do
+        include ViewHelpers
+      end
+    end
+  end
+
+  class Filter < OpenStruct
+    def model_name
+      OpenStruct.new(param_key: 'filter')
+    end
+  end
+
+  module ClassMethods
+  end
+
+  module InstanceMethods
+    def process_set(set)
+      @set = set
+      @filters = JSON.parse(filter_params.to_json,
+                            object_class: Filter)
+      active_set = ActiveSet.new(set)
+      active_set = active_set.filter(filter_structure) if filter_params.any?
+      active_set = active_set.sort(sort_params) if sort_params.any?
+      active_set
+    end
+
+    private
+
+    def filter_params
+      params.fetch(:filter, {}).to_unsafe_hash
+    end
+
+    def filter_structure
+      filter_params.flatten_keys.reject { |_, v| v.blank? }.each_with_object({}) do |(keypath, value), memo|
+        instruction = ActiveSet::Instructions::Entry.new(keypath, value)
+        item_with_value = @set.find { |i| !instruction.value_for(item: i).nil? }
+        item_value = instruction.value_for(item: item_with_value)
+        typecast_value = ActionSet::Instructions::EntryValue.new(value)
+                                                            .cast(to: item_value.class)
+        memo[keypath] = typecast_value
+      end
+    end
+
+    def sort_params
+      params.fetch(:sort, {}).to_unsafe_hash
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
 end

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: actionset
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Stephen Margheim
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activeset
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,9 +94,121 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.15.1
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
 description: Easily filter, sort, and paginate enumerable sets via web requests.
 email:
-- margheim@mail.med.upenn.edu
+- stephen.margheim@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,6 +217,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,8 +225,11 @@ files:
 - actionset.gemspec
 - bin/console
 - bin/setup
+- config.ru
 - lib/action_set.rb
+- lib/action_set/instructions/entry_value.rb
 - lib/action_set/version.rb
+- lib/action_set/view_helpers.rb
 homepage: https://github.com/fractaledmind/actionset
 licenses:
 - MIT