smart_config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2916bd8a506f8c74af2f8b00729d7ba04241159b7ea993090b0010b82657b62e
+  data.tar.gz: 55d1eadaf37c20f76de2ff01e21b23aba1448eedae035404c739d0a7b2d74cff
+SHA512:
+  metadata.gz: 04f2a8e1094f315d3afe3e47d0dc42fbd305d079abd11024b0f8b2762c4f0154f23a5deda724c6223b4b08cd784f0e4836777354595f401102cc59d573a0276e
+  data.tar.gz: 59ee036cb4a4253af357017db22662e01c6765d589282939e2638e422e303f5e97213ee91395fe009e9b1a11f8e795c15f86adb11130a59d862f6c08a65e3917

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Damien MATHIEU
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Smart Config
+
+We have "smart" toothbrushes these days, so why not smart configuration?
+
+**Note**: As you can see in the version number, this gem is still in a very early version, and you should expect that there may be breaking changes until we reach 1.0.
+
+## Usage
+
+Smart Config allows you to define a static configuration and access it from anywhere within your application.  
+It will try to read the configuration from a YAML file, and fallback on environment variables.
+
+### Installation
+
+Add the `smart_gem` dependency to you Gemfile:
+
+```
+gem 'smart_gem'
+```
+
+Then, create a new config class that, and define the configuration you need:
+
+```
+class Config
+	extend SmartConfig::Config
+
+	# Optional. Will default to `config/config.yml`
+	config_path 'config/app_config.yml'
+
+	value :app_name
+
+	group :smtp do
+		value :hostname
+		value :port
+		value :username
+		value :password
+	end
+
+	group :redis do
+		group :connection do
+			value :hostname
+			value :port
+			value :username
+			value :password
+		end
+
+		value :timeout
+	end
+end
+```
+
+Then, within your application, you can call:
+
+```
+Config.redis.connection.hostname
+```
+
+To access the configuration value.

data/lib/smart_config/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SmartConfig
+  #
+  # Allows creating static configurations that rely on YAML files, or fall back
+  # to environment variables
+  #
+  module Config
+    include Values
+
+    def config_path(path)
+      @config_path = path
+    end
+
+    private
+
+    def config_file_path
+      return 'config/config.yaml' if @config_path.nil?
+
+      @config_path
+    end
+
+    def data
+      @data ||= [
+        YAML.load_file(config_file_path),
+        ENV.to_h.transform_keys(&:downcase)
+      ]
+    end
+  end
+end

data/lib/smart_config/group.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SmartConfig
+  #
+  # Handles recursive subgroups of configurations
+  #
+  class Group
+    include SmartConfig::Values
+
+    def initialize(name, parent, &)
+      @name = name
+      @parent = parent
+      instance_exec(&)
+    end
+
+    private
+
+    def data
+      @data ||= @parent.get_path(@name)
+    end
+  end
+end

data/lib/smart_config/values.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module SmartConfig
+  #
+  # Handles the retrieval of values, but with already provided data.
+  #
+  module Values
+    def value(name)
+      @config ||= {}
+      @config[name.to_sym] = {}
+    end
+
+    def group(name, &)
+      @config ||= {}
+      @config[name.to_sym] = SmartConfig::Group.new(name, self, &)
+    end
+
+    def keys
+      @config.keys
+    end
+
+    def method_missing(name, *args, &)
+      return get_value(name) if keys.include?(name)
+
+      super
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      return true if keys.include?(name)
+
+      super
+    end
+
+    def get_value(name)
+      path = get_path(name)
+
+      case @config[name]
+      when SmartConfig::Group
+        @config[name]
+      else
+        path.first
+      end
+    end
+
+    def get_path(name)
+      name = name.to_s
+      data.map { |a| a[name] }.compact
+    end
+
+    private
+
+    # Getting the data needs to be implemented by a lateral module
+    def data
+      raise NotImplementedError
+    end
+  end
+end

data/lib/smart_config/version.rb

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

data/lib/smart_config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+#
+# The main SmartConfig module. See documentation for the sub modules.
+#
+module SmartConfig; end
+
+require 'smart_config/values'
+require 'smart_config/group'
+require 'smart_config/config'
+require 'smart_config/version'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: smart_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Damien MATHIEU
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-28 00:00:00.000000000 Z
+dependencies: []
+description: Define and access static configuration, from a YAML config file, or environment
+  variables
+email:
+- 42@dmathieu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/smart_config.rb
+- lib/smart_config/config.rb
+- lib/smart_config/group.rb
+- lib/smart_config/values.rb
+- lib/smart_config/version.rb
+homepage: https://github.com/dmathieu/smart_config
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: A DLS for reading and accessing static configuration
+test_files: []