conf-stack 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5acb2fa0a3cb439c2e5531bb4c3a679ec24f3a6c0bc79dbb4b3dafdd6fad5f8c
+  data.tar.gz: f235e532b5ed0beb98d51b2e3d3fd81d048d8b3942e7dee0f6c2871fc4a3ab17
+SHA512:
+  metadata.gz: d36aa1d0f17da3cd9b0b3aeee1f01c3fcda9e483fea027c6906888369571770efe3c62ba3e9f8af4cf24e5cbb2a9fcaae26deaa1dbb86c23aed608b386f596cb
+  data.tar.gz: 5a3aef9729890caac18d5eb0d7e933686d307650c7e673e5d187d472a7ad16785f6f7afea5cc7ea9a7c530e51e76471e0d4d3ee02bac7986a9f69a7d8edb3b6e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in conf-stack.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "pry", "~> 0.14.1"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    conf-stack (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  conf-stack!
+  pry (~> 0.14.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Hall
+
+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,117 @@
+# ConfStack
+
+ConfStack is a hierarchical configuration management library.
+
+## Usage
+
+ConfStack configuration is loaded from `.confstack` files using a minimal DSL.
+The name of this file is configurable when creating the configuration object by
+passing a `filename:` argument (e.g. `ConfStack.new filename: 'my-cool-config'`).
+
+ConfStack looks for and evaluates `.confstack` files recursively up the file
+tree until it reaches the root of your project, if defined, or your home directory,
+if it's not.  Additionally, it always looks for and attempts to load a `.confstack`
+file in your home directory, if one exists.
+
+In this way, configuration for your tools can live where it makes the most sense
+for it to live with as much or as little duplication as you deem necessary.
+
+Short example:
+
+```ruby
+
+at_project_root   # Specifies that this is the root of your project
+
+# These are functionally equivalent
+configure some_value: 'foo'
+configure :some_value, 'foo'
+
+# These are also functionally equivalent
+configure(:lazy_load) { "some_value is #{some_value}" }
+configure lazy_load: proc { "some value is #{some_value}" }
+
+see_also 'path/to/other/configuration'
+```
+
+### ConfStack DSL
+
+#### `project_root [directory]`
+
+Specifies the root of your project.  Must be specified to prevent Mastermind
+from scanning more of your file system than it needs to.  The easiest way to
+do this is to just specify `at_project_root` in a `.confstack` file in the
+actual root of your project.
+
+----
+
+#### `at_project_root`
+
+Syntactic sugar for specifying that the current `.confstack` is in the root of your repository.
+
+It's equivalent to `project_root __dir__`.
+
+----
+
+#### `configure attribute [value] [&block]`
+
+Alias: `set`
+
+This command has two forms that are otherwise identical:
+
+* `configure attribute, value # attribute and value as separate arguments`
+* `configure attribute: value # attribute and value as key: value of a hash`
+
+Used to set arbitrary configuration options.  When a configuration option is
+set in multiple `.confstack` files, the "closest" one to your invocation wins.
+In other words, since Mastermind reads `.confstack` files starting in your
+current directory and working it's way "up" the hierarchy, the first `.confstack`
+that specifies a configuration option "wins".
+
+When provided a block, the value is computed the first time the option is called
+for.  The block runs in the context of the `Configuration` object built up by
+all the loaded `.confstack` files, so it has access to all previously set
+configuration options.
+
+The block is only executed once.  After that, the value is cached so that it
+doesn't need to be recomputed.
+
+If both a block and a value are given, the block is ignored and only the value
+is stored.
+
+----
+
+#### `see_also filename`
+
+Instructs Mastermind to also load the configuration specified in `filename`.
+This file does _not_ have to be named `.confstack` but _does_ have to conform
+to the syntax outlined here.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem conf-stack'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install conf-stack
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/chall8908/conf-stack.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "conf-stack"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/conf-stack.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/conf_stack/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "conf-stack"
+  spec.version       = ConfStack::VERSION
+  spec.authors       = ["Chris Hall"]
+  spec.email         = ["chall8908@gmail.com"]
+
+  spec.summary       = "Hierarchical configuration management"
+  # spec.description   = "Hierarchical configuration management"
+  spec.homepage      = "https://github.com/chall8908/conf_stack"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chall8908/conf_stack"
+  spec.metadata["changelog_uri"] = "https://github.com/chall8908/conf_stack"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/conf-stack.rb

@@ -0,0 +1 @@
+require_relative 'conf_stack'

data/lib/conf_stack/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class ConfStack
+  VERSION = "1.0.0"
+end

data/lib/conf_stack.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require 'set'
+require_relative "conf_stack/version"
+
+##
+# Main configuration object.  Walks up the file tree looking for configuration
+# files and loading them to build a the configuration.
+#
+# These configuarion files are loaded starting from the current working directory
+# and traversing up until a file with a `at_project_root` directive or the directory
+# specified by a `project_root` directive is reached.
+#
+# Configuration options set with `configure` are latched once set to something
+# non-nil.  This, along with the aforementioned load order of configuration files,
+# means that configuration files closest to the source of your invokation will
+# "beat" other configuration files.
+#
+# A global configuration located at $HOME/.confstack is loaded _last_.  You can
+# use this to specify plans you want accessible everywhere or global configuration
+# that should apply everywhere (unless overridden by more proximal files).
+#
+# Additionally, there is a directive (`see_other`) that allows for configuration
+# files outside of the lookup tree to be loaded.
+#
+# See {DSL} for a full list of the commands provided by ConfStack.
+class ConfStack
+  class Error < StandardError; end
+
+  class MissingConfigurationError < Error
+    def initialize(attribute, filename)
+      super "#{attribute} has not been defined.  Call `configure :#{attribute}[, value]` in a `#{filename}` to set it."
+    end
+  end
+
+  class InvalidDirectoryError < Error
+    def initialize(message, directory)
+      super "#{message}:  #{directory} does not exist or is not a directory"
+    end
+  end
+
+  # Adds an arbitrary attribute given by +attribute+ to the configuration class
+  #
+  # @param attribute [String,Symbol] the attribute to define
+  #
+  # @!macro [attach] add_attribute
+  #   @!attribute [rw] $1
+  def self.add_attribute(attribute)
+    return if self.method_defined? attribute
+
+    define_method "#{attribute}=" do |new_value=nil, &block|
+      self.instance_variable_set("@#{attribute}", new_value.nil? ? block : new_value) if self.instance_variable_get("@#{attribute}").nil?
+    end
+
+    define_method attribute do
+      value = self.instance_variable_get("@#{attribute}")
+      return value unless value.respond_to?(:call)
+
+      # Cache the value returned by the block so we're not doing potentially
+      # expensive operations mutliple times.
+      self.instance_variable_set("@#{attribute}", self.instance_eval(&value))
+    end
+
+    define_method "#{attribute}?" do
+      true
+    end
+
+    nil
+  end
+
+  # Specifies the directory that is the root of your project.
+  # This directory is where ConfStack will stop looking for more
+  # files, so it's important that it be set.
+  add_attribute :project_root
+
+  # @param filename [String] the filename to look for to build configuration
+  def initialize(filename: '.confstack')
+    @filename = filename
+    @loaded_conf_files = Set.new
+
+    lookup_and_load_configuration_files
+    load_configuration_file File.join(Dir.home, @filename)
+  end
+
+  # Loads a config file using the DSL, if it exists and hasn't been loaded already
+  #
+  # @param filename [String] the path to the config file to load
+  # @return [Void]
+  def load_configuration_file filename
+    if File.exists? filename and !@loaded_conf_files.include? filename
+      @loaded_conf_files << filename
+      DSL.new(self, filename)
+    end
+
+    nil
+  end
+
+  private
+
+  # Override the default NoMethodError with a more useful MissingConfigurationError.
+  #
+  # I
+  #
+  # Since the configuration object is used directly by plans for configuration information,
+  # accessing non-existant configuration can lead to unhelpful NoMethodErrors.  This replaces
+  # those errors with more helpful errors.
+  def method_missing(symbol, *args)
+    return false if symbol.to_s.ends_with? '?'
+
+    super
+  rescue NoMethodError
+    raise MissingConfigurationError.new(symbol, @filename)
+  end
+
+  # Walks up the file tree looking for configuration files.
+  #
+  # @return [Void]
+  def lookup_and_load_configuration_files
+    load_configuration_file File.join(Dir.pwd, @filename)
+
+    # Walk up the tree until we reach the project root, the home directory, or
+    # the root directory
+    unless [project_root, Dir.home, '/'].include? Dir.pwd
+      Dir.chdir('..') { lookup_and_load_configuration_files }
+    end
+  end
+
+  # Describes the DSL used in configuration files.
+  class DSL
+    # @param config [ConfStack] the configuration object used by the DSL
+    # @param filename [String] the path to the configuration file to be loaded
+    def initialize(config, filename)
+      @config = config
+      @filename = filename
+      instance_eval(File.read(filename), filename, 0) if File.exists? filename
+    end
+
+    # Specifies that another file should also be loaded when loading
+    # this file.  NOTE: This _immediately_ loads the other file.
+    #
+    # @param filename [String] the path to the file to be loaded
+    def see_also(filename)
+      @config.load_configuration_file(File.expand_path(filename))
+    end
+
+    # Specifies the root of the project.
+    # +root+ must be a directory.
+    #
+    # @param root [String] the root directory of the project
+    # @raise [InvalidDirectoryError] if +root+ is not a directory
+    def project_root(root)
+      unless Dir.exist? root
+        raise InvalidDirectoryError.new('Invalid project root', root)
+      end
+
+      @config.project_root = root
+    end
+
+    # Syntactic sugar on top of `project_root` to specify that the current
+    # file resides in the root of the project.
+    #
+    # @see project_root
+    def at_project_root
+      project_root File.dirname(@filename)
+    end
+
+    # Add arbitrary configuration attributes to the configuration object.
+    # Use this to add plan specific configuration options.
+    #
+    # @overload configure(attribute, value=nil, &block)
+    #   @example configure(:foo, 'bar')
+    #   @example configure(:foo) { 'bar' }
+    #   @param attribute [String,Symbol] the attribute to define
+    #   @param value [] the value to assign
+    #   @param block [#call,nil] a callable that will return the value
+    #
+    # @overload configure(attribute)
+    #   @example configure(foo: 'bar')
+    #   @example configure('foo' => -> { 'bar' } # not recommended, but should work
+    #   @param attribute [Hash] a single entry hash with the key as the attribute
+    #     name and value as the corresponding value
+    def configure(attribute, value=nil, &block)
+      attribute, value = attribute.first if attribute.is_a? Hash
+
+      ConfStack.add_attribute(attribute)
+      @config.public_send "#{attribute}=", value, &block
+    end
+    alias_method :set, :configure
+
+    # The following methods are maintained for backwards compatability with
+    # .masterplan files used by Mastermind
+    def backward_compatability(*args, **kwargs)
+    end
+    alias_method :plan_files, :backward_compatability
+    alias_method :has_plan_files, :backward_compatability
+    alias_method :plan_file, :backward_compatability
+    alias_method :define_alias, :backward_compatability
+    alias_method :skip_confirmation, :backward_compatability
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: conf-stack
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Chris Hall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-27 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- chall8908@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- conf-stack.gemspec
+- lib/conf-stack.rb
+- lib/conf_stack.rb
+- lib/conf_stack/version.rb
+homepage: https://github.com/chall8908/conf_stack
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chall8908/conf_stack
+  source_code_uri: https://github.com/chall8908/conf_stack
+  changelog_uri: https://github.com/chall8908/conf_stack
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Hierarchical configuration management
+test_files: []