redis-aid 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+coverage
+rdoc
+pkg
+*.rdb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss 'nu7hatch' Kowalik
+
+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,59 @@
+= Redis Aid
+
+Small lib which helps with extending your classes or modules with redis (and nest) goodies.
+
+== Installation
+
+From rubygems:
+
+  gem install redis-aid # with sudo if necessary
+
+== Examples
+
+You can configure global redis connection:
+
+  Redis::Aid.redis = Redis.new
+
+Simple usage:
+
+  class MyClass
+    include Redis::Aid
+
+    def foo
+      redis.get(:foo)
+    end
+  end
+
+Powered by nest: 
+
+  class MySecondClass
+    include Redis::Aid::Ns(:foo)
+
+    def bar
+      redis[:bar].get # => value of 'foo:bar'
+    end
+
+    def spam_and_eggs
+      redis[:spam][:eggs].get # => value of 'foo:spam:eggs'
+    end
+
+Custom redis connection for each class? No problem:
+
+  class MyThirdClass
+    include Redis::Aid
+    redis = Redis.connect(:host => "host.com")
+  end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Kriss 'nu7hatch' Kowalik. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+# -*- ruby -*-
+$:.unshift(File.expand_path('../lib', __FILE__))
+
+require 'rspec/core/rake_task'
+require 'rake/rdoctask'
+require 'redis-aid'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %q[-c -b]
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rspec_opts = %q[-c -b]
+  t.rcov_opts = %q[-T -x "spec"]
+end
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Redis Aid #{Redis::Aid.version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec
+
+desc "Build current version as a rubygem"
+task :build do
+  `gem build redis-aid.gemspec`
+  `mkdir -p pkg`
+  `mv redis-aid-*.gem pkg/`
+end
+
+desc "Relase current version to rubygems.org"
+task :release => :build do
+  `git tag -am "Version bump to #{Redis::Aid.version}" v#{Redis::Aid.version}`
+  `git push origin master`
+  `git push origin master --tags`
+  `gem push pkg/redis-aid-#{Redis::Aid.version}.gem`
+end
+
+desc "Perform installation via rubygems"
+task :install => :build do
+  `gem install pkg/redis-aid-#{Redis::Aid.version}.gem`
+end

data/lib/redis-aid.rb

@@ -0,0 +1,50 @@
+require "redis"
+require "nest"
+
+class Redis
+  module Aid
+
+    class << self
+      def version
+        "0.0.1"
+      end
+
+      attr_accessor :redis
+
+      def redis
+        @redis ||= Redis.new
+      end
+
+      def Namespace(ns)
+        Redis::Aid.instance_variable_set("@ns", ns)
+        Redis::Aid
+      end
+      alias :Ns :Namespace
+    end # << self
+
+    module ClassMethods
+      attr_accessor :redis
+
+      def redis
+        @redis ||= Redis::Aid.redis
+      end
+
+      def ns=(namespace)
+        @redis = Nest.new(namespace, redis)
+      end
+    end # ClassMethods
+    
+    module InstanceMethods
+      def redis
+        self.class.redis
+      end
+    end # InstanceMethods
+    
+    def self.included(base) # :nodoc:
+      base.send :extend, ClassMethods
+      base.send :include, InstanceMethods
+      base.ns = @ns and @ns = nil if @ns 
+    end
+
+  end # Aid
+end # Redis

data/redis-aid.gemspec

@@ -0,0 +1,22 @@
+# -*- ruby -*-
+$:.unshift(File.expand_path('../lib', __FILE__))
+require 'redis-aid'
+
+Gem::Specification.new do |s|
+  s.name             = 'redis-aid'
+  s.version          = Redis::Aid.version
+  s.homepage         = 'http://github.com/nu7hatch/redis-aid'
+  s.email            = ['chris@nu7hat.ch']
+  s.authors          = ['Chris Kowalik']
+  s.summary          = %q{The Redis first aid!}
+  s.description      = %q{Small lib which helps with extending your classes or modules with redis (and nest) goodies.}
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths    = %w[lib]
+  s.extra_rdoc_files = %w[LICENSE README.rdoc]
+
+  s.add_runtime_dependency 'redis',     [">= 2.0"]
+  s.add_runtime_dependency 'nest',      [">= 0"]
+  s.add_development_dependency 'rspec', ["~> 2.0"]
+  s.add_development_dependency 'mocha', [">= 0.9"]
+end

data/spec/redis_aid_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+class First
+  include Redis::Aid
+end
+
+class Second
+  include Redis::Aid::Ns(:test)
+end
+
+describe Redis::Aid do
+  subject do
+    Redis::Aid
+  end
+
+  describe "#redis" do
+    context "when no connection set before" do
+      it "should return default connection" do
+        Redis::Aid.redis.should be_kind_of Redis
+      end
+    end
+
+    context "when connection set before" do
+      it "should return it" do
+        Redis::Aid.redis = "test"
+        Redis::Aid.redis.should == "test"
+      end
+    end
+  end
+end
+
+describe "Class with Redis Aid" do
+  subject do 
+    First
+  end
+
+  before do
+    Redis::Aid.redis = "test"
+  end
+
+  describe ".redis" do
+    context "when no custom connection set before" do    
+      it "should return global connection" do
+        klass = subject
+        klass.redis.should == "test"
+      end
+    end
+
+    context "when custom connection set" do
+      it "should return it" do
+        klass = subject
+        klass.redis = "test2"
+        klass.redis.should == "test2"
+      end
+    end
+  end
+
+  describe "#redis" do
+    it "should be alias for .redis" do
+      klass = subject.new
+      klass.class.redis = "testing"
+      klass.redis.should == "testing"
+    end
+  end
+end
+
+describe "Class with namespaced Redis Aid" do
+  subject do 
+    Second
+  end
+
+  before do
+    Redis::Aid.redis = Redis.new
+  end
+
+  describe "#redis" do
+    it "should return nested client instance" do
+      klass = subject
+      klass.redis.should be_kind_of Nest
+    end
+
+    it "should work properly" do
+      Redis::Aid.redis.set("test:bar:bla", "testing")
+      klass = subject
+      klass.redis[:bar][:bla].get.should == "testing"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "rspec"
+require "mocha"
+require "redis-aid"
+
+RSpec.configure do |conf|
+  conf.mock_with :mocha
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: redis-aid
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Kowalik
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id004
+description: Small lib which helps with extending your classes or modules with redis (and nest) goodies.
+email: 
+- chris@nu7hat.ch
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/redis-aid.rb
+- redis-aid.gemspec
+- spec/redis_aid_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/nu7hatch/redis-aid
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: The Redis first aid!
+test_files: []
+