spinel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a55bbe4e834685bcef3003c6a53a4722d0d4b3e7
+  data.tar.gz: bb615a4d0d4c79069686ecd73575f9e228c27942
+SHA512:
+  metadata.gz: 2a887be953fc67ce0688d578c71faadeeb86badddc9e0b58a92c37abae19010fe412e4f81fcb64b14171f1452c1b63cae042050b2fa9ce64a70344cd94ae94f1
+  data.tar.gz: 492dc54d734cf244b04d506468d394e7d0c3c1955b54f5c8a7d7542a63bc45ae6f5305e265ad222a58b5457e6259fa5ff163f21f22792b1282affbf4d546b381

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/vendor/bundle
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in spinel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Shogo Kawaguchi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Spinel
+
+SpinelはRedisをバックエンドに用いた軽量なサジェストシステムです。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spinel'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install spinel
+```
+
+## Usage
+
+### Configuration
+
+```ruby
+Spinel.configure do |config|
+  config.redis = 'redis://127.0.0.1:6379/0'
+  config.min_complete = 3
+  config.cache_expire = 300
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/k-shogo/spinel/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/spinel/backend.rb

@@ -0,0 +1,39 @@
+module Spinel
+  class Backend < Base
+
+    def add(doc, opts = {})
+      opts = { skip_duplicate_check: false }.merge(opts)
+      document_validate doc
+      id = document_id 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_to_phrase(doc)).each do |p|
+          Spinel.redis.zadd(base_and(p), document_score(doc), id)
+        end
+      end
+    end
+
+    def get id
+      if doc = Spinel.redis.hget(database, id)
+        MultiJson.decode(doc)
+      end
+    end
+
+    def remove(doc)
+      if prev_doc = Spinel.redis.hget(database, document_id(doc))
+        prev_doc = MultiJson.decode(prev_doc)
+        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|
+            Spinel.redis.zrem(base_and(p), prev_id)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/spinel/base.rb

@@ -0,0 +1,31 @@
+module Spinel
+  class Base
+    include Helper
+
+    attr_accessor :type
+
+    def initialize type = :default
+      @type = type
+    end
+
+    def base
+      "#{Spinel.namespace}:index:#{type}"
+    end
+
+    def base_and p
+      "#{base}:#{p}"
+    end
+
+    def database
+      "#{Spinel.namespace}:data:#{type}"
+    end
+
+    def cachebase
+      "#{Spinel.namespace}:cache:#{type}"
+    end
+
+    def cachekey words
+      "#{cachebase}:#{words.join('|')}"
+    end
+  end
+end

data/lib/spinel/config.rb

@@ -0,0 +1,61 @@
+module Spinel
+  module Config
+    DEFAULT_MIN_COMPLETE = 2
+    DEFAULT_CACHE_EXPIRE = 600
+    DEFAULT_MATCH_LIMIT  = 10
+    DEFAULT_DOCUMENT_KEY = :body
+    DEFAULT_NAMESPACE    = 'spinel'
+
+    attr_writer :min_complete, :cache_expire, :match_limit, :document_key, :namespace
+
+    def min_complete
+      @min_complete ||= DEFAULT_MIN_COMPLETE
+    end
+
+    def cache_expire
+      @cache_expire ||= DEFAULT_CACHE_EXPIRE
+    end
+
+    def match_limit
+      @match_limit ||= DEFAULT_MATCH_LIMIT
+    end
+
+    def document_key
+      (@document_key ||= DEFAULT_DOCUMENT_KEY).to_s
+    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
+    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
+        })
+      )
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+  end
+end

data/lib/spinel/helper.rb

@@ -0,0 +1,36 @@
+module Spinel
+  module Helper
+
+    def prefixes_for_phrase(phrase)
+      words = phrase.split(' ')
+      words.map do |w|
+        (Spinel.min_complete-1..(w.length-1)).map{ |l| w[0..l] }
+      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
+
+    def document_id doc
+      doc[:id] || doc["id"]
+    end
+
+    def document_score doc
+      doc[:score] || doc["score"]
+    end
+
+    def document_body doc
+      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/matcher.rb

@@ -0,0 +1,32 @@
+module Spinel
+  class Matcher < Base
+
+    def matches(term, options = {})
+      options = { limit: Spinel.match_limit, cache: true }.merge(options)
+
+      words = term.split(' ').reject do |w|
+        w.size < Spinel.min_complete
+      end.sort
+
+      return [] if words.empty?
+
+      tmp_cachekey = cachekey(words)
+
+      if !options[:cache] || !Spinel.redis.exists(tmp_cachekey) || Spinel.redis.exists(tmp_cachekey) == 0
+        interkeys = words.map { |w| base_and w }
+        Spinel.redis.zinterstore(tmp_cachekey, interkeys)
+        Spinel.redis.expire(tmp_cachekey, Spinel.cache_expire)
+      end
+
+      ids = Spinel.redis.zrevrange(tmp_cachekey, 0, options[:limit] - 1)
+      if ids.size > 0
+        results = Spinel.redis.hmget(database, *ids)
+        results = results.reject{ |r| r.nil? }
+        results.map { |r| MultiJson.decode(r) }
+      else
+        []
+      end
+    end
+
+  end
+end

data/lib/spinel/version.rb

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

data/lib/spinel.rb

@@ -0,0 +1,20 @@
+require 'redis'
+require 'multi_json'
+require "spinel/version"
+require "spinel/config"
+require "spinel/helper"
+require "spinel/base"
+require "spinel/backend"
+require "spinel/matcher"
+
+module Spinel
+  extend Config
+
+  def self.backend type = :default
+    Backend.new type
+  end
+
+  def self.matcher type = :default
+    Matcher.new type
+  end
+end

data/spinel.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spinel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spinel"
+  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.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redis', '>= 3.0'
+  spec.add_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: spinel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- k-shogo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: suggest related words
+email:
+- platycod0n.ramosa@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spinel.rb
+- lib/spinel/backend.rb
+- lib/spinel/base.rb
+- lib/spinel/config.rb
+- lib/spinel/helper.rb
+- lib/spinel/matcher.rb
+- lib/spinel/version.rb
+- spinel.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: suggest related words
+test_files: []