uuidify 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a9e959197e4e8a62bcbb16ded7067741fbdab5c
+  data.tar.gz: 1c92ad53e4716ee3a8c23aee7da0cca921f4e196
+SHA512:
+  metadata.gz: d3dd3353d5fd4339fe2b9b427589bd755708bdb804969b7c298d16442741c9e7aa4317832f10fc5c7b0dae6e3aa23656ec2ad379489612132e475a5b635d067d
+  data.tar.gz: 414d085b9e63883137c205c00a994e5d6f62881e937b51e5eb26b916172295cad910bea808e2a210d1b1eb4d326616fd100c6bd071f0bd30273adc810526449c

checksums.yaml.gz.asc

@@ -0,0 +1,12 @@
+-----BEGIN PGP SIGNATURE-----
+Version: GnuPG/MacGPG2 v2.0.19 (Darwin)
+Comment: GPGTools - http://gpgtools.org
+
+iQEcBAABCgAGBQJSYAHrAAoJEP5F5V2hilTWVTsH/RvqX1tXbzrismXLpW6+B/Z9
+Qy6u0z1CpMQrfDYCei0fAcjZgAcoedU9i0k/9CsKk35qGEEr1GM6+9K8Sfyzeos5
+LQgEcPUcrn+dQWHP+pTh/qU7kVsMI0xiWE4hVXrzgcdndS9CK8r2T9wmGoNqBKtm
+JR3CXH9W9gqDxc2E3ddX0FqsP7g6QzW5GmaVOo2DcT50UBuCtY88MeLz9Dqg0S1Q
+HB9w/lUXKb9yq9NxmzVJVC/glFja6MV8arKvtIXGpyfs9aghmBDwyhn9GDwiou4j
+KuLJpMjW6w7dsK0bbtBHAfUVEWY4Dg7H2xj0Kda+FPcp6za0ewieBwcskZ/vRbw=
+=3Z04
+-----END PGP SIGNATURE-----

data/LICENSE

@@ -0,0 +1,31 @@
+Copyright (c) 2013 Grant T. Olson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of the Grant T. Olson nor the names of
+      additional contributors may be used to endorse or promote
+      products derived from this software without specific prior
+      written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,25 @@
+Uuidify
+=======
+
+Add UUIDs to existing ActiveRecord models.
+
+To install:
+
+    rake uuidify:install:migrations
+    rake db:migrate
+
+To enable on a specific model:
+
+    class Foo < ActiveRecord::Base
+      uuidify
+    end
+
+To get/set uuids:
+
+    Foo.new.uuid
+    Foo.new.uuid = UUIDTools::UUID.timestamp_create
+
+ To gc orphan records:
+
+    Foo.garbage_collect_uuids # single model
+    Uuidify.garbage_collect_uuids # everything, even if the model doesn't exist in the source

data/Rakefile

@@ -0,0 +1,44 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Uuidify'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.main = "lib/uuidify.rb"
+end
+
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Copy a usable database.yml file if we don't have one"
+task :config_database_yml do
+  if !File.exists? "./spec/dummy/config/database.yml"
+    sh "cp ./spec/dummy/config/database.yml.sample ./spec/dummy/config/database.yml"
+  end
+end
+
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => [:config_database_yml, "app:db:drop", "app:db:create", "app:db:migrate"])
+
+task :default => :spec

data/app/models/uuidify/uuid.rb

@@ -0,0 +1,4 @@
+# Store the relationship between UUID and ActiveRecord instance
+class Uuidify::Uuid < ActiveRecord::Base
+  attr_accessible :model_name, :model_id, :model_uuid
+end

data/db/migrate/20130612143347_create_uuidify_uuids.rb

@@ -0,0 +1,18 @@
+class CreateUuidifyUuids < ActiveRecord::Migration
+  def up
+    create_table :uuidify_uuids do |t|
+      t.string :model_name
+      t.integer :model_id
+#      t.string :model_uuid, :limit => 36
+    end
+    
+    execute "ALTER TABLE uuidify_uuids ADD COLUMN model_uuid BINARY(16)"
+    add_index :uuidify_uuids, [:model_name, :model_id], :unique => true
+    add_index :uuidify_uuids, :model_uuid, :unique => true
+    add_index :uuidify_uuids, [:model_uuid, :model_id], :unique => true
+  end
+
+  def down
+    drop_table :uuidify_uuids
+  end
+end

data/lib/tasks/guidify_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :guidify do
+#   # Task goes here
+# end

data/lib/uuidify/engine.rb

@@ -0,0 +1,5 @@
+module Uuidify
+  class Engine < ::Rails::Engine
+    isolate_namespace Uuidify
+  end
+end

data/lib/uuidify/uuidify_concern.rb

