konfig-config 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 75a53b2df0604086dbbec0e28d797572149247f999d16875948c0ceec940ccb5
-  data.tar.gz: 5dcc54bb9a313c53c26ce7b3070ef69e3a9ea9a805aa9a3513d5406be7297c64
+  metadata.gz: 1ad4223735db5a3060899308630e5381f8366e6540e5cd377fa9482d0ba72029
+  data.tar.gz: 52f936cf81e41df19f076e0807c7a13f20bdc4b385efebee49645bcfef0869bf
 SHA512:
-  metadata.gz: 6536edc14535469c53978a368ddc3fb8e73dbf8058c7c79cb4737894e73645d30275e86551a16fcfc5374acc8eb40e94c1c0af64ab5c45ab8775d341c8971273
-  data.tar.gz: c0f45ef59ea643d7d1a1d1342d6bda7ff88edb4e50530e53a009eb46efdbf6f3d64c42ece69d98cf959150fc74f0abedf6422d8f249815e5ff8370c5635cbec8
+  metadata.gz: 86cb227104473211276c12e8e82f186260058d4eccb9c8ecf109417735ccb6018370667a7a1a9cf6143e4936318ea9321680c7b7582f861275c56376e438dd94
+  data.tar.gz: 59cebceb30b34f4d9cd4d9ad5696a4da5559b6535619913f38f33d2ff8e9c10eb356ce8bd40b6c479dfc5d00e3955b631e60374bce0319f77c4b4eca7e416267

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

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.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-16 00:00:00.000000000 Z
+date: 2023-03-20 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