nido 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b6ace7778462d82d73a638d2620395e436241eb
+  data.tar.gz: 1661f54773ccd18e5de06478d6ff07aa9158e811
+SHA512:
+  metadata.gz: 9aef52e92c6cd4c4886ad37885c05098a8d0075ba5ae3bfabbc1973a5a470d0bad3ad741d03e9abcb3b530dd659c4e8953eeb1aa303686d9b54a337fb3b3ffca
+  data.tar.gz: e8b2fed1af1445c2ade7a3644250f35d95d04606c62fabfa352b340b450bdbf5a0e677f69379ac4d07b4b48669483f406e79e6a9becdfc121244a4a024362dc0

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 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,70 @@
+Nido
+====
+
+Structured keys helper.
+
+Description
+-----------
+
+If you are familiar with databases like [Redis](http://code.google.com/p/redis)
+and libraries like [Ohm](http://ohm.keyvalue.org) you already know how
+important it is to craft the keys that will hold the data.
+
+    >> redis = Redis.new
+    >> redis.sadd("event:3:attendees", "Albert")
+    >> redis.smembers("event:3:attendees")
+    => ["Albert"]
+
+It is a design pattern in key-value databases to use the key to simulate
+structure, and you can read more about this in the [case study for a
+Twitter clone](http://code.google.com/p/redis/wiki/TwitterAlikeExample).
+
+Nido helps you generate those keys by providing chainable namespaces:
+
+    >> r = Redis.new
+    >> event = Nido.new("event")
+    >> r.sadd(event[3][:attendees], "Albert")
+    >> r.smembers(event[3][:attendees])
+    => ["Albert"]
+
+Usage
+-----
+
+To create a new namespace:
+
+    >> ns = Nido.new("foo")
+    => "foo"
+
+    >> ns["bar"]
+    => "foo:bar"
+
+    >> ns["bar"]["baz"]["qux"]
+    => "foo:bar:baz:qux"
+
+And you can use any object as a key, not only strings:
+
+    >> ns[:bar][42]
+    => "foo:bar:42"
+
+In a more realistic tone, lets assume you are working with Redis and
+dealing with events:
+
+    >> events = Nido.new("events")
+    => "events"
+
+    >> id = r.incr(events[:id])
+    => 1
+
+    >> r.sadd(events[id][:attendees], "Albert")
+    => "OK"
+
+    >> meetup = events[id]
+    => "events:1"
+
+    >> r.smembers(meetup[:attendees])
+    => ["Albert"]
+
+Installation
+------------
+
+    $ gem install nido

data/Rakefile

@@ -0,0 +1,6 @@
+task :test do
+  require "cutest"
+  Cutest.run(Dir["test/nido*"])
+end
+
+task :default => :test

data/lib/nido.rb

@@ -0,0 +1,9 @@
+class Nido < String
+  def initialize(key)
+    super(key.to_s)
+  end
+
+  def [](key)
+    self.class.new("#{self}:#{key}")
+  end
+end

data/nido.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name              = "nido"
+  s.version           = "0.0.1"
+  s.summary           = "Structured keys helper"
+  s.description       = "It is a design pattern in key-value databases to use the key to simulate structure, and Nido can take care of that."
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "http://github.com/soveran/nido"
+
+  s.files = Dir[
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_development_dependency "cutest"
+end

data/test/nido_test.rb

@@ -0,0 +1,35 @@
+require_relative "../lib/nido.rb"
+
+# Creating namespaces.
+scope do
+  test "return the namespace" do
+    n1 = Nido.new("foo")
+    assert "foo" == n1
+  end
+
+  test "prepend the namespace" do
+    n1 = Nido.new("foo")
+    assert "foo:bar" == n1["bar"]
+  end
+
+  test "work in more than one level" do
+    n1 = Nido.new("foo")
+    n2 = Nido.new(n1["bar"])
+    assert "foo:bar:baz" == n2["baz"]
+  end
+
+  test "be chainable" do
+    n1 = Nido.new("foo")
+    assert "foo:bar:baz" == n1["bar"]["baz"]
+  end
+
+  test "accept symbols" do
+    n1 = Nido.new(:foo)
+    assert "foo:bar" == n1[:bar]
+  end
+
+  test "accept numbers" do
+    n1 = Nido.new("foo")
+    assert "foo:3" == n1[3]
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: nido
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !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: It is a design pattern in key-value databases to use the key to simulate
+  structure, and Nido can take care of that.
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/nido.rb
+- nido.gemspec
+- test/nido_test.rb
+homepage: http://github.com/soveran/nido
+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: Structured keys helper
+test_files: []