globalid 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18495b4f7910329fd0a65dcfa294742d0cdbb129a4c7f6971c4f9c62e9ea890d
-  data.tar.gz: 5b6a25aabd0d04d9a4a2d4bb4d5152d68a67758fad96deabc011a4a169f2a055
+  metadata.gz: e7f6fd8b8b0b07aad73739e2004b5c4229e48dfa64960dcfa243f6c1b6276b44
+  data.tar.gz: a1cc24c9968a2236d2974f4ecac4d3fbb8513e4ac74d18685185afa684fad41d
 SHA512:
-  metadata.gz: fb525d60050154b885197a89aaf2b1f2f577d0574b83160a3c0cbc2899d67e8995cf23c2de852c30baaa1ef8cc594cad39187e3808b350195c95ead32359957c
-  data.tar.gz: 5dda5c09cffcc6e60da06931f3be5ba144db99f6ed0b9d7dc085633e0bac642f1c9d9ac7ba686dd59a6b9be64bb275ee8e78b39fae6e372b69c8131709db6f0f
+  metadata.gz: 68bd4cc42217eb59cff8b1f73c989e9f17ddce332f7d65f533e5b2fa6e429a10328d9c5b02f165e778cd83c02afa095103984910c098e75c9dcab788a4c97024
+  data.tar.gz: 652bc775cb1da110f6eca011d5a6ef3d907f79ddbfda755206d84eddca06c2153b734befb5b5dc6ea09ed911b87c72fcae6f9bfb5554da1b4616d60d22a298fb

data/README.md

@@ -57,7 +57,7 @@ GlobalID::Locator.locate_signed person_sgid
 
 **Expiration**
 
-Signed Global IDs can expire some time in the future. This is useful if there's a resource
+Signed Global IDs can expire sometime in the future. This is useful if there's a resource
 people shouldn't have indefinite access to, like a share link.
 
 ```ruby
@@ -73,8 +73,8 @@ GlobalID::Locator.locate_signed(expiring_sgid.to_s, for: 'sharing')
 # => nil
 ```
 
-**In Rails, an auto-expiry of 1 month is set by default.** You can alter that deal
-in an initializer with:
+**In Rails, an auto-expiry of 1 month is set by default.** You can alter that
+default in an initializer with:
 
 ```ruby
 # config/initializers/global_id.rb
@@ -87,7 +87,7 @@ You can assign a default SGID lifetime like so:
 SignedGlobalID.expires_in = 1.month
 ```
 
-This way any generated SGID will use that relative expiry.
+This way, any generated SGID will use that relative expiry.
 
 It's worth noting that _expiring SGIDs are not idempotent_ because they encode the current timestamp; repeated calls to `to_sgid` will produce different results. For example, in Rails
 
@@ -165,19 +165,19 @@ Note the order is maintained in the returned results.
 
 Either `GlobalID::Locator.locate` or `GlobalID::Locator.locate_many` supports a hash of options as second parameter. The supported options are:
 
-* :includes - A Symbol, Array, Hash or combination of them
-  The same structure you would pass into a `includes` method of Active Record.
-  See [Active Record eager loading associations](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations)
+* `:includes` - A Symbol, Array, Hash or combination of them.
+  The same structure you would pass into an `includes` method of Active Record.
+  See [Active Record eager loading associations](https://guides.rubyonrails.org/active_record_querying.html#eager-loading-associations).
   If present, `locate` or `locate_many` will eager load all the relationships specified here.
-  Note: It only works if all the gids models have that relationships.
-* :only - A class, module or Array of classes and/or modules that are
+  Note: It only works if all the GIDs Models have those relationships.
+* `:only` - A class, module, or Array of classes and/or modules that are
   allowed to be located.  Passing one or more classes limits instances of returned
   classes to those classes or their subclasses.  Passing one or more modules in limits
   instances of returned classes to those including that module.  If no classes or
-  modules match, +nil+ is returned.
-* :ignore_missing (Only for `locate_many`) - By default, `locate_many` will call `#find` on the model to locate the
+  modules match, `nil` is returned.
+* `:ignore_missing` (Only for `locate_many`) - By default, `locate_many` will call `#find` on the model to locate the
   ids extracted from the GIDs. In Active Record (and other data stores following the same pattern),
-  `#find` will raise an exception if a named ID can't be found. When you set this option to true,
+  `#find` will raise an exception if a named ID can't be found. When you set this option to `true`,
   we will use `#where(id: ids)` instead, which does not raise on missing records.
 
 ### Custom App Locator
@@ -207,9 +207,31 @@ class BarLocator
 end
 ```
 
-After defining locators as above, URIs like "gid://foo/Person/1" and "gid://bar/Person/1" will now use the foo block locator and `BarLocator` respectively.
+After defining locators as above, URIs like `gid://foo/Person/1` and `gid://bar/Person/1` will now use the foo block locator and `BarLocator` respectively.
 Other apps will still keep using the default locator.
 
+### Custom Default Locator
+
+A custom default locator can be set for an app by calling `GlobalID::Locator.default_locator=` and providing a default locator to use for that app.
+
+```ruby
+class MyCustomLocator < UnscopedLocator
+  def locate(gid, options = {})
+    ActiveRecord::Base.connected_to(role: :reading) do
+      super(gid, options)
+    end
+  end
+  
+  def locate_many(gids, options = {})
+    ActiveRecord::Base.connected_to(role: :reading) do
+      super(gids, options)
+    end
+  end
+end
+
+GlobalID::Locator.default_locator = MyCustomLocator.new
+```
+
 ## Contributing to GlobalID
 
 GlobalID is work of many contributors. You're encouraged to submit pull requests, propose

data/lib/global_id/global_id.rb

@@ -32,6 +32,10 @@ class GlobalID
       @app = URI::GID.validate_app(app)
     end
 
+    def default_locator(default_locator)
+      Locator.default_locator = default_locator
+    end
+
     private
       def parse_encoded_gid(gid, options)
         new(Base64.urlsafe_decode64(gid), options) rescue nil

data/lib/global_id/identification.rb

@@ -31,8 +31,8 @@ class GlobalID
     #
     #   model = Person.new id: 1
     #   global_id = model.to_global_id
-    #   global_id.modal_class # => Person
-    #   global_id.modal_id # => "1"
+    #   global_id.model_class # => Person
+    #   global_id.model_id # => "1"
     #   global_id.to_param # => "Z2lkOi8vYm9yZGZvbGlvL1BlcnNvbi8x"
     def to_global_id(options = {})
       GlobalID.create(self, options)
@@ -52,8 +52,8 @@ class GlobalID
     #
     #   model = Person.new id: 1
     #   signed_global_id = model.to_signed_global_id
-    #   signed_global_id.modal_class # => Person
-    #   signed_global_id.modal_id # => "1"
+    #   signed_global_id.model_class # => Person
+    #   signed_global_id.model_id # => "1"
     #   signed_global_id.to_param # => "BAh7CEkiCGdpZAY6BkVUSSIiZ2..."
     #
     # ==== Expiration

data/lib/global_id/locator.rb

@@ -5,6 +5,9 @@ class GlobalID
     class InvalidModelIdError < StandardError; end
 
     class << self
+      # The default locator used when no app-specific locator is found.
+      attr_accessor :default_locator
+
       # Takes either a GlobalID or a string that can be turned into a GlobalID
       #
       # Options:
@@ -134,7 +137,7 @@ class GlobalID
 
       private
         def locator_for(gid)
-          @locators.fetch(normalize_app(gid.app)) { DEFAULT_LOCATOR }
+          @locators.fetch(normalize_app(gid.app)) { default_locator }
         end
 
         def find_allowed?(model_class, only = nil)
@@ -223,7 +226,8 @@ class GlobalID
             end
           end
       end
-      DEFAULT_LOCATOR = UnscopedLocator.new
+
+      self.default_locator = UnscopedLocator.new
 
       class BlockLocator
         def initialize(block)

data/lib/global_id/uri/gid.rb

@@ -36,6 +36,8 @@ module URI
     COMPOSITE_MODEL_ID_MAX_SIZE = 20
     COMPOSITE_MODEL_ID_DELIMITER = "/"
 
+    URI_PARSER = URI::RFC2396_Parser.new # :nodoc:
+
     class << self
       # Validates +app+'s as URI hostnames containing only alphanumeric characters
       # and hyphens. An ArgumentError is raised if +app+ is invalid.
@@ -62,7 +64,7 @@ module URI
       #   URI.parse('gid://bcx')       # => URI::GID instance
       #   URI::GID.parse('gid://bcx/') # => raises URI::InvalidComponentError
       def parse(uri)
-        generic_components = URI.split(uri) << nil << true # nil parser, true arg_check
+        generic_components = URI.split(uri) << URI_PARSER << true # RFC2396 parser, true arg_check
         new(*generic_components)
       end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: globalid
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,8 +59,11 @@ homepage: http://www.rubyonrails.org
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/rails/globalid/issues
+  changelog_uri: https://github.com/rails/globalid/releases/tag/v1.3.0
+  mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
+  source_code_uri: https://github.com/rails/globalid/tree/v1.3.0
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: 'Refer to any model with a URI: gid://app/class/id'
 test_files: []