redis-wrap 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f4f0dc09510ead01d649792f68ab44732e1bc27
+  data.tar.gz: f6c44a5e02ea93445f72d851b3bc5743f453728a
+SHA512:
+  metadata.gz: d63a3117b2860184ef8e9df704ec41cb118a375dad5ad76635a1e213067891c5e331816a2512ced54a40fb5de58b8a8c23b4b736409f7bf229873ee37dda14dd
+  data.tar.gz: 1db64e7604d159cd20f93201b22a4faec1f64430ff6dc2aaaf6672273b5754bd545b7fe42786cefe32da208fd5352b2568c8cc5a4a347ca2c251856bfb437be1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+ruby '2.1.0'
+
+gem 'redis', '~> 3'
+
+group :development do
+  gem 'require_all'
+  gem 'rake'
+  gem 'minitest'
+  gem 'nokogiri'
+end

data/README.md

@@ -0,0 +1,83 @@
+# `redis-wrap`
+
+Every web application needs Redis. The problem is that Redis does not have a schema, which forces the developer to establish conventions across the code base. The goal of `redis-wrap` is to have one key declaration per object to avoid spaghetti code.
+
+### Examples
+
+Here's how it works. Set up Redis in initialization code.
+
+```ruby
+require 'redis'
+require 'redis-wrap'
+
+Redis.current = Redis.new()
+```
+
+State the key once and then access methods.
+
+```ruby
+redis = Redis.current
+
+counter = redis['counter']
+# => #<Redis::Wrap @key="counter">
+
+counter.incr
+# => 1
+
+counter.incr
+# => 2
+
+counter.del
+counter.incr
+# => 1
+```
+
+Wraps may be used interchangably as keys.
+
+```ruby
+class User
+  def interests
+    Redis::Wrap.new("users:#{id}:interests")
+  end
+end
+
+jack.interests.sadd(%w(music cooking gardening dancing))
+jean.interests.sadd(%w(movies music dancing))
+
+jack.interests.sinter(jean.interests)
+# => [ "music", "dancing" ]
+```
+
+The wrap is simply a ruby object so you can extend functionality.
+
+```ruby
+require 'marshal'
+
+class CachedFind < Redis::Wrap
+  def initialize(klass, id)
+    @klass = klass
+    @id = id
+  end
+
+  def key
+    "#{@klass.underscore}:#{@id}")
+  end
+
+  def fetch
+    binary = get
+    if binary.present?
+      Marshal.load(binary)
+    else
+      klass.find(id).tap do |model|
+        set(Marshal.dump(model))
+      end
+    end
+  end
+end
+
+CachedFind.new(User, params[:id]).fetch
+```
+
+### Install
+
+**TODO.**

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.join(__dir__, 'lib'))
+
+require 'require_all'
+
+task default: :test
+
+task :test do
+  require_relative 'test/helper.rb'
+  require_rel 'test/**/*_spec.rb'
+end

data/lib/redis-wrap.rb

@@ -0,0 +1 @@
+require 'redis/wrap'

data/lib/redis/wrap.rb

@@ -0,0 +1,29 @@
+class Redis
+  def [](key)
+    Wrap.new(key)
+  end
+
+  class Wrap
+    attr_reader :key
+
+    def initialize(key)
+      @key = key
+    end
+
+    def method_missing(command, *arguments, &block)
+      arguments = arguments.map do |argument|
+        if argument.is_a?(Redis::Wrap)
+          argument.key
+        else
+          argument
+        end
+      end
+
+      redis.send(command, key, *arguments, &block)
+    end
+
+    def redis
+      Redis.current
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'redis'
+require 'minitest/autorun'
+
+Redis.current = Redis.new(db: 0)
+
+class Minitest::Spec
+  after(:each) do
+    redis.flushdb
+  end
+
+  def redis
+    Redis.current
+  end
+end
+

data/test/redis/wrap_spec.rb

@@ -0,0 +1,61 @@
+require 'redis/wrap'
+
+describe Redis do
+  describe '#[]' do
+    it 'should return a wrap' do
+      assert_equal(redis['test'].class, Redis::Wrap)
+    end
+
+    it 'should pass itself' do
+      assert_equal(redis['test'].redis, redis)
+    end
+  end
+end
+
+describe Redis::Wrap do
+  describe 'string' do
+    let(:string) { redis['string'] }
+
+    it 'should set and get' do
+      string.set('hello')
+      assert_equal(string.get, 'hello')
+    end
+  end
+
+  describe 'counter' do
+    let(:counter) { redis['counter'] }
+
+    it 'should increment' do
+      assert_equal(counter.incr, 1)
+    end
+
+    it 'should decrement' do
+      counter.incr
+      assert_equal(counter.decr, 0)
+    end
+  end
+
+  describe 'set' do
+    it 'should intersect' do
+      s1 = redis['set:1']
+      s2 = redis['set:2']
+      s3 = redis['set:3']
+
+      s1.sadd(%w(1 2 3))
+      s2.sadd(%w(2 3 4))
+      s3.sadd(%w(3 4 5))
+
+      assert_equal(s1.sinter(s2, s3), %w(3))
+    end
+  end
+
+  describe 'leaderboard' do
+    let(:leaderboard) { redis['leaderboard'] }
+
+    it 'should get top scores' do
+      leaderboard.zadd([ [ 7, 'abc' ], [ 23, 'xyz' ] ])
+      leaders = leaderboard.zrevrange(0, -1)
+      assert_equal(leaders, %w(xyz abc))
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: redis-wrap
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- "@aj0strow"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: ''
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- lib/redis-wrap.rb
+- lib/redis/wrap.rb
+- test/helper.rb
+- test/redis/wrap_spec.rb
+homepage: https://github.com/aj0strow/redis-wrap
+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.2.0
+signing_key: 
+specification_version: 4
+summary: object-oriented redis
+test_files:
+- test/helper.rb
+- test/redis/wrap_spec.rb