identifiable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 490257eea4bca942162766045db54e9cac0b3cdbedcea08a418e3b659cc209ec
+  data.tar.gz: e3cfa1004c351eac0170b1740e291b9f3a878c72a450b9cc7c787ae999b33d83
+SHA512:
+  metadata.gz: e54d72207095067e3b7fea091a5bb41665525d43c5ececa51c228f5ee824d1fc7f55c5c2ca5aac177504456508b60bef7a7d61a27757cc3a801be269cc2b4f0c
+  data.tar.gz: e685fb908d6122fc2e4ce52cb0957bfb50c813705a9acecfe64ddb5ec7fea09dbbddacb346ec70d83de2c4b73107189edc53b5ae0554d58cafc68eed24189da3

data/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    name: 'Test Suite'
+    strategy:
+      matrix:
+        ruby: [2.5, 2.6, 2.7]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.ruby }}
+      - run: bundle install --jobs 4 --retry 3 --path vendor/bundle
+      - run: bundle exec rake
+  lint:
+    name: 'Rubocop'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.7.2
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: bundle-2.7.2-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-2.7.2
+      - run: bundle install --jobs 4 --retry 3 --path vendor/bundle
+      - run: bundle exec rubocop

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 1500
+
+Metrics/BlockLength:
+  Max: 50
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hi@tpritc.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    identifiable (0.1.0)
+      activerecord (> 4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activerecord (6.0.3.4)
+      activemodel (= 6.0.3.4)
+      activesupport (= 6.0.3.4)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.3.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.1.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  identifiable!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.3)
+  sqlite3
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tom Pritchard
+
+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,125 @@
+# Identifiable
+
+Identifiable makes is really quick and easy way to add random, customizable, public-facing IDs to your models. These are great for URLs and reports, where you might not want to share the record's `id` attribute.
+
+## Why do I need public-facing IDs?
+
+If you're asking this question, you probably use your record's `id` attribute as its identifier in its URL. This can be an issue for two main reasons:
+
+1. If you've got a low number of records (if you're just getting started, for instance) it might look unprofessional to have a low ID number. Simply put, `https://example.app/orders/14` doesn't look as good as `https://example.app/orders/87133275`. Even if you've only got 14 orders so far, you might want to _look_ like you've got more. Fake it 'til you make it!
+2. If you're exposing things to the open web, using auto-incrementing IDs means someone hoping to scrape your app can just increment the ID parameter in the URL and get everything. With randomly generated public IDs, scrapers can't just add 1 to each ID to find valid pages.
+
+Identifiable makes it really simple to generate and use random public-facing IDs in your Rails applications.
+
+```ruby
+# Before:
+orders_url(id: @order.id) # → https://example.app/orders/14
+
+# After:
+orders_url(id: @order.public_id) # → https://example.app/orders/87133275
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'identifiable'
+```
+
+Then run `bundle install` and you'll be set.
+
+## Usage
+
+Adding Identifiable to your Rails models couldn't be simpler. The easiest, most default way to add public IDs is to just add `identifiable` to your model. This'll default to 8-character long numeric public IDs (like `23843274` or `98237268`, for instance) on the `public_id` column of your model. These public IDs will be automatically set when you create your records.
+
+```ruby
+class Order < ApplicationRecord
+  identifiable
+end
+```
+
+Identifiable doesn't create the columns for your model, so you will need to add those yourself when you create your models (or add the columns when adding Identifiable to an existing model). These columns will also need an index on them. To add a `public_id` string column with an index to your `Order` model, you can run in your command line:
+
+```bash
+bundle exec rails generate migration add_public_id_to_orders public_id:index
+bundle exec rails db:migrate
+```
+
+If you don't have the public id column set up, Identifiable will raise an error.
+
+### Finding by your model's public ID
+
+If you're used to using `Model.find(id)` in your controllers, no need to fret! Now you can replace it with `Model.find_by_public_id!(public_id)` and you'll get the same behavior, including raising `ActiveRecord::RecordNotFound` if the record doesn't exist. It's plug-and-play.
+
+You can also use `Model.find_by_public_id(public_id)`, which is similar, but does not raise an error if the record doesn't exist, you'll just get `nil` instead.
+
+Because your public ID is just a column in your database, you can also use all the standard Rails ways of accessing records, including `#where` and `#find_by`.
+
+### Adding public IDs to existing records
+
+Public IDs are assigned when saving a record if the public ID isn't already set, so to add public IDs to existing records, you just need to re-run a `#save` on each one, like so:
+
+```ruby
+Order.all.find_each do |order|
+  order.save!
+end
+```
+
+## Customization
+
+While Identifiable strives to have useful defaults, you may want to customize your public IDs for your particular application, or even for particular models in your application.
+
+### Different public ID styles
+
+By default, Identifiable will generate numeric public IDs, with each character between 0 and 9, but it can also generate alphanumeric public IDs and UUID public ids. To chose your public ID style, simply pass it in as a parameter to `identifiable` on your model.
+
+```ruby
+class Order < ApplicationRecord
+  # Valid options for style are :numeric (default), :alphanumeric, and :uuid
+  identifiable style: :alphanumeric
+end
+```
+
+Here's how each available style looks:
+
+* `:numeric` produces public ids with numbers between 0 and 9 for each character, and looks like `23843274`.
+* `:alphanumeric` produces public ids with uppercase letters (A-Z), lowercase letters (a-z), and numbers (0-9) for each character, and looks like `a3ZG8fkP`.
+* `:uuid` produces public ids that match the [UUID specification in RFC 4122](https://tools.ietf.org/html/rfc4122), and look like `adea0700-94de-4075-bbf0-7853cffcca50`.
+
+### Changing the public ID column
+
+By default, Identifiable will assume your public ID column is `public_id`, but you can pick another column if you want. For instance, you might want to use `share_link_id` for a publicly shareable link. To do so, simply pass the column name as a symbol to `identifiable` on your model.
+
+```ruby
+class Order < ApplicationRecord
+  # Defaults to `:public_id`. In this example, the column `share_link_id` must
+  # exist in the `orders` table, otherwise Identifiable will raise an error.
+  identifiable column: :share_link_id
+end
+```
+
+### Changing the length of the public ID
+
+Numeric and alphanumeric public IDs default to 8 characters long, but in your application you might want more (or less) than that. The `length` parameter of `identifiable` is used to set the length of these public IDs, and defaults to `8`.
+
+```ruby
+class Order < ApplicationRecord
+  # This configuration will produce 16 character long alphanumeric public IDs.
+  identifiable style: :alphanumeric, length: 16
+end
+```
+
+The `length` parameter is ignored if you're using `style: :uuid`, because UUIDs already have a fixed length. The `length` parameter also needs be an Integer, and can't be less than `4` or greater than `128`. If any of these constraints are broken, Identifiable will raise an error letting you know.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/tpritc/identifiable). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tpritc/identifiable/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). If you or your organization need a custom, commercial license for any reason, [send me an email](mailto:hi@tpritc.com) and I'll be happy to set something up for you.
+
+## Code of Conduct
+
+Everyone interacting in the Identifiable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tpritc/identifiable/blob/main/CODE_OF_CONDUCT.md).

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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'identifiable'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/identifiable.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/identifiable/version'
+
+Gem::Specification.new do |spec|
+  spec.version       = Identifiable::VERSION
+  spec.name          = 'identifiable'
+  spec.authors       = ['Tom Pritchard']
+  spec.email         = ['hi@tpritc.com']
+
+  spec.summary       = 'A quick and easy way to add random, customizable, public-facing IDs to your models.'
+  spec.homepage      = 'https://github.com/tpritc/identifiable'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '> 4.2'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.3'
+  spec.add_development_dependency 'sqlite3'
+end

