randomized_field 0.1.0 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b672711694faa07ea4ae48df26a552238f5a48fa4f04571ee2167468d354055
+  data.tar.gz: 698f94b12b4948c6942cdae923dc3198929ea4aafb7ad20b56eab8ddda4485ef
+SHA512:
+  metadata.gz: f50da6ab04ca124bf770d4181e539e6a9d0948f1c8b6b28504f6047db481e42fbae0d7c6d1605d5e2a7e88c23853e16afeb97451c5d161ffd190b54448e46c2a
+  data.tar.gz: ac0f57a008b5b8d8668917eae652cee28581530fd3be99e1f71c99c88ee1a63aa15361bf0a74bcfd39b65d8560a08763d0483643727c4d518caa129cf4e8b675

data/.gitignore

@@ -0,0 +1,46 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+vendor/Pods/
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5+
+  Exclude:
+    - ./*.gemspec
+
+Metrics/BlockLength:
+  ExcludedMethods: ['context', 'describe']
+
+Metrics/LineLength:
+  Max: 100
+
+RSpec/BeforeAfterAll:
+  Enabled: false
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    randomized_field (0.1.0)
+      activerecord (>= 4.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.1)
+    minitest (5.11.3)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.59.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.30.0)
+      rubocop (>= 0.58.0)
+    ruby-progressbar (1.10.0)
+    shoulda-matchers (3.1.2)
+      activesupport (>= 4.0.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  randomized_field!
+  rspec (~> 3.0)
+  rubocop (~> 0.59)
+  rubocop-rspec (~> 1.30)
+  shoulda-matchers (~> 3.1)
+  sqlite3
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Strive Talent, Inc. (dba Strive)
+
+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,92 +1,57 @@
 # RandomizedField
 
-[![Build Status](https://secure.travis-ci.org/jfarmer/randomized_field.png)](http://travis-ci.org/jfarmer/randomized_field)
+RandomizedField is a simple module for ActiveRecord that populates a field with a unique, randomly-generated string. This is useful for generating one-off tokens or creating a non-incrementing unique ID.
 
-RandomizedField is a simple plugin for ActiveRecord that populates a field with a unique,
-randomly-generated string.  This is useful for generating one-off tokens or creating a
-non-incrementing unique ID.
-
-Oftentimes we want a randomized unique ID so that we don't reveal information about how
-large our database is, or to create an unguessable (and perhaps temporary) token for
-things like password resets, etc.
+Oftentimes we want a randomized unique ID so that we don't reveal information about how large our database is or to create an unguessable (and perhaps temporary) token for things like password resets, etc.
 
 You might use RandomizedField to generate:
 
-* Order numbers, return authorization numbers, etc. for an e-commerce system
-* Unique referral IDs or invitation tokens for each user of your site
-* Tokens for password reset emails
-* Temporary tokens embedded in an email that automatically log users in 
-
-## Features
+- Order numbers, return authorization numbers, etc. for an e-commerce system
+- Unique referral IDs or invitation tokens for each user of your site
+- Tokens for password reset emails
+- Temporary tokens embedded in an email that automatically log users in
 
-RandomizedField currently generates a random, fixed-length string with an optional prefix.
-You can control the length of the string, what characters are used to generate the string, and what
-prefix to prepend to the string (if any).
+## Installation and Usage
 
-Like I said: simple.
+1. Add the `randomized_field` gem to your application's Gemfile:
 
-## Rails Quickstart
-```ruby
-    gem install randomized_field
+   ```ruby
+   gem 'randomized_field'
+   ```
+2. Run `bundle` to install the gem
 
-    rails new my_app
+   ```console
+   $ bundle
+   ```
 
-    cd my_app
+   Or install it directly with the `gem` command:
 
-    gem "randomized_field"
+   ```console
+   $ gem install randomized_field
+   ```
 
-    rails generate scaffold user name:string random_id:string
+3. Include `RandomizedField` in the models you care about (or in a shared base class like `ApplicationRecord` if you want it available to every model):
 
-    # edit db/migrate/*_create_users.rb
-    add_index :users, :random_id, :unique => true
+   ```ruby
+   class Article < ApplicationRecord
+     include RandomizedField
 
-    rake db:migrate
+     randomized_field :slug, length: 10
+   end
+   ```
 
-    # edit app/models/user.rb
-    class User < ActiveRecord::Base
-	  randomized_field :random_id, :length => 6, :prefix => 'U'
-    end
+**Note**: RandomizedField won't do anything unless you also call `randomized_field` with the name of the field you want to populate.
 
-    User.create! name: "Joe Schmoe"
+## Development
 
-    rails server
-	
-	User.find_by_random_id(params[:random_id])
-```
-	
-## Bugs
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-Please report them on the [Github issue
-tracker](http://github.com/jfarmer/randomized_field/issues) for this project.
+To install this gem onto your local machine, run `bundle exec rake install`.
 
-If you have a bug to report, please include the following information:
-
-* **Version information for RandomizedField, Rails and Ruby.**
-* Full stack trace and error message (if you have them).
-* Any snippets of relevant model, view or controller code that shows how you
-  are using RandomizedField.
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/StriveTalent/randomized_field.
 
 ## License
 
-	Copyright (c) 2012 Jesse Farmer, released under the MIT license
-	
-	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.
-
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).  See the `LICENSE.txt` file.

data/Rakefile

@@ -1,37 +1,6 @@
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'RandomizedField'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+RSpec::Core::RakeTask.new(:spec)
 
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "randomized_field"
+
+# 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/lib/randomized_field.rb

@@ -1,4 +1,18 @@
-require 'randomized_field/version'
-require 'randomized_field/defaults'
-require 'randomized_field/base'
-require 'randomized_field/randomizer'
+require "randomized_field/version"
+require "randomized_field/callback"
+require "randomized_field/generator"
+
+require "active_support/concern"
+
+# Top-level module that adds the randomized_field method to ActiveRecord
+# objects. Include in individual models or ApplicationRecord.
+module RandomizedField
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def randomized_field(field_name, **opts, &block)
+      before_create RandomizedField::Callback.new(field_name, **opts, &block)
+      validates field_name, uniqueness: true
+    end
+  end
+end

data/lib/randomized_field/callback.rb

@@ -0,0 +1,30 @@
+module RandomizedField
+  # Implements the before_create ActiveRecord callback used to set the value
+  # of the randomized field.
+  class Callback
+    attr_reader :field_name, :generator
+    private :field_name, :generator
+
+    def initialize(field_name, **generator_opts, &block)
+      @field_name = field_name
+      @generator = Generator.new(generator_opts, &block)
+    end
+
+    def before_create(record)
+      record[field_name] ||= new_field_value(record)
+    end
+
+    private
+
+    def new_field_value(record)
+      old_record = true
+
+      until old_record.nil?
+        new_value = generator.generate
+        old_record = record.class.find_by(field_name => new_value)
+      end
+
+      new_value
+    end
+  end
+end