globalid 0.4.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c51189af124bc8712e1242070c33fa3bfd26c900003699a2b21328e8d197e55
-  data.tar.gz: b00783d7b5fd8b7def68e925d6f70e3ddfb70ad82c3603061c0d29e736dfa9f4
+  metadata.gz: 52c4368f15fc8952c9d79189ed9a78e649e0142421721aef338625c19b24c3b9
+  data.tar.gz: 4d6d1c379d45ccaf5761488c540d19cac9d0488b578564964edd88c52073c511
 SHA512:
-  metadata.gz: 5f5b1a859baae95d9efb693f8d9a0cfb008c82cedfbc3cc994b51cdf46d7191725317e31f8eee824ade1c04a9924d661ca1b9c04e7032ab9250aa20bf8e73614
-  data.tar.gz: c0ac25a21157363a3274e4e58ba99146fa2ce90e0860bbe7c21356a9af9d8013c0404bef2d6f4c793ca20aae287c26fa9625e4c74170574a1f4b048dd961fe0e
+  metadata.gz: 49ff5a4b4d4f68afdffa67a85b5aebfb3b2f518257ffec22be8a60a29ac5596a67552aae46bebab28a4fe6b37a5802ac520b0f567098617110b2f54c4a74cfcb
+  data.tar.gz: f6ba35dc2c080b0c996bd4529cec1438a35545c693cc0271e25c6b7bdaa8f759de61f26ae6ecf16487d89c7e6e5afc41caab7114541cd8a54ebdf9e2a3ce1f60

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2016 David Heinemeier Hansson
+Copyright (c) 2014-2023 David Heinemeier Hansson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -18,4 +18,3 @@ 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.
-

data/README.md

