attr_uuid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 203bfad60d62588e004febd0e0da42650e7d5f07
+  data.tar.gz: a97228bf96e15b6016f8e718fa0da4decc9a0078
+SHA512:
+  metadata.gz: 7b2a471a2ca67c0d1085242449b8d7e74d943bd1a3ddfca08dce40598ff8004ec7174c5aa9e3b70e6ebc82f6748d56be2cbb0254cdc5cc02492aa8caf63d9df4
+  data.tar.gz: b653111918be2f358917c557393e9160796b009d367e32a332f5e9eb814b2883e581282270f94a34128e36ba442d7c38ee976658b685e58a9b44dcb6be79f9e4

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+*.swp
+.bundle
+.config
+.rspec
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/config/database.json
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundle/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem "json", "~> 1.7.7"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shou Takenaka
+
+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,66 @@
+# attr\_uuid
+
+attr\_uuid makes binary uuid attribute easy to use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'attr_uuid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install attr_uuid
+
+## Usage
+
+1. In a migration file, prevent generate id column and add uuid column (tinyblob).
+
+        class CreateUsers < ActiveRecord::Migration
+            def up
+                create_table :users, :id => false do |t|
+                    t.column :uuid, :tinyblob
+                    t.string :user_name
+                end
+                execute "ALTER TABLE users ADD PRIMARY KEY (`uuid`(16))"
+            end
+            def down
+                drop_table :users
+            end
+        end
+
+2. Change primary\_key to uuid, and call `attr_uuid` method in a model class.  When you pass `autofill: true` to `attr_uuid`, it hooks `before_create` callback to set automatically generated uuid as 16 byte binary data to id attirbute.
+
+        class User < ActiveRecord::Base
+            self.primary_key = "uuid"
+            attr_uuid :id, column_name: "uuid", autofill: true
+        end
+
+3. `attr_uuid` adds `#hex_id`, `#hex_id=`, `#formatted_id` and `#formatted_id=` to the model to refer formatted uuid.
+
+        user = User.create(:user_name => "foo")
+        user.id  #=> "3~\x05v\xCBfAQ\xA2\xE1\xE0\xFC\x04\xFB3\xD1"
+        user.hex_id  #=> "337e0576cb664151a2e1e0fc04fb33d1"
+        user.formatted_id  #=> "337e0576-cb66-4151-a2e1-e0fc04fb33d1"
+
+        user.hex_id = "9f648b40fa6e11e3a3ac0800200c9a66"
+        user.id  #=> "\x9Fd\x8B@\xFAn\x11\xE3\xA3\xAC\b\x00 \f\x9Af"
+        user.formatted_id  #=> "9f648b40-fa6e-11e3-a3ac-0800200c9a66"
+
+
+5. `attr_uuid` also adds `.find_by_hex_id` and `.find_by_formatted_id` method to retrive model from data store with an uuid string.
+
+        User.find_by_hex_id("337e0576cb664151a2e1e0fc04fb33d1")
+        User.find_by_formatted_id("337e0576-cb66-4151-a2e1-e0fc04fb33d1")
+
+## 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 @@
+require "bundler/gem_tasks"

data/attr_uuid.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'attr_uuid/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "attr_uuid"
+  gem.version       = AttrUuid::VERSION
+  gem.authors       = ["Shou Takenaka"]
+  gem.email         = ["sasaminn@gmail.com"]
+  gem.description   = %q{This gem makes binary uuid attribute easy to use}
+  gem.summary       = %q{Easy to use binay uuid attribute}
+  gem.homepage      = ""
+
+  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_dependency "uuidtools"
+
+  gem.add_development_dependency "mysql2"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "with_model"
+end

data/lib/attr_uuid.rb

@@ -0,0 +1,82 @@
+require "attr_uuid/version"
+require "active_record"
+require "uuidtools"
+
+module AttrUuid
+  require "attr_uuid/railtie" if defined?(Rails)
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def attr_uuid(name, options = {})
+      name = name.to_s if name.is_a?(Symbol)
+      column_name = (options[:column_name] || name)
+      column_name = column_name.to_s if column_name.is_a?(Symbol)
+
+      if !name.is_a?(String) || !column_name.is_a?(String)
+        return
+      end
+
+      define_method "formatted_#{name}" do
+        binary = self.send(column_name)
+        if binary.nil?
+          return nil
+        else
+          return UUIDTools::UUID.parse_raw(binary).to_s
+        end
+      end
+
+      define_method "formatted_#{name}=" do |value|
+        uuid = UUIDTools::UUID.parse(value)
+        self.send("#{column_name}=", uuid.raw)
+      end
+
+      define_method "hex_#{name}" do
+        binary = self.send(column_name)
+        if binary.nil?
+          return nil
+        else
+          return UUIDTools::UUID.parse_raw(binary).hexdigest
+        end
+      end
+
+      define_method "hex_#{name}=" do |value|
+        uuid = UUIDTools::UUID.parse_hexdigest(value)
+        self.send("#{column_name}=", uuid.raw)
+      end
+
+      if self < ActiveRecord::Base
+        (class << self; self end).class_eval do
+          define_method "find_by_formatted_#{name}" do |value|
+            begin
+              uuid = UUIDTools::UUID.parse(value)
+              return self.send("find_by_#{column_name}", uuid.raw)
+            rescue
+              return nil
+            end
+          end
+          define_method "find_by_hex_#{name}" do |value|
+            begin
+              uuid = UUIDTools::UUID.parse_hexdigest(value)
+              return self.send("find_by_#{column_name}", uuid.raw)
+            rescue
+              return nil
+            end
+          end
+        end
+
+        if options[:autofill]
+          before_create do
+            value = self.send(column_name)
+            if value.blank?
+              uuid = UUIDTools::UUID.timestamp_create
+              self.send("#{column_name}=", uuid.raw)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/attr_uuid/railtie.rb

@@ -0,0 +1,11 @@
+require "attr_uuid"
+
+module AttrUuid
+  class Railtie < Rails::Railtie
+    initializer "activerecord_uuid_as_pk.initialize" do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :include, AttrUuid
+      end
+    end
+  end
+end

data/lib/attr_uuid/version.rb

@@ -0,0 +1,3 @@
+module AttrUuid
+  VERSION = "1.0.0"
+end

data/spec/config/database.json.sample

@@ -0,0 +1,7 @@
+{
+    "adapter": "mysql2",
+    "username": "user"
+    "password": "password"
+    "database": "attr_uuid_test",
+    "encoding": "utf8"
+}

data/spec/db/create_database.sql

@@ -0,0 +1 @@
+CREATE DATABASE attr_uuid_test DEFAULT CHARACTER SET utf8;

data/spec/lib/attr_uuid_spec.rb

