smart_config 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2916bd8a506f8c74af2f8b00729d7ba04241159b7ea993090b0010b82657b62e
-  data.tar.gz: 55d1eadaf37c20f76de2ff01e21b23aba1448eedae035404c739d0a7b2d74cff
+  metadata.gz: 79021decd1e8da1ca164f03eb52d4e4291516844c5142ae38c11d1ba88f967f7
+  data.tar.gz: 728aaac6723424090f3c5b53cbb0289ac003fb40b1429b7ed5c7ebef71f3690b
 SHA512:
-  metadata.gz: 04f2a8e1094f315d3afe3e47d0dc42fbd305d079abd11024b0f8b2762c4f0154f23a5deda724c6223b4b08cd784f0e4836777354595f401102cc59d573a0276e
-  data.tar.gz: 59ee036cb4a4253af357017db22662e01c6765d589282939e2638e422e303f5e97213ee91395fe009e9b1a11f8e795c15f86adb11130a59d862f6c08a65e3917
+  metadata.gz: 3e4754d90251092a7ae9d31b8a16ab855ce4630f2e1595e23b0b532bec60c383e5d1a26c08319bf2f72683ff5147681eb4549ad880a1e2cf764be302965be0cc
+  data.tar.gz: ad94e8af908a5a4cd9da816552af14374187a6d18c643fad444a893b5a87319e845b993af1fbb4326f08b61f36b0434c399b7f062678e7b9a9179baaf2fd3971

data/README.md

@@ -17,20 +17,22 @@ Add the `smart_gem` dependency to you Gemfile:
 gem 'smart_gem'
 ```
 
+### Usage
+
 Then, create a new config class that, and define the configuration you need:
 
-```
+```ruby
 class Config
 	extend SmartConfig::Config
 
 	# Optional. Will default to `config/config.yml`
 	config_path 'config/app_config.yml'
 
-	value :app_name
+	value :app_name, default: 'My App'
 
 	group :smtp do
 		value :hostname
-		value :port
+		value :port, format: :integer
 		value :username
 		value :password
 	end
@@ -54,4 +56,31 @@ Then, within your application, you can call:
 Config.redis.connection.hostname
 ```
 
-To access the configuration value.
+To access the configuration value, from the following YAML file for example:
+
+```yaml
+redis:
+  connection:
+    hostname: 'localhost'
+```
+
+For values that are not  in the YAML config, the tool will try reading it from environment variables, such as (from the previous configuration):
+
+```
+REDIS_CONNECTION_PASSWORD
+```
+
+#### Value Options
+
+Values can use options, which can be set after the value name. For example:
+
+```ruby
+value :hostname, default: 'localhost'
+```
+
+All available options are:
+
+| name      | description                                                                                                                                        |
+|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------|
+| default   | Sets a default value for the field, if no configuration could be found. If this option is not set, getting an unset field will raise an exception. |
+| format    | Sets the format of the field. If this option is not set, the field will be formatted as string.                                                    |

data/lib/smart_config/config.rb

@@ -22,11 +22,17 @@ module SmartConfig
       @config_path
     end
 
-    def data
-      @data ||= [
-        YAML.load_file(config_file_path),
-        ENV.to_h.transform_keys(&:downcase)
-      ]
+    def walker
+      @walker ||= SmartConfig::Walker.new([
+        {
+          data: config_file_path,
+          strategy: :nested
+        },
+        {
+          data: ENV.to_h.transform_keys(&:downcase),
+          strategy: :flat
+        }
+      ])
     end
   end
 end

data/lib/smart_config/formatters/boolean.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SmartConfig
+  module Formatters
+    #
+    # Boolean formats the value into a boolean
+    class Boolean
+      def self.format(value)
+        ['true', '1', 1, true].include?(value)
+      end
+    end
+  end
+end

data/lib/smart_config/formatters/float.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SmartConfig
+  module Formatters
+    #
+    # Float formats the value into a float
+    class Float
+      def self.format(value)
+        return nil if value.nil?
+
+        value.to_f
+      end
+    end
+  end
+end

data/lib/smart_config/formatters/integer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SmartConfig
+  module Formatters
+    #
+    # Integer formats the value into an integer
+    class Integer
+      def self.format(value)
+        return nil if value.nil?
+
+        value.to_i
+      end
+    end
+  end
+end

data/lib/smart_config/formatters/string.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SmartConfig
+  module Formatters
+    #
+    # String formats the value into a string
+    class String
+      def self.format(value)
+        value
+      end
+    end
+  end
+end

data/lib/smart_config/formatters.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SmartConfig
+  #
+  # Formatters define behaviors to format values into another type
+  # This is especially useful for environment variables, which are always strings
+  #
+  module Formatters
+    def self.find(format)
+      SmartConfig::Formatters.const_get(camelize(format))
+    end
+
+    def self.camelize(format)
+      format.to_s.split('_').collect(&:capitalize).join
+    end
+  end
+end
+
+require 'smart_config/formatters/string'
+require 'smart_config/formatters/integer'
+require 'smart_config/formatters/float'
+require 'smart_config/formatters/boolean'

