redis_obj 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60078190708a0aa3872d0df60a6d389ab6949117
+  data.tar.gz: c88fb3d786df0eb865cdaf30816eada0b4315c8f
+SHA512:
+  metadata.gz: 8304198906cc62aa89c17de1ee495d87c01f0f70569b548105a49195f68feb6b67c0d5d95e84dafc6dca7b770b15a1914f2a52c5bcb2dfd8ee4361d36a50dcef
+  data.tar.gz: 6d813e8d0144add088b84b744c0a6952c7d6ef717e2fe9e908190b3a48401c6663be400dc72af0449ab768b12c913975b535615b56d345ec1c3970e5518c1dc2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in redis_obj.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tal Atlas
+
+MIT License
+
+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,29 @@
+# RedisObj
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_obj'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_obj
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis_obj/base.rb

@@ -0,0 +1,29 @@
+class RedisObj::Base
+  attr_accessor :key, :redis
+  def initialize redis, key=nil
+    unless key
+      key = redis
+      redis = RedisObj.redis
+    end
+    @key = key
+    @redis = redis
+  end
+
+  def == other
+    self.class == other.class and self.key == other.key
+  end
+
+  def del_key
+    redis.del(key)
+  end
+
+  private
+
+  def get_keys(keys)
+    if keys.first.respond_to?(:key)
+      keys.collect(&:key)
+    else
+      keys
+    end
+  end
+end

data/lib/redis_obj/hash.rb

@@ -0,0 +1,69 @@
+class RedisObj::Hash < RedisObj::Base
+  def del field
+    redis.hdel(key,field)
+  end
+
+  def incby field, amt
+    if amt.is_a?(Float)
+      redis.hincrbyfloat(key,field,amt)
+    else
+      redis.hincrby(key,field,amt)
+    end
+  end
+  alias incbyfloat incby
+
+  def inc field
+    incby(field,1)
+  end
+
+  def dec field
+    incby(field,-1)
+  end
+
+  def mget *fields
+    redis.hmget(key,*fields)
+  end
+
+  def mset *fields
+    redis.hmset(key,*fields)
+  end
+
+  def vals
+    redis.hvals(key)
+  end
+  alias values vals
+
+  def keys
+    redis.hkeys(key)
+  end
+
+  def exists field
+    redis.hexists(key,field)
+  end
+
+  def get field
+    redis.hget(key,field)
+  end
+  alias [] get
+
+  def set field, val
+    redis.hset(key,field,val)
+  end
+  alias []= set
+
+  def getall
+    redis.hgetall(key)
+  end
+  alias to_h getall
+
+  def len
+    redis.hlen(key)
+  end
+  alias size len
+  alias count len
+  alias length len
+
+  def setnx field, val
+    redis.hsetnx(key,field,val)
+  end
+end

data/lib/redis_obj/list.rb

@@ -0,0 +1,89 @@
+class RedisObj::List < RedisObj::Base
+  include Enumerable
+
+  def blpop *args
+    redis.blpop(key,*args)
+  end
+
+  def brpop *args
+    redis.brpop(key,*args)
+  end
+
+  def brpoplpush(destination, options = {})
+    redis.brpoplpush(key,destination,options)
+  end
+
+  def lindex(index)
+    redis.lindex(key,index)
+  end
+  alias [] lindex
+
+  def linsert(where, pivot, value)
+    redis.linsert(key,where,pivot,value)
+  end
+
+  def lrange(start, stop)
+    redis.lrange(key, start, stop)
+  end
+
+  def to_a
+    lrange(0,-1)
+  end
+
+  def each &blk
+    to_a.each(&blk)
+  end
+
+  def lrem(count, value)
+    redis.lrem(key, count, value)
+  end
+
+  def lset(index, value)
+    redis.lset(key, index, value)
+  end
+  alias []= lset
+
+  def ltrim(start, stop)
+    redis.ltrim(key, start, stop)
+  end
+
+  def len
+    redis.llen(key)
+  end
+  alias length len
+  alias size len
+  alias count len
+
+  def lpop
+    redis.lpop(key)
+  end
+  alias shift lpop
+
+  def lpush val
+    redis.lpush(val)
+  end
+  alias unshift lpush
+
+  def lpushx val
+    redis.lpushx(key,val)
+  end
+
+  def rpop
+    redis.rpop(key)
+  end
+  alias pop rpop
+
+  def rpoplpush destination
+    redis.rpoplpush(key, destination)
+  end
+
+  def rpush val
+    redis.rpush(key,val)
+  end
+  alias << rpush
+  alias push rpush
+
+  def rpushx val
+    redis.rpushx(key,val)
+  end
+end

