Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Easy access to your Mongoid document's siblings.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/mongoid
spec
.gitignore
Gemfile
LICENSE
README.md
Rakefile
mongoid-siblings.gemspec

README.md

mongoid-siblings Build Status

mongoid-siblings adds methods to enable you to easily access your Mongoid document's siblings.

Requirements

  • mongoid (~> 3.0)

Installation

Add the following to your Gemfile:

gem "mongoid-siblings", require: "mongoid/siblings"

And tell Bundler to install the new gem:

bundle install

Usage

Include the Mongoid::Siblings module in your document class:

class Book
  include Mongoid::Document
  include Mongoid::Siblings

  belongs_to :publisher
  belongs_to :author

  ...
end

You will now have access to the following methods:

# Find all books by this book's author, not including this book.
book.siblings(scope: :author)

# Find all books by this book's author.
book.siblings_and_self(scope: :author)

# Check whether a certain book was published by the same publisher as this book.
book.sibling_of?(other_book, scope: :publisher)

# Make this book a sibling of a book with another author and publisher.
# This will set this books author and publisher to match that of the other book.
book.become_sibling_of!(other_book, scope: [:author, :publisher])

Full documentation

See this project's RubyDoc.info page.

Known issues

See the GitHub Issues page.

License

Copyright (c) 2012 Douwe Maan

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.

Something went wrong with that request. Please try again.