simhash2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd2ed19bec8ea85cee9f79596b1462883eca1df5
+  data.tar.gz: 642f9ce751132870bb0dfe14301fbe3199bd0bcd
+SHA512:
+  metadata.gz: 34d638e74e3dade90dfa25e9d9d56e3b2574b155cd90123c5d359e73c83afa0270613c1325b5b9cf198e5c79b0063b319ce9c6d55df6715e954834d1abd8afb0
+  data.tar.gz: eb0302bc772a0d53ba5ce6099bc3cb40376e0dfc9c987ab95194888e6483afb66f146b518fce240e1c4b69ab05cfeff70893eef37c52fa474dc98e6c5b62868d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'spec/spec_helper.rb'
+
+Metrics/LineLength:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in MetaInspector.gemspec
+gemspec
+
+gem 'coveralls', require: false
+gem 'rake'
+gem 'rspec'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathan Wong
+
+MIT License
+
+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,6 @@
+[![Gem Version](https://badge.fury.io/rb/simhash2.svg)](https://badge.fury.io/rb/simhash2)
+[![Code Climate](https://codeclimate.com/github/armchairtheorist/simhash/badges/gpa.svg)](https://codeclimate.com/github/armchairtheorist/simhash)
+[![Build Status](https://travis-ci.org/armchairtheorist/simhash.svg?branch=master)](https://travis-ci.org/armchairtheorist/simhash)
+[![Coverage Status](https://coveralls.io/repos/github/armchairtheorist/simhash/badge.svg?branch=master)](https://coveralls.io/github/armchairtheorist/simhash?branch=master)
+
+# Simhash

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/lib/simhash/version.rb

@@ -0,0 +1,3 @@
+module Simhash
+  VERSION = '0.0.1'.freeze
+end

data/lib/simhash.rb

@@ -0,0 +1,68 @@
+require 'simhash/version'
+
+module Simhash
+  extend self
+
+  HASHBITS = 64
+
+  OPTIONS = {
+    min_token_length: 1,
+    unique: false,
+    stemming: false,
+    stop_words: []
+
+  }.freeze
+
+  def generate(str, options = {})
+    generate_from_tokens(str.split(/\s+/), options)
+  end
+
+  def generate_from_tokens(tokens, options = {})
+    filter_tokens(tokens, OPTIONS.merge(options))
+
+    v = [0] * HASHBITS
+
+    masks = v.dup
+    masks.each_with_index { |_e, i| masks[i] = (1 << i) }
+
+    hashes = tokens.map { |token| simple_string_hash(token, HASHBITS) }
+    hashes.each do |h|
+      HASHBITS.times do |i|
+        v[i] += (h & masks[i]).zero? ? -1 : +1
+      end
+    end
+
+    simhash = 0
+    HASHBITS.times { |i| simhash += 1 << i if v[i] >= 0 }
+
+    simhash
+  end
+
+  def hamming_distance(simhash1, simhash2)
+    (simhash1.to_i ^ simhash2.to_i).to_s(2).count('1')
+  end
+
+  private
+
+  def simple_string_hash(str, length)
+    return 0 if str == ''
+
+    x = str.bytes.first << 7
+    m = 1_000_003
+    mask = (1 << length) - 1
+    str.each_byte { |char| x = ((x * m) ^ char.to_i) & mask }
+
+    x ^= str.bytes.count
+    x = -2 if x == -1
+
+    x.to_i
+  end
+
+  def filter_tokens(tokens, options)
+    tokens.map! { |e| e.downcase.gsub(/\W+/, '') }
+    tokens.reject! { |e| e.nil? || e.length < options[:min_token_length] }
+    tokens.reject! { |e| options[:stop_words].include?(e) } unless options[:stop_words].nil? || options[:stop_words].empty?
+    tokens.map!(&:stem) if options[:stemming]
+    tokens.uniq! if options[:unique]
+  end
+end

data/simhash2.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/simhash/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simhash2'
+  spec.version       = Simhash::VERSION
+  spec.authors       = ['Jonathan Wong']
+  spec.email         = ['jonathan@armchairtheorist.com']
+  spec.summary       = 'A rewrite of the \'simhash\' gem, which is an implementation of Moses Charikar\'s simhashes in Ruby.'
+  spec.homepage      = 'http://github.com/armchairtheorist/simhash'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.add_development_dependency 'rake', '~> 0'
+end

data/spec/simhash_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'fast-stemmer'
+
+describe Simhash do
+  it 'should generate the same simhash for the same string, and a different simhash for a different string' do
+    str1 = 'I like going to the beach'
+    str2 = 'I like going to the beach'
+    str3 = 'I like going to the mall'
+
+    expect(Simhash.generate(str1)).to eq Simhash.generate(str2)
+    expect(Simhash.generate(str1)).not_to eq Simhash.generate(str3)
+  end
+
+  it 'should strip punctuation and capitalization properly' do
+    str1 = "Hello, nurse!  How's it going today...   my man?"
+    str2 = 'hello nurse hows it going today my man'
+
+    expect(Simhash.generate(str1, unique: true)).to eq Simhash.generate(str2, unique: true)
+  end
+
+  it "should respect the 'unique' option" do
+    str1 = 'apple pear'
+    str2 = 'apple apple apple pear'
+
+    expect(Simhash.generate(str1, unique: true)).to eq Simhash.generate(str2, unique: true)
+    expect(Simhash.generate(str1, unique: false)).not_to eq Simhash.generate(str2, unique: false)
+  end
+
+  it "should respect the 'stop_words' option" do
+    str1 = 'I like the man on the moon.'
+    str2 = 'like man moon'
+    stop_words = %w[i the on]
+
+    expect(Simhash.generate(str1, stop_words: stop_words)).to eq Simhash.generate(str2, stop_words: stop_words)
+    expect(Simhash.generate(str1)).not_to eq Simhash.generate(str2)
+  end
+
+  it "should respect the 'stemming' option" do
+    str1 = 'My crazy cars have crazy minds!'
+    str2 = 'My crazi car have crazi mind!'
+
+    expect(Simhash.generate(str1, stemming: true)).to eq Simhash.generate(str2, stemming: true)
+    expect(Simhash.generate(str1, stemming: false)).not_to eq Simhash.generate(str2, stemming: false)
+  end
+
+  it 'should calculate hamming distances correctly' do
+    expect(Simhash.hamming_distance(2, 2)).to eq 0
+    expect(Simhash.hamming_distance(2, 3)).to eq 1
+    expect(Simhash.hamming_distance(255, 197)).to eq 4
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'simhash'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # These two settings work together to allow you to limit a spec run
+  #   # to individual examples or groups you care about by tagging them with
+  #   # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  #   # get run.
+  #   config.filter_run :focus
+  #   config.run_all_when_everything_filtered = true
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # This setting enables warnings. It's recommended, but in some cases may
+  #   # be too noisy due to issues in dependencies.
+  #   config.warnings = true
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = 'doc'
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: simhash2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-12 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  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'
+description: 
+email:
+- jonathan@armchairtheorist.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simhash.rb
+- lib/simhash/version.rb
+- simhash2.gemspec
+- spec/simhash_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/armchairtheorist/simhash
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A rewrite of the 'simhash' gem, which is an implementation of Moses Charikar's
+  simhashes in Ruby.
+test_files: []