data/lib/redis_obj/relations.rb

@@ -0,0 +1,84 @@
+module RedisObj::Relations
+  module Initializers
+    def store_redis_in &blk
+      if blk
+        @store_redis_in = blk
+      else
+        @store_redis_in ||= begin
+          base_class = self.class.to_s.downcase
+          Proc.new { "#{base_class}:#{id}" }
+        end
+      end
+    end
+
+    def redis_prefix ctx
+      if ctx.is_a? ::Hash
+        ctx = OpenStruct.new(ctx)
+      end
+      ctx.instance_exec(&store_redis_in)
+    end
+
+    def redis_obj type, name, opts={}
+      opts[:key] = name unless opts.has_key?(:key)
+      opts[:redis] ||= -> { RedisObj.redis }
+
+      klass_method = "redis_#{name}"
+      instance_variable = "@#{name}"
+
+      define_method name do
+        unless obj = instance_variable_get(instance_variable)
+          obj = self.class.send(klass_method,self)
+
+          instance_variable_set(instance_variable,obj)
+        end
+        obj
+      end
+
+      define_singleton_method klass_method do |context|
+        redis = opts[:redis]
+
+        if redis.respond_to?(:call)
+          redis = redis.call
+        end
+
+        if opts[:key] == false
+          type.new(redis, "#{redis_prefix(context)}")
+        else
+          type.new(redis, "#{redis_prefix(context)}:#{opts[:key]}")
+        end
+      end
+    end
+
+    def redis_hash name, opts={}
+      redis_obj(RedisObj::Hash,name,opts)
+    end
+
+    def redis_set name, opts={}
+      redis_obj(RedisObj::Set,name,opts)
+    end
+
+    def redis_sorted_set name, opts={}
+      redis_obj(RedisObj::SortedSet,name,opts)
+    end
+
+    def redis_list name, opts={}
+      redis_obj(RedisObj::List,name,opts)
+    end
+
+    def inherited subklass
+      super
+      subklass.instance_variable_set(:@store_redis_in,@store_redis_in)
+    end
+  end
+
+  module InstanceMethods
+    def redis_prefix
+      self.class.redis_prefix(self)
+    end
+  end
+
+  def self.included klass
+    klass.extend Initializers
+    klass.send(:include, InstanceMethods)
+  end
+end

data/lib/redis_obj/set.rb

@@ -0,0 +1,101 @@
+class RedisObj::Set < RedisObj::Base
+  include Enumerable
+
+  def members
+    redis.smembers(key)
+  end
+  alias to_a members
+
+  def ismember val
+    redis.sismember(key,val)
+  end
+  alias include? ismember
+
+  def inter *keys
+    redis.sinter(key,*get_keys(keys))
+  end
+  alias & inter
+
+  def interstore destination, *keys
+    redis.sinterstore(destination,key,*get_keys(keys))
+    new_key = self.class.new(redis,destination)
+
+    if block_given?
+      begin
+        yield(new_key)
+      ensure
+        redis.del(destination)
+      end
+    end
+
+    new_key
+  end
+
+  def diff *keys
+    redis.sdiff(key,*get_keys(keys))
+  end
+  alias - diff
+
+  def diffstore destination, *keys
+    redis.sdiffstore(destination,key,*get_keys(keys))
+    new_key = self.class.new(redis,destination)
+
+    if block_given?
+      begin
+        yield(new_key)
+      ensure
+        redis.del(destination)
+      end
+    end
+
+    new_key
+  end
+
+  def union *keys
+    redis.sunion(key,*get_keys(keys))
+  end
+  alias | union
+
+  def unionstore destination, *keys
+    redis.sunionstore(destination,key,*get_keys(keys))
+    new_key = self.class.new(redis,destination)
+
+    if block_given?
+      begin
+        yield(new_key)
+      ensure
+        redis.del(destination)
+      end
+    end
+
+    new_key
+  end
+
+  def pop
+    redis.pop(key)
+  end
+
+  def add val
+    redis.sadd(key,val)
+  end
+  alias << add
+
+  def rem val
+    redis.srem(key,val)
+  end
+
+  def srandmember num=1
+    redis.srandmember(key,num)
+  end
+
+  def card
+    redis.scard(key)
+  end
+  alias length card
+  alias size card
+  alias count card
+
+  def each &blk
+    to_a.each(&blk)
+  end
+end

data/lib/redis_obj/sorted_set.rb

@@ -0,0 +1,101 @@
+class RedisObj::SortedSet < RedisObj::Base
+  def add score, member
+    redis.zadd(key,score,member)
+  end
+
+  def rem member
+    redis.zrem(key,mem)
+  end
+
+  def card min=0,max=0
+    if min
+      redis.zcount(key,min,max)
+    else
+      redis.zcard(key)
+    end
+  end
+  alias length card
+  alias size card
+  alias count card
+
+  def incby amt, member
+    redis.zincby(key,amt,member)
+  end
+
+  def inc member
+    incby(1,member)
+  end
+
+  def dec member
+    incby(-1,member)
+  end
+
+  def range start, stop, opts={}
+    redis.zrange(key,start,stop,opts)
+  end
+
+  def revrange start, stop, opts={}
+    redis.zrevrange(key,start,stop,opts)
+  end
+
+  def rangebyscore start, stop, opts={}
+    redis.zrangebyscore(key,start,stop,opts)
+  end
+
+  def revrangebyscore start, stop, opts={}
+    redis.zrevrangebyscore(key,start,stop,opts)
+  end
+
+  def rank mem
+    redis.rank(key,mem)
+  end
+
+  def revrank mem
+    redis.revrank(key,mem)
+  end
+
+  def remrangebyrank start, stop
+    redis.zremrangebyrank(key,start,stop)
+  end
+
+  def remrangebyscore start, stop
+    redis.zremrangebyscore(key,start,stop)
+  end
+
+  def interstore(destination, keys, options = {})
+    keys = [key]+keys
+
+    redis.zinterstore(destination,keys,options)
+
+    new_key = self.class.new(redis,destination)
+
+    if block_given?
+      begin
+        yield(new_key)
+      ensure
+        redis.del(destination)
+      end
+    end
+
+    new_key
+  end
+
+  def unionstore(destination, keys, options = {})
+    keys = [key]+keys
+
+    redis.zunionstore(destination,keys,options)
+
+    new_key = self.class.new(redis,destination)
+
+    if block_given?
+      begin
+        yield(new_key)
+      ensure
+        redis.del(destination)
+      end
+    end
+
+    new_key
+  end
+
+end

data/lib/redis_obj/version.rb

@@ -0,0 +1,3 @@
+module RedisObj
+  VERSION = "0.0.2"
+end

data/lib/redis_obj.rb

@@ -0,0 +1,22 @@
+require 'ostruct'
+
+%w{
+  version
+  base
+  set
+  sorted_set
+  hash
+  relations
+}.each do |f|
+  require "redis_obj/#{f}"
+end
+
+module RedisObj
+  class << self
+    attr_accessor :redis
+  end
+
+  def self.included reciever
+    raise NameError, "Please include RedisObj::Relations instead of this module"
+  end
+end

data/redis_obj.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_obj/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_obj"
+  spec.version       = RedisObj::VERSION
+  spec.authors       = ["Tal Atlas"]
+  spec.email         = ["me@tal.by"]
+  spec.description   = %q{methods for managing redis keys in an object oriented manner}
+  spec.summary       = %q{kinda like a redis ORM}
+  spec.homepage      = "https://github.com/tal/redis_obj"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'redis'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/redis_obj_class_methods_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe RedisObj do
+  let(:test_klass) do
+    Class.new do
+      attr_reader :id
+      include RedisObj::Relations
+
+      redis_set :friends
+
+      def initialize
+        @id = rand(100000)
+      end
+    end
+  end
+  subject {test_klass}
+
+  describe "redis_obj" do
+    let(:context) {test_klass.new}
+    subject {test_klass.redis_friends(context)}
+
+    it {should be_a(RedisObj::Set)}
+    its(:key) {should == "class:#{context.id}:friends"}
+
+    context "hash" do
+      let(:context) {{id: rand(100000)}}
+      # before {context.should_receive(:is_a?).and_return(true)}
+
+      it do
+        test_klass.redis_prefix(context).should == "class:#{context[:id]}"
+      end
+
+      it {should be_a(RedisObj::Set)}
+      its(:key) {should == "class:#{context[:id]}:friends"}
+    end
+  end
+end

