gonfic 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcb47c69de0e96e8ef069e61e166a70a7e40b8fe89128798ec9d49ace69e9607
-  data.tar.gz: b6556140b3495ddf655cc26365ebdc30dc9486a12e2179ca85b51d68c3f9710f
+  metadata.gz: cdf1477e7d76fc97fe5ee9a224079275e563e90c22d837346c0a6ba43f0a4841
+  data.tar.gz: 8f8121dfac2bc667c067008352763f1a5a276a96d1817180d0f2c4ae6d3f1e36
 SHA512:
-  metadata.gz: 3b1a43a997e1fea31cd4338194c9a3db887623b4646b8939c910794b2efa11219d7ac26f671907d4c2520be9e745bb545ace7d91fd8135f7bc3b54e597c006cc
-  data.tar.gz: e7239f4d73c722b01ddc05a70789ec6c0461525029983f4d3777bbee15106d86899fab408fbcd9d4f2ffa93cd37d4df1b14a64cd71003f98dedebc7caf98647b
+  metadata.gz: 564f42cc15d5a2a7055c8a9d58e960bdf3206b5f7b340c908c45ab1af243f02ccf8ab8444345d36901e998f83d9c7e22de418c24d099ce1ae0a4aef82ae19946
+  data.tar.gz: 1910650dfe238d8d4e01db9dffc03e9f4edb0f7ac9385b460cee285dedc6fbcb8471621dd2417316f547a1bbc26030cf2c8435dbc2dae7b186d633f74f58a04b

data/.rubocop.yml

@@ -21,6 +21,10 @@ Layout/IndentationWidth: # weird setting to enable other Layout cops to work wit
   Width: 1
 # tab country ends
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: true
+  EnforcedStyle: indented
+
 Layout/SpaceBeforeBlockBraces:
   Enabled: true
   EnforcedStyle: no_space
@@ -47,4 +51,3 @@ Style/TrailingCommaInHashLiteral:
 Layout/SpaceInsideHashLiteralBraces:
   Enabled: true
   EnforcedStyle: no_space
-

data/README.md

@@ -43,6 +43,8 @@ This one is actually kind of cool, in its minimalism - and intended for similar
 
 ## Advanced scenarios
 
+As 90+% of the functionality is configured by different ways of calling `Gonfic.new`, this section delves into possible variants you might want to consider - to fine-tune `Gonfic` to your needs.
+
 ### Deferring dangerous operations
 
 The `Gonfic.new` call will peform file I/O and other operations, which can potentially fail and raise errors. Doing things like that is generally frowned upon in initializers and immediately when files are `require`d - so `CONFIG = Gonfic.new` might not be the best practice ever, succinct as it is. A more prudent approach would be:
@@ -56,6 +58,16 @@ The `Gonfic.new` call will peform file I/O and other operations, which can poten
 In this way you are lazily deferring the "dangerous" operations until first usage, then memoizing.
 Additionally, with access to your config via a method that's easy to stub, your test suite will be happy :)
 
+### Loading configuration from ENV
+
+If you provide `filename:`, `Gonfic.new` will also check `ENV` for variables it considers relevant.
+See `EnvExtractor.env_prefix_from_filename` for what it will scan - either in source code, or in `bin/console`.
+The pattern, in general, is that `.tool-name` becomes `TOOL_NAME_*` - and any variables matching the pattern, and present in `defaults:` (again, converted to upcase with underscores), will be merged into resulting configuration.
+
+To disable this behavior, set `env_variable_prefix:` to falsey (`nil` will do).
+
+You can also override the prefix. Underscore at the end is optional.
+
 ## Source code
 
 https://gitlab.com/tanstaafl/gonfic
@@ -73,6 +85,7 @@ This will run tests (Minitest) and linter (Rubocop, custom config, see `.rubocop
 
 Note: the repo does not force the bundle to be vendorized,
 but should work fine if you set `BUNDLE_PATH: "vendor"` in your `~/.bundle/config`.
+Hint, hint ;)
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -85,7 +98,7 @@ Bug reports and merge requests are welcome on GitLab at https://gitlab.com/tanst
 ## Name
 
 Yeah, it's not great. As in: not obvious.
-If you would prefer it to be better:
+If you have an idea how to make it better:
 
 1. Go to https://rubygems.org/gems?letter=C
 2. Binary-search to `conf*` (at this stage you might begin to appreciate how hard naming is in this particular case, I hope).

data/lib/gonfic/env_extractor.rb

@@ -0,0 +1,40 @@
+module Gonfic
+	# extracts config options from env vars
+	class EnvExtractor
+		def self.extract_variables_from_env(prefix:, defaults:)
+			extracted = {}
+
+			defaults.each_key do |key_name|
+				extract_variable(prefix: prefix, key_name: key_name, into: extracted)
+			end
+
+			extracted
+		end
+
+		def self.env_prefix_from_filename(filename)
+			return nil unless filename
+
+			converted = upcase_and_simplify(File.basename(filename, '.*'))
+
+			"#{converted}_"
+		end
+
+		def self.upcase_and_simplify(sym)
+			sym
+				.to_s
+				.gsub(/[^\w]+/, '_')
+				.delete_prefix('_')
+				.delete_suffix('_')
+				.upcase
+		end
+
+		def self.extract_variable(prefix:, key_name:, into:)
+			env_var_name = prefix + upcase_and_simplify(key_name)
+			into[key_name] = env[env_var_name] if env.key?(env_var_name)
+		end
+
+		def self.env
+			ENV
+		end
+	end
+end

data/lib/gonfic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gonfic
-	VERSION = '0.4.2'
+	VERSION = '0.5.0'
 end

data/lib/gonfic.rb

@@ -2,15 +2,23 @@
 
 require_relative 'gonfic/version'
 require_relative 'gonfic/config'
+require_relative 'gonfic/env_extractor'
 
 # external interface to creating a Config with data loaded from files
 module Gonfic
 	FILE_LOADER = ->(filename){ YAML.safe_load(File.read(filename)) }
 
-	def self.new(defaults: {}, filename: nil, file_loader: FILE_LOADER)
+	def self.new(
+		defaults: {},
+		filename: nil, file_loader: FILE_LOADER,
+		env_variable_prefix: EnvExtractor.env_prefix_from_filename(filename)
+	)
 		config = Config.new(defaults)
 		config.merge!(load_configuration_file("~/#{filename}", file_loader)) if filename
 		config.merge!(load_configuration_file("./#{filename}", file_loader)) if filename
+		if env_variable_prefix
+			config.merge!(EnvExtractor.extract_variables_from_env(prefix: env_variable_prefix, defaults: defaults))
+		end
 		config
 	end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gonfic
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Emil Chludziński
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-14 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -41,6 +41,7 @@ files:
 - gonfic.gemspec
 - lib/gonfic.rb
 - lib/gonfic/config.rb
+- lib/gonfic/env_extractor.rb
 - lib/gonfic/version.rb
 homepage: https://gitlab.com/tanstaafl/gonfic
 licenses: