ii_finder 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 452fde95e0ced0ad63b8ccf586d493c1514895d074fbb7ae7c4c8e105ae66fb4
-  data.tar.gz: b07f0b0c3354b93a6b189187ba423605169709b8a4fb56fe57cb8efc92d9c6f0
+  metadata.gz: 0af875699d606b3d6b00fc1dba12000c1eea5767d029b5bd125b10f7ef3cdabd
+  data.tar.gz: e865e05b213f6e69522d3d9df5b96b2d2bffed9cfe62dd15e9e3ad0e964677bb
 SHA512:
-  metadata.gz: c973652162caad6088d84acee6605344679976504869a35c4687b8332e825ec5778cf8b605ae0882573f1998be02ffabdb29d40c9f91b41976b27dadaebaceab
-  data.tar.gz: d56881a31d2aaa55052094cb1f0e26832339a9ee2478d2a9a18580ef2aef66a6068259230179ca72129e683fb5c97925d28ab8285496614221eefb898b007f35
+  metadata.gz: 89f8b24b33d997bf4f530673cf7066390864fbf3d4dbe56bd871edef522664febf803f4c06cd906a6792837dbb08336973c9f8538b2ca9c626f591d9939dee0c
+  data.tar.gz: 8d65c22603983ed0cbd3c7dccdcc349f8f8466be5bf76be8241e45c7181db63c6d36bed2eb5431323da5ad74a4935e12b6cceaad79f615e0660a4aab4f955d38

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # CHANGELOG
 
+## 2.0.1
+
+* Return relation after callbacks called.
+
+## 2.0.0
+
+* Replace chain feature with coactive.
+
+## 1.2.0
+
+* Add chain feature.
+
+## 1.1.2
+
+* Try fetch prior to calling instance method.
+
 ## 1.1.1
 
 * Check arel_table existence for model.

data/README.md

@@ -24,14 +24,14 @@ Then execute:
 Prepare model:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 ```
 
 Prepare finder:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -43,15 +43,15 @@ end
 Use finder as follows:
 
 ```ruby
