https://github.com/ream88/mongoid-permalinks
Permalinks for your Mongoid documents.
https://github.com/ream88/mongoid-permalinks
Last synced: 5 months ago
JSON representation
Permalinks for your Mongoid documents.
- Host: GitHub
- URL: https://github.com/ream88/mongoid-permalinks
- Owner: ream88
- Created: 2012-12-22T18:37:31.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-03-07T16:37:27.000Z (over 12 years ago)
- Last Synced: 2025-10-07T23:42:34.065Z (8 months ago)
- Language: Ruby
- Homepage: mariouher.com/mongoid-permalinks
- Size: 176 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# mongoid-permalinks
Mongoid::Permalinks adds a permalink based on your document `to_s` method.
## Installation
In your Gemfile:
```ruby
gem 'mongoid-permalinks'
```
## Usage
```ruby
class Document
include Mongoid::Document
include Mongoid::Permalinks
field :name, type: String
alias_method :to_s, :name
end
```
```ruby
document = Document.create(name: 'Mongoid::Permalinks is awesome')
document.permalink # => 'mongoid-permalinks-is-awesome'
```
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
## Copyright
(The MIT license)
Copyright (c) 2012-2014 Mario Uher
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.