xml-mapping_extensions 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ad2038c6915f4e3195269c95f734366b100701f
-  data.tar.gz: e9385d3e05c59809e21425a2a2fada61975a35bf
+  metadata.gz: 6cbddeb5cebad76e112d491aa604c17a2662e3cd
+  data.tar.gz: 8b54eb808ba7ffb26ddd7bc43b00d8886c6fc9f9
 SHA512:
-  metadata.gz: 6f3af4513a661edf05a8ad119745fe5556e59e7ca4bf0de81def9962fe8e00446f8005af34f82c1273dc8d724b87c49f1350881048c9e29d103eb481ecaeaaee
-  data.tar.gz: 4af18d3e1fb46313683ea91e9ba60fc9e62ee36237783fda16cc691fa1c37b3148336deb6be2ab44e966bb03d8e68690862113ba4156c6de0edd07baa15f8a8e
+  metadata.gz: 5da4f0c98e7a224c6363a777ff8558a6fe5229ba7fb6af6f1a56309e2d844919cf01f60adedd6f21c55015b09989b7b5b76df81398a1d274a209a4f3e3ceb471
+  data.tar.gz: 91abdca7327b7075defe0d27c9a272fe59f442ed06cf5aa33689befe317f75e56908dfd2cdb0b32ea867c4917230e55b8a84aae73daf1df690382bcefb5cd93a

data/CHANGES.md

