hashid-rails 1.2.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 507694ba57b2e4a2bcdfa90869828753f0cb30d1
-  data.tar.gz: 91496f73e9b29be5cb2a4c72693de1f60c545b08
+SHA256:
+  metadata.gz: fd185250fd0af5aafc4c16778f0c75caa5a6d9e40e66a9f7cb4d80f72abbd695
+  data.tar.gz: 5cbf59b9d08b71d217b1fafac1259bc039997a7df1a71e0050df1b192e2a1b4a
 SHA512:
-  metadata.gz: 661591b2767fae3adc5556e7e6c78fe912cbad133fedcd4266ee1d2317fc82cd29afe6fdf9d2870b2f4ce41d3f4e89fa7d56c0cc23ea5eed20c475eb96460006
-  data.tar.gz: 01c86a260f13fa72a9a253175ff3728d583ee41a70fc2e1960546efe0f716994ef2c4c2b7abe59218745543c501542dcd2abf62f93e8b54fa037b32472eae0e1
+  metadata.gz: c8ee16a2e88d3efeca25e40e62215d95525e0f2e37428a3c6ae04bc19ff8977f1a8e48483ff4482467b43cf0cdc801bdacb12c9c6fe6790515633730b38e1661
+  data.tar.gz: 363076602dac93a35124cef3e5519a5e3544abdf97e35f8de67e245d04f213a0b4119b47cfe0cdb01cfcad17b2aebbc3cb8e08a9acce8e407661f583a19c4e9a

data/.github/workflows/ruby.yml

