xdr 2.0.0 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 841aa4d6061ac4e1989f6eb231c3b78fdc69b43f
-  data.tar.gz: d3342bce08c239465be256c53311d242d15fe658
+SHA256:
+  metadata.gz: 5e73176f8adac880de7eb0ed3761730773c9dadac9f572e9a9fd1f75ff396488
+  data.tar.gz: ea7c2d4f8fc312f33d4fb81be7a9074a6ed2f6e5dec2cccb41f7c00cdabff248
 SHA512:
-  metadata.gz: faaa298dac8ceed46a0f9d7c654e5e4daad1bf8fad2dfdd1cee350c84ec54c653b193653289ef4fecbc92922f72e79c32a41285a59b392f98c14e596861afd6a
-  data.tar.gz: 1bc9c094fec32a7e39338122696fb58cb3058099f29929abf7b87da9972d3ddab2e1e58ca691ac3ab8956694ffb767eb354ec6f39b3c80b9245be3f74123757b
+  metadata.gz: 9f6825750389ef2f19882533f169c9de4c05a264fa19228fcdbed3f3276196473d6e6e2cac75c420926a097f2543a71100cc17ad0784864e1c18c24da66aa455
+  data.tar.gz: 3c04035a3532da2c732aa47664a9bf4cfe79616806f3193948d5c8c37aa2c2862153cb2a74fe13b0afcb30d25f2f1f39729f510ac67655891a9d466de767ba64

data/CHANGELOG.md

@@ -1,17 +1,36 @@
-# Changelog 
+# Changelog
 
-All notable changes to this project will be documented in this
-file.  This project adheres to [Semantic Versioning](http://semver.org/).
+All notable changes to this project will be documented in this file.
 
-As this project is pre 1.0, breaking changes may happen for minor version
-bumps.  A breaking change will get clearly notified in this log.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [1.0.0](https://github.com/stellar/ruby-stellar-base/compare/v0.1.0...v1.0.0)
+### [3.0.3](https://github.com/astroband/ruby-xdr/compare/v3.0.2...v3.0.3) (2022-02-18)
+### Bug Fixes
+- make `XDR::Option` write empty strings as values ([#15](https://github.com/astroband/ruby-xdr/issues/15)) ([ccab229](https://github.com/astroband/ruby-xdr/commit/ccab22928a1104dee525211b51d1d567079d27ba))
 
+
+## [3.0.2](https://github.com/astroband/ruby-xdr/compare/v3.0.1...v3.0.2) - 2020-10-20
+### Changed
+- Relax lower bound for ActiveSupport dependency to support usage in Rails 4.2 ([#12](https://github.com/astroband/ruby-xdr/pull/12))
+
+### Bug Fixes
+- Fix non-bang arm accessors for XDR::Union ([#13](https://github.com/astroband/ruby-xdr/pull/13))
+- Fix .from_xdr encoding param to accept symbols ([#14](https://github.com/astroband/ruby-xdr/pull/14))
+
+
+## [3.0.1](https://github.com/astroband/ruby-xdr/compare/v3.0.0...v3.0.1) - 2020-06-10
+### Added
+- Add encoding parameter to Union#to_xdr ([#7](https://github.com/astroband/ruby-xdr/pull/7)).
+
+### Bug Fixes
+- Padding bytes are now properly validated when reading xdr values.  According to the XDR spec, padding must be zeros.
+
+
+## [1.0.0](https://github.com/astroband/ruby-xdr/compare/v0.1.0...v1.0.0) - 2015-10-02
 ### Added
 - the `to_xdr` helpers can take a second parameter that will encode the resulting output to hex or base64 when requested.
 - the `from_xdr` helpers can take a second parameter that will trigger a decode from hex or base64 of the provided string before decoding from xdr.
 
 ### Changed
-
 - `from_xdr` raises an ArgumentError when the input data is not fully consumed

data/README.md

@@ -3,7 +3,9 @@
 [![Build Status](https://travis-ci.org/stellar/ruby-xdr.svg?branch=master)](https://travis-ci.org/stellar/ruby-xdr)
 [![Code Climate](https://codeclimate.com/github/stellar/ruby-xdr/badges/gpa.svg)](https://codeclimate.com/github/stellar/ruby-xdr)
 
-XDR is an open data format, specified in [RFC 4506](http://tools.ietf.org/html/rfc4506.html).  This library provides a way to read and write XDR data from ruby.  It can read/write all of the primitive XDR types and also provides facilities to define readers for the compound XDR types (enums, structs and unions)
+XDR is an open data format, specified in [RFC 4506](http://tools.ietf.org/html/rfc4506.html). This library provides a
+way to read and write XDR data from ruby. It can read/write all of the primitive XDR types and also provides facilities
+to define readers for the compound XDR types (enums, structs and unions)
 
 ## Installation
 
@@ -15,28 +17,28 @@ gem 'xdr'
 
 And then execute:
 
-    $ bundle
+    bundle
 
 Or install it yourself as:
 
-    $ gem install xdr
+    gem install xdr
 
 ## Usage
 
 ```ruby
 # Reading/writing a primitive values
-XDR::Bool.to_xdr(false)                # => "\x00\x00\x00\x00"
+XDR::Bool.to_xdr(false) # => "\x00\x00\x00\x00"
 XDR::Bool.from_xdr("\x00\x00\x00\x01") # => true
 
 # Reading/writing arrays
-XDR::Array[XDR::Int,2].to_xdr([1,2]) # => "\x00\x00\x00\x01\x00\x00\x00\x02"
-XDR::Array[XDR::Int,2].from_xdr("\x00\x00\x00\x03\x00\x00\x00\x04") # => [3,4]
+XDR::Array[XDR::Int, 2].to_xdr([1, 2]) # => "\x00\x00\x00\x01\x00\x00\x00\x02"
+XDR::Array[XDR::Int, 2].from_xdr("\x00\x00\x00\x03\x00\x00\x00\x04") # => [3,4]
 
 # Defining an enum
 
 class ResultType < XDR::Enum
-  member :ok,       0
-  member :error,    1
+  member :ok, 0
+  member :error, 1
   seal
 end
 
@@ -88,22 +90,22 @@ Result.from_xdr("\x00\x00\x00\x00") # => #<Result ...>
 
 ## Thread safety
 
-Code generated by `xdrgen`, which targets this library, uses autoload extensively.
-Since autoloading is not thread-safe, neither is code generated from xdrgen. To
-work around this, any module including `XDR::Namespace` can be forced to load
+Code generated by `xdrgen`, which targets this library, uses autoload extensively. Since autoloading is not thread-safe,
+neither is code generated from xdrgen. To work around this, any module including `XDR::Namespace` can be forced to load
 all of it's children by calling `load_all!` on the module.
 
 ## Code generation
 
-ruby-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom data types.  Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen).  xdrgen will take your .x files and produce a set of ruby files that target this library to allow for your own custom types.
+ruby-xdr by itself does not have any ability to parse XDR IDL files and produce a parser for your custom data types.
+Instead, that is the responsibility of [xdrgen](http://github.com/stellar/xdrgen). `xdrgen` will take your `.x` files
+and produce a set of ruby files that target this library to allow for your own custom types.
 
-See [ruby-stellar-base](http://github.com/stellar/ruby-stellar-base) for an example (check out the generated directory)
+See [ruby-stellar-base](http://github.com/astroband/ruby-stellar-sdk/tree/master/base/generated) for an example.
 
 ## Contributing
 
-1. Sign the [Contributor License Agreement](http://goo.gl/forms/6r7I4S0K4z)
-2. Fork it ( https://github.com/stellar/ruby-xdr/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+1. Fork the repo ( https://github.com/astroband/ruby-xdr/fork )
+1. Create your feature branch (`git checkout -b my-new-feature`)
+1. Commit your changes (`git commit -am 'Add some feature'`)
+1. Push to the branch (`git push origin my-new-feature`)
+1. Create a new Pull Request

data/lib/xdr/array.rb

@@ -6,7 +6,7 @@ class XDR::Array
 
   def initialize(child_type, length)
     @child_type = child_type
-    @length     = length
+    @length = length
   end
 
   def write(val, io)
@@ -19,10 +19,10 @@ class XDR::Array
   end
 
   def read(io)
-    @length.times.map{ @child_type.read(io) }
+    @length.times.map { @child_type.read(io) }
   end
 
   def valid?(val)
     super(val) && val.length == @length
   end
-end
+end

data/lib/xdr/bool.rb

@@ -3,22 +3,22 @@ module XDR::Bool
 
   def self.write(val, io)
     case val
-    when true  ; XDR::Int.write(1, io)
-    when false ; XDR::Int.write(0, io)
-    else ; raise XDR::WriteError, "Invalid bool value: #{val}"
+    when true then XDR::Int.write(1, io)
+    when false then XDR::Int.write(0, io)
+    else; raise XDR::WriteError, "Invalid bool value: #{val}"
     end
   end
 
   def self.read(io)
     val = XDR::Int.read(io)
     case val
-    when 0 ; false
-    when 1 ; true
-    else ; raise XDR::ReadError, "Invalid bool value: #{val}"
+    when 0 then false
+    when 1 then true
+    else; raise XDR::ReadError, "Invalid bool value: #{val}"
     end
   end
 
   def self.valid?(val)
     val == true || val == false
   end
-end
+end

data/lib/xdr/concerns/array_converter.rb

@@ -1,5 +1,5 @@
 module XDR::Concerns::ArrayConverter
   def valid?(val)
-    val.is_a?(Array) && val.all?{|v| @child_type.valid?(v)}
+    val.is_a?(Array) && val.all? { |v| @child_type.valid?(v) }
   end
-end
+end

data/lib/xdr/concerns/converts_to_xdr.rb

@@ -1,91 +1,90 @@
-require 'base64'
+require "base64"
 
 module XDR::Concerns::ConvertsToXDR
   include XDR::Concerns::ReadsBytes
 
-  # 
+  #
   # Serialized the provided `val` to xdr and writes it to `io`
-  # 
+  #
+  # @abstract
   # @param val [Object] The object to serialize
-  # @param io [IO] an IO object to write to
-  # 
+  # @param io [#write] an IO object to write to
+  # @return [void]
   def write(val, io)
     raise NotImplementedError, "implement in including class"
   end
 
-  # 
+  #
   # Reads from the provided IO an instance of the implementing class
-  # @param io [IO] the io to read from
-  # 
+  #
+  # @abstract
+  # @param io [#read] the io to read from
   # @return [Object] the deserialized value
   def read(io)
     raise NotImplementedError, "implement in including class"
   end
 
-  # 
   # Returns true if the value provided is compatible with this serializer class
-  # 
+  #
+  # @abstract
   # @param value [Object] the value to test
-  # 
   # @return [Boolean] true if valid, false otherwise
   def valid?(value)
     raise NotImplementedError, "implement in including class"
   end
-  
-  # 
+
   # Serialized the provided val to xdr, returning a string
   # of the serialized data
-  # 
+  #
   # @param val [Object] the value to serialize
-  # 
+  # @param encoding [:raw|:hex|:base64] encode the result with specified codec
   # @return [String] the produced bytes
-  def to_xdr(val, encoding='raw')
-    raw = StringIO.
-      new.
-      tap{|io| write(val, io)}.
-      string.force_encoding("ASCII-8BIT")
+  def to_xdr(val, encoding = "raw")
+    io = StringIO.new
+    write(val, io)
+    raw = io.string.force_encoding("ASCII-8BIT")
 
-    case encoding
-    when 'raw' ; raw
-    when 'base64' ; Base64.strict_encode64(raw)
-    when 'hex' ; raw.unpack("H*").first
+    case String(encoding)
+    when "raw" then raw
+    when "hex" then raw.unpack1("H*")
+    when "base64" then Base64.strict_encode64(raw)
     else
-      raise  ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
+      raise ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
     end
   end
-  
-  # 
+
   # Deserializes an object from the provided string of bytes
-  # 
+  #
   # @param string [String] the bytes to read from
-  # 
+  # @param encoding [:raw|:hex|:base64] decode the input before deserialization
   # @return [Object] the deserialized value
-  def from_xdr(string, encoding='raw')
-    raw = case encoding
-          when 'raw' ; string
-          when 'base64' ; Base64.strict_decode64(string)
-          when 'hex' ; [string].pack("H*")
+  def from_xdr(string, encoding = "raw")
+    raw = case String(encoding)
+          when "raw" then string
+          when "hex" then [string].pack("H*")
+          when "base64" then Base64.strict_decode64(string)
           else
-            raise  ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
-          end
+            raise ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
+    end
 
     io = StringIO.new(raw)
     result = read(io)
 
     if io.pos != io.length
-      raise  ArgumentError, "Input string not fully consumed! are you decoding the right xdr type?"
+      raise ArgumentError, "Input string not fully consumed! are you decoding the right xdr type?"
     end
 
     result
   end
 
   private
+
   def padding_for(length)
     case length % 4
-    when 0 ; 0
-    when 1 ; 3
-    when 2 ; 2
-    when 3 ; 1
+    when 0 then 0
+    when 1 then 3
+    when 2 then 2
+    when 3 then 1
     end
   end
 end

data/lib/xdr/concerns/float_converter.rb

@@ -2,4 +2,4 @@ module XDR::Concerns::FloatConverter
   def valid?(val)
     val.is_a?(Float)
   end
-end
+end

data/lib/xdr/concerns/integer_converter.rb

@@ -2,4 +2,4 @@ module XDR::Concerns::IntegerConverter
   def valid?(val)
     val.is_a?(Integer)
   end
-end
+end

data/lib/xdr/concerns/reads_bytes.rb

@@ -1,8 +1,17 @@
 module XDR::Concerns::ReadsBytes
   private
+
   def read_bytes(io, length)
     io.read(length).tap do |bytes|
       raise EOFError if bytes.nil? || bytes.length != length
     end
   end
-end
+
+  def read_zeros(io, length)
+    read_bytes(io, length).each_byte do |byte|
+      raise XDR::ReadError unless byte == 0
+    end
+
+    nil
+  end
+end

data/lib/xdr/concerns/string_converter.rb

@@ -2,4 +2,4 @@ module XDR::Concerns::StringConverter
   def valid?(val)
     val.is_a?(String)
   end
-end
+end

data/lib/xdr/double.rb

@@ -8,7 +8,6 @@ module XDR::Double
   end
 
   def self.read(io)
-    read_bytes(io, 8).unpack("G").first
+    read_bytes(io, 8).unpack1("G")
   end
-
-end
+end

data/lib/xdr/dsl/enum.rb

@@ -1,17 +1,16 @@
 module XDR::DSL::Enum
-
   def member(name, value)
-    raise ArgumentError, "#{self} is sealed" if self.sealed
-    raise ArgumentError, "#{value} is not Integer" unless value.is_a?(Integer)
-    raise ArgumentError, "#{value} is already used" unless 
-
     name = name.to_s.underscore
 
+    raise ArgumentError, "#{self} is sealed" if sealed
+    raise ArgumentError, "#{value} is not Integer" unless value.is_a?(Integer)
+    raise ArgumentError, "#{value} is already used" if members.key?(name)
+
     instance = new(name, value)
-    self.members = self.members.merge(name => instance)
-    self.by_value = self.by_value.merge(instance.value => instance)
+    self.members = members.merge(name => instance)
+    self.by_value = by_value.merge(instance.value => instance)
 
-    class_eval <<-EOS, __FILE__, __LINE__
+    class_eval <<-EOS, __FILE__, __LINE__ + 1
       def self.#{name}
         members["#{name}"]
       end
@@ -21,4 +20,4 @@ module XDR::DSL::Enum
   def seal
     self.sealed = true
   end
-end
+end

data/lib/xdr/dsl/struct.rb

@@ -1,11 +1,10 @@
 module XDR::DSL::Struct
   def attribute(name, type)
-
     unless type.is_a?(XDR::Concerns::ConvertsToXDR)
       raise ArgumentError, "#{type} does not convert to xdr"
     end
 
-    self.fields = self.fields.merge(name => type)
+    self.fields = fields.merge(name => type)
 
     define_method name do
       read_attribute(name)

data/lib/xdr/dsl/union.rb

@@ -1,39 +1,39 @@
 module XDR::DSL::Union
   def switch_on(type, name)
-    raise ArgumentError if self.switch_type.present?
+    raise ArgumentError if switch_type.present?
     self.switch_type = type
     self.switch_name = name
 
     alias_method name, :switch
   end
 
-  def switch(switch, arm=nil)
-    raise ArgumentError, "`switch_on` not defined yet" if self.switch_type.nil?
+  def switch(switch, arm = nil)
+    raise ArgumentError, "`switch_on` not defined yet" if switch_type.nil?
 
     switch = normalize_switch_declaration(switch)
-    self.switches = self.switches.merge(switch => arm)
+    self.switches = switches.merge(switch => arm)
   end
 
   def attribute(name, type)
     raise ArgumentError, "#{type} does not convert to xdr" unless type.is_a?(XDR::Concerns::ConvertsToXDR)
 
-    self.arms = self.arms.merge(name => type)
+    self.arms = arms.merge(name => type)
     define_attribute_methods name
   end
 
   private
+
   def normalize_switch_declaration(switch)
-    case
-    when switch.is_a?(self.switch_type)
+    if switch.is_a?(switch_type)
       switch
-    when self.switch_type.valid?(switch)
+    elsif switch_type.valid?(switch)
       switch
-    when switch == :default
+    elsif switch == :default
       switch
-    when self.switch_type.respond_to?(:from_name)
-      self.switch_type.from_name(switch)
+    elsif switch_type.respond_to?(:from_name)
+      switch_type.from_name(switch)
     else
-      raise ArgumentError, "Cannot normalize switch: #{switch.inspect} to type: #{self.switch_type}"
+      raise ArgumentError, "Cannot normalize switch: #{switch.inspect} to type: #{switch_type}"
     end
   end
 end

data/lib/xdr/dsl.rb

@@ -4,4 +4,4 @@ module XDR::DSL
   autoload :Struct
   autoload :Union
   autoload :Enum
-end
+end

data/lib/xdr/enum.rb

@@ -7,7 +7,7 @@ class XDR::Enum
   class_attribute :sealed
   self.members = ActiveSupport::OrderedHash.new.with_indifferent_access
   self.by_value = ActiveSupport::OrderedHash.new
-  self.sealed  = false
+  self.sealed = false
 
   def self.write(val, io)
     raise XDR::WriteError, "Invalid enum value: #{val.inspect}" unless val.is_a?(self)
@@ -21,14 +21,14 @@ class XDR::Enum
       raise XDR::EnumValueError, "Unknown #{name} member: #{value}" if result.blank?
     end
   end
-  
+
   def self.valid?(val)
     val.is_a?(self)
   end
 
   def self.from_name(name)
     normalized = name.to_s.underscore
-    members[normalized].tap do |r|      
+    members[normalized].tap do |r|
       raise XDR::EnumNameError, "#{name} is not a member of #{self.name}" if r.blank?
     end
   end
@@ -37,12 +37,12 @@ class XDR::Enum
   attr_reader :value
 
   def initialize(name, value)
-    raise ArgumentError, "#{self.class} is sealed" if self.sealed
-    @name  = name
+    raise ArgumentError, "#{self.class} is sealed" if sealed
+    @name = name
     @value = value
   end
 
   def to_s
     "#{self.class.name}.#{@name}(#{@value})"
   end
-end
+end

data/lib/xdr/float.rb

@@ -8,7 +8,6 @@ module XDR::Float
   end
 
   def self.read(io)
-    read_bytes(io, 4).unpack("g").first
+    read_bytes(io, 4).unpack1("g")
   end
-
-end
+end

data/lib/xdr/hyper.rb

@@ -9,6 +9,6 @@ module XDR::Hyper
   end
 
   def self.read(io)
-    read_bytes(io, 8).unpack("q>").first
+    read_bytes(io, 8).unpack1("q>")
   end
-end
+end

data/lib/xdr/int.rb

@@ -9,6 +9,6 @@ module XDR::Int
   end
 
   def self.read(io)
-    read_bytes(io, 4).unpack("l>").first
+    read_bytes(io, 4).unpack1("l>")
   end
-end
+end

data/lib/xdr/namespace.rb

@@ -1,9 +1,9 @@
-# 
+#
 # A thin wrapper around ActiveSupport::Autoload configured to always eager_load
 # a child.  By calling `load_all!` on the namespace module, all children will
 # be eager loaded, allowing us to more easily operate in a multi-threaded
 # environment.
-# 
+#
 module XDR::Namespace
   extend ActiveSupport::Concern
 
@@ -14,13 +14,11 @@ module XDR::Namespace
   module ClassMethods
     def load_all!
       constants.each do |const_name|
-        begin
-          const = const_get const_name
-          const.public_send :load_all! if const.respond_to? :load_all!
-        rescue NameError => e
-          raise e unless e.message =~ /uninitialized constant #{const_name}/
-        end
+        const = const_get const_name
+        const.public_send :load_all! if const.respond_to? :load_all!
+      rescue NameError => e
+        raise e unless /uninitialized constant #{const_name}/.match?(e.message)
       end
     end
   end
-end
+end

data/lib/xdr/opaque.rb

@@ -12,17 +12,17 @@ class XDR::Opaque
   def read(io)
     # read and return @length bytes
     # throw away @padding bytes
-    read_bytes(io, @length).tap{ read_bytes(io, @padding) }
+    read_bytes(io, @length).tap { read_zeros(io, @padding) }
   end
 
-  def write(val,io)
+  def write(val, io)
     length = val.bytesize
-    
+
     if val.length != @length
-      raise XDR::WriteError, "Value length is #{length}, must be #{@length}" 
+      raise XDR::WriteError, "Value length is #{length}, must be #{@length}"
     end
 
     io.write val
     io.write "\x00" * @padding
   end
-end
+end

data/lib/xdr/option.rb

@@ -6,16 +6,16 @@ class XDR::Option
   attr_reader :child_type
 
   def initialize(child_type)
-    #TODO, raise an error if child_type is not ConvertToXDR
+    # TODO, raise an error if child_type is not ConvertToXDR
     @child_type = child_type
   end
 
   def write(val, io)
-    if val.present?
+    if val.nil?
+      XDR::Bool.write(false, io)
+    else
       XDR::Bool.write(true, io)
       @child_type.write(val, io)
-    else
-      XDR::Bool.write(false, io)
     end
   end
 
@@ -27,4 +27,4 @@ class XDR::Option
   def valid?(val)
     val.nil? || @child_type.valid?(val)
   end
-end
+end

data/lib/xdr/quadruple.rb

@@ -2,4 +2,4 @@ module XDR::Quadruple
   extend XDR::Concerns::ConvertsToXDR
 
   # No support for quads, so we don't overide read/write
-end
+end