prettyid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5f1d1eaec32642fac2fb8040eab5029eba0e11dac498e661ee1f220c8628f32e
+  data.tar.gz: 56399f1ad4530619fbda6e71cced771336c351ddb4704a9062c127ec03c87813
+SHA512:
+  metadata.gz: 7d4bb5c9a4676b3454d9e30d93d46c9d9c90a298ba0e1197896504b91150c454c37dc1711ace222135e847005de2a7822b1d38f479814c5acd74bf475cc82b8c
+  data.tar.gz: 6a1930e2c2cec62139a846f0c6456c90d13f3a76e433275e7a2e39742af991fec9a5d442cd48777b2c2d9b624bb10389c95a29446006543555a7aa43d67b86b5

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pretty_id.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    pretty_id (0.1.0)
+      activerecord (>= 4.2.0)
+      activesupport (>= 4.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pretty_id!
+  rake
+  rspec
+  sqlite3
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,100 @@
+# PrettyId
+
+How does Stripe generate object ids?
+
+**[Patrick Collison](https://twitter.com/patrickc)**, Stripe CEO:
+> They're randomly generated by our Ruby application code. We use the ```ch_```-style prefixes because we find it really useful to be able to immediately recognize the type of an ID when looking at logs or stacktraces.
+
+[source](https://www.quora.com/How-does-Stripe-generate-object-ids)
+
+With PrettyId you can generate Stripe-like IDs for your ActiveRecord models.
+
+## Usage
+
+For each model when you create table inside migration, you have to:
+
+1. tell AR to not automatically add primary key column.
+1. create ```id``` column as string
+2. add unique index for ```id``` column
+
+```
+create_table :users, id: false do |t|
+  t.string :id, null: false
+
+  # your other columns
+end
+
+add_index(:users, :id, unique: true)
+```
+
+Inside model class just include PrettyId module:
+
+```
+class User < ActiveRecord::Base
+  include PrettyId
+end
+```
+
+By default first 3 letters of model class will be taken as id prefix. You can change it by specifying your own value:
+
+```
+class User < ActiveRecord::Base
+  include PrettyId
+
+  self.id_prefix = 'usr'
+end
+```
+
+Or, if you want to add some tricky logic for id prefix (let's say for test account it should be ```acc_test``` and for live account it should be ```acc_live```) you can provide a Proc that will return id prefix:
+
+```
+class Account < ActiveRecord::Base
+  include PrettyId
+
+  attr_accessor :type
+
+  self.id_prefix = -> (model) { model.type == 'test' ? 'acc_test' : 'acc_live' }
+end
+
+account = Account.new
+account.type = 'test'
+account.save
+
+account.id #=> acc_test_....
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prettyid', require: 'pretty_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prettyid
+
+
+
+## Perfomance
+
+If you care about performance, it's better to measure it yourself :) I have measured method that generates id (```rake bm```). Here are results for 1M calls:
+
+                            user        system    total       real
+    PrettyId::Generator#id: 12.880000   0.020000  12.900000 ( 12.907587)                       
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alovak/pretty_id.
+
+## License
+
+This code is available under [MIT license](/LICENSE).
+
+&copy; Pavel Gabriel, 2018

data/Rakefile

@@ -0,0 +1,24 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'benchmark'
+require 'pretty_id'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+task :bm do
+  n = 1_000_000
+
+  class One
+    def self.id_prefix
+      'one'
+    end
+  end
+
+  generator = PrettyId::Generator.new(One.new)
+
+  Benchmark.bm(20) do |x|
+    x.report("PrettyId::Generator#id:")   { n.times { generator.id } }
+  end
+end

data/bin/console

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

@@ -0,0 +1,25 @@
+module PrettyId
+  class Generator
+    attr_reader :record
+
+    def initialize(record)
+      @record = record
+    end
+
+    def id
+      "#{prefix}_#{SecRandom.alphanumeric(length)}"
+    end
+
+    def length
+      12
+    end
+
+    def prefix
+      if record.class.id_prefix.is_a? Proc
+        record.class.id_prefix.call(record)
+      else
+        record.class.id_prefix
+      end
+    end
+  end
+end

data/lib/pretty_id/sec_random.rb

@@ -0,0 +1,42 @@
+require 'securerandom'
+
+module PrettyId
+  # taken from Ruby 2.5 implementation
+  class SecRandom
+    ALPHANUMERIC = [*'A'..'Z', *'a'..'z', *'0'..'9']
+
+    def self.alphanumeric(n=nil)
+      n = 16 if n.nil?
+      choose(ALPHANUMERIC, n)
+    end
+
+    def self.choose(source, n)
+      size = source.size
+      m = 1
+      limit = size
+      while limit * size <= 0x100000000
+        limit *= size
+        m += 1
+      end
+      result = ''.dup
+      while m <= n
+        rs = SecureRandom.random_number(limit)
+        is = rs.digits(size)
+        (m-is.length).times { is << 0 }
+        result << source.values_at(*is).join('')
+        n -= m
+      end
+      if 0 < n
+        rs = SecureRandom.random_number(limit)
+        is = rs.digits(size)
+        if is.length < n
+          (n-is.length).times { is << 0 }
+        else
+          is.pop while n < is.length
+        end
+        result.concat source.values_at(*is).join('')
+      end
+      result
+    end
+  end
+end

data/lib/pretty_id/version.rb

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

data/lib/pretty_id.rb

@@ -0,0 +1,35 @@
+require "pretty_id/version"
+require "pretty_id/sec_random"
+require "pretty_id/generator"
+require 'active_support/concern'
+
+module PrettyId
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def id_prefix=(prefix)
+      @id_prefix = prefix
+    end
+
+    def id_prefix
+      @id_prefix || name.downcase[0, 3]
+    end
+  end
+
+  def _create_record(*)
+    attempt ||= 1
+    set_pretty_id
+    super
+  rescue ActiveRecord::RecordNotUnique => e
+    attempt += 1
+    retry if attempt < 4
+
+    raise
+  end
+
+  private
+
+  def set_pretty_id
+    self.id = PrettyId::Generator.new(self).id
+  end
+end

data/pretty_id.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pretty_id/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "prettyid"
+  spec.version       = PrettyId::VERSION
+  spec.authors       = ["Pavel Gabriel"]
+  spec.email         = ["alovak@gmail.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Generate Stripe-like ids for your ActiveRecord models}
+  spec.description   = %q{Generate Stripe-like ids for your ActiveRecord models}
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "activerecord", ">= 4.2.0"
+  spec.add_dependency "activesupport", ">= 4.2.0"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: prettyid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pavel Gabriel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Generate Stripe-like ids for your ActiveRecord models
+email:
+- alovak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pretty_id.rb
+- lib/pretty_id/generator.rb
+- lib/pretty_id/sec_random.rb
+- lib/pretty_id/version.rb
+- pretty_id.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Generate Stripe-like ids for your ActiveRecord models
+test_files: []