suggester 0.1.0

data/test/fixtures/books.sql

@@ -0,0 +1,15 @@
+DROP TABLE IF EXISTS `books`;
+
+CREATE TABLE `books` (
+  `id` INT UNSIGNED AUTO_INCREMENT NOT NULL,
+  `title` VARCHAR(64),
+  `author` VARCHAR(125),
+  PRIMARY KEY (`id`)
+);
+
+INSERT INTO `books` SET `id` = 1, `title` = 'A Tale of Two Cities', `author` = 'Charles Dickens';
+INSERT INTO `books` SET `id` = 2, `title` = 'Anna Karenina', `author` = 'Leo Tolstoy';
+INSERT INTO `books` SET `id` = 3, `title` = 'Great Expectations', `author` = 'Charles Dickens';
+INSERT INTO `books` SET `id` = 4, `title` = 'The Origin of Species', `author` = 'Charles Darwin';
+INSERT INTO `books` SET `id` = 5, `title` = 'The Catcher in the Rye', `author` = 'J.D. Salinger';
+INSERT INTO `books` SET `id` = 6, `title` = 'The Lord of the Rings', `author` = 'J.R.R. Tolkien';

data/test/fixtures/yaml.yml

@@ -0,0 +1,25 @@
+---
+- :data:
+    :id: 500
+    :display_string: "A"
+  :search_term: "a"
+- :data:
+    :id: 600
+    :display_string: "B"
+  :search_term: "b"
+- :data:
+    :id: 700
+    :display_string: "D"
+  :search_term: "d"
+- :data:
+    :id: 800
+    :display_string: "C"
+  :search_term: "c"
+- :data:
+    :id: 900
+    :display_string: "Aardvark"
+  :search_term: "aardvark"
+- :data:
+    :id: 1000
+    :display_string: "Aachen"
+  :search_term: "aachen"

data/test/functional/basic_test.rb

@@ -0,0 +1,98 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../test_helper.rb"))
+require 'rack/test'
+
+Suggester::Server.add_handler("yaml_handler", Suggester::Handlers::Yaml.new(:file => File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'yaml.yml'))))
+Suggester::Server.add_handler("marshal_handler", Suggester::Handlers::Marshal.new(:file => File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'marshal.marshal'))))
+
+class BasicTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Suggester::Server
+  end
+
+  should "list all handlers on index page" do
+    get '/'
+    assert last_response.ok?
+    assert last_response.body.include?('yaml_handler')
+    assert last_response.body.include?('marshal_handler')
+  end
+
+  should "dump data in yaml format" do
+    get '/yaml_handler/dump.yml'
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = YAML::load(last_response.body)
+      assert_equal(6, data.length)
+    end
+  end
+
+  should "dump data in json format" do
+    get '/yaml_handler/dump.json'
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = JSON::load(last_response.body)
+      assert_equal(6, data.length)
+    end
+  end
+
+  should "dump data in marshal format" do
+    get '/yaml_handler/dump.marshal'
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = Marshal.load(last_response.body)
+      assert_equal(6, data.length)
+    end
+  end
+
+  should "find begins with matches in yaml format" do
+    get '/yaml_handler/find/a.yml'
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = YAML::load(last_response.body)
+      assert_equal(3, data.length)
+    end
+  end
+
+  should "find begins with matches in json format" do
+    get '/yaml_handler/find/a.json'
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = JSON::load(last_response.body)
+      assert_equal(3, data.length)
+    end
+  end
+
+  should "find with limit" do
+    get '/yaml_handler/find/a.yml', :limit => 2
+    assert last_response.ok?
+    assert_nothing_raised do
+      data = YAML::load(last_response.body)
+      assert_equal(2, data.length)
+    end
+  end
+
+  should "refresh" do
+    # handler shouldn't need a refresh
+    assert !Suggester::Server.handler("yaml_handler").needs_refresh?
+
+    # force the server to refresh when it gets a chance
+    get '/yaml_handler/refresh'
+    assert last_response.ok?
+    assert_equal("OK", last_response.body)
+
+    # should need a refresh
+    assert Suggester::Server.handler("yaml_handler").needs_refresh?
+
+    # restore state
+    Suggester::Server.handler("yaml_handler").refresh!
+    assert !Suggester::Server.handler("yaml_handler").needs_refresh?
+  end
+
+  should "fail to refresh non-existent handler" do
+    get '/non_existent/refresh'
+    assert last_response.ok?
+    assert_equal("FAIL", last_response.body)
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+ENV["RAILS_ENV"] = "test"
+
+# add to the load path (done by loading gems for you, just not in test)
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+# require the suggester files
+require 'suggester'
+require 'suggester/server'
+require 'bundler'
+Bundler.setup
+require 'active_support'
+require 'active_support/test_case'
+require 'shoulda'
+require 'mocha'
+
+# run the mysql tests if you have set up your mysql.yml
+config_file = File.join(File.dirname(__FILE__), '..', 'config', 'database.yml')
+RUN_AR_TESTS = File.exists?(config_file)
+if RUN_AR_TESTS
+  require 'activerecord'
+  require 'mysql'
+  database_config = YAML::load_file(config_file)["test"]
+  ActiveRecord::Base.establish_connection(database_config)
+else
+  raise "set up your config/database.yml"
+end

data/test/unit/active_record_handler_test.rb

@@ -0,0 +1,74 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../test_helper.rb"))
+
+class ActiveRecordHandlerTest < ActiveSupport::TestCase
+  if RUN_AR_TESTS
+    class Book < ActiveRecord::Base
+    end
+
+    should "raise exception if no class given" do
+      assert_raises RuntimeError do
+        handler = Suggester::Handlers::ActiveRecord.new()
+      end
+    end
+
+    should "load basic active_record handler" do
+      assert_nothing_raised do
+        handler = Suggester::Handlers::ActiveRecord.new( :class => Book, 
+                                                            :id_field => :id, 
+                                                            :name_field => :title)
+        assert_equal(6, handler.cache.length)
+      end
+    end
+
+    should "load a sorted cache" do
+      handler = Suggester::Handlers::ActiveRecord.new( :class => Book, 
+                                                          :id_field => :id, 
+                                                          :name_field => :title)
+      search_strings = handler.cache.map{|entry| entry[:search_term]}
+      sorted_search_strings = search_strings.sort
+      assert_equal(sorted_search_strings, search_strings)
+    end
+
+    should "find begins with matches" do
+      handler = Suggester::Handlers::ActiveRecord.new( :class => Book, 
+                                                          :id_field => :id, 
+                                                          :name_field => :title)
+      matches = handler.find(:query => "the")
+      assert_equal(3, matches.length)
+
+      matches = handler.find(:query => "a ")
+      assert_equal(1, matches.length)
+    end
+
+    should "find exact matches" do
+      handler = Suggester::Handlers::ActiveRecord.new( :class => Book, 
+                                                          :id_field => :id, 
+                                                          :name_field => :title)
+      matches = handler.match(:query => "the")
+      assert_equal(0, matches.length)
+
+      matches = handler.match(:query => "the catcher in the rye")
+      assert_equal(1, matches.length)
+    end
+
+    should "normalize search string" do
+      handler = Suggester::Handlers::ActiveRecord.new( :class => Book, 
+                                                          :id_field => :id, 
+                                                          :name_field => :title)
+      matches = handler.find(:query => "THE")
+      assert_equal(3, matches.length)
+
+      matches = handler.match(:query => "THE cAtChEr In ThE rYe")
+      assert_equal(1, matches.length)
+    end
+
+  end
+
+
+protected
+
+  def yaml_file
+    File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'yaml.yml'))
+  end
+
+end

data/test/unit/marshal_handler_test.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../test_helper.rb"))
+
+class MarshalHandlerTest < ActiveSupport::TestCase
+
+  should "raise exception if no file given" do
+    assert_raises RuntimeError do
+      handler = Suggester::Handlers::Marshal.new
+    end
+  end
+
+  should "load basic marshal file" do
+    assert_nothing_raised do
+      handler = Suggester::Handlers::Marshal.new(:file => marshal_file)
+      assert_equal(6, handler.cache.length)
+    end
+  end
+
+  should "load a sorted cache" do
+    handler = Suggester::Handlers::Marshal.new(:file => marshal_file)
+    search_strings = handler.cache.map{|entry| entry[:search_term]}
+    sorted_search_strings = search_strings.sort
+    assert_equal(sorted_search_strings, search_strings)
+  end
+
+  should "load marshal from uri" do
+    # stub the open uri
+    OpenURI.stubs(:open_uri).returns(File.open(marshal_file))
+    url = "http://suggester.server.com/handler/dump.marshal"
+    assert_nothing_raised do
+      handler = Suggester::Handlers::Marshal.new(:file => url)
+      assert_equal(6, handler.cache.length)
+    end
+  end
+
+  should "find begins with matches" do
+    handler = Suggester::Handlers::Marshal.new(:file => marshal_file)
+    matches = handler.find(:query => "a")
+    assert_equal(3, matches.length)
+
+    matches = handler.find(:query => "aa")
+    assert_equal(2, matches.length)
+  end
+
+  should "find exact matches" do
+    handler = Suggester::Handlers::Marshal.new(:file => marshal_file)
+    matches = handler.match(:query => "aar")
+    assert_equal(0, matches.length)
+
+    matches = handler.match(:query => "aardvark")
+    assert_equal(1, matches.length)
+  end
+
+  should "normalize search string" do
+    handler = Suggester::Handlers::Marshal.new(:file => marshal_file)
+    matches = handler.match(:query => "AARDVARK")
+    assert_equal(1, matches.length)
+  end
+
+protected
+
+  def marshal_file
+    File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'marshal.marshal'))
+  end
+
+end

data/test/unit/yaml_handler_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "../test_helper.rb"))
+
+class YamlHandlerTest < ActiveSupport::TestCase
+
+  should "raise exception if no file given" do
+    assert_raises RuntimeError do
+      handler = Suggester::Handlers::Yaml.new
+    end
+  end
+
+  should "load basic yaml file" do
+    assert_nothing_raised do
+      handler = Suggester::Handlers::Yaml.new(:file => yaml_file)
+      assert_equal(6, handler.cache.length)
+    end
+  end
+
+  should "load a sorted cache" do
+    handler = Suggester::Handlers::Yaml.new(:file => yaml_file)
+    search_strings = handler.cache.map{|entry| entry[:search_term]}
+    sorted_search_strings = search_strings.sort
+    assert_equal(sorted_search_strings, search_strings)
+  end
+
+  should "load yaml from uri" do
+    # stub the open uri
+    OpenURI.stubs(:open_uri).returns(File.open(yaml_file))
+    url = "http://suggester.server.com/handler/dump.yml"
+    assert_nothing_raised do
+      handler = Suggester::Handlers::Yaml.new(:file => url)
+      assert_equal(6, handler.cache.length)
+    end
+  end
+
+  should "find begins with matches" do
+    handler = Suggester::Handlers::Yaml.new(:file => yaml_file)
+    matches = handler.find(:query => "a")
+    assert_equal(3, matches.length)
+
+    matches = handler.find(:query => "aa")
+    assert_equal(2, matches.length)
+  end
+
+  should "find exact matches" do
+    handler = Suggester::Handlers::Yaml.new(:file => yaml_file)
+    matches = handler.match(:query => "aar")
+    assert_equal(0, matches.length)
+
+    matches = handler.match(:query => "aardvark")
+    assert_equal(1, matches.length)
+  end
+
+  should "normalize search string" do
+    handler = Suggester::Handlers::Yaml.new(:file => yaml_file)
+    matches = handler.match(:query => "AARDVARK")
+    assert_equal(1, matches.length)
+  end
+
+
+protected
+
+  def yaml_file
+    File.expand_path(File.join(File.dirname(__FILE__), '..', 'fixtures', 'yaml.yml'))
+  end
+
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: suggester
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Ching
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-09 00:00:00 -08:00
+default_executable: suggester_server
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: vegas
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: Extensible, cache-based auto-suggest server for ruby. Includes refresh and replication support out of the box.
+email: ching.jeff@gmail.com
+executables: 
+- suggester_server
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- bin/suggester_server
+- config/database.yml.example
+- lib/array_bsearch.rb
+- lib/suggester.rb
+- lib/suggester/client.rb
+- lib/suggester/handlers.rb
+- lib/suggester/handlers/active_record.rb
+- lib/suggester/handlers/base.rb
+- lib/suggester/handlers/helpers/normalization.rb
+- lib/suggester/handlers/helpers/refresh.rb
+- lib/suggester/handlers/marshal.rb
+- lib/suggester/handlers/yaml.rb
+- lib/suggester/server.rb
+- pkg/suggester-0.0.1.gem
+- pkg/suggester-0.0.2.gem
+- suggester.gemspec
+- test/fixtures/books.sql
+- test/fixtures/marshal.marshal
+- test/fixtures/yaml.yml
+- test/functional/basic_test.rb
+- test/test_helper.rb
+- test/unit/active_record_handler_test.rb
+- test/unit/marshal_handler_test.rb
+- test/unit/yaml_handler_test.rb
+has_rdoc: true
+homepage: http://github.com/chingor13/suggester
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 595145928742037670
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Extensible, cache-based auto-suggest server for ruby.
+test_files: 
+- test/functional/basic_test.rb
+- test/test_helper.rb
+- test/unit/active_record_handler_test.rb
+- test/unit/marshal_handler_test.rb
+- test/unit/yaml_handler_test.rb