skn_utils 3.3.12 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6048e54b3ef049c2f0cc12d2e5d8c1068464bf9
-  data.tar.gz: 13d07f94bf6785297b7da9f407447abe7ea0242c
+  metadata.gz: d855808b255a82843fa3fe92df17e71473f2f61b
+  data.tar.gz: 6cad163a2d5269b36d874c8e524bcf74f517f1c0
 SHA512:
-  metadata.gz: 491f607e8959573f8d9a8806d1447802507fb50a8ae51487fa428421a87c3b20569fe62212f0cc6a1b6226182dba2f25a6813515fe78fa60bced473fcb8be1fe
-  data.tar.gz: 8237f57472729b24e8b25b7346bdda8413f0d0616f1942dbda9d6cda1f05a558c91441ba68d0f40fcbc48a65bb8b8b7678a23790ebef05cfd1a861dbb055da5e
+  metadata.gz: 5bae4958839f86632dbdaf840120e755e668719f3d0f49d8a25fa4ed729c25b2296c25d639fbf0f4c81f5403b0cf423a6421d39d448f65b8bd90c0be8da1f3ea
+  data.tar.gz: 7ac67cbc92251445e2cacb367d01658395d92e6d5ab057a15a1242140cd1c93bdbdb5ca83f29370dd341433298b6982253b8e70ab11be13a302796cee3afbbef

data/README.md

@@ -16,6 +16,9 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 
 
 ## New Features
+    09/2017  V3.4.0
+    Added HashToXml class which converts complex/simple hashes into XML. pre-req's Nokogiri 1.8.0 or higher, unless Rails present, then uses version included with rails.
+
     08/2017  V3.3.0
     Added Linked List classes which implement Single, Double, and Circular linked lists patterns.  LinkedLists are implemented
     with method results returning node values or the nodes themselves.
@@ -55,12 +58,14 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 ## Public Components
     SknUtils::NestedResult           # >= V 3.0.0 Primary Key/Value Container with Dot/Hash notiation support.
     SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.
-    SknUtils::Configurable           # Basic one-level configuration settings module for Applications and or Gems
-
     SknHash                          # Wrapper for name only, WITHOUT SknUtils namespace, inherits from SknUtils::NestedResult
     SknUtils::ResultBean             # Wrapper for name only, inherits from SknUtils::NestedResult
     SknUtils::PageControls           # Wrapper for name only, inherits from SknUtils::NestedResult
 
+    SknUtils::Configurable           # Basic one-level configuration settings module for Applications and or Gems
+    SknUtils::Converters::HashToXml  # #call(hash) to convert Ruby complex hashes into XML
+
+
     SknUtils::List::LinkedList          # List with forward (#next) navigation, and tail/open
     SknUtils::List::DoublyLinkedList    # List with forward (#next) and backward (#prev) navigation, and head/tail open
     SknUtils::List::CircularLinkedList  # List with forward (#next) and backward (#prev) navigation, and head/tail wrapping

data/lib/skn_utils/converters/hash_to_xml.rb

@@ -0,0 +1,98 @@
+## lib/skn_utils/converters/hash_to_xml.rb
+#
+# Converts Simple Hash to XML, or a Complex nested hash to XML
+# Ref: https://stackoverflow.com/questions/11933451/converting-nested-hash-into-xml-using-nokogiri
+#
+# Input Format:
+# {
+#   someKey: someValue,
+#   list: {item: [1,2,3]},
+#   listings: {
+#       uri: 'topic/content/topic_value',
+#       '@attributes' => {secured: true}
+#   }
+# }
+#
+# - produces:
+# <?xml version="1.0"?>
+# <root>
+#   <one>1</one>
+#   <two>2</two>
+#   <list>
+#     <item>1</item>
+#     <item>2</item>
+#     <item>3</item>
+#   </list>
+#   <listings secured="true">
+#     <uri>topic/content/topic_value</uri>
+#   </listings>
+# </basic>
+##
+# xml_string = SknUtils::Converters::HashToXml.call(hash)
+##
+module SknUtils
+  module Converters
+
+    class HashToXml
+
+      def initialize(*args)
+      end
+
+      def self.call(*vargs_with_at_least_one_hash, &block)
+        new().call(*vargs_with_at_least_one_hash, &block)
+      end
+
+      def call(*vargs, &block)
+        return nil if vargs.size == 0
+        hash = generate_xml(*vargs )
+          yield hash if block_given?
+        hash
+      end
+
+    protected
+
+      ##
+      # generate xml from a hash of hashes or array of hashes
+      def generate_xml(data, parent = false, opt = {})
+        return if data.to_s.empty?
+        return unless data.is_a?(Hash)
+
+        unless parent
+          # assume that if the hash has a single key that it should be the root
+          root, data = (data.length == 1) ? [data.keys.first.to_s , data] : ["root", data]
+          builder = ::Nokogiri::XML::Builder.new(opt.merge(:encoding => 'UTF-8')) do |xml|
+            xml.send(root) {
+              generate_xml(data, xml)
+            }
+          end
+
+          return builder.to_xml
+        end
+
+        data.each do |label, value|
+          if value.is_a?(Hash)
+            attrs = value.fetch('@attributes', {})
+            # also passing 'text' as a key makes nokogiri do the same thing
+            text = value.fetch('@text', '')
+            parent.send(label, attrs, text) {
+              value.delete('@attributes')
+              value.delete('@text')
+              generate_xml(value, parent)
+            }
+
+          elsif value.is_a?(Array)
+            value.each do |el|
+              # lets trick the above into firing so we do not need to rewrite the checks
+              el = {label => el}
+              generate_xml(el, parent)
+            end
+
+          else
+            parent.send(label, value)
+          end
+        end
+      end # end method
+
+    end # end class
+  end
+end

data/lib/skn_utils/exploring/action_service.rb

@@ -1,6 +1,6 @@
 ## lib/skn_utils/action_service.rb
 #
-# Exploritory Action/Service Class
+# Exploratory Action/Service Class
 # Ref: https://blog.lelonek.me/what-service-objects-are-not-7abef8aa2f99#.p64vudxq4
 #      http://sporto.github.io/blog/2012/11/15/a-pattern-for-service-objects-in-rails/
 #

data/lib/skn_utils/version.rb

@@ -2,8 +2,8 @@
 module SknUtils
   class Version
     MAJOR = 3
-    MINOR = 3
-    PATCH = 12
+    MINOR = 4
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/skn_utils.rb

@@ -6,6 +6,7 @@ require 'date'
 require 'time'
 unless defined?(Rails)
   require 'deep_merge'
+  require 'nokogiri'
 end
 require 'skn_utils/nested_result'
 require 'skn_utils/result_bean'
@@ -23,6 +24,9 @@ require 'skn_utils/lists/circular_linked_list'
 # require 'skn_utils/exploring/commander'
 # require 'skn_utils/exploring/action_service'
 # require 'skn_utils/exploring/configuration'
+if defined?(::Nokogiri)
+  require 'skn_utils/converters/hash_to_xml'
+end
 require 'skn_hash'
 require 'skn_settings'
 

data/skn_utils.gemspec

@@ -41,4 +41,6 @@ EOF
   spec.add_development_dependency "pry", ">= 0"
   spec.add_development_dependency "simplecov", ">= 0"
   spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'nokogiri', '~> 1.8.0'
+
 end

data/spec/lib/skn_utils/converters/hash_to_xml_spec.rb