@@ -0,0 +1,51 @@
+name: build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} on Rails ${{ matrix.rails }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.5", "2.6"]
+        rails: ["4.2", "5.0", "5.1", "5.2", "6.0"]
+        include:
+          - ruby: "2.7"
+            rails: "6.0"
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Install Ruby (${{ matrix.ruby }})
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install SQLite
+      run: sudo apt install -y libsqlite3-dev
+
+    - name: Cache Ruby Gems
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ruby-${{ matrix.ruby }}-rails-${{ matrix.rails }}-gems-${{ hashFiles('hashid-rails.gemspec', 'Appraisals') }}
+        restore-keys: |
+          ruby-${{ matrix.ruby }}-rails-${{ matrix.rails }}-gems-
+
+    - name: Install Ruby dependencies
+      run: |
+        bundle config set path ../vendor/bundle
+        bundle install --gemfile gemfiles/rails_${{ matrix.rails }}.gemfile --jobs 4 --retry 3
+
+    - name: Test with RSpec
+      env:
+        BUNDLE_GEMFILE: gemfiles/rails_${{ matrix.rails }}.gemfile
+      run: bundle exec appraisal rails-${{ matrix.rails }} rspec
+
+    - name: Publish Test Coverage
+      uses: paambaati/codeclimate-action@v2.6.0
+      env:
+        CC_TEST_REPORTER_ID: 37aee70bb2e818f3bf4d2af88ea4a4355393901ba98b3876c244d42ed20fdbe1
+      with:
+        coverageCommand: true

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 /.ruby-version
+*.gemfile.lock

data/.rubocop.yml

@@ -1,10 +1,15 @@
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-Style/IndentArray:
+AllCops:
+  TargetRubyVersion: 2.3
+Layout/IndentArray:
   EnforcedStyle: consistent
-Style/Documentation:
-  Enabled: false
 Metrics/BlockLength:
   Exclude:
   - "*.gemspec"
   - "spec/**/*.rb"
+Naming/PredicateName:
+  NameWhitelist:
+    - has_many
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Appraisals

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+appraise "rails-4.2" do
+  gem "activerecord", "~> 4.2.0"
+  gem "sqlite3", "< 1.4"
+end
+
+appraise "rails-5.0" do
+  gem "activerecord", "~> 5.0.0"
+  gem "sqlite3", "< 1.4"
+end
+
+appraise "rails-5.1" do
+  gem "activerecord", "~> 5.1.0"
+end
+
+appraise "rails-5.2" do
+  gem "activerecord", "~> 5.2.0"
+end
+
+appraise "rails-6.0" do
+  gem "activerecord", "~> 6.0.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 1.4.1 (2020-08-09)
+
+- Use ** splat operator to address deprecation warning in Ruby 2.7 ([#72](https://github.com/jcypret/hashid-rails/pull/72)) by [alexford](https://github.com/alexford)
+- Use codeclimate-action to improve edge-case handling ([#73](https://github.com/jcypret/hashid-rails/pull/73))
+- Add matrix testing for supported Ruby ([#74](https://github.com/jcypret/hashid-rails/pull/74)) and Rails ([#75](https://github.com/jcypret/hashid-rails/pull/75)) versions.
+
+## 1.4.0 (2019-10-30)
+- Add support for disabling the overriding of `to_param` ([#68](https://github.com/jcypret/hashid-rails/pull/68))
+- Fix exception raised when calling `hashid` on an model with a `nil` id
+  ([#63](https://github.com/jcypret/hashid-rails/pull/63)) by [fauxparse](https://github.com/fauxparse)
+
+## 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
+  decode an integer ID from [@Drakula2k](https://github.com/Drakula2k) ([#54](https://github.com/jcypret/hashid-rails/pull/54)).
+
+## 1.2.1 (2018-01-13)
+- Found issue where unsigned hashids with `find` did not fall back to passed in ID ([#46](https://github.com/jcypret/hashid-rails/pull/46)).
+- Move finder specs to a shared example run against both the signed and unsigned hashids.
+
 ## 1.2.0 (2017-11-17)
 - Fix regression where `find_by_hashid` and `find_by_hashid!` attempt to decode
   values that are not hashids. ([#41](https://github.com/jcypret/hashid-rails/pull/41))

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in hashid-rails.gemspec

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)
 
@@ -18,7 +18,7 @@ be added or removed at any time.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hashid-rails', '~> 1.0'
+gem "hashid-rails", "~> 1.0"
 ```
 
 And then execute:
@@ -27,12 +27,6 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-
-```shell
-$ gem install hashid-rails -v 1.0
-```
-
 ## Basic Usage
 
 1. Include Hashid Rails in the ActiveRecord model you'd like to enable hashids.
@@ -60,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.
 
@@ -100,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
@@ -114,11 +109,30 @@ Hashid::Rails.configure do |config|
   # Whether to override the `find` method
   config.override_find = true
 
+  # Whether to override the `to_param` method
+  config.override_to_param = 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
 ```
 
+### 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
@@ -153,3 +167,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/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "hashid/rails"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+gem "sqlite3", "< 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+gem "sqlite3", "< 1.4"
+
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+
+gemspec path: "../"

data/hashid-rails.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "hashid/rails/version"
@@ -10,13 +11,13 @@ Gem::Specification.new do |spec|
   spec.email         = ["jcypret@gmail.com"]
 
   spec.summary       = "Use Hashids in your Rails app models."
-  spec.description   = <<-EOM
+  spec.description   = <<-DESCRIPTION
     This gem allows you to easily use [Hashids](http://hashids.org/ruby/)
     in your Rails app. Instead of your models using sequential numbers like 1,
     2, 3, they 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.
-  EOM
+  DESCRIPTION
   spec.homepage      = "https://github.com/jcypret/hashid-rails"
   spec.license       = "MIT"
 
@@ -27,13 +28,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.4.0"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
-  spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.add_development_dependency "sqlite3"
 
   spec.add_runtime_dependency "activerecord", ">= 4.0"
   spec.add_runtime_dependency "hashids", "~> 1.0"

data/lib/hashid/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "hashid/rails/version"
 require "hashid/rails/configuration"
 require "hashids"
@@ -31,17 +33,37 @@ module Hashid
     def hashid
       self.class.encode_id(id)
     end
-    alias to_param hashid
+
+    def to_param
+      self.class.hashid_configuration.override_to_param ? hashid : super
+    end
 
     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
 
-      def has_many(*args, &block) # rubocop:disable Style/PredicateName
+      def has_many(*args, &block)
         options = args.extract_options!
         options[:extend] = Array(options[:extend]).push(ClassMethods)
-        super(*args, options, &block)
+        super(*args, **options, &block)
       end
 
       def encode_id(ids)
@@ -69,7 +91,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
@@ -87,11 +109,13 @@ 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
+        return nil if id.nil?
+
+        if hashid_configuration.sign_hashids
           hashids.encode(HASHID_TOKEN, id)
         else
           hashids.encode(id)
@@ -99,14 +123,16 @@ module Hashid
       end
 
       def hashid_decode(id, fallback:)
-        decoded_hashid = hashids.decode(id.to_s)
         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
+          decoded_hashid.first || fallback_value
         end
+      rescue Hashids::InputError
+        fallback_value
       end
 
       def valid_hashid?(decoded_hashid)

data/lib/hashid/rails/configuration.rb

@@ -1,24 +1,30 @@
+# frozen_string_literal: true
+
 module Hashid
   module Rails
     class Configuration
       attr_accessor :salt,
+                    :pepper,
                     :min_hash_length,
                     :alphabet,
                     :override_find,
+                    :override_to_param,
                     :sign_hashids
 
       def initialize
         @salt = ""
+        @pepper = ""
         @min_hash_length = 6
         @alphabet = "abcdefghijklmnopqrstuvwxyz" \
                     "ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
                     "1234567890"
         @override_find = true
+        @override_to_param = true
         @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

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Hashid
   module Rails
-    VERSION = "1.2.0".freeze
+    VERSION = "1.4.1"
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hashid-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Justin Cypret
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-11-18 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,35 +53,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +95,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,10 +162,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
+- Appraisals
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -159,6 +174,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
+- gemfiles/rails_5.1.gemfile
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_6.0.gemfile
 - hashid-rails.gemspec
 - lib/hashid/rails.rb
 - lib/hashid/rails/configuration.rb
@@ -167,7 +187,7 @@ homepage: https://github.com/jcypret/hashid-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,9 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Use Hashids in your Rails app models.
 test_files: []

data/.travis.yml

@@ -1,9 +0,0 @@
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.0
-addons:
-  code_climate:
-    repo_token: 37aee70bb2e818f3bf4d2af88ea4a4355393901ba98b3876c244d42ed20fdbe1
-after_success:
-  - bundle exec codeclimate-test-reporter