acts_as_hashids 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 30d8efbd94952a6f6812f5040e72e7fb86c8ed99
+  data.tar.gz: 2ce7556d45dd3900403240456388e16e9ff9f9f9
+SHA512:
+  metadata.gz: a1bcf96eb0ec873e1832bf1c93faf8147eb5570d066b77b57dbe3b4112e7e5378be952c4d7ae30f22ccba5f6bbf557da2468a629ebb48ae02e42fe1c2dde9047
+  data.tar.gz: fc9ee0ce4799714295d117a237fc6a0fad52211708255f4093cf1e09c8a2198200ee4dcef098b549f9497f86957b1c3e0d5c11c9cf5da00de4b7477dea3a7b0b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.db
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,35 @@
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/**/*'
+    - 'tmp/**/*'
+    - "vendor/**/*"
+Metrics/AbcSize:
+  Max: 40
+Metrics/LineLength:
+  Max: 120
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+Metrics/MethodLength:
+  Max: 20
+Metrics/CyclomaticComplexity:
+  Max: 10
+Metrics/PerceivedComplexity:
+  Max: 10
+Documentation:
+  Enabled: false
+Style/SignalException:
+  EnforcedStyle: only_raise
+Style/IndentHash:
+  EnforcedStyle: consistent
+Style/IndentArray:
+  EnforcedStyle: consistent
+Lint/EndAlignment:
+  AlignWith: variable
+Style/FrozenStringLiteralComment:
+  Enabled: false
+RSpec/AnyInstance:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+sudo: required
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+cache: bundler
+script:
+  - bundle exec rake
+services:
+  - docker
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_hashids.gemspec
+gemspec
+
+gem 'simplecov', '~> 0.11.2', require: false
+gem 'coveralls', '~> 0.8.13', require: false
+gem 'codeclimate-test-reporter', '~> 0.5.0', require: false

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Daisuke Taniwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,121 @@
+# acts_as_hashids
+
+[![Gem Version][gem-image]][gem-link]
+[![Dependency Status][deps-image]][deps-link]
+[![Build Status][build-image]][build-link]
+[![Coverage Status][cov-image]][cov-link]
+[![Code Climate][gpa-image]][gpa-link]
+
+Use [Hashids](https://github.com/peterhellberg/hashids.rb) in ActiveRecord effectively.
+
+## Installation
+
+Add the acts_as_hashids gem to your Gemfile.
+
+```ruby
+gem "acts_as_hashids"
+```
+
+And run `bundle install`.
+
+## Usage
+
+Activate the function in any model of `ActiveRecord::Base`.
+
+```ruby
+class Foo < ActiveRecord::Base
+  acts_as_hashids
+end
+
+foo = Foo.create
+# => #<Foo:0x007feb5978a7c0 id: 3>
+
+foo.to_param
+# => "ePQgabdg"
+
+Foo.find(3)
+# => #<Foo:0x007feb5978a7c0 id: 3>
+
+Foo.find("ePQgabdg")
+# => #<Foo:0x007feb5978a7c0 id: 3>
+
+Foo.find_by_hashids("ePQgabdg")
+# => #<Foo:0x007feb5978a7c0 id: 3>
+
+Foo.with_hashids("ePQgabdg").first
+# => #<Foo:0x007feb5978a7c0 id: 3>
+```
+
+### Use in Rails
+
+Only one thing you need to hash ids is put `acts_as_hashids` in `ApplicationRecord`, then you will see hash ids in routes URL and they are handled correctly as long as you use `find` to find records.
+
+## Options
+
+### length
+
+You can customize the length of hash ids per model. The default length is 8.
+
+```ruby
+class Foo < ActiveRecord::Base
+  acts_as_hashids length: 2
+end
+
+Foo.create.to_param
+# => "Rx"
+```
+
+### secret
+
+You can customize the secret of hash ids per model. The default secret is the class name. The name of base class is used for STI.
+
+```ruby
+class Foo1 < ActiveRecord::Base
+  acts_as_hashids secret: 'my secret'
+end
+
+class Foo2 < ActiveRecord::Base
+  acts_as_hashids secret: 'my secret'
+end
+
+Foo1.create.to_param
+# => "RxQce3a2"
+
+Foo2.create.to_param
+# => "RxQce3a2"
+```
+
+## Test
+
+Execute the command below to run rspec and rubocop.
+
+```
+bundle exec rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Daisuke Taniwaki. See [LICENSE](LICENSE) for details.
+
+
+
+
+[gem-image]:   https://badge.fury.io/rb/acts_as_hashids.svg
+[gem-link]:    http://badge.fury.io/rb/acts_as_hashids
+[build-image]: https://secure.travis-ci.org/dtaniwaki/acts_as_hashids.png
+[build-link]:  http://travis-ci.org/dtaniwaki/acts_as_hashids
+[deps-image]:  https://gemnasium.com/dtaniwaki/acts_as_hashids.svg
+[deps-link]:   https://gemnasium.com/dtaniwaki/acts_as_hashids
+[cov-image]:   https://coveralls.io/repos/dtaniwaki/acts_as_hashids/badge.png
+[cov-link]:    https://coveralls.io/r/dtaniwaki/acts_as_hashids
+[gpa-image]:   https://codeclimate.com/github/dtaniwaki/acts_as_hashids.png
+[gpa-link]:    https://codeclimate.com/github/dtaniwaki/acts_as_hashids
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task(:default).clear
+task default: [:spec, :rubocop]

data/acts_as_hashids.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_hashids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_hashids'
+  spec.version       = ActsAsHashids::VERSION
+  spec.authors       = ['dtaniwaki']
+  spec.email         = ['daisuketaniwaki@gmail.com']
+
+  spec.summary       = 'Hashids in ActiveRecord effectively.'
+  spec.description   = 'Use Hashids in ActiveRecord effectively.'
+  spec.homepage      = 'https://github.com/dtaniwaki/acts_as_hashids'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'hashids', '~> 1.0'
+  spec.add_dependency 'activerecord', '~> 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'rubocop', '= 0.37.2'
+  spec.add_development_dependency 'rubocop-rspec', '= 1.4.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "acts_as_hashids"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/acts_as_hashids.rb

@@ -0,0 +1,12 @@
+module ActsAsHashids
+  class Exception < ::Exception; end
+end
+
+require 'acts_as_hashids/version'
+
+if defined?(Rails::Railtie)
+  require 'acts_as_hashids/railtie'
+elsif defined?(ActiveRecord)
+  require 'acts_as_hashids/methods'
+  ActiveRecord::Base.send(:include, ActsAsHashids::Methods)
+end

data/lib/acts_as_hashids/core.rb

@@ -0,0 +1,64 @@
+require 'hashids'
+
+module ActsAsHashids
+  module Core
+    extend ActiveSupport::Concern
+
+    def to_param
+      id && self.class.hashids.encode(id)
+    end
+
+    module FinderMethods
+      def find(ids = nil, &block)
+        return detect(&block) if block.present? && respond_to?(:detect)
+
+        encoded_ids = Array(ids).map { |id| id.is_a?(String) ? id : hashids.encode(id) }.flatten
+        res = with_hashids(encoded_ids).all
+        if ids.is_a?(Array)
+          raise_record_not_found_exception! encoded_ids, res.size, encoded_ids.size if res.size != encoded_ids.size
+        else
+          raise_record_not_found_exception! encoded_ids[0], res.size, encoded_ids.size if res.empty?
+          res = res[0]
+        end
+        res
+      end
+
+      private
+
+      def raise_record_not_found_exception!(ids, result_size, expected_size)
+        if Array(ids).size == 1
+          error = "Couldn't find #{name} with '#{primary_key}'=#{ids.inspect}"
+        else
+          error = "Couldn't find all #{name.pluralize} with '#{primary_key}': "
+          error << "(#{ids.map(&:inspect).join(', ')}) (found #{result_size} results, but was looking for #{expected_size})"
+        end
+
+        raise ActiveRecord::RecordNotFound, error
+      end
+    end
+
+    module ClassMethods
+      include FinderMethods
+
+      def with_hashids(*ids)
+        ids = ids.flatten
+        decoded_ids = ids.map { |id| hashids.decode(id) }.flatten
+        raise ActsAsHashids::Exception, "Decode error: #{ids.inspect}" if ids.size != decoded_ids.size
+
+        where(id: decoded_ids)
+      end
+
+      def has_many(*args, &block) # rubocop:disable Style/PredicateName
+        options = args.extract_options!
+        options[:extend] = (options[:extend] || []).concat([FinderMethods])
+        super(*args, options, &block)
+      end
+
+      def relation
+        r = super
+        r.extend FinderMethods
+        r
+      end
+    end
+  end
+end

data/lib/acts_as_hashids/methods.rb

@@ -0,0 +1,23 @@
+require_relative 'core'
+
+module ActsAsHashids
+  module Methods
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_hashids(options = {})
+        include ActsAsHashids::Core unless ancestors.include?(ActsAsHashids::Core)
+
+        define_singleton_method :hashids_secret do
+          secret = options[:secret]
+          (secret.respond_to?(:call) ? secret.call : secret) || base_class.name
+        end
+
+        define_singleton_method :hashids do
+          length = options[:length] || 8
+          Hashids.new(hashids_secret, length)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_hashids/railtie.rb

@@ -0,0 +1,11 @@
+require 'acts_as_hashids/methods'
+
+module ActsAsHashids
+  class Railtie < Rails::Railtie
+    initializer 'acts_as_hashids.include_methods' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send(:include, ActsAsHashids::Methods)
+      end
+    end
+  end
+end

data/lib/acts_as_hashids/version.rb

@@ -0,0 +1,3 @@
+module ActsAsHashids
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_hashids
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dtaniwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.37.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: Use Hashids in ActiveRecord effectively.
+email:
+- daisuketaniwaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_hashids.gemspec
+- bin/console
+- bin/setup
+- lib/acts_as_hashids.rb
+- lib/acts_as_hashids/core.rb
+- lib/acts_as_hashids/methods.rb
+- lib/acts_as_hashids/railtie.rb
+- lib/acts_as_hashids/version.rb
+homepage: https://github.com/dtaniwaki/acts_as_hashids
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Hashids in ActiveRecord effectively.
+test_files: []
+has_rdoc: