prefixed_ids 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11c3803dce3921dff8333129c9cbfa8f34ad50463bda15e3517dd2cf74b17205
-  data.tar.gz: f2a460deb4832039b85668764420150831a3f7b7c79cda9b233cf51907fa5bfe
+  metadata.gz: 59a5bd4a556be1cc707fbfc22826ff52c2c7ace6f69c9328eb4ec9e8552a939d
+  data.tar.gz: 13d03f6fa3ef80f5527750456fe16ca5262db9c2278f187d49a46f3cd229b113
 SHA512:
-  metadata.gz: ef6760313ffd3a32edf92f4b87f6f9d63b8c9209308be4b0d7d6d54bc6f10b7f78fd31f9efe28e260025f3ef13e1837add383d920051564fbc443803c90400e1
-  data.tar.gz: '01869ac0b8c994fed97c77df7f92adca5cb93a31a9ab09a1cda897eac8d60d8cf4d3960e556023c962de57981cc9cc2e9b41691335ed1a51f99d2c6f890f945a'
+  metadata.gz: 97ed861903460640f0e836602aa17015e391600b900437edac0c321707b95bc47aa1ee4ac86b9a303b3531e6e5fbb13ae7195c13ee19bcfe688b57702a0eb1a8
+  data.tar.gz: 7d6712c197f5278fc2841033f5d52e17ade941639f6a84b99e428838ae404eb97ea4699587338abb88aaae7bb0aca2e368fb4b961c154990ee27c69ad0f6e9d9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Chris Oliver
+
+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

@@ -1,28 +1,58 @@
-# PrefixedIds
+<p align="center">
+  <h1>Prefixed IDs</h1>
+</p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/prefixed_ids`. To experiment with that code, run `bin/console` for an interactive prompt.
+### 🆔 Friendly Prefixed IDs for your Ruby on Rails models
 
-TODO: Delete this and the text above, and describe your gem
+[![Build Status](https://github.com/excid3/prefixed_ids/workflows/Tests/badge.svg)](https://github.com/excid3/prefixed_ids/actions) [![Gem Version](https://badge.fury.io/rb/prefixed_ids.svg)](https://badge.fury.io/rb/prefixed_ids)
 
-## Installation
+Generate prefixed IDs for your models with a friendly prefix. For example:
 
+```ruby
+user_12345abcd
+acct_23lksjdg3
+```
+
+## 🚀 Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'prefixed_ids'
+bundle add 'prefixed_ids'
 ```
 
-And then execute:
+## 📝 Usage
 
-    $ bundle install
+First, you'll need to generate a migration to add the prefix_id column to your model(s).
 
-Or install it yourself as:
+```ruby
+class AddPrefixIdToUsers< ActiveRecord::Migration
+  def change
+    add_index :users, :prefix_id, unique: true
+  end
+end
+```
 
-    $ gem install prefixed_ids
+It's important the `prefix_id` column is indexed and unique.
 
-## Usage
+Then you can add `has_prefix_id :my_prefix` to your models to autogenerate prefixed IDs.
 
-TODO: Write usage instructions here
+```ruby
+class User < ApplicationRecord
+  has_prefix_id :user
+end
+```
+
+This will generate a value like `user_1234abcd` in the User's `prefix_id` column.
+
+### Customizing
+
+You can customize the prefix, length, and attribute name for PrefixedIds.
+
+```ruby
+class Account < ApplicationRecord
+  has_prefix_id :acct, attribute: :my_id, length: 32
+end
+```
 
 ## Development
 
@@ -30,11 +60,11 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+## 🙏 Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/prefixed_ids. 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/[USERNAME]/prefixed_ids/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/excid3/prefixed_ids. 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/[USERNAME]/prefixed_ids/blob/master/CODE_OF_CONDUCT.md).
 
-## License
+## 📝 License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/Rakefile

@@ -1,12 +1,18 @@
-# frozen_string_literal: true
+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"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
 end
 
 task default: :test

data/lib/prefixed_ids.rb

@@ -1,8 +1,27 @@
-# frozen_string_literal: true
-
-require_relative "prefixed_ids/version"
+require "prefixed_ids/version"
+require "prefixed_ids/engine"
 
 module PrefixedIds
-  class Error < StandardError; end
-  # Your code goes here...
+  MINIMUM_TOKEN_LENGTH = 24
+
+  module Attribute
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def has_prefix_id(prefix, attribute: :prefix_id, length: MINIMUM_TOKEN_LENGTH)
+        if length < MINIMUM_TOKEN_LENGTH
+          raise MinimumLengthError, "Token requires a minimum length of #{MINIMUM_TOKEN_LENGTH} characters."
+        end
+
+        # Load securerandom only when has_secure_token is used.
+        require "active_support/core_ext/securerandom"
+        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_prefix_id(prefix, length: length) }
+        before_create { send("#{attribute}=", self.class.generate_unique_prefix_id(prefix, length: length)) unless send("#{attribute}?") }
+      end
+
+      def generate_unique_prefix_id(prefix, length: MINIMUM_TOKEN_LENGTH)
+        prefix.to_s + "_" + SecureRandom.base58(length)
+      end
+    end
+  end
 end

data/lib/prefixed_ids/engine.rb

@@ -0,0 +1,9 @@
+module PrefixedIds
+  class Engine < ::Rails::Engine
+    initializer "prefixed_ids.model" do
+      ActiveSupport.on_load(:active_record) do
+        include PrefixedIds::Attribute
+      end
+    end
+  end
+end

data/lib/prefixed_ids/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module PrefixedIds
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/tasks/prefixed_ids_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :prefixed_ids do
+#   # Task goes here
+# end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: prefixed_ids
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2021-02-17 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  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: appraisal
+  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: Prefixed IDs generates IDs with friendly prefixes for your models
 email:
 - excid3@gmail.com
@@ -17,18 +59,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
+- MIT-LICENSE
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/prefixed_ids.rb
+- lib/prefixed_ids/engine.rb
 - lib/prefixed_ids/version.rb
-- prefixed_ids.gemspec
+- lib/tasks/prefixed_ids_tasks.rake
 homepage: https://github.com/excid3/prefixed_ids
 licenses:
 - MIT
@@ -44,7 +81,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/main.yml

@@ -1,18 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.0
-    - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.3
-        bundle install
-        bundle exec rake

data/.gitignore

@@ -1,8 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at excid3@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in prefixed_ids.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2021 Chris Oliver
-
-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/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "prefixed_ids"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/prefixed_ids.gemspec

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/prefixed_ids/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "prefixed_ids"
-  spec.version       = PrefixedIds::VERSION
-  spec.authors       = ["Chris Oliver"]
-  spec.email         = ["excid3@gmail.com"]
-
-  spec.summary       = "Prefixed IDs generates IDs with friendly prefixes for your models"
-  spec.description   = "Prefixed IDs generates IDs with friendly prefixes for your models"
-  spec.homepage      = "https://github.com/excid3/prefixed_ids"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/excid3/prefixed_ids"
-  spec.metadata["changelog_uri"] = "https://github.com/excid3/prefixed_ids"
-
-  # 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{\A(?:test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end