has_unique_identifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8297a453b96808f1f92e967cff6c8ae331822c27
+  data.tar.gz: 247efc8edb1cfcdda610da4f2b58542e68ea0861
+SHA512:
+  metadata.gz: d2d4579fcc72ea6ef4c8675f0c5569b575f1ed5e1661b05794389ddb48471030fab903e1b6766a37590a61fbe908491595bcf0aa3fd25437b97156270fb3bac9
+  data.tar.gz: e9256637898f776c2e020b11f84aa3b0b61dc04268cad5e1ae1ca253037822f5103763fd80d4f3df281b6c529b48eb3e2f68895593a588ecb971cffd4436a3be

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Sergey Besedin
+
+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,58 @@
+# HasUniqueIdentifier
+
+[![Gem Version](https://badge.fury.io/rb/has_unique_identifier.svg)](http://badge.fury.io/rb/has_unique_identifier)
+[![Code Climate](https://codeclimate.com/github/kressh/has_unique_identifier/badges/gpa.svg)](https://codeclimate.com/github/kressh/has_unique_identifier)
+
+This gem provides unique identifier generation
+
+Supporting ORM are ActiveRecord and Sequel (through [sequel-rails](https://github.com/TalentBox/sequel-rails) gem)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'has_unique_identifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_unique_identifier
+
+## Usage
+
+### ActiveRecord
+
+```ruby
+class User < ActiveRecord::Base
+  has_unique_identifier :sid, to_param: true
+end
+```
+
+### Sequel
+
+```ruby
+class Event < Sequel::Model
+  has_unique_identifier :id, only_numbers: true, to_param: true
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kressh/has_unique_identifier.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/has_unique_identifier.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_unique_identifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_unique_identifier"
+  spec.version       = HasUniqueIdentifier::VERSION
+  spec.authors       = ["Sergey Besedin"]
+  spec.email         = ["kr3ssh@gmail.com"]
+
+  spec.summary       = "Make random unique identifiers with ease"
+  spec.description   = ""
+  spec.homepage      = "https://github.com/kressh/has_unique_identifier"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'rails', '>= 4.0'
+end

data/lib/has_unique_identifier/class_methods.rb

@@ -0,0 +1,16 @@
+module HasUniqueIdentifier
+  module ClassMethods
+    def unique_identifier
+      @unique_identifier
+    end
+
+    def has_unique_identifier(name, opts = {})
+      raise ArgumentError if name.blank?
+
+      @unique_identifier = OpenStruct.new(
+        name: name,
+        options: opts
+      )
+    end
+  end
+end

data/lib/has_unique_identifier/instance_methods.rb

@@ -0,0 +1,43 @@
+module HasUniqueIdentifier
+  module InstanceMethods
+    DEFAULT_RANDOM_IDENTIFIER_LENGTH = 24
+
+    extend ActiveSupport::Concern
+
+    def to_param
+      if self.class.unique_identifier &&
+        self.class.unique_identifier.options[:to_param] == true
+
+        return send(self.class.unique_identifier.name)
+      end
+      super
+    end
+
+    included do
+      before_create :ensure_unique_identifier
+
+      private
+
+      def ensure_unique_identifier
+        return unless self.class.unique_identifier
+        return if self[self.class.unique_identifier.name].present?
+
+        length = self.class.unique_identifier.options[:length] ||
+          DEFAULT_RANDOM_IDENTIFIER_LENGTH
+
+        send("#{self.class.unique_identifier.name}=",
+          loop do
+            hash =
+              if self.class.unique_identifier.options[:only_numbers]
+                number_size = 10 ** length
+                SecureRandom.random_number(9 * number_size) + number_size
+              else
+                SecureRandom.hex(length)
+              end
+            break hash unless self.class.exists?(self.class.unique_identifier.name => hash)
+          end
+        )
+      end
+    end
+  end
+end

data/lib/has_unique_identifier/railtie.rb

@@ -0,0 +1,14 @@
+require 'rails/railtie'
+
+module HasUniqueIdentifier
+  class Railtie < Rails::Railtie
+
+    initializer "has_unique_identifier.setup_orm" do |app|
+      [:active_record, :sequel].each do |orm|
+        ActiveSupport.on_load orm do
+          HasUniqueIdentifier.setup_orm self
+        end
+      end
+    end
+  end
+end

data/lib/has_unique_identifier/version.rb

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

data/lib/has_unique_identifier.rb

@@ -0,0 +1,14 @@
+require 'has_unique_identifier/version'
+require 'has_unique_identifier/class_methods'
+require 'has_unique_identifier/instance_methods'
+
+require_relative 'has_unique_identifier/railtie' if defined? Rails
+
+module HasUniqueIdentifier
+  def self.setup_orm(base)
+    base.class_eval do
+      extend ClassMethods
+      include InstanceMethods
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: has_unique_identifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Besedin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: ''
+email:
+- kr3ssh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- has_unique_identifier.gemspec
+- lib/has_unique_identifier.rb
+- lib/has_unique_identifier/class_methods.rb
+- lib/has_unique_identifier/instance_methods.rb
+- lib/has_unique_identifier/railtie.rb
+- lib/has_unique_identifier/version.rb
+homepage: https://github.com/kressh/has_unique_identifier
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Make random unique identifiers with ease
+test_files: []