@@ -0,0 +1,120 @@
+##
+# spec/lib/skn_utils/converters/hash_to_xml_spec.rb
+#
+
+describe SknUtils::Converters::HashToXml,  "Hash to XML Converter Utility " do
+
+  context "Initializers Feature. " do
+
+    it "#new can be called without params or block without error. " do
+      expect( described_class.new()).to be_a described_class
+    end
+
+    it "#call can be called without params or block without error. " do
+      expect( described_class.call()).to be nil
+    end
+
+    it "#call called with params returns xml string as expected. " do
+      string = described_class.call({
+                                      one: 1,
+                                      two: 2,
+                                      list: {item: [1,2,3]},
+                                      listings: {item: [1,2,3]}
+                                    })
+      puts __method__, string
+      expect(string).to be_a String
+    end
+
+    it "#call called with params and block yields xml string as expected. " do
+      described_class.call({
+                             one: 1,
+                             two: 2,
+                             list: {item: [1,2,3]},
+                             listings: {item: [1,2,3]}
+                           }) do |string|
+        puts __method__, string
+        expect(string).to be_a String
+      end
+    end
+
+  end
+
+  context "Handles Complex Hashes. " do
+    let(:array_of_hashes) {
+        {'resource' => [
+                      { 'name' => 'category1',
+                        'subCategory' => [
+                            { 'name' => 'subCategory1',
+                              'product' => [
+                                  { 'name' => 'productName1',
+                                    'desc' => 'desc1' },
+                                  { 'name' => 'productName2',
+                                    'desc' => 'desc2' } ]
+                            } ]
+                      },
+                      { 'name' => 'category2',
+                        'subCategory' => [
+                            { 'name' => 'subCategory2.1',
+                              'product' => [
+                                  { 'name' => 'productName2.1.1',
+                                    'desc' => 'desc1' },
+                                  { 'name' => 'productName2.1.2',
+                                    'desc' => 'desc2' } ]
+                            } ]
+                      }
+                   ]
+        }
+    }
+
+    let(:xml_aware_hash) {
+                    {'xmlAwareHash' =>
+                      {
+                        'num' => 99,
+                        'title' => 'something witty',
+                        'nested' => {
+                          'total' => [99, 98],
+                          '@attributes' => {'foo' => 'bar', 'hello' => 'world'}
+                        },
+                        'anothernest' => {
+                          '@attributes' => {'foo' => 'bar', 'hello' => 'world'},
+                          'date' => [
+                            'today',
+                            {'day' => 23, 'month' => 'Dec',
+                              'year' => {'y' => 1999, 'c' => 21},
+                              '@attributes' => {'foo' => 'blhjkldsaf'}
+                            }
+                          ]
+                        }
+                      }
+                    }
+    }
+
+    it "#call(nested_hash) return an xml string as expected." do
+      string = described_class.call({
+                                      one: 1,
+                                      two: 2,
+                                      list: {item: [1,2,3]},
+                                      listings: {
+                                          uri: 'topic/content/topic_value',
+                                          '@attributes' => {secured: true}}
+                                    })
+      puts __method__, string
+      expect( string ).to be_a String
+    end
+
+    it "#call(array_of_hashes) return an xml string as expected." do
+      string = described_class.call(array_of_hashes, false)
+      puts __method__, string
+      expect( string ).to be_a String
+    end
+
+    it "#call(xml_aware_hash) return an xml string as expected." do
+      string = described_class.call(xml_aware_hash)
+      puts __method__, string
+      expect( string ).to be_a String
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -16,7 +16,6 @@ require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
 require 'skn_utils/exploring/configuration'
 require 'skn_utils/business_services/year_month'
-
 require 'rspec'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.3.12
+  version: 3.4.0
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 description: "The intent of the NestedResult class is to be a container for data values
   composed of key/value pairs, \nwith easy access to its contents, and on-demand transformation
   back to the hash (#to_hash).\n\nReview the RSpec tests, and or review the README
@@ -136,6 +150,7 @@ files:
 - lib/skn_utils.rb
 - lib/skn_utils/business_services/year_month.rb
 - lib/skn_utils/configurable.rb
+- lib/skn_utils/converters/hash_to_xml.rb
 - lib/skn_utils/exploring/action_service.rb
 - lib/skn_utils/exploring/commander.rb
 - lib/skn_utils/exploring/configuration.rb
@@ -158,6 +173,7 @@ files:
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/business_services/year_month_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
+- spec/lib/skn_utils/converters/hash_to_xml_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb
@@ -206,6 +222,7 @@ test_files:
 - spec/lib/skn_settings_spec.rb
 - spec/lib/skn_utils/business_services/year_month_spec.rb
 - spec/lib/skn_utils/configurable_spec.rb
+- spec/lib/skn_utils/converters/hash_to_xml_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb