redis-classy 0.9.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "redis-namespace", "~> 0.10.0"
+
+group :development do
+  gem "rspec", "~> 2.5.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    redis (2.1.1)
+    redis-namespace (0.10.0)
+      redis (< 3.0.0)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  redis-namespace (~> 0.10.0)
+  rspec (~> 2.5.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kenn Ejima
+
+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.rdoc

@@ -0,0 +1,75 @@
+= Redis Classy
+
+Model-friendly base class for Redis.
+
+With this library, the class name of your model becomes the prefix part of the Redis keys.
+
+This library contains only 27 lines of code, yet powerful when you need more abstraction on Redis objects rather than dealing with complicated keys in all strings.
+
+Requies the redis-namespace gem.
+
+== Install
+
+ gem install redis-classy
+
+== Usage
+
+In Gemfile:
+
+ gem "redis-classy"
+
+In your initializer:
+
+ Redis::Classy.db = Redis.new
+
+Now you can write models that inherit the Redis::Classy class, automatically prefixing keys with its class name.
+
+ class UniqueUser < Redis::Classy
+   def self.nuke
+     self.keys.each{|key| self.del(key) }
+   end
+ end
+ 
+ UniqueUser.sadd "2011-02-28", @user_a.id
+ UniqueUser.sadd "2011-02-28", @user_b.id
+ UniqueUser.sadd "2011-03-01", @user_c.id
+ 
+ UniqueUser.smembers "2011-02-28"
+ => ["123", "456"]
+ 
+ UniqueUser.nuke
+ => ["2011-02-28", "2011-03-01"]
+ 
+ UniqueUser.keys
+ => []
+
+In most cases you may be just fine with class methods, but by creating an instance with a key, even further binding is possible.
+
+ class Counter < Redis::Classy
+   def initialize(object)
+     super("#{object.class.name}:#{object.id}")
+   end
+ end
+ 
+ counter = Counter.new(@room)
+ counter.incr
+ counter.incr
+ counter.get
+ => "2"
+ 
+ counter.key
+ => "Room:123"
+
+You also have access to the non-namespaced, raw Redis instance via Redis::Classy.db
+
+ Redis::Classy.db.keys "UniqueUser:*"
+ => ["UniqueUser:2011-02-28", "UniqueUser:2011-03-01"]
+ 
+ Redis::Classy.db.multi do
+   UniqueUser.sadd "2011-02-28", @user_a.id
+   UniqueUser.sadd "2011-02-28", @user_b.id
+ end
+
+Since the "db" attribute is a class instance variable, you can dynamically assign different databases for each class.
+
+ UniqueUser.db = Redis::Namespace.new("UniqueUser", :redis => Redis.new(:host => "another.host"))

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "redis-classy"
+  gem.homepage = "http://github.com/kenn/redis-classy"
+  gem.license = "MIT"
+  gem.summary = "Model-friendly base class for Redis"
+  gem.description = "Make the prefix part of the Redis keys a class name for your model."
+  gem.email = "kenn.ejima@gmail.com"
+  gem.authors = ["Kenn Ejima"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redis-classy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.9.0

data/lib/redis/classy.rb

@@ -0,0 +1,27 @@
+require 'redis-namespace'
+
+class Redis
+  class Classy
+    class << self
+      attr_accessor :db
+
+      def inherited(subclass)
+        subclass.db = Redis::Namespace.new(subclass.name, :redis => self.db)
+      end
+
+      def method_missing(method_name, *args)
+        self.db.send(method_name, *args)
+      end
+    end
+
+    attr_accessor :key
+
+    def initialize(key)
+      self.key = key
+    end
+
+    def method_missing(method_name, *args)
+      self.class.send(method_name, self.key, *args)
+    end
+  end
+end

data/lib/redis-classy.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/redis/classy'

data/redis-classy.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{redis-classy}
+  s.version = "0.9.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kenn Ejima"]
+  s.date = %q{2011-02-28}
+  s.description = %q{Make the prefix part of the Redis keys a class name for your model.}
+  s.email = %q{kenn.ejima@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/redis-classy.rb",
+    "lib/redis/classy.rb",
+    "redis-classy.gemspec",
+    "spec/redis-classy_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kenn/redis-classy}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.3}
+  s.summary = %q{Model-friendly base class for Redis}
+  s.test_files = [
+    "spec/redis-classy_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<redis-namespace>, ["~> 0.10.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<redis-namespace>, ["~> 0.10.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<redis-namespace>, ["~> 0.10.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/spec/redis-classy_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RedisClassy" do
+  pending "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'redis-classy'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: redis-classy
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Kenn Ejima
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-28 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis-namespace
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Make the prefix part of the Redis keys a class name for your model.
+email: kenn.ejima@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis-classy.rb
+- lib/redis/classy.rb
+- redis-classy.gemspec
+- spec/redis-classy_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kenn/redis-classy
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 1153223303982788264
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Model-friendly base class for Redis
+test_files: 
+- spec/redis-classy_spec.rb
+- spec/spec_helper.rb