hashid-rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 452d76b6a75d881163fd3f8a5216b458ac1d96fd
-  data.tar.gz: 54201c5c82b115e15c207c7d0c57a8176cb490e7
+  metadata.gz: cf52f7660d6373fa40779618384e0ed119723ddb
+  data.tar.gz: 46ab38a8734c1c09a826bc39984bf8201c87a207
 SHA512:
-  metadata.gz: b604b9ed6b7550f16445847d1f2f93de1af252cc70c1a72c76a2709cb803eda02598e8b0d2102705a109911dcc18f4abc916f025c293102da700303c24756233
-  data.tar.gz: 679db7739b37d2d705e9b1745e78abd881682982c8d5fc591d6de159cc8641e3e2b10ace09e2084c0e7d3332eb2581747e810f72bb5208e697fc9cfb59ddf5f5
+  metadata.gz: 97335ce4d3e274f3dc57d70ecd08f70b851fb5a204051e6d63475b5125f0c045e701761db765b88e627e180eca74336dd013e9dc57afdcbbcd79befc69dce8c7
+  data.tar.gz: d58c2692ca18d302997a6ba1cb690187de52421cff9bbdfbb36687076b2ec8c9be3bc36498789a62bc963bb4a3c01735b06f08fc2672385f6dc797fe11e100ba

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0 (2017-10-04)
+- Add option to disable hashid signing. This adds backwards compatibility with
+  pre-1.0 releases. Thanks [@olliebennett](https://github.com/olliebennett)! ([#37](https://github.com/jcypret/hashid-rails/pull/37))
+- Add note to README about upgrading from pre-1.0 releases.
+
 ## 1.0.0 (2017-04-29)
 - Sign hashids to prevent accidentally decoded regular ids
 - Require explicitly including Hashid::Rails in models

data/README.md

@@ -10,6 +10,9 @@ will instead have unique short hashes like "yLA6m0oM", "5bAyD0LO", and
 "wz3MZ49l". The database will still use integers under the hood, so this gem can
 be added or removed at any time.
 
+> IMPORTANT: If you need to maintain the same hashids from a pre-1.0 release,
+> read the [upgrade notes](#upgrading-from-pre-10).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -110,9 +113,29 @@ Hashid::Rails.configure do |config|
 
   # Whether to override the `find` method
   config.override_find = true
+
+  # Whether to sign hashids to prevent conflicts with regular IDs (see https://github.com/jcypret/hashid-rails/issues/30)
+  config.sign_hashids = true
 end
 ```
 
+## Upgrading from Pre-1.0
+
+The 1.0 release of this gem introduced hashid signing to prevent
+conflicts with database IDs that could be mis-interpreted as hashids.
+IDs are now signed when encoding and the signature verified when decoding.
+The trade off is that hashids are different than in previous versions due to the added signature.
+If you need to maintain the same hashids from a pre-1.0 version, set `sign_hashids` to false in the config.
+
+Additionally, some of the config names have been modified to better match the parent [Hashid](https://github.com/peterhellberg/hashids.rb) project.
+The config `secret` has been renamed to `salt` and the `length` renamed to `min_hash_length`.
+Update the initializer config accordingly.
+
+Lastly, `Hashid::Rails` is no longer imported into `ActiveRecord::Base` by default.
+You can instead include `Hashid::Rails` selectively in the desired models,
+or include it in `ApplicationRecord` for Rails 5 to apply to all subclassed models,
+or add an initializer with `ActiveRecord::Base.send :include, Hashid::Rails` to match previous behavior.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/hashid/rails.rb

@@ -78,13 +78,20 @@ module Hashid
       end
 
       def hashid_encode(id)
-        hashids.encode(HASHID_TOKEN, id)
+        if Hashid::Rails.configuration.sign_hashids
+          hashids.encode(HASHID_TOKEN, id)
+        else
+          hashids.encode(id)
+        end
       end
 
       def hashid_decode(id)
         decoded_hashid = hashids.decode(id.to_s)
-        return id unless valid_hashid?(decoded_hashid)
-        decoded_hashid.last
+        if Hashid::Rails.configuration.sign_hashids
+          valid_hashid?(decoded_hashid) ? decoded_hashid.last : id
+        else
+          decoded_hashid.first
+        end
       end
 
       def valid_hashid?(decoded_hashid)

data/lib/hashid/rails/configuration.rb

@@ -1,7 +1,11 @@
 module Hashid
   module Rails
     class Configuration
-      attr_accessor :salt, :min_hash_length, :alphabet, :override_find
+      attr_accessor :salt,
+                    :min_hash_length,
+                    :alphabet,
+                    :override_find,
+                    :sign_hashids
 
       def initialize
         @salt = ""
@@ -10,6 +14,7 @@ module Hashid
                     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
                     "1234567890"
         @override_find = true
+        @sign_hashids = true
       end
 
       def for_table(table_name)

data/lib/hashid/rails/version.rb

@@ -1,5 +1,5 @@
 module Hashid
   module Rails
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.0".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashid-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-29 00:00:00.000000000 Z
+date: 2017-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler