record-locator 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80227723629775954056e7bbbd872273f5569f95
+  data.tar.gz: f1a00ed1597d89c3deab8721239d363a127fa295
+SHA512:
+  metadata.gz: 15e7cb653b75d0aec890dcd18d2ebd0645bb13c57e93b361fe4934931d23fbc2565285659b6fcf611f9fb7ea19149a8f73a4486029a059b140026f06066910c2
+  data.tar.gz: 492a4d4c8792595baeba95986f1ff898986cfb6a2397b6fe36ab90d4a293f3c36f9178d2e3f4058f9262fa211813ef217d7c36d51234a3aea8ae3900c37eb3f6

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem 'rails', '~> 3.2' do
+    gem 'activerecord'
+    gem 'railties'
+  end
+  gem 'sqlite3'
+
+  gem 'rspec', '~> 2.5.0'
+end
+
+gem 'jeweler', '~> 1.8.8', :group => :development

data/Gemfile.lock

@@ -0,0 +1,133 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.15)
+      actionpack (= 3.2.15)
+      mail (~> 2.5.4)
+    actionpack (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.15)
+      activesupport (= 3.2.15)
+      builder (~> 3.0.0)
+    activerecord (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.15)
+      activemodel (= 3.2.15)
+      activesupport (= 3.2.15)
+    activesupport (3.2.15)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.15)
+      actionmailer (= 3.2.15)
+      actionpack (= 3.2.15)
+      activerecord (= 3.2.15)
+      activeresource (= 3.2.15)
+      activesupport (= 3.2.15)
+      bundler (~> 1.0)
+      railties (= 3.2.15)
+    railties (3.2.15)
+      actionpack (= 3.2.15)
+      activesupport (= 3.2.15)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.2)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.8)
+  rails (~> 3.2)
+  rspec (~> 2.5.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Abdul Barek and Ryan Alyn Porter
+
+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,68 @@
+# Introduction
+
+Remember the last time that you bought an airline ticket?  You got an email with a
+"[record locator](http://en.wikipedia.org/wiki/Record_locator)".
+When you checked in for your flight, the airline didn't make you enter "23873498712098234095723469"
+to get your boarding pass.  You entered something like "FK92B9", and your name.  The airline used
+your name and that code to find the ID.
+
+It's about usability.  If humans ever need to type Active Record database IDs into a form for some
+reason, then don't make them type a huge number, give them a short code.  (An argument can be made
+that if humans ever need to type record IDs into forms then you have bigger UX problems than the
+record ID format and probably security problems also, and this is very true.)
+
+One way to provide an easier ID to type is to use Base 36.  It takes an integer and returns a really
+short string that you can convert back to that integer again.  And it's really easy to use with
+Ruby:
+
+    12345678901.to_s(36).upcase
+    => "5O6AQT1"
+
+    "5O6AQT1".to_i(36)
+    => 12345678901
+
+The problem with "5O6AQT1" is the second character.  Is that an "O" or a "0"?  And that last
+character, is that a "1" or an "I"?  And "Q" is a land mine too.  It can look a lot like an "O" or
+"0", especially if you can't control the typeface that it's printed in.  A "5" can also look like an "S", or vice versa.  And "B" and "8" can be confused in the same way.
+
+What we really need is Base 27.  We want to use Base 36, but without the potentially confusing
+characters, "B", "8", "5", "S", "O", "0", "1", "I", or "Q".  That's the Record Locator gem.  I needed this gem and it
+didn't exist, so I commissioned the impeccable services of Mr. Abdul Barek in Bangladesh, who did a
+fantastic job.
+
+# COMPATIBILITY WARNING
+
+**WARNING:** This gem is **NOT** compatible with the
+[PHP record locator](https://github.com/jakoubek/php-recordlocator) or the
+[Perl record locator](http://search.cpan.org/~jesse/Number-RecordLocator-0.005/lib/Number/RecordLocator.pm)
+libraries.  Those libraries include potentially-confusing characters like "O" and "I".  IDs encoded
+with either of those libraries cannot be decoded using this library.
+
+# How to install
+
+Include the gem into your Gemfile:
+
+    gem 'record_locator', '1.0.0', :git => 'git@github.com:VenueDriver/record_locator.git'
+
+Then run
+
+    bundle install
+
+Suppose, you want to apply this encoding stuff on your Book Model's publisher_id then follow this way:
+
+    class Book < ActiveRecord::Base
+      extend RecordLocator
+      has_record_locator :publisher_id
+    end
+
+Now restart your server.
+
+**has_record_locator will expect Numeric field only (here publisher_id is Integer)**
+
+From your ActiveRecord model object, You can get the encoded value by calling encoded_record_locator method:
+
+    @book.encoded_record_locator
+
+You can find the ActiveRecord Model Object by passing encoded value, for example:
+
+    Blog.record_locator.find(params[:encoded_publisher_id])

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "record-locator"
+  gem.homepage = "http://github.com/VenueDriver/record-locator"
+  gem.license = "MIT"
+  gem.summary = %Q{Use Base-27 encoding to shorten ID strings for easier data entry.}
+  gem.description = %Q{A Base-36 encoding for integer database IDs without potentially confusing character pairs like 5 and S, B and 8, I and 1, O and 0, or Q}
+  gem.email = "work@endymion.com"
+  gem.authors = ["Abdul Barek", "Ryan Alyn Porter"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "record-locator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/record-locator-finder.rb

@@ -0,0 +1,24 @@
+class Finder
+
+  def initialize(model,record_locator_field)
+    @model = model
+    @record_locator_field = record_locator_field
+  end
+
+  def find(id)
+    find_all(id).first
+  end
+
+  def find_all(id)
+    # for Rails > 4.0, use ActiveRecord where method
+    #@model.where("#{@record_locator_field}=?", Util::Base::decode(id.to_s))
+
+    # supported until rails 4.0 from rails 2.3
+    records = @model.find(:all, :conditions => "#{@record_locator_field}='#{Util::Base::decode(id.to_s)}'")
+    if records.empty?
+      records = @model.find(:all, :conditions => "#{@record_locator_field}='#{id}'")
+    end
+    return records
+  end
+
+end

data/lib/record-locator-util.rb

@@ -0,0 +1,39 @@
+module Util
+
+  ENCODER = Hash.new do |h,k|
+    h[k] = Hash[ k.chars.map.enum_for(:each_with_index).to_a.map(&:reverse) ]
+  end
+  DECODER = Hash.new do |h,k|
+    h[k] = Hash[ k.chars.map.enum_for(:each_with_index).to_a ]
+  end
+
+  # 0 through 9 plus A through Z, without B8S5O0I1 or Q.
+  # "234679ACDEFGHJKLMNPRTUVWXYZ"
+  BASE27 = (('0'..'9').to_a + ('A'..'Z').to_a).delete_if{|char| char =~ /[B8S5O0I1Q]/}.join
+
+  class Base
+
+    def self.encode(value)
+      ring = Util::ENCODER[Util::BASE27]
+      base = Util::BASE27.length
+      result = []
+      until value == 0
+        result << ring[ value % base ]
+        value /= base
+      end
+      result.reverse.join
+    end
+
+    def self.decode(string)
+      string = string.to_s
+      return string if string.split('').include?('1') || string.split('').include?('0') # as 0 and 1 are included into exceptional chars
+      ring = Util::DECODER[Util::BASE27]
+      base = Util::BASE27.length
+      string.reverse.chars.enum_for(:each_with_index).inject(0) do |sum,(char,i)|
+        sum + ring[char] * base**i
+      end
+    end
+
+  end
+
+end

data/lib/record-locator.rb

@@ -0,0 +1,32 @@
+require File.expand_path(File.dirname(__FILE__) + '/record-locator-util')
+require File.expand_path(File.dirname(__FILE__) + '/record-locator-finder')
+
+module RecordLocator
+
+    def has_record_locator(reference_column)
+      @@record_locator_by = reference_column
+      self.send(:include, RecordLocator::InstanceMethods)
+    end
+
+    def get_record_locator_field
+      @@record_locator_by
+    end
+
+    def record_locator
+      Finder.new(self,get_record_locator_field)
+    end
+
+  module InstanceMethods
+
+    def record_locator_field
+      return self.class.to_s.constantize::get_record_locator_field
+    end
+
+    def encoded_record_locator
+      locator_value = self.send(record_locator_field)
+      Util::Base::encode(locator_value)
+    end
+    
+  end
+
+end

data/models/book.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../lib/record-locator')
+
+class Book < ActiveRecord::Base
+  extend RecordLocator
+  has_record_locator :publisher_id
+end

data/record-locator.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "record-locator"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Abdul Barek", "Ryan Alyn Porter"]
+  s.date = "2013-11-14"
+  s.description = "A Base-36 encoding for integer database IDs without potentially confusing character pairs like 5 and S, B and 8, I and 1, O and 0, or Q"
+  s.email = "work@endymion.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/record-locator-finder.rb",
+    "lib/record-locator-util.rb",
+    "lib/record-locator.rb",
+    "models/book.rb",
+    "record-locator.gemspec",
+    "spec/models/record-locator_spec.rb",
+    "spec/schema.rb",
+    "spec/spec_helper.rb",
+    "tddium.yml"
+  ]
+  s.homepage = "http://github.com/VenueDriver/record-locator"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.6"
+  s.summary = "Use Base-27 encoding to shorten ID strings for easier data entry."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rails>, ["~> 3.2"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.8"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.2"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.8"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.2"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.8"])
+  end
+end
+

data/spec/models/record-locator_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+require File.expand_path(File.dirname(__FILE__) + '../../../lib/record-locator-util')
+require File.expand_path(File.dirname(__FILE__) + '../../../models/book')
+
+describe 'RecordLocator' do
+
+  describe 'EncoderAndDecoder' do
+
+    it "Should produce an encoded ID that the original ID can be recovered from" do
+      100000.times do
+        original = rand(999999999999999)
+        encoded = Util::Base::encode(original)
+        decoded = Util::Base::decode(encoded)
+        original.should == decoded
+      end
+    end
+
+    it "Should not contain potentially-confusing characters (l,1,0,O,Q) after encode" do
+      100000.times do
+        original = rand(999999999999999)
+        encoded = Util::Base::encode(original)
+        encoded = encoded.split("")
+        encoded.include?('l').should == false
+        encoded.include?('1').should == false
+        encoded.include?('0').should == false
+        encoded.include?('O').should == false
+        encoded.include?('Q').should == false
+      end
+    end
+
+    it "Should not produce any collisions." do
+      originals = {}
+      encodeds = {}
+      100000.times do
+        original = rand(999999)
+        next if originals.has_key? original
+        originals[original] = true
+        encoded = Util::Base::encode(original)
+        encodeds.has_key?(encoded).should == false
+        encodeds[encoded] = true
+      end
+    end
+
+  end
+
+  before(:each) do
+    @book = Book.find_or_create_by_publisher_id rand(999999999999999)
+  end
+
+  it "Should return defined record locator filed" do
+    @book.record_locator_field.should == :publisher_id
+  end
+
+  it "Should not have record locator field nil" do
+    @book.encoded_record_locator.should_not be_nil
+  end
+
+  it "Should equal ActiveRecord locator decoded value with original ActiveRecord field value" do
+    @book.publisher_id.should == Util::Base::decode(Util::Base::encode(@book.publisher_id))
+  end
+
+  it "Should Return class type Finder" do
+    Book.record_locator.class.to_s.should == 'Finder'
+  end
+
+  it "Should Return class type Book" do
+    encoded_field = @book.encoded_record_locator
+    @book.class.should == Book.record_locator.find(encoded_field).class
+  end
+
+  it "Should return Original ActiveRecord Object found by defined encoded filed instead of Active record finder" do
+    encoded_field = @book.encoded_record_locator
+    @book.should === Book.record_locator.find(encoded_field)
+  end
+
+  it "Should return Activerecord Object by passing normal id instead of passing encoded id" do
+    publisher_id = @book.publisher_id
+
+    @book.should === Book.record_locator.find(publisher_id)
+  end
+
+
+end

data/spec/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 20131015114743) do
+
+  create_table "books", :force => true do |t|
+    t.integer "id"
+    t.integer "publisher_id"
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+require "yaml"
+require 'active_record'
+require 'active_support'
+
+RSpec.configure do |config|
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ':memory:')
+  load "spec/schema.rb"
+  ActiveRecord::Base.connection
+end

data/tddium.yml

@@ -0,0 +1,3 @@
+:tddium:
+  :ruby_version: ruby-2.0.0
+  :bundler_version: 1.3.5

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: record-locator
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Abdul Barek
+- Ryan Alyn Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.8
+description: A Base-36 encoding for integer database IDs without potentially confusing
+  character pairs like 5 and S, B and 8, I and 1, O and 0, or Q
+email: work@endymion.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/record-locator-finder.rb
+- lib/record-locator-util.rb
+- lib/record-locator.rb
+- models/book.rb
+- record-locator.gemspec
+- spec/models/record-locator_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb
+- tddium.yml
+homepage: http://github.com/VenueDriver/record-locator
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Use Base-27 encoding to shorten ID strings for easier data entry.
+test_files: []