data/spec/redis_obj_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe RedisObj do
+  let(:base_redis) { mock("BaseRedis") }
+  before { RedisObj.redis = base_redis }
+
+  let(:test_klass) do
+    Class.new do
+      attr_reader :id
+      include RedisObj::Relations
+
+      def initialize
+        @id = rand(100000)
+      end
+    end
+  end
+
+  context 'custom class' do
+    it "should store the" do
+      test_klass.should respond_to(:store_redis_in)
+      blk = -> { 'foo' }
+      test_klass.store_redis_in(&blk)
+      test_klass.store_redis_in.should == blk
+    end
+
+    it "should set default prefix" do
+      test_klass.new.redis_prefix.should start_with('class:')
+    end
+  end
+
+  let(:obj) {test_klass.new}
+  subject {obj}
+
+  context 'with prefix' do
+    before { test_klass.store_redis_in { "test:#{id}"} }
+    its(:redis_prefix) { should == "test:#{subject.id}" }
+
+    describe "global redis instance" do
+      subject{obj.friends}
+      let(:redis) {mock('Redis')}
+
+      before { RedisObj.redis = redis; test_klass.redis_set :friends }
+      after { RedisObj.redis = base_redis }
+
+      it { RedisObj.redis.should === redis }
+
+      its(:redis) { should === redis }
+    end
+
+    describe 'redis_hash with no key' do
+      before do
+        test_klass.redis_hash :hash, key: false
+      end
+
+      it {should respond_to :hash}
+      its(:hash) { should be_a(RedisObj::Hash) }
+
+      describe 'hash' do
+        subject { obj.hash }
+
+        its(:key) { should == obj.redis_prefix }
+      end
+    end
+
+    describe 'redis_set defined default key' do
+      let(:redis) {mock('Redis')}
+      before do
+        test_klass.redis_set :friends
+        test_klass.redis_set :friends2, key: 'f', redis: redis
+        test_klass.redis_set :friends3, key: 'ff', redis: ->{redis}
+      end
+
+      it {should respond_to :friends}
+      its(:friends) { should be_a(RedisObj::Set) }
+
+      it 'should memoize' do
+        f = obj.friends
+        obj.friends.should be f
+        obj.friends.should be f
+        obj.instance_variable_set(:@friends,nil)
+        obj.friends.should_not be f
+      end
+
+      describe 'friends' do
+        subject{obj.friends}
+
+        its(:key) { should == "test:#{obj.id}:friends" }
+        its(:redis) { should === base_redis}
+
+        it { RedisObj.redis.should === base_redis }
+      end
+
+      describe 'friends2' do
+        subject{obj.friends2}
+
+        its(:key) { should == "test:#{obj.id}:f" }
+        its(:redis) { should be redis }
+      end
+
+      describe 'friends3' do
+        subject{obj.friends3}
+
+        its(:redis) { should be redis }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__),'..','lib')))
+
+require 'redis'
+require 'redis_obj'

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: redis_obj
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Tal Atlas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-06 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: methods for managing redis keys in an object oriented manner
+email:
+- me@tal.by
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_obj.rb
+- lib/redis_obj/base.rb
+- lib/redis_obj/hash.rb
+- lib/redis_obj/list.rb
+- lib/redis_obj/relations.rb
+- lib/redis_obj/set.rb
+- lib/redis_obj/sorted_set.rb
+- lib/redis_obj/version.rb
+- redis_obj.gemspec
+- spec/redis_obj_class_methods_spec.rb
+- spec/redis_obj_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tal/redis_obj
+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: kinda like a redis ORM
+test_files:
+- spec/redis_obj_class_methods_spec.rb
+- spec/redis_obj_spec.rb
+- spec/spec_helper.rb