mongoid_atomic 0.1.0

data/README.rdoc

@@ -0,0 +1,87 @@
+= Mongoid::Atomic
+
+Atomic updates for your Mongoid models.
+
+== Installation
+
+Add to Gemfile:
+  
+    gem 'mongoid_atomic'
+
+== Getting Started
+
+Include the module in models where you want it:
+
+    class User
+      include Mongoid::Document
+      include Mongoid::Atomic
+
+      field :username
+      field :groups, :type => Array, :default => ['users']
+      field :post_count, :type => Integer
+    end
+
+== Easy and Human Readable Atomic Updates!
+
+A simple example. To increment a post count:
+
+    u = User.where(:name => 'Bill').first
+    u.atomic_inc(:post_count) 
+
+.. which might fit nicely in your Post model:
+
+    class Post
+      include Mongoid::Document
+      ...
+      references_one :user
+      ...
+      after_create :update_post_count
+      ...
+      private
+      def update_post_count
+        self.user.atomic_inc :post_count
+      end
+    end
+
+.. or join a group:
+  
+    ...
+    u.atomic_push(:groups, 'posters')
+    
+    
+.. or remove a field:
+
+    ...
+    u.atomic_unset(:deprecated_field)
+    
+.. or change your name:
+
+    ...
+    u.atomic_set(:username, 'bill')
+
+.. or do all of it at once:
+
+    ...
+    u.atomic_update :inc => {:post_count => 1}, :set => {:username => 'bobby'}, :pushAll => {:groups => %w[rubyists developers]}
+
+== A Note About Attribute Consistency
+
+No effort is made to ensure consistency between the server and instance attributes. There's a good reason for this: the operations are performed inside of the Mongo server and we often don't care about the result.  If you need to ensure the consistency of your attributes after an update, call the Mongoid reload method.  Example:
+
+    >> u = User.first
+    => #<User....>
+    
+    >> u.post_count
+    => 0
+    
+    >> u.atomic_inc :post_count
+    => nil
+    
+    >> u.post_count
+    => 0
+    
+    >> u.reload
+    => #<User....>
+    
+    >> u.post_count
+    >= 1

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid_atomic.rb

@@ -0,0 +1,50 @@
+module Mongoid::Atomic
+  extend ActiveSupport::Concern
+
+  def atomic_update(options)
+    doc = {}
+    options.each do |k,v|
+      next unless %w[inc set unset push pushAll addToSet pop pull pullAll].include? k.to_s
+      doc["$#{k}"] = v
+    end
+    collection.update({'_id' => self._id}, doc)
+  end
+
+  def atomic_inc(field, by=1)
+    atomic_update :inc => { field => by }
+  end
+  alias :atomic_increment :atomic_inc
+
+  def atomic_set(field, value)
+    atomic_update :set => { field => value }
+  end
+
+  def atomic_unset(field)
+    atomic_update :unset => { field => 1 }
+  end
+  
+  def atomic_push(field, value)
+    atomic_update :push => { field => value }
+  end
+  
+  def atomic_push_all(field, array)
+    atomic_update :pushAll => { field => array.to_a }
+  end
+  
+  def atomic_add_to_set(field, value)
+    atomic_update :addToSet => { field => value }
+  end
+  
+  def atomic_pop(field, index=1)
+    atomic_update :pop => { field => index.to_i }
+  end
+  
+  def atomic_pull(field, value)
+    atomic_update :pull => { field => value }
+  end
+  
+  def atomic_pull_all(field, array)
+    atomic_update :pullAll => { field => array.to_a }
+  end
+
+end

data/spec/models/user.rb

@@ -0,0 +1,9 @@
+class User
+  include Mongoid::Document
+  include Mongoid::Atomic
+  
+  field :username
+  field :groups, :type => Array, :defaults => ['users']
+  field :post_count, :type => Integer, :default => 0
+  
+end

data/spec/mongoid_atomic_spec.rb

@@ -0,0 +1,92 @@
+require "spec_helper"
+
+describe Mongoid::Atomic do
+  
+  context "user" do
+    
+    before(:each) do
+      @bob = User.create(:username => 'Bob', :groups => %w[users moderators admins])
+      @nancy = User.create(:username => 'Nancy', :groups => %w[users peons])
+    end
+    
+    it "should increment" do
+      @bob.atomic_inc :post_count
+      @bob.reload.post_count.should eql 1
+      @bob.atomic_inc :post_count
+      @bob.reload.post_count.should eql 2
+      @bob.atomic_inc :post_count, -2
+      @bob.reload.post_count.should eql 0
+      @nancy.atomic_inc :post_count, 10
+      @nancy.reload.post_count.should eql 10
+    end
+    
+    it "should set" do
+      @bob.atomic_set :username, 'Robby'
+      @bob.reload.username.should eql 'Robby'
+      @nancy.atomic_set :groups, %w[users women]
+      @nancy.reload.groups.should eql %w[users women]
+    end
+    
+    it "should unset" do
+      @bob.atomic_unset :groups
+      @bob.reload.groups.should eql nil
+    end
+    
+    it "should push" do
+      @bob.atomic_push :groups, 'bobs'
+      @bob.reload.groups.should eql %w[users moderators admins bobs]
+      @nancy.atomic_unset :groups
+      @nancy.atomic_push :groups, 'women'
+      @nancy.atomic_push :groups, 'nancies'
+      @nancy.reload.groups.should eql %w[women nancies]
+    end
+    
+    it "should push all" do
+      @bob.atomic_push_all :groups, %w[executives bosses idiots]
+      @bob.reload.groups.should eql %w[users moderators admins executives bosses idiots]
+    end
+    
+    it "should add to set" do
+      @bob.atomic_add_to_set :groups, 'bobs'
+      @bob.reload.groups.should eql %w[users moderators admins bobs]
+      @bob.atomic_add_to_set :groups, 'users'
+      @bob.reload.groups.should eql %w[users moderators admins bobs]
+    end
+    
+    it "should pop" do
+      @bob.atomic_pop :groups
+      @bob.reload.groups.should eql %w[users moderators]
+      @bob.atomic_pop :groups, -1
+      @bob.reload.groups.should eql %w[moderators]
+      @nancy.atomic_pop :groups, 1
+      @nancy.reload.groups.should eql %w[users]
+      @nancy.atomic_set :groups, %w[beautiful brunette woman starts_with_n]
+      @nancy.atomic_pop :groups, 1
+      @nancy.reload.groups.should eql %w[beautiful brunette woman]
+    end
+    
+    it "should pull" do
+      @bob.atomic_pull :groups, 'users'
+      @bob.reload.groups.should eql %w[moderators admins]
+      @nancy.atomic_pull :groups, 'peons'
+      @nancy.reload.groups.should eql %w[users]
+    end
+    
+    it "should pull all" do
+      @bob.atomic_pull_all :groups, %w[users admins]
+      @bob.reload.groups.should eql %w[moderators]
+    end
+    
+    it "should update multiple field at the same time" do
+      @bob.atomic_update :inc => {:post_count => 1}, :set => {:username => 'bobby'}, :pushAll => {:groups => %w[bosses idiots]}
+      @bob.reload
+      @bob.post_count.should eql 1
+      @bob.groups.should eql %w[users moderators admins bosses idiots]
+      @bob.username.should eql 'bobby'
+    end
+    
+  end
+  
+end
+
+      

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require(:default)
+
+Mongoid.config.master = Mongo::Connection.new.db("mongoid_atomic_test")
+
+require File.expand_path("../../lib/mongoid_atomic", __FILE__)
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+DatabaseCleaner.orm = "mongoid"
+
+Rspec.configure do |config|
+  config.before(:all) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_atomic
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jason Coene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-17 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: -1848230040
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta4
+        version: 2.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+description: A collection of instance methods to more easily perform atomic updates to your Mongoid models.
+email: jcoene@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- VERSION
+- lib/mongoid_atomic.rb
+- spec/models/user.rb
+- spec/mongoid_atomic_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jcoene/mongoid_atomic
+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: Atomic updates for your Mongoid models.
+test_files: 
+- spec/models/user.rb
+- spec/mongoid_atomic_spec.rb
+- spec/spec_helper.rb