active_record_uuid 0.0.1 → 0.1.0

data/lib/active_record_uuid/rails/railtie.rb

@@ -0,0 +1,19 @@
+module ActiveRecordUuid
+  class Railtie < Rails::Railtie
+    config.active_record.schema_format = :sql
+    
+    initializer :after => 'active_record.initialize_database' do
+    
+      ActiveSupport.on_load(:active_record) do |app|
+        require 'active_record_uuid/extensions/quoting_extension'
+        
+        ::ActiveRecord::Base.connection.class.send :include, ActiveRecordUuid::QuotingExtension
+        ::ActiveRecord::Base.send(:include, ActiveRecordUuid::Model)
+      end
+    end
+    
+    rake_tasks do
+      load "active_record_uuid/rails/db.rake"
+    end
+  end
+end

data/lib/active_record_uuid/serializer.rb

@@ -0,0 +1,50 @@
+module ActiveRecordUuid
+  class Serializer
+    attr_reader :type
+    def initialize(type)
+      @type = type
+    end
+    
+    def load(value)
+      return nil if value.nil?
+
+      begin
+        uuid = case type
+        when :binary
+          UUIDTools::UUID.parse_raw(value)
+        when :base64
+          UUIDTools::UUID.parse_raw(Base64.decode64(value))
+        when :hexdigest
+          UUIDTools::UUID.parse_hexdigest(value)
+        when :string
+          UUIDTools::UUID.parse(value)
+        end
+        raise ArgumentError unless uuid.valid?
+        
+        uuid.to_s
+      rescue ArgumentError, TypeError
+        raise ActiveRecord::SerializationTypeMismatch,
+          "Attribute was supposed to be a valid uuid, but was #{value}"
+      end
+    end
+    
+    def dump(value)
+      uuid = begin
+        UUIDTools::UUID.parse(value)
+      rescue ArgumentError, TypeError
+        nil
+      end
+      
+      case type
+      when :binary
+        uuid.raw
+      when :base64
+        Base64.encode64(uuid.raw).strip
+      when :hexdigest
+        uuid.hexdigest
+      when :string
+        uuid.to_s
+      end
+    end
+  end
+end

data/lib/active_record_uuid/uuid_base.rb

@@ -1,18 +1,26 @@
 require File.join(File.dirname(__FILE__), "uuid_base_helper.rb")
 
 class ActiveRecord::UuidBase < ::ActiveRecord::Base
-  include UuidBaseHelper
-
   class << self
     def inherited_with_uuid(kls)
       inherited_without_uuid kls
-      kls.assign_defaults
+      warn "[DEPRECATION] `UuidBaseHelper` and `ActiveRecord::UuidBase` are deprecated.  Please inherit from `ActiveRecord::Base` and use `uuid_config` instead."
+      kls.uuid_config do
+        primary_key true
+        association true
+        hook        :before_create
+      end
     end
     alias_method_chain :inherited, :uuid
   end
 
   self.descendants.each do |kls|
-    kls.assign_defaults
+    warn "[DEPRECATION] `UuidBaseHelper` and `ActiveRecord::UuidBase` are deprecated.  Please inherit from `ActiveRecord::Base` and use `uuid_config` instead."
+    kls.uuid_config do
+      primary_key true
+      association true
+      hook        :before_create
+    end
   end
 
   self.abstract_class = true

data/lib/active_record_uuid/uuid_base_helper.rb

@@ -1,89 +1,12 @@
 module UuidBaseHelper
-  UUID_REG = /^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{2})([0-9a-f]{2})-([0-9a-f]{12})$/
-
   def self.included(base)
-    base.send(:extend, ClassMethods)
-    base.send(:extend, AssociationMethods)
-    base.send(:include, InstanceMethods)
-    base.assign_defaults
-  end
-
-  module InstanceMethods
-    def assign_uuid
-      self.id = UUIDTools::UUID.timestamp_create().to_s
-    end
-
-    def assign_uuid!
-      assign_uuid
-      save!
-    end
-    
-    private
-    def assign_uuid_when_blank
-      assign_uuid if self.id.blank?
-    end
-  end
-
-  module ClassMethods
-    def generate_uuid
-      UUIDTools::UUID.send("timestamp_create").to_s
-    end
-    
-    def assign_defaults
-      self.primary_key            = 'uuid'
-      self.before_create          :assign_uuid_when_blank
-      self.validates_format_of    :uuid, :with => UUID_REG, :if => Proc.new { |r| r.id.present? }
-    end
-  end
-  
-  module AssociationMethods
-    def has_many(name, options = {}, &extension)
-      options = uuid_assoc_options(:has_many, name, options)
-      super
-    end
-    
-    def has_one(name, options = {})
-      options = uuid_assoc_options(:has_one, name, options)
-      super
-    end
-    
-    def belongs_to(name, options = {})
-      options = uuid_assoc_options(:belongs_to, name, options)
-      super
-    end
-
-    def has_and_belongs_to_many(name, options = {}, &extension)
-      options = uuid_assoc_options(:has_and_belongs_to_many, name, options)
-      super
-    end
-    
-    private
-    def uuid_assoc_options(macro, association_name, options)
-      opts = {}
-      
-      # Set class_name only if not a has-through relation or poly relation
-      if options[:through].blank? and options[:as].blank? and options[:class_name].blank? and !self.name.match(/::/)
-        opts[:class_name] = "::#{association_name.to_s.singularize.camelize}"
-      end
-      
-      # Set foreign_key only if not passed
-      if options[:foreign_key].blank?
-        case macro
-        when :has_many, :has_one
-          opts[:foreign_key] = uuid_foreign_key(self.name)
-        when :belongs_to
-          opts[:foreign_key] = uuid_foreign_key(association_name)
-        when :has_and_belongs_to_many
-          opts[:foreign_key] = uuid_foreign_key(self.name)
-          opts[:association_foreign_key] = uuid_foreign_key(association_name)
-        end
-      end
-
-      options.merge(opts)
-    end
+    warn "[DEPRECATION] `UuidBaseHelper` and `ActiveRecord::UuidBase` are deprecated.  Please inherit from `ActiveRecord::Base` and use `uuid_config` instead."
     
-    def uuid_foreign_key(name)
-      name.to_s.singularize.underscore.downcase + "_uuid"
+    base.send(:include, ActiveRecordUuid::Model)
+    base.uuid_config do
+      primary_key true
+      association true
+      hook        :before_create
     end
   end
 end

data/lib/active_record_uuid/version.rb

@@ -1,3 +1,3 @@
 module ActiveRecordUuid
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/lib/association_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe "UuidBase" do
+describe "UuidConfig" do
   context "uuid association" do
     before(:all) do
       @post1 = Post.create!(:text => "Post 1")

data/spec/lib/base64_uuid_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "Base64 Uuid" do
+  context "configure: PostBase64 model" do 
+    it "should have uuid as primary key based config" do
+      PostBase64.primary_key.should eq('uuid')
+    end
+    
+    it "should store uuid as base64" do
+      post = PostBase64.create(:text => "Base64 uuid1")
+      post.reload
+      
+      post.attributes_before_type_cast["uuid"]["value"].bytesize.should eq(24)
+    end
+    
+    it "should retreive back as uuid string from base64" do
+      post = PostBase64.create(:text => "Base64 uuid2")
+      post.reload
+      
+      post.uuid.should be_present
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should retreive uuid back with the same value that was assigned" do
+      post = PostBase64.new(:text => "Base64 uuid2")
+      post.uuid = "b360c78e-b62e-11e1-9870-0026b90faf3c"
+      post.save
+      post.reload
+      
+      post.uuid.should eq("b360c78e-b62e-11e1-9870-0026b90faf3c")
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should find by uuid column" do
+      post = PostBase64.create(:text => "Base64 uuid3")
+
+      PostBase64.find_by_uuid(post.uuid).should   eq(post)
+      PostBase64.where(:uuid => post.uuid).should eq([post])
+    end
+    
+    it "should find by primary key" do
+      post = PostBase64.create(:text => "Base64 uuid4")
+
+      PostBase64.find(post).should eq(post)
+      PostBase64.find(post.uuid).should eq(post)
+    end
+    
+    it "should find by array of primary keys" do
+      post1 = PostBase64.create(:text => "Base64 uuid5")
+      post2 = PostBase64.create(:text => "Base64 uuid6")
+
+      PostBase64.find([post1.uuid, post2.uuid]).should eq([post1, post2])
+    end
+  end
+end

data/spec/lib/binary_uuid_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe "Binary Uuid" do
+  context "configure: PostBinary model" do 
+    it "should have uuid as primary key based config" do
+      PostBinary.primary_key.should eq('uuid')
+    end
+    
+    it "should have uuid association" do
+      PostBinary.reflections[:comments].options[:foreign_key].should eq("post_binary_uuid")
+    end
+    
+    it "should store uuid as binary" do
+      post = PostBinary.create(:text => "Binary uuid1")
+      post.reload
+      
+      post.attributes_before_type_cast["uuid"]["value"].bytesize.should eq(16)
+    end
+    
+    it "should retreive back as uuid string from binary" do
+      post = PostBinary.create(:text => "Binary uuid2")
+      post.reload
+      
+      post.uuid.should be_present
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should retreive uuid back with the same value that was assigned" do
+      post = PostBinary.new(:text => "Binary uuid2")
+      post.uuid = "b360c78e-b62e-11e1-9870-0026b90faf3c"
+      post.save
+      post.reload
+      
+      post.uuid.should eq("b360c78e-b62e-11e1-9870-0026b90faf3c")
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should find by uuid column" do
+      post = PostBinary.create(:text => "Binary uuid3")
+
+      PostBinary.find_by_uuid(post.uuid).should   eq(post)
+      PostBinary.where(:uuid => post.uuid).should eq([post])
+    end
+    
+    it "should find by primary key" do
+      post = PostBinary.create(:text => "Binary uuid4")
+
+      PostBinary.find(post).should eq(post)
+      PostBinary.find(post.uuid).should eq(post)
+    end
+    
+    it "should find by array of primary keys" do
+      post1 = PostBinary.create(:text => "Binary uuid5")
+      post2 = PostBinary.create(:text => "Binary uuid6")
+
+      PostBinary.find([post1.uuid, post2.uuid]).should eq([post1, post2])
+    end
+
+    it "should save association" do
+      blog = Blog.create(:name => "Blog 1")
+      article = blog.articles.create(:title => "Blog Association 1")
+
+      blog.articles.count.should eq(1)
+      blog.articles[0].should eq(article)
+    end
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe "Uuid Config" do
+  it "should initialize with default values" do
+    @config = ActiveRecordUuid::Config.new
+    
+    @config.column.should eq(:uuid)
+    @config.primary_key.should eq(false)
+    @config.association.should eq(false)
+    @config.generator.should eq(:timestamp)
+    @config.store_as.should eq(:string)
+    @config.hook.should eq(:before_validation)
+  end
+  
+  it "should validate options: generator" do
+    @config = ActiveRecordUuid::Config.new
+    
+    @config.generator(:abc)
+    lambda {
+      @config.validate_options!
+    }.should raise_error ArgumentError, /^Expected :timestamp/
+  end
+  
+  it "should validate options: store_as" do
+    @config = ActiveRecordUuid::Config.new
+    
+    @config.store_as(:abc)
+    lambda {
+      @config.validate_options!
+    }.should raise_error ArgumentError, /^Expected :binary/
+  end
+  
+  it "should validate options: hook" do
+    @config = ActiveRecordUuid::Config.new
+    
+    @config.hook(:abc)
+    lambda { 
+      @config.validate_options!
+    }.should raise_error ArgumentError, /^Expected :before_validation/
+  end
+end

data/spec/lib/deprecation_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe "Depreciation: ActiveRecord::UuidBase" do
+  it "should create uuid" do
+    article = ArticleUuidBase.create(:title => "uuid base1")
+
+    article.uuid.length.should eq(36)
+  end
+
+  it "should not use primary_key" do
+    ArticleUuidBase.primary_key.should eq("uuid")
+  end
+  
+  it "should not set association" do
+    ArticleUuidBase.reflections[:comments].options[:foreign_key].should eq("article_uuid_base_uuid")
+  end
+end

data/spec/lib/hexdigest_uuid_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe "HexDigest Uuid" do
+  context "configure: PostHexDigest model" do 
+    it "should have uuid as primary key based config" do
+      PostHexDigest.primary_key.should eq('uuid')
+    end
+    
+    it "should store uuid as HexDigest" do
+      post = PostHexDigest.create(:text => "HexDigest uuid1")
+      post.reload
+      
+      post.attributes_before_type_cast["uuid"]["value"].bytesize.should eq(32)
+    end
+    
+    it "should retreive back as uuid string from HexDigest" do
+      post = PostHexDigest.create(:text => "HexDigest uuid2")
+      post.reload
+      
+      post.uuid.should be_present
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should retreive uuid back with the same value that was assigned" do
+      post = PostHexDigest.new(:text => "HexDigest uuid2")
+      post.uuid = "b360c78e-b62e-11e1-9870-0026b90faf3c"
+      post.save
+      post.reload
+      
+      post.uuid.should eq("b360c78e-b62e-11e1-9870-0026b90faf3c")
+      post.uuid.should be_instance_of(String)
+      post.uuid.length.should eq(36)
+    end
+    
+    it "should find by uuid column" do
+      post = PostHexDigest.create(:text => "HexDigest uuid3")
+
+      PostHexDigest.find_by_uuid(post.uuid).should   eq(post)
+      PostHexDigest.where(:uuid => post.uuid).should eq([post])
+    end
+    
+    it "should find by primary key" do
+      post = PostHexDigest.create(:text => "HexDigest uuid4")
+
+      PostHexDigest.find(post).should eq(post)
+      PostHexDigest.find(post.uuid).should eq(post)
+    end
+    
+    it "should find by array of primary keys" do
+      post1 = PostHexDigest.create(:text => "HexDigest uuid5")
+      post2 = PostHexDigest.create(:text => "HexDigest uuid6")
+
+      PostHexDigest.find([post1.uuid, post2.uuid]).should eq([post1, post2])
+    end
+  end
+end