-UsersFinder.call(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+ItemsFinder.call(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 You can also specify relation as first argument:
 
 ```ruby
-UsersFinder.call(User.where(id: [1, 2, 3]), name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."id" IN (1, 2, 3) AND "users"."name" = 'NAME'
+ItemsFinder.call(Item.where(id: [1, 2, 3]), name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."id" IN (1, 2, 3) AND "items"."name" = 'NAME'
 ```
 
 ### Finder
@@ -61,7 +61,7 @@ Finder method will not be called when the value of parameter is blank.
 If you want to receive such value, set `allow_blank` as follows:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name, allow_blank: true
 
   def name(value)
@@ -69,14 +69,14 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: '').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = ''
+ItemsFinder.call(name: '').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = ''
 ```
 
 Finder has following attributes:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -87,10 +87,10 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: 'NAME')
-#=> relation: #<User::ActiveRecord_Relation:
+ItemsFinder.call(name: 'NAME')
+#=> relation: #<Item::ActiveRecord_Relation:
 #   criteria: {:name=>'NAME'}
-#   model: User
+#   model: Item
 #   table: #<Arel::Table ...>
 ```
 
@@ -102,7 +102,7 @@ IIFinder.configure do |config|
   config.merge_relation = false
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   parameters :name
 
   def name(value)
@@ -110,8 +110,8 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+ItemsFinder.call(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 #### Callbacks
@@ -125,7 +125,7 @@ Following callbacks are available.
 For example:
 
 ```ruby
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
   after_call :default_order
 
   def default_order
@@ -133,14 +133,45 @@ class UsersFinder < IIFinder::Base
   end
 end
 
-UsersFinder.call.to_sql
-#=> SELECT "users".* FROM "users" ORDER BY "users"."id" DESC
+ItemsFinder.call.to_sql
+#=> SELECT "items".* FROM "items" ORDER BY "items"."id" DESC
 ```
 
 Note that finder does not handle the return value of callback.
 When you want to update `@relation` in the callback,
 reassign `@relation` or use methods like `where!` or `order!`.
 
+#### Coactors
+
+You can chain multiple finders by using `coact`. For example:
+
+```ruby
+class NameFinder < IIFinder::Base
+  parameters :name
+
+  def name(value)
+    @relation.where(name: value)
+  end
+end
+
+class AgeFinder < IIFinder::Base
+  parameters :age
+
+  def age(value)
+    @relation.where(age: value)
+  end
+end
+
+class ItemsFinder < IIFinder::Base
+  coact NameFinder, AgeFinder
+end
+
+ItemsFinder.call(Item.all, name: 'name', age: 10).to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'name' AND "items"."age" = 10
+```
+
+See [coactive](https://github.com/kanety/coactive) for more `coact` examples:
+
 ### Lookup for model
 
 Finder lookups related model by its class name when the first argument of `call` is not relation.
@@ -148,30 +179,30 @@ So the name of finder class should be composed of the name of model class.
 For example:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
 end
 
-IIFinder::Base.lookup(UsersFinder)
-#=> User
+IIFinder::Base.lookup(ItemsFinder)
+#=> Item
 ```
 
 Note that superclass of finder is also looked up until related model is found.
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
 end
 
-class UsersFinder < IIFinder::Base
+class ItemsFinder < IIFinder::Base
 end
 
-class InheritedUsersFinder < UsersFinder
+class InheritedItemsFinder < ItemsFinder
 end
 
-IIFinder::Base.lookup(InheritedUsersFinder)
-#=> User
+IIFinder::Base.lookup(InheritedItemsFinder)
+#=> Item
 ```
 
 ### Scope for model
@@ -179,12 +210,12 @@ IIFinder::Base.lookup(InheritedUsersFinder)
 In case you want to call finder from model, include `IIFinder::Scope` into model as follows:
 
 ```ruby
-class User < ActiveRecord::Base
+class Item < ActiveRecord::Base
   include IIFinder::Scope
 end
 
-User.finder_scope(name: 'NAME').to_sql
-#=> SELECT "users".* FROM "users" WHERE "users"."name" = 'NAME'
+Item.finder_scope(name: 'NAME').to_sql
+#=> SELECT "items".* FROM "items" WHERE "items"."name" = 'NAME'
 ```
 
 ### Logging
@@ -199,7 +230,7 @@ IIFinder::LogSubscriber.attach_to :ii_finder
 This subscriber will write logs in debug mode as the following example:
 
 ```
-Called UsersFinder with {:id=>1} (Duration: 9.9ms, Allocations: 915)
+Called ItemsFinder with {:id=>1} (Duration: 9.9ms, Allocations: 915)
 ```
 
 ## Contributing

data/ii_finder.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "coactive", ">= 0.1"
 
   spec.add_development_dependency "rails", ">= 5.0"
   spec.add_development_dependency "sqlite3"

data/lib/ii_finder/base.rb

@@ -5,6 +5,7 @@ require_relative 'parameters'
 require_relative 'callbacks'
 require_relative 'instrumentation'
 require_relative 'lookup'
+require_relative 'coactors'
 
 module IIFinder
   class Base
@@ -13,5 +14,6 @@ module IIFinder
     include Callbacks
     include Instrumentation
     include Lookup
+    include Coactors
   end
 end

data/lib/ii_finder/callbacks.rb

@@ -13,6 +13,8 @@ module IIFinder
       run_callbacks :call do
         super
       end
+
+      @relation
     end
 
     class_methods do

data/lib/ii_finder/coactors.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module IIFinder
+  module Coactors
+    extend ActiveSupport::Concern
+
+    included do
+      include Coactive::Base
+
+      configure_coactive do |config|
+        config.load_paths = ['app/finders']
+        config.class_suffix = 'Finder'
+        config.use_cache = true
+        config.lookup_superclass_until = ['ActiveRecord::Base', 'ActiveModel::Base']
+      end
+
+      class << self
+        alias_method :chain, :coact
+      end
+    end
+
+    def call
+      coactors.each do |finder|
+        merge_relation!(finder.call(*@_args))
+      end
+      super
+    end
+  end
+end

data/lib/ii_finder/core.rb

@@ -9,6 +9,7 @@ module IIFinder
     end
 
     def initialize(*args)
+      @_args = args;
       if args.size == 0 || args.size == 1
         @model = self.class.lookup
         raise IIFinder::Error.new("could not find model for #{self.class}") unless @model
@@ -26,7 +27,7 @@ module IIFinder
       self.class._parameters.each do |param|
         value = fetch_criteria(param.name)
         if value.present? || param.allow_blank?
-          call_method(param.name, value)
+          merge_relation!(send(param.name, value))
         end
       end
 
@@ -34,18 +35,16 @@ module IIFinder
     end
 
     def fetch_criteria(name)
-      if @criteria.respond_to?(name)
-        @criteria.send(name)
-      elsif @criteria.respond_to?(:fetch)
+      if @criteria.respond_to?(:fetch)
         @criteria.fetch(name, nil)
+      elsif @criteria.respond_to?(name)
+        @criteria.send(name)
       end
     end
 
-    def call_method(name, value)
-      result = send(name, value)
-
-      if result.respond_to?(:merge) && Config.merge_relation
-        @relation = @relation.merge(result)
+    def merge_relation!(relation)
+      if relation.respond_to?(:merge) && Config.merge_relation
+        @relation = @relation.merge(relation)
       end
     end
 

data/lib/ii_finder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIFinder
-  VERSION = '1.1.1'
+  VERSION = '2.0.1'
 end

data/lib/ii_finder.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'coactive'
 
 require 'ii_finder/version'
 require 'ii_finder/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ii_finder
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-21 00:00:00.000000000 Z
+date: 2021-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coactive
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,7 @@ files:
 - lib/ii_finder.rb
 - lib/ii_finder/base.rb
 - lib/ii_finder/callbacks.rb
+- lib/ii_finder/coactors.rb
 - lib/ii_finder/config.rb
 - lib/ii_finder/core.rb
 - lib/ii_finder/errors.rb
@@ -148,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A base finder to support building relations from parameters