neat_ids 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47363230b8058ed8405561165226af620e1f75ffcbf63003359572cc083cb0c2
-  data.tar.gz: 7cab3e1ff65aec2f9ba9f7eae92546a11d78eb0fb471bbde69e2377cf6aca915
+  metadata.gz: 71d2b22c9ed3296f5b52c0fcb193caee551837cb351c5c7200e985da420df33c
+  data.tar.gz: e0df512bd2bd22df8f44d0a83acc863a37bb9d3affa3ab05bb5806087b6718cf
 SHA512:
-  metadata.gz: 37ab0caa54c2f8a80ee6776083eab688f61a323b3b4289d38610ac0e3e2949b0a49a311e049143e11a2ca91db58b358fc8036fb5f740b50474f8fa49ad15fbb5
-  data.tar.gz: 8065f32d9d5b8b354834ef9beb75d59f2f69c0ca54284ff83add2f0c9a4e8ef7ad0af81919f5ccdeb96fb0c3eb76dcc5b14a1e947652c197ce864864d1ebbd3b
+  metadata.gz: 23715fa9a6cd461ed7970f775903632ba35afa785682499029b21b0c3ca0cbdecdcfb1e7caecb848a87eefd601af8df308a9d10be527ca31ecb690fc58249a34
+  data.tar.gz: f658ad44a57b92be00d2c76c822839874f362c07fff00ef7615e943c63fbcc6104209aa64b8bc0f26460d0e76cf55dc79aef93eb1bca3adcd9eb8557f2a49a8f

data/Rakefile

@@ -3,8 +3,6 @@ require "bundler/setup"
 APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
-load "rails/tasks/statistics.rake"
-
 require "bundler/gem_tasks"
 
 require "rake/testtask"

data/lib/neat_ids/neat_id.rb

@@ -1,13 +1,14 @@
 module NeatIds
   class NeatId
-    attr_reader :sqids, :prefix
+    attr_reader :sqids, :prefix, :salt
 
     TOKEN = 123
 
-    def initialize(model, prefix, min_length: NeatIds.minimum_length, alphabet: NeatIds.alphabet, delimiter: NeatIds.delimiter, **options)
+    def initialize(model, prefix, min_length: NeatIds.minimum_length, alphabet: NeatIds.alphabet, delimiter: NeatIds.delimiter, salt: NeatIds.salt, **options)
       @prefix = prefix.to_s
       @delimiter = delimiter.to_s
-      @sqids = Sqids.new( min_length: min_length, alphabet: alphabet)
+      @salt = "#{model.table_name}#{salt}"
+      @sqids = Sqids.new(min_length: min_length, alphabet: shuffle_alphabet(alphabet))
     end
 
     def encode(id)
@@ -38,6 +39,24 @@ module NeatIds
 
     private
 
+    def shuffle_alphabet(alphabet)
+      chars = alphabet.chars
+      i = 0
+      p = 0
+      len = chars.length
+
+      salt_length = @salt.length
+      while i < len
+        v = salt_length.zero? ? 0 : @salt.getbyte(i % salt_length)
+        p += v
+        j = (v + p + i) % len
+        chars[i], chars[j] = chars[j], chars[i]
+        i += 1
+      end
+
+      chars.join
+    end
+
     def valid?(decoded_hashid)
       decoded_hashid.size >= 2 && decoded_hashid.first == TOKEN
     end
@@ -47,13 +66,13 @@ module NeatIds
     end
 
     def uuid_to_ints(uuid)
-      hex = uuid.delete('-')
+      hex = uuid.delete("-")
       [0, 8, 16, 24].map { |i| hex[i, 8].to_i(16) }
     end
 
     def ints_to_uuid(ints)
-      hex = ints.map { |n| n.to_s(16).rjust(8, '0') }.join
-      "#{hex[0,8]}-#{hex[8,4]}-#{hex[12,4]}-#{hex[16,4]}-#{hex[20,12]}"
+      hex = ints.map { |n| n.to_s(16).rjust(8, "0") }.join
+      "#{hex[0, 8]}-#{hex[8, 4]}-#{hex[12, 4]}-#{hex[16, 4]}-#{hex[20, 12]}"
     end
   end
 end

data/lib/neat_ids/version.rb

@@ -1,3 +1,3 @@
 module NeatIds
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/neat_ids.rb

@@ -3,6 +3,19 @@ require "neat_ids/engine"
 
 require "sqids"
 
+# The upstream sqids gem derives its max encodable number from `0.size`
+# (the machine word size). On 32-bit platforms (e.g. arm32) that yields
+# 2**30 - 1 = 1073741823, which is too small for the 32-bit integer chunks
+# used to encode UUIDs and breaks encoding on machines like the Raspberry Pi 2.
+# `max_value` only acts as an upper-bound guard in `Sqids#encode`; it does not
+# affect the encoding/decoding algorithm, so pinning it to a fixed constant is
+# safe and produces identical IDs on every platform.
+class Sqids
+  def self.max_value
+    9007199254740991 # 2**53 - 1, per the Sqids spec
+  end
+end
+
 module NeatIds
   class Error < StandardError; end
 
@@ -11,6 +24,7 @@ module NeatIds
   mattr_accessor :delimiter, default: "_"
   mattr_accessor :alphabet, default: "abcdefghijklmnopqrstuvwxyz1234567890"
   mattr_accessor :minimum_length, default: 24
+  mattr_accessor :salt, default: ""
 
   mattr_accessor :models, default: {}
 
@@ -21,6 +35,16 @@ module NeatIds
     raise Error, "Unable to find model with prefix `#{prefix}`. Available prefixes are: #{models.keys.join(", ")}"
   end
 
+  # Returns a decoded ID from a neat_id
+  def self.decode_neat_id(neat_id)
+    return neat_id if neat_id.nil? || neat_id.is_a?(Integer)
+    return neat_id unless models.keys.any? { |key| neat_id.to_s.start_with?("#{key}#{delimiter}") }
+
+    model_name, _ = split_id(neat_id)
+
+    models.fetch(model_name).decode_neat_id(neat_id)
+  end
+
   # Splits a prefixed ID into its prefix and ID
   def self.split_id(neat_id, delimiter = NeatIds.delimiter)
     prefix, _, id = neat_id.to_s.rpartition(delimiter)
@@ -62,6 +86,13 @@ module NeatIds
   module Attribute
     extend ActiveSupport::Concern
 
+    # Methods added to relations and has_many associations
+    module RelationMethods
+      def neat_ids
+        klass.neat_ids(pluck(:id))
+      end
+    end
+
     class_methods do
       def find_by_neat_id(id)
         find_by(id: _neat_id.decode(id))
@@ -86,6 +117,16 @@ module NeatIds
       def decode_neat_ids(ids)
         ids.map { |id| decode_neat_id(id) }
       end
+
+      def relation
+        super.tap { |r| r.extend RelationMethods }
+      end
+
+      def has_many(*args, &block)
+        options = args.extract_options!
+        options[:extend] = Array(options[:extend]).push(RelationMethods)
+        super(*args, **options, &block)
+      end
     end
 
     def neat_id
@@ -112,12 +153,35 @@ module NeatIds
       end
 
       def relation
-        super.tap { |r| r.extend ClassMethods }
+        super.tap { |r| r.extend ClassMethods, Attribute::RelationMethods }
+      end
+
+      def belongs_to(*args, **options, &block)
+        association = super
+
+        name = args.first
+        reflection = association[name] || association[name.to_s]
+
+        return association if reflection.polymorphic?
+        return association if reflection.klass._neat_id.blank?
+
+        generated_association_methods.class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}_neat_id
+            #{reflection.klass}._neat_id.encode(#{reflection.foreign_key})
+          end
+
+          def #{name}_neat_id=(neat_id)
+            decoded_id = #{reflection.klass}._neat_id.decode(neat_id, fallback: #{reflection.klass}._neat_id_fallback)
+            send("#{reflection.foreign_key}=", decoded_id)
+          end
+        CODE
+
+        association
       end
 
       def has_many(*args, &block)
         options = args.extract_options!
-        options[:extend] = Array(options[:extend]).push(ClassMethods)
+        options[:extend] = Array(options[:extend]).push(ClassMethods, Attribute::RelationMethods)
         super(*args, **options, &block)
       end
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: neat_ids
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brad Thompson
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-07-05 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,7 +58,6 @@ metadata:
   homepage_uri: https://github.com/braddoeswebdev/neat_ids
   source_code_uri: https://github.com/braddoeswebdev/neat_ids
   changelog_uri: https://github.com/braddoeswebdev/neat_ids
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -74,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 4.0.14
 specification_version: 4
 summary: Neat IDs generates IDs with friendly prefixes for your models
 test_files: []