activerecord_uuid_as_pk 1.0.0

data/.gitignore

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

data/Gemfile

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

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,73 @@
+# ActiveRecordUUIDAsPK
+
+`activerecord_uuid_as_pk` is a extension for ActiveRecord to enable to use uuid for `id` attribute (**v1.0.0 tested only MySQL**).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord_uuid_as_pk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord_uuid_as_pk
+
+
+## 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. Call `uuid_as_primary_key` method in a model class.
+
+        class User < ActiveRecord::Base
+            uuid_as_primary_key
+        end
+
+3. The `uuid_as_primary_key` method hooks `before_create` callback to set automatically generated uuid as 16 byte binary data to id attirbute.  And this method adds `#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.formatted_id  #=> "337e0576-cb66-4151-a2e1-e0fc04fb33d1"
+
+4. Of course you can set arbitrary uuid if you set 16 byte binary, a formatted uuid string or UUIDTools::UUID object to `id` attribute.  A formatted uuid string and UUIDTools::UUID object will be converted 16 byte binary data when you save a model.
+
+        user1 = User.create(:id => UUIDTools::UUID.parse("f311427a-954c-46f5-92df-3d37f56b5b41").raw, :user_name => "user1")
+        user1.formatted_id
+            #=> "f311427a-954c-46f5-92df-3d37f56b5b41"
+        user2 = User.create(:id => "206b38d7-3b5f-4645-b5b2-5e7efea1d3ca", :user_name => "user2")
+        user2.formatted_id
+            #=> "206b38d7-3b5f-4645-b5b2-5e7efea1d3ca"
+        user3 = User.create(:id => UUIDTools::UUID.parse("c81836c5-309a-4608-bf1a-5fe343081a92"), :user_name => "user3")
+        user3.formatted_id
+            #=> "c81836c5-309a-4608-bf1a-5fe343081a92"
+
+5. The `uuid_as_primary_key` method also adds `find_by_formatted_id` class method to retrive model from data store with a formatted uuid string.
+
+        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/activerecord_uuid_as_pk.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord_uuid_as_pk/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "activerecord_uuid_as_pk"
+  gem.version       = ActiveRecordUUIDAsPK::VERSION
+  gem.authors       = ["Shou Takenaka"]
+  gem.email         = ["shou_takenaka@guihua.jp"]
+  gem.description   = %q{activerecord_uuid_as_pk is a extension for ActiveRecord to enable to use uuid for id attribute.}
+  gem.summary       = %q{ActiveRecord extension to use uuid for id 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 "uuidtools"
+  gem.add_development_dependency "rails"
+  gem.add_development_dependency "mysql2"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "simplecov"
+end

data/lib/activerecord_uuid_as_pk.rb

@@ -0,0 +1,58 @@
+require "uuidtools"
+require "activerecord_uuid_as_pk/version"
+
+
+module ActiveRecordUUIDAsPK
+
+  require "activerecord_uuid_as_pk/railtie" if defined?(Rails)
+
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+
+  module ClassMethods
+
+    def uuid_as_primary_key()
+      self.primary_key = "uuid"
+
+      define_method "formatted_id" do
+        return self.id.present? ? UUIDTools::UUID.parse_raw(self.id).to_s : nil
+      end
+
+      define_method "hex_id" do
+        return self.id.present? ? UUIDTools::UUID.parse_raw(self.id).hexdigest : nil
+      end
+
+      before_create do
+        if self.id.nil?
+          self.id = UUIDTools::UUID.timestamp_create.raw
+        elsif self.id.is_a?(UUIDTools::UUID)
+          self.id = self.id.raw
+        elsif self.id.is_a?(String)
+          if self.id.size != 16
+            if self.id =~ /^([0-9a-f]{8})-([0-9a-f]{4})-([0-9a-f]{4})-([0-9a-f]{2})([0-9a-f]{2})-([0-9a-f]{12})$/
+              self.id = UUIDTools::UUID.parse(self.id).raw
+            else
+              self.id = UUIDTools::UUID.timestamp_create.raw
+            end
+          end
+        else
+          self.id = UUIDTools::UUID.timestamp_create.raw
+        end
+      end
+
+      (class << self; self end).class_eval do
+
+        define_method "find_by_formatted_id" do |uuid|
+          raw_uuid = UUIDTools::UUID.parse(uuid).raw
+          return self.find_by_uuid(raw_uuid)
+        end
+
+      end
+    end
+
+  end
+
+end

data/lib/activerecord_uuid_as_pk/railtie.rb

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

data/lib/activerecord_uuid_as_pk/version.rb

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

data/spec/activerecord_uuid_as_pk/activerecord_uuid_as_pk_spec.rb

@@ -0,0 +1,124 @@
+require "spec_helper"
+
+
+describe ActiveRecordUUIDAsPK, ".find_by_formatted_id" do
+
+  before do
+    uuid = UUIDTools::UUID.parse("488995f0-a0b4-11e2-9e96-0800200c9a66")
+    Account.create!(:id => uuid.raw, :name => "user1")
+  end
+
+
+  it "returns a found model" do
+    o = Account.find_by_formatted_id("488995f0-a0b4-11e2-9e96-0800200c9a66")
+    o.name.should == "user1"
+  end
+
+
+  it "returns nil when no model found" do
+    o = Account.find_by_formatted_id("dba654cd-c798-483b-9eff-a0e68ce10846")
+    o.should be_nil
+  end
+
+end
+
+
+describe ActiveRecordUUIDAsPK, "#before_create" do
+
+  context "when uuid is set UUIDTools::UUID" do
+    it "converts the uuid to raw" do
+      uuid = UUIDTools::UUID.parse("28316607-02d0-4069-917a-8c29b25674d4")
+      o = Account.create!(:id => uuid, :name => "user1")
+      o.id.should == uuid.raw
+    end
+  end
+
+
+  context "when uuid is set raw uuid string" do
+    it "does nothing" do
+      uuid = UUIDTools::UUID.parse("ec9621be-5293-4f35-aa27-f993c754ec5c")
+      o = Account.create!(:id => uuid.raw, :name => "user1")
+      o.id.should == uuid.raw
+    end
+  end
+
+
+  context "when uuid is set uuid format string" do
+    it "converts the uuid string to raw" do
+      o = Account.create!(:id => "5864d76a-2738-415d-9e76-87326ae9d73d", :name => "user1")
+      o.id.should == UUIDTools::UUID.parse("5864d76a-2738-415d-9e76-87326ae9d73d").raw
+    end
+  end
+
+
+  context "when uuid is set other string" do
+    it "generates a new uuid" do
+      uuid = UUIDTools::UUID.parse("a7b62e8f-02ea-4ee2-adbd-ce579e2a1ab2")
+      UUIDTools::UUID.stub(:timestamp_create).and_return(uuid)
+      o = Account.create!(:id => "other_string", :name => "user1")
+      o.id.should == uuid.raw
+    end
+  end
+
+
+  context "when uuid is neither Stirng nor UUIDTools::UUID" do
+    it "generates a new uuid" do
+      uuid = UUIDTools::UUID.parse("3acab61b-1dbc-4636-8aa5-726a777b64b7")
+      UUIDTools::UUID.stub(:timestamp_create).and_return(uuid)
+      o = Account.create!(:id => 1, :name => "user1")
+      o.id.should == uuid.raw
+    end
+  end
+
+
+  context "when uuid is nil" do
+    it "generates a new uuid" do
+      uuid = UUIDTools::UUID.parse("a7b62e8f-02ea-4ee2-adbd-ce579e2a1ab2")
+      UUIDTools::UUID.stub(:timestamp_create).and_return(uuid)
+      o = Account.create!(:id => nil, :name => "user1")
+      o.id.should == uuid.raw
+    end
+  end
+
+end
+
+
+describe ActiveRecordUUIDAsPK, "#formatted_id" do
+
+  context "when uuid is set value" do
+    it "returns a uuid string" do
+      o = Account.create!(:id => "71366243-a184-418f-bce1-3d1f5c28d669")
+      o.formatted_id.should == "71366243-a184-418f-bce1-3d1f5c28d669"
+    end
+  end
+
+
+  context "when uuid is nil" do
+    it "returns nil" do
+      o = Account.new
+      o.formatted_id.should be_nil
+    end
+  end
+
+end
+
+
+describe ActiveRecordUUIDAsPK, "#hex_id" do
+
+  context "when uuid is set value" do
+    it "returns a uuid string" do
+      uuid = UUIDTools::UUID.parse("a3ea6c43-3971-426f-b488-99c5d141bce5")
+      o = Account.create!(:id => uuid.to_s)
+      o.hex_id.should == uuid.hexdigest
+    end
+  end
+
+
+  context "when uuid is nil" do
+    it "returns nil" do
+      o = Account.new
+      o.hex_id.should be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "rubygems"
+require "bundler/setup"
+
+require "simplecov"
+SimpleCov.start do
+  add_filter "spec"
+  add_filter "test_app"
+  add_filter "vendor"
+end
+
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+ENV["RAILS_ENV"] ||= "test"
+require "#{File.dirname(__FILE__)}/../test_app/config/environment"
+require "rspec/rails"
+require "rspec/autorun"
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+end

data/test_app/Gemfile

@@ -0,0 +1,34 @@
+source 'https://rubygems.org'
+
+gem 'rails', '3.2.13'
+gem 'mysql2'
+
+
+# Gems used only for assets and not required
+# in production environments by default.
+#group :assets do
+#  gem 'sass-rails',   '~> 3.2.3'
+#  gem 'coffee-rails', '~> 3.2.1'
+#
+#  # See https://github.com/sstephenson/execjs#readme for more supported runtimes
+#  # gem 'therubyracer', :platforms => :ruby
+#
+#  gem 'uglifier', '>= 1.0.3'
+#end
+#
+#gem 'jquery-rails'
+
+# To use ActiveModel has_secure_password
+# gem 'bcrypt-ruby', '~> 3.0.0'
+
+# To use Jbuilder templates for JSON
+# gem 'jbuilder'
+
+# Use unicorn as the app server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'debugger'

data/test_app/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.