spinel 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f6bf12711194f3614c34dbfc4f8867c38f622c
-  data.tar.gz: d21f2b552b8bf29de5182be3970ba97b9c76cbb3
+  metadata.gz: 7efbff4b362858d3bb4ec7ad0efb505b1876b094
+  data.tar.gz: f9084f203a49492a4d13c8fabadf886d656cb11c
 SHA512:
-  metadata.gz: 483bffbfa8cd936502ac4eaae3d218b59bee7a6ecf3b77e43661de092027bbaac0a2a81b200d6bfccf482a10d2250d4f418813733310d74fcaa8f94f32a887f5
-  data.tar.gz: a0023b87aba1bc5204751d9d4af65acd32efe7b906a7f5b9a2b44d091a7e6ee990da4ed157c785d94a883628f95bc3503168567d34b53eaed510d7a3575fba21
+  metadata.gz: 685721dab555cf5cd26d3f14b97104acddd6eb89dd8fd05561d3b4f2f780a7204f18f628dee704df67ef9b74c1681e9523c2235c74907a54741da6d9c1612ff7
+  data.tar.gz: 4c41ca8da330313b2f203afc114926f844f8a4213482228ad91b8ae7303b91045a8ab7b9ae01b2e353b806d3363cd55074672e78ee8f0ace6f48e88ae81751f2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.0
+
+* インデキシングするフィールドを複数指定できるようにする
+* Redisへの接続の取り回しをConnectionPool対応にする
+
 # 0.4.0
 
 * デフォルト検索上限数オプションが効いていなかったバグを修正

data/README.md

@@ -79,7 +79,7 @@ Spinel.configure do |config|
   config.minimal_word = 2
   config.cache_expire = 600
   config.search_limit = 10
-  config.document_key = :body
+  config.index_fields = :body
   config.namespace    = 'spinel'
 end
 ```
@@ -88,15 +88,22 @@ end
 
 デフォルトでは `redis://127.0.0.1:6379/0` に接続しようとします。  
 環境変数に `REDIS_URL` が存在するとき、`redis://127.0.0.1:6379/0` よりも優先してその値を使おうとします。  
-明示的な設定が行われた場合には環境変数よりも設定が優先されます。
+また`Redis.current`で指定することも可能です。
 
-明示的な設定において文字列が与えられた場合には、文字列をパースしてredisの接続を作成します。  
-[resque/redis-namespace](https://github.com/resque/redis-namespace)等を使いたい場合には、直接指定することも可能です。
+```
+Redis.current = Redis.new(host: '127.0.0.1', port: 6379, db: 15)
+```
+
+[resque/redis-namespace](https://github.com/resque/redis-namespace)や、[mperham/connection_pool](https://github.com/mperham/connection_pool)等を使いたい場合には直接指定することも可能です。
 
 ```ruby
-Spinel.configure do |config|
-  config.redis = Redis::Namespace.new(:ns, redis: Redis.new)
-end
+require 'redis-namespace'
+Spinel.redis = Redis::Namespace.new(:ns, redis: Redis.new)
+```
+
+```
+require 'connection_pool'
+Spinel.redis = ConnectionPool.new(size: 5, timeout: 5) { Redis.new(host: '127.0.0.1', port: 6379) }
 ```
 
 #### 検索結果のキャッシュ / 候補数

data/lib/spinel.rb

@@ -5,6 +5,7 @@ require "spinel/config"
 require "spinel/helper"
 require "spinel/indexer"
 require "spinel/searcher"
+require "spinel/connection_pool_proxy"
 require "spinel/client"
 
 module Spinel

data/lib/spinel/config.rb

@@ -3,10 +3,10 @@ module Spinel
     DEFAULT_MINIMAL_WORD = 2
     DEFAULT_CACHE_EXPIRE = 600
     DEFAULT_SEARCH_LIMIT = 10
-    DEFAULT_DOCUMENT_KEY = :body
+    DEFAULT_INDEX_FIELDS = [:body]
     DEFAULT_NAMESPACE    = 'spinel'
 
-    attr_writer :minimal_word, :cache_expire, :search_limit, :document_key, :namespace
+    attr_writer :minimal_word, :cache_expire, :search_limit, :index_fields, :namespace
 
     def minimal_word
       @minimal_word ||= DEFAULT_MINIMAL_WORD
@@ -20,35 +20,21 @@ module Spinel
       @search_limit ||= DEFAULT_SEARCH_LIMIT
     end
 
-    def document_key
-      (@document_key ||= DEFAULT_DOCUMENT_KEY).to_s
+    def index_fields
+      Array(@index_fields ||= DEFAULT_INDEX_FIELDS)
     end
 
     def namespace
       @namespace ||= DEFAULT_NAMESPACE
     end
 
-    def redis=(server)
-      if server.is_a?(String)
-        @redis = nil
-        @redis_url = server
-      else
-        @redis = server
-      end
-      redis
+    def redis= conn
+      @redis = Spinel::ConnectionPoolProxy.proxy_if_needed(conn)
     end
 
     def redis
-      @redis ||= (
-        url = URI(@redis_url || ENV["REDIS_URL"] || "redis://127.0.0.1:6379/0")
-
-        ::Redis.new({
-          host:     url.host,
-          port:     url.port,
-          db:       url.path[1..-1],
-          password: url.password
-        })
-      )
+      @redis || $redis || Redis.current ||
+        raise(NotConnected, "Redis::Objects.redis not set to a Redis.new connection")
     end
 
     def configure

data/lib/spinel/connection_pool_proxy.rb

@@ -0,0 +1,24 @@
+module Spinel
+  class ConnectionPoolProxy
+    def initialize pool
+      raise ArgumentError, "Should only proxy ConnectionPool!" unless self.class.should_proxy?(pool)
+      @pool = pool
+    end
+
+    def method_missing name, *args, &block
+      @pool.with { |x| x.send(name, *args, &block) }
+    end
+
+    def respond_to_missing? name, include_all = false
+      @pool.with { |x| x.respond_to?(name, include_all) }
+    end
+
+    def self.should_proxy?(conn)
+      defined?(::ConnectionPool) && conn.is_a?(::ConnectionPool)
+    end
+
+    def self.proxy_if_needed(conn)
+      should_proxy?(conn) ? self.new(conn) : conn
+    end
+  end
+end

data/lib/spinel/helper.rb

@@ -12,11 +12,9 @@ module Spinel
     end
 
     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]
+      id = document_id doc
+      raise ArgumentError, "documents must specify id" unless id
+      [id, document_index_fields(doc), document_score(doc)]
     end
 
     def document_id doc
@@ -27,8 +25,10 @@ module Spinel
       (doc[:score] || doc["score"]).to_f
     end
 
-    def document_body doc
-      doc[Spinel.document_key.to_sym] || doc[Spinel.document_key]
+    def document_index_fields doc
+      Spinel.index_fields.map {|field|
+        doc[field.to_s.to_sym] || doc[field.to_s] || doc[field]
+      }.compact.join(' ')
     end
 
   end

data/lib/spinel/indexer.rb

@@ -28,7 +28,7 @@ module Spinel
         prev_id = document_id prev_doc
         Spinel.redis.pipelined do
           Spinel.redis.hdel(database, prev_id)
-          prefixes(document_body(prev_doc)).each do |p|
+          prefixes(document_index_fields(prev_doc)).each do |p|
             Spinel.redis.zrem(index(p), prev_id)
           end
         end

data/lib/spinel/version.rb

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

data/spinel.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter"
   spec.add_development_dependency "dotenv"
   spec.add_development_dependency "mock_redis"
+  spec.add_development_dependency "connection_pool"
 end

data/test/config_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class ConfigTest < SpinelTestBase
+
+  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_index_fields
+    assert { [:body] == Spinel.index_fields }
+  end
+
+  def test_namespace
+    assert { 'spinel' == Spinel.namespace }
+  end
+end

data/test/connection_pool_proxy_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class ConnectionPoolProxy < Minitest::Test
+
+  def setup
+    @proxy = Spinel::ConnectionPoolProxy.new(ConnectionPool.new { MockRedis.new  })
+  end
+
+  def test_initialize
+    assert_raises(ArgumentError){ Spinel::ConnectionPoolProxy.new 'string'  }
+  end
+
+  def test_method_missing
+    assert { 'PONG' == @proxy.ping }
+  end
+
+  def test_respond_to?
+    assert { true == @proxy.respond_to?(:ping) }
+  end
+
+  def test_should_proxy?
+    assert { true == Spinel::ConnectionPoolProxy.should_proxy?(ConnectionPool.new { MockRedis.new })  }
+  end
+
+end

data/test/helper_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class HelperTest < SpinelTestBase
+
+  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({body: 'body'}) }
+    assert { [1, 'body', 0.0] == @spinel.get_valid_document({id: 1, body: 'body'}) }
+    assert { [1, '', 0.0] == @spinel.get_valid_document({id: 1}) }
+  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_index_fields
+    assert { "test" == @spinel.document_index_fields({body: "test"}) }
+    assert { "test" == @spinel.document_index_fields({"body" => "test"}) }
+    Spinel.index_fields = [:index, :aliase]
+    assert { "test word" == @spinel.document_index_fields({index: "test", "aliase" => "word"}) }
+    assert { "test word" == @spinel.document_index_fields({"index" => "test", aliase: "word"}) }
+    Spinel.index_fields = Spinel::Config::DEFAULT_INDEX_FIELDS
+  end
+end

data/test/indexer_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class IndexerTest < SpinelTestBase
+
+  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
+end

data/test/searcher_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class SearcherTest < SpinelTestBase
+
+  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
+
+  def test_search_option
+    assert { {limit: 10, cache: true} == @spinel.search_option }
+    assert { {limit: 1, cache: true} == @spinel.search_option({limit: 1}) }
+    assert { {limit: 10, cache: false} == @spinel.search_option({cache: false}) }
+  end
+
+  def test_search_word_split
+    assert { ['test','word'] == @spinel.search_word_split('test word') }
+    assert { ['abc','def'] == @spinel.search_word_split('  def   abc  ') }
+  end
+end

data/test/spinel_test.rb

@@ -1,16 +1,10 @@
 require 'test_helper'
 
-class SpinelTest < Minitest::Test
-  def setup
-    @spinel = Spinel.new
-  end
+class SpinelTest < SpinelTestBase
 
   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 }
@@ -41,91 +35,4 @@ class SpinelTest < Minitest::Test
     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
-
-  def test_search_option
-    assert { {limit: 10, cache: true} == @spinel.search_option }
-    assert { {limit: 1, cache: true} == @spinel.search_option({limit: 1}) }
-    assert { {limit: 10, cache: false} == @spinel.search_option({cache: false}) }
-  end
-
-  def test_search_word_split
-    assert { ['test','word'] == @spinel.search_word_split('test word') }
-    assert { ['abc','def'] == @spinel.search_word_split('  def   abc  ') }
-  end
 end

data/test/test_helper.rb

@@ -7,10 +7,12 @@ CodeClimate::TestReporter.start if ENV['CCR']
 
 SimpleCov.start do
   add_filter "vendor"
+  add_filter "test"
 end
 
 require 'spinel'
 require 'mock_redis'
+require 'connection_pool'
 require 'minitest/autorun'
 require 'minitest/unit'
 require 'minitest-power_assert'
@@ -20,10 +22,17 @@ Spinel.configure do |config|
   config.minimal_word = 2
   config.cache_expire = 600
   config.search_limit = 10
-  config.document_key = :body
+  config.index_fields = :body
   config.namespace    = 'spinel'
 end
 
+
+class SpinelTestBase < Minitest::Test
+  def setup
+    @spinel = Spinel.new
+  end
+end
+
 def test_data
   [
     {id: 1, body: 'and all with pearl and ruby glowing'},

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spinel
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - k-shogo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  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
@@ -166,11 +180,17 @@ files:
 - lib/spinel.rb
 - lib/spinel/client.rb
 - lib/spinel/config.rb
+- lib/spinel/connection_pool_proxy.rb
 - lib/spinel/helper.rb
 - lib/spinel/indexer.rb
 - lib/spinel/searcher.rb
 - lib/spinel/version.rb
 - spinel.gemspec
+- test/config_test.rb
+- test/connection_pool_proxy_test.rb
+- test/helper_test.rb
+- test/indexer_test.rb
+- test/searcher_test.rb
 - test/spinel_test.rb
 - test/test_helper.rb
 homepage: ''
@@ -198,5 +218,10 @@ signing_key:
 specification_version: 4
 summary: lightweight text search system on Redis
 test_files:
+- test/config_test.rb
+- test/connection_pool_proxy_test.rb
+- test/helper_test.rb
+- test/indexer_test.rb
+- test/searcher_test.rb
 - test/spinel_test.rb
 - test/test_helper.rb