vidibus-uuid 0.3.5

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Andre Pankratz
+
+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.rdoc

@@ -0,0 +1,70 @@
+= vidibus-uuid
+
+This gem is part of the open source SOA framework Vidibus: http://www.vidibus.org
+
+It generates compact UUIDs. Basically, this is an abstraction of http://github.com/assaf/uuid
+
+
+== Installation
+
+Add the dependency to the Gemfile of your application:
+
+  gem "vidibus-uuid"
+
+Then call bundle install on your console.
+
+
+== Usage
+
+  Vidibus::Uuid.generate
+  # => "b063263064e0012d47b658b035f038ab"
+
+
+=== Usage in Mongoid model
+
+Include the Vidibus::Uuid::Mongoid module in your Mongoid model:
+
+  class MyModel
+    include Mongoid::Document
+    include Vidibus::Uuid::Mongoid
+  end
+
+This will extend your model as follows:
+
+  class MyModel
+    include Mongoid::Document
+  
+    field :uuid
+    index :uuid, :unique => true
+  
+    before_validation :generate_uuid
+    validates :uuid, :uniqueness => true, :uuid => true
+  
+    private
+  
+    def generate_uuid
+      return unless new_record?
+      self.uuid ||= Vidibus::Uuid.generate
+    end
+  end
+
+
+=== Validation of custom attributes
+
+To verfify that custom attributes are formatted as UUID, add the uuid validator to your model:
+
+  class MyModel
+    include Mongoid::Document
+    field :product_uuid
+    validates :product_uuid, :uuid => { :allow_blank => true }
+  end
+
+
+== Copyright
+
+Copyright (c) 2010 Andre Pankratz. See LICENSE for details.
+
+
+== Thank you!
+
+The development of this gem was sponsored by Käuferportal: http://www.kaeuferportal.de

data/Rakefile

@@ -0,0 +1,46 @@
+require "rubygems"
+require "rake"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gem|
+    gem.name = "vidibus-uuid"
+    gem.summary = %Q{Provides UUID generation through UUID gem.}
+    gem.description = %Q{Provides UUID generation for Mongoid models. It includes a validator for UUIDs.}
+    gem.email = "andre@vidibus.com"
+    gem.homepage = "http://github.com/vidibus/vidibus-uuid"
+    gem.authors = ["Andre Pankratz"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "mongoid", "= 2.0.0.beta.15"
+    gem.add_dependency "uuid"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << "lib" << "spec"
+  spec.spec_files = FileList["spec/**/*_spec.rb"]
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_files = FileList['spec/vidibus/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', '^spec,/gems/']
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+require "rake/rdoctask"
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?("VERSION") ? File.read("VERSION") : ""
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "vidibus-uuid #{version}"
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  rdoc.options << "--charset=utf-8"
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.3.5

data/config/locale/en.yml

@@ -0,0 +1,5 @@
+en:
+  activemodel:
+    errors:
+      messages:
+        invalid_uuid: "is not a valid UUID"

data/lib/vidibus-uuid.rb

@@ -0,0 +1,6 @@
+require "vidibus/uuid"
+require "vidibus/validate_uuid"
+require "vidibus/uuid/mongoid"
+
+# Add UUID validator
+ActiveModel::Validations.send(:include, Vidibus::ValidateUuid)

data/lib/vidibus/uuid.rb

@@ -0,0 +1,9 @@
+require "uuid"
+
+module Vidibus
+  module Uuid
+    def self.generate
+      UUID.new.generate(:compact)
+    end
+  end
+end

data/lib/vidibus/uuid/mongoid.rb

@@ -0,0 +1,25 @@
+module Vidibus
+  module Uuid
+    module Mongoid
+      extend ActiveSupport::Concern
+      included do
+        field :uuid
+        index :uuid, :unique => true
+        before_validation :generate_uuid
+        validates :uuid, :uniqueness => true, :uuid => true
+      end
+      
+      # Returns UUID as param for urls.
+      def to_param
+        uuid
+      end
+      
+      private
+      
+      # Sets unique UUID unless uuid is present.
+      def generate_uuid
+        self.uuid ||= Vidibus::Uuid.generate
+      end
+    end
+  end
+end

data/lib/vidibus/validate_uuid.rb

@@ -0,0 +1,13 @@
+module Vidibus
+  module ValidateUuid
+    class UuidValidator < ActiveModel::EachValidator
+      
+      # Ensures that every value is of a valid compact UUID format
+      def validate_each(record, attribute, value)
+        unless value.to_s.match(/^[a-z0-9]{32}$/)
+          record.errors.add(attribute, :invalid_uuid)
+        end
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "rubygems"
+require "active_support/core_ext"
+require "spec"
+require "mongoid"
+require "uuid"
+require "vidibus-uuid"
+
+Mongoid.configure do |config|
+  name = "vidibus-uuid_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+Spec::Runner.configure do |config|  
+  config.mock_with :rspec
+  config.before(:each) do  
+    Mongoid.master.collections.select { |c| c.name != 'system.indexes' }.each(&:drop)  
+  end
+end
+
+I18n.load_path += Dir[File.join('config', 'locale', '**', '*.{rb,yml}')]

data/spec/vidibus/uuid/mongoid_spec.rb

@@ -0,0 +1,68 @@
+require "spec_helper"
+
+class Model
+  include Mongoid::Document
+  include Vidibus::Uuid::Mongoid
+  embeds_many :children
+end
+
+class Child
+  include Mongoid::Document
+  include Vidibus::Uuid::Mongoid
+  embedded_in :model, :inverse_of => :children
+end
+
+describe "Vidibus::Uuid::Mongoid" do
+  let(:model) { Model.create }
+  let(:new_model) { Model.new }
+  let(:uuid) { Vidibus::Uuid.generate }
+
+  it "should add an uuid field to model" do
+    model.should respond_to(:uuid)
+  end
+  
+  it "should generate a valid UUID before creation" do
+    model.uuid.length.should eql(32)
+  end
+  
+  it "should keep the UUID persistent" do
+    uuid = model.uuid
+    model.save!
+    model.uuid.should eql(uuid)
+  end
+  
+  it "should allow assignment of UUID" do
+    new_model.uuid = uuid
+    new_model.save
+    new_model.uuid.should eql(uuid)
+  end
+  
+  it "should allow changes to UUID" do
+    model.update_attributes(:uuid => uuid)
+    model.uuid.should eql(uuid)
+  end
+  
+  it "should verify format of UUID" do
+    model.update_attributes(:uuid => "as")
+    model.errors[:uuid].length.should eql(1)
+  end
+  
+  it "should verify uniqueness of UUID in class" do
+    another_model = Model.create(:uuid => model.uuid)
+    another_model.errors[:uuid].should have(1).error
+  end
+  
+  it "should verify uniqueness of UUID in embedded documents" do
+    first_child = model.children.create!
+    second_child = model.children.create!
+    second_child.update_attributes(:uuid => first_child.uuid)
+    second_child.errors[:uuid].should have(1).error
+    model.reload
+    model.children[0].uuid.should_not eql(model.children[1].uuid)
+  end
+  
+  it "should set UUID as default param" do
+    model.should respond_to(:to_param)
+    model.to_param.should eql(model.uuid)
+  end
+end

data/spec/vidibus/uuid_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe "Vidibus::Uuid" do
+  it "should return a compact UUID" do
+    uuid = Vidibus::Uuid.generate
+    uuid.length.should eql(32)
+  end
+end

data/spec/vidibus/validate_uuid_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+class ModelWithValidations
+  include ActiveModel::Validations
+  attr_accessor :required_uuid, :optional_uuid
+  validates :required_uuid, :uuid => true
+  validates :optional_uuid, :uuid => { :allow_blank => true }
+end
+
+describe "Vidibus::ValidateUuid::UuidValidator" do
+  let(:model) { ModelWithValidations.new }
+
+  it "should be available as uuid validator for attribute required_uuid" do
+    ModelWithValidations.validators_on(:required_uuid).first.should be_a_kind_of(Vidibus::ValidateUuid::UuidValidator)
+  end
+  
+  it "should be available as uuid validator for attribute optional_uuid" do
+    ModelWithValidations.validators_on(:optional_uuid).first.should be_a_kind_of(Vidibus::ValidateUuid::UuidValidator)
+  end
+  
+  it "should validate ddeb4500668e012d47bb58b035f038ab" do
+    model.required_uuid = "ddeb4500668e012d47bb58b035f038ab"
+    model.should be_valid
+  end
+  
+  it "should add an error for ddeb4500668e0" do
+    model.required_uuid = "ddeb4500668e0"
+    model.should be_invalid
+    model.errors[:required_uuid].should have(1).error
+    model.errors[:required_uuid].first.should eql("is not a valid UUID")
+  end
+
+  it "should add an error on required_uuid, if empty" do
+    model.required_uuid = ''
+    model.should be_invalid
+    model.errors[:required_uuid].should have(1).error
+  end
+  
+  it "should allow emtpy optional_uuid" do
+    model.required_uuid = "ddeb4500668e012d47bb58b035f038ab"
+    model.optional_uuid = ""
+    model.should be_valid
+  end
+end

data/vidibus-uuid.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vidibus-uuid}
+  s.version = "0.3.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andre Pankratz"]
+  s.date = %q{2010-08-09}
+  s.description = %q{Provides UUID generation for Mongoid models. It includes a validator for UUIDs.}
+  s.email = %q{andre@vidibus.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "config/locale/en.yml",
+     "lib/vidibus-uuid.rb",
+     "lib/vidibus/uuid.rb",
+     "lib/vidibus/uuid/mongoid.rb",
+     "lib/vidibus/validate_uuid.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/vidibus/uuid/mongoid_spec.rb",
+     "spec/vidibus/uuid_spec.rb",
+     "spec/vidibus/validate_uuid_spec.rb",
+     "vidibus-uuid.gemspec"
+  ]
+  s.homepage = %q{http://github.com/vidibus/vidibus-uuid}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides UUID generation through UUID gem.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/vidibus/uuid/mongoid_spec.rb",
+     "spec/vidibus/uuid_spec.rb",
+     "spec/vidibus/validate_uuid_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+      s.add_runtime_dependency(%q<uuid>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+      s.add_dependency(%q<uuid>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<mongoid>, ["= 2.0.0.beta.15"])
+    s.add_dependency(%q<uuid>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: vidibus-uuid
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 5
+  version: 0.3.5
+platform: ruby
+authors: 
+- Andre Pankratz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-09 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196477
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 15
+        version: 2.0.0.beta.15
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: uuid
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Provides UUID generation for Mongoid models. It includes a validator for UUIDs.
+email: andre@vidibus.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- config/locale/en.yml
+- lib/vidibus-uuid.rb
+- lib/vidibus/uuid.rb
+- lib/vidibus/uuid/mongoid.rb
+- lib/vidibus/validate_uuid.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/vidibus/uuid/mongoid_spec.rb
+- spec/vidibus/uuid_spec.rb
+- spec/vidibus/validate_uuid_spec.rb
+- vidibus-uuid.gemspec
+has_rdoc: true
+homepage: http://github.com/vidibus/vidibus-uuid
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides UUID generation through UUID gem.
+test_files: 
+- spec/spec_helper.rb
+- spec/vidibus/uuid/mongoid_spec.rb
+- spec/vidibus/uuid_spec.rb
+- spec/vidibus/validate_uuid_spec.rb