data/lib/identifiable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Stylists
+  end
+end
+
+require 'active_record'
+require 'identifiable/stylist'
+require 'identifiable/stylists/alphanumeric'
+require 'identifiable/stylists/numeric'
+require 'identifiable/stylists/uuid'
+require 'identifiable/errors'
+require 'identifiable/model'
+require 'identifiable/version'
+
+ActiveRecord::Base.include Identifiable::Model

data/lib/identifiable/errors.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Errors
+    class ColumnMustBeASymbolError < StandardError
+      def initialize(column_value)
+        column_value_string = column_value.to_s || 'nil'
+        column_value_class = column_value.class.to_s
+        super("The identifiable's column must be a symbol. You passed in #{column_value_string}, which was a #{column_value_class}.")
+      end
+    end
+
+    class ColumnCannotBeIdError < StandardError
+      def initialize
+        super('The identifiable\'s column cannot be :id, since that\'s your primary key. You should create another index column in your table with a name like :public_id.')
+      end
+    end
+
+    class ColumnMustExistInTheTableError < StandardError
+      def initialize(column_value, valid_columns:)
+        column_value_string = column_value.to_s || 'nil'
+        super("The identifiable's column must exist on the table for this model. You passed in #{column_value_string}, but the valid columns are: #{valid_columns}")
+      end
+    end
+
+    class StyleMustBeAValidStyleError < StandardError
+      def initialize(style_value)
+        style_value_string = style_value.to_s || 'nil'
+        super("The identifiable\'s style must be a valid stylist. You passed in #{style_value_string}, but the valid options are: #{Identifiable::Stylist::VALID_STYLES}")
+      end
+    end
+
+    class LengthMustBeAnIntegerError < StandardError
+      def initialize
+        super('The identifiable\'s length must be an Integer.')
+      end
+    end
+
+    class LengthIsTooShortError < StandardError
+      def initialize
+        super('The identifiable\'s length must be at least 4.')
+      end
+    end
+
+    class LengthIsTooLongError < StandardError
+      def initialize
+        super('The identifiable\'s length cannot be more than 128.')
+      end
+    end
+
+    class LengthMustBeNilIfStyleIsUuidError < StandardError
+      def initialize
+        super('The identifiable\'s length cannot be set if you\'re using the :uuid style, because UUIDs have a fixed length. You should remove the length parameter.')
+      end
+    end
+
+    class RanOutOfAttemptsToSetPublicIdError < StandardError
+      def initialize
+        super('We tried 100 times to find an unused public ID, but we could not find one. You should increase the length parameter of the public ID.')
+      end
+    end
+  end
+end

data/lib/identifiable/model.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :identifiable_column
+      attr_reader :identifiable_style
+      attr_reader :identifiable_length
+
+      def identifiable(column: :public_id, style: :numeric, length: 8)
+        @identifiable_column = column
+        @identifiable_style = style
+        @identifiable_length = length
+
+        _identifiable_validate_column_must_be_a_symbol
+        _identifiable_validate_column_cannot_be_id
+        _identifiable_validate_column_must_be_in_the_table
+        _identifiable_validate_style_must_be_a_valid_style
+        _identifiable_validate_length_must_be_an_integer
+        _identifiable_validate_length_must_be_in_a_valid_range
+
+        before_create :set_public_id!
+      end
+
+      def find_by_public_id(public_id)
+        where(Hash[identifiable_column, public_id]).first
+      end
+
+      def find_by_public_id!(public_id)
+        result = find_by_public_id(public_id)
+        raise ActiveRecord::RecordNotFound unless result.present?
+
+        result
+      end
+
+      # We only accept symbols for the column parameter, so we need to raise an
+      # error if anything other than a symbol is passed in.
+      def _identifiable_validate_column_must_be_a_symbol
+        return if @identifiable_column.is_a? Symbol
+
+        raise Identifiable::Errors::ColumnMustBeASymbolError, @identifiable_column
+      end
+
+      # The column parameter cannot be :id, since that's reserved for the
+      # primary key, so raise an error if the column parameter is :id.
+      def _identifiable_validate_column_cannot_be_id
+        return unless @identifiable_column == :id
+
+        raise Identifiable::Errors::ColumnCannotBeIdError
+      end
+
+      # The column parameter must be in the model's table, so check that the
+      # column corresponds to a column in the model's table, and raise an error
+      # if it is not.
+      def _identifiable_validate_column_must_be_in_the_table
+        return if column_names.include? @identifiable_column.to_s
+
+        raise Identifiable::Errors::ColumnMustExistInTheTableError.new(@identifiable_column, valid_columns: column_names)
+      end
+
+      # We can only use valid styles, so check that the style parameter is a
+      # valid style, and raise an error if it is not.
+      def _identifiable_validate_style_must_be_a_valid_style
+        return if Identifiable::Stylist::VALID_STYLES.include? @identifiable_style
+
+        raise Identifiable::Errors::StyleMustBeAValidStyleError, @identifiable_style
+      end
+
+      # The length parameter must be an Integer, so if it's something else then
+      # raise an error.
+      def _identifiable_validate_length_must_be_an_integer
+        return if @identifiable_length.is_a? Integer
+
+        raise Identifiable::Errors::LengthMustBeAnIntegerError
+      end
+
+      # The length parameter can only be within a certain range to prevent
+      # public IDs that are too short or too long, so raise an error if the
+      # length is too short or too long.
+      def _identifiable_validate_length_must_be_in_a_valid_range
+        raise Identifiable::Errors::LengthIsTooShortError if @identifiable_length < 4
+        raise Identifiable::Errors::LengthIsTooLongError if @identifiable_length > 128
+      end
+    end
+
+    # If we don't have a public ID yet, this method fetches the stylist for
+    # this class and finds a new, valid public id, and assigns it to the public
+    # ID column.
+    def set_public_id!
+      # We don't want to set the public id if there's already a value in the
+      # column, so exit early if that's the case.
+      return unless self[self.class.identifiable_column].blank?
+
+      # Create a new stylist for this record, that'll return random IDs
+      # matching the class' style and length options.
+      stylist = Identifiable::Stylist.new(record: self)
+      new_public_id = nil
+
+      # Loop until we find an unused public ID or we run out of attempts.
+      100.times do
+        new_public_id = stylist.random_id
+        break if self.class.find_by_public_id(new_public_id).nil?
+
+        new_public_id = nil
+      end
+
+      # If we ran out of attempts, this probably means the length is too short,
+      # since we kept colliding with existing records. Raise an error to let
+      # the developers know that they need to up the length of the public ID.
+      raise Identifiable::Errors::RanOutOfAttemptsToSetPublicIdError if new_public_id.nil?
+
+      # If we got this far, we've got a new valid public ID, time to set it!
+      self[self.class.identifiable_column] = new_public_id
+    end
+  end
+end

