qpid_proton 0.4 → 0.5

data/lib/qpid_proton.rb

@@ -18,7 +18,12 @@
 #
 
 require "cproton"
+require "date"
 
+require "qpid_proton/described"
+require "qpid_proton/mapping"
+require "qpid_proton/array"
+require "qpid_proton/hash"
 require "qpid_proton/exceptions"
 require "qpid_proton/exception_handling"
 require "qpid_proton/message_format"

data/lib/qpid_proton/array.rb

@@ -0,0 +1,173 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+#--
+# Patch the Array class to provide methods for adding its contents
+# to a Qpid::Proton::Data instance.
+#++
+
+module Qpid
+
+  module Proton
+
+    # Holds the information for an AMQP Array compound type.
+    #
+    # It holds the type for the array and the descriptor if the
+    # array is described.
+    #
+    class ArrayHeader
+      attr_reader :type
+      attr_reader :descriptor
+
+      def initialize(type, descriptor = nil)
+        @type = type
+        @descriptor = descriptor
+      end
+
+      # Returns true if the array is described.
+      def described?
+        !@descriptor.nil?
+      end
+
+      def ==(that)
+        ((@type == that.type) && (@descriptor == that.descriptor))
+      end
+    end
+
+  end
+
+end
+
+class Array
+
+  # Used to declare an array as an AMQP array.
+  #
+  # The value, if defined, is an instance of Qpid::Proton::ArrayHeader
+  attr_accessor :proton_array_header
+
+  # Returns true if the array is the a Proton described type.
+  def proton_described?
+    !@proton_array_header.nil? && @proton_array_header.described?
+  end
+
+  # Puts the elements of the array into the specified Qpid::Proton::Data object.
+  def proton_put(data)
+    raise TypeError, "data object cannot be nil" if data.nil?
+
+    if @proton_array_header.nil?
+      proton_put_list(data)
+    else
+      proton_put_array(data)
+    end
+  end
+
+  private
+
+  def proton_put_list(data)
+    # create a list, then enter it and add each element
+    data.put_list
+    data.enter
+    each do |element|
+      # get the proton type for the element
+      mapping = Qpid::Proton::Mapping.for_class(element.class)
+      # add the element
+      mapping.put(data, element)
+    end
+    # exit the list
+    data.exit
+  end
+
+  def proton_put_array(data)
+    data.put_array(@proton_array_header.described?, @proton_array_header.type)
+    data.enter
+    if @proton_array_header.described?
+      data.symbol = @proton_array_header.descriptor
+    end
+
+    each do |element|
+      @proton_array_header.type.put(data, element)
+    end
+
+    data.exit
+  end
+
+  class << self
+
+    # Gets the elements of an array or list out of the specified
+    # Qpid::Proton::Data object.
+    def proton_get(data)
+      raise TypeError, "can't convert nil into Qpid::Proton::Data" if data.nil?
+
+      type = data.type
+
+      if type == Qpid::Proton::LIST
+        result = proton_get_list(data)
+      elsif type == Qpid::Proton::ARRAY
+        result = proton_get_array(data)
+      else
+        raise TypeError, "element is not a list and not an array"
+      end
+    end
+
+    private
+
+    def proton_get_list(data)
+      size = data.list
+      raise TypeError, "not a list" unless data.enter
+      elements = []
+      (0...size).each do
+        data.next
+        type = data.type
+        raise TypeError, "missing next element in list" unless type
+        elements << type.get(data)
+      end
+      data.exit
+      return elements
+    end
+
+    def proton_get_array(data)
+      count, described, type = data.array
+
+      raise TypeError, "not an array" unless data.enter
+      elements = []
+
+      descriptor = nil
+
+      if described
+        data.next
+        descriptor = data.symbol
+      end
+
+      elements.proton_array_header = Qpid::Proton::ArrayHeader.new(type, descriptor)
+      (0...count).each do |which|
+        if data.next
+          etype = data.type
+          raise TypeError, "missing next element in array" unless etype
+          raise TypeError, "invalid array element: #{etype}" unless etype == type
+          elements << type.get(data)
+        end
+      end
+      data.exit
+      return elements
+    end
+
+  end
+
+end
+

data/lib/qpid_proton/data.rb

@@ -17,6 +17,8 @@
 # under the License.
 #
 
+require 'cproton'
+
 module Qpid
 
   module Proton
@@ -51,27 +53,34 @@ module Qpid
     #
     # The following types of scalar values are supported:
     #
-    # * *:NULL*
-    # * *:BOOL*
-    # * *:UBYTE*
-    # * *:USHORT*
-    # * *:SHORT*
-    # * *:UINT*
-    # * *:INT*
-    # * *:ULONG*
-    # * *:LONG*
-    # * *:FLOAT*
-    # * *:DOUBLE*
-    # * *:BINARY*
-    # * *:STRING*
-    # * *:SYMBOL*
+    # * *NULL*
+    # * *BOOL*
+    # * *UBYTE*
+    # * *BYTE*
+    # * *USHORT*
+    # * *SHORT*
+    # * *UINT*
+    # * *INT*
+    # * *CHAR*
+    # * *ULONG*
+    # * *LONG*
+    # * *TIMESTAMP*
+    # * *FLOAT*
+    # * *DOUBLE*
+    # * *DECIMAL32*
+    # * *DECIMAL64*
+    # * *DECIMAL128*
+    # * *UUID*
+    # * *BINARY*
+    # * *STRING*
+    # * *SYMBOL*
     #
     # The following types of compound values are supported:
     #
-    # * *:DESCRIBED*
-    # * *:ARRAY*
-    # * *:LIST*
-    # * *:MAP*
+    # * *DESCRIBED*
+    # * *ARRAY*
+    # * *LIST*
+    # * *MAP*
     #
     class Data
 
@@ -115,13 +124,12 @@ module Qpid
         Cproton.pn_data_rewind(@data)
       end
 
-      # Advances the current node to tits next sibling and returns its types.
+      # Advances the current node to its next sibling and returns its types.
       #
       # If there is no next sibling the current node remains unchanged
       # and nil is returned.
-      def next
-        found = Cproton.pn_data_next(@data)
-        return found ? found : nil
+      def next(print = false)
+        Cproton.pn_data_next(@data)
       end
 
       # Advances the current node to its previous sibling and returns its type.
@@ -129,8 +137,7 @@ module Qpid
       # If there is no previous sibling then the current node remains unchanged
       # and nil is return.
       def prev
-        found = Cproton.pn_data_prev(@data)
-        return found ? found : nil
+        return Cproton.pn_data_prev(@data) ? type : nil
       end
 
       # Sets the parent node to the current node and clears the current node.
@@ -146,21 +153,26 @@ module Qpid
         Cproton.pn_data_exit(@data)
       end
 
-      # Returns the type of the current node.
-      def node_type
+      # Returns the numeric type code of the current node.
+      def type_code
         dtype = Cproton.pn_data_type(@data)
         return (dtype == -1) ? nil : dtype
       end
 
-      # Returns a representation of the data encoded. in AMQP format.
+      # Return the Type object for the current node
+      def type
+        Mapping.for_code(type_code)
+      end
+
+      # Returns a representation of the data encoded in AMQP format.
       def encode
-        size = 1024
+        buffer = "\0"*1024
         loop do
-          (cd, enc) = Cproton.pn_data_encode(@data, size)
+          cd = Cproton.pn_data_encode(@data, buffer, buffer.length)
           if cd == Cproton::PN_OVERFLOW
-            size *= 2
+            buffer *= 2
           elsif cd >= 0
-            return enc
+            return buffer[0...cd]
           else
             check(cd)
           end
@@ -175,7 +187,7 @@ module Qpid
       # * encoded - the encoded data
       #
       def decode(encoded)
-        check(Cproton.pn_data_decode(@data, encoded))
+        check(Cproton.pn_data_decode(@data, encoded, encoded.length))
       end
 
       # Puts a list value.
@@ -208,7 +220,7 @@ module Qpid
       #   @data.enter
       #   (0...count).each
       #     type = @data.next
-      #     puts "Value: #{@data.string}" if type == :STRING
+      #     puts "Value: #{@data.string}" if type == STRING
       #     # ... process other node types
       #   end
       def list
@@ -244,10 +256,10 @@ module Qpid
       #   @data.enter
       #   (0...count).each do
       #     type = @data.next
-      #     puts "Key=#{@data.string}" if type == :STRING
+      #     puts "Key=#{@data.string}" if type == STRING
       #     # ... process other key types
       #     type = @data.next
-      #     puts "Value=#{@data.string}" if type == :STRING
+      #     puts "Value=#{@data.string}" if type == STRING
       #     # ... process other value types
       #   end
       #   @data.exit
@@ -255,6 +267,10 @@ module Qpid
         Cproton.pn_data_get_map(@data)
       end
 
+      def get_map # :nodoc:
+        ::Hash.proton_data_get(self)
+      end
+
       # Puts an array value.
       #
       # Elements may be filled by entering the array node and putting the
@@ -273,7 +289,7 @@ module Qpid
       #
       #   # create an array of integer values
       #   data = Qpid::Proton::Data.new
-      #   data.put_array(false, :INT)
+      #   data.put_array(false, INT)
       #   data.enter
       #   data.int = 1
       #   data.int = 2
@@ -281,7 +297,7 @@ module Qpid
       #   data.exit
       #
       #   # create an array of double values
-      #   data.put_array(true, :DOUBLE)
+      #   data.put_array(true, DOUBLE)
       #   data.enter
       #   data.symbol = "array-descriptor"
       #   data.double = 1.1
@@ -290,8 +306,7 @@ module Qpid
       #   data.exit
       #
       def put_array(described, element_type)
-        check(Cproton.pn_data_put_array(@data, described,
-                                        Data.type_value(element_type)))
+        check(Cproton.pn_data_put_array(@data, described, element_type.code))
       end
 
       # If the current node is an array, returns a tuple of the element count, a
@@ -319,12 +334,12 @@ module Qpid
         count = Cproton.pn_data_get_array(@data)
         described = Cproton.pn_data_is_array_described(@data)
         array_type = Cproton.pn_data_get_array_type(@data)
-        if array_type == -1
-          array_type = nil
-        else
-          array_type = Data.type_name(array_type)
-        end
-        [count, described, array_type]
+        return nil if array_type == -1
+        [count, described, Mapping.for_code(array_type) ]
+      end
+
+      def get_array # :nodoc:
+        ::Array.proton_get(self)
       end
 
       # Puts a described value.
@@ -346,6 +361,19 @@ module Qpid
         check(Cproton.pn_data_put_described(@data))
       end
 
+      def get_described # :nodoc:
+        raise TypeError, "not a described type" unless self.described?
+        self.enter
+        self.next
+        type = self.type
+        descriptor = type.get(self)
+        self.next
+        type = self.type
+        value = type.get(self)
+        self.exit
+        Described.new(descriptor, value)
+      end
+
       # Checks if the current node is a described value.
       #
       # The described and value may be accessed by entering the described value.
@@ -366,6 +394,11 @@ module Qpid
         check(Cproton.pn_data_put_null(@data))
       end
 
+      # Utility method for Qpid::Proton::Mapping
+      def null=(value) # :nodoc:
+        null
+      end
+
       # Checks if the current node is null.
       def null?
         Cproton.pn_data_is_null(@data)
@@ -719,38 +752,22 @@ module Qpid
         Cproton.pn_data_get_symbol(@data)
       end
 
-      def self.add_item(key, value, name) # :nodoc:
-        @@type_value ||= {}
-        @@type_value[key] = value
-
-        @@type_name ||= {}
-        @@type_name[value] = key
-      end
-
-      # Returns the typename for the specified type.
-      #
-      # ==== Examples
-      #   # returns "null"
-      #   name = Qpid::Proton::Data.type_name(:NULL)
-      #
-      def self.type_name(key)
-        @@type_name[key]
+      # Get the current value as a single object.
+      def get
+        type.get(self);
       end
 
-      def self.type_value(key) # :nodoc:
-        @@type_value[key]
-      end
-
-      def self.const_missing(key) # :nodoc:
-        @@type_value[key]
+      # Put value as an object of type type_
+      def put(value, type_);
+        type_.put(self, value);
       end
 
       private
 
       def valid_uuid?(value)
-      # ensure that the UUID is in the right format
-      # xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
-      value =~ /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/
+        # ensure that the UUID is in the right format
+        # xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx
+        value =~ /[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}/
       end
 
       def check(err) # :nodoc:
@@ -760,35 +777,6 @@ module Qpid
           return err
         end
       end
-
-      self.add_item(:NULL,       Cproton::PN_NULL,       "null")
-      self.add_item(:BOOL,       Cproton::PN_BOOL,       "bool")
-      self.add_item(:UBYTE,      Cproton::PN_UBYTE,      "ubyte")
-      self.add_item(:BYTE,       Cproton::PN_BYTE,       "byte")
-      self.add_item(:USHORT,     Cproton::PN_USHORT,     "ushort")
-      self.add_item(:SHORT,      Cproton::PN_SHORT,      "short")
-      self.add_item(:UINT,       Cproton::PN_UINT,       "uint")
-      self.add_item(:INT,        Cproton::PN_INT,        "int")
-      self.add_item(:CHAR,       Cproton::PN_CHAR,       "char")
-      self.add_item(:ULONG,      Cproton::PN_ULONG,      "ulong")
-      self.add_item(:LONG,       Cproton::PN_LONG,       "long")
-      self.add_item(:TIMESTAMP,  Cproton::PN_TIMESTAMP,  "timestamp")
-      self.add_item(:FLOAT,      Cproton::PN_FLOAT,      "float")
-      self.add_item(:DOUBLE,     Cproton::PN_DOUBLE,     "double")
-      self.add_item(:DECIMAL32,  Cproton::PN_DECIMAL32,  "decimal32")
-      self.add_item(:DECIMAL64,  Cproton::PN_DECIMAL64,  "decimal64")
-      self.add_item(:DECIMAL128, Cproton::PN_DECIMAL128, "decimal128")
-      self.add_item(:UUID,       Cproton::PN_UUID,       "uuid")
-      self.add_item(:BINARY,     Cproton::PN_BINARY,     "binary")
-      self.add_item(:STRING,     Cproton::PN_STRING,     "string")
-      self.add_item(:SYMBOL,     Cproton::PN_SYMBOL,     "symbol")
-      self.add_item(:DESCRIBED,  Cproton::PN_DESCRIBED,  "described")
-      self.add_item(:ARRAY,      Cproton::PN_ARRAY,      "array")
-      self.add_item(:LIST,       Cproton::PN_LIST,       "list")
-      self.add_item(:MAP,        Cproton::PN_MAP,        "map")
-
     end
-
   end
-
 end