activerecord-uuid 0.9.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.rspec
+.irbrc
+.rvmrc
+.bundle
+Gemfile.lock
+pkg/*

data/CHANGELOG

@@ -0,0 +1,4 @@
+2012-02-27 Philip Champon <pchampon@gmail.com>
+
+	* Initial working version, no tests, hardly any docs
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-uuid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,8 @@
+Copyright (c) 2012 Adaptly
+
+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,73 @@
+# ActiveRecord::Uuid
+
+Adds automatically-assigned UUIDs to your model and allows you to find by UUID directly.
+
+## Configuration
+Add the gem to your Gemfile:
+
+```
+gem 'activerecord-uuid'
+```
+
+Create a migration to inclue a uuid column:
+
+```
+class CreateFoos < ActiveRecord::Migration
+  def up
+    create_table :foos do |t|
+      t.string :uuid # Store it as a string. See below to use native PostgreSQL UUID columns.
+    end
+  end
+end
+```
+
+Use it in your ActiveRecord model:
+
+```
+class Foo < ActiveRecord::Base
+  include ActiveRecord::Uuid
+end
+```
+
+See it work:
+
+```
+Foo.create
+ => #<Foo id: 1, uuid: "680d92fc-8b1e-11e1-a80a-70cd60fffe5d">
+Foo.find(1)
+ => #<Foo id: 1, uuid: "680d92fc-8b1e-11e1-a80a-70cd60fffe5d">
+Foo.find("680d92fc-8b1e-11e1-a80a-70cd60fffe5d")
+ => #<Foo id: 1, uuid: "680d92fc-8b1e-11e1-a80a-70cd60fffe5d">
+```
+
+## Native UUID Columns
+
+This gem adds a Rails initializer that allows you to use native UUID types in PostgreSQL. To create a column in your migration:
+
+```
+class CreateFoos < ActiveRecord::Migration
+  def up
+    create_table :foos
+    add_column :foos, :uuid, :uuid
+  end
+end
+```
+
+Note that this does not work with `create_table` and `change_table` block syntaxes. Feel free to add support and open a pull request.
+
+Dumping your `db/schema.rb` file will not work with native UUID types, so instead you should use this line in your `config/application.rb` file to instead dump to `db/structure.sql`:
+
+```
+config.active_record.schema_format = :sql
+```
+
+## TODO
+
+1. Allow configuration of UUID columns.
+2. Figure out how to make native migrations work with `create_table` and `change_table`.
+3. Write tests!
+
+## Copyright
+
+&copy; 2012 Adaptly. See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activerecord-uuid.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_record/uuid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "activerecord-uuid"
+  s.version     = ActiveRecord::Uuid::VERSION
+  s.authors     = ["Philip Champon", "Nathan Bryan"]
+  s.email       = ["pchampon@gmail.com", "nathan.bryan@gmail.com"]
+  s.homepage    = "http://github.com/adaptly/activerecord-uuid"
+  s.summary     = %q{Bundles all UUID for ActiveRecord and Postgres}
+  s.description = %q{Installs blah blah blah}
+
+  s.rubyforge_project = "activerecord-uuid"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activerecord", "~> 3.1"
+  s.add_runtime_dependency "railties", "~> 3.1"
+  s.add_runtime_dependency "uuidtools"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/config/initializers/active_record.rb

@@ -0,0 +1,30 @@
+#
+# Shamelessly stolen from: http://pilif.github.com/2011/03/rails-postgresql-and-the-native-uuid-type/
+# This monkey patch renders `rake db:schema:load` useless. You will need to run `rake db:structure:load` from here to eternity.
+#
+module ActiveRecord
+  module ConnectionAdapters
+    if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+      PostgreSQLAdapter.class_eval do
+        def native_database_types_with_uuid_support
+          a = native_database_types_without_uuid_support
+          a[:uuid] = {:name => 'uuid'}
+          return a
+        end
+        alias_method_chain :native_database_types, :uuid_support
+      end
+
+      PostgreSQLColumn.class_eval do
+        def simplified_type_with_uuid_support(field_type)
+          if field_type == 'uuid'
+            :uuid
+          else
+            simplified_type_without_uuid_support(field_type)
+          end
+        end
+        alias_method_chain :simplified_type, :uuid_support
+      end
+    end
+  end
+end
+

data/lib/active_record/uuid.rb

@@ -0,0 +1,20 @@
+require 'active_record/uuid/finder_methods'
+require 'active_record/uuid/model'
+require 'active_record/uuid/railtie'
+require 'active_record/uuid/relation'
+require 'active_record/uuid/version'
+
+module ActiveRecord
+  module Uuid    
+    def self.included(model)
+      class << model
+        alias_method :relation_without_uuid, :relation
+      end
+    
+      model.instance_eval do
+        extend Relation
+        include Model
+      end
+    end
+  end
+end

data/lib/active_record/uuid/finder_methods.rb

@@ -0,0 +1,25 @@
+module ActiveRecord
+  module Uuid
+    module FinderMethods
+      VALID_UUID = /[0-9A-F]{32}/i
+    
+      # Ultimately, many methods call #find_one rather than simply just #find. Overriding just
+      # this allows more things to just work properly.
+      def find_one(id)
+        if id.to_s.gsub('-', '') =~ VALID_UUID && record = where(:uuid => id).limit(1).first
+          record
+        else
+          super(id)
+        end
+      end
+      
+      def exists?(id = false)
+        if id.to_s.gsub('-', '') =~ VALID_UUID
+          super :uuid => id
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/active_record/uuid/model.rb

@@ -0,0 +1,23 @@
+require 'uuidtools'
+
+module ActiveRecord
+  module Uuid
+    module Model
+      def self.included(model)
+        model.instance_eval do
+          # This should never be user-assigned
+          attr_protected :uuid
+          # Validate on update since uuid won't exist yet on creation
+          validates :uuid, :presence => true, :uniqueness => true, :on => :update
+          before_create :assign_uuid
+        end
+      end
+    
+    private
+    
+      def assign_uuid
+        write_attribute(:uuid, UUIDTools::UUID.timestamp_create.to_s)
+      end
+    end
+  end
+end

data/lib/active_record/uuid/railtie.rb

@@ -0,0 +1,10 @@
+# 
+# Provide a Railtie, which changes the schema format to :sql. This in turn allows development_structure.sql to define uuid fields as the Postgresql uuid type.
+#
+module ActiveRecord
+  module Uuid
+    class Railtie < Rails::Railtie
+      config.active_record.schema_format = :sql # For UUID columns and other PGSQL goodness.
+    end
+  end
+end

data/lib/active_record/uuid/relation.rb

@@ -0,0 +1,24 @@
+module ActiveRecord
+  module Uuid
+    module Relation
+    private
+  
+      # Rather than monkey-patching ActiveRecord::Relation, subclass it with our own implementation
+      # of the finder methods. This is the way FriendlyId does it, and should place nicely with it.
+      def uuid_relation_class    
+        @uuid_relation_class ||= Class.new(relation_without_uuid.class) do
+          alias_method :find_one_without_uuid, :find_one
+          alias_method :exists_without_uuid?, :exists?
+          include Uuid::FinderMethods
+        end
+      end
+    
+      # Override the model's relation method to return our subclassed version.
+      def relation
+        @relation = nil unless @relation.class <= uuid_relation_class
+        @relation ||= uuid_relation_class.new(self, arel_table)
+        super
+      end
+    end
+  end
+end

data/lib/active_record/uuid/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Uuid
+    VERSION = "0.9.0"
+  end
+end

data/lib/activerecord-uuid.rb

@@ -0,0 +1 @@
+require 'active_record/uuid'

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-uuid
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
+platform: ruby
+authors:
+- Philip Champon
+- Nathan Bryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70261265704540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70261265704540
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70261265704040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70261265704040
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: &70261265703660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70261265703660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70261265703200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261265703200
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70261265702780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70261265702780
+description: Installs blah blah blah
+email:
+- pchampon@gmail.com
+- nathan.bryan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-uuid.gemspec
+- config/initializers/active_record.rb
+- lib/active_record/uuid.rb
+- lib/active_record/uuid/finder_methods.rb
+- lib/active_record/uuid/model.rb
+- lib/active_record/uuid/railtie.rb
+- lib/active_record/uuid/relation.rb
+- lib/active_record/uuid/version.rb
+- lib/activerecord-uuid.rb
+homepage: http://github.com/adaptly/activerecord-uuid
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: activerecord-uuid
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Bundles all UUID for ActiveRecord and Postgres
+test_files: []
+has_rdoc: