gonfic 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2fad61828080ba4b9eb70df2a48a73c96f36c57838ba1995352729798418aba
+  data.tar.gz: b8aefe5e2a0382397db5b29051d16206fd881bd80417330a4b7f158d7f1ed237
+SHA512:
+  metadata.gz: f87f1745b1a4de1fca0b71304a48d3edbd3ef28420ca1de05aed0e782c583c7c2be58fdba43416d05a15284af799c623233fcdc2b5e55a8ad595134ffedf7202
+  data.tar.gz: f2a204863ba25f38dfe81a05820b3ef5a2dc21e203c4f6dacb6516833b05741f429b19905d713813eedd23bfdeb66fd2074007e01d6e20f056ca0b9e9fe6341a

data/.rubocop.yml

@@ -0,0 +1,50 @@
+---
+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/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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Emil Chludziński
+
+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,96 @@
+# Gonfic
+
+Tool-oriented configuration: merge config from ~/, ./, ENV, and OptionParser, access as Hashie::Mash
+
+## Installation
+
+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
+
+## Design
+
+`Gonfic` is intended to be used with tools - small, often commandline programs.
+It will merge configuration from multiple sources, in increasing order of specificity.
+You can also think about these sources in terms of how long-lived they are:
+
+* `config_defaults:`: this is what you determine when writing the tool - lasts as long as this particular tool,
+* `~/$CONFIGURATION_FILENAME`: this will be applied every time a particular user uses your tool,
+* `./$CONFIGURATION_FILENAME`: every time that user uses your tool, in a particular directory (e.g. source code checkout),
+* `ENV` variables: every time your tool is used during a particular session (so it can override directory settings, but persists over multiple runs),
+* `OptionParser`'d settings: during a single, particular run.
+
+In the intended scenario (where you allow the config to be slightly flexible) you will barely need to configure your tool's config, aside from providing `config_defaults:` once. No listing of allowed setting readers, no spelling out options and types, no mapping to formats - `Gonfic` takes care of all that's needed.
+
+## Why not...?
+
+### https://github.com/bkeepers/dotenv or https://github.com/rubyconfig/config
+
+These are application-oriented: they have robust support for multiple environments and integration with frameworks.
+
+### https://dry-rb.org/gems/dry-configurable/main/
+
+This is more for library developers: allows you to add configurable settings to an object, which other code will later use.
+
+### https://github.com/cjbottaro/config_spartan
+
+This one is actually kind of cool, in its minimalism - and intended for similar usage scenarios. But it doesn't seem to be actively developed nowadays, and I wanted a few more features, mostly around some opinionated/automagical defaults.
+
+## Advanced scenarios
+
+### 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:
+
+    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 :)
+
+## Source code
+
+https://gitlab.com/tanstaafl/gonfic
+
+## Development
+
+Your first steps should be:
+
+    git clone git@gitlab.com:tanstaafl/gonfic.git
+    cd gonfic
+    bundle install
+    bundle exec rake
+
+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`.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine from sources, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at https://gitlab.com/tanstaafl/gonfic.
+
+## Name
+
+Yeah, it's not great. As in: not obvious.
+If you would prefer it to be 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).
+3. Send me an issue (or a merge request, or something) with a better name that's available on RubyGems! :D
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# 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]

data/gonfic.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/gonfic/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'gonfic'
+	spec.version = Gonfic::VERSION
+	spec.authors = ['Emil Chludziński']
+	spec.email = ['tanstaafl@tlen.pl']
+
+	spec.summary = 'Gonfic - merge config from ~/, ./, ENV, and OptionParser - access as Hashie::Mash.'
+	spec.description = <<~DESCRIPTION
+		Gonfic
+		Configuration gem for commandline tools.
+		Provides easy access to config, merged from multiple sources in order of specificity.
+	DESCRIPTION
+	spec.homepage = 'https://gitlab.com/tanstaafl/gonfic'
+	spec.license = 'MIT'
+	spec.required_ruby_version = '>= 2.6.0'
+
+	spec.metadata['homepage_uri'] = spec.homepage
+	spec.metadata['source_code_uri'] = spec.homepage
+	spec.metadata['rubygems_mfa_required'] = 'true'
+
+	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])
+		end
+	end
+	spec.bindir = 'exe'
+	spec.executables = spec.files.grep(%r{\Aexe/}){ |f| File.basename(f) }
+	spec.require_paths = ['lib']
+
+	spec.add_dependency 'hashie'
+end

data/lib/gonfic/config.rb

@@ -0,0 +1,11 @@
+require 'hashie/mash'
+require 'hashie/extensions/mash/safe_assignment'
+require 'hashie/extensions/mash/symbolize_keys'
+
+module Gonfic
+	# loads, stores, and allows access to configuration
+	class Config < Hashie::Mash
+		include Hashie::Extensions::Mash::SafeAssignment
+		include Hashie::Extensions::Mash::SymbolizeKeys
+	end
+end

data/lib/gonfic/version.rb

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

data/lib/gonfic.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'gonfic/version'
+require_relative 'gonfic/config'
+
+# external interface to creating a Config with data loaded from files
+module Gonfic
+	def self.new(defaults: {}, filename: nil)
+		config = Config.new(defaults)
+		config.merge!(load_configuration_file("~/#{filename}"))
+		config.merge!(load_configuration_file("./#{filename}"))
+	end
+
+	def self.load_configuration_file(filename)
+		YAML.safe_load(File.read(filename))
+	end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: gonfic
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Emil Chludziński
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Gonfic
+  Configuration gem for commandline tools.
+  Provides easy access to config, merged from multiple sources in order of specificity.
+email:
+- tanstaafl@tlen.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- gonfic.gemspec
+- lib/gonfic.rb
+- lib/gonfic/config.rb
+- lib/gonfic/version.rb
+homepage: https://gitlab.com/tanstaafl/gonfic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/tanstaafl/gonfic
+  source_code_uri: https://gitlab.com/tanstaafl/gonfic
+  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: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.15
+signing_key:
+specification_version: 4
+summary: Gonfic - merge config from ~/, ./, ENV, and OptionParser - access as Hashie::Mash.
+test_files: []