universalid 0.1.3 → 0.1.5

data/lib/universalid.rb

@@ -1,3 +1,30 @@
 # frozen_string_literal: true
 
-require_relative "universal_id"
+require "active_support/all"
+require "zeitwerk"
+
+module UniversalID
+  module Extensions; end
+
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new(File::NULL)
+    end
+  end
+end
+
+Zeitwerk::Loader.for_gem(warn_on_extra_files: false).tap do |loader|
+  loader.inflector = Zeitwerk::GemInflector.new(__dir__)
+  loader.ignore "#{__dir__}/universalid/**/*message_pack_type*"
+  loader.ignore "#{__dir__}/universalid/extensions"
+  loader.inflector.inflect("universalid" => "UniversalID")
+  loader.inflector.inflect("uri" => "URI")
+  loader.inflector.inflect("uid" => "UID")
+  loader.inflector.inflect("version" => "VERSION")
+  loader.setup
+  loader.eager_load
+end
+
+UniversalID::Settings.instance # initialize settings

data/lib/uri/uid.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+require "uri"
+
 unless defined?(::URI::UID) || ::URI.scheme_list.include?("UID")
 
   module URI
     class UID < ::URI::Generic
       VERSION = UniversalID::VERSION
       SCHEME = "uid"
-      HOST = "universal-id"
+      HOST = "universalid"
 
       class << self
         def encoder
@@ -18,8 +20,13 @@ unless defined?(::URI::UID) || ::URI.scheme_list.include?("UID")
         end
 
         def parse(value)
-          components = ::URI.split(value.to_s)
-          new(*components)
+          return nil if value.nil?
+          return value if value.is_a?(self)
+
+          value = value.to_s
+          return nil if value.strip.empty?
+
+          new(*::URI.split(value))
         end
 
         def build_string(payload, object = nil)
@@ -87,10 +94,13 @@ unless defined?(::URI::UID) || ::URI.scheme_list.include?("UID")
         end
       end
 
-      alias_method :fingerprint, :fragment
+      def payload
+        path[1..]
+      end
 
-      def payload(truncate: false)
-        (truncate && path.length > 80) ? "#{path[1..77]}..." : path[1..]
+      def fingerprint(decode: false)
+        return decode_fingerprint if decode
+        fragment
       end
 
       def valid?
@@ -116,7 +126,7 @@ unless defined?(::URI::UID) || ::URI.scheme_list.include?("UID")
       end
 
       def inspect
-        "#<URI::UID scheme=#{scheme}, host=#{host}, payload=#{payload truncate: true}>"
+        "#<URI::UID payload=#{payload.truncate 40}, fingerprint=#{fingerprint.truncate 40}>"
       end
 
       private

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: universalid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-17 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: brotli
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: config
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +164,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  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: magic_frozen_string_literal
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +220,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  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: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -249,10 +333,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.32'
 description: |
-  Universal ID is a Ruby library that specializes in the serialization of Ruby objects to URL-safe strings,
-  employing MessagePack and Brotli for optimized encoding. It facilitates efficient data transfer and state
-  management across various computing processes. Designed to seamlessly integrate with Ruby applications,
-  it does not rely on Rails-specific dependencies, making it adaptable for diverse Ruby projects.
+  Universal ID opens the flood gates with a deluge of profoundly powerful
+  yet easily implemented new use-cases for your apps and scripts.
 email:
 - natehop@gmail.com
 executables: []
@@ -263,46 +345,42 @@ files:
 - Rakefile
 - config/default.yml
 - config/example.yml
-- lib/universal_id.rb
-- lib/universal_id/contrib/active_record.rb
-- lib/universal_id/contrib/active_record/base_message_pack_type.rb
-- lib/universal_id/contrib/active_record/base_packer.rb
-- lib/universal_id/contrib/active_record/base_unpacker.rb
-- lib/universal_id/contrib/active_record/relation_message_pack_type.rb
-- lib/universal_id/contrib/active_support.rb
-- lib/universal_id/contrib/active_support/time_with_zone_message_pack_type.rb
-- lib/universal_id/contrib/global_id.rb
-- lib/universal_id/contrib/global_id/global_id_model.rb
-- lib/universal_id/contrib/global_id/global_id_uid_extension.rb
-- lib/universal_id/contrib/global_id/message_pack_type.rb
-- lib/universal_id/contrib/rails.rb
-- lib/universal_id/contrib/signed_global_id.rb
-- lib/universal_id/contrib/signed_global_id/message_pack_type.rb
-- lib/universal_id/encoder.rb
-- lib/universal_id/message_pack_factory.rb
-- lib/universal_id/message_pack_types.rb
-- lib/universal_id/message_pack_types/ruby/composites/module.rb
-- lib/universal_id/message_pack_types/ruby/composites/open_struct.rb
-- lib/universal_id/message_pack_types/ruby/composites/set.rb
-- lib/universal_id/message_pack_types/ruby/composites/struct.rb
-- lib/universal_id/message_pack_types/ruby/scalars/complex.rb
-- lib/universal_id/message_pack_types/ruby/scalars/date.rb
-- lib/universal_id/message_pack_types/ruby/scalars/date_time.rb
-- lib/universal_id/message_pack_types/ruby/scalars/range.rb
-- lib/universal_id/message_pack_types/ruby/scalars/rational.rb
-- lib/universal_id/message_pack_types/ruby/scalars/regexp.rb
-- lib/universal_id/message_pack_types/uri/uid/type.rb
-- lib/universal_id/prepack_database_options.rb
-- lib/universal_id/prepack_options.rb
-- lib/universal_id/prepacker.rb
-- lib/universal_id/refinements.rb
-- lib/universal_id/refinements/array_refinement.rb
-- lib/universal_id/refinements/hash_refinement.rb
-- lib/universal_id/refinements/open_struct_refinement.rb
-- lib/universal_id/refinements/set_refinement.rb
-- lib/universal_id/settings.rb
-- lib/universal_id/version.rb
 - lib/universalid.rb
+- lib/universalid/encoder.rb
+- lib/universalid/extensions/active_record/base_message_pack_type.rb
+- lib/universalid/extensions/active_record/base_packer.rb
+- lib/universalid/extensions/active_record/base_unpacker.rb
+- lib/universalid/extensions/active_record/relation_message_pack_type.rb
+- lib/universalid/extensions/active_support/time_with_zone_message_pack_type.rb
+- lib/universalid/extensions/global_id/global_id_model.rb
+- lib/universalid/extensions/global_id/global_id_uid_extension.rb
+- lib/universalid/extensions/global_id/message_pack_type.rb
+- lib/universalid/extensions/signed_global_id/message_pack_type.rb
+- lib/universalid/message_pack_factory.rb
+- lib/universalid/message_pack_types.rb
+- lib/universalid/message_pack_types/ruby/composites/module.rb
+- lib/universalid/message_pack_types/ruby/composites/open_struct.rb
+- lib/universalid/message_pack_types/ruby/composites/set.rb
+- lib/universalid/message_pack_types/ruby/composites/struct.rb
+- lib/universalid/message_pack_types/ruby/scalars/bigdecimal.rb
+- lib/universalid/message_pack_types/ruby/scalars/complex.rb
+- lib/universalid/message_pack_types/ruby/scalars/date.rb
+- lib/universalid/message_pack_types/ruby/scalars/date_time.rb
+- lib/universalid/message_pack_types/ruby/scalars/range.rb
+- lib/universalid/message_pack_types/ruby/scalars/rational.rb
+- lib/universalid/message_pack_types/ruby/scalars/regexp.rb
+- lib/universalid/message_pack_types/uri/uid/type.rb
+- lib/universalid/packer.rb
+- lib/universalid/prepack_database_options.rb
+- lib/universalid/prepack_options.rb
+- lib/universalid/prepacker.rb
+- lib/universalid/refinements.rb
+- lib/universalid/refinements/array_refinement.rb
+- lib/universalid/refinements/hash_refinement.rb
+- lib/universalid/refinements/open_struct_refinement.rb
+- lib/universalid/refinements/set_refinement.rb
+- lib/universalid/settings.rb
+- lib/universalid/version.rb
 - lib/uri/uid.rb
 homepage: https://github.com/hopsoft/universalid
 licenses:
@@ -326,8 +404,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.3.21
 signing_key:
 specification_version: 4
-summary: URL-Safe String Serialization for any Ruby Object
+summary: Fast, recursive, optimized, URL-Safe serialization for any Ruby object
 test_files: []

data/lib/universal_id/contrib/active_record/base_message_pack_type.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base_packer"
-require_relative "base_unpacker"
-
-UniversalID::MessagePackFactory.register(
-  type: ActiveRecord::Base,
-  recreate_pool: false,
-  packer: ->(obj, packer) { UniversalID::Contrib::ActiveRecordBasePacker.new(obj).pack_with packer },
-  unpacker: ->(unpacker) { UniversalID::Contrib::ActiveRecordBaseUnpacker.unpack_with unpacker }
-)

data/lib/universal_id/contrib/active_record/base_packer.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-class UniversalID::Contrib::ActiveRecordBasePacker
-  using UniversalID::Refinements::HashRefinement
-
-  # TODO: implement support for has_one
-  #       ActiveRecord::Reflection::HasOneReflection
-  #
-  # TODO: implement support for has_and_belongs_to_many
-  #       ActiveRecord::Reflection::HasAndBelongsToManyReflection
-  #
-  HAS_MANY_ASSOCIATIONS = [
-    ActiveRecord::Reflection::HasManyReflection
-  ]
-
-  DESCENDANTS_KEY = "uid:descendants"
-
-  attr_reader :record
-
-  def initialize(record)
-    @record = record
-  end
-
-  def pack_with(packer)
-    packer.write record.class.name
-    packer.write packable_attributes
-  end
-
-  def prepack_options
-    options = record.instance_variable_get(:@_uid_prepack_options)
-    options = UniversalID::PrepackOptions.new unless options.is_a?(UniversalID::PrepackOptions)
-    options
-  end
-
-  def prepack_database_options
-    prepack_options.database_options
-  end
-
-  private
-
-  def packable_attributes
-    return record.attributes.slice(record.class.primary_key) if id_only?(prepack_database_options)
-
-    hash = record.attributes
-    reject_keys! hash if prepack_database_options.exclude_keys?
-    reject_timestamps! hash if prepack_database_options.exclude_timestamps?
-    reject_unsaved_changes! hash if prepack_database_options.exclude_unsaved_changes?
-    add_descendants! hash if include_descendants?
-
-    hash.prepack prepack_options
-  end
-
-  # helpers ..................................................................................................
-  def id_only?(prepack_database_options)
-    return false if record.new_record?
-    return false if prepack_database_options.include_descendants?
-    prepack_database_options.exclude_unsaved_changes?
-  end
-
-  def include_descendants?
-    return false unless prepack_database_options.include_descendants?
-
-    max_depth = prepack_database_options.descendant_depth.to_i
-    record_depth = record.instance_variable_get(:@_uid_depth).to_i
-    record_depth < max_depth
-  end
-
-  # attribute mutators .......................................................................................
-
-  def reject_keys!(hash)
-    hash.delete record.class.primary_key
-    foreign_key_column_names.each { |key| hash.delete key }
-  end
-
-  def reject_timestamps!(hash)
-    timestamp_column_names.each { |key| hash.delete key }
-  end
-
-  def reject_unsaved_changes!(hash)
-    record.changes_to_save.each do |key, (original_value, _)|
-      hash[key] = original_value
-    end
-  end
-
-  def add_descendants!(hash)
-    hash[DESCENDANTS_KEY] ||= {}
-
-    loaded_has_many_relations_by_name.each do |name, relation|
-      descendants = relation.map do |descendant|
-        descendant.instance_variable_set(:@_uid_depth, prepack_database_options.current_depth + 1)
-        UniversalID::Encoder.encode descendant, prepack_options
-      ensure
-        prepack_database_options.decrement_current_depth!
-        descendant.remove_instance_variable :@_uid_depth
-      end
-      hash[DESCENDANTS_KEY][name] = descendants
-    end
-
-    prepack_database_options.increment_current_depth!
-  end
-
-  # active record helpers ....................................................................................
-
-  def timestamp_column_names
-    record.class.all_timestamp_attributes_in_model
-  end
-
-  def foreign_key_column_names
-    record.class.reflections
-      .each_with_object([]) do |(name, reflection), memo|
-        memo << reflection.foreign_key if reflection.macro == :belongs_to
-      end
-  end
-
-  def associations
-    record.class.reflect_on_all_associations
-  end
-
-  def has_many_associations
-    associations.select { |a| HAS_MANY_ASSOCIATIONS.include? a.class }
-  end
-
-  def loaded_has_many_relations_by_name
-    has_many_associations.each_with_object({}) do |association, memo|
-      relation = record.public_send(association.name)
-      next unless relation.loaded?
-      memo[association.name] = relation
-    end
-  end
-end

data/lib/universal_id/contrib/active_record/base_unpacker.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-class UniversalID::Contrib::ActiveRecordBaseUnpacker
-  class << self
-    def unpack_with(unpacker)
-      class_name = unpacker.read
-      attributes = unpacker.read || {}
-      create_instance class_name, attributes
-    end
-
-    private
-
-    def create_instance(class_name, attributes)
-      klass = Object.const_get(class_name) if Object.const_defined?(class_name)
-      return nil unless klass
-
-      record = if attributes[klass.primary_key]
-        klass.find_by(klass.primary_key => attributes[klass.primary_key])
-      else
-        klass.new
-      end
-
-      assign_attributes record, attributes
-      assign_descendants record, attributes
-
-      record
-    end
-
-    def assign_attributes(record, attributes)
-      attributes.each do |key, value|
-        record.public_send "#{key}=", value if record.respond_to? "#{key}="
-      end
-    end
-
-    def assign_descendants(record, attributes)
-      descendants = attributes[UniversalID::Contrib::ActiveRecordBasePacker::DESCENDANTS_KEY] || {}
-      descendants.each do |name, list|
-        next unless record.respond_to?(name) && record.respond_to?("#{name}=")
-
-        models = list.map { |encoded| UniversalID::Encoder.decode encoded }
-        models.compact!
-        next unless models.any?
-
-        # NOTE: ActiveRecord is smart enough to not re-create or re-add
-        #       existing records for has_many associations
-        record.public_send "#{name}=", models
-      end
-    end
-  end
-end

data/lib/universal_id/contrib/active_record/relation_message_pack_type.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-# TODO: Revisit ActiveRecord::Relation serialization strategy,
-#       and attempt to optimize without falling back to Marshal.dump/load
-UniversalID::MessagePackFactory.register(
-  type: ActiveRecord::Relation,
-  recreate_pool: false,
-  packer: ->(obj, packer) do
-    # NOTE: packing a relation will reset the loaded state and internal cache of the relation
-    #       this ensures minimal payload size
-    obj = obj.dup # clear internal cached state (loaded results, etc.)
-    obj.reset # dup should clear any internal caching, but we call reset just in case
-    packer.write Marshal.dump(obj)
-  end,
-  unpacker: ->(unpacker) { Marshal.load unpacker.read }
-)

data/lib/universal_id/contrib/active_record.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "active_record/base_message_pack_type"
-require_relative "active_record/relation_message_pack_type"

data/lib/universal_id/contrib/active_support/time_with_zone_message_pack_type.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-UniversalID::MessagePackFactory.register(
-  type: ActiveSupport::TimeWithZone,
-  packer: ->(obj, packer) do
-    packer.write obj.iso8601(9)
-    packer.write obj.zone
-  end,
-  unpacker: ->(unpacker) do
-    time = Time.parse(unpacker.read)
-    zone = unpacker.read
-    ActiveSupport::TimeWithZone.new time, ActiveSupport::TimeZone[zone]
-  end
-)

data/lib/universal_id/contrib/active_support.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "active_support/time_with_zone_message_pack_type"

data/lib/universal_id/contrib/global_id/global_id_model.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-class UniversalID::Contrib::GlobalIDModel
-  include GlobalID::Identification
-
-  def self.find(value)
-    new value
-  end
-
-  attr_reader :id, :uid
-
-  def initialize(universal_id)
-    @uid = case universal_id
-    when URI::UID then universal_id
-    when String
-      case universal_id
-      when /\A#{URI::UID::SCHEME}/o then URI::UID.parse(universal_id)
-      else URI::UID.parse(URI::UID.build_string(universal_id, self))
-      end
-    end
-
-    @id = @uid&.payload
-  end
-end

data/lib/universal_id/contrib/global_id/global_id_uid_extension.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module UniversalID::Contrib::GlobalIDUIDExtension
-  extend Forwardable
-
-  def self.included(mixer)
-    mixer.extend ClassMethods
-  end
-
-  # Adds all GlobalID::Identification methods
-  def_delegators(:to_global_id_model, *GlobalID::Identification.instance_methods(false))
-
-  # Returns a UniversalID::Contrib::GlobalIDModel instance
-  # which implements the GlobalID::Identification interface/protocol
-  def to_global_id_model
-    UniversalID::Contrib::GlobalIDModel.new self
-  end
-
-  module ClassMethods
-    def from_global_id_record(gid_record)
-      gid_record&.find&.uid
-    end
-
-    def from_global_id(gid, options = {})
-      from_global_id_record GlobalID.parse(gid, options)
-    end
-
-    alias_method :from_gid, :from_global_id
-
-    def from_signed_global_id(sgid, options = {})
-      from_global_id_record SignedGlobalID.parse(sgid, options)
-    end
-
-    alias_method :from_sgid, :from_signed_global_id
-  end
-end

data/lib/universal_id/contrib/global_id/message_pack_type.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module UniversalID::Contrib::GlobalID; end
-
-require_relative "global_id_model"
-require_relative "global_id_uid_extension"
-
-URI::UID.include UniversalID::Contrib::GlobalIDUIDExtension
-
-UniversalID::MessagePackFactory.register(
-  type: GlobalID,
-  recreate_pool: false,
-  packer: ->(obj, packer) { packer.write obj.to_param },
-  unpacker: ->(unpacker) { GlobalID.parse unpacker.read }
-)

data/lib/universal_id/contrib/global_id.rb

@@ -1,3 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "global_id/message_pack_type"

data/lib/universal_id/contrib/rails.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "active_record" if defined? ActiveRecord
-require_relative "active_support" if defined? ActiveSupport
-require_relative "global_id" if defined? GlobalID
-require_relative "signed_global_id" if defined? SignedGlobalID

data/lib/universal_id/contrib/signed_global_id/message_pack_type.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-UniversalID::MessagePackFactory.register(
-  type: SignedGlobalID,
-  recreate_pool: false,
-  packer: ->(obj, packer) { packer.write obj.to_param },
-  unpacker: ->(unpacker) { SignedGlobalID.parse unpacker.read }
-)