mongoid_upk 0.0.2

data/.rvmrc

@@ -0,0 +1,83 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p0@mongoid_upk"
+
+#
+# Uncomment the following lines if you want to verify rvm version per project
+#
+# rvmrc_rvm_version="1.10.2" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+#
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+#
+# The variable PROJECT_JRUBY_OPTS requires the following to be run in shell:
+#
+#    chmod +x ${rvm_path}/hooks/after_use_jruby_opts
+#
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && ! command -v bundle >/dev/null
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && command -v bundle
+# then
+#   bundle install
+# fi
+
+if [[ $- == *i* ]] # check for interactive shells
+then
+    echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+else 
+	echo "Using: $GEM_HOME" # don't use colors in interactive shells
+fi
+

data/Gemfile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+source "https://rubygems.org"
+
+gem "bson_ext"
+gem "mongoid"
+gem "uuid"
+gem "activesupport"
+
+group :development, :test do
+  gem "rake"
+  gem "rspec"
+  gem "database_cleaner"
+  gem "jeweler"
+
+  gem "pry"
+  gem "pry-doc"
+end

data/Gemfile.lock

@@ -0,0 +1,73 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
+      builder (~> 3.0.0)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bson (1.5.2)
+    bson_ext (1.5.2)
+      bson (= 1.5.2)
+    builder (3.0.0)
+    coderay (1.0.5)
+    database_cleaner (0.7.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.5)
+    macaddr (1.5.0)
+      systemu (>= 2.4.0)
+    method_source (0.7.0)
+    mongo (1.5.2)
+      bson (= 1.5.2)
+    mongoid (2.4.3)
+      activemodel (~> 3.1)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    multi_json (1.0.4)
+    pry (0.9.8.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7)
+      slop (>= 2.4.3, < 3)
+    pry-doc (0.4.0)
+      pry (>= 0.9.0)
+      yard (~> 0.7.4)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    slop (2.4.3)
+    systemu (2.4.2)
+    tzinfo (0.3.31)
+    uuid (2.3.5)
+      macaddr (~> 1.0)
+    yard (0.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bson_ext
+  database_cleaner
+  jeweler
+  mongoid
+  pry
+  pry-doc
+  rake
+  rspec
+  uuid

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Christoph 'asaaki' Grabo
+
+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,84 @@
+# Mongoid::UPK
+
+Mongoid::UPK generates more unique `_id` by using UUID.
+
+UPK stands for "unique primary key" or "uuid primary key".
+
+## Install
+
+```bash
+gem install mongoid_upk
+```
+
+**Gemfile**
+
+```ruby
+gem "mongoid_upk"
+```
+
+## Usage
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::UPK
+end
+```
+
+Will automatically use `UUID` ([uuid gem](https://github.com/assaf/uuid) by assaf), `:compact` mode per default.
+
+**Explicit definition**
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::UPK
+  uuid_pk
+end
+```
+
+Same as above.
+
+**Pretty UUID**
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::UPK
+  pretty_uuid_pk
+end
+```
+
+Almost same as above but with hyphens in it.
+(Example: `c1b457b0-3214-012f-316d-10e6baa29f2c`)
+
+**Mixed ID**
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include Mongoid::UPK
+  bson_uuid_pk
+end
+```
+
+Very long `_id` with both BSON::ObjectId **and** UUID.
+(Example: `4f2e55a2ee911332c4000001-95faf560320f012f315510e6baa29f2c`)
+
+## Motivation
+
+While writing very fast to MongoDB it is possible to take an BSON::ObjectId twice.
+This will lead to big troubles because you never know which document will be returned.
+
+This gem utilizes the `key` method and overwrites the automatically given default id with the choosen generator on save.
+So the real id can be read first after a successful save (I don't want to hack deeper here, because saves are more important than getting a unique id on instance initialization).
+
+UUID is in most cases more reliable, especially if the app instances are set up correctly (and/or running on different machines).
+
+Read more about the [UUID gem and how to set up your project (e.g. using unicorn or other threaded webservers)](https://github.com/assaf/uuid).
+
+## License
+
+MIT/X11
+
+2012 — [Christoph 'asaaki' Grabo](https://github.com/asaaki)

data/Rakefile

@@ -0,0 +1,35 @@
+# encoding: utf-8
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+require "rubygems"
+require "bundler"
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require "rake"
+require "jeweler"
+require "rspec/core"
+require "rspec/core/rake_task"
+require "mongoid_upk/version"
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mongoid_upk"
+  gem.version = Mongoid::UPK::VERSION
+  gem.homepage = "http://github.com/asaaki/mongoid_upk"
+  gem.license = "MIT"
+  gem.summary = %Q{Mongoid::UPK generates more unique `_id`}
+  gem.description = %Q{Mongoid::UPK generates more unique `_id` by using UUID.}
+  gem.email = "chris@dinarrr.com"
+  gem.authors = ["Christoph Grabo"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid_upk.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+require "uuid"
+
+module Mongoid
+  module UPK
+
+    class MissingDependency < StandardError
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      unless self.ancestors.include?(Mongoid::Document)
+        raise MissingDependency, "You must include Mongoid::Document BEFORE Mongoid::UPK"
+      end
+      uuid_pk
+    end
+
+    module ClassMethods
+
+      # UUID compact (32 digits)
+      def uuid_pk
+        key :_id do |origin_bson_id|
+          uuid = UUID.new
+          "#{uuid.generate(:compact)}"
+        end
+      end
+
+      # UUID with hyphens (36 digits)
+      def pretty_uuid_pk
+        key :_id do |origin_bson_id|
+          uuid = UUID.new
+          "#{uuid.generate}"
+        end
+      end
+
+      # BSON::ObjectId + UUID
+      def bson_uuid_pk
+        key :_id do |origin_bson_id|
+          uuid = UUID.new
+          "#{origin_bson_id}-#{uuid.generate(:compact)}"
+        end
+      end
+
+    end
+
+  end
+end

data/lib/mongoid_upk/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+module Mongoid
+  module UPK
+    VERSION = "0.0.2"
+  end
+end

data/mongoid_upk.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "mongoid_upk"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Grabo"]
+  s.date = "2012-02-05"
+  s.description = "Mongoid::UPK generates more unique `_id` by using UUID."
+  s.email = "chris@dinarrr.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rvmrc",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "lib/mongoid_upk.rb",
+    "lib/mongoid_upk/version.rb",
+    "mongoid_upk.gemspec",
+    "spec/mongoid_upk_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/asaaki/mongoid_upk"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Mongoid::UPK generates more unique `_id`"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_runtime_dependency(%q<uuid>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<pry-doc>, [">= 0"])
+    else
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<uuid>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<pry-doc>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<uuid>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<pry-doc>, [">= 0"])
+  end
+end
+

data/spec/mongoid_upk_spec.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class TestDoc
+  include Mongoid::Document
+  include Mongoid::UPK
+
+  field :name
+end
+
+describe Mongoid::UPK do
+  it "automatic uuid generator" do
+    td = TestDoc.new
+    old_id = td._id
+    td.save and td.reload
+    td._id.should_not == old_id
+  end
+
+  it "bson id + uuid" do
+    class TestDoc2 < TestDoc
+      bson_uuid_pk
+    end
+
+    td = TestDoc2.new
+    old_id = td._id
+    td.save and td.reload
+    td._id.should_not == old_id
+    td._id.should     =~ /#{old_id}/
+  end
+
+  it "raises error if dependency not met" do
+    expect {
+      class FailTest
+        include Mongoid::UPK
+      end
+    }.to raise_error(Mongoid::UPK::MissingDependency)
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path("../../lib",__FILE__))
+
+require "database_cleaner"
+require "mongoid"
+require "mongoid_upk"
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_upk_test")
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_upk
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Christoph Grabo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &7357340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7357340
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &7356860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7356860
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: &7356380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7356380
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &7355900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *7355900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &7355420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7355420
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &7354940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7354940
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &7354460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7354460
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &7353980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7353980
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &7353500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7353500
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: &7369420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *7369420
+description: Mongoid::UPK generates more unique `_id` by using UUID.
+email: chris@dinarrr.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongoid_upk.rb
+- lib/mongoid_upk/version.rb
+- mongoid_upk.gemspec
+- spec/mongoid_upk_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/asaaki/mongoid_upk
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 762031412242489430
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Mongoid::UPK generates more unique `_id`
+test_files: []