integer_hash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f1b9fe5811e8e3b473bf259c936f194ce92f5e
+  data.tar.gz: 16239f6487e78623853fbfb25e1d64eb3d13ecb8
+SHA512:
+  metadata.gz: e4cb473dc98b39435842bf5fb8c92ec08ca9066212824ef978af6861006409f0eb1b4c70b15ef8e6d62a8290cc656a5e1c631bf148d4f0d791e9b7f6c1cda932
+  data.tar.gz: 0917e5cad6993ce2de2f4e0031b2e6eb19e6498172b0c333595bdba62690acb68ee9d17a5278db13e615a26e7abd888bc6013737cd6f819a54c851a6f483e2e5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.2.3
+  - 2.1.7
+  - 2.0.0-p647
+  - 1.9.3-p551
+
+script: 'bundle exec rake'
+
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in integer_hash.gemspec
+gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil
+gem "sqlite3", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Florin Popa
+
+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,69 @@
+# IntegerHash
+
+[![Build Status](https://travis-ci.org/icehero/integer_hash.svg?branch=master)](https://travis-ci.org/icehero/integer_hash)
+[![Code Climate](https://codeclimate.com/github/icehero/integer_hash/badges/gpa.svg)](https://codeclimate.com/github/icehero/integer_hash)
+[![Test Coverage](https://codeclimate.com/github/icehero/integer_hash/badges/coverage.svg)](https://codeclimate.com/github/icehero/integer_hash/coverage)
+
+A small Ruby gem that implements Knuth's multiplication hashing algorithm with the following properties: fast, reversable and zero collisions.
+
+This is a port from PHP of the [jenssegers/optimus](https://github.com/jenssegers/optimus) package.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'integer_hash'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install integer_hash
+
+## Configure
+
+Write the defaults taken from `IntegerHash::Generator.generate_configuration` in `config/initializers/integer_hash.rb`:
+
+```ruby
+IntegerHash.configure do |config|
+  config.prime =
+  config.inverse_integer =
+  config.random_integer =
+end
+```
+
+## Usage
+
+```ruby
+$ IntegerHash.encode(42)
+=> 1591777047
+$ IntegerHash.decode(1591777047)
+=> 42
+```
+
+## Alternatives
+
+There are only two alternatives to this gem written in Ruby. ['hashids'](https://github.com/peterhellberg/hashids.rb) gem and ['obfuscate_id'](https://github.com/namick/obfuscate_id) gem which both offer the same main feature: encoding integers so that you don't expose database ids to the user.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/icehero/integer_hash.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/active_record_master.rb

@@ -0,0 +1,50 @@
+begin
+  require 'bundler/inline'
+rescue LoadError => e
+  $stderr.puts 'Bundler version 1.10 or later is required. Please update your Bundler'
+  raise e
+end
+
+gemfile(true) do
+  source 'https://rubygems.org'
+  gem 'rails', github: 'rails/rails'
+  gem 'arel', github: 'rails/arel'
+  gem 'rack', github: 'rack/rack'
+  gem 'sqlite3'
+end
+
+require 'active_record'
+require 'minitest/autorun'
+require 'logger'
+
+# This connection will do for database-independent bug reports.
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(STDOUT)
+
+ActiveRecord::Schema.define do
+  create_table :posts, force: true  do |t|
+  end
+
+  create_table :comments, force: true  do |t|
+    t.integer :post_id
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class BugTest < Minitest::Test
+  def test_association_stuff
+    post = Post.create!
+    post.comments << Comment.create!
+
+    assert_equal 1, post.comments.count
+    assert_equal 1, Comment.count
+    assert_equal post.id, Comment.first.post.id
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "integer_hash"
+
+# 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,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/integer_hash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'integer_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "integer_hash"
+  spec.version       = IntegerHash::VERSION
+  spec.authors       = ["Florin Popa"]
+  spec.email         = ["pp.flrn@gmail.com"]
+
+  spec.summary       = %q{Integer hashing based on Knuth's multiplicative hashing algorithm.}
+  spec.homepage      = "https://github.com/icehero/integer_hash"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_runtime_dependency "rails", "~> 4.2"
+end

data/lib/generators/integer_hash_generator.rb

@@ -0,0 +1,19 @@
+require 'integer_hash/generator'
+
+class IntegerHashGenerator < Rails::Generators::Base
+  def create_new_configuration
+    IntegerHash::Generator.generate_configuration
+  end
+
+  def create_initializer_file
+    configuration = create_new_configuration
+
+    create_file "config/initializers/integer_hash.rb", <<-FILE
+IntegerHash.configure do |config|
+  config.prime = #{configuration.prime}
+  config.inverse_integer = #{configuration.inverse_integer}
+  config.random_integer = #{configuration.random_integer}
+end
+    FILE
+  end
+end

data/lib/integer_hash.rb

@@ -0,0 +1,31 @@
+require "integer_hash/version"
+require "integer_hash/configuration"
+require "integer_hash/rails"
+
+module IntegerHash
+  def self.encode(value)
+    ((value * prime) & max_integer) ^ random_integer
+  end
+
+  def self.decode(value)
+    ((value ^ random_integer) * inverse_integer) & max_integer
+  end
+
+  protected
+
+  def self.prime
+    configuration.prime
+  end
+
+  def self.inverse_integer
+    configuration.inverse_integer
+  end
+
+  def self.random_integer
+    configuration.random_integer
+  end
+
+  def self.max_integer
+    configuration.max_integer
+  end
+end

data/lib/integer_hash/configuration.rb

@@ -0,0 +1,27 @@
+module IntegerHash
+  class Configuration
+    attr_accessor :prime
+    attr_accessor :inverse_integer
+    attr_accessor :random_integer
+    attr_accessor :max_integer
+
+    def initialize values = {}
+      @prime = values[:prime]
+      @inverse_integer = values[:inverse_integer]
+      @random_integer = values[:random_integer]
+      @max_integer = 2**(values[:size] || 31)-1
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/integer_hash/generator.rb

@@ -0,0 +1,34 @@
+module IntegerHash
+  class Generator
+    def self.generate_configuration(size = 31, prime = nil)
+      return Configuration.new(Generator.new(size: size, prime: prime).generate_configuration)
+    end
+
+    def initialize(values = {})
+      @size = values[:size]
+      @prime = values[:prime]
+      #TODO BN requires it to be > 16 or the bites are too small
+      raise ArgumentError if @size < 16
+    end
+
+    def generate_configuration
+      @prime ||= generate_prime
+      inverse_integer = generate_inverse
+      random_integer = generate_random
+
+      {prime: @prime.to_i, inverse_integer: inverse_integer.to_i, random_integer: random_integer.to_i}
+    end
+
+    def generate_prime
+      OpenSSL::BN.generate_prime(@size)
+    end
+
+    def generate_inverse
+      OpenSSL::BN.new(@prime.to_s).mod_inverse(2**@size)
+    end
+
+    def generate_random
+      OpenSSL::BN.rand(@size)
+    end
+  end
+end

data/lib/integer_hash/rails.rb

@@ -0,0 +1,62 @@
+require 'integer_hash'
+require 'active_record'
+
+module IntegerHash
+  module Rails
+    def encode_id
+      require 'integer_hash'
+      extend ClassMethods
+      include InstanceMethods
+
+      cattr_accessor :integer_hash_configuration
+
+    end
+
+    module ClassMethods
+      def find(*args)
+        scope = args.slice!(0)
+        options = args.slice!(0) || {}
+        if has_encoded_id? && !options[:no_hashed_id]
+          if scope.is_a?(Array)
+            scope.map! {|a| IntegerHash.decode(a.to_i).to_s}
+          else
+            scope = IntegerHash.decode(scope.to_i).to_s
+          end
+        end
+        super(scope)
+      end
+
+      def has_encoded_id?
+        true
+      end
+    end
+
+    module InstanceMethods
+      def to_param
+        IntegerHash.encode(self.id).to_s
+      end
+
+      # Override ActiveRecord::Persistence#reload
+      # passing in an options flag with { no_hashed_id: true }
+      def reload(options = nil)
+        options = (options || {}).merge(no_hashed_id: true)
+
+        clear_aggregation_cache
+        clear_association_cache
+
+        fresh_object =
+          if options && options[:lock]
+            self.class.unscoped { self.class.lock(options[:lock]).find(id, options) }
+          else
+            self.class.unscoped { self.class.find(id, options) }
+          end
+
+        @attributes = fresh_object.instance_variable_get('@attributes')
+        @new_record = false
+        self
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend IntegerHash::Rails

data/lib/integer_hash/version.rb

@@ -0,0 +1,3 @@
+module IntegerHash
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: integer_hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Florin Popa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 
+email:
+- pp.flrn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_master.rb
+- bin/console
+- bin/setup
+- integer_hash.gemspec
+- lib/generators/integer_hash_generator.rb
+- lib/integer_hash.rb
+- lib/integer_hash/configuration.rb
+- lib/integer_hash/generator.rb
+- lib/integer_hash/rails.rb
+- lib/integer_hash/version.rb
+homepage: https://github.com/icehero/integer_hash
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Integer hashing based on Knuth's multiplicative hashing algorithm.
+test_files: []