@@ -0,0 +1,69 @@
+require 'uuidtools'
+require 'active_support/concern'
+require_relative 'uuidify_exception'
+
+# Mixin to add uuids to an active record model.
+module Uuidify::UuidifyConcern
+  extend ActiveSupport::Concern
+  
+  included do
+    before_destroy :destroy_uuid
+  end
+
+  module ClassMethods
+    # .find_by_uuid.  Used lookup so we know it's not rails magic.
+    def lookup_uuid(uuid)
+      uuid = Uuidify::Uuid.where(:model_uuid => uuid.raw, :model_name => self.to_s).first
+      uuid ? find(uuid.model_id) : nil
+    end
+
+    # Delete entries where we don't have a model that can be instantiated anymore.
+    def garbage_collect_uuids
+      Uuidify::Uuid.where(:model_name => self.to_s).find_each do |uuid|
+        if !where(:id => uuid.model_id).first
+          uuid.destroy
+        end
+      end
+    end
+  end
+
+  # Return a UUID, creating it if needed.
+  def uuid
+    abort_if_unsaved!
+
+    model_name = self.class.to_s
+    model_id = self.id
+
+    uuid = Uuidify::Uuid.where(:model_name => model_name, :model_id => model_id).first
+
+    if uuid.nil?
+      new_uuid = UUIDTools::UUID.timestamp_create.raw
+      uuid = Uuidify::Uuid.create(:model_name => model_name, :model_id => self.id, :model_uuid => new_uuid)
+      uuid.save!
+    end
+    
+    UUIDTools::UUID.parse_raw(uuid.model_uuid)
+  end
+
+  # Assign a UUID that came from an external source.
+  def uuid= new_uuid
+    abort_if_unsaved!
+    Uuidify::Uuid.where(:model_name => self.class.to_s, :model_id => self.id).first_or_create!.update_column(:model_uuid, new_uuid.raw)
+  end
+  
+  private
+
+  def abort_if_unsaved!
+    if self.id.nil?
+      raise Uuidify::UuidifyException, "This model hasn't been persisted yet and Uuidify doesn't want to implicitly do that.  Won't create uuid"
+    end
+  end
+
+  def destroy_uuid
+    model_name = self.class.to_s
+    model_id = self.id
+    uuid = Uuidify::Uuid.where(:model_name => model_name, :model_id => model_id).first
+    uuid.destroy if uuid
+  end
+end
+

data/lib/uuidify/uuidify_exception.rb

@@ -0,0 +1,2 @@
+class Uuidify::UuidifyException < StandardError
+end

data/lib/uuidify/version.rb

@@ -0,0 +1,3 @@
+module Uuidify
+  VERSION = "0.3.0"
+end

data/lib/uuidify.rb

@@ -0,0 +1,22 @@
+require 'uuidify/engine'
+require 'uuidify/uuidify_concern'
+
+# Helper like acts_as_X so we don't deal with the concern mixin directly.
+def uuidify
+  include Uuidify::UuidifyConcern
+end
+
+module Uuidify
+  # Clean up all orphaned and useless UUIDs in the database, whether or not we can
+  # resolve them to a class.
+  def self.garbage_collect_uuids
+    Uuidify::Uuid.select("model_name").group("model_name").each  do |m|
+      begin
+        klass = m.model_name.constantize
+        klass.garbage_collect_uuids
+      rescue NameError => ex # Class that doesn't exist in current project
+        Uuidify::Uuid.where(:model_name => m.model_name).delete_all
+      end
+    end
+  end
+end

data/lib/uuidify.rb~

@@ -0,0 +1,46 @@
+# = Uuidify
+#
+# Add UUIDs to existing ActiveRecord models.
+#
+# To install:
+# 
+#    rake uuidify:install:migrations
+#    rake db:migrate
+#
+# To enable on a specific model:
+#
+#    class Foo < ActiveRecord::Base
+#      uuidify
+#    end
+#
+# To get/set uuids:
+#
+#    Foo.new.uuid
+#    Foo.new.uuid = UUIDTools::UUID.timestamp_create
+#
+# To gc orphan records:
+#
+#    Foo.garbage_collect_uuids # single model
+#    Uuidify.garbage_collect_uuids # everything, even if the model doesn't exist in the source
+require 'uuidify/engine'
+require 'uuidify/uuidify_concern'
+
+# Helper like acts_as_X so we don't deal with the concern mixin directly.
+def uuidify
+  include Uuidify::UuidifyConcern
+end
+
+module Uuidify
+  # Clean up all orphaned and useless UUIDs in the database, whether or not we can
+  # resolve them to a class.
+  def self.garbage_collect_uuids
+    Uuidify::Uuid.select("model_name").group("model_name").each  do |m|
+      begin
+        klass = m.model_name.constantize
+        klass.garbage_collect_uuids
+      rescue NameError => ex # Class that doesn't exist in current project
+        Uuidify::Uuid.where(:model_name => m.model_name).delete_all
+      end
+    end
+  end
+end

data/spec/dummy/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.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/bar.rb

@@ -0,0 +1,3 @@
+# Bar does not include uuidify
+class Bar < ActiveRecord::Base
+end

data/spec/dummy/app/models/foo.rb

@@ -0,0 +1,3 @@
+class Foo < ActiveRecord::Base
+  uuidify
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>