hashid-rails 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b2ea9d51584971cbf828a309a551da690745fbd
-  data.tar.gz: 04f8a2f59a6fa30308b3103b7698153795b6b46c
+  metadata.gz: 71c60b5b414a413c97192b5c81cc6c0495a71a06
+  data.tar.gz: d4e88b4c3ee0ff8a1412eb19cf7bbae4ee29ed37
 SHA512:
-  metadata.gz: ef4dfa2c27773687fa4bf0b27e65bc415201fe1f022fdd31631c96ab2d4cef9b8c3b16a5209f5c12d9953bc1a3cb75906083d6b0c32aa83b8a440758a0f72752
-  data.tar.gz: 1c0d95fee24c8ce7d1d67df9ae4bb0740e57101d0e402e3398bd4ca2aa7f120b745bba65b7d53f353c40505110bc1a3d916a79778027fd9b693295fd2e818603
+  metadata.gz: c27cbfdf204ae0227beccdc6efeeec7544bb4f283fbe939c67b9266e6fa818f5878f8a49f99edec0b4e409c7b1559e725923c4ea5166abd11395a2e6acaa4ed2
+  data.tar.gz: 39ef44045dd17fd962d869a8cad31ccd0593b9be32bc07cd1fd1f3a5c03ce83ee12a62740070c696a8605c616c1fcdb5cc5035ad80ef90e2067363c55fca0822

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.2.0 (2016-01-02)
+
+- Customize the Hashid seed and length using a configuration initializer.
+- Add test coverage
+- Fix issue where calling `.reload` on model retries to `decode_id`.
+
 ## 0.1.2 (2015-04-12)
 
 - Let `Model#find` work with integers passed in as strings.

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in hashid-rails.gemspec
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,6 +1,13 @@
 # Hashid Rails
+[ ![Codeship Status for jcypret/hashid-rails](https://codeship.com/projects/79614b80-93bc-0133-e91e-767635853833/status?branch=master)](https://codeship.com/projects/124848)
+[![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)
 
-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.
+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.
 
 ## Installation
 
@@ -23,14 +30,30 @@ Or install it yourself as:
 Just use `Model#find` passing in the hashid instead of the model id:
 
 ```ruby
-@person = People.find(params[:hashid])
+@person = Person.find(params[:hashid])
+```
+
+## Configuration
+
+To customize the Hashids seed and ensure that another user of the gem cannot
+easily reverse engineer your ids, create an initializer and:
+
+```ruby
+Hashid::Rails.configure do |config|
+  config.secret = 'my secret'
+  config.length = 6
+end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release` to create a git tag for the version, push git commits
+and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/hashid-rails.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.9'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
 
   spec.add_runtime_dependency 'activerecord', '~> 4.0'
   spec.add_runtime_dependency 'hashids', '~> 1.0'

data/lib/hashid/rails.rb

@@ -4,6 +4,22 @@ require 'active_record'
 
 module Hashid
   module Rails
+
+    # Get configuration or load defaults
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Set configuration settings with a block
+    def self.configure
+      yield(configuration)
+    end
+
+    # Reset gem configuration to defaults
+    def self.reset
+      @configuration = Configuration.new
+    end
+
     def self.included(base)
       base.extend ClassMethods
     end
@@ -18,8 +34,11 @@ module Hashid
     alias_method :hashid, :to_param
 
     module ClassMethods
+
       def hashids
-        Hashids.new(table_name, 6)
+        secret = Hashid::Rails.configuration.secret
+        length = Hashid::Rails.configuration.length
+        Hashids.new("#{table_name}#{secret}", length)
       end
 
       def encode_id(id)
@@ -31,9 +50,25 @@ module Hashid
       end
 
       def find(hashid)
-        super decode_id(hashid) || hashid
+        model_reload? ? super(hashid) : super( decode_id(hashid) || hashid )
+      end
+
+      private
+
+      def model_reload?
+        caller.any? {|s| s =~ /active_record\/persistence.*reload/}
+      end
+    end
+
+    class Configuration
+      attr_accessor :secret, :length
+
+      def initialize
+        @secret = ''
+        @length = 6
       end
     end
+
   end
 end
 

data/lib/hashid/rails/version.rb

@@ -1,5 +1,5 @@
 module Hashid
   module Rails
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hashid-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-13 00:00:00.000000000 Z
+date: 2016-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +94,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.1