@@ -0,0 +1,291 @@
+require "spec_helper"
+require "active_record"
+require "attr_uuid"
+require "json"
+
+config_json = File.open(File.join("spec", "config", "database.json")).read
+config = JSON.parse(config_json, :symbolize_keys => true)
+ActiveRecord::Base.establish_connection(config)
+
+class Model1
+  include AttrUuid
+  attr_uuid :uuid
+  attr_accessor :uuid
+  def initialize(uuid)
+    @uuid = UUIDTools::UUID.parse(uuid).raw
+  end
+end
+
+class Model2
+  include AttrUuid
+  attr_uuid 1
+end
+
+class Model3
+  include AttrUuid
+  attr_uuid :uuid, :column_name => 1
+end
+
+describe AttrUuid do
+  context "when PORO" do
+    subject(:model) { Model1.new("faea220a-e94e-442c-9ca0-5b39753e3549") }
+
+    describe ".attr_uuid" do
+      context "when argument is String" do
+        it { is_expected.to respond_to :formatted_uuid }
+        it { is_expected.to respond_to :formatted_uuid= }
+        it { is_expected.to respond_to :hex_uuid }
+        it { is_expected.to respond_to :hex_uuid= }
+      end
+
+      context "when argument is neither String nor Symbol" do
+        subject(:model) { Model2.new }
+        it { is_expected.not_to respond_to :formatted_1 }
+        it { is_expected.not_to respond_to :formatted_1= }
+        it { is_expected.not_to respond_to :hex_1 }
+        it { is_expected.not_to respond_to :hex_1= }
+      end
+
+      context "when column alias name is neither String nor Symbol" do
+        subject(:model) { Model3.new }
+        it { is_expected.not_to respond_to :formatted_1 }
+        it { is_expected.not_to respond_to :formatted_1= }
+        it { is_expected.not_to respond_to :hex_1 }
+        it { is_expected.not_to respond_to :hex_1= }
+      end
+    end
+
+    describe "#formatted_xxx" do
+      it "returns formatted attribute value" do
+        expect(model.formatted_uuid).to eq "faea220a-e94e-442c-9ca0-5b39753e3549"
+      end
+
+      context "when uuid is nil" do
+        before { model.uuid = nil }
+        it { expect(model.formatted_uuid).to be_nil }
+      end
+    end
+
+    describe "#formatted_xxx=" do
+      it "updates original attribute" do
+        uuid = UUIDTools::UUID.parse("d8354fff-f782-4b86-b4a7-7db46a5426d7")
+        model.formatted_uuid = uuid.to_s
+        expect(model.uuid).to eq uuid.raw
+      end
+    end
+
+    describe "#hex_xxx" do
+      it "returns hex digested attribute value" do
+        expect(model.hex_uuid).to eq "faea220ae94e442c9ca05b39753e3549"
+      end
+
+      context "when uuid is nil" do
+        before { model.uuid = nil }
+        it { expect(model.hex_uuid).to be_nil }
+      end
+    end
+
+    describe "#hex_xxx=" do
+      it "updates original attribute" do
+        uuid = UUIDTools::UUID.parse("d8354fff-f782-4b86-b4a7-7db46a5426d7")
+        model.hex_uuid = uuid.hexdigest
+        expect(model.uuid).to eq uuid.raw
+      end
+    end
+  end
+
+  context "when ActiveRecord" do
+    context "when disable autofill" do
+      with_model :dummy do
+        table do |t|
+          t.binary :uuid
+        end
+
+        model do
+          include AttrUuid
+          attr_uuid :uuid
+        end
+      end
+
+      context "when save without uuid" do
+        subject(:model) { Dummy.create! }
+        it { expect(model.uuid).to be_nil }
+      end
+
+      subject(:model) do
+        uuid = UUIDTools::UUID.parse("faea220a-e94e-442c-9ca0-5b39753e3549")
+        Dummy.new {|o| o.uuid = uuid.raw }
+      end
+
+      describe ".attr_uuid" do
+        it { is_expected.to respond_to :formatted_uuid }
+        it { is_expected.to respond_to :formatted_uuid= }
+        it { is_expected.to respond_to :hex_uuid }
+        it { is_expected.to respond_to :hex_uuid= }
+        it { expect(Dummy).to respond_to :find_by_formatted_uuid }
+        it { expect(Dummy).to respond_to :find_by_hex_uuid }
+      end
+
+      describe ".find_by_formatted_xxx" do
+        before { model.save! }
+        subject(:result) { Dummy.find_by_formatted_uuid(uuid) }
+
+        context "when uuid matched" do
+          let(:uuid) { "faea220a-e94e-442c-9ca0-5b39753e3549" }
+          it { expect(result).to eq model }
+        end
+
+        context "when no uuid matched" do
+          let(:uuid) { "00000000-e94e-442c-9ca0-5b39753e3549" }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid is nil" do
+          let(:uuid) { nil }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid isn't String" do
+          let(:uuid) { 1 }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid format is invalid" do
+          let(:uuid) { "invalid" }
+          it { expect(result).to be_nil }
+        end
+      end
+
+      describe ".find_by_hex_xxx" do
+        before { model.save! }
+        subject(:result) { Dummy.find_by_hex_uuid(uuid) }
+
+        context "when uuid matched" do
+          let(:uuid) { "faea220ae94e442c9ca05b39753e3549" }
+          it { expect(result).to eq model }
+        end
+
+        context "when no uuid matched" do
+          let(:uuid) { "00000000e94e442c9ca05b39753e3549" }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid is nil" do
+          let(:uuid) { nil }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid isn't String" do
+          let(:uuid) { 1 }
+          it { expect(result).to be_nil }
+        end
+
+        context "when uuid format is invalid" do
+          let(:uuid) { "invalid" }
+          it { expect(result).to be_nil }
+        end
+      end
+    end
+
+    context "when column name alias enabled" do
+      with_model :dummy do
+        table do |t|
+          t.binary :x_uuid
+        end
+
+        model do
+          include AttrUuid
+          attr_uuid :uuid, :column_name => "x_uuid"
+        end
+      end
+
+      context "when save without uuid" do
+        subject(:model) { Dummy.create! }
+        it { expect(model.x_uuid).to be_nil }
+      end
+
+      subject(:model) do
+        uuid = UUIDTools::UUID.parse("faea220a-e94e-442c-9ca0-5b39753e3549")
+        Dummy.new {|o| o.x_uuid = uuid.raw }
+      end
+
+      describe ".attr_uuid" do
+        it { is_expected.to respond_to :formatted_uuid }
+        it { is_expected.to respond_to :formatted_uuid= }
+        it { is_expected.to respond_to :hex_uuid }
+        it { is_expected.to respond_to :hex_uuid= }
+        it { expect(Dummy).to respond_to :find_by_formatted_uuid }
+        it { expect(Dummy).to respond_to :find_by_hex_uuid }
+      end
+
+      describe ".find_by_formatted_xxx" do
+        before { model.save! }
+        subject(:result) { Dummy.find_by_formatted_uuid(uuid) }
+
+        context "when uuid matched" do
+          let(:uuid) { "faea220a-e94e-442c-9ca0-5b39753e3549" }
+          it { expect(result).to eq model }
+        end
+
+        context "when no uuid matched" do
+          let(:uuid) { "00000000-e94e-442c-9ca0-5b39753e3549" }
+          it { expect(result).to be_nil }
+        end
+      end
+
+      describe ".find_by_hex_xxx" do
+        before { model.save! }
+        subject(:result) { Dummy.find_by_hex_uuid(uuid) }
+
+        context "when uuid matched" do
+          let(:uuid) { "faea220ae94e442c9ca05b39753e3549" }
+          it { expect(result).to eq model }
+        end
+
+        context "when no uuid matched" do
+          let(:uuid) { "00000000e94e442c9ca05b39753e3549" }
+          it { expect(result).to be_nil }
+        end
+      end
+    end
+
+    context "when enable autofill" do
+      with_model :dummy do
+        table do |t|
+          t.binary :uuid
+        end
+
+        model do
+          include AttrUuid
+          attr_uuid :uuid, :autofill => true
+        end
+      end
+
+      context "when uuid is nil" do
+        before do
+          @uuid = UUIDTools::UUID.parse("080cd5cb-9556-4c07-9af3-a4559cf52627")
+          UUIDTools::UUID.stub(:timestamp_create).and_return(@uuid)
+        end
+        subject(:model) { Dummy.create! }
+        it { expect(model.uuid).to eq @uuid.raw }
+      end
+
+      context "when uuid is empty" do
+        before do
+          @uuid = UUIDTools::UUID.parse("40d5fafe-ff68-4606-9de7-554eae0d77a3")
+          UUIDTools::UUID.stub(:timestamp_create).and_return(@uuid)
+        end
+        subject(:model) { Dummy.create! {|o| o.uuid = ""} }
+        it { expect(model.uuid).to eq @uuid.raw }
+      end
+
+      context "when uuid is set" do
+        subject(:model) do
+          @uuid = UUIDTools::UUID.parse("3e1fe985-2fbf-44ce-a5fb-d1b3db49260d")
+          Dummy.create! {|o| o.uuid = @uuid.raw }
+        end
+        it { expect(model.uuid).to eq @uuid.raw }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "rubygems"
+require "bundler/setup"
+require "simplecov"
+require "with_model"
+
+SimpleCov.start do
+  add_filter "spec"
+  add_filter "vendor"
+end
+
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+  config.extend WithModel
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: attr_uuid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shou Takenaka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-23 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: uuidtools
+  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: mysql2
+  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: simplecov
+  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: with_model
+  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 gem makes binary uuid attribute easy to use
+email:
+- sasaminn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- attr_uuid.gemspec
+- lib/attr_uuid.rb
+- lib/attr_uuid/railtie.rb
+- lib/attr_uuid/version.rb
+- spec/config/database.json.sample
+- spec/db/create_database.sql
+- spec/lib/attr_uuid_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easy to use binay uuid attribute
+test_files:
+- spec/config/database.json.sample
+- spec/db/create_database.sql
+- spec/lib/attr_uuid_spec.rb
+- spec/spec_helper.rb