pretty_id 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2adaf9801acbc841856a03333afaaddf61d1eba3
+  data.tar.gz: 478f9e9224476be744f41cf237d8e774ed2af44a
+SHA512:
+  metadata.gz: dcf2bbba6f40717818e2eecee56d154557b620313c9666d7643e3ed03e443c81e1dbd369e9d369b898e537fa03e8dc57df9dbe87b14d8cfd7751c19a971926e8
+  data.tar.gz: da70deca1e75cb700629ae154d02358ad50185443644b2369ba39a9691bd9e7b1528ff45c73a7fe2fa9f1d88474ccbd330a0879c03b638ced897f4e9dbb872cd

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: Czw8TYLlNKX5ZLpHVZAmZVjxdKSZdroYH

data/.gitignore

@@ -0,0 +1,15 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/config/database.yml
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+spec/dummy/public/uploads/*
+tmp/*
+coverage/*
+*.gem
+Gemfile.lock
+spec/dummy/db/test.sqlite3
+gemfiles/*.lock
+.ruby-gemset

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+script: bundle exec rspec
+notifications:
+  email: false
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-3' do
+  gem 'rails', '3.2.7'
+end
+
+appraise 'rails-4.0' do
+  gem 'rails', '4.0.0'
+end
+
+appraise 'rails-4.1' do
+  gem 'rails', '4.1.0'
+end

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2014 Department of Better Technology
+
+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,46 @@
+pretty_id
+=======
+
+[![Travis][0]](https://travis-ci.org/dobtco/pretty_id)
+[![Code Climate][1]](https://codeclimate.com/github/dobtco/pretty_id)
+[![Coveralls][2]](https://coveralls.io/r/dobtco/pretty_id)
+[![RubyGem][3]](http://rubygems.org/gems/pretty_id)
+
+Add random, unique "pretty" ids to your ActiveRecord models.
+
+## Usage
+
+#### 1. Install the gem
+```ruby
+gem 'pretty_id'
+```
+
+#### 2. Add a `pretty_id` column (and index!) to your model
+```ruby
+add_column :books, :pretty_id, :string
+add_index :books, :pretty_id
+```
+
+#### 3. Add `has_pretty_id` to your model
+```ruby
+class Book < ActiveRecord::Base
+  has_pretty_id
+end
+```
+
+## Options
+```ruby
+class Book < ActiveRecord::Base
+  has_pretty_id column: :another_string_column,   # default: :pretty_id
+                length: 12                        # default: 8
+end
+```
+
+## Warnings
+
+Pretty IDs are generated using the [Bignum#to_s](http://www.ruby-doc.org/core-2.1.1/Bignum.html#method-i-to_s) method, and since we're seeding with a random value, there's no guarantee that they'll always be 8 characters long. However, the IDs are always checked against existing values in the database to ensure uniqueness.
+
+[0]: http://img.shields.io/travis/dobtco/pretty_id.svg
+[1]: http://img.shields.io/codeclimate/github/dobtco/pretty_id.svg
+[2]: http://img.shields.io/coveralls/dobtco/pretty_id.svg
+[3]: http://img.shields.io/gem/v/pretty_id.svg

data/gemfiles/rails_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "3.2.7"
+
+gemspec :path => "../"

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "4.1.0"
+
+gemspec :path => "../"

data/lib/pretty_id/core.rb

@@ -0,0 +1,31 @@
+module PrettyId
+  module Core
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_pretty_id(options = {})
+        default_options = {
+          column: :pretty_id,
+          length: 8
+        }
+
+        options = default_options.merge(options)
+
+        define_method(:"generate_#{options[:column]}") do
+          new_pretty_id = loop do
+            random_pretty_id = rand(36**options[:length]).to_s(36)
+            exists_hash = {}
+            exists_hash[options[:column]] = random_pretty_id
+            break random_pretty_id unless self.class.exists?(exists_hash)
+          end
+
+          self.send "#{options[:column]}=", new_pretty_id
+        end
+
+        before_create :"generate_#{options[:column]}"
+      end
+    end
+  end
+end

data/lib/pretty_id/version.rb

@@ -0,0 +1,3 @@
+module PrettyId
+  VERSION = '0.0.1'
+end

data/lib/pretty_id.rb

@@ -0,0 +1,2 @@
+require 'pretty_id/core'
+ActiveRecord::Base.send :include, PrettyId::Core

data/pretty_id.gemspec

@@ -0,0 +1,28 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "pretty_id/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = "pretty_id"
+  s.version = PrettyId::VERSION
+
+  s.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+  s.authors = ['Adam Becker']
+  s.summary = 'Add random, unique "pretty" ids to your ActiveRecord models.'
+  s.email = 'adam@dobt.co'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {features,spec}/*`.split("\n")
+
+  s.homepage = 'http://github.com/dobtco/pretty_id'
+
+  s.add_dependency 'rails'
+
+  s.add_development_dependency 'appraisal', '1.0.0'
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/pretty_id_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class UserWithPrettyId < ActiveRecord::Base
+  self.table_name = 'users'
+  has_pretty_id
+end
+
+class UserWithPrettyIdAlt < ActiveRecord::Base
+  self.table_name = 'users'
+  has_pretty_id column: :pretty_id_alt
+end
+
+describe PrettyId do
+  it 'assigns before creation' do
+    u = UserWithPrettyId.new
+    expect(u.pretty_id).to be_nil
+    u.save
+    expect(u.pretty_id).to_not be_nil
+  end
+
+  it 'does not change' do
+    u = UserWithPrettyId.create
+    original_pretty_id = u.pretty_id
+    u.update_attributes(pretty_id_alt: 'foo')
+    expect(u.reload.pretty_id).to eq original_pretty_id
+  end
+
+  it 'can assign to other columns' do
+    u = UserWithPrettyIdAlt.create
+    expect(u.pretty_id).to be_blank
+    expect(u.pretty_id_alt).to be_present
+  end
+
+  describe 'preventing duplicates' do
+    before do
+      UserWithPrettyId.stub(:exists?).and_return(true, false)
+      UserWithPrettyId.any_instance.stub(:rand).and_return(1, 2)
+    end
+
+    it 'prevents duplicates' do
+      u = UserWithPrettyId.create
+      expect(u.pretty_id).to eq '2'
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :pretty_id
+    t.string :pretty_id_alt
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  Coveralls::SimpleCov::Formatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+
+require 'rails/all'
+require 'pretty_id'
+require 'rspec/rails'
+require_relative 'setup'

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: pretty_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: rspec-rails
+  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: 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: adam@dobt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.md
+- README.md
+- gemfiles/rails_3.gemfile
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- lib/pretty_id.rb
+- lib/pretty_id/core.rb
+- lib/pretty_id/version.rb
+- pretty_id.gemspec
+- spec/pretty_id_spec.rb
+- spec/setup.rb
+- spec/spec_helper.rb
+homepage: http://github.com/dobtco/pretty_id
+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.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Add random, unique "pretty" ids to your ActiveRecord models.
+test_files:
+- spec/pretty_id_spec.rb
+- spec/setup.rb
+- spec/spec_helper.rb