nest 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8ed6349c656cd7f0a6e5af473c0ac0bcbf6a3d0
-  data.tar.gz: e1eb3fe26126cb919e9dae57a450d0f425d56c9c
+  metadata.gz: 1aceadee837f1ac2bba7fd3840c7c35ffadf777f
+  data.tar.gz: e82ff489cdde15c5edbe643d64c1a99e80a13d21
 SHA512:
-  metadata.gz: 05b3e1fc3c0180f154b2b8788bf5764dfdfd777ce93db6f8122a46b38e3c131797d88a0f5523b5283fdb5a4b0ea97f4c6aba1b2718aca6c53ec7760e0caacf54
-  data.tar.gz: b3d86e1b501fa9420a1feb7a68613fe7db35a9ede69a8134b40225a91c1c3f7949b7f70b529b88a6b9817140e37f1781a7ed56204cfe0f99e7b3eb2944d34d7b
+  metadata.gz: 2a07fe72c0f5f84a2460767986a3b084a6b5a47bf79cf74841d1c5c34b427c2d321f63f76f81afc36651fa372f77281c0715e5b1ddac04ef94d8befcf4fc5254
+  data.tar.gz: 788ffc225cc8cf912fa628e949cab221c717cc72628be46f640acfee3a904972886748bfb96bb4cffab5beff1a62b8719b06ec2c6f4695458e4db9347bb5c210

data/.gems

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

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 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

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Michel Martens & Damian Janowski
+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

data/README.md

@@ -12,9 +12,9 @@ important it is to craft the keys that will hold the data.
 
 ```ruby
 >> redis = Redic.new
->> redis.call("SADD", "event:3:attendees", "Albert")
->> redis.call("SMEMBERS", "event:3:attendees")
-=> ["Albert"]
+>> redis.call("HSET", "Event:3", "name", "Redis Meetup")
+>> redis.call("HGET", "Event:3", "name")
+=> ["Redis Meetup"]
 ```
 
 It is a design pattern in key-value databases to use the key to simulate
@@ -25,10 +25,10 @@ Nest helps you generate those keys by providing chainable namespaces that are
 already connected to Redis:
 
 ```ruby
->> event = Nest.new("event")
->> event[3][:attendees].sadd("Albert")
->> event[3][:attendees].smembers
-=> ["Albert"]
+>> event = Nest.new("Event")
+>> event[3].call("HSET", "name", "Redis Meetup")
+>> event[3].call("HGET", "name")
+=> ["Redis Meetup"]
 ```
 
 Usage
@@ -58,20 +58,20 @@ In a more realistic tone, lets assume you are working with Redis and
 dealing with events:
 
 ```ruby
->> events = Nest.new("events")
-=> "events"
+>> event = Nest.new("Event")
+=> "Event"
 
->> id = events[:id].incr
+>> id = event[:id].call("INCR")
 => 1
 
->> events[id][:attendees].sadd("Albert")
-=> "OK"
+>> event[id].call("HSET", "name", "Redis Meetup")
+=> 1
 
->> meetup = events[id]
-=> "events:1"
+>> meetup = event[id]
+=> "Event:1"
 
->> meetup[:attendees].smembers
-=> ["Albert"]
+>> meetup.call("HGET", "name")
+=> ["Redis Meetup"]
 ```
 
 Supplying your existing Redis instance
@@ -84,14 +84,11 @@ a second parameter. If you don't, a default instance is created for you:
 >> redis = Redic.new("redis://localhost:6379")
 => #<Redic:0x007fa640845f10 ...>
 
->> users = Nest.new("users", redis)
-=> "users"
-
->> id = users[:id].incr
-=> 1
+>> event = Nest.new("Event", redis)
+=> "Event"
 
->> users[id].hset(:name, "Albert")
-=> "OK"
+>> event[:id].call("TYPE")
+=> "string"
 ```
 
 `Nest` objects respond to `redis` and return a `Redic` instance. It is
@@ -99,24 +96,12 @@ automatically reused when you create a new namespace, and you can reuse it when
 creating a new instance of Nest:
 
 ```ruby
->> events = Nest.new("events", meetup.redis)
-=> "events"
-
->> events.sadd(meetup)
-=> true
-
->> events.sismember(meetup)
-=> true
-
->> events.smembers
-=> ["events:1"]
-
->> events.del
->> true
+>> event = Nest.new("Event", meetup.redis)
+=> "Event"
 ```
 
 Nest allows you to execute all the Redis commands that expect a key as the
-first parameter.
+first parameter. If you use any other command, the result can be unexpected.
 
 Differences with redis-namespace
 --------------------------------

data/lib/nest.rb

@@ -1,40 +1,52 @@
+# 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 "redic"
 
-class Nest < String
-  METHODS = [:append, :bitcount, :bitfield, :bitpos, :blpop, :brpop,
-    :brpoplpush, :decr, :decrby, :del, :dump, :exists, :expire,
-    :expireat, :geoadd, :geohash, :geopos, :geodist, :georadius,
-    :georadiusbymember, :get, :getbit, :getrange, :getset, :hdel,
-    :hexists, :hget, :hgetall, :hincrby, :hincrbyfloat, :hkeys, :hlen,
-    :hmget, :hmset, :hset, :hsetnx, :hstrlen, :hvals, :incr, :incrby,
-    :incrbyfloat, :lindex, :linsert, :llen, :lpop, :lpush, :lpushx,
-    :lrange, :lrem, :lset, :ltrim, :move, :persist, :pexpire, :pexpireat,
-    :pfadd, :pfcount, :pfmerge, :psetex, :pttl, :publish, :rename,
-    :renamenx, :restore, :rpop, :rpoplpush, :rpush, :rpushx, :sadd,
-    :scard, :sdiff, :sdiffstore, :set, :setbit, :setex, :setnx,
-    :setrange, :sinter, :sinterstore, :sismember, :smembers, :smove,
-    :sort, :spop, :srandmember, :srem, :strlen, :subscribe, :sunion,
-    :sunionstore, :touch, :ttl, :type, :unsubscribe, :watch, :zadd,
-    :zcard, :zcount, :zincrby, :zinterstore, :zlexcount, :zrange,
-    :zrangebylex, :zrevrangebylex, :zrangebyscore, :zrank, :zrem,
-    :zremrangebylex, :zremrangebyrank, :zremrangebyscore, :zrevrange,
-    :zrevrangebyscore, :zrevrank, :zscore, :zunionstore, :sscan,
-    :hscan, :zscan]
+class Nest
+  def initialize(ns, rc = Redic.new)
+    @ns = ns.to_s
+    @rc = rc
+  end
 
-  attr :redis
+  def [](key)
+    Nest.new("#{@ns}:#{key}", @rc)
+  end
 
-  def initialize(key, redis = Redic.new)
-    super(key.to_s)
-    @redis = redis
+  def redis
+    @rc
+  end
+  
+  def hash
+    @ns.hash
   end
 
-  def [](key)
-    self.class.new("#{self}:#{key}", redis)
+  def to_s
+    @ns
+  end
+
+  def call(command, *args)
+    @rc.call(command, to_s, *args)
   end
 
-  METHODS.each do |meth|
-    define_method(meth) do |*args|
-      redis.call(meth, self, *args)
-    end
+  def inspect
+    @ns.inspect
   end
 end

data/makefile

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

data/nest.gemspec

@@ -1,23 +1,15 @@
 Gem::Specification.new do |s|
   s.name              = "nest"
-  s.version           = "2.1.0"
+  s.version           = "3.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.licenses          = ["MIT"]
+  s.license           = "MIT"
   s.authors           = ["Michel Martens"]
   s.email             = ["michel@soveran.com"]
   s.homepage          = "http://github.com/soveran/nest"
 
+  s.files = `git ls-files`.split("\n")
+  
   s.add_dependency "redic"
-
-  s.files = Dir[
-    "LICENSE",
-    "README.md",
-    "Rakefile",
-    "lib/**/*.rb",
-    "*.gemspec",
-    "test/*.*"
-  ]
-
   s.add_development_dependency "cutest"
 end

data/test/nest_test.rb

@@ -3,34 +3,34 @@ require_relative "helper"
 # Creating namespaces.
 scope do
   test "return the namespace" do
-    n1 = Nest.new("foo")
-    assert "foo" == n1
+    n1 = Nest.new("foo", Redic.new)
+    assert "foo" == n1.to_s
   end
 
   test "prepend the namespace" do
     n1 = Nest.new("foo")
-    assert "foo:bar" == n1["bar"]
+    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"]
+    assert "foo:bar:baz" == n2["baz"].to_s
   end
 
   test "be chainable" do
     n1 = Nest.new("foo")
-    assert "foo:bar:baz" == n1["bar"]["baz"]
+    assert "foo:bar:baz" == n1["bar"]["baz"].to_s
   end
 
   test "accept symbols" do
     n1 = Nest.new(:foo)
-    assert "foo:bar" == n1[:bar]
+    assert "foo:bar" == n1[:bar].to_s
   end
 
   test "accept numbers" do
     n1 = Nest.new("foo")
-    assert "foo:3" == n1[3]
+    assert "foo:3" == n1[3].to_s
   end
 end
 
@@ -43,16 +43,16 @@ scope do
 
   test "work if no redis instance was passed" do
     n1 = Nest.new("foo")
-    n1.set("s1")
+    n1.call("SET", "s1")
 
-    assert "s1" == n1.get
+    assert "s1" == n1.call("GET")
   end
 
   test "work if a redis instance is supplied" do
     n1 = Nest.new("foo", @redis)
-    n1.set("s1")
+    n1.call("SET", "s1")
 
-    assert "s1" == n1.get
+    assert "s1" == n1.call("GET")
   end
 
   test "pass the redis instance to new keys" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nest
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Michel Martens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-02 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redic
@@ -46,10 +46,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gems"
+- ".gitignore"
+- CHANGELOG.md
+- CONTRIBUTING
 - LICENSE
 - README.md
-- Rakefile
 - lib/nest.rb
+- makefile
 - nest.gemspec
 - test/helper.rb
 - test/nest_test.rb

data/Rakefile

@@ -1,39 +0,0 @@
-task :test do
-  require "cutest"
-  Cutest.run(Dir["test/nest*"])
-end
-
-task :default => :test
-
-task :commands do
-  require "open-uri"
-  require "json"
-
-  file = File.expand_path("lib/nest.rb", File.dirname(__FILE__))
-  path = "https://github.com/antirez/redis-doc/raw/master/commands.json"
-
-  commands = JSON.parse(open(path).read).select do |name, command|
-    # Skip all DEBUG commands
-    next if command["group"] == "server"
-
-    # If the command has no arguments, it doesn't operate on a key
-    next if command["arguments"].nil?
-
-    arg = command["arguments"].first
-
-    arg["type"] == "key" ||
-      Array(arg["name"]) == ["channel"]
-  end
-
-  commands = commands.keys.map { |key| key.downcase.to_sym }
-
-  commands.delete(:mget)
-
-  source = File.read(file).sub(/  METHODS = .+?\n\n/m) do
-    "  METHODS = #{commands.inspect}\n\n"
-  end
-
-  File.open(file, "w") { |f| f.write source }
-
-  system "git diff --color-words #{file}"
-end