Resolving comments in PR

- Deprecate locate without options
- Calling includes when options[:includes] is passed
- Adjusting test for the deprecation
- Documenting the new locate method structure with options

Author: rafacoello

README.md

@@ -191,7 +191,7 @@ A custom locator can either be a block or a class.
 Using a block:
 
 ```ruby
-GlobalID::Locator.use :foo do |gid|
+GlobalID::Locator.use :foo do |gid, options|
   FooRemote.const_get(gid.model_name).find(gid.model_id)
 end
 ```
@@ -201,7 +201,7 @@ Using a class:
 ```ruby
 GlobalID::Locator.use :bar, BarLocator.new
 class BarLocator
-  def locate(gid)
+  def locate(gid, options = {})
     @search_client.search name: gid.model_name, id: gid.model_id
   end
 end

lib/global_id/locator.rb

@@ -20,11 +20,7 @@ def locate(gid, options = {})
         gid = GlobalID.parse(gid)
         return unless gid && find_allowed?(gid.model_class, options[:only])
 
-        if locator_for(gid).method(:locate).arity == 1
-          locator_for(gid).locate(gid)
-        else
-          locator_for(gid).locate(gid, options.except(:only))
-        end
+        locator_for(gid).locate(gid, options.except(:only))
       end
 
       # Takes an array of GlobalIDs or strings that can be turned into a GlobalIDs.
@@ -106,7 +102,7 @@ def locate_many_signed(sgids, options = {})
       #
       # Using a block:
       #
-      #   GlobalID::Locator.use :foo do |gid|
+      #   GlobalID::Locator.use :foo do |gid, options|
       #     FooRemote.const_get(gid.model_name).find(gid.model_id)
       #   end
       #
@@ -115,7 +111,7 @@ def locate_many_signed(sgids, options = {})
       #   GlobalID::Locator.use :bar, BarLocator.new
       #
       #   class BarLocator
-      #     def locate(gid)
+      #     def locate(gid, options = {})
       #       @search_client.search name: gid.model_name, id: gid.model_id
       #     end
       #   end
@@ -151,7 +147,7 @@ def normalize_app(app)
       class BaseLocator
         def locate(gid, options = {})
           model_class = gid.model_class
-          model_class = model_class.includes(options[:includes]) if model_class.respond_to?(:includes)
+          model_class = model_class.includes(options[:includes]) if options[:includes]
 
           model_class.find gid.model_id
         end
@@ -168,7 +164,7 @@ def locate_many(gids, options = {})
 
         private
           def find_records(model_class, ids, options)
-            model_class = model_class.includes(options[:includes]) if model_class.respond_to?(:includes)
+            model_class = model_class.includes(options[:includes]) if options[:includes]
 
             if options[:ignore_missing]
               model_class.where(id: ids)

test/cases/global_locator_test.rb

@@ -217,7 +217,7 @@ class GlobalLocatorTest < ActiveSupport::TestCase
 
   test 'use locator with class' do
     class BarLocator
-      def locate(gid); :bar; end
+      def locate(gid, options = {}); :bar; end
       def locate_many(gids, options = {}); gids.map(&:model_id); end
     end