readable_ident 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 937571a591a4d48958a844d0add1048fa40dfc9b
+  data.tar.gz: fc4549f0079cdf7df6d0ef262a5ed742b257d613
+SHA512:
+  metadata.gz: 729d0f75604ea3f682a381e9ab00a1bd6aac3f35319beb51fca11934dedf5a1459d5dcd1861a6e8200398669432b951a735863040fa12887e877f24455966035
+  data.tar.gz: c891e9e3c184c8d7864df4daa3f59f4b3198cae83ef25010f109f233551e720d2be75d7343dd0b58c179333a762d8b63f141de4bfe0437b8f2fa9602e43a191f

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+db/test.db

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in readable_ident.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Mark Schewe
+
+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.

data/README.md

@@ -0,0 +1,55 @@
+# Readable Ident
+
+[![Build Status](https://travis-ci.org/mschewe/readable_ident.png?branch=master)](https://travis-ci.org/mschewe/readable_ident) [![Code Climate](https://codeclimate.com/github/mschewe/readable_ident.png)](https://codeclimate.com/github/mschewe/readable_ident)
+
+UUIDs are great, but not really easy to remember and compare by humans.
+At many points you might need a human readable ident, that is not the database id field.
+To use the database id might be appealing, but if you need to backup and probably restore data this is no good.
+
+This gem aims to help you generate unique short idents for ActiveRecord models.
+
+It makes it possible to autogenerate a quiet readable unique ident, that consists of an (optional) prefix and a variable amount of [a-zA-Z0-9]{n}.
+
+e.g. device-9fX compared to 170a3d59-db5d-48d4-b064-1fd127fde049
+
+For example if you decide to use the signs, there are (26*2 + 10)^3 = 238.328 possible combinations, that should be enough for most cases.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'readable_ident'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install readable_ident
+
+## Usage
+
+First create a migration to add a field to the model
+
+```rails g migration add_r_ident_to_device r_ident:string```
+
+Then add the following to your model:
+
+```
+class SomeModel < ActiveRecord::Base
+  readable_ident prefix: s, seperator: '~', length: 5
+end
+```
+
+This will automatically generate an unique ident for the field r_ident with the prefix 's', the seperator '~' and the length of 5 e.g. s~iq12xk
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/readable_ident/model_addition.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+require 'active_record'
+require 'active_support/concern'
+
+module ReadableIdent
+
+  module ModelAddition
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    @options
+
+    included do
+      validates :r_ident, presence: true, length: { minimum: 0 }
+      after_validation :generate_readable_ident
+    end
+
+    module ClassMethods
+      def readable_ident(options={})
+        attr_reader :options
+        class_attribute :options
+        self.options = options
+      end
+    end
+
+    private
+    def generate_readable_ident
+      r_ident = ''
+      while true do
+        r_ident = ReadableIdent::generate_readable_ident(self.options)
+        break if self.class.where(r_ident: r_ident).first.nil?
+      end
+      write_attribute(:r_ident, r_ident)
+    end
+
+  end
+end
+
+ActiveRecord::Base.send(:include, ReadableIdent::ModelAddition)

data/lib/readable_ident/version.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+module ReadableIdent
+  VERSION = "0.0.1"
+end

data/lib/readable_ident.rb

@@ -0,0 +1,47 @@
+# -*- encoding : utf-8 -*-
+require "readable_ident/model_addition"
+
+module ReadableIdent
+
+  @@regex_prefix    = /[a-zA-Z0-9]+|^$/
+  @@regex_seperator = /[~-]+|^$/
+
+  def self.generate_readable_ident(options={})
+    options[:length]    ||= 4
+    options[:prefix]    ||= ''
+
+    if options[:prefix].empty?
+      options[:seperator] ||= ''
+    else
+      options[:seperator] ||= '-'
+    end
+
+    self.validate_options(options)
+
+    options[:prefix].to_s + options[:seperator].to_s + random_alphanumeric(options[:length].to_i).to_s
+  end
+
+  private
+
+  def self.random_alphanumeric(length)
+    ident = ""
+    length.times { ident << (i = Kernel.rand(62); i += ((i < 10) ? 48 : ((i < 36) ? 55 : 61 ))).chr }
+    return ident
+  end
+
+  def self.validate_options(options)
+    raise ArgumentError, 'length must be numeric' \
+      unless options[:length].is_a? Numeric
+
+    raise ArgumentError, 'seperator length must be 1' \
+      unless options[:seperator].length < 2
+
+    raise ArgumentError, 'prefix is not in specified regex' \
+      if options[:prefix].match(@@regex_prefix).nil?
+
+    raise ArgumentError, 'seperator is not in specified regex' \
+      if options[:seperator].match(@@regex_seperator).nil?
+  end
+
+end
+

data/readable_ident.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'readable_ident/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "readable_ident"
+  gem.version       = ReadableIdent::VERSION
+  gem.authors       = ["Mark Schewe"]
+  gem.email         = ["schewe.mark@gmail.com"]
+  gem.description   = %q{Generates a readable ident for a given model}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/mschewe/readable_ident"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activerecord"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "factory_girl"
+  gem.add_development_dependency "debugger"
+  gem.add_development_dependency "sqlite3"
+
+end

data/spec/factories/test_class_factory.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+FactoryGirl.define do
+  factory :test_class do
+    r_ident 'abcd'
+  end
+end

data/spec/readable_ident/model_addition_spec.rb

@@ -0,0 +1,75 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+root = File.expand_path(File.join(File.dirname(__FILE__), '../..'))
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{root}/db/test.db"
+)
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+  create_table :test_classes, :force => true do |t|
+    t.string :r_ident
+  end
+end
+
+class TestClass < ActiveRecord::Base
+  readable_ident length: 10
+end
+
+
+describe ReadableIdent do
+
+  let(:test_class) { TestClass.create() }
+
+  it 'calls generates a readable_ident before validation' do
+    test_class.r_ident.should_not be_nil
+    test_class.r_ident.should_not be_empty
+    test_class.r_ident.length.should be 10
+  end
+
+  context 'creation with options' do
+
+    it 'accepts a length option' do
+      TestClass.options.merge!({length: 11})
+      test_class.r_ident.length.should be 11
+    end
+
+    it 'accepts a prefix option' do
+      TestClass.options.merge!({prefix: 'x', length: 12, seperator: '~'})
+      test_class.r_ident.length.should be 14
+      test_class.r_ident.should start_with('x~')
+    end
+
+    it 'acceps a seperator option' do
+      TestClass.options.merge!({prefix: 'y', length: 13, seperator: ''})
+      test_class.r_ident.length.should be 14
+      test_class.r_ident.should start_with('y')
+    end
+  end
+
+  context 'model validations' do
+    it 'generates unique idents' do
+      test_class_1 = FactoryGirl.build(:test_class)
+      test_class_2 = FactoryGirl.build(:test_class, r_ident: test_class_1.r_ident)
+
+      test_class_1.should be_valid
+      test_class_2.should be_valid
+
+      test_class_1.r_ident.should_not be test_class_2.r_ident
+
+    end
+
+    it 'p_ident should not be nil' do
+      test_class.r_ident = nil
+      test_class.should_not be_valid
+    end
+
+    it 'check if p_ident is empty' do
+      test_class.r_ident = ''
+      test_class.should_not be_valid
+    end
+  end
+
+end

data/spec/readable_ident/readable_ident_spec.rb

@@ -0,0 +1,72 @@
+# -*- encoding : utf-8 -*-
+require 'spec_helper'
+
+describe "generate_readable_ident" do
+
+  context 'prefix' do
+
+    it 'should be empty if not supplied' do
+      ident = ReadableIdent.generate_readable_ident(length: 10);
+      ident.length.should eq 10
+      ident.should_not start_with('-')
+    end
+
+    it 'must be in specified regex' do
+      expect { ReadableIdent.generate_readable_ident(prefix: 'ß') }.to \
+        raise_error(ArgumentError, 'prefix is not in specified regex')
+    end
+
+    it 'should start with the given prefix' do
+      ident = ReadableIdent.generate_readable_ident(prefix: 'custom_prefix')
+      ident.should start_with('custom_prefix')
+    end
+  end
+
+  context 'seperator' do
+
+    it 'should have a dash as seperator if prefix is specified' do
+      ident = ReadableIdent.generate_readable_ident(prefix: 'hello')
+      ident.should start_with('hello-')
+    end
+
+    it 'should have an empty seperator if specified and has prefix' do
+      ident = ReadableIdent.generate_readable_ident(prefix: 'hello', seperator: '', length: 10)
+      ident.should =~ /hello[a-zA-Z0-9]{10}/
+    end
+
+    it 'must have the length of 1' do
+      expect { ReadableIdent.generate_readable_ident(seperator: '123') }.to \
+        raise_error(ArgumentError, 'seperator length must be 1')
+    end
+
+    it 'must be in specified regex' do
+      expect { ReadableIdent.generate_readable_ident(seperator: "µ") }.to \
+        raise_error(ArgumentError, 'seperator is not in specified regex')
+    end
+
+    it 'should have use the supplied seperator' do
+      ident = ReadableIdent.generate_readable_ident(seperator: '~')
+      ident.should start_with('~')
+    end
+
+  end
+
+  context 'length' do
+
+    it 'should generate ident with given length' do
+      ident = ReadableIdent.generate_readable_ident(length: 22)
+      ident.length.should eq 22
+    end
+
+    it 'must be numeric or raise AgrumentError' do
+      expect { ReadableIdent.generate_readable_ident(length: 'a') }.to \
+        raise_error(ArgumentError, 'length must be numeric')
+    end
+
+    it 'should have a length of 4 if no length given' do
+      ident = ReadableIdent.generate_readable_ident
+      ident.length.should eq 4
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+require 'readable_ident'
+require 'factory_girl'
+
+FactoryGirl.find_definitions

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: readable_ident
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Schewe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: 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: factory_girl
+  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: debugger
+  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: Generates a readable ident for a given model
+email:
+- schewe.mark@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/.gitkeep
+- lib/readable_ident.rb
+- lib/readable_ident/model_addition.rb
+- lib/readable_ident/version.rb
+- readable_ident.gemspec
+- spec/factories/test_class_factory.rb
+- spec/readable_ident/model_addition_spec.rb
+- spec/readable_ident/readable_ident_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mschewe/readable_ident
+licenses: []
+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.5
+signing_key: 
+specification_version: 4
+summary: Generates a readable ident for a given model
+test_files:
+- spec/factories/test_class_factory.rb
+- spec/readable_ident/model_addition_spec.rb
+- spec/readable_ident/readable_ident_spec.rb
+- spec/spec_helper.rb