hashid-rails 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ea795a68ca182b4cf66429705dc4281272502ef4e9922551082ddb1dfad022
-  data.tar.gz: 38f04be13d9159eadd37075091f90ddb57bef4eaac679718681deae67cfc33d1
+  metadata.gz: ff1db9b357cb0791da90ba58f86c3193d8f02fa9585099c18a90edb274bb4dbe
+  data.tar.gz: 11b31881df97678fda33e38eb42153b245b9f0672e823f3cae57219586a178b9
 SHA512:
-  metadata.gz: 94cecc8c493920fb3aa1e0495e307989d6d1051ca8284580f11be3090f55a3c9821c34f8cb4248511c70537c618db1066f5ebdb3a654a7e1182c700f67e7eb30
-  data.tar.gz: 2ed1f2740f8f1d67fd2ce1997b6c06d6de4d8925eca00eb13dd9251a75406bac09635429d8a7e8177a4ef3b62af88825330e93fd7530746fcbd30ffeebd221cc
+  metadata.gz: 9fedf05af138f2efbeb4e1caedafc0ab844946cba287e085bd4446f49a218f4f44926602b36d26a5d06b2792d49f7b0e37121230c561d6b13ad351fa8e3e56f0
+  data.tar.gz: db9d9f9740bca29e8b0bf33ac2d1598a98a34516368a7d503bf10bfe71f8cbc147819934675eb1dda46bfddf32acff25705a0133f4ddc85a2f424e4842e41426

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+
+    - name: Install Ruby (2.6)
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+
+    - name: Install SQLite
+      run: sudo apt install -y libsqlite3-dev
+
+    - name: Setup Code Climate test-reporter
+      run: |
+        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+        chmod +x ./cc-test-reporter
+        ./cc-test-reporter before-build
+
+    - name: Build and test with RSpec
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rspec
+
+    - name: Publish code coverage
+      run: |
+        export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
+        ./cc-test-reporter after-build -r ${{secrets.CC_TEST_REPORTER_ID}}

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.3.0 (2019-10-29)
+- Add support for model-level config ([#67](https://github.com/jcypret/hashid-rails/pull/67))
+
 ## 1.2.2 (2018-07-29)
 ### Fixed
 - Handle exception raised when using a letter-only alphabet and attempting to

data/README.md

@@ -1,6 +1,6 @@
 # Hashid Rails
 [![Gem Version](https://badge.fury.io/rb/hashid-rails.svg)](https://badge.fury.io/rb/hashid-rails)
-[![Build Status](https://travis-ci.org/jcypret/hashid-rails.svg?branch=master)](https://travis-ci.org/jcypret/hashid-rails)
+![Build Status](https://github.com/jcypret/hashid-rails/workflows/build/badge.svg?branch=master)
 [![Code Climate](https://codeclimate.com/github/jcypret/hashid-rails/badges/gpa.svg)](https://codeclimate.com/github/jcypret/hashid-rails)
 [![Test Coverage](https://codeclimate.com/github/jcypret/hashid-rails/badges/coverage.svg)](https://codeclimate.com/github/jcypret/hashid-rails/coverage)
 
@@ -54,7 +54,7 @@ model.hashid
 #=> "yLA6m0oM"
 ```
 
-Additionally, the `to_param` method is overriden to use hashid instead of id.
+Additionally, the `to_param` method is overridden to use hashid instead of id.
 This means methods that take advantage of implicit ID will automatically work
 with hashids.
 
@@ -94,8 +94,9 @@ default options.
 
 ```ruby
 Hashid::Rails.configure do |config|
-  # The salt to use for generating hashid. Prepended with table name.
+  # The salt to use for generating hashid. Prepended with pepper (table name).
   config.salt = ""
+  config.pepper = table_name
 
   # The minimum length of generated hashids
   config.min_hash_length = 6
@@ -113,6 +114,22 @@ Hashid::Rails.configure do |config|
 end
 ```
 
+### Model-Level Config
+
+You can also customize the hashid configuration at the model level.
+`hashid_config` supports all the same options as the `Hashid::Rails.configure`
+block and allows for each model to have a different config. This can be useful
+for setting a custom salt/pepper. For instance, the pepper defaults to the table
+name, so if you rename the table, you can keep the same hashids by setting the
+pepper to the old table name.
+
+```ruby
+class Model < ActiveRecord::Base
+  include Hashid::Rails
+  hashid_config pepper: "old_table_name"
+end
+```
+
 ## Upgrading from Pre-1.0
 
 The 1.0 release of this gem introduced hashid signing to prevent
@@ -147,3 +164,6 @@ and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+> NOTE: If it's a significant feature or change, consider creating an Issue for
+> discussion before opening a PR.

data/lib/hashid/rails.rb

@@ -36,6 +36,23 @@ module Hashid
     alias to_param hashid
 
     module ClassMethods
+      def hashid_config(options = {})
+        config = Hashid::Rails.configuration.dup
+        config.pepper = table_name
+        options.each do |attr, value|
+          config.public_send("#{attr}=", value)
+        end
+        @hashid_configuration = config
+      end
+
+      def hashid_configuration
+        @hashid_configuration || hashid_config
+      end
+
+      def reset_hashid_config
+        @hashid_configuration = nil
+      end
+
       def relation
         super.tap { |r| r.extend ClassMethods }
       end
@@ -71,7 +88,7 @@ module Hashid
         uniq_ids = ids.flatten.compact.uniq
         uniq_ids = uniq_ids.first unless expects_array || uniq_ids.size > 1
 
-        if Hashid::Rails.configuration.override_find
+        if hashid_configuration.override_find
           super(decode_id(uniq_ids, fallback: true))
         else
           super
@@ -89,11 +106,11 @@ module Hashid
       private
 
       def hashids
-        Hashids.new(*Hashid::Rails.configuration.for_table(table_name))
+        Hashids.new(*hashid_configuration.to_args)
       end
 
       def hashid_encode(id)
-        if Hashid::Rails.configuration.sign_hashids
+        if hashid_configuration.sign_hashids
           hashids.encode(HASHID_TOKEN, id)
         else
           hashids.encode(id)
@@ -104,7 +121,7 @@ module Hashid
         fallback_value = fallback ? id : nil
         decoded_hashid = hashids.decode(id.to_s)
 
-        if Hashid::Rails.configuration.sign_hashids
+        if hashid_configuration.sign_hashids
           valid_hashid?(decoded_hashid) ? decoded_hashid.last : fallback_value
         else
           decoded_hashid.first || fallback_value

data/lib/hashid/rails/configuration.rb

@@ -4,6 +4,7 @@ module Hashid
   module Rails
     class Configuration
       attr_accessor :salt,
+                    :pepper,
                     :min_hash_length,
                     :alphabet,
                     :override_find,
@@ -11,6 +12,7 @@ module Hashid
 
       def initialize
         @salt = ""
+        @pepper = ""
         @min_hash_length = 6
         @alphabet = "abcdefghijklmnopqrstuvwxyz" \
                     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
@@ -19,8 +21,8 @@ module Hashid
         @sign_hashids = true
       end
 
-      def for_table(table_name)
-        ["#{table_name}#{salt}", min_hash_length, alphabet]
+      def to_args
+        ["#{pepper}#{salt}", min_hash_length, alphabet]
       end
     end
   end

data/lib/hashid/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Hashid
   module Rails
-    VERSION = "1.2.2"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashid-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-07-29 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -148,6 +148,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -182,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Use Hashids in your Rails app models.