unique_id 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDY2MWMyMDNlNjRlY2U1MWJjNjY4NDM3MjRjNTJkN2E5MmRmMDNjNw==
+  data.tar.gz: !binary |-
+    YzY5ZWEyMzE5NjIwZmJkYjZlZWJiYTA0ZTIxMGJiYzg4OWM5MzIyYg==
+SHA512:
+  metadata.gz: !binary |-
+    OGM1YjcxZmIwNmFkZjM3YzExM2EzMGFlZDNlY2U1MzM5Zjg1ZTE5Mjk5YmEz
+    MDQ4NzYxMzQyZWZkMmFlMWRiZDJlZjE1NDEyODJhZjc3N2JlMWYwZDAwNjUx
+    NzcxNWUzNGJmODNlYTBhZTZjZjU0YTFlN2VhOTllZWRhZWI0MGE=
+  data.tar.gz: !binary |-
+    NTZiOWRlYjU2YjU0NTIyMjcyNmUyZjYwN2YyYzQ1NWZmZmZmM2M1MjM0ZmMx
+    MzNlZWYxNjMxYzgwZTEwNDMyMzJlYzQwOTMyZDUyN2VhM2NlNTk0YmNkM2Ji
+    NjJlYzc1Y2JiNDMxMjU1NTAyYTUwNTczY2I4NTc3Y2Y3NjgwY2Q=

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/internal/db/*.sqlite3
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+unique-id

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p484

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=postgresql
+before_script:
+  - mysql -e 'create database myapp_test'
+  - psql -c 'create database myapp_test' -U postgres

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in unique_id.gemspec
+gemspec
+
+group :test do
+  gem 'sqlite3'
+  gem 'mysql2'
+  gem 'pg'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Christian Aust
+
+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,95 @@
+# UniqueId
+
+[![Build Status](https://travis-ci.org/datenimperator/unique-id.svg?branch=master)](https://travis-ci.org/datenimperator/unique-id)
+
+This ActiveRecord extension keeps track of number ranges and easily creates valid sequential formatted identifiers which could be used for invoices, orders, personnel numbers and the like. Did you ever want to generate invoice IDs like this?
+
+* INV-0001
+* INV-0002
+* INV-0002
+
+That's what UniqueId does. It support multiple independent number ranges, each of them can be scoped and formatted as needed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'unique_id'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unique_id
+
+### Requirements
+
+The gem has been tested with these configurations:
+
+* MRI Ruby 1.9.3, 2.0.0 and 2.1.1
+* sqlite3, mySQL or PostgreSQL
+* ActiveRecord 3.1 and higher
+
+## Usage
+
+Create a database attribute which will hold the id, and activate unique_id to use it:
+
+````ruby
+class Invoice
+  has_unique :inv_id
+end
+````
+
+In this example, `inv_id` is the attribute of our model `Invoice` which will hold the id once it has been created. It needs to be a string attribute, your application is responsible for creating and indexing it as appropriate.
+
+There are some options that can be set. These are the defaults:
+
+````ruby
+class Invoice
+  has_unique :inv_id,
+  	start: 1,
+  	scoped_by: nil,
+  	formatter: nil
+end
+````
+
+#### start
+
+Numbering starts with this value for each number range. Can be set per model.
+
+#### scoped_by
+
+A number is guaranteed to be unique within a *scope*. While the default is blank, this could be used for revolving number ranges, eg. to start over the numbers each year:
+
+````ruby
+class Invoice
+  has_unique :inv_id,
+  	scoped_by: proc { Time.now.year }
+end
+````
+
+The scope will be set to the return value of the proc and will be evaluated every time a new identifier is generated. In this example numbering will start over each year.
+
+#### formatter
+
+By default a unique_id will simple be an integer value. You can define a formatter to make it look however you like:
+
+````ruby
+class Invoice
+  has_unique :inv_id,
+  	formatter: proc { |scope, value| sprintf("INV-%04d", value) }
+end
+````
+
+Like this, the `uid` attribute will be filled with values `INV-0001`, `INV-0002`, `INV-0003`…
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/unique_id/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/unique_id/base.rb

@@ -0,0 +1,46 @@
+require 'active_support/concern'
+
+module UniqueId
+  module Base
+    extend ActiveSupport::Concern
+
+    included do
+      before_create :generate_unique
+    end
+
+    def unique_type
+      self.class.to_s
+    end
+
+    def unique_scope
+      if scope = self.class.unique.scope
+        @unique_scope ||= case scope
+          when Symbol then self.send(scope)
+          when Proc   then self.instance_exec(&scope)
+          else scope
+        end
+      end
+    end
+
+    def unique_format(value)
+      if f = self.class.unique.formatter
+        return self.instance_exec(self.unique_scope, value, &f)
+      end
+      value
+    end
+
+    def generate_unique
+      value = unique_format(self.class.unique.next(scope:self.unique_scope, type:self.unique_type))
+      write_attribute self.class.unique.attribute, value
+    end
+
+    module ClassMethods
+      attr_accessor :unique
+
+      def has_unique(*args)
+        opts = args.extract_options!
+        @unique = ::Unique::Generator.new(args.first, opts)
+      end
+    end
+  end
+end

data/lib/unique_id/engine.rb

@@ -0,0 +1,11 @@
+require 'rails/engine'
+
+module UniqueId
+  class Engine < Rails::Engine
+    engine_name :unique_id
+
+    ActiveSupport.on_load :active_record do
+      include ::UniqueId::Base
+    end
+  end
+end

data/lib/unique_id/generator.rb

@@ -0,0 +1,46 @@
+module Unique
+  class Generator
+    attr_reader :attribute
+
+    DEFAULT = {
+      start: 1,
+      scoped_by: nil,
+      formatter: nil
+    }
+
+    def initialize(attribute, opts={})
+      @attribute = attribute
+      @opts = DEFAULT.merge(opts)
+    end
+
+    def scope
+      @opts[:scoped_by]
+    end
+
+    def formatter
+      @opts[:formatter]
+    end
+
+    def next(opts)
+      _scope = opts[:scope].nil? ? nil : opts[:scope].to_s
+      _type  = opts[:type]
+
+      table = Arel::Table.new(:unique_ids)
+      query = table
+        .project( table[:value].maximum.as('v1') )
+        .where( table[:type].eq(_type).and(table[:scope].eq(_scope)) )
+      result = ActiveRecord::Base.connection.execute(query.to_sql).first
+      max = result.is_a?(Hash) ? result['v1'] : result[0]
+
+      next_value = max.nil? ? @opts[:start] : max.to_i + 1
+
+      ins_query = table.create_insert
+      ins_query.into table
+      ins_query.insert table[:type]=>_type, table[:scope]=>_scope, table[:value]=>next_value
+      result = ActiveRecord::Base.connection.insert(ins_query, nil, nil, next_value)
+      raise "Unexpected result: #{result}" unless result == next_value
+
+      next_value
+    end
+  end
+end

data/lib/unique_id/version.rb

@@ -0,0 +1,3 @@
+module UniqueId
+  VERSION = "0.0.1"
+end

data/lib/unique_id.rb

@@ -0,0 +1,4 @@
+require 'unique_id/version'
+require 'unique_id/base'
+require 'unique_id/generator'
+require 'unique_id/engine'

data/spec/internal/config/database.yml

@@ -0,0 +1,28 @@
+sqlite: &sqlite
+  adapter: sqlite3
+  database: db/<%= Rails.env %>.sqlite3
+
+mysql: &mysql
+  adapter: mysql2
+  username: root
+  password:
+  database: myapp_<%= Rails.env %>
+
+postgresql: &postgresql
+  adapter: postgresql
+  username: postgres
+  password:
+  database: myapp_<%= Rails.env %>
+  min_messages: ERROR
+
+defaults: &defaults
+  pool: 5
+  timeout: 5000
+  host: localhost
+  <<: *<%= ENV['DB'] || "sqlite" %>
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define do
+  create_table(:unique_ids, id:false, force:true) do |t|
+    t.string :type, default:nil, null:false
+    t.string :scope
+    t.integer :value, default:nil, null:false
+  end
+  add_index :unique_ids, [:type, :scope, :value], unique: true
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/lib/unique_id_spec.rb

@@ -0,0 +1,87 @@
+require "spec_helper"
+
+describe UniqueId do
+
+  it "should be set" do
+    build_model :invoice do
+      string :inv_id
+      has_unique :inv_id
+    end
+
+    inv = Invoice.create
+    inv.inv_id.should_not be_nil
+  end
+
+  it "can have a different start value" do
+    build_model :invoice do
+      string :inv_id
+      has_unique :inv_id,
+        start:1000
+    end
+
+    inv = Invoice.create
+    inv.inv_id.should == 1000
+  end
+
+  it "handles multiple models" do
+    build_model :model1 do
+      string :uid
+      has_unique :uid
+    end
+
+    build_model :model2 do
+      string :uid
+      has_unique :uid
+    end
+
+    m1_1 = Model1.create
+    m1_2 = Model1.create
+    m2 = Model2.create
+
+    m1_1.uid.should == 1
+    m1_2.uid.should == 2
+    m2.uid.should == 1
+  end
+
+  it "formats the unique value" do
+    build_model :model3 do
+      string :uid
+      has_unique :uid,
+        scoped_by: proc { Time.now.year },
+        formatter: proc { |scope, value| sprintf("inv_%4d_%04d", scope, value) }
+    end
+
+    m = Model3.create
+    m.uid.should == "inv_#{Time.now.year}_0001"
+  end
+
+  context "with scopes" do
+    it "supports scopes given as procs" do
+      build_model :model4 do
+        string :uid
+        has_unique :uid,
+          scoped_by: proc { Time.now.year }
+      end
+
+      m = Model4.create
+      m.uid.should == 1
+    end
+
+    describe "scopes can access the current instance" do
+      build_model :model5 do
+        string :uid
+        has_unique :uid,
+          scoped_by: :current_year
+
+        def current_year
+          Time.now.year
+        end
+      end
+
+      m = Model5.create
+      m.uid.should == 1
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+
+require 'bundler'
+
+Bundler.require :default, :development
+
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+Combustion.initialize! :active_record
+
+require 'rspec/rails'
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.include ActsAsFu
+  config.use_transactional_fixtures = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+

data/unique_id.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'unique_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "unique_id"
+  spec.version       = UniqueId::VERSION
+  spec.authors       = ["Christian Aust"]
+  spec.email         = ["git@kontakt.software-consultant.net"]
+  spec.summary       = %q{An ActiveRecord extension which creates unique, sequentially numbered values.}
+  spec.description   = %q{This extension creates values which can be used for invoice numbers, personnel numbers and the like.}
+  spec.homepage      = "https://github.com/datenimperator/unique-id"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 3.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "acts_as_fu"
+  spec.add_development_dependency "rspec-rails"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: unique_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Christian Aust
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: combustion
+  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: acts_as_fu
+  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'
+description: This extension creates values which can be used for invoice numbers,
+  personnel numbers and the like.
+email:
+- git@kontakt.software-consultant.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/unique_id.rb
+- lib/unique_id/base.rb
+- lib/unique_id/engine.rb
+- lib/unique_id/generator.rb
+- lib/unique_id/version.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/unique_id_spec.rb
+- spec/spec_helper.rb
+- unique_id.gemspec
+homepage: https://github.com/datenimperator/unique-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: '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: An ActiveRecord extension which creates unique, sequentially numbered values.
+test_files:
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/lib/unique_id_spec.rb
+- spec/spec_helper.rb