mongoid_auto_inc 0.0.4

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jeff Smith
+
+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,26 @@
+= mongoid_auto_inc
+Add SQL like auto-incrementing fields to your Mongoid documents.  
+
+This gem is inspired by http://ihswebdesign.com/blog/autoincrement-in-mongodb-with-ruby/ and the mongomapper_id2[https://github.com/phstc/mongomapper_id2] gem.
+== Install
+  gem install mongoid_auto_inc
+== Usage
+Just add <tt>auto_increment :field</tt> to your Mongoid model where <tt>:field</tt> is the name of the auto-incremented field you want to create.
+Example:
+  class Book
+    include Mongoid::Document
+
+    field :title
+    field :author
+
+    auto_increment :sequence
+  end
+<tt>auto_increment :sequence</tt> will create a field of type <tt>Integer</tt> named <tt>sequence</tt> for <tt>Book</tt>.  Whenever an instance of the model is created (intially saved to mongoDB), the <tt>auto_increment</tt> field will automatically be set to the next number in the sequence.
+
+You can add more than one auto-incremented field per model.
+=== Options
+  auto_increment :sequence, :collection => :some_collection
+<tt>mongoid_auto_inc</tt> keeps track of the current number in the sequence by creating a separate document mongoDB to query and update.  By default <tt>auto_increment</tt> will save this document to a mongoDB collection called <tt>sequences</tt>.  If you wish to save to a different collection use the <tt>:collection</tt> option to specify its name.
+
+  auto_increment :sequence, :seed => 3333
+Use the <tt>:seed</tt> option to set the initial value of the auto-incremented field.  The first number assigned from the sequence will be the next number after the seed value.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/mongoid_auto_inc/incrementor.rb

@@ -0,0 +1,64 @@
+# This is a modified version of the code found on this blog post:
+#   http://ihswebdesign.com/blog/autoincrement-in-mongodb-with-ruby/
+module MongoidAutoInc
+  class Incrementor
+    class Sequence
+      def initialize(sequence, collection_name)
+        @sequence = sequence.to_s
+        @collection = collection_name.to_s
+        exists? || create
+      end
+
+      def inc
+        update_number_with("$inc" => { "number" => 1 })
+      end
+
+      def set(number)
+        update_number_with("$set" => { "number" => number })
+      end
+    
+      private
+
+      def exists?
+        collection.find(query).count > 0
+      end
+
+      def create(number = 0)
+        collection.insert(query.merge({ "number" => number }))
+      end
+
+      def collection
+        Mongoid.database[@collection]
+      end
+      
+      def query
+        { "seq_name" => @sequence }
+      end
+        
+      def current
+        collection.find_one(query)["number"]
+      end
+      
+      def update_number_with(mongo_func)
+        opts = {
+          "query"  => query,
+          "update" => mongo_func,
+          "new"    => true # return the modified document
+        }
+        collection.find_and_modify(opts)["number"]
+      end
+    end
+    
+    def initialize(options={})
+      @collection = options[:collection] || "sequences"
+    end
+
+    def [](sequence)
+      Sequence.new(sequence, @collection)
+    end
+
+    def []=(sequence, number)
+      Sequence.new(sequence, @collection).set(number)
+    end
+  end
+end

data/lib/mongoid_auto_inc/version.rb

@@ -0,0 +1,3 @@
+module MongoidAutoInc
+  VERSION = "0.0.4"
+end

data/lib/mongoid_auto_inc.rb

@@ -0,0 +1,23 @@
+require "mongoid_auto_inc/incrementor"
+
+module MongoidAutoInc
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def auto_increment(name, options={})
+      field name, :type => Integer
+      
+      seq_name = "#{self.name.downcase}_#{name}"
+      @@incrementor = MongoidAutoInc::Incrementor.new(options) 
+      @@incrementor[seq_name].set(options[:seed]) if options[:seed].is_a? Integer
+
+      before_create { self.send("#{name}=", @@incrementor[seq_name].inc) } 
+    end
+  end
+end
+
+module Mongoid
+  module Document
+    include MongoidAutoInc
+  end
+end

data/mongoid_auto_inc.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid_auto_inc/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid_auto_inc"
+  s.version     = MongoidAutoInc::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jeff Smith"]
+  s.email       = ["jffreyjs@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Adds auto increment capabilities to Mongoid::Document}
+  s.description = %q{Adds auto increment capabilities to Mongoid::Document}
+
+  s.rubyforge_project = "mongoid_auto_inc"
+
+  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"]
+  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_development_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+      s.add_dependency %q<mongoid>, ['>= 2.0.0.rc.6']
+      s.add_dependency %q<activesupport>, ['>=3.0.0']
+    else
+      s.add_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+      s.add_dependency %q<mongoid>, ['>= 2.0.0.rc.6']
+      s.add_dependency %q<activesupport>, ['>= 3.0.0']
+    end
+  else
+    s.add_dependency %q<rspec>, ['~> 2.0.0.beta.22']
+    s.add_dependency %q<mongoid>, ['>= 2.0.0.rc.6']
+    s.add_dependency %q<activesupport>, ['>= 3.0.0']
+  end
+end

data/spec/mongoid_auto_inc_spec.rb

@@ -0,0 +1,5 @@
+require 'mongoid_auto_inc'
+
+describe MongoidAutoInc
+  pending "I should add some tests at some point."
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_auto_inc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Jeff Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-06 00:00:00 -05: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 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 22
+        version: 2.0.0.beta.22
+  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 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - rc
+        - 6
+        version: 2.0.0.rc.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id003
+description: Adds auto increment capabilities to Mongoid::Document
+email: 
+- jffreyjs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/mongoid_auto_inc.rb
+- lib/mongoid_auto_inc/incrementor.rb
+- lib/mongoid_auto_inc/version.rb
+- mongoid_auto_inc.gemspec
+- spec/mongoid_auto_inc_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: mongoid_auto_inc
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds auto increment capabilities to Mongoid::Document
+test_files: []
+