snfoil-searcher 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16c6b00c6b911a77a4b26bd64ba85f6ec810042e3321d1ced01a991d03010887
-  data.tar.gz: 8fc41b100f24e584842844cdb67faba8e3aa942350bb2606df81998b33fc6221
+  metadata.gz: 35e99bfb3087eff8d0fed094ec44d25762c1f1e1c1cab4db7a356113598ffb52
+  data.tar.gz: ad2494552709ce5058e391cfab5236a21969681a2fecfa15e8e798eadcff25b7
 SHA512:
-  metadata.gz: 5f6f485324db8996278ee672295231b81bee8f133ca11841a453f6cff4afff05733dab724cf25a614eb64ac4e10202d181c2e2387e09875f56c3f33504754c29
-  data.tar.gz: a1ffe7a23cbedb024982ea436db3a1aba3f422f7ccf67909eec7568f99a5901ed967f7b11f84722d2efdb5492d69ff426a0f5041a76cbe9f07e8b70c5fc9a8e7
+  metadata.gz: ba4379088352cf5061ab96bc19f05526c179946a3864eb163b7cb041418e7dd659a4089a314b41c7e28f256ebb910552ee961f48a89ea6721395b8b7d3688df7
+  data.tar.gz: b11cad54c284612a0579f5fa9618a687434fef305d7692d8cad1fe51cb4e1cfa451025b21ab5e3452562f653cc47d1b59c61a563ede8df1d9b9cbe6ab53cb1b1

data/.fasterer.yml

@@ -0,0 +1,22 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
+exclude_paths:
+  - 'vendor/**/*.rb'

data/.github/workflows/main.yml

@@ -1,5 +1,5 @@
 name: build
-on: 
+on:
   push:
     branches: [ main ]
   pull_request:
@@ -11,7 +11,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 2.6, 2.5]
+        ruby-version: [2.7, 2.6, 2.5, '3.0']
 
     steps:
       - uses: actions/checkout@v2
@@ -43,4 +43,8 @@ jobs:
         run: bundle install
       - name: Run rubocop
         run: bundle exec rubocop
+      - name: Run fasterer
+        run: bundle exec fasterer
+      - name: Run bundle audit
+        run: bundle exec bundle audit check --update
 

data/README.md

@@ -16,7 +16,7 @@ gem 'snfoil-searcher'
 
 ### Quickstart
 
-Here is a quick example of how you would use the a SnFoil Searcher with active record.
+Here is a quick example of how you would use a SnFoil Searcher with Active Record.
 
 ```ruby 
 # lib/searchers/people_searcher
@@ -53,7 +53,7 @@ end
 ```
 
 #### Scoping
-You can provide an inital scope to the searcher by passing it to `new`.  If you don't pass in an initial scope, the searcher will try to use the model.
+You can provide an initial scope to the searcher by passing it to `new`.  If you don't pass in an initial scope, the searcher will try to use the model.
 
 ```ruby
 PeopleSearcher.new(People.where(team_id: 2))
@@ -61,7 +61,7 @@ PeopleSearcher.new(People.where(team_id: 2))
 
 #### Model
 
-Model is a optional paramater you can set on the searcher class.  If model is defined - and there is no default scope provided when initilizing the searcher - it will default to using `model.all`
+Model is an optional parameter you can set on the searcher class.  If a model is defined - and there is no default scope provided when initializing the searcher - it will default to using `model.all`
 
 ```ruby 
 class PeopleSearcher
@@ -73,7 +73,7 @@ end
 
 #### Filter
 
-A filter is a step in the search process that takes the current scope and parameters and returns an altered scope.  We recommend keeping each filter as simple as possible - it should only have one responibility.  This way you can easily see every step the searcher takes to get to its outcome as well as clearly defining behaviors that should be tested.
+A filter is a step in the search process that takes the current scope and parameters and returns an altered scope.  We recommend keeping each filter as simple as possible - it should only have one responsibility.  This way you can easily see every step the searcher takes to get to its outcome as well as defining behaviors that should be tested.
 
 You can create as many filters as you would like, but it is important to remember that a filter should **always** return a scope.
 
