chef-gyoku 1.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 961beab424895dc794bc90010c758f6b6ce1423a8b2b1248c64796a7874cc76e
+  data.tar.gz: bef27d17bcc60cb5e2c10761230bcfa459243e2c71240229816fa036c82b40d1
+SHA512:
+  metadata.gz: 0255cddf2cc2448f6f30840ac97f54c846d7e9a8728087318d67bb149d0efaf2208bfd2e87ca0c41050a2d5abfd84b4e01872c81739c55b9e8c88867be41a45f
+  data.tar.gz: fa9bf05243f96bda7ab2564c805c817e2cdab018112773660f9214ec8151084a7f3e1f932f804b8506d8977db0f460396084833143d39fb678b7cfc6216bc91e

data/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    name: Ruby ${{ matrix.ruby }}
+
+    strategy:
+      fail-fast: true
+      matrix:
+        ruby:
+          - '3.2'
+          - '3.1'
+          - '3.0'
+          - 'jruby'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # 'bundle install' and cache
+
+      - name: Run tests
+        run: bundle exec rake --trace
+        continue-on-error: false
+
+  coveralls:
+    name: Coveralls
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rake
+
+      - name: Report coverage
+        uses: coverallsapp/github-action@v2
+        with:
+          flag-name: ruby-3.2

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+.yardoc
+doc
+coverage
+tmp
+*~
+*.swp
+*.gem
+.bundle
+Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,154 @@
+# CHANGELOG
+
+## 1.4.0 (2022-04-01)
+
+### Fixed
+
+- Fix [Issue #56](https://github.com/savonrb/gyoku/issues/56) with PR [#57](https://github.com/savonrb/gyoku/pull/57). Thanks, [@jpmoral]!
+- Avoid circular reference [#69](https://github.com/savonrb/gyoku/pull/69), thanks [@ccarruitero]!
+
+### Added
+
+- Unwrap specific keys [#54](https://github.com/savonrb/gyoku/pull/54), by [@rlburkes]. Documented by [@mahemoff]. Thanks to you both!
+- Add `:pretty_print`, `:indent` and `:compact` options to allow prettified XML output. [#59](https://github.com/savonrb/gyoku/pull/59), by [@Jeiwan]. Thanks!
+
+### Changed
+
+- Removed Rubinius support, by [@olleolleolle]
+- Clean-up, CI setup, and changelog authoring, by [@olleolleolle]
+
+[@jpmoral]: https://github.com/jpmoral
+[@ccarruitero]: https://github.com/ccarruitero
+[@rlburkes]: https://github.com/rlburkes
+[@mahemoff]: https://github.com/mahemoff
+[@Jeiwan]: https://github.com/Jeiwan
+[@olleolleolle]: https://github.com/olleolleolle
+
+## 1.3.1 (2015-04-05)
+
+* Feature: [#53](https://github.com/savonrb/gyoku/pull/53) Improved serialization of hashes nested in arrays. Thanks to @riburkes for this!
+
+## 1.3.0 (2015-03-30)
+
+* Formally drop support for ruby 1.8.7
+
+## 1.2.3 (2015-03-10)
+
+* Feature: [#52](https://github.com/savonrb/gyoku/pull/52) Adds an :unwrap option that allows an array of hashes to be unwrapped into a single array xml node, rather than one per hash.
+
+## 1.2.2 (2014-09-22)
+
+* Fixed a bug introduced by making Gyoku threadsafe. Who knew that `$1` and the block variable that `#gsub` provides are not the same?
+
+## 1.2.1 (2014-09-22)
+
+* Fix : [#46](https://github.com/savonrb/gyoku/pull/46) Fixed an issue where Gyoku was not threadsafe. Gyoku should now be relatively more threadsafe due to less usage of global variables.
+
+## 1.2.0 (2014-09-18)
+
+* Feature: [#44](https://github.com/savonrb/gyoku/pull/44) support for sorting via :order! with a string key
+
+## 1.1.1 (2014-01-02)
+
+* Feature: [#38](https://github.com/savonrb/gyoku/pull/38) support for building nested Arrays
+* Feature: [#36](https://github.com/savonrb/gyoku/pull/36) allow setting any objects content with :content!
+* Deprecation:  Support for ree and ruby 1.8.7 will be going away soon.
+
+## 1.1.0 (2013-07-26)
+
+* Feature: [#30](https://github.com/savonrb/gyoku/pull/30) support for building Arrays
+  of parent tags using @attributes.
+
+* Fix: [#21](https://github.com/savonrb/gyoku/pull/21) stop modifying the original Hash.
+  The original issue is [savonrb/savon#410](https://github.com/savonrb/savon/issues/410).
+
+## 1.0.0 (2012-12-17)
+
+* Refactoring: Removed the global configuration. This should really only affect the
+  `Gyoku.convert_symbols_to` shortcut which was removed as well. If you're using Gyoku
+  with Savon 2.0, there's now an option for that. If you're using Gyoku on itself,
+  you can pass it the `:key_converter` option instead.
+
+## 0.5.0 (2012-12-15)
+
+Feature: [#19](https://github.com/savonrb/gyoku/pull/19) adds support for explicit XML attributes.
+
+Feature: [#17](https://github.com/savonrb/gyoku/pull/17) adds an `:upcase` formula.
+
+## 0.4.6 (2012-06-28)
+
+* Fix: [#16](https://github.com/rubiii/gyoku/issues/16) Date objects were mapped like DateTime objects.
+
+      Gyoku.xml(date: Date.today)  # => "<date>2012-06-28</date>"
+
+* Fix: Time objects were also mapped like DateTime objects.
+
+      Gyoku.xml(time: sunday)  # => "<time>16:22:33</time>"
+
+## 0.4.5 (2012-05-28)
+
+* Fix: [issue 8](https://github.com/rubiii/gyoku/issues/8) -
+  Conflict between camelcase methods in Rails.
+
+* Fix: [pull request 15](https://github.com/rubiii/gyoku/pull/15) -
+  Gyoku generates blank attribute values if there are fewer attribute
+  values in attributes! than elements.
+
+* Fix: [issue 12](https://github.com/rubiii/gyoku/issues/12) -
+  Don't remove special keys from the original Hash.
+
+## 0.4.4
+
+* Fix: [issue 6](https://github.com/rubiii/gyoku/issues/6) -
+  `Gyoku.xml` does not modify the original Hash.
+
+## 0.4.3
+
+* Fix: Make sure `require "date"` when necessary.
+
+## 0.4.2
+
+* Fix: `Array.to_xml` so that the given :namespace is applied to every element
+  in an Array.
+
+## 0.4.1
+
+* Fix: Alternative formulas and namespaces.
+
+## 0.4.0
+
+* Feature: Added alternative Symbol conversion formulas. You can choose between
+  :lower_camelcase (the default), :camelcase and :none.
+
+      Gyoku.convert_symbols_to :camelcase
+
+  You can even define your own formula:
+
+      Gyoku.convert_symbols_to { |key| key.upcase }
+
+## 0.3.1
+
+* Feature: Gyoku now calls Proc objects and converts their return value.
+
+## 0.3.0
+
+* Feature: Now when all Hash keys need to be namespaced (like with
+  elementFormDefault), you can use options to to trigger this behavior.
+
+      Gyoku.xml hash,
+        :element_form_default => :qualified,
+        :namespace => :v2
+
+## 0.2.0
+
+* Feature: Added support for self-closing tags. Hash keys ending with a forward
+  slash (regardless of their value) are now converted to self-closing tags.
+
+## 0.1.1
+
+* Fix: Allow people to use new versions of builder.
+
+## 0.1.0
+
+* Initial version. Gyoku was born as a core extension inside the
+  [Savon](http://rubygems.org/gems/savon) library.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "simplecov", require: false
+gem "coveralls", require: false

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Harrington
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,313 @@
+# Gyoku
+
+Gyoku translates Ruby Hashes to XML.
+
+``` ruby
+Gyoku.xml(:find_user => { :id => 123, "v1:Key" => "api" })
+# => "<findUser><id>123</id><v1:Key>api</v1:Key></findUser>"
+```
+
+[![Build status](https://github.com/savonrb/gyoku/actions/workflows/ci.yml/badge.svg)](https://github.com/savonrb/gyoku/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/gyoku.svg)](http://badge.fury.io/rb/gyoku)
+[![Code Climate](https://codeclimate.com/github/savonrb/gyoku.svg)](https://codeclimate.com/github/savonrb/gyoku)
+[![Coverage Status](https://coveralls.io/repos/savonrb/gyoku/badge.svg?branch=master)](https://coveralls.io/r/savonrb/gyoku)
+
+
+## Installation
+
+Gyoku is available through [Rubygems](http://rubygems.org/gems/gyoku) and can be installed via:
+
+``` bash
+$ gem install gyoku
+```
+
+or add it to your Gemfile like this:
+
+``` ruby
+gem 'gyoku', '~> 1.0'
+```
+
+
+## Hash keys
+
+Hash key Symbols are converted to lowerCamelCase Strings.
+
+``` ruby
+Gyoku.xml(:lower_camel_case => "key")
+# => "<lowerCamelCase>key</lowerCamelCase>"
+```
+
+You can change the default conversion formula to `:camelcase`, `:upcase` or `:none`.  
+Note that options are passed as a second Hash to the `.xml` method.
+
+``` ruby
+Gyoku.xml({ :camel_case => "key" }, { :key_converter => :camelcase })
+# => "<CamelCase>key</CamelCase>"
+```
+
+Custom key converters. You can use a lambda/Proc to provide customer key converters.
+This is a great way to leverage active support inflections for domain specific acronyms.
+
+``` ruby
+# Use camelize lower which will hook into active support if installed.
+Gyoku.xml({ acronym_abc: "value" }, key_converter: lambda { |key| key.camelize(:lower) })
+# => "<acronymABC>value</acronymABC>"
+
+```
+
+Hash key Strings are not converted and may contain namespaces.
+
+``` ruby
+Gyoku.xml("XML" => "key")
+# => "<XML>key</XML>"
+```
+
+
+## Hash values
+
+* DateTime objects are converted to xs:dateTime Strings
+* Objects responding to :to_datetime (except Strings) are converted to xs:dateTime Strings
+* TrueClass and FalseClass objects are converted to "true" and "false" Strings
+* NilClass objects are converted to xsi:nil tags
+* These conventions are also applied to the return value of objects responding to :call
+* All other objects are converted to Strings using :to_s
+
+## Array values
+
+Array items are by default wrapped with the containiner tag, which may be unexpected.
+
+``` ruby
+> Gyoku.xml({languages: [{language: 'ruby'},{language: 'java'}]})
+# => "<languages><language>ruby</language></languages><languages><language>java</language></languages>"
+```
+
+You can set the `unwrap` option to remove this behavior.
+
+``` ruby
+> Gyoku.xml({languages: [{language: 'ruby'},{language: 'java'}]}, { unwrap: true})
+# => "<languages><language>ruby</language><language>java</language></languages>"
+```
+
+## Special characters
+
+Gyoku escapes special characters unless the Hash key ends with an exclamation mark.
+
+``` ruby
+Gyoku.xml(:escaped => "<tag />", :not_escaped! => "<tag />")
+# => "<escaped>&lt;tag /&gt;</escaped><notEscaped><tag /></notEscaped>"
+```
+
+
+## Self-closing tags
+
+Hash Keys ending with a forward slash create self-closing tags.
+
+``` ruby
+Gyoku.xml(:"self_closing/" => "", "selfClosing/" => nil)
+# => "<selfClosing/><selfClosing/>"
+```
+
+
+## Sort XML tags
+
+In case you need the XML tags to be in a specific order, you can specify the order  
+through an additional Array stored under the `:order!` key.
+
+``` ruby
+Gyoku.xml(:name => "Eve", :id => 1, :order! => [:id, :name])
+# => "<id>1</id><name>Eve</name>"
+```
+
+
+## XML attributes
+
+Adding XML attributes is rather ugly, but it can be done by specifying an additional  
+Hash stored under the`:attributes!` key.
+
+``` ruby
+Gyoku.xml(:person => "Eve", :attributes! => { :person => { :id => 1 } })
+# => "<person id=\"1\">Eve</person>"
+```
+
+## Explicit XML Attributes
+
+In addition to using the `:attributes!` key, you may also specify attributes through keys beginning with an "@" sign.
+Since you'll need to set the attribute within the hash containing the node's contents, a `:content!` key can be used
+to explicity set the content of the node. The `:content!` value may be a String, Hash, or Array.
+
+This is particularly useful for self-closing tags.
+
+**Using :attributes!**
+
+``` ruby
+Gyoku.xml(
+  "foo/" => "", 
+  :attributes! => {
+    "foo/" => {
+      "bar" => "1", 
+      "biz" => "2", 
+      "baz" => "3"
+    }
+  }
+)
+# => "<foo baz=\"3\" bar=\"1\" biz=\"2\"/>"
+```
+
+**Using "@" keys and ":content!"**
+
+``` ruby
+Gyoku.xml(
+  "foo/" => {
+    :@bar => "1",
+    :@biz => "2",
+    :@baz => "3",
+    :content! => ""
+  })
+# => "<foo baz=\"3\" bar=\"1\" biz=\"2\"/>"
+```
+
+**Example using "@" to get Array of parent tags each with @attributes & :content!**
+
+``` ruby
+Gyoku.xml(
+  "foo" => [
+    {:@name => "bar", :content! => 'gyoku'}
+    {:@name => "baz", :@some => "attr", :content! => 'rocks!'}
+  ])
+# => "<foo name=\"bar\">gyoku</foo><foo name=\"baz\" some=\"attr\">rocks!</foo>"
+```
+
+Unwrapping Arrays. You can specify an optional `unwrap` argument to modify the default Array
+behavior. `unwrap` accepts a boolean flag (false by default) or an Array whitelist of keys to unwrap.
+``` ruby
+# Default Array behavior
+Gyoku.xml({
+  "foo" => [
+    {:is => 'great' },
+    {:is => 'awesome'}
+  ]
+})
+# => "<foo><is>great</is></foo><foo><is>awesome</is></foo>"
+
+# Unwrap Array behavior
+Gyoku.xml({
+  "foo" => [
+    {:is => 'great' },
+    {:is => 'awesome'}
+  ]
+}, unwrap: true)
+# => "<foo><is>great</is><is>awesome</is></foo>"
+
+# Unwrap Array, whitelist.
+# foo is not unwrapped, bar is.
+Gyoku.xml({
+  "foo" => [
+    {:is => 'great' },
+    {:is => 'awesome'}
+  ],
+  "bar" => [
+      {:is => 'rad' },
+      {:is => 'cool'}
+  ]
+}, unwrap: [:bar])
+# => "<foo><is>great</is></foo><foo><is>awesome</is></foo><bar><is>rad</is><is>cool</is></bar>"
+```
+
+Naturally, it would ignore :content! if tag is self-closing:
+
+``` ruby
+Gyoku.xml(
+  "foo/" => [
+    {:@name => "bar", :content! => 'gyoku'}
+    {:@name => "baz", :@some => "attr", :content! => 'rocks!'}
+  ])
+# => "<foo name=\"bar\"/><foo name=\"baz\" some=\"attr\"/>"
+```
+
+This seems a bit more explicit with the attributes rather than having to maintain a hash of attributes.
+
+For backward compatibility, `:attributes!` will still work. However, "@" keys will override `:attributes!` keys
+if there is a conflict.
+
+``` ruby
+Gyoku.xml(:person => {:content! => "Adam", :@id! => 0})
+# => "<person id=\"0\">Adam</person>"
+```
+
+**Example with ":content!", :attributes! and "@" keys**
+
+``` ruby
+Gyoku.xml({ 
+  :subtitle => { 
+    :@lang => "en", 
+    :content! => "It's Godzilla!" 
+  }, 
+  :attributes! => { :subtitle => { "lang" => "jp" } } 
+}
+# => "<subtitle lang=\"en\">It's Godzilla!</subtitle>"
+```
+
+The example above shows an example of how you can use all three at the same time. 
+
+Notice that we have the attribute "lang" defined twice.
+The `@lang` value takes precedence over the `:attribute![:subtitle]["lang"]` value.
+
+## Pretty Print
+
+You can prettify the output XML to make it more readable. Use these options:
+* `pretty_print` – controls pretty mode (default: `false`)
+* `indent` – specifies indentation in spaces (default: `2`)
+* `compact` – controls compact mode (default: `true`)
+
+**This feature is not available for XML documents generated from arrays with unwrap option set to false as such documents are not valid**
+
+**Examples**
+
+``` ruby
+puts Gyoku.xml({user: { name: 'John', job: { title: 'Programmer' }, :@status => 'active' }}, pretty_print: true)
+#<user status='active'>
+#  <name>John</name>
+#  <job>
+#    <title>Programmer</title>
+#  </job>
+#</user>
+```
+
+``` ruby
+puts Gyoku.xml({user: { name: 'John', job: { title: 'Programmer' }, :@status => 'active' }}, pretty_print: true, indent: 4)
+#<user status='active'>
+#    <name>John</name>
+#    <job>
+#        <title>Programmer</title>
+#    </job>
+#</user>
+```
+
+``` ruby
+puts Gyoku.xml({user: { name: 'John', job: { title: 'Programmer' }, :@status => 'active' }}, pretty_print: true, compact: false)
+#<user status='active'>
+#  <name>
+#    John
+#  </name>
+#  <job>
+#    <title>
+#      Programmer
+#    </title>
+#  </job>
+#</user>
+```
+
+**Generate XML from an array with `unwrap` option set to `true`**
+``` ruby
+puts Gyoku::Array.to_xml(["john", "jane"], "user", true, {}, pretty_print: true, unwrap: true)
+#<user>
+#  <user>john</user>
+#  <user>jane</user>
+#</user>
+```
+
+**Generate XML from an array with `unwrap` option unset (`false` by default)**
+``` ruby
+puts Gyoku::Array.to_xml(["john", "jane"], "user", true, {}, pretty_print: true)
+#<user>john</user><user>jane</user>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+require "bundler/setup"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w[-c]
+end
+
+task default: :spec
+task test: :spec

data/gyoku.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "gyoku/version"
+
+Gem::Specification.new do |s|
+  s.name = "chef-gyoku"
+  s.version = Gyoku::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors = "Daniel Harrington"
+  s.email = "me@rubiii.com"
+  s.homepage = "https://github.com/savonrb/#{s.name}"
+  s.summary = "Translates Ruby Hashes to XML"
+  s.description = "Gyoku translates Ruby Hashes to XML"
+  s.required_ruby_version = ">= 3.0"
+
+  s.license = "MIT"
+
+  s.add_dependency "builder", ">= 2.1.2"
+  s.add_dependency "rexml", "~> 3.3"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "standard"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.require_paths = ["lib"]
+end