gonfic 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ad26346c85a9ae7084d9889d8e5f633f5e0a350ef780054d81012638e32cb5
-  data.tar.gz: 7bff4a1c1c1df7950d81299b449c71049f745fe8158f55e284b9ff0de434989b
+  metadata.gz: 5540b5acbed6a77e6822f0aea120d20cac396ec86c7011edf7b665fe82e2f96b
+  data.tar.gz: e27a4fa9e41ae1696a14192835c5e31290a146dd3719708cf1bee481747c5c26
 SHA512:
-  metadata.gz: 3341cf94bb91e9f69b8a667438ffa9639bbcd9e7004d83fc2d0e1d4d7bb028c201007b486b2dc1627b750b275241e2b1f48b567374dbd876835dbe12822c3131
-  data.tar.gz: f6d00634a769200640b62c53a36567c27dd8fa70632b63ce4b0a60db939ba0a7dfeb5a4d8095bfb3931118ab63cf9965dbebc5ff295e142c2d00f9c709a43ad0
+  metadata.gz: f5310196e4f2681a3f1b931101f7349782700b8b57666b517fc21625808f00272a41bf42a03f84692a4ca5caf0a1b05a58da249362bab242b14dad2565141b6e
+  data.tar.gz: 70f3c1f5fe26fd365657b9480265cf8efbe5f9ff7f4a6eb9959cab6d95355d1312bd7dd88a5ede693f0539ff1b0a7b35be59bbfb1532fe0c49f1c09369819dc0

data/README.md

@@ -8,10 +8,12 @@ Add `gem 'gonfic'` to your application's `Gemfile`, then run `bundle install`.
 
 ## Usage
 
-    CONFIGURATION_FILENAME = '.my_tool' # YAML config file format, by default
-    CONFIGURATION_DEFAULTS = {a: 1, b: {c: 2}} # will deep_merge! using Hashie magic
-    CONFIG = Gonfic.new(filename: CONFIGURATION_FILENAME, defaults: CONFIGURATION_DEFAULTS)
-    puts CONFIG.b.c
+```ruby
+CONFIGURATION_FILENAME = '.my_tool' # YAML config file format, by default
+CONFIGURATION_DEFAULTS = {a: 1, b: {c: 2}} # will deep_merge! using Hashie magic
+CONFIG = Gonfic.new(filename: CONFIGURATION_FILENAME, defaults: CONFIGURATION_DEFAULTS)
+puts CONFIG.b.c
+```
 
 ## Design
 
@@ -49,11 +51,13 @@ As 90+% of the functionality is configured by different ways of calling `Gonfic.
 
 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:
 
-    module MyTool
-        def self.config
-            @config ||= Gonfic.new(...)
-        end
+```ruby
+module MyTool
+    def self.config
+        @config ||= Gonfic.new(...)
     end
+end
+```
 
 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 :)
@@ -63,6 +67,32 @@ Additionally, with access to your config via a method that's easy to stub, your
 By default, `Gonfic.new` will look for `filename:` in `~/` and `./` (merging them, if both are present).
 If you want to load from other directories, just set the `directories:` parameter to your list.
 
+### Providing list of full paths (when filenames differ)
+
+Alternatively, you don't have to use the same `.my_tool` configuration filename, but instead support e.g. all of these:
+
+```
+~
+├── .my_tool.yml
+└── .config
+    ├── my_tool.yml
+    └── my_tool
+        ├── aliases.yml
+        └── secrets.yml
+```
+
+If you want these files to be merged, set the `file_paths:` parameter to a list of full paths including filenames:
+
+```ruby
+CONFIG = Gonfic.new(
+    file_paths: %w[~/.my_tool.yml ~/.config/my_tool.yml ~/.config/my_tool/aliases.yml ~/.config/my_tool/secrets.yml],
+    defaults: CONFIGURATION_DEFAULTS,
+)
+```
+
+All the paths passed to `Gonfic.new`, either in `directories:` + `filename:`, or in `file_paths:` mode, are
+passed through `File.expand_path` - so you can use `~/` and `./` as parts of the path parameters.
+
 ### Loading configuration from ENV
 
 If you provide `filename:`, `Gonfic.new` will also check `ENV` for variables it considers relevant.
@@ -71,7 +101,7 @@ The pattern, in general, is that `.tool-name` becomes `TOOL_NAME_*` - and any va
 
 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.
+You can also override the prefix - set it independently from `filename:`. Underscore at the end is optional.
 
 ## Source code
 

data/lib/gonfic/version.rb

@@ -1,3 +1,3 @@
 module Gonfic
-	VERSION = '0.6.3'.freeze
+	VERSION = '0.7.0'.freeze
 end

data/lib/gonfic.rb

@@ -9,14 +9,14 @@ require_relative 'gonfic/directories'
 module Gonfic
 	YAML_FILE_LOADER = ->(filename){ YAML.safe_load(File.read(filename)) }
 
-	def self.new(
-		defaults: {},
-		filename: nil, file_loader: YAML_FILE_LOADER, directories: Directories.home_then_here,
+	def self.new( # rubocop:disable Metrics/ParameterLists
+		defaults: {}, file_loader: YAML_FILE_LOADER,
+		filename: nil, directories: Directories.home_then_here, file_paths: join_into_paths(directories, filename),
 		env_variable_prefix: EnvExtractor.env_prefix_from_filename(filename)
 	)
 		configs =
 			configs_from_defaults(defaults: defaults) +
-			configs_from_files(filename: filename, file_loader: file_loader, directories: directories) +
+			configs_from_files(file_loader: file_loader, file_paths: file_paths) +
 			configs_from_env(env_variable_prefix: env_variable_prefix, defaults: defaults)
 
 		configs.reduce(:merge!)
@@ -26,11 +26,16 @@ module Gonfic
 		[Config.new(defaults)]
 	end
 
-	def self.configs_from_files(filename:, file_loader:, directories:)
-		return [] unless filename
+	def self.join_into_paths(directories, filename)
+		return [] unless directories && filename
 
-		directories.map do |directory|
-			filepath = File.expand_path(File.join(directory, filename))
+		directories.map{ |directory| File.expand_path(File.join(directory, filename)) }
+	end
+
+	def self.configs_from_files(file_loader:, file_paths:)
+		return [] unless file_paths
+
+		file_paths.map do |filepath|
 			load_configuration_file(filepath, file_loader)
 		end
 	end
@@ -39,8 +44,8 @@ module Gonfic
 		return {} unless File.exist?(filename)
 
 		file_loader.call(filename)
-	rescue StandardError => e
-		Hashie.logger.error(e)
+	rescue StandardError => exc
+		Hashie.logger.error(exc)
 		{}
 	end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gonfic
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Emil Chludziński
 bindir: exe
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -54,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="