something_like_that 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c96432f5e32fa8dfe2ca27cd0e29bd39ace63be
+  data.tar.gz: 46694911b3e8119b458ed794899a3fc63f5bafd2
+SHA512:
+  metadata.gz: c6cf181ecb47f218bfa5e933e8824b5ae8ec4a8fa4cdb6117430821d2c9cb693985b04b653c7fe0065f7364220d25599b225b6e34274338046c1f863b18de1b0
+  data.tar.gz: 5e7201f4ee5148c7fe4e2ac27816798e8e008849631f331233d2ec2aed2badd30ca8d56d4359bccafaedbbc17310a04e6786fe47ad23f7b8be38f57879c37d73

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rspec'
+  gem 'rubocop', require: false
+end

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright © 2017 Ryan Lue
+
+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,56 @@
+Something Like That
+===================
+
+See how closely two long, multi-word phrases match each other.
+
+Something Like That is asymmetrical, meaning “Azkaban” will match “Harry Potter and the Prisoner of Azkaban” much more strongly than vice versa. Great for ordering search results gathered from diverse sources.
+
+Based on the modified Monge-Elkan method described in [Jimenez et al. (2009)][paper] (pdf), using the [amatch][amatch] library’s implementation of the Jaro-Winkler similarity measure.
+
+Installation
+------------
+
+```bash
+$ gem install something_like_that
+```
+
+Usage
+-----
+
+```ruby
+>> require 'something_like_that'
+=> true
+>> query = SomethingLikeThat.new('Hannibal Lecter')
+=> "Hannibal Lecter"
+>> query.match('Hannibal Lecter Goes to Washington')
+=> 1.0
+>> query.match('Hannibal Buress')
+=> 0.7071067811865476
+>> query.match?('Hannibal Buress')
+=> false
+>> SomethingLikeThat::Scorer.threshold = 0.7
+=> 0.7
+>> query.match?('Hannibal Buress')
+=> true
+```
+
+Config
+------
+
+This gem collects similarity scores for matching pairs of tokens (words) from two different phrases, then averages them together. 
+
+* `SomethingLikeThat::Scorer.threshold` (default = 0.8)  
+  During the first (tokenwise) round of scoring, match scores below this value are dropped to 0. Once the resulting scores are averaged, this value determines whether `#match?` returns `true` or `false`.
+* `SomethingLikeThat::Scorer.mean_exponent` (default = 2)  
+  The method outlined by Jimenez et al. (2009) uses a [generalized mean][gmean] to favor matches over non-matches. For a two-word phrase, one exact match (1.0) and one non-match (0.0) produce an arithmetic mean (_p = 1_) of 0.5 and a quadratic mean (_p = 2_) of ~0.7. (For an in-depth analysis, [see Section 3 of their paper][paper].)
+
+License
+-------
+
+The MIT License (MIT)
+
+Copyright © 2017 Ryan Lue
+
+[paper]: http://www.gelbukh.com/CV/Publications/2009/Generalized%20Mongue-Elkan%20Method%20for%20Approximate%20Text%20String.pdf
+[amatch]: https://github.com/flori/amatch
+[gmean]: https://en.wikipedia.org/wiki/Generalized_mean

data/lib/something_like_that/match_phrase/query.rb

@@ -0,0 +1,20 @@
+module SomethingLikeThat
+  # Holds a string phrase to be compared to other (candidate) MatchPhrases.
+  # Queries may be abbreviated/truncated; candidates should be complete.
+  class Query < MatchPhrase
+    attr_reader :scorer
+
+    def initialize(phrase)
+      super phrase
+      @scorer = Scorer.new(self)
+    end
+
+    def match(candidate)
+      scorer.score(MatchPhrase.new(candidate))
+    end
+
+    def match?(candidate)
+      scorer.match?(MatchPhrase.new(candidate))
+    end
+  end
+end

data/lib/something_like_that/match_phrase.rb

@@ -0,0 +1,10 @@
+module SomethingLikeThat
+  # Holds a string phrase for a Query to be compared to.
+  class MatchPhrase < String
+    # TODO: lump determiners and prepositions in with their subjects?
+    # if so, then must create MatchToken class
+    def tokens
+      downcase.split(/[^\w']/).reject(&:empty?)
+    end
+  end
+end

data/lib/something_like_that/scorer.rb

@@ -0,0 +1,69 @@
+require 'amatch'
+
+module SomethingLikeThat
+  # Computes similarity scores in asymmetrical comparison of string phrases.
+  class Scorer
+    @mean_exponent = 2
+    @threshold = 0.8
+    class << self
+      attr_reader :mean_exponent, :threshold
+
+      def mean_exponent=(p)
+        unless p.is_a?(Integer)
+          raise TypeError, 'mean_exponent must be an integer'
+          # TODO: add explanation in rdoc documentation?
+        end
+        @mean_exponent = p
+      end
+
+      def threshold=(threshold)
+        unless threshold.between?(0, 1)
+          raise RangeError, 'threshold must be between 0 and 1'
+          # TODO: add explanation in rdoc documentation?
+        end
+        @threshold = threshold
+      end
+
+      def generalized_mean(numbers, p = mean_exponent)
+        (numbers.map { |x| x**p }.reduce(:+).to_f / numbers.length)**(1.0 / p)
+      end
+    end
+
+    attr_reader :query_matchers
+
+    def initialize(query, matcher = Amatch::JaroWinkler)
+      @query_matchers = query.tokens.map { |token| matcher.new(token) }
+    end
+
+    def score(candidate)
+      average(top_scores(candidate.tokens))
+    end
+
+    def match?(candidate)
+      score(candidate) > self.class.threshold
+    end
+
+    private
+
+    def top_scores(candidate_tokens, max_finder = TwoDArray)
+      all_scores = tokenwise_score_table(candidate_tokens)
+      max_finder.new(all_scores).maxima
+    end
+
+    def tokenwise_score_table(candidate_tokens)
+      query_matchers.map do |matcher|
+        candidate_tokens.map do |token|
+          apply_threshold(matcher.match(token))
+        end
+      end
+    end
+
+    def apply_threshold(score)
+      score > self.class.threshold ? score : 0
+    end
+
+    def average(scores)
+      self.class.generalized_mean(scores)
+    end
+  end
+end

data/lib/something_like_that/two_d_array.rb

@@ -0,0 +1,44 @@
+require 'ostruct'
+
+module SomethingLikeThat
+  # Holds a 2-dimensional numeric array.
+  # Unstable. We're holding out for a better numeric array library...
+  class TwoDArray < Array
+    def initialize(array)
+      super array
+    end
+
+    # TODO: rename (incl. corresponding method call in Scorer)
+    def maxima
+      max_vals = Array.new(length)
+      double = dup
+      max_vals.map.with_index { |_, i| i < lengths.min ? double.pop_max : 0 }
+    end
+
+    def pop_max
+      max = flatten.max
+      eliminate(coords(max))
+      max
+    end
+
+    def lengths
+      x = length
+      y = map(&:length).max
+      min, max = [x, y].minmax
+      OpenStruct.new(x: x, y: y, min: min, max: max)
+    end
+
+    private
+
+    def eliminate(axes)
+      delete_at(axes.x)
+      each { |row| row.delete_at(axes.y) }
+    end
+
+    def coords(value)
+      x = index { |row| row.include?(value) }
+      y = slice(x).index(value)
+      OpenStruct.new(x: x, y: y)
+    end
+  end
+end

data/lib/something_like_that/version.rb

@@ -0,0 +1,3 @@
+module SomethingLikeThat
+  VERSION = '0.1.2'
+end

data/lib/something_like_that.rb

@@ -0,0 +1,12 @@
+require 'something_like_that/match_phrase'
+require 'something_like_that/match_phrase/query'
+require 'something_like_that/scorer'
+require 'something_like_that/two_d_array'
+
+# This module encapsulates the entire Something Like That gem, and contains a
+# top-level wrapper method to provide a simplified public interface.
+module SomethingLikeThat
+  def self.new(phrase)
+    Query.new(phrase)
+  end
+end

data/something_like_that.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'something_like_that/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'something_like_that'
+  spec.version       = SomethingLikeThat::VERSION
+  spec.author        = 'Ryan Lue'
+  spec.email         = 'ryan.lue@gmail.com'
+
+  spec.summary       = 'Fuzzy string matching for long, multi-word phrases.'
+  spec.description   = 'See how closely two long, multi-word phrases ' \
+                       'match each other. Something Like That is ' \
+                       'asymmetrical, meaning “Azkaban” will match ' \
+                       '“Harry Potter and the Prisoner of Azkaban” much ' \
+                       'more strongly than vice versa. Great for ' \
+                       'ordering search results gathered from diverse ' \
+                       'sources.'
+  spec.homepage      = 'https://github.com/rlue/something_like_that'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(spec/|\.\w)})
+                        end
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
+  spec.add_runtime_dependency 'amatch', '~> 0.3'
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: something_like_that
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Ryan Lue
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: amatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: See how closely two long, multi-word phrases match each other. Something
+  Like That is asymmetrical, meaning “Azkaban” will match “Harry Potter and the Prisoner
+  of Azkaban” much more strongly than vice versa. Great for ordering search results
+  gathered from diverse sources.
+email: ryan.lue@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/something_like_that.rb
+- lib/something_like_that/match_phrase.rb
+- lib/something_like_that/match_phrase/query.rb
+- lib/something_like_that/scorer.rb
+- lib/something_like_that/two_d_array.rb
+- lib/something_like_that/version.rb
+- something_like_that.gemspec
+homepage: https://github.com/rlue/something_like_that
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Fuzzy string matching for long, multi-word phrases.
+test_files: []