stal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 01f32692fdb539b8eebbc7d2964ba275aecef27b
+  data.tar.gz: a971d29478038e640c0e94fd2636e0a57edd807f
+SHA512:
+  metadata.gz: dc8a947141e7a9d84d8c78ba58097d5cdb002b2493fdbd5a9752cb98306cd661c4f49e6c2b353c4371bb28ff45f30368b255f200d56a467bfe265c69fe620bfd
+  data.tar.gz: 47e6bb79573cde80bce0ed2554ef135de38f52c45ce5303761886d41f2b14b4bb4994632d45007d342685f21c530241d111dc8abe7a2984ef2beebc4361b082d

data/.gems

@@ -0,0 +1,2 @@
+redic -v 1.3.0
+cutest -v 1.2.2

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Michel Martens
+
+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,99 @@
+Stal
+====
+
+Set algebra solver for Redis.
+
+Description
+-----------
+
+`Stal` receives an array with an s-expression composed of commands
+and key names and resolves the set operations in [Redis][redis].
+
+Community
+---------
+
+Meet us on IRC: [#lesscode](irc://chat.freenode.net/#lesscode) on
+[freenode.net](http://freenode.net/).
+
+Getting started
+---------------
+
+Install [Redis][redis]. On most platforms it's as easy as grabbing
+the sources, running make and then putting the `redis-server` binary
+in the PATH.
+
+Once you have it installed, you can execute `redis-server` and it
+will run on `localhost:6379` by default. Check the `redis.conf`
+file that comes with the sources if you want to change some settings.
+
+Usage
+-----
+
+`Stal` requires a [Redic][redic] compatible client. To make things
+easier, `redic` is listed as a runtime dependency so the examples
+in this document will work.
+
+```ruby
+require "stal"
+
+# Connect the client to the default host
+redis = Redic.new
+
+# Use the Redis client to populate some sets
+redis.call("SADD", "foo", "a", "b", "c")
+redis.call("SADD", "bar", "b", "c", "d")
+redis.call("SADD", "baz", "c", "d", "e")
+redis.call("SADD", "qux", "x", "y", "z")
+```
+
+Now we can perform some set operations with `Stal`:
+
+```ruby
+expr = [:union, "qux", [:diff, [:inter, "foo", "bar"], "baz"]]
+
+Stal.solve(redis, expr)
+#=> ["b", "x", "y", "z"]
+```
+
+`Stal` translates the shortcuts `:union`, `:diff` and `:inter` into
+`SDIFFSTORE`, `SINTERSTORE` and `SUNIONSTORE` to perform the
+underlying operations. You can also use the explicit command
+(lowercase works too).
+
+```ruby
+expr = [:SUNIONSTORE, "qux", [:SDIFFSTORE, [:SINTERSTORE, "foo", "bar"], "baz"]]
+
+Stal.solve(redis, expr)
+#=> ["b", "x", "y", "z"]
+```
+
+If you want to preview the commands `Stal` will send to generate
+the results, you can use `Stal.compile`:
+
+```ruby
+Stal.compile([:inter, [:union, "foo", "bar"], "baz"])
+#  [[:SUNIONSTORE, "stal:55f631dc-...", "foo", "bar"],
+#   [:SINTERSTORE,
+#    "stal:fe5aaec9-...",
+#    "stal:55f631dc-...",
+#    "baz"],
+#   [:SMEMBERS, "stal:fe5aaec9-..."],
+#   [:DEL,
+#    "stal:fe5aaec9-...",
+#    "stal:55f631dc-..."]]
+```
+
+All commands are pipelined and wrapped in a `MULTI/EXEC` transaction.
+The temporary keys, which have been shortened in the example, are
+deleted immediately.
+
+
+Installation
+------------
+
+```
+$ gem install stal
+```
+
+[redis]: http://redis.io
+[redic]: https://github.com/amakawa/redic

data/lib/stal.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+
+require "redic"
+require "securerandom"
+
+module Stal
+  ALIASES = {
+    :diff        => "SDIFFSTORE",
+    :inter       => "SINTERSTORE",
+    :union       => "SUNIONSTORE",
+  }
+
+  def self.tr(term)
+    ALIASES.fetch(term, term)
+  end
+
+  def self.compute(expr, ids, acc)
+    id = sprintf("stal:%s", SecureRandom.uuid)
+
+    # Keys we need to clean up later
+    ids.push(id)
+
+    # Add command with destination key
+    cmd = [tr(expr[0]), id]
+
+    expr[1..-1].each do |item|
+      if Array === item
+        cmd.push(compute(item, ids, acc))
+      else
+        cmd.push(item)
+      end
+    end
+
+    acc.push(cmd)
+
+    return id
+  end
+
+  def self.compile(expr)
+
+    # Commands to process
+    acc = []
+
+    # Keys to cleanup
+    ids = []
+
+    id = compute(expr, ids, acc)
+
+    acc.push([:SMEMBERS, id])
+    acc.push([:DEL, *ids])
+    acc
+  end
+
+  # Evaluate expression `expr` in the Redis client `c`.
+  def self.solve(c, expr)
+    operations = compile(expr)
+
+    c.queue("MULTI")
+
+    operations.each do |op|
+      c.queue(*op)
+    end
+
+    c.queue("EXEC")
+
+    # Return the result of SMEMBERS
+    c.commit[-1][-2]
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest -r ./test/helper.rb ./test/*.rb

data/stal.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name = "stal"
+  s.version = "0.0.1"
+  s.summary = %{Set algebra solver for Redis}
+  s.description = %Q{Stal receives s-expressions and resolves the set operations in Redis}
+  s.authors = ["Michel Martens"]
+  s.email = ["michel@soveran.com"]
+  s.homepage = "https://github.com/soveran/stal"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "redic"
+  s.add_development_dependency "cutest"
+end

data/test/all.rb

@@ -0,0 +1,37 @@
+require_relative "helper"
+
+setup do
+  Redic.new.tap do |c|
+    c.call("FLUSHDB")
+    c.call("SADD", "foo", "a", "b", "c")
+    c.call("SADD", "bar", "b", "c", "d")
+    c.call("SADD", "baz", "c", "d", "e")
+    c.call("SADD", "qux", "x", "y", "z")
+  end
+end
+
+test do |c|
+
+  # Shortcut syntax
+  expr = [:union, "qux", [:diff, [:inter, "foo", "bar"], "baz"]]
+
+  # Explicit syntax
+  expr = [:SUNIONSTORE, "qux", [:SDIFFSTORE, [:SINTERSTORE, "foo", "bar"], "baz"]]
+
+  assert_equal ["b", "x", "y", "z"], Stal.solve(c, expr).sort
+
+  # Explicit syntax with strings
+  expr = ["SUNIONSTORE", "qux", ["SDIFFSTORE", ["SINTERSTORE", "foo", "bar"], "baz"]]
+
+  assert_equal ["b", "x", "y", "z"], Stal.solve(c, expr).sort
+
+  # Explicit syntax with lowercase strings
+  expr = ["sunionstore", "qux", ["sdiffstore", ["sinterstore", "foo", "bar"], "baz"]]
+
+  assert_equal ["b", "x", "y", "z"], Stal.solve(c, expr).sort
+
+  assert_equal ["b", "x", "y", "z"], Stal.solve(c, expr).sort
+
+  # Verify there's no pollution
+  assert_equal ["bar", "baz", "foo", "qux"], c.call("KEYS", "*").sort
+end

data/test/helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/stal"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: stal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redic
+  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: cutest
+  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: Stal receives s-expressions and resolves the set operations in Redis
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- LICENSE
+- README.md
+- lib/stal.rb
+- makefile
+- stal.gemspec
+- test/all.rb
+- test/helper.rb
+homepage: https://github.com/soveran/stal
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Set algebra solver for Redis
+test_files: []