@@ -109,7 +109,7 @@ end
 ```
 
 #### Setup
-Setup is just a filter that runs first - before any other filters.  It does not allow for conditionals.  We recommend using this block to setup any requirements, tenant scoping, or stuff that really just need to happen first. 
+Setup is just a filter that runs first - before any other filters.  It does not allow for conditionals.  We recommend using this block to setup any requirements, tenant scoping, or stuff that just needs to happen first. 
 
 ```ruby 
 class PeopleSearcher
@@ -127,7 +127,7 @@ end
 
 #### Casting Booleans
 
-To help with cating boolean params - especially those coming from http params - we've added explicit boolean casting for params.  There are parsed and cast in place before any filter.  Just pass in an array of the params you would like to have cast.
+To help with casting boolean params - especially those coming from http params - we've added explicit boolean casting for params.  There are parsed and cast in place before any filter.  Just pass in an array of the params you would like to have cast.
 
 ```ruby
 
@@ -195,4 +195,4 @@ The gem is available as open source under the terms of the [Apache 2 License](ht
 
 ## Code of Conduct
 
-Everyone interacting in the Snfoil::Policy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/limited-effort/snfoil-searcher/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Snfoil::Policy project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/limited-effort/snfoil-searcher/blob/main/CODE_OF_CONDUCT.md).

data/lib/snfoil/searcher/boolean.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Original code taken from https://github.com/rails/rails/blob/6-1-stable/activemodel/lib/active_model/type/boolean.rb
+
+# Copyright (c) 2005-2021 David Heinemeier Hansson
+
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'set'
+
+module SnFoil
+  module Searcher
+    # A class that behaves like a boolean type, including rules for coercion of user input.
+    #
+    # === Coercion
+    # - "false", "f" , "0", +0+ or any other value in +FALSE_VALUES+ will be coerced to +false+
+    # - Empty strings are coerced to +nil+
+    # - All other values will be coerced to +true+
+    class Boolean
+      # rubocop:disable Lint/BooleanSymbol
+      FALSE_VALUES = [
+        false, 0,
+        '0', :'0',
+        'f', :f,
+        'F', :F,
+        'false', :false,
+        'FALSE', :FALSE,
+        'off', :off,
+        'OFF', :OFF,
+        '', nil
+      ].to_set.freeze
+      # rubocop:enable Lint/BooleanSymbol
+
+      def cast(value)
+        !FALSE_VALUES.include?(value)
+      end
+    end
+  end
+end

data/lib/snfoil/searcher/version.rb

@@ -2,6 +2,6 @@
 
 module SnFoil
   module Searcher
-    VERSION = '0.0.2'
+    VERSION = '0.0.4'
   end
 end

data/lib/snfoil/searcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2021 Matthew Howes
+# Copyright 2021 Matthew Howes, Cliff Campbell
 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 # limitations under the License.
 
 require 'active_support/concern'
+require_relative 'searcher/boolean'
 
 module SnFoil
   #
@@ -30,39 +31,42 @@ module SnFoil
     extend ActiveSupport::Concern
 
     class_methods do
-      attr_reader :i_model, :i_setup, :i_filters, :i_search_step, :i_booleans
+      attr_reader :snfoil_model, :snfoil_setup, :snfoil_filters, :snfoil_booleans
 
       def model(klass = nil)
-        raise SnFoil::Searcher::Error, "model already defined for #{self.class.name}" if @i_model
+        raise SnFoil::Searcher::Error, "model already defined for #{self.class.name}" if @snfoil_model
 
-        @i_model = klass
+        @snfoil_model = klass
       end
 
       def setup(setup_method = nil, &setup_block)
-        raise SnFoil::Searcher::Error, "setup already defined for #{self.class.name}" if @i_setup
+        raise SnFoil::Searcher::Error, "setup already defined for #{self.class.name}" if @snfoil_setup
 
-        @i_setup = setup_method || setup_block
+        @snfoil_setup = setup_method || setup_block
       end
 
       def filter(method = nil, **options, &block)
         raise SnFoil::Searcher::ArgumentError, 'filter requires either a method name or a block' if method.nil? && block.nil?
 
-        (@i_filters ||= []) << {
-          method: method,
-          block: block,
-          if: options[:if],
-          unless: options[:unless]
-        }
+        (@snfoil_filters ||= []) << { method: method, block: block, if: options[:if], unless: options[:unless] }
       end
 
       def booleans(*fields)
-        @i_booleans ||= []
-        @i_booleans |= fields.map(&:to_sym)
+        @snfoil_booleans ||= []
+        @snfoil_booleans |= fields.map(&:to_sym)
+      end
+
+      def inherited(subclass)
+        super
+
+        instance_variables.grep(/@snfoil_.+/).each do |i|
+          subclass.instance_variable_set(i, instance_variable_get(i).dup)
+        end
       end
     end
 
     def model
-      self.class.i_model
+      self.class.snfoil_model
     end
 
     attr_reader :scope
@@ -83,15 +87,15 @@ module SnFoil
     def filter; end
 
     def setup
-      self.class.i_setup
+      self.class.snfoil_setup
     end
 
     def filters
-      self.class.i_filters || []
+      self.class.snfoil_filters || []
     end
 
     def booleans
-      self.class.i_booleans || []
+      self.class.snfoil_booleans || []
     end
 
     private
@@ -130,20 +134,12 @@ module SnFoil
     def transform_params_booleans(params)
       params.map do |key, value|
         value = if booleans.include?(key.to_sym)
-                  value_to_boolean(value)
+                  SnFoil::Searcher::Boolean.new.cast(value)
                 else
                   value
                 end
         [key, value]
       end.to_h
     end
-
-    def value_to_boolean(value)
-      value = false if value == '' || value.nil?
-
-      falses = [false, 0, '0', :'0', 'f', :f, 'F', :F, 'false', :false, 'FALSE', :FALSE, 'off', :off, 'OFF', :OFF].to_set.freeze # rubocop:disable Lint/BooleanSymbol
-
-      !falses.include?(value)
-    end
   end
 end

data/snfoil-searcher.gemspec

@@ -5,8 +5,8 @@ require_relative 'lib/snfoil/searcher/version'
 Gem::Specification.new do |spec|
   spec.name          = 'snfoil-searcher'
   spec.version       = SnFoil::Searcher::VERSION
-  spec.authors       = ['Matthew Howes']
-  spec.email         = ['howeszy@gmail.com']
+  spec.authors       = ['Matthew Howes', 'Cliff Campbell']
+  spec.email         = ['howeszy@gmail.com', 'cliffcampbell@hey.com']
 
   spec.summary       = 'A Simple Searcher Framework'
   spec.description   = 'Complex searching functionality as small easily testable sections.'
@@ -30,7 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport', '>= 5.2.6'
 
+  spec.add_development_dependency 'bundle-audit', '~> 0.1.0'
   spec.add_development_dependency 'dry-struct', '~> 1.0'
+  spec.add_development_dependency 'fasterer', '~> 0.9.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.9'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.10'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-searcher
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Matthew Howes
+- Cliff Campbell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.2.6
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -125,10 +154,12 @@ dependencies:
 description: Complex searching functionality as small easily testable sections.
 email:
 - howeszy@gmail.com
+- cliffcampbell@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".fasterer.yml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -142,6 +173,7 @@ files:
 - bin/console
 - bin/setup
 - lib/snfoil/searcher.rb
+- lib/snfoil/searcher/boolean.rb
 - lib/snfoil/searcher/version.rb
 - snfoil-searcher.gemspec
 homepage: https://github.com/limited-effort/snfoil-searcher