vss 0.1.8 → 0.1.9

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+branches:
+  only:
+    - master

data/README.md

@@ -1,44 +1,61 @@
-# VSS - Vector Space Search 
+# VSS – Vector Space Search   [![Build Status](http://travis-ci.org/mkdynamic/vss.png?branch=master)](http://travis-ci.org/mkdynamic/vss)
 
-A simple vector space search engine with **tf*idf** ranking. 
+A simple vector space search engine with tf*idf ranking. 
 
 [More info, and details of how it works.](http://madeofcode.com/posts/69-vss-a-vector-space-search-engine-in-ruby)
 
-## Requirements
+## Installation
 
-Ruby >= 1.8.7. Tested in (MRI 1.8.7 + 1.9.2).
+Just install the gem:
 
-## Install
+```bash
+gem install vss
+```
 
-Just install the gem:
+Or add to your Gemfile, if you're using Bundler:
 
-    gem install vss
+```ruby
+gem 'vss'
+```
 
 ## Usage
 
 To perform a search on a collection of documents:
 
-    require "vss"
-    docs = ["hello", "goodbye", "hello and goodbye", "hello, hello!"]
-    engine = VSS::Engine.new(docs)
-    engine.search("hello") #=> ["hello", "hello, hello!", "hello and goodbye", "goodbye"]
+```ruby
+require "vss"
+docs = ["hello", "goodbye", "hello and goodbye", "hello, hello!"]
+engine = VSS::Engine.new(docs)
+engine.search("hello") #=> ["hello", "hello, hello!", "hello and goodbye"]
+```
     
 ## Rails/ActiveRecord
 
 If you want to search a collection of `ActiveRecord` objects, you need to pass a **documentizer** `Proc` when initializing `VSS::Engine` which will convert the objects into documents (which are simply strings). For example:
 
-    class Page < ActiveRecord::Base
-        #attrs: title, content
-    end
+```ruby
+class Page < ActiveRecord::Base
+    #attrs: title, content
+end
+
+docs = Page.all
+documentizer = lambda { |record| record.title + " " + record.content }
+engine = VSS::Engine.new(docs, documentizer)
+```
 
-    docs = Page.all
-    documentizer = proc { |record| record.title + " " + record.content }
-    engine = VSS::Engine.new(docs, documentizer)
-        
 ## Notes
 
 This isn't designed to be used on huge collections of records. The original use case was for ranking a smallish set of `ActiveRecord` results obtained via a query (using **SearchLogic**). So, essentially, the search consisted of 2 stages; getting the *corpus* via a SQL query, then doing the VSS on that.
 
+## Ruby
+
+Tested with the following Ruby versions:
+
+- MRI 1.9.2
+- MRI 1.8.7
+
+Probably works on JRuby ~> 1.6 too, but not actively tested.
+
 ## Credits
 
 Heavily inspired by [Joesph Wilk's article on building a vector space search engine in Python](http://blog.josephwilk.net/projects/building-a-vector-space-search-engine-in-python.html).

data/Rakefile

@@ -1,4 +1,10 @@
-require "rubygems"
-require "bundler/setup"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
-Bundler::GemHelper.install_tasks
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir['test/*test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/vss/version.rb

@@ -1,3 +1,3 @@
 module VSS
-  VERSION = '0.1.8'
+  VERSION = '0.1.9'
 end

data/test/test.rb

@@ -1,3 +1,4 @@
+require 'bundler/setup'
 require 'test/unit'
 require 'vss'
 
@@ -45,4 +46,4 @@ private
     sig_figs = [10, actual.to_s.size, expected.to_s.size].min - 1
     assert_equal expected.to_s[0, sig_figs], actual.to_s[0, sig_figs], msg
   end
-end
+end

data/vss.gemspec

@@ -1,9 +1,9 @@
+# -*- encoding: utf-8 -*-
 require File.expand_path('../lib/vss/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "vss"
   s.version     = VSS::VERSION
-  s.platform    = Gem::Platform::RUBY
   s.authors     = ["Mark Dodwell"]
   s.email       = ["labs@mkdynamic.co.uk"]
   s.homepage    = "https://github.com/mkdynamic/vss"
@@ -12,11 +12,11 @@ Gem::Specification.new do |s|
   
   s.required_ruby_version = ">= 1.8.7"
   s.add_development_dependency "bundler"
-  s.add_development_dependency "rake", "0.8.7"
-  s.add_runtime_dependency "stemmer"
+  s.add_development_dependency "rake"
+  s.add_runtime_dependency "stemmer", "~> 1.0.0"
   
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- test/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 end

metadata

@@ -1,78 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vss
-version: !ruby/object:Gem::Version 
-  hash: 11
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 8
-  version: 0.1.8
+version: !ruby/object:Gem::Version
+  version: 0.1.9
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Mark Dodwell
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-05 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2011-10-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2155044600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id001
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: bundler
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2155044600
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2155043860 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 49
-        segments: 
-        - 0
-        - 8
-        - 7
-        version: 0.8.7
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  name: rake
   prerelease: false
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2155043860
+- !ruby/object:Gem::Dependency
+  name: stemmer
+  requirement: &2155043020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id003
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
-  name: stemmer
   prerelease: false
+  version_requirements: *2155043020
 description: A simple vector space search engine with tf*idf ranking.
-email: 
+email:
 - labs@mkdynamic.co.uk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -83,41 +63,29 @@ files:
 - lib/vss/version.rb
 - test/test.rb
 - vss.gemspec
-has_rdoc: true
 homepage: https://github.com/mkdynamic/vss
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Vector Space Search
-test_files: 
+test_files:
 - test/test.rb