tty-config 0.3.1 → 0.5.1

data/lib/tty/config/dependency_loader.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module TTY
+  class Config
+    module DependencyLoader
+      attr_reader :dep_name
+
+      # Lazy load a dependency
+      #
+      # @api public
+      def dependency(*dep_names, &block)
+        self.dep_name = dep_names
+        @block = block
+      end
+
+      # Load dependency before object instatiation
+      #
+      # @api public
+      def new(*)
+        load
+        super
+      end
+
+      # Try loading depedency
+      #
+      # @api private
+      def load
+        return if dep_name.nil?
+
+        dep_name.empty? ? @block.() : dep_name.each { |dep| require(dep) }
+      rescue LoadError, NameError => err
+        raise DependencyLoadError, "#{raise_error_message} #{err.message}"
+      end
+
+      def inherited(subclass)
+        super
+        subclass.send(:dep_name=, dep_name)
+      end
+
+      private
+
+      def raise_error_message
+        if dep_name.empty?
+          "One or more dependency are missing."
+        elsif dep_name.size == 1
+          "The dependency `#{dep_name.join}` is missing."
+        else
+          "The dependencies `#{dep_name.join(', ')}` are missing."
+        end
+      end
+
+      attr_writer :dep_name
+    end # DependencyLoader
+  end # Config
+end # TTY

data/lib/tty/config/generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module TTY
+  class Config
+    module Generator
+      # Generate file content based on the data hash
+      #
+      # @param [Hash] data
+      #
+      # @return [String]
+      #   the 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
+        end
+
+        # values
+        values.each do |key, val|
+          content << "#{key} #{separator} #{val}"
+        end
+        content << "" unless values.empty?
+
+        # sections
+        sections.each do |section, object|
+          next if object.empty? # only add section if values present
+
+          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
+          content << ""
+        end
+        content.join("\n")
+      end
+    end # INIFile
+  end # Config
+end # TTY

data/lib/tty/config/marshaller.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "dependency_loader"
+
+module TTY
+  class Config
+    module Marshaller
+      # @api private
+      def self.included(base)
+        super
+        # Help marshallers to declare their gem dependency
+        base.extend DependencyLoader
+        # Help marshallers to declare their extension matching
+        base.extend ExtensionsStore
+      end
+
+      module ExtensionsStore
+        def ext
+          @_ext ||= []
+        end
+
+        # Set a list of extensions
+        #
+        # @example
+        #   extenion "ext1", "ext2", "ext3"
+        #
+        # @api public
+        def extension(*extensions)
+          if extensions[0].is_a?(Array)
+            @_ext = extensions[0]
+          else
+            @_ext = extensions
+          end
+        end
+
+        # Copy extensions to a subclass
+        #
+        # @param [Object] subclass
+        #
+        # @api private
+        def inherited(subclass)
+          super
+          subclass.instance_variable_set(:@_ext, @_ext.dup)
+        end
+      end
+
+      # Marshal object into a given format
+      #
+      # @param [Object] _object
+      #
+      # @api public
+      def marshal(_object, _options = {})
+        raise NotImplementedError
+      end
+
+      # Unmarshal content into a hash object
+      #
+      # @param [String] _content
+      #
+      # @api public
+      def unmarshal(_content, _options = {})
+        raise NotImplementedError
+      end
+    end # Marshaller
+  end # Config
+end # TTY

data/lib/tty/config/marshaller_registry.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module TTY
+  class Config
+    class MarshallerRegistry
+      # All registered marshallers
+      #
+      # @api private
+      attr_reader :marshallers
+
+      # @api private
+      def initialize(mappings = {})
+        @marshallers = mappings
+      end
+
+      def names
+        marshallers.keys
+      end
+
+      def objects
+        marshallers.values
+      end
+
+      def exts
+        marshallers.values.reduce([]) { |acc, obj| acc + obj.ext }
+      end
+
+      def registered?(name_or_object)
+        marshallers.key?(name_or_object) || marshallers.value?(name_or_object)
+      end
+
+      def register(name, object)
+        marshallers[name] = object
+      end
+
+      def unregister(name)
+        marshallers.delete(name)
+      end
+
+      def [](name)
+        marshallers.fetch(name)
+      end
+    end
+  end # Config
+end # TTY

data/lib/tty/config/marshallers/hcl_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 HCL format
+      #
+      # @api public
+      class HCLMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "rhcl"
+
+        extension ".hcl"
+
+        def marshal(object)
+          Rhcl.dump(object)
+        end
+
+        def unmarshal(content)
+          return {} if content == ""
+
+          Rhcl.parse(content)
+        end
+      end # HCLMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "../generator"
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into INI format
+      #
+      # @api public
+      class INIMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "inifile"
+
+        extension ".ini", ".cnf", ".conf", ".cfg", ".cf"
+
+        def marshal(object)
+          TTY::Config::Generator.generate(object)
+        end
+
+        def unmarshal(content)
+          ini = IniFile.new(content: content).to_h
+          global = ini.delete("global") { {} }
+          ini.merge(global)
+        end
+      end # INIMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into Java properties format
+      #
+      # @api public
+      class JavaPropsMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "java-properties"
+
+        extension ".properties", ".props", ".prop"
+
+        def marshal(object)
+          JavaProperties.generate(object)
+        end
+
+        def unmarshal(content)
+          JavaProperties.parse(content)
+        end
+      end # JavapropsMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into JSON format
+      #
+      # @api public
+      class JSONMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "json"
+
+        extension ".json"
+
+        def marshal(object)
+          JSON.pretty_generate(object)
+        end
+
+        def unmarshal(content)
+          JSON.parse(content)
+        end
+      end # JSONMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into TOML format
+      #
+      # @api public
+      class TOMLMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "toml"
+
+        extension ".toml"
+
+        def marshal(data)
+          TOML::Generator.new(data).body
+        end
+
+        def unmarshal(content)
+          TOML::Parser.new(content).parsed
+        end
+      end # TOMLMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../marshaller"
+
+module TTY
+  class Config
+    module Marshallers
+      # Responsible for marshalling content from and into YAML format
+      #
+      # @api public
+      class YAMLMarshaller
+        include TTY::Config::Marshaller
+
+        dependency "yaml"
+
+        extension ".yaml", ".yml"
+
+        def marshal(object)
+          YAML.dump(TTY::Config.normalize_hash(object, :to_s))
+        end
+
+        def unmarshal(content)
+          if YAML.respond_to?(:safe_load)
+            YAML.safe_load(content)
+          else
+            YAML.load(content)
+          end
+        end
+      end # YAMLMarshaller
+    end # Marshallers
+  end # Config
+end # TTY

data/lib/tty/config/marshallers.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "marshaller_registry"
+
+module TTY
+  class Config
+    module Marshallers
+      NO_EXT = ""
+
+      def marshaller_registry
+        @marshaller_registry ||= MarshallerRegistry.new
+      end
+
+      def marshallers
+        marshaller_registry.objects
+      end
+
+      def extensions
+        marshaller_registry.exts << NO_EXT
+      end
+
+      def registered_marshaller?(name_or_object)
+        marshaller_registry.registered?(name_or_object)
+      end
+
+      def register_marshaller(name, object)
+        marshaller_registry.register(name, object)
+      end
+
+      def unregister_marshaller(*names)
+        names.map { |name| marshaller_registry.unregister(name) }
+      end
+    end # Marshallers
+  end # Config
+end # TTY

data/lib/tty/config/version.rb

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