asir 1.0.7 → 1.0.8

data/ChangeLog

@@ -1,3 +1,11 @@
+2012-11-30  Kurt A. Stephens  <ks.github@kurtstephens.com>
+
+	* v1.0.8: New version.
+	* Database: Preliminary support for storing Message and Result objects 
+	  in a database: see gem asir_activerecord.
+	* Coder: Use Coder#prepare instead of Object#dup to handle statefulness.
+	* CodeMore: Use @receiver_name to disambiguate Modules vs. Instances.
+
 2012-11-27  Kurt A. Stephens  <ks.github@kurtstephens.com>
 
 	* v1.0.7: New version.

data/asir.gemspec

@@ -43,6 +43,5 @@ Gem::Specification.new do |s|
   else
     gem.add_development_dependency 'ruby-debug19', '>= 0.1'
   end
-  # s.add_development_dependency 'simplecov', 
 end
 

data/lib/asir/additional_data.rb

@@ -4,6 +4,7 @@ module ASIR
   #
   # Support additional data attached to any object.
   module AdditionalData
+    def _additional_data; @additional_data; end
     def additional_data
       @additional_data || EMPTY_HASH
     end

data/lib/asir/code_more.rb

@@ -7,11 +7,16 @@ module ASIR
     include ObjectResolving # resolve_object()
     include CodeBlock # encode_block!, decode_block!
 
+    attr_accessor :receiver_name
+
     def encode_more!
       obj = encode_block! # may self.dup
       unless ::String === @receiver_class
         obj ||= self.dup # dont dup twice.
-        obj.receiver = @receiver.name if ::Module === @receiver
+        if ::Module === @receiver
+          obj.receiver_name = true
+          obj.receiver = @receiver.name
+        end
         obj.receiver_class = @receiver_class.name
         if resp = obj.result and resp.message == self
           resp.message = obj
@@ -23,8 +28,9 @@ module ASIR
     def decode_more!
       decode_block!
       if ::String === @receiver_class
+        # pp [ :decode_more!, self ]
         @receiver_class = resolve_object(@receiver_class)
-        @receiver = resolve_object(@receiver) if ::Module === @receiver_class
+        @receiver = resolve_object(@receiver) if @receiver_name
         unless @receiver_class === @receiver
           raise Error, "receiver #{@receiver.class.name} is not a #{@receiver_class}" 
         end
@@ -32,19 +38,28 @@ module ASIR
       self
     end
 
-    # Returns "Module.selector" if receiver is Module.
-    # Returns "Class#selector" if receiver is an instance.
-    def description
+    # If receiver is a Module (i.e. class or module message),
+    #   Returns [ name of the Module, :'.' ]
+    # Otherwise
+    #   Returns [ name of the receiver's Class, :'#' ]
+    def message_kind
       case
       when ::String === @receiver_class
-        "#{@receiver_class}.#{@selector}"
+        [ @receiver_class, :'.' ]
       when ::Module === @receiver
-        "#{@receiver}.#{@selector}"
+        [ @receiver.name, :'.' ]
       else
-        "#{@receiver_class}\#\#{@selector}"
+        [ @receiver_class.name, :'#' ]
       end
     end
 
+    # Returns "Module.selector" if receiver is Module.
+    # Returns "Class#selector" if receiver is an instance.
+    def description
+      x = message_kind
+      "#{x[0]}#{x[1]}#{@selector}"
+    end
+
     # Mixin for Result.
     module Result
       def encode_more!

data/lib/asir/coder.rb

@@ -14,6 +14,9 @@ module ASIR
       obj and _decode obj
     end
 
+    # If this Coder is stateful, #prepare should return a new instance.
+    def prepare; self; end
+
     # Coder subclasses:
     def _subclass_responsibility *args
       raise "subclass responsibility"

data/lib/asir/coder/database.rb

