xdr 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf995b29e360c1ebdc82ee5c94ea470d7d8e87a577263f2faeb8fd3d7fce4a62
-  data.tar.gz: ad232ebcb97bef9e00e9fd1103a37cf87941171e5d6fdb89a38addef8ea1afa6
+  metadata.gz: 1f0a7d79379430aafb61eed9de69792863eae9f09d6879b9c45a6dfdf4899423
+  data.tar.gz: 4077d91ba3482d12749dfebfd8af588c8ed8a71ed0ffbc84328752f18bc6099c
 SHA512:
-  metadata.gz: 7026fd132281c4955332ae9acbd4757c1e0d61e29b900139cc24475e8e347381da3c77f04896ea3841a81b790972fc8bc4fa0c79c36922315283921b6c456836
-  data.tar.gz: 9db16c2e581691273a475f6044fcff536accc8a9531c195571b784aaee2534f47409593b54d2c9102072ba9eea8a7871348dbafb789a99eee34e17b3b958d28b
+  metadata.gz: '087033c3d5e43816556e6265b76892f64c193764af9342eec0e15e1ff615c2f1bed2ef1900d02fc6cd54afb3e158fe081b1a4b966fba019275d48e6c66cb14ac'
+  data.tar.gz: 01b99345355417827e4087075724186082f713c807612a4ac481a9d84bfefeb6bac31abc9819f0c807ce0d31296f2854dd055f03b4b17c1257c27feb0151e442

data/CHANGELOG.md

@@ -1,28 +1,31 @@
 # 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).
 
-## [Unreleased](https://github.com/stellar/ruby-xdr/compare/v3.0.1...master)
+## [Unreleased](https://github.com/stellar/ruby-xdr/compare/v3.0.2...master)
 
-## [3.0.1](https://github.com/stellar/ruby-xdr/compare/v3.0.0...v3.0.1)
+## [3.0.2](https://github.com/stellar/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/stellar/ruby-xdr/pull/12])
 
