hashid-rails 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fe325595eeafbc4188f0913be0ac17741e189aa
-  data.tar.gz: b4185d19550070bcf9c0f39b68879143ac63f573
+  metadata.gz: ff291b0a3ecd103ccc6af6971f85636cd06e0c3f
+  data.tar.gz: 99cddc687a989d82845d7d928a26d5e8f19b872b
 SHA512:
-  metadata.gz: df5fe6370f8361bc180b47af9786012639d5d84a7bebaf921c4da895f54f6bb72cf8193912a82cd7e0d7e00d1fbcd7d8a67be1909d3a905e7536b9596101ad2b
-  data.tar.gz: 83b1355d0319263be80bf7e6e6138800a803fab8eb84114650f03b55b0552a8b55297df579c3b87cfae257b244f335f999fb04c6707bfea8c395cc26ef37b63c
+  metadata.gz: 2ba2b51cab4a714ba1d5020095e742bac5569a2d2316282af29e5733d97a0cd723b47009368e08b426fe10378e09824a8448446487dfad0e95bd08be48392dd4
+  data.tar.gz: 851fd6b4a1f66a5baf332ec942852c2811e635888f79aefd7b438e36c0c6622b7f24cb49a547a2000f3acb77e1f7e20846a052f1ec8d7893512f78db88f9a0dc

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.7.0 (2017-02-15)
+- Add configuration option to disable overriding default `find` (#22).
+
 ## 0.6.0 (2017-01-07)
 - Add Rubocop and adjust styles to be consistent.
 - Fix issue where finding multiple non-hashids returns an array of nils.

data/README.md

@@ -65,8 +65,23 @@ Hashid::Rails.configure do |config|
   # config.alphabet is optional, hashids provides a default
   # alphabet that consists of all characters [a-zA-Z0-9]
   config.alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
+  
+  # If your alphbet contains any numerals [0-9], then we recommend diabling the find method
+  #config.disable_find = true
 end
 ```
+### Disable Find Method
+
+If your alphabet includes numerals (0-9) and if the ids in your database are the same length as your hashes, then there could be valid
+hashids that are identical to valid ids.  This ambiguity could lead the `find` method to behave unpredictably.  Since `find` accepts both
+hashids and ids, an input argument that is potentially both a valid hashid and id, will cause `find` to treat the argument as a hashid
+in some cases, and as an id in others.  This unpredictably is usually not desired and can lead to subtle bugs appearing at runtime
+
+In order to avoid this problem, users can add `config.disable_find = true` to their initializer.  This will disable the hashid
+functionality of the `find` method and force `find` to only accept normal (unhashed) ids.  Under this configuration, programmer 
+will need to use the `find_by_hashid` method when desiring to explicitly search by hashid.
+
+It is recommended that `config.disable_find = true` be set when the alphabet contains any numerals.
 
 ## Development
 

data/lib/hashid/rails/configuration.rb

@@ -1,12 +1,13 @@
 module Hashid
   module Rails
     class Configuration
-      attr_accessor :secret, :length, :alphabet
+      attr_accessor :secret, :length, :alphabet, :disable_find
 
       def initialize
         @secret = ""
         @length = 6
         @alphabet = nil
+        @disable_find = false
       end
     end
   end

data/lib/hashid/rails/version.rb

@@ -1,5 +1,5 @@
 module Hashid
   module Rails
-    VERSION = "0.6.0".freeze
+    VERSION = "0.7.0".freeze
   end
 end

data/lib/hashid/rails.rb

@@ -63,7 +63,11 @@ module Hashid
       end
 
       def find(hashid)
-        model_reload? ? super(hashid) : super(decode_id(hashid) || hashid)
+        if model_reload? || Hashid::Rails.configuration.disable_find
+          super(hashid)
+        else
+          super(decode_id(hashid) || hashid)
+        end
       end
 
       def find_by_hashid(hashid)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashid-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-08 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler