komainu 0.0.8 → 0.0.9

data/README.md

@@ -14,13 +14,18 @@ require "komainu"
 require "ostruct"
 
 item1 = OpenStruct.new
-item1.text = "hello"
+item1.text = "You are a smelly pirate hooker."
+
 item2 = OpenStruct.new
-item2.text = "world"
+item2.text = "You look like a blueberry."
+
+item3 = OpenStruct.new
+item3.text = "Why don't you go back to your home on Whore Island?"
+
 searchables = [item1, item2]
-Komainu.search("world", searchables)
+Komainu.search("blue", searchables)
 
-#=> {:suggestion=>nil, :items=>["world"]}
+#=> {:suggestion=>nil, :items=>["You look like a blueberry."]}
 ```
 
 ### Suggestions

data/README.md.docu

@@ -15,13 +15,18 @@ require "komainu"
 require "ostruct"
 
 item1 = OpenStruct.new
-item1.text = "hello"
+item1.text = "You are a smelly pirate hooker."
+
 item2 = OpenStruct.new
-item2.text = "world"
+item2.text = "You look like a blueberry."
+
+item3 = OpenStruct.new
+item3.text = "Why don't you go back to your home on Whore Island?"
+
 searchables = [item1, item2]
-Komainu.search("world", searchables)
+Komainu.search("blue", searchables)
 
-#=> {:suggestion=>nil, :items=>["world"]}
+#=> {:suggestion=>nil, :items=>["You look like a blueberry."]}
 :end:
 ```
 

data/komainu.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = Komainu::VERSION
   s.authors     = ["Andrew Vos"]
   s.email       = ["andrew.vos@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{}
-  s.description = %q{}
+  s.homepage    = "https://github.com/AndrewVos/komainu"
+  s.summary     = %q{Simple text search}
+  s.description = %q{Simple text search using a mixture of basic string search and Levenshtein Distance}
 
   s.rubyforge_project = "komainu"
 

data/lib/komainu/{levenshtein.rb → calculates_levenshtein_distance.rb}

@@ -1,7 +1,7 @@
 require "komainu/trie_node"
 
 module Komainu
-  class Levenshtein
+  class CalculatesLevenshteinDistance
     def initialize(words)
       @trie = TrieNode.new
       words.each do |word|

data/lib/komainu/match.rb

@@ -0,0 +1,9 @@
+module Komainu
+  class Match
+    attr_reader :index, :text
+    def initialize index, text
+      @index = index
+      @text = text
+    end
+  end
+end

data/lib/komainu/searches_text.rb

@@ -1,7 +1,16 @@
-require "komainu/levenshtein"
+require "komainu/calculates_levenshtein_distance"
 require "komainu/search_results"
+require "komainu/match"
 
 module Komainu
+  class SearchResult
+    attr_reader :object, :matches
+    def initialize object, matches
+      @object = object
+      @matches = matches
+    end
+  end
+
   class SearchesText
     def initialize data_to_search
       @data_to_search = data_to_search
@@ -10,10 +19,9 @@ module Komainu
     def search query
       results = SearchResults.new
       @data_to_search.each do |searchable|
-        if text_includes_string(searchable.text, query)
-          results.items << searchable
-        elsif text_includes_words_from_string(searchable.text, query)
-          results.items << searchable
+        matches = find_matches(searchable.text, query)
+        if matches.any?
+          results.items << SearchResult.new(searchable, matches)
         end
       end
 
@@ -25,7 +33,7 @@ module Komainu
 
     def calculate_suggestion(query)
       words = split_into_words(@data_to_search.map { |searchable| searchable.text }.join(" "))
-      levenshtein = Levenshtein.new(words)
+      levenshtein = CalculatesLevenshteinDistance.new(words)
 
       suggestion = split_into_words(query).map do |word|
         matches = levenshtein.search(word, 2)
@@ -49,14 +57,18 @@ module Komainu
       string.scan(/\b\w+\b/)
     end
 
-    def text_includes_string text, string
-      text.downcase.include? string.downcase
-    end
-
-    def text_includes_words_from_string text, string
-      string.split(" ").any? do |word|
-        text_includes_string(text, word)
-      end
+    def find_matches text, string
+      text = text.downcase
+      matches = []
+      string.split(" ").each { |word|
+        word = word.downcase
+        offset = 0
+        while matched_index = text.index(word, offset)
+          matches << Match.new(matched_index, word)
+          offset += word.length
+        end
+      }
+      matches
     end
   end
 end

data/lib/komainu/version.rb

@@ -1,3 +1,3 @@
 module Komainu
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/komainu/{levenshtein_spec.rb → calculates_levenshtein_distance_spec.rb}

@@ -1,10 +1,10 @@
 require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-require "komainu/levenshtein"
+require "komainu/calculates_levenshtein_distance"
 
 module Komainu
-  describe Levenshtein do
+  describe CalculatesLevenshteinDistance do
     it "finds words with a distance less the maximum distance" do
-      levenshtein = Levenshtein.new(["hello", "there", "good", "sirs"])
+      levenshtein = CalculatesLevenshteinDistance.new(["hello", "there", "good", "sirs"])
       levenshtein.search("hell", 14).must_equal({
         "hello" => 1,
         "there" => 3,

data/spec/komainu/searches_text_spec.rb

@@ -6,31 +6,27 @@ module Komainu
     subject { SearchesText.new(data_to_search) }
 
     let :data_to_search do
-      item1 = OpenStruct.new
-      item1.name = :item1
-      item1.text = "This is some text."
-      item2 = OpenStruct.new
-      item2.name = :item2
-      item2.text = "Batman has no parents"
-      [item1, item2]
+      @item1 = OpenStruct.new({:text => "This is some text."})
+      @item2 = OpenStruct.new({:text => "Batman has no parents"})
+      [@item1, @item2]
     end
 
     it "finds exact matches" do
       result = subject.search("Batman has")
       result.items.size.must_equal 1
-      result.items.first.name.must_equal :item2
+      result.items.first.object.must_equal @item2
     end
 
     it "finds matches in any case" do
       result = subject.search("BATMAN has")
       result.items.size.must_equal 1
-      result.items.first.name.must_equal :item2
+      result.items.first.object.must_equal @item2
     end
 
     it "finds matches if the text is not in order" do
       result = subject.search("has batman")
       result.items.size.must_equal 1
-      result.items.first.name.must_equal :item2
+      result.items.first.object.must_equal @item2
     end
 
     it "suggests an alternate query" do
@@ -49,5 +45,18 @@ module Komainu
       result = SearchesText.new([item]).search("hell")
       result.suggestion.must_equal "hellp"
     end
+
+    it "knows where the matches were" do
+      item = OpenStruct.new
+      item.text = "Derp herp"
+
+      result = SearchesText.new([item]).search("derp herp")
+
+      result.items.first.matches[0].text.must_equal "derp"
+      result.items.first.matches[0].index.must_equal 0
+
+      result.items.first.matches[2].text.must_equal "herp"
+      result.items.first.matches[2].index.must_equal 5
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: komainu
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000Z
+date: 2011-12-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70133062670220 !ruby/object:Gem::Requirement
+  requirement: &70258233968580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133062670220
+  version_requirements: *70258233968580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70133062669200 !ruby/object:Gem::Requirement
+  requirement: &70258233967340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133062669200
+  version_requirements: *70258233967340
 - !ruby/object:Gem::Dependency
   name: docu
-  requirement: &70133062668160 !ruby/object:Gem::Requirement
+  requirement: &70258233966460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,8 +43,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133062668160
-description: ''
+  version_requirements: *70258233966460
+description: Simple text search using a mixture of basic string search and Levenshtein
+  Distance
 email:
 - andrew.vos@gmail.com
 executables: []
@@ -60,18 +61,19 @@ files:
 - Rakefile
 - komainu.gemspec
 - lib/komainu.rb
+- lib/komainu/calculates_levenshtein_distance.rb
 - lib/komainu/komainu.rb
-- lib/komainu/levenshtein.rb
+- lib/komainu/match.rb
 - lib/komainu/search_results.rb
 - lib/komainu/searches_text.rb
 - lib/komainu/trie_node.rb
 - lib/komainu/version.rb
+- spec/komainu/calculates_levenshtein_distance_spec.rb
 - spec/komainu/komainu_spec.rb
-- spec/komainu/levenshtein_spec.rb
 - spec/komainu/searches_text_spec.rb
 - spec/komainu/trie_node_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/AndrewVos/komainu
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -94,10 +96,10 @@ rubyforge_project: komainu
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: ''
+summary: Simple text search
 test_files:
+- spec/komainu/calculates_levenshtein_distance_spec.rb
 - spec/komainu/komainu_spec.rb
-- spec/komainu/levenshtein_spec.rb
 - spec/komainu/searches_text_spec.rb
 - spec/komainu/trie_node_spec.rb
 - spec/spec_helper.rb