+### Fixed
+- Fix non-bang arm accessors for XDR::Union ((#13)[https://github.com/stellar/ruby-xdr/pull/13])
+- Fix .from_xdr encoding param to accept symbols ((#14)[https://github.com/stellar/ruby-xdr/pull/14])
 
+## [3.0.1](https://github.com/stellar/ruby-xdr/compare/v3.0.0...v3.0.1) - 2020-06-10
 ### Added
 - Add encoding parameter to Union#to_xdr ((#7)[https://github.com/stellar/ruby-xdr/pull/7]).
 
 ### Fixed
 - 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/stellar/ruby-xdr/compare/v0.1.0...v1.0.0)
-
+## [1.0.0](https://github.com/stellar/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

@@ -95,9 +95,11 @@ 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
 

data/lib/xdr/concerns/converts_to_xdr.rb

@@ -5,68 +5,66 @@ module XDR::Concerns::ConvertsToXDR
 
   # 
   # 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.to_s
-    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.unpack("H*").first
+    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'"
+            raise ArgumentError, "Invalid encoding #{encoding.inspect}: must be 'raw', 'base64', or 'hex'"
           end
 
     io = StringIO.new(raw)
@@ -80,6 +78,7 @@ module XDR::Concerns::ConvertsToXDR
   end
 
   private
+
   def padding_for(length)
     case length % 4
     when 0 ; 0

data/lib/xdr/union.rb

@@ -102,14 +102,17 @@ class XDR::Union
 
   alias get value
 
-  def attribute!(attr)
-    if @arm.to_s != attr
-      raise XDR::ArmNotSetError, "#{attr} is not the set arm"
-    end
+  def attribute(attr)
+    return nil unless @arm.to_s == attr
 
     get
   end
 
+  def attribute!(attr)
+    raise XDR::ArmNotSetError, "#{attr} is not the set arm" unless @arm.to_s == attr
+
+    get
+  end
 
   #
   # Compares two unions for equality

data/lib/xdr/version.rb

@@ -1,3 +1,3 @@
 module XDR
-  VERSION = "3.0.1"
+  VERSION = "3.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xdr
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Scott Fleckenstein
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2020-06-10 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,117 +16,95 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: 
+        version: '0.19'
+description:
 email:
 - scott@stellar.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+- CHANGELOG.md
 files:
-- ".gitignore"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
-- Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- examples/enum.rb
-- examples/struct.rb
-- examples/union.rb
 - lib/xdr.rb
 - lib/xdr/array.rb
 - lib/xdr/bool.rb
@@ -163,38 +141,15 @@ files:
 - lib/xdr/var_opaque.rb
 - lib/xdr/version.rb
 - lib/xdr/void.rb
-- spec/lib/xdr/array_spec.rb
-- spec/lib/xdr/bool_spec.rb
-- spec/lib/xdr/concerns/converts_to_xdr_spec.rb
-- spec/lib/xdr/concerns/reads_bytes_spec.rb
-- spec/lib/xdr/double_spec.rb
-- spec/lib/xdr/dsl/enum_spec.rb
-- spec/lib/xdr/dsl/struct_spec.rb
-- spec/lib/xdr/dsl/union_spec.rb
-- spec/lib/xdr/enum_spec.rb
-- spec/lib/xdr/float_spec.rb
-- spec/lib/xdr/hyper_spec.rb
-- spec/lib/xdr/int_spec.rb
-- spec/lib/xdr/opaque_spec.rb
-- spec/lib/xdr/option_spec.rb
-- spec/lib/xdr/quadruple_spec.rb
-- spec/lib/xdr/rpc/record_reader_spec.rb
-- spec/lib/xdr/string_spec.rb
-- spec/lib/xdr/struct_spec.rb
-- spec/lib/xdr/union_spec.rb
-- spec/lib/xdr/unsigned_hyper_spec.rb
-- spec/lib/xdr/unsigned_int_spec.rb
-- spec/lib/xdr/var_array_spec.rb
-- spec/lib/xdr/var_opaque_spec.rb
-- spec/lib/xdr/void_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/eq_bytes.rb
-- xdr.gemspec
 homepage: https://github.com/stellar/ruby-xdr
 licenses:
-- Apache 2.0
-metadata: {}
-post_install_message: 
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/stellar/ruby-xdr/issues
+  changelog_uri: https://github.com/stellar/ruby-xdr/blob/v3.0.2/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/xdr/3.0.2/
+  source_code_uri: https://github.com/stellar/ruby-xdr/tree/v3.0.2
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -202,41 +157,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: XDR Helper Library
-test_files:
-- spec/lib/xdr/array_spec.rb
-- spec/lib/xdr/bool_spec.rb
-- spec/lib/xdr/concerns/converts_to_xdr_spec.rb
-- spec/lib/xdr/concerns/reads_bytes_spec.rb
-- spec/lib/xdr/double_spec.rb
-- spec/lib/xdr/dsl/enum_spec.rb
-- spec/lib/xdr/dsl/struct_spec.rb
-- spec/lib/xdr/dsl/union_spec.rb
-- spec/lib/xdr/enum_spec.rb
-- spec/lib/xdr/float_spec.rb
-- spec/lib/xdr/hyper_spec.rb
-- spec/lib/xdr/int_spec.rb
-- spec/lib/xdr/opaque_spec.rb
-- spec/lib/xdr/option_spec.rb
-- spec/lib/xdr/quadruple_spec.rb
-- spec/lib/xdr/rpc/record_reader_spec.rb
-- spec/lib/xdr/string_spec.rb
-- spec/lib/xdr/struct_spec.rb
-- spec/lib/xdr/union_spec.rb
-- spec/lib/xdr/unsigned_hyper_spec.rb
-- spec/lib/xdr/unsigned_int_spec.rb
-- spec/lib/xdr/var_array_spec.rb
-- spec/lib/xdr/var_opaque_spec.rb
-- spec/lib/xdr/void_spec.rb
-- spec/spec_helper.rb
-- spec/support/matchers/eq_bytes.rb
+test_files: []