activeuuid 0.4.0 → 0.5.0

data/.gitignore

@@ -1,5 +1,5 @@
 *.gem
 .bundle
-Gemfile.lock
+*.lock
 pkg/*
-*.log
+*.log

data/.travis.yml

@@ -3,15 +3,15 @@ before_script:
   - psql -c 'create database activeuuid_test;' -U postgres
 
 rvm:
-  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - rbx-19mode
+  - rbx-2
 
 gemfile:
   - Gemfile
   - gemfiles/Gemfile.rails-3-1
   - gemfiles/Gemfile.rails-3-2
+  - gemfiles/Gemfile.rails-4-0
   - gemfiles/Gemfile.rails-head
 
 env:
@@ -22,6 +22,3 @@ env:
 matrix:
   allow_failures:
     - gemfile: gemfiles/Gemfile.rails-head
-  exclude:
-    - rvm: 1.9.2
-      gemfile: gemfiles/Gemfile.rails-head

data/README.mkd

@@ -41,6 +41,29 @@ class Email < ActiveRecord::Base
 end
 ```
 
+### specify a natural key for generating the UUID based on one or more columns
+```ruby
+class Email < ActiveRecord::Base
+  include ActiveUUID::UUID
+  natural_key :sender_id, :received_at
+  belongs_to :sender
+end
+```
+
+`natural_key` generates a SHA1-based UUID in the ISO OID namespace by default. [7]
+
+### specify a custom UUID namespace for the natural key
+```ruby
+class Email < ActiveRecord::Base
+  include ActiveUUID::UUID
+  uuid_namespace "1dd74dd0-d116-11e0-99c7-5ac5d975667e"
+  natural_key :sender_id, :received_at
+  belongs_to :sender
+end
+```
+
+`uuid_namespace` can either be a UUID in string format, or a UUIDTools::UUID object.
+
 ### use it:
 Here are some example specs:
 
@@ -118,6 +141,7 @@ Or get the code here: https://github.com/jashmenn/activeuuid
 * [4] http://www.codinghorror.com/blog/2007/03/primary-keys-ids-versus-guids.html
 * [5] http://krow.livejournal.com/497839.html
 * [6] https://github.com/jamesgolick/friendly
+* [7] http://tools.ietf.org/html/rfc4122.html#appendix-C
 
 ## Dependencies
 Rails ~> 3.1.0

data/activeuuid.gemspec

@@ -17,7 +17,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec", "~> 2.99.0"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency "activesupport"
   s.add_development_dependency "database_cleaner"
   s.add_development_dependency "forgery"

data/gemfiles/Gemfile.rails-4-0

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.0.0'

data/gemfiles/Gemfile.rails-4-1

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec path: '../'
+
+gem 'activerecord', '~> 4.1.0'

data/lib/activeuuid/patches.rb

@@ -8,7 +8,7 @@ module ActiveUUID
       def uuid(*column_names)
         options = column_names.extract_options!
         column_names.each do |name|
-          type = @base.adapter_name.downcase == 'postgresql' ? 'uuid' : 'binary(16)'
+          type = ActiveRecord::Base.connection.adapter_name.downcase == 'postgresql' ? 'uuid' : 'binary(16)'
           column(name, "#{type}#{' PRIMARY KEY' if options.delete(:primary_key)}", options)
         end
       end
@@ -29,12 +29,12 @@ module ActiveUUID
         end
 
         def simplified_type_with_uuid(field_type)
-          return :uuid if field_type == 'binary(16)'
+          return :uuid if field_type == 'binary(16)' || field_type == 'binary(16,0)'
           simplified_type_without_uuid(field_type)
         end
 
         alias_method_chain :type_cast, :uuid
-        alias_method_chain :type_cast_code, :uuid
+        alias_method_chain :type_cast_code, :uuid if ActiveRecord::VERSION::MAJOR < 4
         alias_method_chain :simplified_type, :uuid
       end
     end
@@ -43,6 +43,12 @@ module ActiveUUID
       extend ActiveSupport::Concern
 
       included do
+        def type_cast_with_uuid(value)
+          return UUIDTools::UUID.serialize(value) if type == :uuid
+          type_cast_without_uuid(value)
+        end
+        alias_method_chain :type_cast, :uuid if ActiveRecord::VERSION::MAJOR >= 4
+
         def simplified_type_with_pguuid(field_type)
           return :uuid if field_type == 'uuid'
           simplified_type_without_pguuid(field_type)

data/lib/activeuuid/uuid.rb

@@ -8,6 +8,10 @@ module UUIDTools
     # duck typing activerecord 3.1 dirty hack )
     def gsub *; self; end
 
+    def next
+      self.class.random_create
+    end
+
     def quoted_id
       s = raw.unpack("H*")[0]
       "x'#{s}'"
@@ -50,25 +54,25 @@ end
 module Arel
   module Visitors
     class DepthFirst < Arel::Visitors::Visitor
-      def visit_UUIDTools_UUID(o)
+      def visit_UUIDTools_UUID(o, a = nil)
         o.quoted_id
       end
     end
 
     class MySQL < Arel::Visitors::ToSql
-      def visit_UUIDTools_UUID(o)
+      def visit_UUIDTools_UUID(o, a = nil)
         o.quoted_id
       end
     end
 
     class SQLite < Arel::Visitors::ToSql
-      def visit_UUIDTools_UUID(o)
+      def visit_UUIDTools_UUID(o, a = nil)
         o.quoted_id
       end
     end
 
     class PostgreSQL < Arel::Visitors::ToSql
-      def visit_UUIDTools_UUID(o)
+      def visit_UUIDTools_UUID(o, a = nil)
         "'#{o.to_s}'"
       end
     end
@@ -81,6 +85,7 @@ module ActiveUUID
 
     included do
       class_attribute :_natural_key, instance_writer: false
+      class_attribute :_uuid_namespace, instance_writer: false
       class_attribute :_uuid_generator, instance_writer: false
       self._uuid_generator = :random
 
@@ -93,6 +98,11 @@ module ActiveUUID
         self._natural_key = attributes
       end
 
+      def uuid_namespace(namespace)
+        namespace = UUIDTools::UUID.parse_string(namespace) unless namespace.is_a? UUIDTools::UUID
+        self._uuid_namespace = namespace
+      end
+
       def uuid_generator(generator_name)
         self._uuid_generator = generator_name
       end
@@ -104,7 +114,7 @@ module ActiveUUID
         EOS
       end
 
-      def instantiate_with_uuid(record)
+      def instantiate_with_uuid(record, record_models = nil)
         uuid_columns.each do |uuid_column|
           record[uuid_column] = UUIDTools::UUID.serialize(record[uuid_column]).to_s if record[uuid_column]
         end
@@ -120,7 +130,7 @@ module ActiveUUID
       if _natural_key
         # TODO if all the attributes return nil you might want to warn about this
         chained = _natural_key.map { |attribute| self.send(attribute) }.join('-')
-        UUIDTools::UUID.sha1_create(UUIDTools::UUID_OID_NAMESPACE, chained)
+        UUIDTools::UUID.sha1_create(_uuid_namespace || UUIDTools::UUID_OID_NAMESPACE, chained)
       else
         case _uuid_generator
         when :random

data/lib/activeuuid/version.rb

@@ -1,3 +1,3 @@
 module Activeuuid
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/spec/fabricators/uuid_article_with_namespace_fabricator.rb

@@ -0,0 +1,4 @@
+Fabricator(:uuid_article_with_namespace) do
+  title { Forgery::LoremIpsum.word }
+  body { Forgery::LoremIpsum.sentence }
+end

data/spec/fabricators/uuid_article_with_natural_key_fabricator.rb

@@ -0,0 +1,4 @@
+Fabricator(:uuid_article_with_natural_key) do
+  title { Forgery::LoremIpsum.word }
+  body { Forgery::LoremIpsum.sentence }
+end

data/spec/lib/activerecord_spec.rb

@@ -14,7 +14,7 @@ describe ActiveRecord::Base do
       connection.drop_table table_name
     end
 
-    specify { connection.table_exists?(table_name).should be_true }
+    specify { connection.table_exists?(table_name).should be_truthy }
 
     context '#add_column' do
       let(:column_name) { :uuid_column }
@@ -22,7 +22,7 @@ describe ActiveRecord::Base do
 
       before { connection.add_column table_name, column_name, :uuid }
 
-      specify { connection.column_exists?(table_name, column_name).should be_true }
+      specify { connection.column_exists?(table_name, column_name).should be_truthy }
       specify { column.should_not be_nil }
 
       it 'should have proper sql type' do
@@ -85,8 +85,8 @@ describe Article do
 
   context '#destroy' do
     subject { article }
-    its(:delete) { should be_true }
-    its(:destroy) { should be_true }
+    its(:delete) { should be_truthy }
+    its(:destroy) { should be_truthy }
   end
 end
 
@@ -132,8 +132,8 @@ describe UuidArticle do
 
   context '#destroy' do
     subject { article }
-    its(:delete) { should be_true }
-    its(:destroy) { should be_true }
+    its(:delete) { should be_truthy }
+    its(:destroy) { should be_truthy }
   end
 
   context '#reload' do
@@ -184,4 +184,26 @@ describe UuidArticle do
       end
     end
   end
-end
+end
+
+describe UuidArticleWithNaturalKey do
+  let!(:article) { Fabricate :uuid_article_with_natural_key }
+  let!(:id) { article.id }
+  let!(:uuid) { UUIDTools::UUID.sha1_create(UUIDTools::UUID_OID_NAMESPACE, article.title) }
+  subject { article }
+  context 'natural_key' do
+    its(:id) { should == uuid }
+  end
+end
+
+describe UuidArticleWithNamespace do
+  let!(:article) { Fabricate :uuid_article_with_namespace }
+  let!(:id) { article.id }
+  let!(:namespace) { UuidArticleWithNamespace._uuid_namespace }
+  let!(:uuid) { UUIDTools::UUID.sha1_create(namespace, article.title) }
+  subject { article }
+  context 'natural_key_with_namespace' do
+    its(:id) { should == uuid }
+  end
+end
+

data/spec/lib/uuid_mokeypatch_spec.rb

@@ -12,6 +12,7 @@ describe UUIDTools::UUID do
     its(:quoted_id) {should == sql_out}
     its(:as_json) {should == hex}
     its(:to_param) {should == hex}
+    its(:next) {should be_a(described_class)}
   end
 
   describe '.serialize' do

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ require 'active_support/all'
 
 ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
 ActiveRecord::Base.configurations = YAML::load(File.read(File.dirname(__FILE__) + "/support/database.yml"))
-ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite3")
+ActiveRecord::Base.establish_connection((ENV["DB"] || "sqlite3").to_sym)
 
 require 'activeuuid'
 

data/spec/support/models/uuid_article_with_namespace.rb

@@ -0,0 +1,6 @@
+class UuidArticleWithNamespace < ActiveRecord::Base
+  include ActiveUUID::UUID
+  self.table_name = 'uuid_articles'
+  natural_key :title
+  uuid_namespace "45e676ea-8a43-4ffe-98ca-c142b0062a83" # a random UUID
+end

data/spec/support/models/uuid_article_with_natural_key.rb

@@ -0,0 +1,5 @@
+class UuidArticleWithNaturalKey < ActiveRecord::Base
+  include ActiveUUID::UUID
+  self.table_name = 'uuid_articles'
+  natural_key :title
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeuuid
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2014-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -29,6 +29,22 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.99.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -204,6 +220,8 @@ files:
 - activeuuid.gemspec
 - gemfiles/Gemfile.rails-3-1
 - gemfiles/Gemfile.rails-3-2
+- gemfiles/Gemfile.rails-4-0
+- gemfiles/Gemfile.rails-4-1
 - gemfiles/Gemfile.rails-head
 - lib/activeuuid.rb
 - lib/activeuuid/patches.rb
@@ -212,6 +230,8 @@ files:
 - lib/activeuuid/version.rb
 - spec/fabricators/article_fabricator.rb
 - spec/fabricators/uuid_article_fabricator.rb
+- spec/fabricators/uuid_article_with_namespace_fabricator.rb
+- spec/fabricators/uuid_article_with_natural_key_fabricator.rb
 - spec/lib/activerecord_spec.rb
 - spec/lib/uuid_mokeypatch_spec.rb
 - spec/spec_helper.rb
@@ -220,6 +240,8 @@ files:
 - spec/support/migrate/20120817081813_create_uuid_articles.rb
 - spec/support/models/article.rb
 - spec/support/models/uuid_article.rb
+- spec/support/models/uuid_article_with_namespace.rb
+- spec/support/models/uuid_article_with_natural_key.rb
 - spec/support/spec_for_adapter.rb
 homepage: https://github.com/jashmenn/activeuuid
 licenses: []
@@ -233,27 +255,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 852897539311025223
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 852897539311025223
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Add binary UUIDs to ActiveRecord in MySQL
 test_files:
 - spec/fabricators/article_fabricator.rb
 - spec/fabricators/uuid_article_fabricator.rb
+- spec/fabricators/uuid_article_with_namespace_fabricator.rb
+- spec/fabricators/uuid_article_with_natural_key_fabricator.rb
 - spec/lib/activerecord_spec.rb
 - spec/lib/uuid_mokeypatch_spec.rb
 - spec/spec_helper.rb
@@ -262,4 +280,6 @@ test_files:
 - spec/support/migrate/20120817081813_create_uuid_articles.rb
 - spec/support/models/article.rb
 - spec/support/models/uuid_article.rb
+- spec/support/models/uuid_article_with_namespace.rb
+- spec/support/models/uuid_article_with_natural_key.rb
 - spec/support/spec_for_adapter.rb