komainu 0.0.6 → 0.0.7

data/README.md

@@ -0,0 +1,30 @@
+komainu
+=======
+
+A very simple text search tool.
+
+
+## Examples
+
+### Simple Search
+
+```ruby
+item1 = OpenStruct.new
+item1.text = "hello"
+item2 = OpenStruct.new
+item2.text = "world"
+searchables = [item1, item2]
+Komainu.search("world", searchables)
+
+#=> {:suggestion=>nil, :items=>["world"]}
+```
+
+### Suggestions
+```ruby
+item = OpenStruct.new
+item.text = "Batman has no parents :("
+searchables = [item]
+Komainu.search("bertman", searchables)
+
+#=> {:suggestion=>"Batman", :items=>[]}
+```

data/README.md.docu

@@ -0,0 +1,32 @@
+komainu
+=======
+
+A very simple text search tool.
+
+
+## Examples
+
+### Simple Search
+
+```ruby
+:example:
+item1 = OpenStruct.new
+item1.text = "hello"
+item2 = OpenStruct.new
+item2.text = "world"
+searchables = [item1, item2]
+Komainu.search("world", searchables)
+
+#=> {:suggestion=>nil, :items=>["world"]}
+:end:
+```
+
+### Suggestions
+```ruby
+item = OpenStruct.new
+item.text = "Batman has no parents :("
+searchables = [item]
+Komainu.search("bertman", searchables)
+
+#=> {:suggestion=>"Batman", :items=>[]}
+```

data/Rakefile

@@ -4,3 +4,39 @@ require 'rake/testtask'
 Rake::TestTask.new(:spec) do |task|
   task.test_files = FileList['spec/**/*_spec.rb']
 end
+
+task :execute_examples do
+  execute_examples("README.md.docu")
+end
+
+def execute_examples(file)
+  require "komainu"
+  puts "Executing Examples..."
+  errors = []
+  contents = File.read(file)
+  contents.scan(/:example:((?:(?!^:end:).)*)/m).flatten.each do |example|
+    if example.include?("#=>")
+      expected = example.scan(/#=>\s*(.*)/).first.first
+      actual = eval(example).inspect
+      if actual == expected
+        print "."
+      else
+        print "F"
+        errors << "Assertion does not match example. Expected \"#{actual}\" to equal \"#{expected}\"."
+      end
+    end
+  end
+  puts
+
+  if errors.any?
+    errors.each do |error|
+      puts error
+    end
+    exit 1
+  else
+    puts "All examples passed!"
+    File.open(file.chomp(File.extname(file)), "w") do |file|
+      file.write contents.gsub(":example:\n", "").gsub(":end:\n", "")
+    end
+  end
+end

data/lib/komainu.rb

@@ -1,6 +1,5 @@
 $: << File.expand_path(File.dirname(__FILE__))
+require "komainu"
+require "komainu/komainu"
 require "komainu/version"
 require "komainu/searches_text"
-
-module Komainu
-end

data/lib/komainu/komainu.rb

@@ -0,0 +1,5 @@
+module Komainu
+  def self.search text, searchables
+    SearchesText.new(searchables).search(text)
+  end
+end

data/lib/komainu/search_results.rb

@@ -5,5 +5,12 @@ module Komainu
     def initialize
       @items = []
     end
+
+    def to_s
+      {
+        :suggestion => suggestion,
+        :items => items.map { |item| item.text }
+      }.to_s
+    end
   end
 end

data/lib/komainu/version.rb

@@ -1,3 +1,3 @@
 module Komainu
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/komainu/komainu_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+require "komainu/komainu"
+module Komainu
+  describe Komainu do
+    it "searches" do
+      item = OpenStruct.new
+      item.text = "hello"
+      Komainu.search("hello", [item]).must_be_kind_of SearchResults
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: komainu
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70113471466500 !ruby/object:Gem::Requirement
+  requirement: &70148385079500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113471466500
+  version_requirements: *70148385079500
 description: ''
 email:
 - andrew.vos@gmail.com
@@ -31,14 +31,18 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
+- README.md.docu
 - Rakefile
 - komainu.gemspec
 - lib/komainu.rb
+- lib/komainu/komainu.rb
 - lib/komainu/levenshtein.rb
 - lib/komainu/search_results.rb
 - lib/komainu/searches_text.rb
 - lib/komainu/trie_node.rb
 - lib/komainu/version.rb
+- spec/komainu/komainu_spec.rb
 - spec/komainu/levenshtein_spec.rb
 - spec/komainu/searches_text_spec.rb
 - spec/komainu/trie_node_spec.rb
@@ -68,6 +72,7 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
+- spec/komainu/komainu_spec.rb
 - spec/komainu/levenshtein_spec.rb
 - spec/komainu/searches_text_spec.rb
 - spec/komainu/trie_node_spec.rb