nest-redis 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba39bd9976d7c71cd6f78aabf7d793a13d869977
+  data.tar.gz: ad2c9222489edf0b207885279d80a6ebad123a66
+SHA512:
+  metadata.gz: 8091caf8e05ce72682eb9a024ebd9526ae52d899269ac8bc11f3a6a95c5457bbcc2d8e9fad3924566e455ea7a0ad01e480684ee50e5ca3955dcff27e6740a98a
+  data.tar.gz: 88978a2dcaf65c3d28a3780d29d087add69d5ba9271bb590096f9de0ccd44c9ad6221753d71ee79b70242becb1cb74c24c3e6a216d2ef98c17d99504ff121fd2

data/.gems

@@ -0,0 +1,2 @@
+redic -v 1.5.1
+cutest -v 1.2.3

data/.gitignore

@@ -0,0 +1 @@
+/pkg

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+## 3.1.2
+
+- Define to_json
+
+  This solves issues that arise when a third party library redefines
+  `to_json` for all objects.
+
+## 3.1.1
+
+- Define to_a and to_ary
+
+  These method definitions are needed for interacting with array-casting
+  operations like Array#flatten and Array().
+
+## 3.1.0
+
+- Forward missing methods to Redis as commands
+
+## 3.0.0
+
+- Use `call` for interacting with Redis
+
+  In previous versions, all the allowed Redis commands were defined
+  in Ruby. The downside of that approach was the fact Nest had to
+  be kept in sync with Redis as new commands were added to the
+  later. The new approach is more verbose, but the maintenance is
+  now close to non-existent.

data/CONTRIBUTING

