mongo_sequence 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+MONGO_VERS = '1.6.1'
+
+gem 'mongo',    MONGO_VERS
+gem 'bson_ext', MONGO_VERS
+
+gemspec

data/README.md

@@ -0,0 +1,87 @@
+# MongoSequence
+
+MongoSequence provides light-weight, robust sequences in MongoDB. They are useful for auto-incrementing or counting.  Compatible with any Mongo ODM.
+
+MongoSequence creates named sequences in a "sequences" collection in your database and atomically increments and returns the counter on them using Mongo's findAndModify command. You won't have collisions--two processes trying to increment at the same time will alway get different numbers.
+
+## Usage
+
+Install with [Bundler](http://gembundler.com/):
+
+``` ruby
+gem "mongo_sequence"
+```
+
+Install without Bundler:
+
+    gem install mongo_sequence --no-ri --no-rdoc
+
+If you're _not_ using MongoMapper or Mongoid, you'll have to tell MongoSequence what database to use:
+
+``` ruby
+MongoSequence.database = Mongo::Connection.new.db('my_app_development')
+```
+
+Now, increment some sequences:
+
+``` ruby
+MongoSequence[:global].next    # => 1
+MongoSequence[:global].next    # => 2
+
+# get the current value...
+# no guarantees of course on how long it's valid
+# usually you use the return value of #next
+MongoSequence[:global].current # => 2
+
+# can also reset sequences if you need to
+MongoSequence[:global] = 100
+MongoSequence[:global].next    # => 101
+
+# sequences with different names are independent
+MongoSequence[:bluejay].next   # => 1
+MongoSequence[:bluejay].next   # => 2
+```
+
+Here's how the sequences look in Mongo:
+
+``` ruby
+MongoSequence.collection.find_one(:_id => 'bluejay')
+# =>
+# {
+#   "_id"     => "bluejay",
+#   "current" => 2
+# }
+```
+
+## Why?
+
+Why would anyone need atomically incrementing sequences with unique return values? Well, the most common case is for auto-incrementing id's in Mongo. Here's a MongoMapper example:
+
+``` ruby
+class Peregrine
+  include MongoMapper::Document
+  key :_id, Integer, :default => lambda { nil }
+
+  before_create do
+    self.id ||= MongoSequence[:peregrine_id].next # for id's unique among Peregrines
+    # or
+    self.id ||= MongoSequence[:mongo_id].next     # for id's unique across the database
+  end
+end
+```
+
+## Help make it better!
+
+Need something added? Please [open an issue](https://github.com/brianhempel/mongo_sequence/issues)! Or, even better, code it yourself and send a pull request:
+
+    # fork it on github, then clone:
+    git clone git@github.com:your_username/mongo_sequence.git
+    bundle install
+    rspec
+    # hack away
+    git push
+    # then make a pull request
+
+## License
+
+Authored by Brian Hempel. Public domain, no restrictions.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/mongo_sequence.rb

@@ -0,0 +1,67 @@
+require "mongo"
+
+class MongoSequence
+
+  class << self
+    attr_writer :database
+
+    def database
+      return @database if @database
+      return MongoMapper.database if defined?(MongoMapper) && MongoMapper.database
+      return Mongoid.database if defined?(Mongoid) && Mongoid.database
+    end
+
+    def collection
+      database['sequences']
+    end
+
+    def [](name)
+      new(name)
+    end
+
+    def []=(name, integer)
+      self[name].current = integer
+    end
+  end
+
+  attr_reader :name
+
+  def initialize(name)
+    @name = name.to_s
+  end
+
+  def collection
+    MongoSequence.collection
+  end
+
+  def next
+    current_after_update(:$inc => { :current => 1 })
+  end
+
+  def current
+    current_after_update(:$set => {}) # noop that works
+  end
+
+  def current=(integer)
+    current_after_update(:current => integer)
+  end
+
+  private
+
+  def current_after_update(update)
+    options = {
+      :query  => { :_id => name },
+      :new    => true, # return the modified doc
+      :update => update
+    }
+    collection.find_and_modify(options)['current']
+  rescue Mongo::OperationFailure => e
+    raise unless e.message =~ /No matching object found/
+    init_in_database
+    current_after_update(update)
+  end
+
+  def init_in_database
+    collection.save({:_id => name, :current => 0}, :safe => true)
+  end
+end

data/mongo_sequence.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = "mongo_sequence"
+  s.version     = '1.0.0'
+  s.authors     = ["Brian Hempel"]
+  s.email       = ["plasticchicken@gmail.com"]
+  s.homepage    = "https://github.com/brianhempel/mongo_sequence"
+  s.summary     = %q{Light-weight sequences for MongoDB, useful for auto-incrementing or counting.  Works with any ODM.}
+  s.description = s.summary
+
+  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 "mongo", ">1.1"
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mongo_mapper"
+  s.add_development_dependency "mongoid"
+end

data/spec/mongo_sequence_spec.rb

@@ -0,0 +1,122 @@
+require 'bundler/setup'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'mongo_sequence'
+require 'mongo_mapper'
+require 'mongoid'
+
+describe MongoSequence do
+  before :each do
+    MongoMapper.database   = nil
+    # can't get rid of Mongoid's db :/
+    MongoSequence.database = nil
+  end
+
+  context "no ODM" do
+    before :each do
+      @db = Mongo::Connection.new.db('mongo_sequence_test')
+      @db.collections.each(&:remove)
+      MongoSequence.database = @db
+    end
+
+    it "returns MongoSequence objects" do
+      MongoSequence[:test].class.should == MongoSequence
+    end
+
+    it "starts at 1 for a new sequence" do
+      MongoSequence[:test].next.should == 1
+    end
+
+    it "increments every time .next is called" do
+      MongoSequence[:test].next
+      MongoSequence[:test].next.should == 2
+      MongoSequence[:test].next.should == 3
+    end
+
+    it "lets us get the current count" do
+      MongoSequence[:test].current.should == 0
+      MongoSequence[:test].next
+      MongoSequence[:test].current.should == 1
+      MongoSequence[:test].current.should == 1 # current should not increment
+    end
+
+    it "pulls current from the database" do
+      MongoSequence[:test].current.should == 0
+      @db['sequences'].update({ :_id => "test" }, { :current => 100 })
+      MongoSequence[:test].current.should == 100
+    end
+
+    it "increments different sequences separately" do
+      MongoSequence[:seq1].next
+      MongoSequence[:seq1].next.should == 2
+      MongoSequence[:seq2].next.should == 1
+      MongoSequence[:seq2].next.should == 2
+    end
+
+    it "lets us set the current count" do
+      MongoSequence[:test].current = 100
+      MongoSequence[:test].current.should == 100
+      MongoSequence[:test].next.should == 101
+    end
+
+    it "lets us set the current count with shorthand syntax" do
+      MongoSequence[:test] = 100
+      MongoSequence[:test].current.should == 100
+      MongoSequence[:test].next.should == 101
+    end
+
+    it "accepts strings or symbols for the sequence name" do
+      MongoSequence[:test] = 100
+      MongoSequence['test'].current.should == 100
+      MongoSequence['test'] = 200
+      MongoSequence[:test].current.should == 200
+    end
+
+    it "uses the 'sequences' collection" do
+      MongoSequence[:seq1].current
+      MongoSequence[:seq2].current
+      MongoSequence[:seq3].current
+      @db['sequences'].count.should == 3
+    end
+
+    it "sets the _id to the sequence name" do
+      MongoSequence[:foo].current
+      @db['sequences'].find.first['_id'].should == "foo"
+    end
+
+    it "should actually use the database" do
+      MongoSequence.collection.save(:_id => "test", :current => 200)
+      MongoSequence[:test].current.should == 200
+    end
+  end
+
+  context "MongoMapper" do
+    before :each do
+      MongoMapper.database = "mongo_sequence_test_mm"
+    end
+
+    it "uses MongoMapper's database by default" do
+      MongoSequence.database.name.should == "mongo_sequence_test_mm"
+    end
+
+    it "allows overriding the database" do
+      MongoSequence.database = Mongo::Connection.new.db('mongo_sequence_test')
+      MongoSequence.database.name.should == "mongo_sequence_test"
+    end
+  end
+
+  context "Mongoid" do
+    before :each do
+      # get around Mongoid complaining that my MongoDB is too old :P
+      Mongoid.config.from_hash('database' => "mongo_sequence_test_mongoid", 'logger' => false)
+    end
+
+    it "uses Mongoid's database by default" do
+      MongoSequence.database.name.should == "mongo_sequence_test_mongoid"
+    end
+
+    it "allows overriding the database" do
+      MongoSequence.database = Mongo::Connection.new.db('mongo_sequence_test')
+      MongoSequence.database.name.should == "mongo_sequence_test"
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_sequence
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Brian Hempel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Light-weight sequences for MongoDB, useful for auto-incrementing or counting.  Works with any ODM.
+email: 
+- plasticchicken@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongo_sequence.rb
+- mongo_sequence.gemspec
+- spec/mongo_sequence_spec.rb
+homepage: https://github.com/brianhempel/mongo_sequence
+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: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Light-weight sequences for MongoDB, useful for auto-incrementing or counting.  Works with any ODM.
+test_files: 
+- spec/mongo_sequence_spec.rb