string-similarity 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0e99a22e06043cfc985e7cda581c9d5b2747ada
+  data.tar.gz: dfc533af4d4b9fc4d138d0505193b51cc934098f
+SHA512:
+  metadata.gz: 84343e34af35640b92bb708fa3d87d96b35aa1d56892dd33ce1f8843edf0439a349a106b924f500b659d7a87d530116a70d9fbef87165502d83fda58a30c9807
+  data.tar.gz: a458bf9bec226ec89549c7ae7041ee1476e8ba2c2ecac92bc71a89e14f16d7350ee5e00bce3fa206d541613ca620ed373356e6fa399ba34ec60bbe45a8f393e6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0-p647
+  - 2.1.7
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/(.*)\/?(.*)_spec\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$})      { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Manuel Hutter
+
+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,71 @@
+# String::Similarity
+
+[![Gem Version](https://badge.fury.io/rb/string-similarity.svg)](http://badge.fury.io/rb/string-similarity)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/string-similarity/frames)
+[![Build Status](https://travis-ci.org/mhutter/string-similarity.svg)](https://travis-ci.org/mhutter/string-similarity)
+[![Code Climate](https://codeclimate.com/github/mhutter/string-similarity/badges/gpa.svg)](https://codeclimate.com/github/mhutter/string-similarity)
+[![Test Coverage](https://codeclimate.com/github/mhutter/string-similarity/badges/coverage.svg)](https://codeclimate.com/github/mhutter/string-similarity/coverage)
+
+Library for calculating the similarity of two strings.
+
+## State
+
+- Cosine: **done**
+- Hamming: _todo_
+- Levenshtein: _todo_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string-similarity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string-similarity
+
+## Usage
+
+```ruby
+require 'string-similarity'
+
+# Call the methods on the module
+String::Similarity.cosine 'foo', 'bar'
+# => 0.0
+String::Similarity.cosine 'mine', 'thyne'
+# => 0.4472135954999579
+String::Similarity.cosine 'foo', 'foo'
+# => 1.0
+
+# or call on a string directly
+'string'.cosine_similarity_to 'strong'
+# => 0.8333333333333335
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`.
+
+## Contributing
+
+1. Fork it ( https://github.com/mhutter/string-similarity/fork )
+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 a new Pull Request
+
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mhutter/string-similarity.
+
+
+## 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,4 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'string/similarity'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/string/similarity.rb

@@ -0,0 +1,67 @@
+require 'string/similarity/version'
+
+class String
+
+  def cosine_similarity_to(other)
+    String::Similarity.cosine(self, other)
+  end
+
+  # +String::Similarity+ provides various methods for
+  # calculating string distances.
+  module Similarity extend self
+
+
+    # Calcuate the
+    # {https://en.wikipedia.org/wiki/Cosine_similarity Cosine similarity}
+    # of two strings.
+    #
+    # @param str1 [String] first string
+    # @param str2 [String] second string
+    # @return [Float] cosine distance of the two arguments.
+    #   - +1.0+ if the strings are identical
+    #   - +0.0+ if the strings are completely different
+    #   - +0.0+ if one of the strings is empty
+    def cosine(str1, str2)
+      return 1.0 if str1 == str2
+      return 0.0 if str1.empty? || str2.empty?
+
+      # convert both texts to vectors
+      v1, v2 = vector(str1), vector(str2)
+
+      # calculate the dot product
+      dot_product = dot(v1, v2)
+
+      # calculate the magnitude
+      magnitude = mag(v1.values) * mag(v2.values)
+      dot_product / magnitude
+    end
+
+    private
+
+    # create a vector from +str+
+    #
+    # @example
+    #     vector('hello') # => {"h"=>1, "e"=>1, "l"=>2, "o"=>1}
+    def vector(str)
+      v = Hash.new(0)
+      str.each_char { |c| v[c] += 1 }
+      v
+    end
+
+    # calculate the dot product of +vector1+ and +vector2+
+    def dot(vector1, vector2)
+      product = 0
+      vector1.each do |k,v|
+        product += v * vector2[k]
+      end
+      product
+    end
+
+    # calculate the magnitude for +vector+
+    def mag(vector)
+      # calculate the sum of squares
+      sq = vector.inject(0) { |s,n| s + n**2 }
+      Math.sqrt(sq)
+    end
+  end
+end

data/lib/string/similarity/version.rb

@@ -0,0 +1,5 @@
+class String
+  module Similarity
+    VERSION = '1.0.1'
+  end
+end

data/string-similarity.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'string/similarity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'string-similarity'
+  spec.version       = String::Similarity::VERSION
+  spec.authors       = ['Manuel Hutter']
+  spec.email         = ['manuel@hutter.io']
+
+  spec.summary       = %q{Various methods for calculating string similarities.}
+  spec.description   = <<-EOT
+This gem provides some methods for calculating similarities of two strings.
+
+Currently implemented:
+- Cosine similarity
+
+Planned:
+- Hamming similarity
+- Levenshtein similarity
+  EOT
+  spec.homepage      = 'https://github.com/mhutter/string-similarity'
+  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'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: string-similarity
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Manuel Hutter
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-04 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'
+description: |
+  This gem provides some methods for calculating similarities of two strings.
+
+  Currently implemented:
+  - Cosine similarity
+
+  Planned:
+  - Hamming similarity
+  - Levenshtein similarity
+email:
+- manuel@hutter.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string/similarity.rb
+- lib/string/similarity/version.rb
+- string-similarity.gemspec
+homepage: https://github.com/mhutter/string-similarity
+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: Various methods for calculating string similarities.
+test_files: []
+has_rdoc: