konfig-config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75a53b2df0604086dbbec0e28d797572149247f999d16875948c0ceec940ccb5
+  data.tar.gz: 5dcc54bb9a313c53c26ce7b3070ef69e3a9ea9a805aa9a3513d5406be7297c64
+SHA512:
+  metadata.gz: 6536edc14535469c53978a368ddc3fb8e73dbf8058c7c79cb4737894e73645d30275e86551a16fcfc5374acc8eb40e94c1c0af64ab5c45ab8775d341c8971273
+  data.tar.gz: c0f45ef59ea643d7d1a1d1342d6bda7ff88edb4e50530e53a009eb46efdbf6f3d64c42ece69d98cf959150fc74f0abedf6422d8f249815e5ff8370c5635cbec8

data/lib/konfig/config.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Konfig
+  class Config
+
+    class << self
+
+      def build(schema, sources: [])
+        @schema = schema
+        @sources = sources
+
+        values = Hashie::Mash.new(@schema.create_hash(nil))
+
+        # Override all defaults with values from the sources
+        # in the reverse order they are given.
+        sources.reverse.each do |source|
+          values.deep_merge!(@schema.create_hash(source))
+        end
+
+        values
+      end
+
+    end
+
+  end
+end

data/lib/konfig/config_hash.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'hashie'
+
+module Konfig
+  class ConfigHash < ::Hash
+
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::DeepMerge
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::IndifferentAccess
+
+  end
+end

data/lib/konfig/deep_merge.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/konfig/error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Konfig
+
+  class Error < StandardError
+  end
+
+  class GroupNotFoundError < Error
+  end
+
+  class AttributeNotFoundError < Error
+  end
+
+  class InvalidAttributeTypeError < Error
+  end
+
+  class ValueNotPresentError < Error
+  end
+
+end

data/lib/konfig/schema.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'konfig/error'
+require 'konfig/schema_group'
+require 'konfig/schema_dsl'
+require 'konfig/config_hash'
+
+module Konfig
+  class Schema
+
+    attr_reader :groups
+
+    def initialize
+      @groups = {}
+    end
+
+    def group(name)
+      @groups[name] || raise(GroupNotFoundError, "Group '#{name}' not found in schema")
+    end
+
+    def group?(name)
+      @groups.key?(name)
+    end
+
+    def add_group(name)
+      group = SchemaGroup.new
+      @groups[name] = group
+      yield group if block_given?
+      group
+    end
+
+    def create_hash(source)
+      @groups.each_with_object({}) do |(name, group), hash|
+        hash[name] = group.create_hash([name], source)
+      end
+    end
+
+    class << self
+
+      def draw(&block)
+        schema = new
+        if block
+          dsl = SchemaDSL.new(schema)
+          dsl.instance_eval(&block)
+        end
+        schema
+      end
+
+    end
+
+  end
+end

data/lib/konfig/schema_attribute.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Konfig
+  class SchemaAttribute
+
+    TYPES = [:string, :integer, :float, :boolean].freeze
+
+    attr_reader :name
+    attr_reader :type
+    attr_reader :default
+    attr_reader :transformer
+
+    def initialize(name, type: :string, array: false, default: nil, transformer: nil)
+      @name = name
+      @type = type
+      @array = array
+      @default = default
+      @transformer = transformer
+
+      raise InvalidAttributeTypeError, "Invalid type #{type} for attribute #{name}" unless TYPES.include?(type)
+    end
+
+    def array?
+      @array == true
+    end
+
+    def cast(value)
+      return value.map { |v| cast(v) } if value.is_a?(Array)
+
+      return nil if value.nil?
+      return nil if value.is_a?(String) && value.empty?
+
+      send("cast_#{type}", value)
+    end
+
+    def transform(value)
+      casted = cast(value)
+      return casted if transformer.nil?
+
+      transformer.call(casted)
+    end
+
+    private
+
+    def cast_string(input)
+      input.to_s
+    end
+
+    def cast_integer(input)
+      return 1 if input == true
+      return 0 if input == false
+
+      input.to_i
+    end
+
+    def cast_float(input)
+      return 1.0 if input == true
+      return 0.0 if input == false
+
+      input.to_f
+    end
+
+    def cast_boolean(input)
+      return true if input == true
+      return false if input == false
+
+      %w[true 1 1.0].include?(input.to_s)
+    end
+
+  end
+end

data/lib/konfig/schema_dsl.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'konfig/schema_group_dsl'
+
+module Konfig
+  class SchemaDSL
+
+    def initialize(schema)
+      @schema = schema
+    end
+
+    def group(name, &block)
+      group = @schema.add_group(name)
+      if block
+        group_dsl = SchemaGroupDSL.new(group)
+        group_dsl.instance_eval(&block)
+      end
+      group
+    end
+
+  end
+end

data/lib/konfig/schema_group.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'konfig/config_hash'
+require 'konfig/schema_attribute'
+
+module Konfig
+  class SchemaGroup
+
+    def initialize
+      @attributes = {}
+    end
+
+    def attribute(name)
+      @attributes[name] || raise(AttributeNotFoundError, "Attribute '#{name}' not found in schema")
+    end
+
+    def attribute?(name)
+      @attributes.key?(name)
+    end
+
+    def add_attribute(name, **kwargs, &block)
+      kwargs[:transformer] = block if block && !kwargs.key?(:transformer)
+      @attributes[name] = SchemaAttribute.new(name, **kwargs)
+    end
+
+    # Create a hash of the all the values for this group from the given source.
+    def create_hash(path, source = nil)
+      @attributes.each_with_object({}) do |(name, attribute), hash|
+        attribute_path = path + [name]
+        if source.nil?
+          hash[name] = attribute.cast(attribute.default)
+        else
+          begin
+            source_value = source.get(attribute_path, attribute: attribute)
+            hash[name] = attribute.transform(source_value)
+          rescue ValueNotPresentError
+            # This is OK
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/konfig/schema_group_dsl.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'konfig/schema_attribute'
+
+module Konfig
+  class SchemaGroupDSL
+
+    def initialize(group)
+      @group = group
+    end
+
+    SchemaAttribute::TYPES.each do |type|
+      define_method type do |name, **kwargs, &block|
+        @group.add_attribute(name, type: type, **kwargs, &block)
+      end
+    end
+
+  end
+end

data/lib/konfig/sources/abstract.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Konfig
+  module Sources
+    class Abstract
+
+      def initialize
+      end
+
+      # The get method will return the give value for the given path.
+      # The path will contain the full path to the value, including the
+      # groups which lead up to it.
+      def get(path, attribute: nil)
+        raise NotImplementedError
+      end
+
+    end
+  end
+end

data/lib/konfig/sources/directory.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'konfig/error'
+require 'konfig/sources/abstract'
+
+module Konfig
+  module Sources
+    class Directory < Abstract
+
+      def initialize(root, strip_contents: true, array_separator: /\n/)
+        super()
+        @root = root
+        @strip_contents = strip_contents
+        @array_separator = array_separator
+      end
+
+      def get(path, attribute: nil)
+        file_path = File.join(@root, path.join('.'))
+        raise ValueNotPresentError unless File.exist?(file_path)
+
+        result = File.read(file_path)
+        result = result.strip if @strip_contents
+        result = handle_array(result) if attribute&.array?
+        result
+      end
+
+      private
+
+      def handle_array(value)
+        value.split(@array_separator).map(&:strip)
+      end
+
+    end
+  end
+end

data/lib/konfig/sources/environment.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'konfig/error'
+require 'konfig/sources/abstract'
+
+module Konfig
+  module Sources
+    class Environment < Abstract
+
+      def initialize(env, array_separator: /\s*,\s*/)
+        super()
+        @env = env
+        @array_separator = array_separator
+      end
+
+      def get(path, attribute: nil)
+        key = path.map { |p| p.to_s.upcase }.join('_')
+        raise ValueNotPresentError unless @env.key?(key)
+
+        value = @env[key]
+
+        value = handle_array(value) if attribute&.array?
+        value
+      end
+
+      private
+
+      def handle_array(value)
+        value.split(@array_separator).map(&:strip)
+      end
+
+    end
+  end
+end

data/lib/konfig/sources/yaml.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'konfig/error'
+require 'konfig/sources/abstract'
+require 'yaml'
+
+module Konfig
+  module Sources
+    class YAML < Abstract
+
+      def initialize(source)
+        super()
+        @source = ::YAML.safe_load(source)
+      end
+
+      def get(path, _attribute: nil)
+        source = @source
+        path.each do |p|
+          raise ValueNotPresentError unless source.key?(p.to_s)
+
+          source = source[p.to_s]
+        end
+        source
+      end
+
+    end
+  end
+end

data/lib/konfig/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Konfig
+
+  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
+  if File.file?(VERSION_FILE_ROOT)
+    VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
+  else
+    VERSION = '0.0.0.dev'
+  end
+
+end

data/lib/konfig-config.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'konfig'

data/lib/konfig.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'konfig/schema'
+require 'konfig/config'

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: konfig-config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A config schema generator
+email:
+- adam@krystal.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/konfig-config.rb
+- lib/konfig.rb
+- lib/konfig/config.rb
+- lib/konfig/config_hash.rb
+- lib/konfig/deep_merge.rb
+- lib/konfig/error.rb
+- lib/konfig/schema.rb
+- lib/konfig/schema_attribute.rb
+- lib/konfig/schema_dsl.rb
+- lib/konfig/schema_group.rb
+- lib/konfig/schema_group_dsl.rb
+- lib/konfig/sources/abstract.rb
+- lib/konfig/sources/directory.rb
+- lib/konfig/sources/environment.rb
+- lib/konfig/sources/yaml.rb
+- lib/konfig/version.rb
+homepage: https://github.com/krystal/konfig
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: A config schema generator
+test_files: []