konfig-config 1.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70db05c79f1d9c7ad43cb0e6fc010dfa6641b418a174921321a031f839accb5c
-  data.tar.gz: 58d4a1b94bcab2baf8eb5f89be424e57df4798b2c005123067eda4487095eed0
+  metadata.gz: 607bd53ea2e3e6a9e7cdf483dfe532f99459e8a322e59315296b9befe2dfcc12
+  data.tar.gz: 2874b799bf9ae8770abd7ad7989415f31ff807c92995e2470c736d39d6c9a4fd
 SHA512:
-  metadata.gz: 57c097fd874a4b4613678fe7a5cf97ca9f8826c041da3b271eaf59607a96b94f5f3681c982a3de691af0d3230090464a383dfdc3d4320c4c9ab50d3da8812ce6
-  data.tar.gz: 070f9408b81179ff67bd2cd2415e8f442242d6a347996bc7a3060efeaacdf91cb4a511b5eca265d35b27ea66fac2b49403296424c0acf5cff975851e55d9da57
+  metadata.gz: 011a5a161270a6a5481eef45785ebcf8ac12f7b280de8e0f0cc33c034cc3d1efd5370381efe54dfc352de147bfd9e91b6cffdd53f0511e9f161d2cd891abab78
+  data.tar.gz: 6bd02077bdd358bc0050cf32a3e7c552c8ac9433f01481a572d7737b75c4fb58d22791d03b275c53bdb703064d4f60e0fd37ffb59b8d9533ed9e54080de97264

data/lib/konfig/exporters/abstract.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Konfig
+  module Exporters
+    class Abstract
+
+      def initialize(schema, **options)
+        @schema = schema
+        @options = options
+      end
+
+      def export
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :options
+
+    end
+  end
+end

data/lib/konfig/exporters/env_vars_as_markdown.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'konfig/exporters/abstract'
+require 'konfig/sources/environment'
+
+module Konfig
+  module Exporters
+    # This export will create a markdown document containing all configuration variables
+    # as defined the schema shown as environment variables.
+    class EnvVarsAsMarkdown < Abstract
+
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def export
+        contents = []
+        contents << "# #{options[:title] || 'Environment Variables'}"
+        contents << ''
+        contents << (options[:introduction] ||
+            'This document contains all the environment variables which are available for this application.')
+        contents << ''
+        contents << '| Name | Type | Description | Default |'
+        contents << '| ---- | ---- | ----------- | ------- |'
+        path = []
+        @schema.groups.each do |group_name, group|
+          path << group_name
+          group.attributes.each do |name, attr|
+            env_var = Sources::Environment.path_to_env_var(path + [name])
+            type = attr.array? ? "Array of #{attr.type}s" : attr.type.to_s.capitalize
+            contents << "| `#{env_var}` | #{type} | #{attr.description} | #{attr.default} |"
+          end
+          path.pop
+        end
+        contents.join("\n") + "\n"
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+    end
+  end
+end

data/lib/konfig/schema_attribute.rb

@@ -7,25 +7,37 @@ module Konfig
 
     attr_reader :name
     attr_reader :type
-    attr_reader :default
-    attr_reader :transformer
+    attr_accessor :default
+    attr_accessor :description
+    attr_accessor :array
+    attr_accessor :transformer
 
-    def initialize(name, type: :string, array: false, default: nil, transformer: nil)
+    def initialize(name, type: :string, array: nil, default: nil, description: nil, transformer: nil)
       @name = name
-      @type = type
-      @array = array
+      @array = array unless array.nil?
+      self.type = type
       @default = default
+      @description = description
       @transformer = transformer
+    end
+
+    def type=(type)
+      if type.is_a?(Array) && type.size == 1
+        @array = true
+        type = type.first
+      end
+
+      raise InvalidAttributeTypeError, "Invalid type #{type} for attribute #{@name}" unless TYPES.include?(type)
 
-      raise InvalidAttributeTypeError, "Invalid type #{type} for attribute #{name}" unless TYPES.include?(type)
+      @type = type
     end
 
     def array?
       @array == true
     end
 
-    def cast(value)
-      return value.map { |v| cast(v) } if value.is_a?(Array)
+    def cast(value, handle_arrays: true)
+      return cast_array(value) if handle_arrays && array?
 
       return nil if value.nil?
       return nil if value.is_a?(String) && value.empty?
@@ -37,7 +49,11 @@ module Konfig
       casted = cast(value)
       return casted if transformer.nil?
 
-      transformer.call(casted)
+      if array?
+        casted.map { |v| transformer.call(v) }
+      else
+        transformer.call(casted)
+      end
     end
 
     private
@@ -67,5 +83,15 @@ module Konfig
       %w[true 1 1.0].include?(input.to_s)
     end
 
+    def cast_array(value)
+      # If we have an array, and we're expecting an array, then we can just
+      # cast all the values of that array
+      return value.map { |v| cast(v, handle_arrays: false) } if value.is_a?(Array)
+
+      # if we want an array but we don't have one, we will take the value
+      # and put it in the array and try casting again
+      [cast(value, handle_arrays: false)]
+    end
+
   end
 end

data/lib/konfig/schema_attribute_dsl.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'konfig/schema_attribute'
+
+module Konfig
+  class SchemaAttributeDSL
+
+    def initialize(attribute)
+      @attribute = attribute
+    end
+
+    def type(value)
+      @attribute.type = value
+    end
+
+    def default(value)
+      @attribute.default = value
+    end
+
+    def description(value)
+      @attribute.description = value
+    end
+    alias desc description
+
+    def array
+      @attribute.array = true
+    end
+
+    def transform(value = nil, &block)
+      @attribute.transformer = block || value
+    end
+
+  end
+end

data/lib/konfig/schema_group.rb

@@ -6,6 +6,8 @@ require 'konfig/schema_attribute'
 module Konfig
   class SchemaGroup
 
+    attr_reader :attributes
+
     def initialize
       @attributes = {}
     end
@@ -28,7 +30,7 @@ module Konfig
       @attributes.each_with_object({}) do |(name, attribute), hash|
         attribute_path = path + [name]
         if source.nil?
-          hash[name] = attribute.cast(attribute.default)
+          hash[name] = attribute.default
         else
           begin
             source_value = source.get(attribute_path, attribute: attribute)

data/lib/konfig/schema_group_dsl.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'konfig/schema_attribute'
-
+require 'konfig/schema_attribute_dsl'
 module Konfig
   class SchemaGroupDSL
 
@@ -11,7 +11,14 @@ module Konfig
 
     SchemaAttribute::TYPES.each do |type|
       define_method type do |name, **kwargs, &block|
-        @group.add_attribute(name, type: type, **kwargs, &block)
+        attribute = @group.add_attribute(name, type: type, **kwargs)
+
+        if block
+          dsl = SchemaAttributeDSL.new(attribute)
+          dsl.instance_eval(&block)
+        end
+
+        attribute
       end
     end
 

data/lib/konfig/sources/environment.rb

@@ -14,7 +14,7 @@ module Konfig
       end
 
       def get(path, attribute: nil)
-        key = path.map { |p| p.to_s.upcase }.join('_')
+        key = self.class.path_to_env_var(path)
         raise ValueNotPresentError unless @env.key?(key)
 
         value = @env[key]
@@ -29,6 +29,14 @@ module Konfig
         value.split(@array_separator).map(&:strip)
       end
 
+      class << self
+
+        def path_to_env_var(path)
+          path.map { |p| p.to_s.upcase }.join('_')
+        end
+
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: konfig-config
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-17 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -37,8 +37,11 @@ files:
 - lib/konfig/config_hash.rb
 - lib/konfig/deep_merge.rb
 - lib/konfig/error.rb
+- lib/konfig/exporters/abstract.rb
+- lib/konfig/exporters/env_vars_as_markdown.rb
 - lib/konfig/schema.rb
 - lib/konfig/schema_attribute.rb
+- lib/konfig/schema_attribute_dsl.rb
 - lib/konfig/schema_dsl.rb
 - lib/konfig/schema_group.rb
 - lib/konfig/schema_group_dsl.rb