Giter Club home page Giter Club logo

mongoid_touch's Introduction

mongoid_touch build status

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:

my_model_instance.touch
my_model_instance.touch! # will raise errors if touching fails.

This will update the updated_at field if present.

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.

mongoid_touch's People

Contributors

asaaki avatar inuki avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.