@@ -133,6 +133,34 @@ GlobalID::Locator.locate_signed(signup_person_sgid.to_s, for: 'signup_form')
 # => #<Person:0x007fae94bf6298 @id="1">
 ```
 
+### Locating many Global IDs
+
+When needing to locate many Global IDs use `GlobalID::Locator.locate_many` or `GlobalID::Locator.locate_many_signed` for Signed Global IDs to allow loading
+Global IDs more efficiently.
+
+For instance, the default locator passes every `model_id` per `model_name` thus
+using `model_name.where(id: model_ids)` versus `GlobalID::Locator.locate`'s `model_name.find(id)`.
+
+In the case of looking up Global IDs from a database, it's only necessary to query
+once per `model_name` as shown here:
+
+```ruby
+gids = users.concat(people).sort_by(&:id).map(&:to_global_id)
+# => [#<GlobalID:0x00007ffd6a8411a0 @uri=#<URI::GID gid://app/User/1>>,
+#<GlobalID:0x00007ffd675d32b8 @uri=#<URI::GID gid://app/Student/1>>,
+#<GlobalID:0x00007ffd6a840b10 @uri=#<URI::GID gid://app/User/2>>,
+#<GlobalID:0x00007ffd675d2c28 @uri=#<URI::GID gid://app/Student/2>>,
+#<GlobalID:0x00007ffd6a840480 @uri=#<URI::GID gid://app/User/3>>,
+#<GlobalID:0x00007ffd675d2598 @uri=#<URI::GID gid://app/Student/3>>]
+
+GlobalID::Locator.locate_many gids
+# SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3)  [["id", 1], ["id", 2], ["id", 3]]
+# SELECT "students".* FROM "students" WHERE "students"."id" IN ($1, $2, $3)  [["id", 1], ["id", 2], ["id", 3]]
+# => [#<User id: 1>, #<Student id: 1>, #<User id: 2>, #<Student id: 2>, #<User id: 3>, #<Student id: 3>]
+```
+
+Note the order is maintained in the returned results.
+
 ### Custom App Locator
 
 A custom locator can be set for an app by calling `GlobalID::Locator.use` and providing an app locator to use for that app.

data/lib/global_id/fixture_set.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class GlobalID
+  module FixtureSet
+    def global_id(fixture_set_name, label, column_type: :integer, **options)
+      create_global_id(fixture_set_name, label, column_type: column_type, klass: GlobalID, **options)
+    end
+
+    def signed_global_id(fixture_set_name, label, column_type: :integer, **options)
+      create_global_id(fixture_set_name, label, column_type: column_type, klass: SignedGlobalID, **options)
+    end
+
+    private
+      def create_global_id(fixture_set_name, label, klass:, column_type: :integer, **options)
+        identifier = identify(label, column_type)
+        model_name = default_fixture_model_name(fixture_set_name)
+        uri = URI::GID.build([GlobalID.app, model_name, identifier, {}])
+        klass.new(uri, **options)
+      end
+  end
+end

data/lib/global_id/global_id.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_support/core_ext/string/inflections'  # For #model_class constantize
 require 'active_support/core_ext/array/access'
 require 'active_support/core_ext/object/try'          # For #find
@@ -35,18 +34,12 @@ class GlobalID
 
     private
       def parse_encoded_gid(gid, options)
-        new(Base64.urlsafe_decode64(repad_gid(gid)), options) rescue nil
-      end
-
-      # We removed the base64 padding character = during #to_param, now we're adding it back so decoding will work
-      def repad_gid(gid)
-        padding_chars = gid.length.modulo(4).zero? ? 0 : (4 - gid.length.modulo(4))
-        gid + ('=' * padding_chars)
+        new(Base64.urlsafe_decode64(gid), options) rescue nil
       end
   end
 
   attr_reader :uri
-  delegate :app, :model_name, :model_id, :params, :to_s, to: :uri
+  delegate :app, :model_name, :model_id, :params, :to_s, :deconstruct_keys, to: :uri
 
   def initialize(gid, options = {})
     @uri = gid.is_a?(URI::GID) ? gid : URI::GID.parse(gid)
@@ -57,7 +50,13 @@ class GlobalID
   end
 
   def model_class
-    model_name.constantize
+    model = model_name.constantize
+
+    unless model <= GlobalID
+      model
+    else
+      raise ArgumentError, "GlobalID and SignedGlobalID cannot be used as model_class."
+    end
   end
 
   def ==(other)
@@ -70,7 +69,10 @@ class GlobalID
   end
 
   def to_param
-    # remove the = padding character for a prettier param -- it'll be added back in parse_encoded_gid
-    Base64.urlsafe_encode64(to_s).sub(/=+$/, '')
+    Base64.urlsafe_encode64(to_s, padding: false)
+  end
+
+  def as_json(*)
+    to_s
   end
 end

data/lib/global_id/identification.rb

@@ -1,9 +1,5 @@
-require 'active_support/concern'
-
 class GlobalID
   module Identification
-    extend ActiveSupport::Concern
-
     def to_global_id(options = {})
       GlobalID.create(self, options)
     end

data/lib/global_id/locator.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_support/core_ext/enumerable' # For Enumerable#index_by
 
 class GlobalID

data/lib/global_id/railtie.rb

@@ -3,8 +3,8 @@ require 'rails/railtie'
 rescue LoadError
 else
 require 'global_id'
-require 'active_support'
 require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/integer/time'
 
 class GlobalID
   # = GlobalID Railtie
@@ -18,11 +18,11 @@ class GlobalID
       default_app_name = app.railtie_name.remove('_application').dasherize
 
       GlobalID.app = app.config.global_id.app ||= default_app_name
-      SignedGlobalID.expires_in = app.config.global_id.expires_in ||= default_expires_in
+      SignedGlobalID.expires_in = app.config.global_id.fetch(:expires_in, default_expires_in)
 
       config.after_initialize do
         GlobalID.app = app.config.global_id.app ||= default_app_name
-        SignedGlobalID.expires_in = app.config.global_id.expires_in ||= default_expires_in
+        SignedGlobalID.expires_in = app.config.global_id.fetch(:expires_in, default_expires_in)
 
         app.config.global_id.verifier ||= begin
           GlobalID::Verifier.new(app.key_generator.generate_key('signed_global_ids'))
@@ -36,6 +36,11 @@ class GlobalID
         require 'global_id/identification'
         send :include, GlobalID::Identification
       end
+
+      ActiveSupport.on_load(:active_record_fixture_set) do
+        require 'global_id/fixture_set'
+        send :extend, GlobalID::FixtureSet
+      end
     end
   end
 end

data/lib/global_id/signed_global_id.rb

@@ -1,4 +1,3 @@
-require 'global_id'
 require 'active_support/message_verifier'
 require 'time'
 

data/lib/global_id/uri/gid.rb

@@ -98,6 +98,10 @@ module URI
       "gid://#{app}#{path}#{'?' + query if query}"
     end
 
+    def deconstruct_keys(_keys)
+      {app: app, model_name: model_name, model_id: model_id, params: params}
+    end
+
     protected
       def set_path(path)
         set_model_components(path) unless defined?(@model_name) && @model_id
@@ -123,9 +127,6 @@ module URI
     private
       COMPONENT = [ :scheme, :app, :model_name, :model_id, :params ].freeze
 
-      # Extracts model_name and model_id from the URI path.
-      PATH_REGEXP = %r(\A/([^/]+)/?([^/]+)?\z)
-
       def check_host(host)
         validate_component(host)
         super
@@ -138,18 +139,18 @@ module URI
 
       def check_scheme(scheme)
         if scheme == 'gid'
-          super
+          true
         else
           raise URI::BadURIError, "Not a gid:// URI scheme: #{inspect}"
         end
       end
 
       def set_model_components(path, validate = false)
-        _, model_name, model_id = path.match(PATH_REGEXP).to_a
-        model_id = CGI.unescape(model_id) if model_id
-
+        _, model_name, model_id = path.split('/', 3)
         validate_component(model_name) && validate_model_id(model_id, model_name) if validate
 
+        model_id = CGI.unescape(model_id) if model_id
+
         @model_name = model_name
         @model_id = model_id
       end
@@ -162,7 +163,7 @@ module URI
       end
 
       def validate_model_id(model_id, model_name)
-        return model_id unless model_id.blank?
+        return model_id unless model_id.blank? || model_id.include?('/')
 
         raise MissingModelIdError, "Unable to create a Global ID for " \
           "#{model_name} without a model id."
@@ -173,5 +174,9 @@ module URI
       end
   end
 
-  @@schemes['GID'] = GID
+  if respond_to?(:register_scheme)
+    register_scheme('GID', GID)
+  else
+    @@schemes['GID'] = GID
+  end
 end

data/lib/global_id/verifier.rb

@@ -1,4 +1,3 @@
-require 'active_support'
 require 'active_support/message_verifier'
 
 class GlobalID

data/lib/global_id.rb

@@ -1,5 +1,5 @@
-require 'global_id/global_id'
 require 'active_support'
+require 'global_id/global_id'
 
 autoload :SignedGlobalID, 'global_id/signed_global_id'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: globalid
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 1.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +47,7 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/global_id.rb
+- lib/global_id/fixture_set.rb
 - lib/global_id/global_id.rb
 - lib/global_id/identification.rb
 - lib/global_id/locator.rb
@@ -58,7 +59,8 @@ files:
 homepage: http://www.rubyonrails.org
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -67,14 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: 'Refer to any model with a URI: gid://app/class/id'