mongoid_touch 0.0.4 → 0.1.0

data/Gemfile

@@ -1,6 +1,6 @@
 source "http://rubygems.org"
 
-gem "mongoid", "~> 2.1.7"
+gem "mongoid", "~> 2.1"
 
 group :development, :test do
   gem "rake"

data/Gemfile.lock

@@ -1,11 +1,11 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.9)
-      activesupport (= 3.0.9)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activesupport (3.0.9)
+    activesupport (3.0.10)
     bson (1.3.1)
     bson_ext (1.3.1)
     builder (2.1.2)
@@ -19,7 +19,7 @@ GEM
       rake
     mongo (1.3.1)
       bson (>= 1.3.1)
-    mongoid (2.1.7)
+    mongoid (2.1.9)
       activemodel (~> 3.0)
       mongo (~> 1.3)
       tzinfo (~> 0.3.22)
@@ -45,7 +45,7 @@ DEPENDENCIES
   bundler (~> 1.0.0)
   database_cleaner (~> 0.6.7)
   jeweler (~> 1.6.4)
-  mongoid (~> 2.1.7)
+  mongoid (~> 2.1)
   mongoid-rspec (~> 1.4.4)
   rake
   rspec (~> 2.3.0)

data/README.md

@@ -0,0 +1,51 @@
+# mongoid_touch ![build status](http://travis-ci.org/asaaki/mongoid_touch.png)
+
+A tiny mongoid extension to provide the `touch` method known from ActiveRecord to Mongoid::Document.
+
+## Install and Usage
+
+Use Bundler/Gemfile, add `gem "mongoid_touch"` right after your added mongoid.
+
+The method `.touch` can have an optional parameter for your custom Time based field, otherwise it will try to use the `updated_at` field (include Mongoid::Timestamps in your model).
+
+Use `.touch!` if you want to get exceptions if touching fails.
+
+Now you can use:
+
+```ruby
+my_model_instance.touch
+my_model_instance.touch! # will raise errors if touching fails.
+```
+
+This will update the `updated_at` field if present.
+
+```ruby
+my_model_instance.touch(:modified_at)
+my_model_instance.touch(:modified_at) # will raise errors if touching fails.
+```
+
+This will update the custom field `modified_at` if present.
+
+## Exceptions for `touch!`
+
+If the corresponding field is not present, mongoid_touch will raise a `Mongoid::Errors::MissingField`.
+
+If the object is frozen, an exception of `Mongoid::Errors::FrozenInstance` is thrown.
+
+If the underlying `update_attribute` doesn't return true, `Mongoid::Errors::DocumentNotUpdated` is thrown (unless mongoid itself throws an error).
+
+## Contributing to `mongoid_touch`
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Christoph Grabo. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/config/locales/en.yml

@@ -0,0 +1,12 @@
+en:
+  mongoid:
+    errors:
+      messages:
+        touch:
+          document_not_updated:
+            The document %{name} was not updated successfully.
+          frozen_instance:
+            The document %{name} is frozen and can't be updated.
+          missing_field:
+            The field %{name} is not present for %{instance}.
+

data/lib/mongoid/document/touch.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Mongoid
+  module Document
+    module Touch
+      extend ActiveSupport::Concern
+      
+      included do
+      end
+      
+      module InstanceMethods
+      
+        def touch( at_field = nil )
+          unless self.frozen?
+            to_touch = at_field || :updated_at
+            if self.fields.include? to_touch.to_s
+              return true if self.update_attribute(to_touch.to_sym, Time.now.utc)
+              false
+            else
+              return false
+            end
+          else
+            false
+          end
+        end
+        
+        def touch!( at_field = nil, force_fail = false )
+          raise Errors::DocumentNotUpdated.new(self) if force_fail
+          unless self.frozen?
+            to_touch = at_field || :updated_at
+            if self.fields.include? to_touch.to_s              
+              return true if self.update_attribute(to_touch.to_sym, Time.now.utc)
+              raise Errors::DocumentNotUpdated, self
+            else
+              raise Errors::MissingField.new(to_touch, self)
+            end
+          else
+            raise Errors::FrozenInstance, self
+          end
+        end
+        
+      end
+    
+    end
+  end
+end
+

data/lib/mongoid/errors/document_not_updated.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+    class DocumentNotUpdated < MongoidError
+      def initialize(name)
+        super(
+          translate("touch.document_not_updated", { :name => name.to_s })
+        )
+      end
+    end
+  end
+end
+

data/lib/mongoid/errors/frozen_instance.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Mongoid
+  module Errors
+    class FrozenInstance < MongoidError
+      def initialize(name)
+        super(
+          translate("touch.frozen_instance", { :name => name.to_s })
+        )
+      end
+    end
+  end
+end
+

data/lib/mongoid/errors/missing_field.rb

@@ -3,9 +3,9 @@
 module Mongoid
   module Errors
     class MissingField < MongoidError
-      def initialize(name)
+      def initialize(name, instance)
         super(
-          translate("missing_field", { :name => name })
+          translate("touch.missing_field", { :name => name.to_s, :instance => instance.to_s })
         )
       end
     end

data/lib/mongoid_touch.rb

@@ -1,18 +1,9 @@
 # encoding: utf-8
-
+require "mongoid"
+require "mongoid/errors/document_not_updated"
+require "mongoid/errors/frozen_instance"
 require "mongoid/errors/missing_field"
+require "mongoid/document/touch"
 
-module Mongoid
-  module Document
-    def touch( at_field = nil )
-      to_touch = at_field || :updated_at
-      if self.fields.include? to_touch.to_s
-        self.update_attribute(to_touch.to_sym, Time.now.utc)
-      else
-        raise Errors::MissingField.new(to_touch.to_s)
-      end
-    end
-    alias :touch! :touch
-  end
-end
+I18n.load_path << File.join(File.dirname(__FILE__), "config", "locales", "en.yml")
 

data/mongoid_touch.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_touch}
-  s.version = "0.0.4"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Christoph Grabo}]
-  s.date = %q{2011-08-14}
+  s.date = %q{2011-08-25}
   s.description = %q{A tiny mongoid extension to provide the `touch` method known from ActiveRecord to Mongoid::Document.}
   s.email = %q{chris@dinarrr.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -24,9 +24,13 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
+    "lib/config/locales/en.yml",
+    "lib/mongoid/document/touch.rb",
+    "lib/mongoid/errors/document_not_updated.rb",
+    "lib/mongoid/errors/frozen_instance.rb",
     "lib/mongoid/errors/missing_field.rb",
     "lib/mongoid_touch.rb",
     "mongoid_touch.gemspec",
@@ -43,7 +47,7 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<mongoid>, ["~> 2.1.7"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2.1"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_development_dependency(%q<mongoid-rspec>, ["~> 1.4.4"])
@@ -52,7 +56,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
     else
-      s.add_dependency(%q<mongoid>, ["~> 2.1.7"])
+      s.add_dependency(%q<mongoid>, ["~> 2.1"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
       s.add_dependency(%q<mongoid-rspec>, ["~> 1.4.4"])
@@ -62,7 +66,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     end
   else
-    s.add_dependency(%q<mongoid>, ["~> 2.1.7"])
+    s.add_dependency(%q<mongoid>, ["~> 2.1"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
     s.add_dependency(%q<mongoid-rspec>, ["~> 1.4.4"])

data/spec/mongoid_touch_spec.rb

@@ -2,34 +2,78 @@
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-class TestDoc
+class TestDocOne
   include Mongoid::Document
   include Mongoid::Timestamps
+  include Mongoid::Document::Touch
   field :name, type: String
 end
 
 class TestDocTwo
   include Mongoid::Document
+  include Mongoid::Document::Touch
   field :name, type: String
   field :modified_at, type: Time
 end
 
-describe "Mongoid::Document#touch" do
+describe Mongoid::Document::Touch do
+
+  describe ".touch" do
+
+    it "updates the updated_at field" do
+      doc = TestDocOne.create(name: "My test doc")
+      origin_at = doc.updated_at
+      sleep 1.1
+      doc.touch.should be_true
+      doc.updated_at.should > origin_at
+    end
+
+    it "updates a custom Time field" do
+      doc = TestDocTwo.create(name: "My test doc", modified_at: Time.now.utc)
+      origin_at = doc.modified_at
+      sleep 1.1
+      doc.touch(:modified_at).should be_true
+      doc.modified_at.should > origin_at  
+    end
 
-  it "should update the updated_at field" do
-    doc = TestDoc.create(name: "My test doc")
-    origin_at = doc.updated_at
-    sleep 1
-    doc.touch
-    doc.updated_at.should > origin_at
   end
-  
-  it "should update a custom Time field" do
-    doc = TestDocTwo.create(name: "My test doc", modified_at: Time.now.utc)
-    origin_at = doc.modified_at
-    sleep 1
-    doc.touch(:modified_at)
-    doc.modified_at.should > origin_at  
+
+  describe ".touch!" do
+
+    it "returns true if :touch is successful on a timestamp" do
+      doc = TestDocOne.create(name: "My test doc")
+      doc.touch!.should be_true
+    end
+
+    it "raises an error if :touch failed on frozen object" do
+      doc = TestDocOne.create(name: "My test doc")
+      doc.freeze
+      lambda { doc.touch! }.should raise_error(Mongoid::Errors::FrozenInstance)
+    end
+
+    it "returns true if :touch! is successful on a custom time field" do
+      doc = TestDocTwo.create(name: "My test doc", modified_at: Time.now.utc)
+      doc.touch!(:modified_at).should be_true
+    end
+
+    it "raises an error if :touch! failed on frozen object" do
+      doc = TestDocTwo.create(name: "My test doc", modified_at: Time.now.utc)
+      doc.freeze
+      lambda { doc.touch!(:modified_at) }.should raise_error(Mongoid::Errors::FrozenInstance)
+    end
+
+    it "raises a MissingField error if :touch! tries to modify a non-existing field" do
+      doc = TestDocTwo.create(name: "My test doc", modified_at: Time.now.utc)
+      lambda { doc.touch!(:undefined_at) }.should raise_error(Mongoid::Errors::MissingField)
+    end
+
+    # force this special fail with the optional param "force_fail = true" in #touch! method
+    it "raises a DocumentNotUpdated error if :touch! can't update." do
+      doc = TestDocOne.create(name: "My test doc")
+      lambda { doc.touch!(:undefined_at,true) }.should raise_error(Mongoid::Errors::DocumentNotUpdated)
+    end
+
   end
 
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_touch
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-14 00:00:00.000000000Z
+date: 2011-08-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &14012140 !ruby/object:Gem::Requirement
+  requirement: &28563080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.7
+        version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *14012140
+  version_requirements: *28563080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14011540 !ruby/object:Gem::Requirement
+  requirement: &28562380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14011540
+  version_requirements: *28562380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14011000 !ruby/object:Gem::Requirement
+  requirement: &28561680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *14011000
+  version_requirements: *28561680
 - !ruby/object:Gem::Dependency
   name: mongoid-rspec
-  requirement: &14010520 !ruby/object:Gem::Requirement
+  requirement: &28560880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.4.4
   type: :development
   prerelease: false
-  version_requirements: *14010520
+  version_requirements: *28560880
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &13990880 !ruby/object:Gem::Requirement
+  requirement: &28560200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.3.1
   type: :development
   prerelease: false
-  version_requirements: *13990880
+  version_requirements: *28560200
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &13990200 !ruby/object:Gem::Requirement
+  requirement: &28534820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.6.7
   type: :development
   prerelease: false
-  version_requirements: *13990200
+  version_requirements: *28534820
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &13989560 !ruby/object:Gem::Requirement
+  requirement: &28534020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *13989560
+  version_requirements: *28534020
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &13988980 !ruby/object:Gem::Requirement
+  requirement: &28533280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,7 +98,7 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *13988980
+  version_requirements: *28533280
 description: A tiny mongoid extension to provide the `touch` method known from ActiveRecord
   to Mongoid::Document.
 email: chris@dinarrr.com
@@ -106,7 +106,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
@@ -115,9 +115,13 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
+- lib/config/locales/en.yml
+- lib/mongoid/document/touch.rb
+- lib/mongoid/errors/document_not_updated.rb
+- lib/mongoid/errors/frozen_instance.rb
 - lib/mongoid/errors/missing_field.rb
 - lib/mongoid_touch.rb
 - mongoid_touch.gemspec
@@ -138,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1506535053835906170
+      hash: -1334556587712060989
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= mongoid_touch
-
-A tiny mongoid extension to provide the `touch` method known from ActiveRecord to Mongoid::Document.
-
-== Contributing to mongoid_touch
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Christoph Grabo. See LICENSE.txt for
-further details.
-