spinel 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a55bbe4e834685bcef3003c6a53a4722d0d4b3e7
-  data.tar.gz: bb615a4d0d4c79069686ecd73575f9e228c27942
+  metadata.gz: da5beee409ee144651696f28780f01ac1674568c
+  data.tar.gz: 95e3ac8b09ad14410d4aa209a3b5403ed886d601
 SHA512:
-  metadata.gz: 2a887be953fc67ce0688d578c71faadeeb86badddc9e0b58a92c37abae19010fe412e4f81fcb64b14171f1452c1b63cae042050b2fa9ce64a70344cd94ae94f1
-  data.tar.gz: 492dc54d734cf244b04d506468d394e7d0c3c1955b54f5c8a7d7542a63bc45ae6f5305e265ad222a58b5457e6259fa5ff163f21f22792b1282affbf4d546b381
+  metadata.gz: 772acc69c9303650862441440df10b16509c8ed0a3935c00da3a8d80d93c9cf383ee110e7727f85dfd6d9ac0a2e5f272e8fc08f4bd22e8acc91e4826ce591dde
+  data.tar.gz: 30de09fa646a5229a3efae3c192fa186146aa3cd5b7b732f6e5c5fa606c1a190c52b78c2a944ec5fecfd0281e20e9079220962d44afb6e0326670ce711d9d0a8

data/README.md

@@ -1,8 +1,15 @@
 # Spinel
 
-SpinelはRedisをバックエンドに用いた軽量なサジェストシステムです。
+Spinel is Redis based lightweight text search engine.  
+SpinelはRedisをバックエンドに用いた軽量なテキスト検索システムです。
 
-## Installation
+## コンセプト
+
+Spinelはテキスト検索システムですが、余計なことはいたしません。  
+形態素解析やストップワードの除去などはSpinelよりも上位の層で行う必要があります。  
+大規模な全文検索を行う場合にはSolrやElasticsearchの使用を検討してください。
+
+## インストール / Installation
 
 Add this line to your application's Gemfile:
 
@@ -22,18 +29,88 @@ Or install it yourself as:
 $ gem install spinel
 ```
 
-## Usage
+## 使い方 / Usage
+
+### データ登録 / registration
+
+```ruby
+backend = Spinel.backend
+backend.add id: 1, body: 'and all with pearl and ruby glowing'
+backend.add id: 2, body: 'a yellow or orange variety of ruby spinel'
+backend.add id: 3, body: 'a colour called pearl yellow'
+backend.add id: 4, body: 'a mandarin orange net sack'
+backend.add id: 5, body: 'a spinel used as a gemstone usually dark red'
+backend.add id: 6, body: 'today is hotter than usual'
+backend.add id: 7, body: 'call on a person'
+backend.add id: 8, body: 'that gem is shining'
+backend.add id: 9, body: 'polish shoes to a bright shine'
+```
+
+データの登録時には最低限の要素として `id` 及び `body` が必要になります。  
+ドキュメントの内容を示すキーである `body` は後述する設定によって変更することも可能です。
+
+`score` がキー含まれていた場合は特別に処理されます。  
+`score`はドキュメントの優先度を指定できるキーであり、検索結果の順序に関係します。
 
-### Configuration
+### 検索 / search
+
+```ruby
+matcher = Spinel.matcher
+matcher.matches 'ruby'
+# => [{"id"=>2, "body"=>"a yellow or orange variety of ruby spinel"}, {"id"=>1, "body"=>"and all with pearl and ruby glowing"}]
+matcher.matches 'usu'
+# => [{"id"=>6, "body"=>"today is hotter than usual"}, {"id"=>5, "body"=>"a spinel used as a gemstone usually dark red"}]
+```
+
+### 設定 / Configuration
+
+設定はブロックにより行うことが出来ます。  
+以下の例で示されているデフォルト値で運用する場合には設定は必要ありません。
 
 ```ruby
 Spinel.configure do |config|
-  config.redis = 'redis://127.0.0.1:6379/0'
-  config.min_complete = 3
-  config.cache_expire = 300
+  config.redis        = 'redis://127.0.0.1:6379/0'
+  config.min_complete = 2
+  config.cache_expire = 600
+  config.match_limit  = 10
+  config.document_key = :body
+  config.namespace    = 'spinel'
 end
 ```
 
+#### redisの接続先
+
+デフォルトでは `redis://127.0.0.1:6379/0` に接続しようとします。  
+環境変数に `REDIS_URL` が存在するとき、`redis://127.0.0.1:6379/0` よりも優先してその値を使おうとします。  
+明示的な設定が行われた場合には環境変数よりも設定が優先されます。
+
+明示的な設定において文字列が与えられた場合には、文字列をパースしてredisの接続を作成します。  
+[resque/redis-namespace](https://github.com/resque/redis-namespace)等を使いたい場合には、直接指定することも可能です。
+
+```ruby
+Spinel.configure do |config|
+  config.redis = Redis::Namespace.new(:ns, redis: Redis.new)
+end
+```
+
+#### 検索結果のキャッシュ / 候補数
+
+高速化の為に、同一のクエリーの検索結果は最後の検索から10分間キャッシュされます。  
+`config.cache_expire` はキャッシュの有効期限を設定する項目です。  
+また `config.match_limit` はデフォルトの検索候補の最大数を変更します。
+
+キャッシュの使用と検索候補数は検索時にオプションとして値を指定することも可能です。
+
+```ruby
+matcher.matches 'ruby', cache: false, limit: 5
+```
+
+## バージョニング / Versioning
+
+Spinelのバージョニングは[Semantic Versioning 2.0.0](http://semver.org/)に基づいて採番されます。  
+現在Spinelは開発初期段階です。  
+いつでも、いかなる変更も起こりうります。
+
 ## Contributing
 
 1. Fork it ( https://github.com/k-shogo/spinel/fork )

data/lib/spinel/backend.rb

@@ -10,7 +10,7 @@ module Spinel
 
       Spinel.redis.pipelined do
         Spinel.redis.hset(database, id, MultiJson.encode(doc))
-        prefixes_for_phrase(document_to_phrase(doc)).each do |p|
+        prefixes_for_phrase(document_body(doc)).each do |p|
           Spinel.redis.zadd(base_and(p), document_score(doc), id)
         end
       end
@@ -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_to_phrase(prev_doc)).each do |p|
+          prefixes_for_phrase(document_body(prev_doc)).each do |p|
             Spinel.redis.zrem(base_and(p), prev_id)
           end
         end

data/lib/spinel/helper.rb

@@ -8,10 +8,6 @@ module Spinel
       end.flatten.uniq
     end
 
-    def document_to_phrase doc
-      [document_body(doc), *Array(document_aliases(doc))].join(' ')
-    end
-
     def document_validate doc
       raise ArgumentError, "documents must specify both an id and a body" unless document_id(doc) && document_body(doc)
     end
@@ -28,9 +24,5 @@ module Spinel
       doc[Spinel.document_key.to_sym] || doc[Spinel.document_key]
     end
 
-    def document_aliases doc
-      doc[:aliases] || doc["aliases"]
-    end
-
   end
 end

data/lib/spinel/version.rb

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

data/spinel.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Spinel::VERSION
   spec.authors       = ["k-shogo"]
   spec.email         = ["platycod0n.ramosa@gmail.com"]
-  spec.summary       = %q{suggest related words}
-  spec.description   = %q{suggest related words}
+  spec.summary       = %q{lightweight text search system on Redis}
+  spec.description   = %q{lightweight text search system on Redis}
   spec.homepage      = ""
   spec.license       = "MIT"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spinel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - k-shogo
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: suggest related words
+description: lightweight text search system on Redis
 email:
 - platycod0n.ramosa@gmail.com
 executables: []
@@ -109,5 +109,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: suggest related words
+summary: lightweight text search system on Redis
 test_files: []