indexa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fda7cc36eb4e16b6f702cef60afe13424ff6ea04
+  data.tar.gz: 26dd0ab1cb92169f6c7349a7c693e4835c44f8cb
+SHA512:
+  metadata.gz: 75e85dfae2fe15fc80deb2b30a149e2258610592c5e8590b10820a64a7e6c959416750f4c3e56eca98faf3847841e8ffecb13e050c14d07d9fa974efcfcab734
+  data.tar.gz: 2bef7ce80d49c37decda3166f268beb4b004b07979fe38f44c53b3098a78983917d36ba0d68465ac189082f17d5a937c473994c66b99250266e92cff3dd9b068

data/.gitignore

@@ -0,0 +1,3 @@
+dump.rdb
+.gs
+

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Julián Porta
+
+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,17 @@
+indexa
+====
+
+Indexa indexes an array of words in a redis backend
+
+Description
+-----------
+
+Indexa indexes an array of words in a redis backend to be searched by Busca, the simple redis search
+
+## Installation
+
+As usual, you can install it using rubygems.
+
+```
+$ gem install indexa
+```

data/indexa.gemspec

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name              = "indexa"
+  s.version           = "0.0.1"
+  s.summary           = "Indexa indexes an array of words in a redis backend"
+  s.description       = "Indexa indexes an array of words in a redis backend to be searched by Busca, the simple redis search"
+  s.authors           = ["Julián Porta"]
+  s.email             = ["julian@porta.sh"]
+  s.homepage          = "https://github.com/Porta/indexa"
+  s.files             = `git ls-files`.split("\n")
+  s.license           = "MIT"
+  s.add_development_dependency "cutest", '~> 1.2'
+  s.add_runtime_dependency "redic", '~> 1.4'
+  s.add_runtime_dependency "msgpack", '~> 0.5'
+end

data/lib/indexa.rb

@@ -0,0 +1,64 @@
+require 'msgpack'
+require 'redic'
+
+
+class Indexa
+
+    NAMESPACE   = 'Busca' #TODO: Confirm gem name
+    LUA_CACHE   = Hash.new { |h, k| h[k] = Hash.new }
+    LUA_INDEX   = File.expand_path("./lib/lua/index.lua")
+    LUA_REMOVE  = File.expand_path("./lib/lua/remove.lua")
+
+    def initialize(namespace = NAMESPACE, opts = {})
+        @namespace = namespace
+        redis = opts[:redis] || Redic.new
+    end
+
+    def add(document_id, words)
+        index_id = script( LUA_INDEX, 0,
+           @namespace.to_msgpack,
+           document_id.to_msgpack,
+           words.to_msgpack
+          )
+        return index_id
+    end
+
+    def remove(id)
+        result = script( LUA_REMOVE, 0,
+           @namespace.to_msgpack,
+           id.to_msgpack
+        )
+        return result        
+    end
+
+    def redis
+        @redis ||= Redic.new
+    end
+
+
+    protected
+
+    def key(name)
+        Nido.new(NAMESPACE)[name]
+    end
+
+    def redis=(redis)
+        @redis = redis
+    end  
+
+    def script(file, *args)
+        cache = LUA_CACHE[redis.url]
+
+        if cache.key?(file)
+          sha = cache[file]
+        else
+          src = File.read(file)
+          sha = redis.call("SCRIPT", "LOAD", src)
+
+          cache[file] = sha
+        end
+
+        redis.call("EVALSHA", sha, *args)
+    end
+
+end

data/lib/lua/index.lua

@@ -0,0 +1,36 @@
+local namespace = cmsgpack.unpack(ARGV[1])
+local document_id  = cmsgpack.unpack(ARGV[2])
+local words     = cmsgpack.unpack(ARGV[3])
+
+local function check_for_vacants()
+  local id = redis.call('RPOP', namespace .. ':vacants')
+  return id
+end
+
+local function save(document_id, words)
+  -- first try to get one available id from the vacants list
+  local id = check_for_vacants()
+  
+  if id == false then
+    id = redis.call('INCR', namespace .. ':document:ids')
+  end
+
+  redis.call('SET', namespace .. ':document:' .. id, document_id)
+
+  return id
+end
+
+
+local function index(words, id)
+  for i, word in pairs(words) do
+    redis.call('SETBIT', namespace .. ':' .. word, id, 1)
+    redis.call('RPUSH', namespace .. ':document:' .. id .. ':words', word)
+  end
+end
+
+
+local id = save(document_id, words)
+
+index(words, id)
+
+return id

data/lib/lua/remove.lua

@@ -0,0 +1,33 @@
+local namespace = cmsgpack.unpack(ARGV[1])
+local id        = cmsgpack.unpack(ARGV[2])
+
+
+local function get_words(id)
+  local words = redis.call('LRANGE', namespace .. ':document:' .. id .. ':words', 0, -1)
+  return words
+end
+
+local function set_new_vacants(id)
+  local id = redis.call('RPUSH', namespace .. ':vacants', id)
+  return id
+end
+
+local function delete(id)
+  -- add document id to vacants list
+  set_new_vacants(id)  
+  redis.call('DEL', namespace .. ':document:' .. id)
+end
+
+local function remove_from_index(words, id)
+  for i, word in pairs(words) do
+    redis.call('SETBIT', namespace .. ':' .. word, id, 0)
+  end
+end
+
+
+local words = get_words(id)
+delete(id)
+
+remove_from_index(words, id)
+
+return true

data/makefile

@@ -0,0 +1,2 @@
+test:
+	cutest ./tests/*_test.rb

data/tests/indexa_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path("../lib/indexa", File.dirname(__FILE__))
+
+scope do
+  setup do
+    document = %w(this is some document that I've indexed)
+    indexer = Indexa.new
+    indexer.redis.call('flushdb')
+    [indexer, document]
+  end
+
+  test "index a document and get it's id" do |indexer, document|
+    document_id = indexer.add(5, document)
+    assert_equal document_id, 1
+  end
+
+  test "index two documents" do |indexer, document|
+    first = indexer.add(3, document)
+    second = indexer.add(7, %w(uno dos tres cuatro cinco seis))
+    assert_equal first, 1
+    assert_equal second, 2
+  end
+
+  
+
+end

data/tests/remove_test.rb

@@ -0,0 +1,36 @@
+require File.expand_path("../lib/indexa", File.dirname(__FILE__))
+
+scope do
+  setup do
+    document = %w(this is some document that I've indexed)
+    indexer = Indexa.new
+    indexer.redis.call('flushdb')
+    [indexer, document]
+  end
+
+  test "delete a document from index" do |indexer, document|
+    first = indexer.add(1, document)
+    second = indexer.add(2, %w(altas llantas tiene el gato))
+    indexer.remove(second)
+    assert_equal indexer.redis.call('GET', 'Busca:document:1'), first.to_s
+    assert_equal indexer.redis.call('GET', 'Busca:document:2'), nil
+  end
+
+  test "should vacant an id upon document deletion" do |indexer, document|
+    first = indexer.add(1, document)
+    second = indexer.add(2, %w(altas llantas tiene el gato))
+    indexer.remove(second)
+    assert_equal indexer.redis.call('GET', 'Busca:document:2'), nil
+    assert_equal indexer.redis.call('LINDEX', 'Busca:vacants', 0), "2"
+  end
+
+  test "should use the vacant id on new document index" do |indexer, document|
+    first = indexer.add(1, document)
+    assert_equal indexer.redis.call('GET', 'Busca:document:1'), first.to_s
+    indexer.redis.call('RPUSH', 'Busca:vacants', 3)
+    foo = %w(My name is julian porta and Im a good person)
+    second = indexer.add(3, foo)
+    assert_equal indexer.redis.call('GET', 'Busca:document:3'), second.to_s
+  end
+
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: indexa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julián Porta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: redic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: msgpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Indexa indexes an array of words in a redis backend to be searched by
+  Busca, the simple redis search
+email:
+- julian@porta.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- indexa.gemspec
+- lib/indexa.rb
+- lib/lua/index.lua
+- lib/lua/remove.lua
+- makefile
+- tests/indexa_test.rb
+- tests/remove_test.rb
+homepage: https://github.com/Porta/indexa
+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.6
+signing_key: 
+specification_version: 4
+summary: Indexa indexes an array of words in a redis backend
+test_files: []