README.md in mongoid-ids-0.1.1 vs README.md in mongoid-ids-0.1.7
- old
+ new
@@ -1,11 +1,20 @@
-# Mongoid::Ids - Short snappy ids/tokens for Mongoid documents
-
-[](http://travis-ci.org/nofxx/mongoid-ids)
+# Mongoid::Ids
[](https://codeclimate.com/github/nofxx/mongoid-ids)
+[](https://gemnasium.com/nofxx/mongoid-ids)
+[](http://travis-ci.org/nofxx/mongoid-ids)
-This library is a quick and simple way to generate unique, random tokens
+## Mongoid::Token || Mongoid::Ids
+
+This gem is a fork that changes the default behaviour of original
+Mongoid::Token: instead of custom fields it changes _id by default.
+But you may still use tokens on custom fields.
+
+
+## Short snappy tokens for Mongoid documents
+
+This library is a quick and simple way to generate unique, random ids
for your mongoid documents, in the cases where you can't, or don't want
to use slugs, or the default MongoDB ObjectIDs.
Mongoid::Ids can help turn this:
@@ -18,16 +27,12 @@
## Getting started
In your gemfile, add:
- gem 'mongoid-ids', '~> 2.0.0'
+ gem 'mongoid-ids'
-Then update your bundle
-
- $ bundle update
-
In your Mongoid documents, just add `include Mongoid::Ids` and the
`token` method will take care of all the setup, like so:
```ruby
class Person
@@ -43,54 +48,70 @@
And that's it! There's lots of configuration options too - which are all
listed [below](#configuration). By default, the `token` method will
create tokens 4 characters long, containing random alphanumeric characters.
-__Note:__ Mongoid::Ids leverages Mongoid's 'safe mode' by
+## Custom/Extra fields
+
+
+```ruby
+class Person
+ include Mongoid::Document
+ include Mongoid::Ids
+
+ field :name
+
+ token :code
+ token :token
+ token :other_code
+end
+
+```
+
+__Note on custom field:__ Mongoid::Ids leverages Mongoid's 'safe mode' by
automatically creating a unique index on your documents using the token
field. In order to take advantage of this feature (and ensure that your
documents always have unique tokens) remember to create your indexes.
+Also, `Mongoid::Ids` will never override `to_param`.
## Finders
-By default, the gem will override the existing `find` method in Mongoid,
-in order to search for documents based on their token first (although
-the default behaviour of ObjectIDs is also there). You can disable these
-with the [`skip_finders` configuration option](#skip-finders-skip_finders).
+`Mongoid::Ids` will **never** override `find`.
+There's some helpers for custom fields:
```ruby
-Video.find("x3v98")
-Account.find("ACC-123456")
+Video.find_by_code("x3v98")
+Account.find_by_token("ACC-123456")
```
+You can disable these with the
+[`skip_finders` configuration option](#skip-finders-skip_finders).
+
## Configuration
-### Idss
+You may choose between two different systems for how your tokens look:
-As of `Mongoid::Ids` 2.0.0, you can now choose between two different
-systems for managing how your tokens look.
+For simple setup, you can use combination of the
+[`length`](#length-length) and [`contains`](#contains-contains),
+which modify the length and types of characters to use.
-For simple setup, you can use
-combination of the [`length`](#length-length) and [`contains`](#contains-contains), which modify the length and
-types of characters to use.
-
For when you need to generate more complex tokens, you can use the
-[`pattern`](#patterns-pattern) option, which allows for very low-level control of the precise
-structure of your tokens, as well as allowing for static strings, like
-prefixes, infixes or suffixes.
+[`pattern`](#patterns-pattern) option, which allows for very low-level
+control of the precise structure of your tokens, as well as allowing
+for static strings, like prefixes, infixes or suffixes.
#### Length (`:length`)
This one is easy, it's just an integer.
__Example:__
```ruby
-token :length => 6 # Tokens are now of length 6
-token :length => 12 # Whow, whow, whow. Slow down egghead.
+token length: 8 # Tokens are now of length 8
+token length: 12 # Whow, whow, whow. Slow down egghead.
```
You get the idea.
The only caveat here is that if used in combination with the
@@ -111,21 +132,20 @@
* `:fixed_numeric_no_leading_zeros` - same as `:fixed_numeric`, but will
never start with zeros
__Examples:__
```ruby
-token :contains => :alpha_upper, :length => 8
-token :contains => :fixed_numeric
+token contains: :alpha_upper, length: 8
+token contains: :fixed_numeric
```
#### Patterns (`:pattern`)
-New in 2.0.0, patterns allow you fine-grained control over how your
-tokens look. It's great for generating random data that has a
-requirements to also have some basic structure. If you use the
-`:pattern` option, it will override both the `:length` and `:contains`
-options.
+Patterns allow you fine-grained control over how your tokens look.
+It's great for generating random data that has a requirements to
+also have some basic structure. If you use the `:pattern` option,
+it will override both the `:length` and `:contains` options.
This was designed to operate in a similar way to something like `strftime`,
if the syntax offends you - please open an issue, I'd love to get some
feedback here and better refine how these are generated.
@@ -141,31 +161,31 @@
* `%D` - any non-zero digit
__Example:__
```ruby
-token :pattern => "PRE-%C%C-%d%d%d%d" # Generates something like: 'PRE-ND-3485'
+token pattern: "PRE-%C%C-%d%d%d%d" # Generates something like: 'PRE-ND-3485'
```
You can also add a repetition modifier, which can help improve readability on
more complex patterns. You simply add any integer after the letter.
__Examples:__
```ruby
-token :pattern => "APP-%d6" # Generates something like; "APP-638924"
+token pattern: "APP-%d6" # Generates something like; "APP-638924"
```
### Field Name
This allows you to change the field name used by `Mongoid::Ids`
This is particularly handy to use multiple tokens one a single document.
__Examples:__
```ruby
-token :length => 6
-token :sharing_token, :length => 12
+token length: 6
+token :sharing_token, length: 12
token :yet_another
```
### Skip Finders (`:skip_finders`)
@@ -173,49 +193,42 @@
This will prevent the gem from creating the customised finders and
overrides for the default `find` behaviour used by Mongoid.
__Example:__
```ruby
-token :skip_finders => true
+token skip_finders: true
```
-### Override to_param (`:override_to_param`)
-
-By default, `Mongoid::Ids` will override to_param, to make it an easy
-drop-in replacement for the default ObjectIDs. If needed, you can turn
-this behaviour off:
-
-__Example:__
-```ruby
-token :override_to_param => false
-```
-
-
### Retry Count (`:retry_count`)
In the event of a token collision, this gem will attempt to try three
more times before raising a `Mongoid::Ids::CollisionRetriesExceeded`
error. If you're wanting it to try harder, or less hard, then this
option is for you.
__Examples:__
```ruby
-token :retry_count => 9
-token :retry_count => 0
+token retry_count: 9
+token retry_count: 0
```
# Notes
+This gem just changes the Mongoid::Token behaviour, use it if you don't
+need to change ids:
+
+http://github.com/thetron/mongoid_token
+
If you find a problem, please [submit an issue](http://github.com/nofxx/mongoid-ids/issues) (and a failing test, if
you can). Pull requests and feature requests are always welcome and
greatly appreciated.
Thanks to everyone that has contributed to this gem over the past year.
Many, many thanks - you guys rawk.
-## Contributors:
+## Mongoid::Token Contributors:
Thanks to everyone who has provided support for this gem over the years.
In particular: [olliem](https://github.com/olliem),
[msolli](https://github.com/msolli),
[siong1987](https://github.com/siong1987),