@@ -0,0 +1,89 @@
+require 'asir/coder'
+
+module ASIR
+  class Coder
+    # !SLIDE
+    # Database Coder
+    #
+    # Construct a database object from a Message or Result object.
+    #
+    # obj = model.new(:object => partially encoded object, :original_object => original object, :payload => Binary)
+    # obj.payload
+    #
+    # See Transport::Database:
+    #
+    # obj.save!
+    class Database < self
+      # The model for Message objects.
+      attr_accessor :message_model
+      # The model for Result objects.
+      attr_accessor :result_model
+      # The model for everything else.
+      attr_accessor :other_model
+
+      # The coder object => object_payload, must code to some binary String.
+      attr_accessor :payload_coder, :additional_data_coder
+
+      # Callback: attrs = call(self, obj, attrs : Hash)
+      attr_accessor :before_model_new
+      # Callback: model_obj = call(self, obj, model_obj)
+      attr_accessor :after_model_new
+
+      def _encode in_obj
+        obj = in_obj
+        case
+        when Message === in_obj && message_model
+          model = message_model
+        when Result === in_obj  && result_model
+          model = result_model
+        else
+          model = other_model
+        end
+        if model
+          obj = in_obj.encode_more!
+          # Prepare attributes for Model.
+          attrs = { :original_object => in_obj }
+
+          # Encode AdditionalData.
+          if AdditionalData === obj and ad = obj._additional_data
+            c = additional_data_coder || payload_coder
+            attrs[:additional_data] = c.prepare.encode(ad)
+          end
+
+          # Results need links back to its Message.
+          if Result === obj and message = in_obj.message
+            attrs[:message_object] = message
+            # Do not encode entire Message in ResultModel#payload.
+            obj.message = nil
+            if message_id = message[:database_id]
+              attrs[:message_id] = message_id
+            end
+            obj[:external_id] ||= message[:external_id]
+            # pp [ :Result_attrs, attrs ]
+          end
+
+          # Encode Object payload
+          payload = payload_coder.prepare.encode(obj)
+          attrs[:object] = obj
+          attrs[:payload] = payload
+
+          if @before_model_new
+            attr = @before_model_new.call(self, in_obj, attrs)
+          end
+          m = model.new(attrs)
+          if @after_model_new
+            m = @after_model_new.call(self, in_obj, m)
+          end
+          obj = m
+        end
+        obj
+      end
+
+      def _decode obj
+        payload_coder.prepare.decode(obj.payload)
+      end
+    end
+    # !SLIDE END
+  end
+end
+

data/lib/asir/coder/identity.rb

@@ -13,9 +13,6 @@ module ASIR
       def _decode obj
         obj
       end
-
-      # Completely stateless.
-      def dup; self; end
     end
     # !SLIDE END
   end

data/lib/asir/coder/json.rb

@@ -13,9 +13,8 @@ module ASIR
       end
 
       def _decode obj
-        parser = ::JSON.parser.new(obj)
-        ary = parser.parse
-        ary.first
+        ::JSON.parser.new(obj).
+          parse.first
       end
     end
     # !SLIDE END

data/lib/asir/coder/null.rb

@@ -13,9 +13,6 @@ module ASIR
       def _decode obj
         nil
       end
-
-      # Completely stateless.
-      def dup; self; end
     end
     # !SLIDE END
   end

data/lib/asir/coder/xml.rb

@@ -207,6 +207,8 @@ module ASIR
         @cls_tag_map[cls_name.freeze] ||= resolve_object(cls_name.gsub('.', '::'))
       end
 
+      # This coder is stateful.
+      def prepare; dup; end
     end
     # !SLIDE END
   end

data/lib/asir/transport.rb

@@ -28,7 +28,7 @@ module ASIR
       message.create_identifier! if needs_message_identifier? message
       @before_send_message.call(self, message) if @before_send_message
       relative_message_delay! message
-      message_payload = encoder.dup.encode(message)
+      message_payload = encoder.prepare.encode(message)
       opaque_result = _send_message(message, message_payload)
       receive_result(message, opaque_result)
     end
@@ -41,7 +41,7 @@ module ASIR
       @message_count ||= 0; @message_count += 1
       additional_data = { }
       if req_and_state = _receive_message(stream, additional_data)
-        message = req_and_state[0] = encoder.dup.decode(req_and_state.first)
+        message = req_and_state[0] = encoder.prepare.decode(req_and_state.first)
         message.additional_data!.update(additional_data) if message
         if @after_receive_message
           @after_receive_message.call(self, message)
@@ -59,11 +59,14 @@ module ASIR
       if @one_way && message.block
         message.block.call(result)
       else
-        result.message = nil # avoid sending back entire Message.
-        result_payload = decoder.dup.encode(result)
+        # avoid sending back entire Message.
+        result.message = nil unless @coder_needs_result_message
+        result_payload = decoder.prepare.encode(result)
         _send_result(message, result, result_payload, stream, message_state)
       end
     end
+    attr_accessor :coder_needs_result_message
+
     # !SLIDE END
 
     # !SLIDE
@@ -74,7 +77,7 @@ module ASIR
     # * Extract Result result or exception.
     def receive_result message, opaque_result
       result_payload = _receive_result(message, opaque_result)
-      result = decoder.dup.decode(result_payload)
+      result = decoder.prepare.decode(result_payload)
       if result && ! message.one_way
         if exc = result.exception
           invoker.invoke!(exc, self)

data/lib/asir/transport/database.rb

@@ -0,0 +1,48 @@
+require 'asir'
+
+module ASIR
+  class Transport
+    # Transport that stores to any model class that responds to:
+    #
+    # obj.save!
+    # obj.database_id
+    #
+    # See Coder::Database
+    #
+    class Database < self
+      attr_accessor :before_message_save, :after_message_save
+      attr_accessor :before_result_save, :after_result_save
+
+      def initialize *args
+        super
+        self.coder_needs_result_message = true
+        self.needs_message_identifier = true
+      end
+
+      def _send_message message, message_payload
+        if @before_message_save
+          @before_message_save.call(self, message, message_payload)
+        end
+        message_payload.save!
+        # message[:database_id] ||= message_payload.database_id
+        if @after_message_save
+          @after_message_save.call(self, message, message_payload)
+        end
+        nil # message_state
+      end
+
+      def _send_result message, result, result_payload, stream, message_state
+        return if one_way? or message.one_way?
+        if @before_result_save
+          @before_result_save.call(self, message, result, result_payload)
+        end
+        result_payload.save!
+        result[:database_id] = result_payload.database_id
+        if @after_result_save
+          @after_result_save.call(self, message, result, result_payload)
+        end
+        nil
+      end
+    end
+  end
+end

data/lib/asir/version.rb

@@ -1,3 +1,3 @@
 module ASIR
-  VERSION = "1.0.7"
+  VERSION = "1.0.8"
 end

data/spec/json_spec.rb

@@ -19,9 +19,9 @@ describe "ASIR::Coder::JSON" do
     str = "[#{str}]"
     basic_objs << [ x, str ]
     it "should handle #{x.inspect}" do
-      out = @enc.encode(x)
+      out = @enc.prepare.encode(x)
       out.should == str
-      @dec.decode(out).should == x
+      @dec.prepare.decode(out).should == x
     end
   end
 
@@ -35,9 +35,9 @@ describe "ASIR::Coder::JSON" do
     str = "[#{str}]"
     basic_objs << [ x, str ]
     it "should handle #{x.inspect}" do
-      out = @enc.encode(x)
+      out = @enc.prepare.encode(x)
       out.should == str
-      y = @dec.decode(out)
+      y = @dec.prepare.decode(out)
       y = y.to_sym if Symbol === x
       y.should == x
     end
@@ -51,18 +51,18 @@ describe "ASIR::Coder::JSON" do
     str = "[#{str}]"
     basic_objs << [ x, str ]
     it "should handle #{x.inspect}" do
-      out = @enc.encode(x)
+      out = @enc.prepare.encode(x)
       out.should == str
-      y = @dec.decode(out)
+      y = @dec.prepare.decode(out)
       y.should == x
     end
   end
 
   it "should handle empty Array" do
     x = [ ]
-    out = @enc.encode(x)
+    out = @enc.prepare.encode(x)
     out.should == "[[]]"
-    @dec.decode(out).should == x
+    @dec.prepare.decode(out).should == x
   end
 
   it "should handle Array" do
@@ -82,14 +82,14 @@ describe "ASIR::Coder::JSON" do
 
   it "should handle Hash" do
     x = Hash[ *basic_objs.flatten.reverse ]
-    out = @enc.encode(x)
+    out = @enc.prepare.encode(x)
     out.should =~ %r{\A\[\{}
     out.should =~ %r{\}\]\Z}
     basic_objs.each do | v, str |
       # out.should =~ %r{#{k.inspect}:}
       out.should =~ %r{#{str}}
     end
-    y = @dec.decode(out)
+    y = @dec.prepare.decode(out)
     y.should == x.inject({}){|h, (k, v)| h[k] = Symbol === v ? v.to_s : v; h }
   end
 
@@ -105,12 +105,26 @@ describe "ASIR::Coder::JSON" do
     x.h = Hash[ *basic_objs.flatten.reverse ]
     x.o = ASIR::Coder::Test::Object.new
     x.o.a = 123
-    out = @enc.encode(x)
+    out = @enc.prepare.encode(x)
+    if out =~ %r{#<ASIR::Coder::Test::Object}
+      out.should =~ %r{\A\[\"#<ASIR::Coder::Test::Object:[^>]+>\"\]\Z}
+    else
+      out.should =~ %r{"a":\[null,true,false,1234,1.234,"symbol","String"\]}
+      out.should =~ %r{"h":\{}
+      out.should =~ %r{"\[1234\]":1234}
+      out.should =~ %r{"\[1.234\]":1.234}
+      out.should =~ %r{"\[null\]":null}
+      out.should =~ %r{"\[\\"String\\"\]":"String"}
+      out.should =~ %r{"\[\\"symbol\\"\]":"symbol"}
+      out.should =~ %r{"\[null\]":null}
+      out.should =~ %r{"\[true\]":true}
+      out.should =~ %r{"\[null\]":null}
+    end
+
     # FIXME:
-    out.should =~ %r{\A\[\"#<ASIR::Coder::Test::Object:[^>]+>\"\]\Z}
     #out.should =~ %r{<#{x.class.name.gsub('::', '.')} id=\"#{x.object_id}\" >}
     #out.should =~ %r{</#{x.class.name.gsub('::', '.')}>}
-    y = @dec.decode(out)
+    y = @dec.prepare.decode(out)
     (String === y).should == true
 =begin
 FIXME:

data/spec/message_spec.rb

@@ -64,5 +64,34 @@ describe "ASIR::Message" do
     exc.exception_message.should == "#{cls.name} #{msg}"
     exc.exception_backtrace.class.should == Array
   end
+
+  it 'should return appropriate message_kind and #description.' do
+    self.object = ASIR::Coder.new
+    self.message = ASIR::Message.new(object, nil, nil, nil, nil)
+    message.selector = :instance_message!
+
+    x = message.description
+    x.should == "ASIR::Coder#instance_message!"
+    message.encode_more!
+    message.description.should == x
+
+    self.object = ASIR::Coder
+    self.message = ASIR::Message.new(object, nil, nil, nil, nil)
+    message.selector = :class_message!
+
+    x = message.description
+    x.should == "ASIR::Coder.class_message!"
+    message.encode_more!
+    message.description.should == x
+
+    self.object = ASIR
+    self.message = ASIR::Message.new(object, nil, nil, nil, nil)
+    message.selector = :module_message!
+
+    x = message.description
+    x.should == "ASIR.module_message!"
+    message.encode_more!
+    message.description.should == x
+  end
 end
 

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 require 'debug_helper'
-$: << File.expand_path('../../lib', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
 
 require 'asir'
 

data/spec/xml_spec.rb

@@ -16,9 +16,9 @@ describe "ASIR::Coder::XML" do
   ].each do | x |
     basic_objs << x
     it "should handle #{x.inspect}" do
-      xml = @enc.encode(x)
+      xml = @enc.prepare.encode(x)
       xml.should == "<#{x.class.name} />"
-      @dec.decode(xml).should == x
+      @dec.prepare.decode(xml).should == x
     end
   end
 
@@ -28,9 +28,9 @@ describe "ASIR::Coder::XML" do
   ].each do | x |
     basic_objs << x
     it "should handle #{x.inspect}" do
-      xml = @enc.encode(x)
+      xml = @enc.prepare.encode(x)
       xml.should == "<#{x.class.name} v=\"#{x.to_s}\" />"
-      @dec.decode(xml).should == x
+      @dec.prepare.decode(xml).should == x
     end
   end
 
@@ -39,9 +39,9 @@ describe "ASIR::Coder::XML" do
   ].each do | x |
     basic_objs << x
     it "should handle #{x.inspect}" do
-      xml = @enc.encode(x)
+      xml = @enc.prepare.encode(x)
       xml.should == "<#{x.class.name} >#{x.to_s}</#{x.class.name}>"
-      @dec.decode(xml).should == x
+      @dec.prepare.decode(xml).should == x
     end
   end
 
@@ -50,36 +50,36 @@ describe "ASIR::Coder::XML" do
   ].each do | x |
     basic_objs << x
     it "should handle #{x.inspect}" do
-      xml = @enc.encode(x)
+      xml = @enc.prepare.encode(x)
       xml.should == "<#{x.class.name} id=\"1\" >#{x.to_s}</#{x.class.name}>"
-      @dec.decode(xml).should == x
+      @dec.prepare.decode(xml).should == x
     end
   end
 
   it "should handle empty Array" do
     x = [ ]
-    xml = @enc.encode(x)
+    xml = @enc.prepare.encode(x)
     xml.should == "<#{x.class.name} id=\"1\" ></#{x.class.name}>"
-    @dec.decode(xml).should == x
+    @dec.prepare.decode(xml).should == x
   end
 
   it "should handle Array" do
     x = [ *basic_objs ]
-    xml = @enc.encode(x)
+    xml = @enc.prepare.encode(x)
     xml.should =~ %r{\A<#{x.class.name} id=\"1\" ><NilClass /><TrueClass /><FalseClass /><Fixnum v="1234" /><Float v="1.234" /><Symbol >symbol</Symbol><String id=\"[^"]+\" >String</String></#{x.class.name}>\Z} # " emacs
-    @dec.decode(xml).should == x
+    @dec.prepare.decode(xml).should == x
   end
 
   it "should handle empty Hash" do
     x = { }
-    xml = @enc.encode(x)
+    xml = @enc.prepare.encode(x)
     xml.should == "<#{x.class.name} id=\"1\" ></#{x.class.name}>"
-    @dec.decode(xml).should == x
+    @dec.prepare.decode(xml).should == x
   end
 
   it "should handle Hash" do
     x = Hash[ *basic_objs.map{|e| e.inspect}.zip(basic_objs).flatten ]
-    xml = @enc.encode(x)
+    xml = @enc.prepare.encode(x)
     xml.should =~ %r{\A<#{x.class.name} id=\"1\" >}
     xml.should =~ %r{</#{x.class.name}>\Z}
     basic_objs.each do | v |
@@ -88,7 +88,7 @@ describe "ASIR::Coder::XML" do
       xml.should =~ Regexp.new(vx)
       xml.should =~ %r{ >#{v.inspect}</String>}
     end
-    @dec.decode(xml).should == x
+    @dec.prepare.decode(xml).should == x
   end
 
   class ASIR::Coder::XML::Test
@@ -101,10 +101,10 @@ describe "ASIR::Coder::XML" do
     x.h = Hash[ *basic_objs.map{|e| e.inspect}.zip(basic_objs).flatten ]
     x.o = ASIR::Coder::XML::Test.new
     x.o.a = 123
-    xml = @enc.encode(x)
+    xml = @enc.prepare.encode(x)
     xml.should =~ %r{<#{x.class.name.gsub('::', '.')} id=\"1\" >}
     xml.should =~ %r{</#{x.class.name.gsub('::', '.')}>}
-    y = @dec.decode(xml)
+    y = @dec.prepare.decode(xml)
     y.a.should == x.a
     y.h.should == x.h
     y.o.class.should == ASIR::Coder::XML::Test
@@ -117,8 +117,8 @@ describe "ASIR::Coder::XML" do
     x = Hash[ *basic_objs.map{|e| e.inspect}.zip(basic_objs).flatten ]
     y = [ 1, 2 ]
     x = [ x, x, y, y ]
-    xml = @enc.encode(x)
-    y = @dec.decode(xml)
+    xml = @enc.prepare.encode(x)
+    y = @dec.prepare.decode(xml)
     y[0].object_id.should == y[1].object_id
     y[2].object_id.should == y[3].object_id
   end
@@ -126,8 +126,8 @@ describe "ASIR::Coder::XML" do
   it "should handle self-referencing Array." do
     x = [ 1 ]
     x << x
-    xml = @enc.encode(x)
-    y = @dec.decode(xml)
+    xml = @enc.prepare.encode(x)
+    y = @dec.prepare.decode(xml)
     y[0].should == x[0]
     y[1].object_id.should == y.object_id
   end
@@ -135,8 +135,8 @@ describe "ASIR::Coder::XML" do
   it "should handle self-referencing Hash." do
     x = { :a => 1 }
     x[:self] = x
-    xml = @enc.encode(x)
-    y = @dec.decode(xml)
+    xml = @enc.prepare.encode(x)
+    y = @dec.prepare.decode(xml)
     y[:a].should == x[:a]
     y[:self].object_id.should == y.object_id
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asir
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uuid
@@ -286,6 +286,7 @@ files:
 - lib/asir/coder.rb
 - lib/asir/coder/base64.rb
 - lib/asir/coder/chain.rb
+- lib/asir/coder/database.rb
 - lib/asir/coder/identity.rb
 - lib/asir/coder/json.rb
 - lib/asir/coder/marshal.rb
@@ -319,6 +320,7 @@ files:
 - lib/asir/transport/composite.rb
 - lib/asir/transport/conduit.rb
 - lib/asir/transport/connection_oriented.rb
+- lib/asir/transport/database.rb
 - lib/asir/transport/delay.rb
 - lib/asir/transport/delegation.rb
 - lib/asir/transport/demux.rb
@@ -367,7 +369,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2492323202029114126
+      hash: 885978386070956346
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -376,7 +378,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2492323202029114126
+      hash: 885978386070956346
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24