uniq_number_id 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1902e9dee1b699cf3e754a3df3e5fda63a5f1ff6
+  data.tar.gz: b4f4d49d8f66583d2f0bdc9776f3f2e1c7bda3c5
+SHA512:
+  metadata.gz: 0bc7a10bccdea1f18ed453478cb766dbbff382a1b7b8026a2db71a0c49fd981830167df1a8e63ed14d0496e20df78621fb1f4618599281e7a89132f8fb409c57
+  data.tar.gz: 7eb44c96e57de0ae458bff94da1b63c69f760aa2201d524d36abd3ef11ae44260567bce7a0e38da5d08484e6dcc075535b3bea5101cc42bf0a99304c9eef91ba

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Yuan He
+
+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,43 @@
+# UniqNumberId
+
+Create uniques random number id for any model in ruby on rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'uniq_number_id'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install uniq_number_id
+
+## Usage
+
+Example using Active Record:
+
+```ruby
+# Schema: User(member_number:integer)
+class User < ActiveRecord::Base
+uniq_number_id :member_number, length: 5 # default length 8
+end
+
+user = User.new
+user.save
+user.member_number # => 17263
+user.renew_member_number # => true, will update member_number with a new number
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/uniq_number_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,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  puts 'no rspec available'
+end

data/lib/uniq_number_id/version.rb

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

data/lib/uniq_number_id.rb

@@ -0,0 +1,62 @@
+require "active_model"
+require 'securerandom'
+require "uniq_number_id/version"
+
+module UniqNumberId
+  extend ActiveSupport::Concern
+
+  # Example using Active Record:
+  #
+  #   # Schema: User(member_number:integer)
+  #   class User < ActiveRecord::Base
+  #     uniq_number_id :member_number, length: 5
+  #   end
+  #
+  #   user = User.new
+  #   user.save
+  #   user.member_number # => 17263
+  #   user.renew_member_number # => true, will update member_number with a new number
+  #
+
+  module ClassMethods
+    def uniq_number_id(*args)
+      include InstanceMethodsOnCallback
+      cattr_accessor :number_columns, :options
+      options = args.extract_options!
+
+      length = options.fetch(:length, 8)
+      bytes = ((length*3.0)/2.0)
+      bytes = 8 if bytes < 8
+
+      args.each do |attr|
+        define_method("renew_#{attr}") do
+          send(:generate_uniq_number_id, attr, bytes, length)
+          save
+        end
+      end
+
+      before_create do
+        args.each do |attr|
+          self.generate_uniq_number_id(attr, bytes, length)
+        end
+      end
+    end
+  end
+
+  module InstanceMethodsOnCallback
+    #TODO: support generate random number bases on attr type
+    #      for example, if attr DB type is integer, then generate integer
+    #                   if attr DB type is String, then generate hex string
+    def generate_uniq_number_id(attr, bytes, length)
+      self.send("#{attr}=", loop do
+                  random_number = SecureRandom.random_bytes(bytes).unpack('N')[0]
+                  random_number = random_number.to_s[0..length-1].to_i
+                  break random_number unless self.class.exists?(attr => random_number)
+                end)
+    end
+  end
+
+  ActiveSupport::on_load(:active_record) do
+    include UniqNumberId
+  end
+end

data/spec/models/course.rb

@@ -0,0 +1,17 @@
+class Course
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include UniqNumberId
+
+  define_model_callbacks :create
+  attr_accessor :course_code
+  uniq_number_id :course_code, length: 10
+
+  def self.exists?(attrs)
+    false
+  end
+
+  def save
+    true
+  end
+end

data/spec/models/user.rb

@@ -0,0 +1,17 @@
+class User
+  extend ActiveModel::Callbacks
+  include ActiveModel::Validations
+  include UniqNumberId
+
+  define_model_callbacks :create
+  attr_accessor :member_number
+  uniq_number_id :member_number, length: 8
+
+  def self.exists?(attrs)
+    false
+  end
+
+  def save
+    true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'uniq_number_id'
+require_relative 'models/user'
+require_relative 'models/course'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/uniq_number_id_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'uniq number id' do
+  before(:each) do
+    @user = User.new
+    @user.run_callbacks :create
+    @course = Course.new
+    @course.run_callbacks :create
+  end
+
+  it 'should has uniq number id' do
+    expect(@user.member_number).to be_a Fixnum
+    expect(@course.course_code).to be_a Fixnum
+  end
+
+  it 'should uniq number id has length 8 by default' do
+    expect(@user.member_number.to_s.length).to eq(8)
+  end
+
+  it 'should custom uniq number length' do
+    expect(@course.course_code.to_s.length).to eq(10)
+  end
+
+  it 'should renew uniq number id' do
+    old_num = @user.member_number
+    expect(@user.renew_member_number).to be true
+    expect(@user.member_number).not_to eq(old_num)
+  end
+end

data/uniq_number_id.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uniq_number_id/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'uniq_number_id'
+  spec.version       = UniqNumberId::VERSION
+  spec.authors       = ['Yuan He']
+  spec.email         = ['lendage@gmail.com']
+  spec.summary       = %q{Create uniques random number id for any model in ruby on rails.}
+  spec.description   = %q{Add to your models an easily way to generate uniq numbers}
+  spec.homepage      = 'https://git.llsapp.com/yuan/uniq_number_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 'activemodel', '~> 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: uniq_number_id
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuan He
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Add to your models an easily way to generate uniq numbers
+email:
+- lendage@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/uniq_number_id.rb
+- lib/uniq_number_id/version.rb
+- spec/models/course.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/uniq_number_id_spec.rb
+- uniq_number_id.gemspec
+homepage: https://git.llsapp.com/yuan/uniq_number_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: Create uniques random number id for any model in ruby on rails.
+test_files:
+- spec/models/course.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+- spec/uniq_number_id_spec.rb
+has_rdoc: