facile_search 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df9c6537e798b558d1322a4f9b4708261e5a95b6
+  data.tar.gz: 87270a7bbd1d922517e48594e5a7c2b1b22d866c
+SHA512:
+  metadata.gz: 90f3969afac89a9a114806a71d720a7b24376cab41e219ecd0cec50d7e3b054dbabd318e56cc399950fb95bcb92d2f3871389d4b9bbee928fa33f7e7bf9cd473
+  data.tar.gz: 06b25f0d288f36320cbca8fe019a7cd69d273559da08a2724a09b09ada2a580a1f8721a3c590baca9f4fead1ccd265b30d3c1f572f153b57c890d1543e5b0087

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 i2bskn
+
+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,39 @@
+# FacileSearch
+
+Simple search with inverted index.  
+(Index data is stored in the Redis.)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'facile_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install facile_search
+
+## Usage
+
+```ruby
+meta = FacileSearch::MetaData.new(namespace: "example_index", text_field: "text")
+index = FacileSearch::InvertedIndex.new(meta)
+sample = Struct.new(:id, :text).new(1, "some text")
+index.indexing(sample) # => "OK"
+index.search(["text"]) # => [1]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/i2bskn/facile_search/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,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Console with library"
+task :console do
+  sh "pry -I lib -r bundler/setup -r facile_search"
+end
+

data/facile_search.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facile_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "facile_search"
+  spec.version       = FacileSearch::VERSION
+  spec.authors       = ["i2bskn"]
+  spec.email         = ["i2bskn@gmail.com"]
+
+  spec.summary       = %q{Simple search with inverted index.}
+  spec.description   = %q{Simple search with inverted index.}
+  spec.homepage      = "https://github.com/i2bskn/facile_search"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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-objects"
+  spec.add_dependency "oj"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end
+

data/lib/facile_search/inverted_index.rb

@@ -0,0 +1,55 @@
+require "facile_search/tokenizer/ngram"
+
+module FacileSearch
+  class InvertedIndex
+    extend Forwardable
+
+    attr_reader :meta_data
+
+    def_delegators :meta_data, :lock_key, *MetaData::BASE_KEYS
+
+    def initialize(meta_data)
+      @meta_data = meta_data
+    end
+
+    def indexing(obj)
+      tokens = tokenizer.tokenize(obj.public_send(text_field))
+      id = obj.public_send(id_field)
+      lock = Redis::Lock.new(lock_key)
+      begin
+        lock.lock do
+          values = redis.hmget(namespace, tokens).map {|ids|
+            array = deserialize(ids)
+            array << id
+            serialize(array.uniq)
+          }
+          redis.hmset(namespace, *tokens.zip(values).flatten(1))
+        end
+      rescue Redis::Lock::LockTimeout
+        raise
+      end
+    end
+
+    def search(queries)
+      queries.each_with_object([]) {|query, obj|
+        tokens = tokenizer.tokenize(query)
+        return [] if tokens.size.zero?
+        obj << redis.hmget(namespace, *tokens).map {|ids| deserialize(ids) }.inject(&:&)
+      }.inject(&:&)
+    end
+
+    private
+      def serialize(obj)
+        Oj.dump(obj)
+      end
+
+      def deserialize(string)
+        string ? Oj.load(string) : []
+      end
+
+      def redis
+        @redis ||= Redis.current
+      end
+  end
+end
+

data/lib/facile_search/meta_data.rb

@@ -0,0 +1,19 @@
+module FacileSearch
+  class MetaData
+    BASE_KEYS = %i(namespace text_field id_field tokenizer).freeze
+
+    attr_reader *BASE_KEYS
+
+    def initialize(namespace: , text_field: , id_field: nil, tokenizer: nil)
+      @namespace = namespace.to_s
+      @text_field = text_field.to_s
+      @id_field = id_field || "id"
+      @tokenizer = tokenizer || Tokenizer::NGram.new(2)
+    end
+
+    def lock_key
+      [namespace, "lock"].join("_")
+    end
+  end
+end
+

data/lib/facile_search/tokenizer/ngram.rb

@@ -0,0 +1,14 @@
+module FacileSearch
+  module Tokenizer
+    class NGram
+      def initialize(n)
+        @n = n
+      end
+
+      def tokenize(strings)
+        strings.chars.each_cons(@n).map(&:join)
+      end
+    end
+  end
+end
+

data/lib/facile_search/version.rb

@@ -0,0 +1,4 @@
+module FacileSearch
+  VERSION = "0.0.1"
+end
+

data/lib/facile_search.rb

@@ -0,0 +1,9 @@
+require "forwardable"
+
+require "redis/objects"
+require "oj"
+
+require "facile_search/version"
+require "facile_search/meta_data"
+require "facile_search/inverted_index"
+

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: facile_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- i2bskn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: rspec
+  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: pry
+  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: Simple search with inverted index.
+email:
+- i2bskn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- facile_search.gemspec
+- lib/facile_search.rb
+- lib/facile_search/inverted_index.rb
+- lib/facile_search/meta_data.rb
+- lib/facile_search/tokenizer/ngram.rb
+- lib/facile_search/version.rb
+homepage: https://github.com/i2bskn/facile_search
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple search with inverted index.
+test_files: []