arpie 0.0.6 → 0.1.0

data/examples/em.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'arpie'
+require 'eventmachine'
+
+EM::run {
+  EM::start_server "127.0.0.1", 51210, Arpie::EventMachine::ArpieProtocol,
+    Arpie::SeparatorProtocol.new do |c|
+      def c.receive message
+        puts message.reverse
+        EM::stop_event_loop
+      end
+    end
+
+  EM::connect "127.0.0.1", 51210, Arpie::EventMachine::ArpieProtocol,
+    Arpie::SeparatorProtocol.new do |c|
+      c.send "hi"
+    end
+}

data/lib/arpie.rb

@@ -1,8 +1,6 @@
+require 'arpie/version'
 require 'arpie/error'
 require 'arpie/protocol'
 require 'arpie/binary'
 require 'arpie/binary_types'
-require 'arpie/xmlrpc'
-require 'arpie/server'
-require 'arpie/client'
-require 'arpie/proxy'
+require 'arpie/em'

data/lib/arpie/binary.rb

@@ -50,7 +50,7 @@ module Arpie
     @@description ||= {}
     @@hooks       ||= {}
 
-    #:stopdoc:
+    # @private
     @@anonymous ||= {}
     def self.__anonymous
       @@anonymous[self]
@@ -58,7 +58,6 @@ module Arpie
     def self.__anonymous= x
       @@anonymous[self] = x
     end
-    #:startdoc:
 
     def initialize
       @fields = {}
@@ -229,6 +228,17 @@ module Arpie
       end
     end
 
+    # You can use the field type as a class method to create new fields,
+    # as if you would call Binary.field with the appropriate parameters.
+    #
+    # Examples:
+    #   uint8 :nameof, :default => 1
+    #   fixed :fixedValue, :value => [1,2,3].pack("CCC")
+    #   list :ls, :of => :uint8, :sizeof => :nameof
+    def self.method_missing meth, *va, &block
+      self.field(va.shift, meth, *va, &block)
+    end
+
     # Specify that this Binary has a field of type +type+.
     # See the class documentation for usage.
     def self.field name, type = nil, opts = {}, &block
@@ -331,7 +341,7 @@ module Arpie
     # a complete Binary.
     def self.from binary, opts = {}
       @@fields[self] ||= []
-      binary = * self.call_hooks(:pre_from, binary)
+      binary, * = * self.call_hooks(:pre_from, binary)
 
       consumed_bytes = 0
       obj = new
@@ -373,7 +383,7 @@ module Arpie
       object.nil? and raise ArgumentError, "cannot #to nil"
       @@fields[self] ||= []
       r = []
-      object = * self.call_hooks(:pre_to, object)
+      object, * = * self.call_hooks(:pre_to, object)
 
       @@fields[self].each {|field| # name, klass, kopts, inline_handler|
         field.opts[:object] = object
@@ -435,5 +445,9 @@ module Arpie
     def self.post_from &handler
       self.add_hook(:post_from, handler)
     end
+
+    private
+    def self.to_ary *a
+    end
   end
 end

data/lib/arpie/binary/bytes_type.rb

@@ -29,7 +29,12 @@ module Arpie
       elsif opts[:length]
         len = case opts[:length]
           when :all
-            binary.size
+            if @pack_string == "Z"
+              npos = binary.index("\000") or raise EIncomplete
+              npos + 1
+            else
+              binary.size
+            end
           when Symbol
             opts[:object].send(opts[:length])
           else
@@ -74,7 +79,7 @@ module Arpie
   Binary.register_type(BytesBinaryType.new("a", :length => 1), :char)
   Binary.register_type(BytesBinaryType.new("a"), :bytes)
   Binary.register_type(BytesBinaryType.new("A"), :string)
-  Binary.register_type(BytesBinaryType.new("Z"), :nstring)
+  Binary.register_type(BytesBinaryType.new("Z", :length => :all), :nstring)
 
   Binary.register_type(BytesBinaryType.new("M"), :quoted_printable)
   Binary.register_type(BytesBinaryType.new("m"), :base64)

data/lib/arpie/binary/fixed_type.rb

@@ -7,6 +7,7 @@ module Arpie
     def from binary, opts
       opts[:value] or raise ArgumentError, "Requires option :value"
       sz = opts[:value].size
+      binary.size >= sz or incomplete!
       existing = binary.unpack("a#{sz}")[0]
       existing == opts[:value] or bogon! nil, ":fixed did not match data in packet"
 
@@ -23,13 +24,19 @@ module Arpie
   class Binary
     # Create a static field.
     # This is an alias for:
-    #  field :name, :fixed, :value => content
+    #  field :name, :fixed, :value => content, :default => content
     #
     # If no name is specified, it is assumed that the user will
     # never want to access it and a suitable one is autogenerated.
-    def self.static content, name = nil
-      name ||= "static-%x" % content.hash
-      field name, :fixed, :value => content
+    def self.static name_or_content, content = nil
+      if content.nil?
+        name = "static-%x" % [name_or_content.hash]
+        content = name_or_content
+      else
+        name = name_or_content
+      end
+
+      field name, :fixed, :value => content, :default => content
     end
 
     # An alias for +static+.

data/lib/arpie/binary/list_type.rb

@@ -67,6 +67,8 @@ module Arpie
         end
 
       else
+        raise StreamError, "length < 0" if length < 0
+
         for i in 0...length do
           cc, ate = type_of.from(binary[consumed .. -1], opts[:of_opts])
           list << cc

data/lib/arpie/binary/pack_type.rb

@@ -14,16 +14,26 @@ module Arpie
         count = 1 if count == 0
 
         length += case directive
-        when 'A', 'a', 'C', 'c', 'Z', 'x' : count
-        when 'B', 'b' : (count / 8.0).ceil
-        when 'D', 'd', 'E', 'G' : count * 8
-        when 'e', 'F', 'f', 'g' : count * 4
-        when 'H', 'h' : (count / 2.0).ceil
-        when 'I', 'i', 'L', 'l', 'N', 'V' : count * 4
-        when 'n', 'S', 's', 'v' : count * 2
-        when 'Q', 'q' : count * 8
-        when 'X' : count * -1
-        else raise ArgumentError, "#{directive} is not supported"
+        when 'A', 'a', 'C', 'c', 'Z', 'x'
+          count
+        when 'B', 'b'
+          (count / 8.0).ceil
+        when 'D', 'd', 'E', 'G'
+          count * 8
+        when 'e', 'F', 'f', 'g'
+          count * 4
+        when 'H', 'h'
+          (count / 2.0).ceil
+        when 'I', 'i', 'L', 'l', 'N', 'V'
+          count * 4
+        when 'n', 'S', 's', 'v'
+          count * 2
+        when 'Q', 'q'
+          count * 8
+        when 'X'
+          count * -1
+        else
+          raise ArgumentError, "#{directive} is not supported"
         end
       end
 

data/lib/arpie/em.rb

@@ -0,0 +1,48 @@
+module Arpie
+  module EventMachine
+    # A EventMachine protocol implementing a simple protocol
+    # chain handler. To use, simply include it in your EM
+    # Connection moduleas you would any other EM protocol.
+    #
+    # The module expects a list of protocols given along with
+    # the module initializer:
+    #   EM::start_server host, port, ArpieProtocol,
+    #     Arpie::MarshalProtocol.new, Arpie::SizedProtocol.new
+    #
+    # To receive messages, override <tt>receive(message)</tt>, which will
+    # be called once for each message decoded with the given
+    # protocols.
+    #
+    # To send messages back over the same connection, simply call
+    # <tt>send(message)</tt>.
+    module ArpieProtocol
+      attr_reader :chain
+
+      def initialize *protocols
+        @chain = Arpie::ProtocolChain.new(*protocols)
+      end
+
+      # Receive a message. Override this in your implemention.
+      def receive message
+      end
+
+      def receive_data data
+        begin
+          for msg in @chain.from(data)
+            receive msg
+          end
+        rescue Arpie::EIncomplete
+          nil
+        end
+      end
+
+      # Send a message, encoding it with the given
+      # protocols.
+      def send message
+        for msg in @chain.to(message)
+          send_data(msg)
+        end
+      end
+    end
+  end # module EventMachine
+end # module Arpie

data/lib/arpie/error.rb

@@ -6,18 +6,16 @@ module Arpie
   class StreamError < IOError ; end
   # Raised by arpie when a Protocol needs more data to parse a packet.
   # Usually only of relevance to the programmer when using Protocol#from directly.
-  class EIncomplete < RuntimeError ; end
+  class EIncomplete < Errno::EAGAIN ; end
 
-  # :stopdoc:
+  # @private
   # Used internally by arpie.
-  class ETryAgain < RuntimeError ; end
   class YieldResult < RuntimeError
     attr_reader :result
     def initialize result
       @result = result
     end
   end
-  # :startdoc:
 
   # Call this if you think the stream has been corrupted, or
   # non-protocol data arrived.

data/lib/arpie/protocol.rb

@@ -1,11 +1,10 @@
 require 'shellwords'
+require 'psych' if RUBY_VERSION =~ /^1.9/
 require 'yaml'
 require 'zlib'
 
 module Arpie
   MTU = 1024
-  # A RPC call. You need to wrap all calls sent over RPC protocols in this.
-  class RPCall < Struct.new(:ns, :meth, :argv, :uuid); end
 
   # A ProtocolChain wraps one or more Protocols to provide a parser
   # list, into which io data can be fed and parsed packets received; and
@@ -22,10 +21,6 @@ module Arpie
     # A buffer holding all parsed, but unreturned messages.
     attr_reader :messages
 
-    # The endpoint class of this Protocol.
-    # Defaults to Arpie::Endpoint
-    attr_accessor :endpoint_class
-
     # Create a new Chain. Supply an Array of Protocol
     # instances, where the leftmost is the innermost.
     #
@@ -39,8 +34,6 @@ module Arpie
           "The outermost protocol needs to be able to " +
           "separate messages in a stream (#{protocols.inspect} does not)."
 
-      @endpoint_class = Arpie::Endpoint
-
       @chain = protocols
       @buffer = ""
       @messages = []
@@ -163,7 +156,7 @@ module Arpie
     # Write +message+ to +io+.
     def write_message io, *messages
       binary = messages.map {|m| to(m)}
-      io.write(binary)
+      io.write(binary.flatten.join(""))
     end
 
     def reset
@@ -180,12 +173,12 @@ module Arpie
     # message separation within a stream.
     CAN_SEPARATE_MESSAGES = false
 
-    # :stopdoc:
+    # @private
     # The stowbuffer hash used by assemble! No need to touch this, usually.
     attr_reader :stowbuffer
+    # @private
     # The meta-information hash used by assemble! No need to touch this, usually.
     attr_reader :metabuffer
-    # :startdoc:
 
     # Convert obj to on-the-wire format.
     def to obj
@@ -212,12 +205,6 @@ module Arpie
       0
     end
 
-    # Call this within Protocol#from to reparse the current
-    # message.
-    def again!
-      raise ETryAgain
-    end
-
     # Stow away a message in this protocols buffer for later reassembly.
     # Optional argument: a token if you are planning to reassemble multiple
     # interleaved/fragmented message streams.
@@ -338,16 +325,13 @@ module Arpie
   # A protocol which encodes objects into YAML representation.
   # Messages are arbitary yaml-encodable objects.
   class YAMLProtocol < Protocol
-    CAN_SEPARATE_MESSAGES = true
-
     def to object
-      yield YAML.dump(object) + "...\n"
+      yield YAML.dump(object)
     end
 
     def from binary
-      index = binary =~ /^\.\.\.$/x or incomplete!
-      yield YAML.load(binary[0, index])
-      4 + index
+      yield YAML.load(binary)
+      binary.size
     end
   end
 

data/lib/arpie/version.rb

@@ -0,0 +1,3 @@
+module Arpie
+  VERSION = "0.1.0"
+end

data/spec/binary_spec.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
-describe "Binary" do
+describe Arpie::Binary do
 
   describe "empty:" do subject {
     [
@@ -9,7 +9,7 @@ describe "Binary" do
       ""
     ]
   }
-    it_should_behave_like "Binary Tests"
+    include_examples "Binary Tests"
   end
 
   describe "basic sanity:" do subject {
@@ -24,7 +24,7 @@ describe "Binary" do
     ]
   }
 
-    it_should_behave_like "Binary Tests with data"
+    include_examples "Binary Tests with data"
   end
 
   describe ".virtual:" do subject {
@@ -32,18 +32,26 @@ describe "Binary" do
       Class.new(Binary) do
         field :a, :uint8
         field :b, :uint8
+
         virtual :c, :uint8 do |o| o.a * o.b end
+
+        v :d, :uint8 do |o| 1 + o.c end
       end,
       [1, 2].pack("CC")
     ]
   }
 
-    it_should_behave_like "Binary Tests with data"
-
     it "evaluates the block given" do
       b, co = @c.from(@d)
       b.c.should == b.a * b.b
     end
+
+    it "evaluates nested virtuals" do
+      b, co = @c.from(@d)
+      b.d.should == b.c + 1
+    end
+
+    include_examples "Binary Tests with data"
   end
 
   describe ".aliases:" do subject {
@@ -58,7 +66,7 @@ describe "Binary" do
     ]
   }
 
-    it_should_behave_like "Binary Tests with data"
+    include_examples "Binary Tests with data"
   end
 
   describe ":default:" do subject {
@@ -72,8 +80,6 @@ describe "Binary" do
     ]
   }
 
-    it_should_behave_like "Binary Tests with data"
-
     it "does not use the default when a value was read" do
       b, con = @c.from([1, 2].pack("CC"))
       b.a.should == 1
@@ -86,7 +92,106 @@ describe "Binary" do
       b.b.should == 5
     end
 
+    it "uses the default for new binaries" do
+      new = @c.new
+      new.b.should == 5
+    end
+
+    include_examples "Binary Tests with data"
   end
 
+  describe ":fixed:" do subject {
+    [
+      Class.new(Binary) do
+        field :a, :fixed, :value => "abc"
+      end,
+      ["abc"].pack("a*")
+    ]
+  }
+
+    it "does not use the default for new binaries when using :fixed" do
+      @c.new.a.should == nil
+    end
 
+    it "fails on parsing invalid values" do
+      proc { @c.from("abd") }.should raise_error Arpie::StreamError
+    end
+
+    it "fails on setting invalid values" do
+      proc {
+        c = @c.new
+        c.a = "abd"
+        c.to
+      }.should raise_error Arpie::StreamError
+    end
+
+    include_examples "Binary Tests with data"
+  end
+
+  describe "static:" do subject {
+    [
+      Class.new(Binary) do
+        static :a, "abc"
+      end,
+      ["abc"].pack("a*")
+    ]
+  }
+
+    it "uses the default for new binaries" do
+      new = @c.new.to.should == "abc"
+    end
+
+    it "fails on parsing invalid values" do
+      proc { @c.from("abd") }.should raise_error Arpie::StreamError
+    end
+
+    it "fails on setting invalid values" do
+      proc {
+        c = @c.new
+        c.a = "abd"
+        c.to
+      }.should raise_error Arpie::StreamError
+    end
+
+    include_examples "Binary Tests with data"
+  end
+
+  describe "mod:" do
+    specify {
+      klass = Class.new(Binary) do
+        uint8 :int, :mod => 1
+        string :test, :sizeof => :uint8, :sizeof_opts => { :mod => -1 }
+      end
+
+      b, read = klass.from("\x01\x05abcde")
+      b.int.should == 2
+      b.test.should == "abcd"
+      read.should == 6
+    }
+  end
+
+  describe "short notation" do
+    describe "invalid fields" do
+      specify do
+        proc {
+          Class.new(Binary) do
+            invalid :xy
+          end
+        }.should raise_error ArgumentError
+      end
+    end
+
+    describe "simple types" do
+      subject {
+        [
+          Class.new(Binary) do
+            bytes :a, :length => 5
+          end,
+          ["abc01"].pack("a5")
+        ]
+      }
+
+      include_examples "Binary Tests with data"
+    end
+  end
 end