@@ -1,3 +1,9 @@
+## 0.3.0 (19 November 2015)
+
+- Replaced `EnumNodeBase` with (simpler) `TypesafeEnumNode` for interoperability
+  with [typesafe_enum](https://github.com/dmolesUC3/typesafe_enum) rather than
+  [ruby-enum](https://github.com/dblock/ruby-enum/)
+
 ## 0.2.1 (16 November 2015)
 
 - Modified `EnumNodeBase` to deal with either enum object instances or enum value

data/README.md

@@ -16,7 +16,6 @@ classes, or use one of the provided implementations.
 
 - `NodeBase`: Base class for simple single-attribute nodes that
    convert XML strings to object values.
-- `EnumNodeBase`: maps XML strings to `Ruby::Enum` values
 
 Note that you must call `::XML::Mapping.add_node_class` for your new node class
 to be registered with the XML mapping engine.
@@ -27,6 +26,7 @@ to be registered with the XML mapping engine.
 - `TimeNode`: ISO 8601 strings to `Time` objects
 - `UriNode`: maps URI strings to `URI` objects
 - `MimeTypeNode`: maps MIME type strings to `MIME::Type` objects
+- `TypesafeEnumNode`: maps XML strings to [typesafe_enum](https://github.com/dmolesUC3/typesafe_enum) values
 
 ### Example
 
@@ -50,13 +50,13 @@ end
 #### Reading XML:
 
 ```ruby
-xml_str = "<my_elem>
+xml_str = '<my_elem>
   <plain_date>1999-12-31</plain_date>
   <zulu_date>2000-01-01Z</zulu_date>
   <time>2000-01-01T02:34:56Z</time>
   <uri>http://example.org</uri>
   <mime_type>text/plain</mime_type>
-</my_elem>"
+</my_elem>'
 
 xml_doc = REXML::Document.new(xml_str)
 xml_elem = xml_doc.root

data/lib/xml/mapping_extensions/typesafe_enum_node.rb

@@ -0,0 +1,31 @@
+require_relative 'node_base'
+
+require 'typesafe_enum'
+
+module XML
+  module MappingExtensions
+
+    # Base class for single-attribute nodes with values that extend `TypesafeEnum::Base`
+    #
+    # Usage:
+    #     # for node class MyEnum
+    #     typesafe_enum_node :my_enum, '@my_enum', default_value: nil, class: MyEnum
+    class TypesafeEnumNode < NodeBase
+      def initialize(*args)
+        super
+        @enum_class = @options[:class]
+      end
+
+      def to_value(xml_text)
+        enum_instance = @enum_class.find_by_value(xml_text)
+        enum_instance = @enum_class.find_by_value_str(xml_text) unless enum_instance
+        enum_instance
+      end
+
+      def to_xml_text(enum_instance)
+        enum_instance.value.to_s if enum_instance
+      end
+    end
+    ::XML::Mapping.add_node_class TypesafeEnumNode
+  end
+end

data/lib/xml/mapping_extensions/version.rb

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

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

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module XML
+  module MappingExtensions
+
+    class MyStringEnum < TypesafeEnum::Base
+      [:FOO, :BAR, :BAZ_QUX].each { |k| new k }
+    end
+
+    class MySymbolEnum < TypesafeEnum::Base
+      new :FOO, :foo
+      new :BAR, :bar
+      new :BAZ_QUX, :baz_qux
+    end
+
+    class TypesafeEnumNodeSpecElem
+      include ::XML::Mapping
+      typesafe_enum_node :my_string_enum, '@my_string_enum', default_value: nil, class: MyStringEnum
+      typesafe_enum_node :my_symbol_enum, '@my_symbol_enum', default_value: nil, class: MySymbolEnum
+
+      root_element_name 'elem'
+    end
+
+    describe TypesafeEnumNode do
+
+      def to_my_string_enum(enum_str)
+        xml_string = enum_str ? "<elem my_string_enum='#{enum_str}'/>" : '<elem/>'
+        doc = REXML::Document.new(xml_string)
+        TypesafeEnumNodeSpecElem.load_from_xml(doc.root).my_string_enum
+      end
+
+      def to_my_symbol_enum(enum_str)
+        xml_string = enum_str ? "<elem my_symbol_enum='#{enum_str}'/>" : '<elem/>'
+        doc = REXML::Document.new(xml_string)
+        TypesafeEnumNodeSpecElem.load_from_xml(doc.root).my_symbol_enum
+      end
+
+      def string_enum_to_text(enum)
+        elem = TypesafeEnumNodeSpecElem.new
+        elem.my_string_enum = enum
+        xml = elem.save_to_xml
+        xml.attributes['my_string_enum']
+      end
+
+      def symbol_enum_to_text(enum)
+        elem = TypesafeEnumNodeSpecElem.new
+        elem.my_symbol_enum = enum
+        xml = elem.save_to_xml
+        xml.attributes['my_symbol_enum']
+      end
+
+      it 'works with a string enum' do
+        MyStringEnum.each do |enum|
+          expect(to_my_string_enum(enum.value)).to eq(enum)
+        end
+
+        MyStringEnum.each do |enum|
+          expect(string_enum_to_text(enum)).to eq(enum.value)
+        end
+      end
+
+      it 'works with a symbol enum' do
+        MySymbolEnum.each do |enum|
+          expect(to_my_symbol_enum(enum.value)).to eq(enum)
+        end
+
+        MySymbolEnum.each do |enum|
+          expect(symbol_enum_to_text(enum)).to eq(enum.value.to_s)
+        end
+      end
+
+      it 'parses a missing value as nil' do
+        expect(to_my_string_enum(nil)).to be_nil
+      end
+
+      it 'doesn\'t set an attribute for a nil value' do
+        expect(string_enum_to_text(nil)).to be_nil
+      end
+
+      it 'accepts enum constants' do
+        elem = TypesafeEnumNodeSpecElem.new
+        elem.my_string_enum = MyStringEnum::BAZ_QUX
+        xml_string = '<elem my_string_enum="baz_qux"/>'
+        expect(elem.save_to_xml).to be_xml(xml_string)
+      end
+
+      it 'round-trips to XML' do
+        xml_string = '<elem my_string_enum="baz_qux"/>'
+        doc = REXML::Document.new(xml_string)
+        elem = TypesafeEnumNodeSpecElem.load_from_xml(doc.root)
+        expect(elem.save_to_xml).to be_xml(xml_string)
+      end
+    end
+  end
+end

data/xml-mapping_extensions.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'mime-types', '~> 2.5'
-  spec.add_dependency 'ruby-enum', '~> 0.4'
+  spec.add_dependency 'typesafe_enum', '~> 0.1', '>= 0.1.1'
   spec.add_dependency 'xml-mapping', '~> 0.10'
 
   spec.add_development_dependency 'equivalent-xml', '~> 0.6.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-mapping_extensions
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - David Moles
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mime-types
@@ -25,19 +25,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: ruby-enum
+  name: typesafe_enum
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: xml-mapping
   requirement: !ruby/object:Gem::Requirement
@@ -183,20 +189,20 @@ files:
 - example.rb
 - lib/xml/mapping_extensions.rb
 - lib/xml/mapping_extensions/date_node.rb
-- lib/xml/mapping_extensions/enum_node_base.rb
 - lib/xml/mapping_extensions/mime_type_node.rb
 - lib/xml/mapping_extensions/node_base.rb
 - lib/xml/mapping_extensions/time_node.rb
+- lib/xml/mapping_extensions/typesafe_enum_node.rb
 - lib/xml/mapping_extensions/uri_node.rb
 - lib/xml/mapping_extensions/version.rb
 - spec/.rubocop.yml
 - spec/rspec_custom_matchers.rb
 - spec/spec_helper.rb
 - spec/unit/xml/mapping_extensions/date_node_spec.rb
-- spec/unit/xml/mapping_extensions/enum_node_base_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
+- spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb
 - spec/unit/xml/mapping_extensions/uri_node_spec.rb
 - xml-mapping_extensions.gemspec
 homepage: http://github.com/dmolesUC3/xml-mapping_extensions
@@ -228,9 +234,9 @@ test_files:
 - spec/rspec_custom_matchers.rb
 - spec/spec_helper.rb
 - spec/unit/xml/mapping_extensions/date_node_spec.rb
-- spec/unit/xml/mapping_extensions/enum_node_base_spec.rb
 - spec/unit/xml/mapping_extensions/mime_type_node_spec.rb
 - spec/unit/xml/mapping_extensions/node_base_spec.rb
 - spec/unit/xml/mapping_extensions/time_node_spec.rb
+- spec/unit/xml/mapping_extensions/typesafe_enum_node_spec.rb
 - spec/unit/xml/mapping_extensions/uri_node_spec.rb
 has_rdoc: 

data/lib/xml/mapping_extensions/enum_node_base.rb

@@ -1,30 +0,0 @@
-require_relative 'node_base'
-
-require 'ruby-enum'
-
-module XML
-  module MappingExtensions
-
-    # Base class for single-attribute nodes with `Ruby::Enum` values
-    #
-    # Usage:
-    #   - extend this class
-    #   - add an `ENUM_CLASS` constant whose value is the `Ruby::Enum` class
-    #     to be mapped
-    #   - call `::XML::Mapping.add_node_class` to add your new node class
-    class EnumNodeBase < NodeBase
-
-      def to_value(xml_text)
-        enum_class = self.class::ENUM_CLASS
-        enum_class.map do |_, enum|
-          return enum if enum.value == xml_text
-        end
-      end
-
-      def to_xml_text(value)
-        value.respond_to?(:value) ? value.value : value.to_s
-      end
-
-    end
-  end
-end

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

@@ -1,79 +0,0 @@
-require 'spec_helper'
-
-module XML
-  module MappingExtensions
-
-    class MyEnum
-      include Ruby::Enum
-
-      define :FOO, 'foo'
-      define :BAR, 'bar'
-      define :BAZ_QUX, 'baz_qux'
-    end
-
-    class MyEnumNode < EnumNodeBase
-      ENUM_CLASS = MyEnum
-    end
-    ::XML::Mapping.add_node_class(MyEnumNode)
-
-    class EnumNodeBaseSpecElem
-      include ::XML::Mapping
-      my_enum_node :my_enum, '@my_enum', default_value: nil
-
-      root_element_name 'elem'
-
-      def self.from_str(enum_str)
-        xml_string = enum_str ? "<elem my_enum='#{enum_str}'/>" : '<elem/>'
-        doc = REXML::Document.new(xml_string)
-        load_from_xml(doc.root)
-      end
-    end
-    describe EnumNodeBase do
-
-      def to_my_enum(str)
-        EnumNodeBaseSpecElem.from_str(str).my_enum
-      end
-
-      def to_text(enum)
-        elem = EnumNodeBaseSpecElem.new
-        elem.my_enum = enum
-        xml = elem.save_to_xml
-        xml.attributes['my_enum']
-      end
-
-      it 'parses an enum value' do
-        MyEnum.map do |_, enum|
-          expect(to_my_enum(enum.value)).to eq(enum)
-        end
-      end
-
-      it 'transforms an enum to a string' do
-        MyEnum.map do |_, enum|
-          expect(to_text(enum)).to eq(enum.value)
-        end
-      end
-
-      it 'parses a missing value as nil' do
-        expect(to_my_enum(nil)).to be_nil
-      end
-
-      it 'doesn\'t set an attribute for a nil value' do
-        expect(to_text(nil)).to be_nil
-      end
-
-      it 'accepts enum constants' do
-        elem = EnumNodeBaseSpecElem.new
-        elem.my_enum = MyEnum::BAZ_QUX
-        xml_string = '<elem my_enum="baz_qux"/>'
-        expect(elem.save_to_xml).to be_xml(xml_string)
-      end
-
-      it 'round-trips to XML' do
-        xml_string = '<elem my_enum="baz_qux"/>'
-        doc = REXML::Document.new(xml_string)
-        elem = EnumNodeBaseSpecElem.load_from_xml(doc.root)
-        expect(elem.save_to_xml).to be_xml(xml_string)
-      end
-    end
-  end
-end