data/lib/smart_config/group.rb

@@ -9,16 +9,14 @@ module SmartConfig
   class Group
     include SmartConfig::Values
 
-    def initialize(name, parent, &)
-      @name = name
-      @parent = parent
+    def initialize(namespace, walker, &)
+      @namespace = namespace
+      @walker = walker
       instance_exec(&)
     end
 
     private
 
-    def data
-      @data ||= @parent.get_path(@name)
-    end
+    attr_reader :walker
   end
 end

data/lib/smart_config/values.rb

@@ -7,14 +7,17 @@ module SmartConfig
   # Handles the retrieval of values, but with already provided data.
   #
   module Values
-    def value(name)
+    attr_reader :namespace
+
+    def value(name, *opts)
       @config ||= {}
-      @config[name.to_sym] = {}
+      @config[name.to_sym] = opts.reduce({}, :merge)
     end
 
     def group(name, &)
       @config ||= {}
-      @config[name.to_sym] = SmartConfig::Group.new(name, self, &)
+      @config[name.to_sym] ||= {}
+      @config[name.to_sym][:group] = SmartConfig::Group.new([namespace, name].compact.flatten, walker, &)
     end
 
     def keys
@@ -22,7 +25,7 @@ module SmartConfig
     end
 
     def method_missing(name, *args, &)
-      return get_value(name) if keys.include?(name)
+      return format_value(name, get_value(name)) if keys.include?(name)
 
       super
     end
@@ -34,26 +37,31 @@ module SmartConfig
     end
 
     def get_value(name)
-      path = get_path(name)
+      return @config[name][:group] if @config[name].key?(:group)
+
+      path = walker.walk(full_name(name))
+      return path.first unless path.first.nil?
+      return @config[name][:default] if @config[name].key?(:default)
 
-      case @config[name]
-      when SmartConfig::Group
-        @config[name]
-      else
-        path.first
-      end
+      raise SmartConfig::MissingConfigValue, full_name(name)
     end
 
-    def get_path(name)
-      name = name.to_s
-      data.map { |a| a[name] }.compact
+    def format_value(name, value)
+      @formatters ||= {}
+
+      @formatters[name] ||= SmartConfig::Formatters.find(@config[name].fetch(:format, :string))
+      @formatters[name].format(value)
     end
 
     private
 
-    # Getting the data needs to be implemented by a lateral module
-    def data
+    # Getting the data through a walker needs to be implemented by a lateral module
+    def walker
       raise NotImplementedError
     end
+
+    def full_name(name)
+      [namespace, name.to_s].compact.flatten.join('.')
+    end
   end
 end

data/lib/smart_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SmartConfig
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/smart_config/walker.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SmartConfig
+  #
+  # Loads the data from any configured source and walks through it to find
+  # values
+  #
+  class Walker
+    def initialize(sources)
+      @sources = sources
+    end
+
+    def walk(path)
+      data.filter_map do |d|
+        next if d[:data].nil?
+
+        case d[:strategy]
+        when :nested
+          d[:data].dig(*path.split('.'))
+        when :flat
+          d[:data][path.tr('.', '_')]
+        end
+      end
+    end
+
+    private
+
+    def data
+      @data ||= @sources.filter_map do |s|
+        {
+          data: load_source(s[:data]),
+          strategy: s[:strategy]
+        }
+      end
+    end
+
+    def load_source(name)
+      case name
+      when Hash
+        name
+      when /\.(yml|yaml)$/
+        YAML.load_file(name)
+      end
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+end

data/lib/smart_config.rb

@@ -3,8 +3,12 @@
 #
 # The main SmartConfig module. See documentation for the sub modules.
 #
-module SmartConfig; end
+module SmartConfig
+  class MissingConfigValue < StandardError; end
+end
 
+require 'smart_config/formatters'
+require 'smart_config/walker'
 require 'smart_config/values'
 require 'smart_config/group'
 require 'smart_config/config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_config
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Damien MATHIEU
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies: []
 description: Define and access static configuration, from a YAML config file, or environment
   variables
@@ -22,9 +22,15 @@ files:
 - README.md
 - lib/smart_config.rb
 - lib/smart_config/config.rb
+- lib/smart_config/formatters.rb
+- lib/smart_config/formatters/boolean.rb
+- lib/smart_config/formatters/float.rb
+- lib/smart_config/formatters/integer.rb
+- lib/smart_config/formatters/string.rb
 - lib/smart_config/group.rb
 - lib/smart_config/values.rb
 - lib/smart_config/version.rb
+- lib/smart_config/walker.rb
 homepage: https://github.com/dmathieu/smart_config
 licenses:
 - MIT