ook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6f958c7bf8f4e80086d023c35343110f5765041
+  data.tar.gz: ddc6d658b56fc63e8f81a78e6af09a9479f305bd
+SHA512:
+  metadata.gz: 6dfef27e8180bdcf50de1edf8341b10662b4a6d5ebd49bd42416778118ac2ea3a61903aef1ec7da3c19270486b8ad4da4b866293248918be6dcb4647d72256d9
+  data.tar.gz: 2dd61beebbd4a498b3b6ac3b9b4a620c159d72b621221c51b5b43bf3f71707cbae2f68596e6f8272cd4839cb8109afc18453da395bfe04d5d0dc37988512e7ec

data/.gems

@@ -0,0 +1,3 @@
+cutest -v 1.2.1
+nido -v 0.0.1
+redic -v 1.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 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,59 @@
+Ook
+===
+
+Object Oriented Keys for Redis.
+
+Description
+-----------
+
+Interact with [Redis][redis] keys in an object oriented way.
+
+```ruby
+# Create an instance of Ook by passing
+# a Redis client and a key.
+k = Ook.new(Redic.new, "foo")
+
+# As it depends on [Nido][nido], you can
+# append strings to the original namespace:
+k["bar"]["baz"].to_s #=> "foo:bar:baz"
+
+# And if you call Redis commands on it,
+# the key will be inserted as the second
+# parameter when sent to the Redis client:
+k.call("SET", 42") # SET foo 42
+k.call("GET")      # GET foo
+```
+
+Usage
+-----
+
+The external API is very similar to that of [Nido][nido], but in
+addition you need to suply a Redis client. For a compatible
+client, check [Redic][redic].
+
+```ruby
+ns = Ook.new(Redic.new, "foo")
+
+ns["bar"]["baz"].call("LPUSH", "42")
+ns["bar"]["baz"].call("LLEN") #=> 1
+
+ns2 = ns["bar"]["baz"]
+ns2.call("LLEN") #=> 1
+```
+
+And you can use any object as a key, not only strings:
+
+```ruby
+ns[:bar][42] #=> "foo:bar:42"
+```
+
+[nido]: https://github.com/soveran/nido
+[redic]: https://github.com/amakawa/redic
+[redis]: http://redis.io
+
+Installation
+------------
+
+```
+$ gem install ook
+```

data/lib/ook.rb

@@ -0,0 +1,32 @@
+require "nido"
+
+class Ook
+
+  # The Redis client can be swapped at any point.
+  attr_accessor :redis
+
+  # Receive a Redis client and a key. There are no restrictions
+  # regardin the type of the Redis client, but it must respond to
+  # `call` and the signature must be identical to that of Redic.
+  def initialize(redis, key)
+    @ns = Nido.new(key)
+    @redis = redis
+  end
+
+  # The passed key will be appended to the previous namespace.
+  def [](key)
+    @ns = @ns[key]
+    self
+  end
+
+  # Return an instance of Nido with the current value.
+  def to_s
+    @ns
+  end
+
+  # Call commands on the Redis client after inserting the key
+  # in the second position. Return the result of the command.
+  def call(cmd, *args)
+    @redis.call(cmd, @ns, *args)
+  end
+end

data/makefile

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

data/ook.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name              = "ook"
+  s.version           = "0.0.1"
+  s.summary           = "Object Oriented Keys for Redis"
+  s.description       = "Call Redis commands on keys created with Nido"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "http://github.com/soveran/ook"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "nido"
+
+  s.add_development_dependency "cutest"
+end

data/test/ook_test.rb

@@ -0,0 +1,24 @@
+require "redic"
+require_relative "../lib/ook.rb"
+
+scope do
+  test "namespaces" do
+    k1 = Ook.new(Redic.new, "foo")
+
+    assert_equal "foo:bar", k1["bar"].to_s
+  end
+
+  test "call Redis commands on Redic instance" do
+    k1 = Ook.new(Redic.new, "foo")
+
+    assert_equal "OK", k1.call("SET", 42)
+    assert_equal "42", k1.call("GET")
+  end
+
+  test "swap Redis client" do
+    k1 = Ook.new(Redic.new, "foo")
+    k1.redis = Redic.new
+
+    assert_equal "foo", k1.call("ECHO")
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: ook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nido
+  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: Call Redis commands on keys created with Nido
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- LICENSE
+- README.md
+- lib/ook.rb
+- makefile
+- ook.gemspec
+- test/ook_test.rb
+homepage: http://github.com/soveran/ook
+licenses: []
+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.3
+signing_key: 
+specification_version: 4
+summary: Object Oriented Keys for Redis
+test_files: []