fig_fig 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 611cf023b0f3caff2f1efbb07477ea41a1037879
+  data.tar.gz: f779ec85398861b6530d1e52fdef5e6d60fd0240
+SHA512:
+  metadata.gz: 6787d47f9d7eea144daee7652f673d991dac6a2b941a38332a68f33fa31744997da2df6f4b9095f2d2884a132645a7cd33e714c4b40829ca7524f0fb6f716d8b
+  data.tar.gz: 32c2d398102871747ee2549691e19b6e5e6b9ed08c182dd39cd8d4223f08760e60b59aede46fe5148d4b879d24b184857750b0baabfdff698a8a9b6d882e1cd6

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea

data/.rubocop.yml

@@ -0,0 +1,86 @@
+inherit_from: .rubocop_todo.yml
+
+Style/MutableConstant:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UnusedBlockArgument:
+  Enabled: true
+
+Metrics/AbcSize:
+  Exclude:
+    - spec/**/*
+
+Style/DotPosition:
+  Enabled: true
+  EnforcedStyle: trailing
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()    # interpolated String
+    '%i': '[]'  # Array of symbols
+    '%q': ()    # Single quoted string
+    '%Q': ()    # Double quoted string
+    '%r': '{}'  # Regex
+    '%s': ()    # Symbol
+    '%w': '[]'  # Array of strings
+    '%W': '[]'  # Array of strings, interpolated
+    '%x': ()    # shell command
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/CollectionMethods:
+  Enabled: true
+  # Mapping from undesired method to desired_method
+  # e.g. use `detect` over `find`:
+  PreferredMethods:
+    find: 'detect'
+    find_all: 'select'
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AndOr:
+  # Whether `and` and `or` are banned only in conditionals (conditionals)
+  # or completely (always).
+  EnforcedStyle: conditionals # and/or are sometimes used for flow control.
+
+Style/BlockDelimiters:
+  EnforcedStyle: semantic
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/NumericLiterals:
+  MinDigits: 5
+
+Style/SpaceBeforeFirstArg:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyleForMultiline, SupportedStyles.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/Lambda:
+  Enabled: false
+
+Metrics/LineLength:
+  Exclude:
+    - spec/mocks.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - spec/mocks.rb

data/.rubocop_todo.yml

@@ -0,0 +1,25 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-10 23:33:29 +0000 using RuboCop version 0.41.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 25
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 112
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 2
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/app_config.rb'

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Referly
+
+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,174 @@
+# FigFig
+Ruby Application Configurator with some validation support
+
+[![CircleCI](https://circleci.com/gh/Referly/fig_fig.svg?style=svg)](https://circleci.com/gh/Referly/fig_fig)
+
+## Usage
+
+Follow this example to perform basic configuration and validation of
+parameter presence.
+
+```ruby
+require "fig_fig"
+FigFig.configure do |c|
+    c.parameter :foo
+    c.parameter :bar, required: true
+end
+FigFig.foo = "foodog"
+FigFig.ready
+#=> raises FigFig::MissingConfigurationError
+FigFig.bar = "yum beer"
+FigFig.ready
+# => nil
+```
+
+If you call `.configure` a second time it raises a ConfigurationAlreadyDefinedError.
+To reset the configuration definition so that it can be redefined pass the `reset: true` option
+ to `.configure`. If you do supply the `reset: true` option, all existing parameter definitions 
+ and any set values will be lost. This true regardless of the current lifecycle stage of the config. 
+ 
+Despite the restriction against calling `.configure` more than once, callbacks you register in the
+block passed to `.configure` can modify any parameter value (unless the parameter is locked),
+read any parameter value, and even register additional parameters (advanced).
+
+```ruby
+require "fig_fig"
+FigFig.configure do |c|
+    c.parameter :foo    
+end
+FigFig.foo = "foo"
+FigFig.ready
+FigFig.foo
+# => "foo"
+FigFig.foo = bar
+FigFig.foo
+# => "bar"
+FigFig.configure do |c|
+    c.parameter :baz    
+end
+# => raises ConfigurationAlreadyDefinedError
+FigFig.configure(reset: true) do |c|
+    c.parameter :baz    
+end
+FigFig.foo = "foo"
+# => raises NoMethodError
+```
+
+You can immediately read values for parameters inside of the block passed to 
+ `.configure`. However, you need to call `.ready` when you are done with your 
+ configuration process and before your application can read values for 
+ parameters from the configuration.
+
+```ruby
+require "fig_fig"
+FigFig.configure do |c|
+    c.parameter :foo
+    c.parameter = "foo"
+    puts c.parameter
+    # => "foo"
+end
+c.parameter
+# => raises NoMethodError
+c.ready
+c.parameter
+# => "foo"
+```
+
+You can check validity of the configuration without invoking `.ready` by
+calling `.valid?`
+
+
+You can specify blocks that should be executed after validation is successful,
+this is useful for late binding configuration parameters managed by FigFig
+to other gems that use the conventional .configure approach.
+
+(Note that after_validation callbacks are invoked in the order they are set.)
+
+```ruby
+require "fig_fig"
+FigFig.configure do |c|
+  c.parameter :is_a_poodle
+  c.parameter :doggyz, required: true
+  c.after_validation do |validated_fig_fig|
+    validated_fig_fig.is_a_poodle = validated_fig_fig.doggyz == "poodle"
+  end
+end
+FigFig.doggyz = "collie"
+FigFig.ready
+FigFig.is_a_poodle
+# => false
+FigFig.doggyz = "poodle"
+FigFig.ready
+FigFig.is_a_poodle
+# => true
+```
+
+You can control the mutability level of the parameters you define. The gem syntax
+exposes this functionality using the `:lock` option. The possible values are:
+
+- nil (the default) - the parameter can be changed at any point
+- :on_set - the parameter once set cannot be subsequently modified
+- :on_validation - the parameter is locked during the validation lifecycle event and
+before the after_validation callbacks are invoked
+- :on_ready - the parameter is locked during the `ready` lifecycle event, the intended
+use case is when you want to prevent the application from modifying the configuration
+outside of the configuration bootstrapping stage of your application
+
+```ruby
+require "fig_fig"
+FigFig.configure do |c|
+  c.parameter :foo
+  c.parameter :bar, lock: :on_set
+  c.parameter :doz, lock: :on_validation
+  c.parameter :diz, lock: :on_validation
+  c.parameter :eck, lock: :on_ready
+  c.parameter :exz, lock: :on_ready
+end
+c.foo = "foo"
+c.bar = "bar"
+c.doz = "doz"
+c.eck = "eck"
+c.foo = "foo2"
+c.bar = "bar2"
+# => raises FigFig::CannotModifyLockedParameterError
+c.doz = "doz2"
+c.eck = "eck2"
+FigFig.valid?
+c.foo = "foo3"
+c.bar = "bar3"
+# => raises FigFig::CannotModifyLockedParameterError
+c.doz = "doz3"
+# => raises FigFig::CannotModifyLockedParameterError
+c.diz = "diz"
+# => raises FigFig::CannotModifyLockedParameterError
+c.diz
+# => nil
+c.eck = "eck3"
+FigFig.ready
+c.foo = "foo4"
+c.bar = "bar4"
+# => raises FigFig::CannotModifyLockedParameterError
+c.doz = "doz4"
+# => raises FigFig::CannotModifyLockedParameterError
+c.diz = "diz2"
+# => raises FigFig::CannotModifyLockedParameterError
+c.diz
+# => nil
+c.eck = "eck4"
+# => raises FigFig::CannotModifyLockedParameterError
+c.exz = "exz"
+# => raises FigFig::CannotModifyLockedParameterError
+c.exz
+# => nil
+```
+
+## Lifecycle events
+
+- `validation` - when the valid? method is invoked (you can register callbacks to `#after_validation`)
+
+- `final_validation` - you cannot interact with this internal only lifecycle event which performs a second
+validation pass after the after_validation callbacks have been run to make sure the configuration is still valid.
+
+- `ready` - when the FigFig instance has completed its bootstrapping process and is ready to be
+used by your application. Late immutable parameters are locked at this point and can no longer be changed
+via setters. (currently you cannot register callbacks to `before_ready` or `after_ready`)

data/circle.yml

@@ -0,0 +1,15 @@
+machine:
+
+  timezone:
+    America/Los_Angeles # Set the timezone
+
+  # Version of ruby to use
+  ruby:
+    version:
+      2.1.5
+
+test:
+  override:
+    - bundle exec rubocop
+    - mkdir -p $CIRCLE_TEST_REPORTS/rspec
+    - bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/rspec.xml spec --format progress

data/fig_fig.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "fig_fig/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fig_fig"
+  s.version     = FigFig::VERSION
+  s.date        = "2016-08-09"
+  s.summary     = "Ruby Application Configurator"
+  s.description = "Configurator for Ruby Applications with some validation and sugars."
+  s.authors     = ["Courtland Caldwell", "Blake Luchessi"]
+  s.email       = "engineering@mattermark.com"
+  s.files         = `git ls-files`.split("\n") - %w[Gemfile Gemfile.lock]
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.license = "MIT"
+  s.homepage =
+    "https://github.com/Referly/fig_fig"
+  s.add_development_dependency "rspec", "~> 3.2"
+  s.add_development_dependency "rb-readline", "~> 0.5", ">= 0.5.3"
+  s.add_development_dependency "byebug", "~> 3.5"
+  s.add_development_dependency "simplecov", "~> 0.10"
+  s.add_development_dependency "rubocop", "~> 0.31"
+  s.add_development_dependency "rspec_junit_formatter", "~> 0.2"
+end

data/lib/fig_fig.rb

@@ -0,0 +1,165 @@
+# Top level class of the FigTree gem
+class FigFig
+  MissingConfigurationError           = Class.new StandardError
+  DuplicateParameterDefinitionError   = Class.new StandardError
+  CannotModifyLockedParameterError    = Class.new StandardError
+  InvalidLockOptionError              = Class.new StandardError
+  ConfigurationAlreadyDefinedError    = Class.new StandardError
+
+  class << self
+    attr_accessor :configuration
+
+    # And we define a wrapper for the configuration block, that we'll use to set up
+    # our set of options
+    def configure(reset: nil)
+      self.reset if reset
+      raise ConfigurationAlreadyDefinedError if @configuration
+      @configuration = ConfigurationContainer.new
+      @configuration.configuring = true
+      yield configuration if block_given?
+      @configuration.configuring = false
+    end
+
+    def configuration
+      @configuration ||= ConfigurationContainer.new
+    end
+
+    def reset
+      @configuration = nil
+    end
+
+    def method_missing(method_name, *args, &blk)
+      return super unless configuration.respond_to? method_name
+      configuration.send method_name, *args, &blk
+    end
+
+    def respond_to_missing?(method, _include_private = false)
+      configuration.respond_to?(method) || super
+    end
+  end
+
+  # The class that encapsulates the current configuration definition and parameter values
+  class ConfigurationContainer
+    attr_accessor :parameters,
+                  :after_validation_callbacks,
+                  :configuring,
+                  :validating,
+                  :readied, # set to true during the ready lifecycle event
+                  :validated # set to true during the validation lifecycle event
+
+    def initialize
+      @configuring = false
+      @validating = false
+    end
+
+    def parameter(name, options = {})
+      @parameters ||= []
+      raise DuplicateParameterDefinitionError if parameters.any? { |p| p.keys.first == name }
+      parameters << { name: name.to_s, options: options, value: nil, set: false }
+    end
+
+    def valid?
+      @validating = true
+      _missing_configuration if _invalid_parameters.any?
+      # Set validated to true to block changes to parameters with on_validation locks
+      # including those in after_validation callbacks
+      @validated = true
+      Array(@after_validation_callbacks).each do |callback|
+        callback.call self
+      end
+      # Below line is the final_validation lifecycle event
+      _missing_configuration if _invalid_parameters.any?
+      @validating = false
+      @validated
+    end
+
+    def validated
+      @validated ||= false
+    end
+
+    def ready
+      valid?
+      @readied = true
+    end
+
+    def readied
+      @readied ||= false
+    end
+
+    def after_validation(&blk)
+      @after_validation_callbacks ||= []
+      @after_validation_callbacks << blk
+    end
+
+    def method_missing(method_name, *args, &blk)
+      method_name_str = method_name.to_s
+      return super unless _dynamically_exposed_methods.include? method_name_str
+      if _dynamically_exposed_readers.include? method_name_str
+        _ghost_reader method_name_str, *args, &blk
+      elsif _dynamically_exposed_writers.include? method_name_str
+        _ghost_writer method_name_str, *args, &blk
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      _dynamically_exposed_methods.include?(method_name.to_s) || super
+    end
+
+    def locked?(parameter)
+      lock_option = parameter[:options].fetch(:lock, nil)
+      case lock_option
+      when nil
+        false
+      when :on_set
+        parameter[:set]
+      when :on_validation
+        validated
+      when :on_ready
+        readied
+      else
+        raise InvalidLockOptionError
+      end
+    end
+
+    private
+
+    def _ghost_reader(method_name_str, *_args)
+      parameters.detect { |p| p[:name] == method_name_str }[:value]
+    end
+
+    def _ghost_writer(method_name_str, *args)
+      parameter = parameters.detect { |p| "#{p[:name]}=" == method_name_str }
+      raise CannotModifyLockedParameterError if locked? parameter
+      parameter[:value] = args.first
+      parameter[:set] = true
+      parameter[:value]
+    end
+
+    def _missing_configuration
+      raise MissingConfigurationError,
+            "All required configurations have not been set. Missing configurations: #{_invalid_parameter_names}"
+    end
+
+    def _dynamically_exposed_methods
+      _dynamically_exposed_readers | _dynamically_exposed_writers
+    end
+
+    def _dynamically_exposed_readers
+      (readied || configuring || validating) ? parameters.map { |p| p[:name] } : []
+    end
+
+    def _dynamically_exposed_writers
+      parameters.map { |p| "#{p[:name]}=" }
+    end
+
+    def _invalid_parameters
+      parameters.
+        select { |p| p[:options].fetch(:required, false) }.
+        select { |p| send(p[:name]).nil? }
+    end
+
+    def _invalid_parameter_names
+      _invalid_parameters.map { |p| p[:name] }.join(",")
+    end
+  end
+end

data/lib/fig_fig/version.rb

@@ -0,0 +1,3 @@
+class FigFig
+  VERSION = "0.2.0"
+end

data/spec/app_config/configuration_container_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+
+describe FigFig::ConfigurationContainer do
+  describe "registering a new parameter" do
+    it "registers a setter" do
+      subject.parameter :foo
+
+      expect { subject.foo = "foo" }.not_to raise_error
+    end
+  end
+
+  describe "validated" do
+    it "defaults to false" do
+      expect(subject.validated).to be false
+    end
+  end
+
+  describe "private methods" do
+    describe "#_invalid_parameters" do
+      context "during validation" do
+        it "is the Array of parameters that are invalid" do
+          subject.parameter :foo
+          subject.parameter :bar, required: true
+          subject.foo = "foo"
+          subject.validating = true
+          expect(subject.send(:_invalid_parameters)).
+            to eq [{ name: "bar", options: { required: true }, value: nil, set: false }]
+        end
+      end
+    end
+  end
+end

data/spec/app_config_spec.rb

@@ -0,0 +1,263 @@
+require "spec_helper"
+
+describe FigFig do
+  before(:each) do
+    described_class.reset
+  end
+  describe "configuring AppConfig" do
+    describe ".configure" do
+      it "yields AppConfig to the given block" do
+        expect { |b| described_class.configure(&b) }.to yield_with_args FigFig::ConfigurationContainer
+      end
+
+      it "is where you should specify the configuration parameters" do
+        described_class.configure do |c|
+          c.parameter :fooz
+          c.parameter :doggyz, required: true
+        end
+
+        described_class.fooz = "yo fooz"
+        expect { described_class.ready }.to raise_error FigFig::MissingConfigurationError
+        described_class.doggyz = "pups"
+        expect { described_class.ready }.not_to raise_error
+
+        described_class.ready
+
+        expect(described_class.fooz).to eq "yo fooz"
+        expect(described_class.doggyz).to eq "pups"
+      end
+
+      it "is where you should specify after_validation callbacks" do
+        expect { |b|
+          described_class.configure do |c|
+            c.parameter :doggyz, required: true
+            c.after_validation(&b)
+          end
+          described_class.doggyz = "poodle"
+          described_class.ready
+        }.to yield_with_args FigFig::ConfigurationContainer
+      end
+
+      it "is possible to perform actions based on the latest state of the AppConfig" do
+        described_class.configure do |c|
+          c.parameter :is_a_poodle
+          c.parameter :doggyz, required: true
+          c.after_validation do |validated_app_config|
+            validated_app_config.is_a_poodle = validated_app_config.doggyz == "poodle"
+          end
+        end
+
+        described_class.doggyz = "collie"
+        described_class.ready
+
+        expect(described_class.is_a_poodle).to eq false
+
+        described_class.doggyz = "poodle"
+        described_class.ready
+        expect(described_class.is_a_poodle).to eq true
+      end
+
+      context "when .configure is called more than once" do
+        it "raises a ConfigurationAlreadyDefinedError" do
+          described_class.configure do |c|
+            c.parameter :cats
+          end
+
+          expect { described_class.configure }.
+            to raise_error FigFig::ConfigurationAlreadyDefinedError
+        end
+
+        context "when the reset: true option is supplied" do
+          it "resets the configuration" do
+            described_class.configure do |c|
+              c.parameter :cats
+              expect(c).to respond_to :cats, :cats=
+            end
+
+            described_class.configure(reset: true) do |c|
+              c.parameter :mice
+              expect(c).to respond_to :mice, :mice=
+              expect(c).not_to respond_to :cats, :cats=
+            end
+          end
+        end
+      end
+
+      describe "marking a configuration parameter as required" do
+        it "accepts a :required option" do
+          described_class.configure do |c|
+            c.parameter :foo, required: true
+          end
+        end
+
+        it "requires the parameter for the AppConfig to be valid" do
+          described_class.configure do |c|
+            c.parameter :foo, required: true
+          end
+
+          expect { described_class.ready }.to raise_error FigFig::MissingConfigurationError
+
+          described_class.foo = :bar
+
+          expect { described_class.ready }.not_to raise_error
+        end
+      end
+    end
+  end
+
+  describe ".valid?" do
+    context "when a required parameter becomes nil during the invocation of an after_validation callback" do
+      it "raises AppConfig::MissingConfigurationError" do
+        described_class.configure do |c|
+          c.parameter :foo, required: true
+          c.after_validation do |config_after_validation|
+            config_after_validation.foo = nil
+          end
+        end
+        described_class.foo = "foo"
+        expect { described_class.valid? }.to raise_error FigFig::MissingConfigurationError
+      end
+    end
+  end
+
+  describe ".ready" do
+    it "triggers validation" do
+      described_class.configure do |c|
+        c.parameter :foo
+      end
+      expect(described_class.configuration).to receive :valid?
+      described_class.ready
+    end
+  end
+
+  describe "parameter locking" do
+    it "defaults to no lock" do
+      described_class.configure do |c|
+        c.parameter :foo
+      end
+      described_class.foo = "foo"
+      expect { described_class.foo = "foo" }.not_to raise_error
+      described_class.valid?
+      expect { described_class.foo = "foo" }.not_to raise_error
+      described_class.ready
+      expect { described_class.foo = "foo" }.not_to raise_error
+    end
+
+    context "when the :on_set lock is used" do
+      it "prevents mutation of the parameter once it has been set" do
+        described_class.configure do |c|
+          c.parameter :foo, lock: :on_set
+        end
+        described_class.foo = "foo"
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+        described_class.valid?
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+        described_class.ready
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+      end
+    end
+
+    context "when the :on_validation lock is used" do
+      it "prevents mutation of the parameter after validation" do
+        described_class.configure do |c|
+          c.parameter :foo, lock: :on_validation
+        end
+        described_class.foo = "foo"
+        expect { described_class.foo = "foo" }.not_to raise_error
+        described_class.valid?
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+        described_class.ready
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+      end
+
+      it "prevents mutation of the parameter in after_validation callbacks" do
+        described_class.configure do |c|
+          c.parameter :foo, lock: :on_validation
+          c.after_validation do |config_after_validation|
+            expect { config_after_validation.foo = "foo" }.
+              to raise_error FigFig::CannotModifyLockedParameterError
+          end
+        end
+        described_class.foo = "foo"
+        expect { described_class.foo = "foo" }.not_to raise_error
+        described_class.valid?
+      end
+    end
+
+    context "when the :on_ready lock is used" do
+      it "prevents mutation of the parameter after the AppConfig is readied" do
+        described_class.configure do |c|
+          c.parameter :foo, lock: :on_ready
+        end
+        described_class.foo = "foo"
+        expect { described_class.foo = "foo" }.not_to raise_error
+        described_class.valid?
+        expect { described_class.foo = "foo" }.not_to raise_error
+        described_class.ready
+        expect { described_class.foo = "foo" }.to raise_error FigFig::CannotModifyLockedParameterError
+      end
+    end
+
+    context "when the specified lock option is unexpected" do
+      it "raises an InvalidLockOptionError" do
+        described_class.configure do |c|
+          c.parameter :foo, lock: :blahblah
+        end
+        expect { described_class.foo = "foo" }.to raise_error FigFig::InvalidLockOptionError
+      end
+    end
+  end
+
+  describe "lifecycle events" do
+    describe "ready" do
+      context "before the ready lifecycle event" do
+        it "prohibits reader access outside of the .configure block's scope" do
+          described_class.configure do |c|
+            c.parameter :foo
+          end
+          described_class.foo = "foo"
+          expect { described_class.foo }.to raise_error NoMethodError
+          expect(described_class).not_to respond_to :foo
+          described_class.ready
+          expect(described_class.foo).to eq "foo"
+          expect(described_class).to respond_to :foo
+        end
+
+        it "permits reader access outside of the .configure block's scope during validation" do
+          described_class.configure do |c|
+            c.parameter :foo
+          end
+          described_class.foo = "foo"
+
+          described_class.configuration.validating = true
+          expect(described_class.foo).to eq "foo"
+          expect(described_class).to respond_to :foo
+        end
+      end
+    end
+  end
+  describe "callbacks" do
+    context "when validation is successful" do
+      it "invokes the registered callbacks in the order they were registered" do
+        described_class.configure do |c|
+          c.parameter :is_a_poodle
+          c.parameter :doggyz, required: true
+          c.after_validation do |validated_app_config|
+            validated_app_config.is_a_poodle = validated_app_config.doggyz == "poodle"
+          end
+          c.after_validation do |validated_app_config|
+            validated_app_config.doggyz = "buy a new dog" if validated_app_config.is_a_poodle
+          end
+        end
+
+        described_class.doggyz = "poodle"
+        described_class.is_a_poodle = false
+
+        described_class.ready
+
+        expect(described_class.is_a_poodle).to be true
+        expect(described_class.doggyz).to eq "buy a new dog"
+      end
+    end
+  end
+end

data/spec/simplecov_custom_profile.rb

@@ -0,0 +1,4 @@
+require "simplecov"
+SimpleCov.profiles.define "fig_fig" do
+  add_filter "/spec"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require_relative "simplecov_custom_profile"
+SimpleCov.start "fig_fig"
+require "fig_fig"
+require "byebug"

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: fig_fig
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Courtland Caldwell
+- Blake Luchessi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Configurator for Ruby Applications with some validation and sugars.
+email: engineering@mattermark.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rubocop.yml
+- .rubocop_todo.yml
+- LICENSE
+- README.md
+- circle.yml
+- fig_fig.gemspec
+- lib/fig_fig.rb
+- lib/fig_fig/version.rb
+- spec/app_config/configuration_container_spec.rb
+- spec/app_config_spec.rb
+- spec/simplecov_custom_profile.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Referly/fig_fig
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: Ruby Application Configurator
+test_files:
+- spec/app_config/configuration_container_spec.rb
+- spec/app_config_spec.rb
+- spec/simplecov_custom_profile.rb
+- spec/spec_helper.rb
+has_rdoc: