public_code 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 391563ed134d7ff113b44b5608ddf2068dd18ca6048190aa1913e03a7313adc8
+  data.tar.gz: 7b1e6be8d4b8bb9abdac10b8aaabf5a269c37b2fe119437f1387562985537538
+SHA512:
+  metadata.gz: d84156a63e7644dd3df2f9beb2c33b20cc12c2936db07c0f2d30770aad3cfaa2572439e91a0fabb33691fdcbbbaf333b1b09c577ebcf3e0aae7221db28b4a736
+  data.tar.gz: ea22466225e19e92fe4fbe4d737153bd0c03c0d8ffa26aaac497d2fb38548066157e3aba9442e3a8b66712b4233f5ae966d40b7e04a7ca545de6cf8149ddd800

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+- A model that calls `has_public_code` gives each new record a random 24 character code, and every address Rails builds for the record carries that code in place of its id.
+- `find_by_public_code!` finds a record by its code among the records searched, whatever the code column is named.
+- `PublicCode.generate` makes a code for a record that already exists, such as in a migration.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 DYB
+
+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,63 @@
+# public_code
+
+Gives an Active Record model a random code that its addresses carry and that
+finds it, so no address shows a database id. The database id stays the
+internal key that records point at each other with.
+
+## Install
+
+```ruby
+gem "public_code"
+```
+
+## Use
+
+Add a code column with a unique index, and fill it for records that already exist:
+
+```ruby
+class AddPublicCodeToProducts < ActiveRecord::Migration[8.1]
+  class Product < ActiveRecord::Base
+    self.table_name = "products"
+  end
+
+  def up
+    add_column :products, :public_code, :string
+    Product.find_each { |product| product.update_columns(public_code: PublicCode.generate) }
+    change_column_null :products, :public_code, false
+    add_index :products, :public_code, unique: true
+  end
+
+  def down
+    remove_column :products, :public_code
+  end
+end
+```
+
+Name the code on the model:
+
+```ruby
+class Product < ApplicationRecord
+  has_public_code
+end
+```
+
+A new product gets a random 24 character code of letters and digits. Every
+address Rails builds for it carries the code in place of its id, so
+`product_path(product)` is `/products/k3f9x2…`.
+
+Find a record from the code in an address:
+
+```ruby
+Product.find_by_public_code!(params[:id])
+current_client.products.find_by_public_code!(params[:id])
+```
+
+It raises `ActiveRecord::RecordNotFound` when no record among those searched
+has that code, so a search limited to one client's records never finds
+another client's.
+
+A column with its own name works the same way:
+
+```ruby
+has_public_code :code
+```

data/lib/public_code/model.rb

@@ -0,0 +1,13 @@
+module PublicCode
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_public_code(column = :public_code)
+        has_secure_token column, length: PublicCode::LENGTH
+        define_method(:to_param) { public_send(column) }
+        define_singleton_method(:find_by_public_code!) { |code| find_by!(column => code) }
+      end
+    end
+  end
+end

data/lib/public_code/version.rb

@@ -0,0 +1,3 @@
+module PublicCode
+  VERSION = "0.1.0"
+end

data/lib/public_code.rb

@@ -0,0 +1,12 @@
+require "active_record"
+require "active_support"
+require "public_code/version"
+require "public_code/model"
+
+module PublicCode
+  LENGTH = 24
+
+  def self.generate = ActiveRecord::Base.generate_unique_secure_token(length: LENGTH)
+end
+
+ActiveSupport.on_load(:active_record) { include PublicCode::Model }

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: public_code
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Schneider
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: Gives an Active Record model a random code that its addresses carry and
+  that finds it, so no address shows a database id.
+email:
+- tylercschneider@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/public_code.rb
+- lib/public_code/model.rb
+- lib/public_code/version.rb
+homepage: https://github.com/DYB-Development/public_code
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DYB-Development/public_code
+  source_code_uri: https://github.com/DYB-Development/public_code
+  changelog_uri: https://github.com/DYB-Development/public_code/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/DYB-Development/public_code/issues
+  documentation_uri: https://github.com/DYB-Development/public_code#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: A random code for a record's addresses in place of its database id.
+test_files: []