redis-structured-multi 0.0.1

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2011 Sean Keith McAuley
+
+This software is MIT-licensed.
+
+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,33 @@
+`redis-structured-multi` is a Ruby library for assembling Redis's multibulk replies (from the [redis-rb gem](http://github.com/ezmobius/redis-rb)'s `Redis#multi`) into objects, before they're actually returned, by using promises, thunks, and [fmap](http://github.com/derefr/fmap).
+
+Just require `redis/structured-multi`, then you can do something like this:
+
+    records = [
+      {:name => 'bob', :height => 180, :likes => 'carrots'},
+      {:name => 'phil', :height => 145, :likes => 'apples'}]
+
+    REDIS = Redis.new
+
+    full_records = REDIS.structured_multi do
+      records.map do |record|
+        last_visit = REDIS.get("user:#{record[:name]}:lastvisittime").to_i
+
+        likes = (REDIS.smembers("user:#{record[:name]}:likes") + [record[:likes]]).to_set
+        
+        left_handed = REDIS.get("user:#{record[:name]}:has:hand:left")
+        right_handed = REDIS.get("user:#{record[:name]}:has:hand:right")
+
+        record.merge(
+          :last_visit => last_visit,
+          :likes => likes,
+          :has_both_hands => (left_handed && right_handed))
+      end
+    end
+
+Under the covers, this is a single Redis pipeline. Even though we're able to do things like `redis_bool && other_redis_bool`, or `redis_set_members + static_set_members`, we're really just transforming promises into other promises. Here's the strategy:
+
+1. Execute a bunch of Redis commands; receive promises in exchange.
+2. Build the structure you want out of data you have, plus these promises.
+3. Return this structure as the value of the `structured_multi` block.
+
+After you do this, `structured-multi` will actually execute the pipeline, then `fmap` your structure into an equivalent one with all the same real data, but with the promises replaced with their actual Redis-retrieved values.

data/lib/redis/structured-multi.rb

@@ -0,0 +1,113 @@
+require 'fmap'
+require 'redis'
+
+class Redis
+  class ReceiptedPipeline < Pipeline
+    class Receipt
+      def initialize(pipeline, token, commands = nil)
+        @pipeline = pipeline
+        @token = token
+        @commands = (commands or [])
+      end
+
+      def ===( o )
+        if o.kind_of? Thunk
+          @pipeline.equal?(o.pipeline)
+        else
+          super
+        end
+      end
+      
+      def method_missing(m, *args, &bl)
+        new_command = [m, args, bl]
+        self.class.new(@pipeline, @token, @commands + [new_command])
+      end
+    end
+    
+    class Thunk
+      def initialize(pipeline, mbulk_reply)
+        @pipeline = pipeline
+        @mbulk_reply = mbulk_reply
+        @evaled_receipts = {}
+      end
+      
+      attr :pipeline
+
+      def ===( o )
+        if o.kind_of? Receipt
+          @pipeline.equal?(o.pipeline)
+        else
+          super
+        end
+      end
+      
+      def []( receipt )
+        receipt_token = receipt.instance_variable_get(:@token)
+        return @evaled_receipts[receipt_token] if @evaled_receipts.has_key?( receipt_token )
+        
+        response = @mbulk_reply[ receipt_token ]
+        receipt.instance_variable_get(:@commands).inject(response) do |o, (m, args, bl)|
+          evaled_args = args.eqfmap(self){ |receipt| self[ receipt ] }
+          o.send(m, *evaled_args, &bl)
+        end
+      end
+    end
+
+
+    def initialize
+      super
+      @tokens_generated = 0
+    end
+    
+    def generate_reply_receipt
+      token = (@tokens_generated += 1) - 1
+      Receipt.new( self, token )
+    end
+
+    def call(*args)
+      super
+      self.generate_reply_receipt
+    end
+    
+    def call_pipelined(commands, options = {})
+      before = @commands.length
+      super
+      after = @commands.length
+      
+      receipts = []
+      (after - before).times { receipts << self.generate_reply_receipt }
+      receipts
+    end
+  end
+
+  def pipelined_with_receipts(options = {})
+    synchronize do
+      begin
+        original, @client = @client, ReceiptedPipeline.new
+        yield
+
+        unless @client.commands.empty?
+          receipted_pipeline = @client
+          pipeline_reply = original.call_pipelined(@client.commands, options)
+          mbulk_reply = pipeline_reply.last
+          ReceiptedPipeline::Thunk.new(receipted_pipeline, mbulk_reply)
+        end
+      ensure
+        @client = original
+      end
+    end
+  end
+  
+  def structured_multi
+    synchronize do
+      structure = nil
+      pipeline_thunk = pipelined_with_receipts(:raise => false) do
+        @client.call_without_reply([:multi])
+        structure = yield(self)
+        @client.call_without_reply([:exec])
+      end
+
+      structure.eqfmap(pipeline_thunk){ |receipt| pipeline_thunk[ receipt ] }
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: redis-structured-multi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sean Keith McAuley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-22 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70267549553720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70267549553720
+- !ruby/object:Gem::Dependency
+  name: fmap
+  requirement: &70267549553240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70267549553240
+description: ! 'redis-structured-multi is an extension to the redis gem''s Redis#multi
+  that allows data structures to be built from the as-yet-unreturned values of the
+  calls to Redis that occur within the #multi block.'
+email: sean@zarokeanpie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/redis/structured-multi.rb
+homepage: http://github.com/derefr/redis-structured-multi
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: redis-structured-multi extends the redis gem's Redis#multi to allow data
+  structures to be built from promises before data is fetched
+test_files: []