tiny_gid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a33939d63b7efe92195e8ff5065083e03061920f0bcafc0b853c43d371c5bf6
+  data.tar.gz: a6245c347ca86b527a67480c888939d57a4070e64d4668c540cf5c09ad971a0f
+SHA512:
+  metadata.gz: 7d57726cc44177123d78a1f7be65ecbcd5dc941c2a58c3238c889a49e8b388c2800fe734011d6c5e3f05f0b99c367f86e664ffaa1b8e54196528697c06a83254
+  data.tar.gz: 2bb181b90609740663d80cf2a30fc5c3ed80e542ce50d9322272823122cdb86e57d123ea17021b3fbcf3df5a2245621e825d9a8358da86a88b41340a68b7ba25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 sshaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND 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

@@ -0,0 +1,84 @@
+# TinyGID
+
+![TinyGID CI Status](https://github.com/sshaw/tiny_gid/actions/workflows/ci.yml/badge.svg "TinyGID CI Status")
+
+Tiny class to build Global ID (gid://) strings from scalar values.
+
+## Usage
+
+`gem install tiny_gid` or for Bundler: `gem "tiny_gid", :require => "gid"`
+
+
+Setting an app name is required. If Rails is installed `Rails.application.name` is used.
+
+```rb
+require "gid"
+
+gid.app = "shopify"
+
+gid::Product(123)        # "gid://shopify/Product/123"
+gid::ProductVariant(123) # "gid://shopify/ProductVariant/123"
+gid::InventoryLevel(123, :inventory_item_id => 456) # "gid://shopify/InventoryLevel/123?inventory_item_id=456"
+
+# Use something besides gid.app for the duration of the block:
+gid.app("something-amaaaazing") do
+  gid::User(1)  # "gid://something-amaaaazing/User/1"
+  gid::Post(99) # "gid://something-amaaaazing/User/99"
+end
+```
+
+This will also import the `GID` class:
+```rb
+gid = GID.new("shopify")
+gid::Product(123)        # "gid://shopify/Product/123"
+
+# You don't have to use :: of course ;)
+gid.Product(123) # "gid://shopify/Product/123"
+```
+
+If you don't want the (pesky?) `gid` method you can require: `tiny_gid/gid` which gives you `GID` only.
+
+If `GID` creates a conflict in the top-level namespace use `TinyGID`:
+```rb
+require "tiny_gid"
+
+TinyGID.app = "shopify"
+TinyGID::Product(123) # "gid://shopify/Product/123"
+
+TinyGID.app("something-amaaaazing") do |gid|
+  gid::User(1) # "gid://something-amaaaazing/User/1"
+end
+
+gid = TinyGID.new("shopify")
+gid.Product(123)
+```
+
+## Why Not Use GlobalID‽
+
+[GlobalID](https://github.com/rails/globalid) is nice but it primarily deals with IDs backed by an instance of a class, e.g. Rails model, whereas
+TinyGID is for scalars.
+
+GlobalID does indeed have version that can be used with scalars but it's a bit verbose and not good for developer productivity:
+```rb
+URI::GID.build(:app => "foo", :model_name => "User", :model_id => "123", :params => { :foo => "bar" })
+```
+
+Don't yah think?
+
+## ID Encoding/Escaping
+
+Using application/x-www-form-urlencoded encoding to match GlobalID. Should probably support URL encoding too.
+
+To put that in 21st century speak: spaces with be replaced with `+` not `%20`.
+
+## Signed Global IDs
+
+No support. Use GlobalID :)
+
+## Author
+
+Skye Shaw [skye.shaw -AT- gmail.com]
+
+## License
+
+Released under the MIT License: http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/gid.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "tiny_gid/gid"
+
+def gid
+  GID
+end

data/lib/tiny_gid/gid.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "tiny_gid"
+
+GID = TinyGID

data/lib/tiny_gid.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module TinyGID
+  VERSION = "0.0.1"
+  FORMAT = "gid://%s/%s/%s"
+
+  module MethodMissing  # :nodoc:
+    def method_missing(name, *arguments, &block)
+      # TODO: need to ensure we're not calling ourselves
+
+      id = arguments.shift
+      raise ArgumentError, "gid::#{name} requires an ID" unless id
+
+      params = (arguments[0] || {}).dup
+      raise TypeError, "gid::#{name} params must be a Hash. Received: #{params.class}" unless params.is_a?(Hash)
+
+      app = params.delete(:__app__) || TinyGID.app
+      raise "gid::#{name} cannot be generated: missing app" unless app
+
+      gid = sprintf(FORMAT, app, name, URI.encode_www_form_component(id))
+      return gid unless params.any?
+
+      gid << "?" << URI.encode_www_form(params)
+    end
+  end
+
+  include MethodMissing         # 🤸‍♀️
+  extend MethodMissing          # 🤸‍♂️
+
+  class << self
+    # In GlobalID app names must be valid URI hostnames: alphanumeric and hyphen characters only
+    def app=(name)
+      @app = name
+    end
+
+    def app(name = nil)
+      if block_given?
+        raise ArgumentError, "block provided without a app to scope to" unless name
+
+        begin
+          og = @app
+          @app = name
+
+          yield self
+        ensure
+          @app = og
+        end
+
+        return
+      end
+
+      # No block but given a name, just set it :|
+      @app = name if name
+
+      return @app if @app
+      return Rails.application.name if defined?(Rails) && Rails.respond_to?(:application)
+    end
+
+    # Necessary?
+    # def to_sc(gid)
+    #   # TODO:
+    #   # value, params = TinyGID.to_sc("gid://shopify/Product/123?is_a=headache")
+    #   gid.to_s.split("/")[-1]
+    # end
+  end
+
+  def initialize(app)
+    raise ArgumentError "app required" if app.to_s.strip.empty?
+    @app = app
+  end
+
+  def method_missing(name, *arguments, &block)
+    id = arguments.shift
+
+    options = arguments.shift || {}
+    options = options.merge(:__app__ => @app) unless options.include?(:app)
+
+    super(name, id, options, &block)
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: tiny_gid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Skye Shaw
+bindir: bin
+cert_chain: []
+date: 2025-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: bundler
+  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: rake
+  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'
+description: TinyGID provides a compact syntax for building Global ID strings for
+  things like GraphQL APIs and Rails apps
+email:
+- skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/gid.rb
+- lib/tiny_gid.rb
+- lib/tiny_gid/gid.rb
+homepage: https://github.com/sshaw/tiny_gid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sshaw/tiny_gid
+  source_code_uri: https://github.com/sshaw/tiny_gid
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Tiny class to build Global ID (gid://) strings from scalar values
+test_files: []