data/lib/identifiable/stylist.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Identifiable
+  class Stylist
+    VALID_STYLES = %i[numeric alphanumeric uuid].freeze
+
+    def initialize(record:)
+      @record = record
+      @stylist = stylist
+    end
+
+    def random_id
+      @stylist.random_id
+    end
+
+    private
+
+    def stylist
+      case @record.class.identifiable_style
+      when :numeric then Identifiable::Stylists::Numeric.new(record: @record)
+      when :alphanumeric then Identifiable::Stylists::Alphanumeric.new(record: @record)
+      when :uuid then Identifiable::Stylists::Uuid.new
+      else
+        raise Identifiable::Errors::StyleMustBeAValidStyle
+      end
+    end
+  end
+end

data/lib/identifiable/stylists/alphanumeric.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Stylists
+    class Alphanumeric
+      def initialize(record:)
+        @record = record
+      end
+
+      def random_id
+        SecureRandom.alphanumeric(@record.class.identifiable_length)
+      end
+    end
+  end
+end

data/lib/identifiable/stylists/numeric.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Stylists
+    class Numeric
+      def initialize(record:)
+        @record = record
+        @scale = scale
+      end
+
+      def random_id
+        (SecureRandom.random_number(@scale.max - @scale.min) + @scale.min).to_s
+      end
+
+      private
+
+      def scale
+        length = @record.class.identifiable_length
+
+        minimum = 10**(length - 1)
+        maximum = (10**length) - 1
+
+        minimum..maximum
+      end
+    end
+  end
+end

data/lib/identifiable/stylists/uuid.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Identifiable
+  module Stylists
+    class Uuid
+      def random_id
+        SecureRandom.uuid
+      end
+    end
+  end
+end

data/lib/identifiable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Identifiable
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: identifiable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Pritchard
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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:
+email:
+- hi@tpritc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- identifiable.gemspec
+- lib/identifiable.rb
+- lib/identifiable/errors.rb
+- lib/identifiable/model.rb
+- lib/identifiable/stylist.rb
+- lib/identifiable/stylists/alphanumeric.rb
+- lib/identifiable/stylists/numeric.rb
+- lib/identifiable/stylists/uuid.rb
+- lib/identifiable/version.rb
+homepage: https://github.com/tpritc/identifiable
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A quick and easy way to add random, customizable, public-facing IDs to your
+  models.
+test_files: []