tty-config 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 106bc8ef14d41383dee670ba581128d5cb22492357e1a01fa7610cc9fcdf26d1
-  data.tar.gz: 78e5a75dff911c39eb7355b114bbc7a511123b22050b792c99936e3b337b5d5e
+  metadata.gz: caebad5a11c843f7436887a74a9c69bb19bc0303b52078daf9e1504ba3306f79
+  data.tar.gz: 61db32809d542344928572cba720baeb132be4b0e0a5ff8f2661d44825bc151b
 SHA512:
-  metadata.gz: 7d94ee40e738070bd66ad3371df6ea6dc281fabb26d6b66c6e07988e637a352d01402081d9c6d8dd8979c9c712b3a932b93d0d178cb9e779058bfeb290ee7605
-  data.tar.gz: '0119ee7f6f3ecdade2606f3df3ebce8d814e3241de3d191ac6ee3cc947691981a3c03dad1f0af29657807c9fda9e08c2c2533614f406dc6511f9c9eb9858a37e'
+  metadata.gz: 768fb85c76d3d68a4c29240c8d557c29ffe4482773131b5ce3cf24d6a3e355d2480dfee921781f6a28013f60b5132e2bb30d09751680546691bff9378e9cccaf
+  data.tar.gz: 5e59beca53007689060f817cd73bb0684bce1cb3ffc72bcd0b4c8eb10fe1d8fd5a937037378e04f2f0666badb3abfeb22abd97d3e69904022bc489092e0a89b6

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v0.6.0] - 2022-06-18
+
+### Added
+* Add the ability to persist configuration settings in an XML format
+
+### Changed
+* Change the INI file format generator to improve maintainability
+* Change gemspec to update toml version constraint
+
 ## [v0.5.1] - 2022-02-04
 
 ### Fixed
@@ -77,6 +86,7 @@
 
 * Initial implementation and release
 
+[v0.6.0]: https://github.com/piotrmurach/tty-config/compare/v0.5.1...v0.6.0
 [v0.5.1]: https://github.com/piotrmurach/tty-config/compare/v0.5.0...v0.5.1
 [v0.5.0]: https://github.com/piotrmurach/tty-config/compare/v0.4.0...v0.5.0
 [v0.4.0]: https://github.com/piotrmurach/tty-config/compare/v0.3.2...v0.4.0

data/README.md

@@ -27,7 +27,7 @@
 
 This is a one-stop shop for all your configuration needs:
 
-* [Read](#216-read) and [write](#217-write) config files in YAML, JSON, TOML, INI, HCL and Java Properties formats
+* [Read](#216-read) and [write](#217-write) config files in YAML, JSON, TOML, INI, XML, HCL and Java Properties formats
 * Add [custom marshallers](#222-register_marshaller) or override the built-in ones
 * [Set](#21-set) and [read](#24-fetch) settings for deeply nested keys
 * [Set](#21-set) defaults for undefined settings
@@ -514,6 +514,7 @@ Currently the supported file formats are:
 * `toml` for `.toml` extension
 * `ini`  for `.ini`, `.cnf`, `.conf`, `.cfg`, `.cf extensions`
 * `hcl`  for `.hcl` extensions
+* `xml`  for `.xml` extension
 * `jprops` for `.properties`, `.props`, `.prop` extensions
 
 Calling `read` without any arguments searches through provided locations to find configuration file and reads it. Therefore, you need to specify at least one search path that contains the configuration file together with actual filename. When filename is specified then all known extensions will be tried.
@@ -700,7 +701,7 @@ config.fetch(:host)
 
 There are number of built-in marshallers that handle the process of serializing internal configuration from and back into a desired format, for example, a `JSON` string.
 
-Currently supported formats out-of-the-box are: `YAML`, `JSON`, `TOML`, `INI` & `HCL`.
+Currently supported formats out-of-the-box are: `YAML`, `JSON`, `TOML`, `INI`, `XML`, `HCL` & `Java Properties`.
 
 To create your own marshaller use the `TTY::Config::Marshaller` interface. You need to provide the implementation for the following marshalling methods:
 
@@ -770,7 +771,7 @@ By default, the **TTY::Config** is ready to recognize various extensions. See [2
 For example, to remove all the built-in marshallers do:
 
 ```ruby
-config.unregister_marshaller :yaml, :json, :toml, :ini, :hcl
+config.unregister_marshaller :yaml, :json, :toml, :ini, :xml, :hcl, :jprops
 ```
 
 ## 3. Examples

data/lib/tty/config/generator.rb

@@ -2,56 +2,129 @@
 
 module TTY
   class Config
+    # Responsible for converting a data object into content in INI format
+    #
+    # @api private
     module Generator
       # Generate file content based on the data hash
       #
-      # @param [Hash] data
+      # @example
+      #   generate({"foo" => {"bar" => "baz"}})
+      #   # => "[foo]\nbar = baz\n"
+      #
+      # @param [Hash{String => Object}] data
+      #   the data to convert to INI file format
+      # @param [String] separator
+      #   the separator for the key and value pairs
       #
       # @return [String]
-      #   the file content
+      #   the INI file content
       #
       # @api public
       def self.generate(data, separator: "=")
-        content  = []
-        values   = {}
-        sections = {}
-
-        data.keys.sort.each do |key|
-          val = data[key]
-          if val.is_a?(NilClass)
-            next
-          elsif val.is_a?(Hash) ||
-                (val.is_a?(Array) && val.first.is_a?(Hash))
-            sections[key] = val
-          elsif val.is_a?(Array)
-            values[key] = val.join(",")
-          else
-            values[key] = val
-          end
+        sections_and_values = group_into_sections_and_values(data)
+
+        values = generate_values(sections_and_values[:values], separator)
+        values << "" unless values.empty?
+        sections = generate_sections(sections_and_values[:sections], separator)
+
+        content = values + sections
+        content.join("\n")
+      end
+
+      # Group data into sections and values
+      #
+      # @param [Hash{String => Object}] data
+      #   the data to group
+      #
+      # @return [Hash{Symbol => Hash}]
+      #   the sections and values
+      #
+      # @api private
+      def self.group_into_sections_and_values(data)
+        sections_and_values = {sections: {}, values: {}}
+        data.sort.each_with_object(sections_and_values) do |(key, val), group|
+          group[section?(val) ? :sections : :values][key] = val
         end
+      end
+      private_class_method :group_into_sections_and_values
+
+      # Check whether or not a value is a section
+      #
+      # @param [Object] value
+      #   the value to check
+      #
+      # @return [Boolean]
+      #   return true if value is a section, false otherwise
+      #
+      # @api private
+      def self.section?(value)
+        value.is_a?(Hash) ||
+          (value.is_a?(Array) && value.all? { |val| val.is_a?(Hash) })
+      end
+      private_class_method :section?
 
-        # values
-        values.each do |key, val|
-          content << "#{key} #{separator} #{val}"
+      # Generate key and value pairs
+      #
+      # @param [Hash{String => Object}] values
+      #   the values to convert to INI format
+      # @param [String] separator
+      #   the separator for the key and value pairs
+      #
+      # @return [Array<String>]
+      #   the formatted key and value pairs
+      #
+      # @api private
+      def self.generate_values(values, separator)
+        values.each_with_object([]) do |(key, val), content|
+          next if val.nil?
+
+          content << generate_pair(key, val, separator)
         end
-        content << "" unless values.empty?
+      end
+      private_class_method :generate_values
 
-        # sections
-        sections.each do |section, object|
-          next if object.empty? # only add section if values present
+      # Generate key and value pair
+      #
+      # @param [String] key
+      #   the key to convert to INI format
+      # @param [Object] value
+      #   the value to convert to INI format
+      # @param [String] separator
+      #   the separator for the key and value pair
+      #
+      # @return [String]
+      #   the formatted key and value pair
+      #
+      # @api private
+      def self.generate_pair(key, value, separator)
+        value = value.join(",") if value.is_a?(Array)
+        "#{key} #{separator} #{value}"
+      end
+      private_class_method :generate_pair
+
+      # Generate sections with key and value pairs
+      #
+      # @param [Hash{String => Object}] sections
+      #   the sections to convert to INI format
+      # @param [String] separator
+      #   the separator for the key and value pairs
+      #
+      # @return [Array<String>]
+      #   the formatted sections with key and value pairs
+      #
+      # @api private
+      def self.generate_sections(sections, separator)
+        sections.each_with_object([]) do |(section, object), content|
+          next if object.empty? # skip section with no values
 
           content << "[#{section}]"
-          if object.is_a?(Array)
-            object = object.reduce({}, :merge!)
-          end
-          object.each do |key, val|
-            val = val.join(",") if val.is_a?(Array)
-            content << "#{key} #{separator} #{val}" if val
-          end
+          object = object.reduce({}, :merge) if object.is_a?(Array)
+          content.concat(generate_values(object, separator))
           content << ""
         end
-        content.join("\n")
       end
-    end # INIFile
+      private_class_method :generate_sections
+    end # Generator
   end # Config
 end # TTY

data/lib/tty/config/marshallers/xml_marshaller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into XML format
+      #
+      # @api public
+      class XMLMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "xmlsimple"
+
+        extension ".xml"
+
+        def marshal(object)
+          XmlSimple.xml_out(object, {rootname: "config"})
+        end
+
+        def unmarshal(content)
+          return {} if content.empty?
+
+          XmlSimple.xml_in(content, {force_array: false})
+        end
+      end # XMLMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

data/lib/tty/config/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Config
-    VERSION = "0.5.1"
+    VERSION = "0.6.0"
   end # Config
 end # TTY

data/lib/tty/config.rb

@@ -10,6 +10,7 @@ require_relative "config/marshallers/yaml_marshaller"
 require_relative "config/marshallers/toml_marshaller"
 require_relative "config/marshallers/hcl_marshaller"
 require_relative "config/marshallers/java_props_marshaller"
+require_relative "config/marshallers/xml_marshaller"
 
 module TTY
   # Responsible for managing application configuration
@@ -104,6 +105,7 @@ module TTY
       register_marshaller :json, Marshallers::JSONMarshaller
       register_marshaller :toml, Marshallers::TOMLMarshaller
       register_marshaller :ini, Marshallers::INIMarshaller
+      register_marshaller :xml, Marshallers::XMLMarshaller
       register_marshaller :hcl, Marshallers::HCLMarshaller
       register_marshaller :jprops, Marshallers::JavaPropsMarshaller
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-config
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inifile
@@ -86,14 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '1.1'
 description: A highly customisable application configuration interface for building
   terminal tools. It supports many file formats such as YAML, JSON, TOML, INI, HCL
   and Java Properties.
@@ -121,6 +135,7 @@ files:
 - lib/tty/config/marshallers/java_props_marshaller.rb
 - lib/tty/config/marshallers/json_marshaller.rb
 - lib/tty/config/marshallers/toml_marshaller.rb
+- lib/tty/config/marshallers/xml_marshaller.rb
 - lib/tty/config/marshallers/yaml_marshaller.rb
 - lib/tty/config/version.rb
 homepage: https://ttytoolkit.org