spinel 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc0aae3285cb2efbb58eea915cde7314614c945
-  data.tar.gz: fa7fb254ea04ddf0c93ff28f6a5fc10f637d40f3
+  metadata.gz: 15242d0a0aa570e1cdb2833f088015b8a123f728
+  data.tar.gz: 065227c4062d41de4e360ce359ad6d18a2119b41
 SHA512:
-  metadata.gz: 744409a98574cbf84ea2e22e7442296c7322a1ced06047a4b6346df7a9b1d8db95fa340553beb501ee3812b83f53de28935278daa0e7f112a58d377cc9f9ee83
-  data.tar.gz: db068029c776eb8d28e5dcc1d45fe58e09ca1fe95f9c99a26bc6063cbb58eba5d96f2524451a898b19f2b3559471b1ff4cce18b785e5061f1d633010c11ffbda
+  metadata.gz: 0cedf931a094181409bf4bda8fd05267b3da5aefa860f3d3c78fda7ba61575cebaacc871bab8cc8247991a00e85884887374eff45b2bdfbe2fbe805239573c98
+  data.tar.gz: a7e79c12d900d2f6030c6d95366aea711b1dea944d8d5649ecc583e76443e174e2de1d5e853ba5e3f1fb5a0270ab3aa7da39ed3c26c9fa5cadea12d2d03b4fc5

data/.gitignore

@@ -13,5 +13,5 @@
 *.o
 *.a
 mkmf.log
-
 .DS_Store
+.env

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.0
+
+* オプション名称を変更
+
 # 0.2.0
 
 * 空白文字列の取り扱いをPOSIX文字クラスで指定

data/README.md

@@ -1,5 +1,9 @@
 # Spinel
 
+[![Gem Version](https://badge.fury.io/rb/spinel.svg)](http://badge.fury.io/rb/spinel)
+[![Code Climate](https://codeclimate.com/github/k-shogo/spinel/badges/gpa.svg)](https://codeclimate.com/github/k-shogo/spinel)
+[![Test Coverage](https://codeclimate.com/github/k-shogo/spinel/badges/coverage.svg)](https://codeclimate.com/github/k-shogo/spinel)
+
 Spinel is Redis based lightweight text search engine.  
 SpinelはRedisをバックエンドに用いた軽量なテキスト検索システムです。
 
@@ -72,9 +76,9 @@ spinel.search 'usu'
 ```ruby
 Spinel.configure do |config|
   config.redis        = 'redis://127.0.0.1:6379/0'
-  config.min_complete = 2
+  config.minimal_word = 2
   config.cache_expire = 600
-  config.match_limit  = 10
+  config.search_limit = 10
   config.document_key = :body
   config.namespace    = 'spinel'
 end

data/Rakefile

@@ -1,2 +1,7 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/lib/spinel/config.rb

@@ -1,23 +1,23 @@
 module Spinel
   module Config
-    DEFAULT_MIN_COMPLETE = 2
+    DEFAULT_MINIMAL_WORD = 2
     DEFAULT_CACHE_EXPIRE = 600
-    DEFAULT_MATCH_LIMIT  = 10
+    DEFAULT_SEARCH_LIMIT = 10
     DEFAULT_DOCUMENT_KEY = :body
     DEFAULT_NAMESPACE    = 'spinel'
 
-    attr_writer :min_complete, :cache_expire, :match_limit, :document_key, :namespace
+    attr_writer :minimal_word, :cache_expire, :search_limit, :document_key, :namespace
 
-    def min_complete
-      @min_complete ||= DEFAULT_MIN_COMPLETE
+    def minimal_word
+      @minimal_word ||= DEFAULT_MINIMAL_WORD
     end
 
     def cache_expire
       @cache_expire ||= DEFAULT_CACHE_EXPIRE
     end
 
-    def match_limit
-      @match_limit ||= DEFAULT_MATCH_LIMIT
+    def search_limit
+      @search_limit ||= DEFAULT_SEARCH_LIMIT
     end
 
     def document_key
@@ -35,7 +35,6 @@ module Spinel
       else
         @redis = server
       end
-
       redis
     end
 

data/lib/spinel/helper.rb

@@ -1,9 +1,9 @@
 module Spinel
   module Helper
 
-    def prefixes_for_phrase(phrase)
-      squish(phrase).split.flat_map do |w|
-        (Spinel.min_complete-1..(w.length-1)).map{ |l| w[0..l] }
+    def prefixes str
+      squish(str).split.flat_map do |w|
+        (Spinel.minimal_word-1..(w.length-1)).map{ |l| w[0..l] }
       end.uniq
     end
 
@@ -11,8 +11,12 @@ module Spinel
       str.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
-    def document_validate doc
-      raise ArgumentError, "documents must specify both an id and a body" unless document_id(doc) && document_body(doc)
+    def get_valid_document doc
+      id    = document_id    doc
+      body  = document_body  doc
+      score = document_score doc
+      raise ArgumentError, "documents must specify both an id and a body" unless id && body
+      [id, body, score]
     end
 
     def document_id doc
@@ -20,7 +24,7 @@ module Spinel
     end
 
     def document_score doc
-      doc[:score] || doc["score"]
+      (doc[:score] || doc["score"]).to_f
     end
 
     def document_body doc

data/lib/spinel/indexer.rb

@@ -3,17 +3,17 @@ module Spinel
 
     def store doc, opts = {}
       opts = { skip_duplicate_check: false }.merge(opts)
-      document_validate doc
-      id = document_id doc
+      id, body, score = get_valid_document doc
 
       remove(id: id) unless opts[:skip_duplicate_check]
 
       Spinel.redis.pipelined do
         Spinel.redis.hset(database, id, MultiJson.encode(doc))
-        prefixes_for_phrase(document_body(doc)).each do |p|
-          Spinel.redis.zadd(index(p), document_score(doc), id)
+        prefixes(body).each do |p|
+          Spinel.redis.zadd(index(p), score, id)
         end
       end
+      doc
     end
 
     def get id
@@ -28,7 +28,7 @@ module Spinel
         prev_id = document_id prev_doc
         Spinel.redis.pipelined do
           Spinel.redis.hdel(database, prev_id)
-          prefixes_for_phrase(document_body(prev_doc)).each do |p|
+          prefixes(document_body(prev_doc)).each do |p|
             Spinel.redis.zrem(index(p), prev_id)
           end
         end

data/lib/spinel/searcher.rb

@@ -2,22 +2,34 @@ module Spinel
   module Searcher
 
     def search term, options = {}
-      options = { limit: Spinel.match_limit, cache: true }.merge(options)
-
-      words = squish(term).split.reject{|w| w.size < Spinel.min_complete}.sort
+      options = search_option options
+      words = search_word_split term
       return [] if words.empty?
 
       tmp_cachekey = cachekey(words)
 
-      unless options[:cache] && Spinel.redis.exists(tmp_cachekey)
-        interkeys = words.map{ |w| index w }
-        Spinel.redis.zinterstore(tmp_cachekey, interkeys)
-        Spinel.redis.expire(tmp_cachekey, Spinel.cache_expire)
-      end
+      set_cache(tmp_cachekey, words) unless options[:cache] && cache_enable(tmp_cachekey)
 
       ids = Spinel.redis.zrevrange(tmp_cachekey, 0, options[:limit] - 1)
       ids.empty? ? [] : Spinel.redis.hmget(database, *ids).compact.map{|json| MultiJson.decode(json)}
+    end
+
+    def search_option options = {}
+      { limit: Spinel.minimal_word, cache: true }.merge(options)
+    end
+
+    def search_word_split word
+      squish(word).split.reject{|w| w.size < Spinel.minimal_word}.sort
+    end
+
+    def set_cache key, words
+      interkeys = words.map{ |w| index w }
+      Spinel.redis.zinterstore(key, interkeys)
+      Spinel.redis.expire(key, Spinel.cache_expire)
+    end
 
+    def cache_enable key
+      Spinel.redis.exists(key)
     end
 
   end

data/lib/spinel/version.rb

@@ -1,6 +1,6 @@
 module Spinel
   MAJOR = 0
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/spinel.gemspec

@@ -23,4 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", ">= 5.4"
+  spec.add_development_dependency "minitest-power_assert"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "mock_redis"
 end

data/test/spinel_test.rb

@@ -0,0 +1,120 @@
+require 'test_helper'
+
+class SpinelTest < Minitest::Test
+  def setup
+    @spinel = Spinel.new
+  end
+
+  def test_redis
+    assert { 'PONG' == Spinel.redis.ping }
+
+    Spinel.redis = 'redis://127.0.0.1:6379/0'
+    assert { 'PONG' == Spinel.redis.ping }
+
+    mock_redis = MockRedis.new
+    Spinel.redis = mock_redis
+    assert { mock_redis.object_id == Spinel.redis.object_id }
+  end
+
+  def test_respond_to?
+   assert Spinel.respond_to? :store
+   assert Spinel.respond_to? :remove
+   assert Spinel.respond_to? :get
+   assert Spinel.respond_to? :search
+  end
+
+  def test_method_missing
+    Spinel.redis.flushall
+    Spinel.store({id: 1, body: 'test'},{})
+    assert { 1 == Spinel.redis.hlen(@spinel.database) }
+  end
+
+  def test_database_index
+    assert { 'spinel:data:default' == @spinel.database }
+  end
+
+  def test_index
+    assert { 'spinel:index:default:term' == @spinel.index(:term) }
+  end
+
+  def test_cachekey_index
+    assert { 'spinel:cache:default:word1|word2' == @spinel.cachekey(%w(word1 word2)) }
+  end
+
+  def test_prefixes
+    assert { ["ta", "tak", "take", "tal", "talk"] == @spinel.prefixes("take talk") }
+  end
+
+  def test_squish
+    assert { "quick brown fox" == @spinel.squish("  quick \t  brown\n fox  ") }
+  end
+
+  def test_get_valid_document
+    assert_raises(ArgumentError){ @spinel.get_valid_document({id: 1}) }
+    assert_raises(ArgumentError){ @spinel.get_valid_document({body: 'body'}) }
+    assert { [1, 'body', 0.0] == @spinel.get_valid_document({id: 1, body: 'body'}) }
+  end
+
+  def test_document_id
+    assert { "doc_id" == @spinel.document_id({id: "doc_id"}) }
+    assert { "doc_id" == @spinel.document_id({"id" => "doc_id"}) }
+  end
+
+  def test_document_score
+    assert { 1.0 == @spinel.document_score({score: 1}) }
+    assert { 1.0 == @spinel.document_score({"score" => 1}) }
+    assert { 0.0 == @spinel.document_score({}) }
+  end
+
+  def test_document_body
+    assert { "doc_body" == @spinel.document_body({body: "doc_body"}) }
+    assert { "doc_body" == @spinel.document_body({"body" => "doc_body"}) }
+  end
+
+  def test_minimal_word
+    assert { 2 == Spinel.minimal_word }
+  end
+
+  def test_cache_expire
+    assert { 600 == Spinel.cache_expire }
+  end
+
+  def test_search_limit
+    assert { 10 == Spinel.search_limit }
+  end
+
+  def test_document_key
+    assert { 'body' == Spinel.document_key }
+  end
+
+  def test_namespace
+    assert { 'spinel' == Spinel.namespace }
+  end
+
+  def test_store
+    Spinel.redis.flushall
+    @spinel.store id: 1, body: 'test'
+    assert { 1 == Spinel.redis.hlen(@spinel.database) }
+  end
+
+  def test_get
+    Spinel.redis.flushall
+    @spinel.store id: 1, body: 'test'
+    assert { {"id" => 1, "body" => 'test'} == @spinel.get(1) }
+  end
+
+  def test_remove
+    Spinel.redis.flushall
+    @spinel.store id: 1, body: 'test'
+    @spinel.remove id: 1
+    assert { 0 == Spinel.redis.hlen(@spinel.database) }
+  end
+
+  def test_search
+    Spinel.redis.flushall
+    @spinel.store id: 1, body: 'ruby'
+    @spinel.store id: 2, body: 'rubx'
+    assert { 2 == @spinel.search('rub').size }
+    assert { 1 == @spinel.search('ruby').size }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,39 @@
+require 'dotenv'
+require "codeclimate-test-reporter"
+require 'simplecov'
+
+Dotenv.load
+CodeClimate::TestReporter.start if ENV['CCR']
+
+SimpleCov.start do
+  add_filter "vendor"
+end
+
+require 'spinel'
+require 'mock_redis'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest-power_assert'
+
+Spinel.configure do |config|
+  config.redis        = MockRedis.new
+  config.minimal_word = 2
+  config.cache_expire = 600
+  config.search_limit = 10
+  config.document_key = :body
+  config.namespace    = 'spinel'
+end
+
+def test_data
+  [
+    {id: 1, body: 'and all with pearl and ruby glowing'},
+    {id: 2, body: 'yellow or orange variety of ruby spinel'},
+    {id: 3, body: 'colour called pearl yellow'},
+    {id: 4, body: 'mandarin orange net sack'},
+    {id: 5, body: 'spinel used as a gemstone usually dark red'},
+    {id: 6, body: 'today is hotter than usual'},
+    {id: 7, body: 'call on a person'},
+    {id: 8, body: 'that gem is shining'},
+    {id: 9, body: 'polish shoes to a bright shine'}
+  ]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinel
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - k-shogo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -66,6 +66,90 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mock_redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: lightweight text search system on Redis
 email:
 - platycod0n.ramosa@gmail.com
@@ -87,6 +171,8 @@ files:
 - lib/spinel/searcher.rb
 - lib/spinel/version.rb
 - spinel.gemspec
+- test/spinel_test.rb
+- test/test_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -111,4 +197,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: lightweight text search system on Redis
-test_files: []
+test_files:
+- test/spinel_test.rb
+- test/test_helper.rb