@@ -0,0 +1,19 @@
+This code tries to solve a particular problem with a very simple
+implementation. We try to keep the code to a minimum while making
+it as clear as possible. The design is very likely finished, and
+if some feature is missing it is possible that it was left out on
+purpose. That said, new usage patterns may arise, and when that
+happens we are ready to adapt if necessary.
+
+A good first step for contributing is to meet us on IRC and discuss
+ideas. We spend a lot of time on #lesscode at freenode, always ready
+to talk about code and simplicity. If connecting to IRC is not an
+option, you can create an issue explaining the proposed change and
+a use case. We pay a lot of attention to use cases, because our
+goal is to keep the code base simple. Usually the result of a
+conversation is the creation of a different tool.
+
+Please don't start the conversation with a pull request. The code
+should come at last, and even though it may help to convey an idea,
+more often than not it draws the attention to a particular
+implementation.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Michel Martens & Damian Janowski
+
+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,163 @@
+nest-redis
+====
+
+Object Oriented Keys for Redis.
+
+Forewords:
+In our experience, redic based nest is suffering racing with thin server.
+We don't have time to reproduce it so I just swap redic with redis,
+hopefully it will solve our problem (by us stopped to see the racing
+issue)
+
+Require from your Gemfile
+-------------------------
+
+gem 'nest-redis', require: 'nest'
+
+Description
+-----------
+
+If you are familiar with databases like [Redis](http://redis.io)
+and libraries like [Ohm](http://ohm.keyvalue.org) you already know how
+important it is to craft the keys that will hold the data.
+
+```ruby
+>> redis = Redis.new
+>> redis.hset("Event:3", "name", "Redis Meetup")
+>> redis.hget("Event:3", "name")
+=> ["Redis Meetup"]
+```
+
+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://redis.io/topics/twitter-clone).
+
+Nest helps you generate those keys by providing chainable namespaces that are
+already connected to Redis:
+
+```ruby
+>> event = Nest.new("Event")
+>> event[3].call("HSET", "name", "Redis Meetup")
+>> event[3].call("HGET", "name")
+=> ["Redis Meetup"]
+```
+
+Alternatively, you can send the Redis commands as messages to Nest,
+and if the method definition is missing it will forward the command
+to Redis:
+
+```ruby
+>> event = Nest.new("Event")
+>> event[3].hset("name", "Redis Meetup")
+>> event[3].hget("name")
+=> ["Redis Meetup"]
+```
+
+Usage
+-----
+
+To create a new namespace:
+
+```ruby
+>> ns = Nest.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:
+
+```ruby
+>> ns[:bar][42]
+=> "foo:bar:42"
+```
+
+In a more realistic tone, lets assume you are working with Redis and
+dealing with events:
+
+```ruby
+>> event = Nest.new("Event")
+=> "Event"
+
+>> id = event[:id].incr
+=> 1
+
+>> event[id].hset("name", "Redis Meetup")
+=> 1
+
+>> meetup = event[id]
+=> "Event:1"
+
+>> meetup.hget("name")
+=> ["Redis Meetup"]
+```
+
+Supplying your existing Redis instance
+--------------------------------------
+
+You can supply a [Redis](https://github.com/amakawa/redic) instance as
+a second parameter. If you don't, a default instance is created for you:
+
+```ruby
+>> redis = Redis.new(url: "redis://localhost:6379")
+=> #<Redis:0x007fa640845f10 ...>
+
+>> event = Nest.new("Event", redis)
+=> "Event"
+
+>> event[:id].call("TYPE")
+=> "string"
+```
+
+`Nest` objects respond to `redis` and return a `Redis` instance. It is
+automatically reused when you create a new namespace, and you can reuse it when
+creating a new instance of Nest:
+
+```ruby
+>> event = Nest.new("Event", meetup.redis)
+=> "Event"
+```
+
+Nest allows you to execute all the Redis commands that expect a key as the
+first parameter. If you use any other command, the result can be unexpected.
+
+Differences with redis-namespace
+--------------------------------
+
+[redis-namespace](http://github.com/defunkt/redis-namespace) wraps Redis
+and translates the keys back and forth transparently.
+
+Use redis-namespace when you want all your application keys to live in a
+different scope.
+
+Use Nest when you want to use the keys to represent structure.
+
+Tip: instead of using redis-namespace, it is recommended that you run a
+different instance of `redis-server`. Translating keys back and forth is not
+only delicate, but unnecessary and counterproductive.
+
+Differences with Ohm
+--------------------
+
+[Ohm](http://ohm.keyvalue.org) lets you map Ruby objects to Redis with
+little effort. It not only alleviates you from the pain of generating
+keys for each object, but also helps you when dealing with references
+between objects.
+
+Use Ohm when you want to use Redis as your database.
+
+Use Nest when mapping objects with Ohm is not possible or overkill.
+
+Tip: Ohm uses Nest internally to deal with keys. Having a good knowledge
+of Nest will let you extend Ohm to suit your needs.
+
+Installation
+------------
+
+```
+$ gem install nest
+```

data/lib/nest.rb

@@ -0,0 +1,67 @@
+# Copyright (c) 2010 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.
+#
+require "redis"
+
+class Nest
+  def initialize(ns, rc = Redis.new)
+    @ns = ns.to_s
+    @rc = rc
+  end
+
+  def [](key)
+    Nest.new("#{@ns}:#{key}", @rc)
+  end
+
+  def redis
+    @rc
+  end
+
+  def hash
+    @ns.hash
+  end
+
+  def to_ary
+    nil
+  end
+
+  def to_str
+    @ns
+  end
+
+  alias to_s to_str
+  alias to_a to_ary
+
+  def to_json(*args)
+    @ns.to_json(*args)
+  end
+
+  def call(command, *args)
+    @rc.call(command, to_s, *args)
+  end
+
+  def inspect
+    @ns.inspect
+  end
+
+  def method_missing(m, *args)
+    call(m, *args)
+  end
+end

data/makefile

@@ -0,0 +1,7 @@
+.PHONY: test
+
+test:
+	cutest ./test/*.rb
+
+console:
+	irb -r ./lib/nest

data/nest-redis.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name              = "nest-redis"
+  s.version           = "4.0.0"
+  s.summary           = "Object-oriented keys for Redis."
+  s.description       = "It is a design pattern in key-value databases to use the key to simulate structure, and Nest can take care of that."
+  s.license           = "MIT"
+  s.authors           = ["Michel Martens", "Phuong Nguyen"]
+  s.email             = ["michel@soveran.com", "phuongnd08@gmail.com"]
+  s.homepage          = "http://github.com/remitano/nest-redis"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "redis"
+  s.add_development_dependency "cutest"
+end

data/test/helper.rb

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

data/test/nest_test.rb

@@ -0,0 +1,108 @@
+require_relative "helper"
+
+# Creating namespaces.
+scope do
+  test "return the namespace" do
+    n1 = Nest.new("foo", Redis.new)
+    assert "foo" == n1.to_s
+  end
+
+  test "prepend the namespace" do
+    n1 = Nest.new("foo")
+    assert "foo:bar" == n1["bar"].to_s
+  end
+
+  test "work in more than one level" do
+    n1 = Nest.new("foo")
+    n2 = Nest.new(n1["bar"])
+    assert "foo:bar:baz" == n2["baz"].to_s
+  end
+
+  test "be chainable" do
+    n1 = Nest.new("foo")
+    assert "foo:bar:baz" == n1["bar"]["baz"].to_s
+  end
+
+  test "accept symbols" do
+    n1 = Nest.new(:foo)
+    assert "foo:bar" == n1[:bar].to_s
+  end
+
+  test "accept numbers" do
+    n1 = Nest.new("foo")
+    assert "foo:3" == n1[3].to_s
+  end
+end
+
+# Operating with Redis.
+scope do
+  prepare do
+    @redis = Redis.new
+    @redis.call("FLUSHDB")
+  end
+
+  test "work if no redis instance was passed" do
+    n1 = Nest.new("foo")
+    n1.call("SET", "s1")
+
+    assert "s1" == n1.call("GET")
+  end
+
+  test "work if a redis instance is supplied" do
+    n1 = Nest.new("foo", @redis)
+    n1.call("SET", "s1")
+
+    assert "s1" == n1.call("GET")
+  end
+
+  test "pass the redis instance to new keys" do
+    n1 = Nest.new("foo", @redis)
+
+    assert @redis.object_id == n1["bar"].redis.object_id
+  end
+end
+
+
+# Operating with Redis with dynamic methods.
+scope do
+  prepare do
+    @redis = Redis.new
+    @redis.call("FLUSHDB")
+  end
+
+  test "relay missing methods as Redis commands" do
+    n1 = Nest.new("foo")
+    n1.set("s1")
+
+    assert "s1" == n1.get
+  end
+end
+
+# Operations that call to_a and to_ary
+scope do
+  test "interaction with array-casting operations" do
+    n1 = Nest.new("foo")
+
+    assert_equal [n1], [n1].flatten
+    assert_equal [n1],  Array(n1)
+  end
+end
+
+# Operations that call to_str and to_ary
+scope do
+  test "interaction with string-casting operations" do
+    n1 = Nest.new("foo")
+    s1 = "bar"
+
+    s2 = s1 + n1
+
+    assert_equal "barfoo", s1 + n1
+  end
+
+  test "interaction with array-casting operations" do
+    n1 = Nest.new("foo")
+
+    assert_equal [n1], [n1].flatten
+    assert_equal [n1],  Array(n1)
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: nest-redis
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Michel Martens
+- Phuong Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: It is a design pattern in key-value databases to use the key to simulate
+  structure, and Nest can take care of that.
+email:
+- michel@soveran.com
+- phuongnd08@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- ".gitignore"
+- CHANGELOG.md
+- CONTRIBUTING
+- LICENSE
+- README.md
+- lib/nest.rb
+- makefile
+- nest-redis.gemspec
+- test/helper.rb
+- test/nest_test.rb
+homepage: http://github.com/remitano/nest-redis
+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.2
+signing_key: 
+specification_version: 4
+summary: Object-oriented keys for Redis.
+test_files: []