mongoid-ids 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f98fcca5a53dd0256f8e74ab38719ce9bd2e001b
-  data.tar.gz: 47b8832b2ff1d6a217aac882b275770ff9c7fb24
+  metadata.gz: e9972a9121c4854be14d38fe4e5c21c51af16e9c
+  data.tar.gz: 1c210ceb6bdb7e6388572ccd5a0145f9baa44b75
 SHA512:
-  metadata.gz: 37852de0e84195e089881f026e322679977bfc3a576d5bfd57dcd14e97c6983110875ee5896a7b318509d5a983d6e07a22f4f08ae7edfc99808c0950cbc18579
-  data.tar.gz: cc4fa090eabec9cd29b999e04406d680e73537e2bec545d28b0f115665c2f40a0f782ed5aa016a1def94872e04953ceac65c5ca3e6bedcd780b55ecda59eb952
+  metadata.gz: 8f2549a80a6c1599e8d1ab9f471691aca2b6601e173532c73e5632fbc9ef1bb118fc21faf27d2447e978a5f0d29007a40818c8a3a5bf1a1a385bf8a9b4548652
+  data.tar.gz: 6257c1b856c9e43c1179d65c703ab61cf0f73abd21d7f6bd78d0d3d9d02b391ddd45d813e8084706d14c7f99534321eda92ef6adfc133eb3f1d6a509d45ab95f

data/.travis.yml

@@ -3,9 +3,15 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
   - 2.1.1
   - 2.2.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: rbx-2
 
 gemfile:
   - Gemfile

data/README.md

@@ -1,9 +1,18 @@
-# Mongoid::Ids - Short snappy ids/tokens for Mongoid documents
-
-[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-ids.png)](http://travis-ci.org/nofxx/mongoid-ids)
+# Mongoid::Ids
 [![Code Climate](https://codeclimate.com/github/nofxx/mongoid-ids.png)](https://codeclimate.com/github/nofxx/mongoid-ids)
+[![Dependency Status](https://gemnasium.com/nofxx/mongoid-ids.svg)](https://gemnasium.com/nofxx/mongoid-ids)
+[![Build Status](https://secure.travis-ci.org/nofxx/mongoid-ids.png)](http://travis-ci.org/nofxx/mongoid-ids)
+
+## 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.
 
-This library is a quick and simple way to generate unique, random tokens
+
+## 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.
 
@@ -20,11 +29,7 @@ Into something more like this:
 
 In your gemfile, add:
 
-    gem 'mongoid-ids', '~> 2.0.0'
-
-Then update your bundle
-
-    $ bundle update
+    gem 'mongoid-ids'
 
 In your Mongoid documents, just add `include Mongoid::Ids` and the
 `token` method will take care of all the setup, like so:
@@ -45,40 +50,56 @@ 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
+## Configuration
 
-As of `Mongoid::Ids` 2.0.0, you can now choose between two different
-systems for managing how your tokens look.
+You may choose between two different systems for 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`)
 
@@ -87,8 +108,8 @@ 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.
@@ -113,17 +134,16 @@ 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
@@ -143,7 +163,7 @@ generated character, and are as follows:
 __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
@@ -152,7 +172,7 @@ 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
@@ -162,8 +182,8 @@ 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
 ```
 
@@ -175,19 +195,7 @@ overrides for the default `find` behaviour used by Mongoid.
 
 __Example:__
 ```ruby
-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
+token skip_finders: true
 ```
 
 
@@ -200,12 +208,17 @@ 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.
@@ -214,7 +227,7 @@ 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),

data/lib/mongoid/ids.rb

@@ -27,7 +27,6 @@ module Mongoid
           add_token_field_and_index(options)
 
           define_custom_finders(options) if options.skip_finders? == false
-          override_to_param(options) if options.override_to_param?
         end
       end
 
@@ -57,12 +56,6 @@ module Mongoid
           document.create_token_if_nil options.field_name, options.pattern
         end
       end
-
-      def override_to_param(options)
-        self.send(:define_method, :to_param) do
-          self.send(options.field_name) || super()
-        end
-      end
     end
 
     protected

data/lib/mongoid/ids/options.rb

@@ -30,10 +30,6 @@ module Mongoid
         @options[:skip_finders]
       end
 
-      def override_to_param?
-        @options[:override_to_param]
-      end
-
       def pattern
         @options[:pattern] ||= \
         case @options[:contains].to_sym
@@ -69,8 +65,7 @@ module Mongoid
           :retry_count => 3,
           :contains => :alphanumeric,
           :field_name => :_id,
-          :skip_finders => false,
-          :override_to_param => true,
+          :skip_finders => false
         }.merge(options)
       end
     end

data/lib/mongoid/ids/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Ids
-    VERSION = '0.1.1'
+    VERSION = '0.1.7'
   end
 end

data/spec/mongoid/ids/options_spec.rb

@@ -50,17 +50,6 @@ describe Mongoid::Ids::Options do
     expect(Mongoid::Ids::Options.new.pattern).to eq('%s4')
   end
 
-  describe 'override_to_param' do
-    it 'should be an option' do
-      expect(Mongoid::Ids::Options.new(override_to_param: false)
-              .override_to_param?).to eq false
-    end
-
-    it 'should default to true' do
-      expect(Mongoid::Ids::Options.new.override_to_param?).to eq true
-    end
-  end
-
   describe 'skip_finder' do
     it 'should be an option' do
       expect(Mongoid::Ids::Options.new(skip_finders: true)

data/spec/mongoid/token_spec.rb

@@ -283,9 +283,9 @@ describe Mongoid::Ids do
   end
 
   describe '.to_param' do
-    it 'should return the token' do
+    it 'should be removed from this gem' do
       document_class.send(:token, :token)
-      expect(document.to_param).to eq document.token
+      expect(document.to_param).to eq document.id.to_s # why to_s?
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-ids
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.7
 platform: ruby
 authors:
 - Nicholas Bruning