rediscan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55923a1180bce348df51b1dfa0a29bf4ea229bd8
+  data.tar.gz: 35c0664c69da14d97b43c84b1d9a4d58c5d1b7ac
+SHA512:
+  metadata.gz: 7c1d1e175655b6b5eca476739919816d69dcf4567a5acb4e4fcf88d8291c0f538fecaac21c36030094e78dfedf29dec3d97b759341bcc9b19d32f319666af6ac
+  data.tar.gz: 45757631d3b2a89d518a336f2b6527b04467db82f2f74c88efa9a6c54ce6a7157f510c1326aa879a1cb445a41bbe1798376d58e7bbc0d62b0b7e2aa8c2e01f5b

data/.gems

@@ -0,0 +1,3 @@
+cutest -v 1.2.0
+hiredis -v 0.4.5
+redic -v 1.0.1

data/.gitignore

@@ -0,0 +1 @@
+/.gs

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,52 @@
+Rediscan
+========
+
+Scanner for Redis keyspace
+
+Description
+-----------
+
+Rediscan lets you iterate over the Redis keyspace and execute a
+block for each match.
+
+Usage
+-----
+
+You need to suply a Redis client. There are no restrictions
+regarding the type of the Redis client, but it must respond to
+`call` and the signature must be identical to that of
+[Redic][redic].
+
+```ruby
+r = Rediscan.new(Redic.new)
+```
+
+Once you have the `Rediscan` instance, you can use it as follows:
+
+```ruby
+r.each do |key|
+  # Do something with `key`
+end
+```
+
+You can also provide `match` and `count` arguments:
+
+```ruby
+r.each(match: "ost:*", count: 4) do |key|
+  # Do something with `key`
+end
+```
+
+For the meaning for `match` and `count`, check the documentation
+for the [SCAN command][scan]
+
+## Installation
+
+You can install it using rubygems.
+
+```
+$ gem install rediscan
+```
+
+[redic]: https://github.com/amakawa/redic
+[scan]: http://redis.io/commands/scan

data/lib/rediscan.rb

@@ -0,0 +1,20 @@
+class Rediscan
+  def initialize(redis)
+    @redis = redis
+    @cursor = "0"
+  end
+
+  def each(match: nil, count: nil, &block)
+    done = false
+    args = []
+    args.push("MATCH", match) if match
+    args.push("COUNT", count) if count
+
+    until done
+      @cursor, keys = @redis.call("SCAN", @cursor, *args)
+      done = @cursor == "0"
+
+      keys.each(&block)
+    end
+  end
+end

data/makefile

@@ -0,0 +1,2 @@
+test:
+	RUBYLIB=./lib cutest tests/*.rb

data/rediscan.gemspec

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name              = "rediscan"
+  s.version           = "0.0.1"
+  s.summary           = "Scanner for Redis keyspace"
+  s.description       = "Scanner for Redis keyspace"
+  s.authors           = ["Michel Martens"]
+  s.email             = ["michel@soveran.com"]
+  s.homepage          = "https://github.com/soveran/rediscan"
+  s.files             = `git ls-files`.split("\n")
+  s.license           = "MIT"
+
+  s.add_dependency "redic"
+end

data/tests/rediscan_test.rb

@@ -0,0 +1,24 @@
+require_relative "../lib/rediscan"
+
+REDIS_URL = "redis://localhost:6379/3"
+
+prepare do
+  Redic.new(REDIS_URL).call("FLUSHDB")
+end
+
+setup do
+  c = Redic.new(REDIS_URL)
+  s = Rediscan.new(c)
+
+  [c, s]
+end
+
+test do |c, s|
+  assert_equal 0, c.call("DBSIZE")
+
+  c.call("SET", "ost:1", "1")
+
+  s.each(match: "ost:*", count: 10) do |key|
+    assert_equal "ost:1", key
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rediscan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-07 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'
+description: Scanner for Redis keyspace
+email:
+- michel@soveran.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gems
+- .gitignore
+- LICENSE
+- README.md
+- lib/rediscan.rb
+- makefile
+- rediscan.gemspec
+- tests/rediscan_test.rb
+homepage: https://github.com/soveran/rediscan
+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.3
+signing_key: 
+specification_version: 4
+summary: Scanner for Redis keyspace
+test_files: []