gonfic 0.5.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdf1477e7d76fc97fe5ee9a224079275e563e90c22d837346c0a6ba43f0a4841
-  data.tar.gz: 8f8121dfac2bc667c067008352763f1a5a276a96d1817180d0f2c4ae6d3f1e36
+  metadata.gz: 7b8810655c20a36c4ae9220d82652bd740f7a9b108f62fa6c34400c39d8af4d0
+  data.tar.gz: 4202e4993d903c3fe560730ff88e798728617f2db71d92bc9f5de1127ca30888
 SHA512:
-  metadata.gz: 564f42cc15d5a2a7055c8a9d58e960bdf3206b5f7b340c908c45ab1af243f02ccf8ab8444345d36901e998f83d9c7e22de418c24d099ce1ae0a4aef82ae19946
-  data.tar.gz: 1910650dfe238d8d4e01db9dffc03e9f4edb0f7ac9385b460cee285dedc6fbcb8471621dd2417316f547a1bbc26030cf2c8435dbc2dae7b186d633f74f58a04b
+  metadata.gz: 4dd9ed806e8982e2be4103930ab51291b3c93c4163f044b5ebbdd63edc72b6bf369d4b2be8c597c5da66a8d83bce4e116171f1021c4238284e54cc6a3f36092b
+  data.tar.gz: 6828d7979ccc5589531c81d2f4f063fcf5d8511749f97445d58c6a8aff6ce2befa75a808d67f6f1e8db89d843a837cee237a5feb40a981146e9567b9a1473432

data/README.md

@@ -58,6 +58,11 @@ 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 :)
 
+### Providing custom list of directories
+
+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.
+
 ### Loading configuration from ENV
 
 If you provide `filename:`, `Gonfic.new` will also check `ENV` for variables it considers relevant.
@@ -83,9 +88,7 @@ Your first steps should be:
 
 This will run tests (Minitest) and linter (Rubocop, custom config, see `.rubocop.yml`).
 
-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 ;)
+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.
 

data/gonfic.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative 'lib/gonfic/version'
 
 Gem::Specification.new do |spec|
@@ -25,7 +23,7 @@ Gem::Specification.new do |spec|
 	spec.files = Dir.chdir(__dir__) do
 		`git ls-files -z`.split("\x0").reject do |f|
 			File.expand_path(f) == __FILE__ ||
-				f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+				f.start_with?(*%w[bin/ test/ .git .rubocop.yml Gemfile Rakefile])
 		end
 	end
 	spec.bindir = 'exe'

data/lib/gonfic/directories.rb

@@ -0,0 +1,11 @@
+module Gonfic
+	# provide convenient lists of directories
+	class Directories
+		HOME = '~'.freeze
+		HERE = '.'.freeze
+
+		def self.home_then_here
+			[HOME, HERE]
+		end
+	end
+end

data/lib/gonfic/env_extractor.rb

@@ -30,7 +30,7 @@ module Gonfic
 
 		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)
+			into[key_name] = env.fetch(env_var_name) if env.key?(env_var_name)
 		end
 
 		def self.env

data/lib/gonfic/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Gonfic
-	VERSION = '0.5.0'
+	VERSION = '0.6.2'.freeze
 end

data/lib/gonfic.rb

@@ -1,25 +1,38 @@
-# frozen_string_literal: true
+require 'yaml'
 
 require_relative 'gonfic/version'
 require_relative 'gonfic/config'
 require_relative 'gonfic/env_extractor'
+require_relative 'gonfic/directories'
 
 # external interface to creating a Config with data loaded from files
 module Gonfic
-	FILE_LOADER = ->(filename){ YAML.safe_load(File.read(filename)) }
+	YAML_FILE_LOADER = ->(filename){ YAML.safe_load(File.read(filename)) }
 
 	def self.new(
 		defaults: {},
-		filename: nil, file_loader: FILE_LOADER,
+		filename: nil, file_loader: YAML_FILE_LOADER, directories: Directories.home_then_here,
 		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))
+		configs =
+			configs_from_defaults(defaults: defaults) +
+			configs_from_files(filename: filename, file_loader: file_loader, directories: directories) +
+			configs_from_env(env_variable_prefix: env_variable_prefix, defaults: defaults)
+
+		configs.reduce(:merge!)
+	end
+
+	def self.configs_from_defaults(defaults:)
+		[Config.new(defaults)]
+	end
+
+	def self.configs_from_files(filename:, file_loader:, directories:)
+		return [] unless filename
+
+		directories.map do |directory|
+			filepath = File.expand_path(File.join(directory, filename))
+			load_configuration_file(filepath, file_loader)
 		end
-		config
 	end
 
 	def self.load_configuration_file(filename, file_loader)
@@ -30,4 +43,10 @@ module Gonfic
 		Hashie.logger.error(e)
 		{}
 	end
+
+	def self.configs_from_env(env_variable_prefix:, defaults:)
+		return [] unless env_variable_prefix
+
+		[EnvExtractor.extract_variables_from_env(prefix: env_variable_prefix, defaults: defaults)]
+	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gonfic
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.2
 platform: ruby
 authors:
 - Emil Chludziński
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-21 00:00:00.000000000 Z
+date: 2023-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -34,13 +34,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
 - LICENSE.txt
 - README.md
-- Rakefile
 - gonfic.gemspec
 - lib/gonfic.rb
 - lib/gonfic/config.rb
+- lib/gonfic/directories.rb
 - lib/gonfic/env_extractor.rb
 - lib/gonfic/version.rb
 homepage: https://gitlab.com/tanstaafl/gonfic

data/.rubocop.yml

@@ -1,53 +0,0 @@
----
-AllCops:
-  TargetRubyVersion: 2.6
-  SuggestExtensions: false
-  NewCops: enable
-
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
-Layout/EndOfLine:
-  Enabled: true
-  EnforcedStyle: lf
-
-# tab country begins
-Layout/IndentationStyle:
-  Enabled: true
-  EnforcedStyle: tabs
-
-Layout/IndentationWidth: # weird setting to enable other Layout cops to work with tabs
-  Enabled: true
-  Width: 1
-# tab country ends
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Layout/SpaceBeforeBlockBraces:
-  Enabled: true
-  EnforcedStyle: no_space
-
-Layout/LineLength:
-  Max: 120
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: comma
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: true
-  EnforcedStyleForMultiline: comma
-
-Layout/SpaceInsideHashLiteralBraces:
-  Enabled: true
-  EnforcedStyle: no_space

data/Rakefile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-	t.libs << 'test'
-	t.libs << 'lib'
-	t.test_files = FileList['test/**/test_*.rb']
-end
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[rubocop test]