talent_scout 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d013c77ffd08bf7bb7d36d4f30c10bc763a4ea79c437d80604985de86fadd74
-  data.tar.gz: a4a996e5b44c64af45806849f3744f06bf7f192d346416943739f172abf45180
+  metadata.gz: e8762e9b2380fffc1760108d9519e9d6e936aa5a0372c0b4a15e426fdf002dde
+  data.tar.gz: fa0c26db874aea1c7a1fddcb0b8270bca03ba604d240c42e961ab3d7d2d21f49
 SHA512:
-  metadata.gz: 24e7c840762d376d5dd9353e3f9b4f167424914e1320573fbcc5cf6dcb691ab5a78f4465261fd2ca029784dd5fac25192c8def19b1f2280401dd3a1452baed7a
-  data.tar.gz: b6be4607619b5dcae29c012fb5194b640e5a5bf5ad9de94f1cd80532cf9cfdb12d8d61f615297da0531b8fe2fa9504a589d7f3816da2192f3e6b7f603231cb58
+  metadata.gz: 2b0d2cd202e33572ca6a24c4235f4e7a36f0975361ba09ed870e03a758c89cfafe07ba544d5e3737a1432535d466993b50383df57fa8ee5f8d7039f77b2acad7
+  data.tar.gz: 19e4fe92e92aa8c0b69151034adf430739bee6e538e8878bcb7606d7fb9738b3f1a2f259ce264b64388bf972853c877703c95d72536a9dfc4d6e38c54db18fbf

data/README.md

@@ -1,4 +1,4 @@
-# talent_scout
+# talent_scout [![Build Status](https://travis-ci.org/jonathanhefner/talent_scout.svg?branch=master)](https://travis-ci.org/jonathanhefner/talent_scout)
 
 Model-backed searches in Rails.  A whiz-bang example:
 
@@ -42,10 +42,16 @@ end
 ```html+erb
 <!-- app/views/posts/index.html.erb -->
 
-<%= form_with model: @search, method: :get do |form| %>
+<%= form_with model: @search, local: true, method: :get do |form| %>
+  <%= form.label :title_includes %>
   <%= form.text_field :title_includes %>
+
+  <%= form.label :within %>
   <%= form.select :within, @search.each_choice(:within), include_blank: true %>
+
+  <%= form.label :only_published %>
   <%= form.check_box :only_published %>
+
   <%= form.submit %>
 <% end %>
 
@@ -519,15 +525,21 @@ Search forms can be rendered using Rails' form builder and a search
 object:
 
 ```html+erb
-<%= form_with model: @search, method: :get do |form| %>
+<%= form_with model: @search, local: true, method: :get do |form| %>
+  <%= form.label :title_includes %>
   <%= form.text_field :title_includes %>
+
+  <%= form.label :created_on %>
   <%= form.date_field :created_on %>
+
+  <%= form.label :only_published %>
   <%= form.check_box :only_published %>
+
   <%= form.submit %>
 <% end %>
 ```
 
-Notice the `method: :get` argument to `form_with`; this is **required**.
+Notice the `method: :get` argument to `form_with`; **this is required**.
 
 Form fields will be populated with the criteria input (or default)
 values of the same name from `@search`.  Type-appropriate form fields
@@ -646,7 +658,7 @@ end
 ```
 
 ```html+erb
-<%= form_with model: @search, method: :get do |form| %>
+<%= form_with model: @search, local: true, method: :get do |form| %>
   <%= form.select :category, @search.each_choice(:category) %>
   <%= form.submit %>
 <% end %>
@@ -668,7 +680,7 @@ end
 ```
 
 ```html+erb
-<%= form_with model: @search, method: :get do |form| %>
+<%= form_with model: @search, local: true, method: :get do |form| %>
   <%= form.select :order, @search.each_choice(:order) %>
   <%= form.submit %>
 <% end %>
@@ -707,7 +719,6 @@ end
 
 Remember that only one order can be applied at a time, so only one value
 in the Hash, at most, will be non-`nil`.
->>>>>>> b0d201c... Update README
 
 
 ## Installation

data/lib/talent_scout/controller.rb

@@ -4,7 +4,7 @@ module TalentScout
 
     module ClassMethods
       # Returns the controller model search class.  Defaults to a class
-      # corresponding to the singular-form of the controller name.  The
+      # corresponding to the singular form of the controller name.  The
       # model search class can also be set with {model_search_class=}.
       # If the model search class has not been set, and the default
       # class does not exist, a +NameError+ will be raised.
@@ -32,8 +32,8 @@ module TalentScout
       end
 
       # Similar to {model_search_class}, but returns nil instead of
-      # raising an error when the value has not been set (via
-      # {model_search_class=}) and the default class does not exist.
+      # raising an error when the value has not been set and the default
+      # class does not exist.
       #
       # @return [Class<TalentScout::ModelSearch>, nil]
       def model_search_class?

data/lib/talent_scout/model_search.rb

@@ -47,11 +47,11 @@ module TalentScout
       @model_name ||= ModelName.new(self)
     end
 
-    # Sets the default scope of the search.  Like ActiveRecord's
+    # Sets the default scope of the search.  Like Active Record's
     # +default_scope+, the scope here is specified as a block which is
     # evaluated in the context of the {model_class}.  Also like
-    # ActiveRecord, multiple calls to this method will be merged
-    # together.
+    # Active Record, multiple calls of this method will append to the
+    # default scope.
     #
     # @example
     #   class PostSearch < TalentScout::ModelSearch
@@ -88,26 +88,26 @@ module TalentScout
     # Model (e.g. +:string+, +:boolean+, +:integer+, etc), with the
     # addition of a +:void+ type.  A +:void+ type is just like a
     # +:boolean+ type, except that the criteria is not evaluated when
-    # the type-casted value is falsey.
+    # the typecasted value is falsey.
     #
-    # Alternatively, instead of a type, an array or hash of +choices+
+    # Alternatively, instead of a type, an Array or Hash of +choices+
     # can be specified, and the criteria will be evaluated only if the
     # passed-in value matches one of the choices.
     #
-    # Active Model +attribute_options+ can also be specified, most
-    # notably +:default+ to provide the criteria a default value to
-    # operate on.
+    # Active Model +attribute_options+ can also be specified.  Most
+    # notably, the +:default+ option provides the criteria a default
+    # value to operate on.
     #
-    # Each criteria can specify a block which recieves the corresponding
-    # type-casted value as an argument.  If the corresponding value is
-    # not set on the search object (and no default value is defined),
+    # Each criteria can specify a block which recieves its corresponding
+    # typecasted value as an argument.  If the corresponding value is
+    # not set on the search object, and no default value is defined,
     # the criteria will not be evaluated.  Like an Active Record
     # +scope+ block, a criteria block is evaluated in the context of an
-    # +ActiveRecord::Relation+ and should return an
+    # +ActiveRecord::Relation+, and should return an
     # +ActiveRecord::Relation+.  A criteria block may also return nil,
     # in which case the criteria will be skipped.  If no criteria block
     # is specified, the criteria will be evaluated as a +where+ clause
-    # using the criteria name and type-casted value.
+    # using the criteria name and typecasted value.
     #
     # As a convenient shorthand, Active Record scopes which have been
     # defined on the {model_class} can be used directly as criteria
@@ -171,7 +171,7 @@ module TalentScout
     #   PostSearch.new(only_edited: "1").results    # == Post.where("modified_at > created_at")
     #
     #
-    # @example Specifying choices (array)
+    # @example Specifying choices (Array)
     #   class PostSearch < TalentScout::ModelSearch
     #     criteria :category, choices: %w[science tech engineering math]
     #   end
@@ -180,7 +180,7 @@ module TalentScout
     #   PostSearch.new(category: "BLAH").results  # == Post.all
     #
     #
-    # @example Specifying choices (hash)
+    # @example Specifying choices (Hash)
     #   class PostSearch < TalentScout::ModelSearch
     #     criteria :within, choices: {
     #       "Last 24 hours" => 24.hours,
@@ -209,15 +209,38 @@ module TalentScout
     #   PostSearch.new(within_days: 2).results  # == Post.where("created_at >= ?", 2.days.ago)
     #
     #
-    # @param names [String, Symbol, Array<String>, Array<Symbol>]
-    # @param type [Symbol, ActiveModel::Type]
-    # @param choices [Array<String>, Array<Symbol>, Hash<String, Object>, Hash<Symbol, Object>]
-    # @param attribute_options [Hash]
-    # @option attribute_options :default [Object]
-    # @yieldreturn [ActiveRecord::Relation, nil]
+    # @overload criteria(names, type = :string, **attribute_options, &block)
+    #   @param names [String, Symbol, Array<String>, Array<Symbol>]
+    #   @param type [Symbol, ActiveModel::Type]
+    #   @param attribute_options [Hash]
+    #   @option attribute_options :default [Object]
+    #   @yieldparam value [Object]
+    #   @yieldreturn [ActiveRecord::Relation, nil]
+    #
+    # @overload criteria(names, type = :string, **attribute_options)
+    #   @param names [String, Symbol, Array<String>, Array<Symbol>]
+    #   @param type [Symbol, ActiveModel::Type]
+    #   @param attribute_options [Hash]
+    #   @option attribute_options :default [Object]
+    #
+    # @overload criteria(names, choices:, **attribute_options, &block)
+    #   @param names [String, Symbol, Array<String>, Array<Symbol>]
+    #   @param choices [Array<String>, Array<Symbol>, Hash<String, Object>, Hash<Symbol, Object>]
+    #   @param attribute_options [Hash]
+    #   @option attribute_options :default [Object]
+    #   @yieldparam value [Object]
+    #   @yieldreturn [ActiveRecord::Relation, nil]
+    #
+    # @overload criteria(names, choices:, **attribute_options)
+    #   @param names [String, Symbol, Array<String>, Array<Symbol>]
+    #   @param choices [Array<String>, Array<Symbol>, Hash<String, Object>, Hash<Symbol, Object>]
+    #   @param attribute_options [Hash]
+    #   @option attribute_options :default [Object]
+    #   @yieldreturn [ActiveRecord::Relation, nil]
+    #
     # @return [void]
     # @raise [ArgumentError]
-    #   if +choices+ are specified and +type+ is other than +:string+
+    #   if +choices+ is specified and +type+ is not +:string+
     def self.criteria(names, type = :string, choices: nil, **attribute_options, &block)
       if choices
         if type != :string
@@ -269,7 +292,7 @@ module TalentScout
     # +:default+ option in the order definition.  (Note that only one
     # order can be designated as the default order.)
     #
-    # See also {toggle_order}.
+    # @see toggle_order
     #
     #
     # @example Single-column order
@@ -346,25 +369,30 @@ module TalentScout
       order_type.add_definition(definition)
     end
 
-    # Initializes a +ModelSearch+ instance.  Assigns values in +params+
-    # to appropriate criteria attributes.
+    # Initializes a +ModelSearch+ instance.  Assigns values from
+    # +params+ to corresponding criteria attributes.
     #
     # If +params+ is a +ActionController::Parameters+, blank values are
     # ignored.  This behavior prevents empty search form fields from
     # affecting search results.
     #
     # @param params [Hash<String, Object>, Hash<Symbol, Object>, ActionController::Parameters]
+    # @raise [ActiveModel::UnknownAttributeError]
+    #   if +params+ is a Hash, and it contains an unrecognized key
     def initialize(params = {})
+      # HACK initialize ActiveRecord state required by ActiveRecord::AttributeMethods::BeforeTypeCast
+      @transaction_state ||= nil
+
       if params.is_a?(ActionController::Parameters)
         params = params.permit(self.class.attribute_types.keys).reject!{|key, value| value.blank? }
       end
       super(params)
     end
 
-    # Applies search {criteria} with set or default attribute values,
-    # and the set or default {order} on top of the {default_scope}.
-    # Returns an +ActiveRecord::Relation+, allowing further scopes, such
-    # as pagination, to be applied post-hoc.
+    # Applies the {default_scope}, search {criteria} with set or default
+    # attribute values, and the set or default {order} to the
+    # {model_class}.  Returns an +ActiveRecord::Relation+, allowing
+    # further scopes, such as pagination, to be applied post-hoc.
     #
     # @example
     #   class PostSearch < TalentScout::ModelSearch
@@ -383,14 +411,15 @@ module TalentScout
     #
     # @return [ActiveRecord::Relation]
     def results
-      self.class.criteria_list.reduce(self.class.model_class) do |scope, crit|
+      self.class.criteria_list.reduce(self.class.model_class.all) do |scope, crit|
         crit.apply(scope, attribute_set)
       end
     end
 
     # Builds a new model search object with +criteria_values+ merged on
-    # top of the subject search object's criteria values.  Does not
-    # modify the subject search object.
+    # top of the subject search object's criteria values.
+    #
+    # Does not modify the subject search object.
     #
     # @example
     #   class PostSearch < TalentScout::ModelSearch
@@ -414,8 +443,9 @@ module TalentScout
 
     # Builds a new model search object with the subject search object's
     # criteria values, excluding values specified by +criteria_names+.
-    # Default criteria values will still be applied.  Does not modify
-    # the subject search object.
+    # Default criteria values will still be applied.
+    #
+    # Does not modify the subject search object.
     #
     # @example
     #   class PostSearch < TalentScout::ModelSearch
@@ -479,10 +509,10 @@ module TalentScout
 
     # Iterates over a specified {criteria}'s defined choices.  If the
     # given block accepts a 2nd argument, a boolean will be passed
-    # indicating whether that choice is currently used by the subject
-    # search object.  If no block is given, an +Enumerator+ will be
-    # returned.
+    # indicating whether that choice is currently assigned to the
+    # specified criteria.
     #
+    # An Enumerator is returned if no block is given.
     #
     # @example With block
     #   class PostSearch < TalentScout::ModelSearch
@@ -549,7 +579,7 @@ module TalentScout
     # {order}.  Each key's associated value indicates that order's
     # currently applied direction -- +:asc+, +:desc+, or +nil+ if the
     # order is not applied.  Note that only one order can be applied at
-    # a time, so only one value in the Hash, at most, will be non-+nil+.
+    # a time, so, at most, one value in the Hash will be non-+nil+.
     #
     # @example
     #   class PostSearch < TalentScout::ModelSearch

data/lib/talent_scout/version.rb

@@ -1,3 +1,3 @@
 module TalentScout
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: talent_scout
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jonathan Hefner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-17 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -58,6 +58,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +102,7 @@ dependencies:
         version: '4.0'
 description: 
 email:
-- jonathan.hefner@gmail.com
+- jonathan@hefner.pro
 executables: []
 extensions: []
 extra_rdoc_files: []