has_uuid 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Norbert Crombach
+
+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.markdown

@@ -0,0 +1,60 @@
+has_uuid
+========
+
+[has_uuid](http://github.com/troessner/has_uuid) provides basic [UUID](http://en.wikipedia.org/wiki/Universally_Unique_Identifier) assignment methods for ActiveRecord objects.
+
+It depends on the [uuidtools](http://uuidtools.rubyforge.org/) gem.
+
+This is a fork - full credits for the source code go to [has_uuid](http://github.com/norbert/has_uuid).
+What I changed:
+a) Made it rails 3.1 compatible.
+b) Bundler'ized it - you can now use and manage it as a gem, not as a rails plugin.
+
+Installation
+------------
+
+Add
+
+>> gem 'has_uuid'
+
+to your Gemfile and run
+
+>> bundle install
+
+Usage
+-----
+
+	class Post < ActiveRecord::Base
+	  # automatically assign a UUID to the "uuid" column on create
+	  has_uuid
+	end
+
+	class Comment < ActiveRecord::Base
+	  # skip assignment on create
+	  has_uuid :auto => false
+	end
+
+	class User < ActiveRecord::Base
+	  # store the UUID in the "token" column, generate version 1 UUIDs
+	  has_uuid :column => :token, :generator => :timestamp
+	end
+
+	# assign a UUID if a valid one is not already present
+	@post.assign_uuid
+
+	# assign a UUID, replacing whatever is already there
+	@post.assign_uuid(:force => true)
+
+	# assign a UUID and save, replacing whatever is there
+	@post.assign_uuid!
+
+	# check if the current UUID is valid
+	@post.uuid_valid?
+
+
+Credits
+-------
+
+* Norbert Crombach
+* Todd Eichel
+* Joerg Batterman

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the has_uuid plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the has_uuid plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'has_uuid'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/has_uuid.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "has_uuid/version"
+
+Gem::Specification.new do |s|
+  s.name        = "has_uuid"
+  s.version     = HasUuid::VERSION
+  s.authors     = ["Timo Rößner"]
+  s.email       = ["timo.roessner@googlemail.com"]
+  s.homepage    = ""
+  s.summary     = %q{The has_uuid gem adds a UUID to your AR models.}
+  s.description = %q{The has_uuid gem adds a UUID to your AR models. See the README for details.}
+
+  s.rubyforge_project = "has_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_dependency 'activerecord'
+  s.add_dependency 'uuidtools'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/has_uuid/version.rb

@@ -0,0 +1,3 @@
+module HasUuid
+  VERSION = "0.0.2"
+end

data/lib/has_uuid.rb

@@ -0,0 +1,71 @@
+require 'uuidtools'
+
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+    # Use this extension to assign a UUID to your models.
+    #
+    # Example:
+    #
+    #    class Post < ActiveRecord::Base
+    #      has_uuid
+    #    end
+    #
+    # That is all.
+    module HasUuid
+      GENERATORS = [:random, :timestamp] #:nodoc:
+
+      # Configuration options are:
+      #
+      # * <tt>:column</tt> - specifies the column in which to store the UUID (default: +uuid+).
+      # * <tt>:auto</tt> - specifies whether the plugin should assign a UUID on create (default: true).
+      # * <tt>:generator</tt> - sets the UUID generator. Possible values are <tt>:random</tt> for version 4 (default) and <tt>:timestamp</tt> for version 1.
+      def has_uuid(options = {})
+        options.reverse_merge!(:auto => true, :generator => :random, :column => :uuid)
+        raise ArgumentError, "invalid UUID generator" unless GENERATORS.include?(options[:generator])
+
+        class_eval do
+          send :include, InstanceMethods # hide include from RDoc
+
+          if options[:auto]
+            # always applies to subclasses
+            before_validation(:on => :create) { assign_uuid }
+          end
+
+          class_inheritable_reader :uuid_column
+          write_inheritable_attribute :uuid_column, options[:column]
+
+          class_inheritable_reader :uuid_generator
+          write_inheritable_attribute :uuid_generator, options[:generator]
+        end
+      end
+
+      module InstanceMethods #:nodoc:
+        def assign_uuid(options = {})
+          return if uuid_valid? unless options[:force]
+
+          uuid = UUIDTools::UUID.send("#{uuid_generator}_create").to_s
+          send("#{uuid_column}=", uuid)
+        end
+
+        def assign_uuid!
+          assign_uuid(:force => true)
+          save!
+        end
+
+        def uuid_valid?
+          uuid = send(uuid_column)
+          return false if uuid.blank?
+          begin
+            UUIDTools::UUID.parse(uuid).kind_of?(UUIDTools::UUID)
+          rescue ArgumentError, TypeError
+            false
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval do
+  extend ActiveRecord::Acts::HasUuid
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'has_uuid'

data/test/has_uuid_test.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class Widget < ActiveRecord::Base
+  has_uuid
+end
+
+class Thingy < ActiveRecord::Base
+  has_uuid :auto => false
+end
+
+class HasUuidTest < Test::Unit::TestCase
+  def test_should_assign_uuid
+    @widget = Widget.new
+    @widget.assign_uuid
+    assert @widget.new_record?
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_force_assign_uuid
+    original_uuid = UUIDTools::UUID.random_create.to_s
+    @widget = Widget.new(:uuid => original_uuid)
+    @widget.assign_uuid(:force => true)
+    assert_not_equal original_uuid, @widget.uuid
+  end
+
+  def test_should_force_assign_uuid_and_save
+    @widget = Widget.new
+    @widget.assign_uuid!
+    assert !@widget.new_record?
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_assign_uuid_on_create
+    @widget = Widget.new
+    assert_nil @widget.uuid
+    @widget.save
+    @widget.reload
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_check_uuid_validity
+    @widget = Widget.new
+    assert !@widget.uuid_valid?
+    @widget.uuid = "test"
+    assert !@widget.uuid_valid?
+    @widget.uuid = UUIDTools::UUID.random_create.to_s
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_not_overwrite_valid_uuid
+    manual_uuid = UUIDTools::UUID.random_create.to_s
+    @widget = Widget.new(:uuid => manual_uuid)
+    @widget.save
+    assert_equal manual_uuid, @widget.uuid
+  end
+
+  def test_should_assign_uuid_when_nil
+    @widget = Widget.new
+    @widget.save
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_assign_uuid_when_blank
+    @widget = Widget.new(:uuid => "")
+    @widget.save
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_assign_uuid_when_invalid
+    @widget = Widget.new(:uuid => "test")
+    assert !@widget.uuid_valid?
+    @widget.save
+    assert @widget.uuid_valid?
+  end
+
+  def test_should_not_assign_uuid_on_create_for_thingies
+    # such a weird name for a class
+    @thingy = Thingy.new
+    @thingy.save
+    @thingy.reload
+    assert_nil @thingy.uuid
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'test/unit'
+
+require 'active_record'
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+require File.dirname(__FILE__) + '/../lib/has_uuid'
+
+silence_stream(STDOUT) do
+  ActiveRecord::Schema.define do
+    create_table :widgets do |t|
+      t.string :uuid
+    end
+
+    create_table :thingies do |t|
+      t.string :uuid
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: has_uuid
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- !binary |
+  VGltbyBSw7bDn25lcg==
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-31 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: activerecord
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: uuidtools
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: sqlite3
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: The has_uuid gem adds a UUID to your AR models. See the README for details.
+email: 
+- timo.roessner@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- has_uuid.gemspec
+- lib/has_uuid.rb
+- lib/has_uuid/version.rb
+- rails/init.rb
+- test/has_uuid_test.rb
+- test/test_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: has_uuid
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: The has_uuid gem adds a UUID to your AR models.
+test_files: []
+