xml-mapping_extensions 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ed4292829e9d05dae2299e8d9f79d6e8e668db
-  data.tar.gz: 7980a10f39051df33fe45df96b0541d9242fcc00
+  metadata.gz: c4e7ef0d9b37dd1ecc3569d5aeadb75a9da079b1
+  data.tar.gz: 59a93fa0fa398f3ea4d493c7751f93e3ae34c9de
 SHA512:
-  metadata.gz: 2a79811d0aac935feb3e80dfa218d08f84f8d20726c34616dde559ec18c3422501ca6686affa8c8434470efc20b2319efb8765dceff3a829b7a6ce01ed157456
-  data.tar.gz: bbfb24c26fa14bebc99d5a6b84290ca1d3d1e9050828a534fa3616710bf6411f0c98e085ed2ab71e55cdb5971380a5e2f3d1d911b11929c3f606a857f1452e2a
+  metadata.gz: de2478465f7e44829e949505834d290274466d43d643bab3f8cef180fe35e7db1fd3c4ad0a1a07a022b818c5e5d84fb15f108c8a01eb1e58157dc27abaeec8a9
+  data.tar.gz: 19a67e611dfaf5ae7a8b509598faaa0c84546f0f5a98a3f27058f26cef646c278642b8e39a73a844eaa9a3eaf798698ac95bda6158737816fab92d7a0ba52234

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.4.6 (15 August 2016)
+
+- `TypesafeEnumNode.to_value()` now raises `ArgumentError` if the argument is not a valid value for the node's
+  enum type.
+- Added `#write_to_file` to simplify writing a root element to a file. 
+
 ## 0.4.5 (14 July 2016)
 
 - Make `#fallback_mapping` preserve the order of the fallback mapping instead of appending all fallback
@@ -5,7 +11,7 @@
 
 ## 0.4.4 (12 July 2016)
 
-- Add '#fallback_mapping'
+- Add `#fallback_mapping`
 
 ## 0.4.3 (11 July 2016)
 

data/lib/xml/mapping_extensions/typesafe_enum_node.rb

@@ -21,17 +21,20 @@ module XML
       end
 
       # Converts an enum value or value string to an enum instance
-      # @param xml_text the enum value or value string
-      # @return [TypesafeEnum::Base] an instance of the enum class declared in the initializer
+      # @param xml_text [String, nil] the enum value or value string
+      # @return [TypesafeEnum::Base, nil] an instance of the enum class declared in the initializer,
+      #   or nil if `xml_text` is nil
       def to_value(xml_text)
+        return nil unless xml_text
         enum_instance = @enum_class.find_by_value(xml_text)
         enum_instance = @enum_class.find_by_value_str(xml_text) unless enum_instance
+        fail ArgumentError, "No instance of enum class #{@enum_class.name} found for value '#{xml_text}'" unless enum_instance
         enum_instance
       end
 
       # Converts an enum value or value string to an enum instance
-      # @param enum_instance [TypesafeEnum::Base] an instance of the enum class declared in the initializer
-      # @return [String] the enum value as a string
+      # @param enum_instance [TypesafeEnum::Base, nil] an instance of the enum class declared in the initializer
+      # @return [String, nil] the enum value as a string, or nil if `enum_instance` is nil
       def to_xml_text(enum_instance)
         enum_instance.value.to_s if enum_instance
       end

data/lib/xml/mapping_extensions/version.rb

@@ -1,6 +1,6 @@
 module XML
   module MappingExtensions
     # The version of this gem
-    VERSION = '0.4.5'
+    VERSION = '0.4.6'
   end
 end

data/lib/xml/mapping_extensions.rb

@@ -34,7 +34,7 @@ module XML
 
   module Mapping
 
-    # Writes this mapped object as an XML string.
+    # Writes this mapped object as a pretty-printed XML string.
     #
     # @param options [Hash] the options to be passed to
     #   [XML::Mapping#save_to_xml](http://multi-io.github.io/xml-mapping/XML/Mapping.html#method-i-save_to_xml)
@@ -48,6 +48,27 @@ module XML
       io.string
     end
 
+    # Writes this mapped object to the specified file, as an XML document (including declaration).
+    #
+    # @param path [String] The path of the file to write to
+    # @param indent [Integer] The indentation level. Defaults to -1 (no indenting). Note
+    #   that this parameter will be ignored if `pretty` is present.
+    # @param pretty [Boolean] Whether to pretty-print the output. Defaults to `false`. Note
+    #   that this option overrides `indent`.
+    # @param options [Hash] the options to be passed to
+    #   [XML::Mapping#save_to_xml](http://multi-io.github.io/xml-mapping/XML/Mapping.html#method-i-save_to_xml)
+    def write_to_file(path, indent: -1, pretty: false, options: { mapping: :_default })
+      doc = REXML::Document.new
+      doc << REXML::XMLDecl.new
+      doc.elements[1] = save_to_xml(options)
+      File.open(path, 'w') do |f|
+        return doc.write(f, indent) unless pretty
+        formatter = REXML::Formatters::Pretty.new
+        formatter.compact = true
+        formatter.write(doc, f)
+      end
+    end
+
     # Additional accessors needed for `#fallback_mapping`.
     class Node
       attr_reader :attrname

data/spec/unit/xml/mapping_extensions/mapping_extensions_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'tempfile'
+require 'tmpdir'
 
 module XML
   module Mapping
@@ -61,6 +62,37 @@ module XML
       end
     end
 
+    describe '#write_to_file' do
+
+      before(:each) do
+        @obj = MXSpecObject.new
+        @obj.attribute = 123
+        @obj.text = 'element text'
+        @obj.children = ['child 1', 'child 2']
+        @expected = REXML::Document.new(@obj.write_xml)
+      end
+
+      it 'writes to a file' do
+        Dir.mktmpdir do |tmp|
+          outfile = "#{tmp}/mxspec.xml"
+          @obj.write_to_file(outfile, indent: 4)
+          outxml = File.read(outfile)
+          puts("'#{outxml}'")
+          expect(outxml).to be_xml(@expected)
+        end
+      end
+
+      it 'pretty-prints to a file' do
+        Dir.mktmpdir do |tmp|
+          outfile = "#{tmp}/mxspec.xml"
+          @obj.write_to_file(outfile, pretty: true)
+          outxml = File.read(outfile)
+          puts("'#{outxml}'")
+          expect(outxml).to be_xml(@expected)
+        end
+      end
+    end
+
     describe '#parse_xml' do
 
       before(:each) do

data/spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb

@@ -69,10 +69,14 @@ module XML
         end
       end
 
-      it 'parses a missing value as nil' do
+      it 'parses a nil value as nil' do
         expect(to_my_string_enum(nil)).to be_nil
       end
 
+      it 'raises ArgumentError for an invalid value' do
+        expect { to_my_string_enum('elvis') }.to raise_error(ArgumentError)
+      end
+
       it 'doesn\'t set an attribute for a nil value' do
         expect(string_enum_to_text(nil)).to be_nil
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mapping_extensions
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2016-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types