clean_config 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YTc4YTQ0Mjg4OWIzNGJkMmViYzQwYjI4YTkyMTY0YWE2OGQ3N2QzMw==
+  data.tar.gz: !binary |-
+    NTZlYTM1M2QxNTRmYmNkMDgwNjlhYThkYTM5MmU3MGQ4ZTQzOTM5ZA==
+SHA512:
+  metadata.gz: !binary |-
+    ZTdlY2ZkZDAyY2M2Y2I3YTcwY2M2ODJiMzlmZTYyYTljMmUwMzQzOTJkY2Jk
+    MmNmMjczNjgyZDI5YTczNGVhYzRhOGU2NGQ4MWNhODBhZWNkNmVmZTg2NjQy
+    YjY5YmZlYmM2MGEwMjkyYTVhZTRlY2I0ZWU4YTFhYjkyOTc3OTM=
+  data.tar.gz: !binary |-
+    YWExOTljY2FmNDJlZmEwNGYyOGU4MThlMzkyMzQ0Y2YwZGU0Zjk2MGRhNDBi
+    Nzg0ZDM5NmQwYWEwMjVkNDVkNzVkNjU3NDFiNTQ1NTQ4MmRkZDA2M2Y1NzE4
+    NDc0MTE1YTljZmM5ZGZlMjdmYjM0ZWYxYTY3MWY5OWE4ZjgzMmM=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+*.log
+annotations_report.html
+annotations.yml

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+#do not check for utf stamp
+Encoding:
+  Enabled: false
+
+LineLength:
+  Enabled: true
+  Max: 128
+
+# The rubocop Documentation cop is a duplicate of the Reek IrresponsibleModule
+# check.
+Documentation:
+  Enabled: false
+
+CaseIndentation:
+  Enabled: false
+
+# MethodLength is superseded by Reek's TooManyStatements smell-finder.
+MethodLength:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 10

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - 2.2.2
+script: bundle exec rake spec

data/.yardopts

@@ -0,0 +1,2 @@
+--exclude lib/clean_config/version.rb
+--exclude lib/tasks.rb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.0.1
+- enables `fetch`,`keys` method on recursive_open_struct
+- load!, merge! and reset! convenience methods 

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clean_config.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015, Opower
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,94 @@
+#clean_config
+
+A simple configuration library for Ruby projects.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'clean_config'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install 'clean_config'
+
+## Usage
+
+By convention, configuration lives in a single file: `config/config.yml`.
+
+You can put any data you want in this file and access that data in one of three ways:
+
+```yaml
+# config/config.yml
+ :foo:
+   :bar: 'baz'
+```
+
+```ruby
+require 'clean_config'
+
+class MyClass
+  include CleanConfig::Configurable
+
+  def initialize()
+    config = CleanConfig::Configuration.instance
+    config[:foo][:bar]          # 'baz'
+    config.foo.bar              # 'baz'
+    config.parse_key('foo.bar') # 'baz'
+  end
+end
+```
+
+### Conventions
+Loading configuration data in Ruby is easy. In fact, it is so easy that if you look at several different Ruby projects,
+you'll likely find several different implementations for loading configuration. We decided to standardize how we would 
+load our configuration across all our gems.
+
+This library requires your configuration be stored in a single yml file, located at
+
+`config/config.yml`
+
+### Loading Configuration
+Including the `Configurable` module is what initializes the `Configuration` object with the data from `config/config.yml`.
+Simply include this module and your configuration will be available via `CleanConfig::Configuration.instance`.
+
+If you are using the CleanConfig outside of a module or class, there are a few methods available to you
+to point CleanConfig to your configuration directory.
+
+`add!` allows you to change the directory/file name for your configuration files.
+
+`load!` looks for the default directory/file name (`config/config.yml`) but at the same level as the calling code.
+
+`merge!` allows you to pass in a hash of additional configuration to add to your CleanConfig.
+
+### Accessing Configuration
+After `include CleanConfig::Configurable` you can access your config with: `CleanConfig::Configuration.instance`.
+This will have all of your project's configuration and any configuration defined in dependencies.
+
+To get access to the underlying `Hash` methods prefix them with `to_hash` or `to_h`, e.g. `config.to_h.values`.
+
+Note: We have added a `#keys` method also.
+As a result, if you have a field called `:keys:` in your config file the only way to access it is `config.to_h[:keys]`
+
+### Layering Configuration
+If you depend on gems that are using clean_config, you can override their key-value pairs in your own `config/config.yml`. 
+Also, it's a good idea to nest your configuration under some top-level, project-specific key to prevent accidental 
+configuration collisions.
+
+## Contributing
+
+#### Contacts
++ Adrian Cazacu
++ CivJ
++ Crystal Hsiung
+
+#### Process
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require_relative 'lib/tasks'

data/build.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Tell bash that we want the whole script to fail if any part fails.
+set -e
+
+# Global Variables
+SOURCE_DIR=`pwd`
+
+# Begin
+echo "*************************************"
+echo "Running build script..."
+echo "PWD :"$SOURCE_DIR
+
+main() {
+  echo "*************************************"
+  startTime=$(date +%s)
+
+  bundle install --path vendor/bundle
+  bundle exec rake rubocop
+  bundle exec rake spec:full --trace
+  gem build orb_configuration.gemspec
+
+  endTime=$(date +%s)
+  timeDifference=$(( $endTime - $startTime ))
+
+  echo "Execution time :" $timeDifference
+  echo "Finished."
+}
+
+# RUN
+main

data/clean_config.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/clean_config/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'clean_config'
+  spec.version       = CleanConfig::VERSION
+  spec.summary       = 'A simple configuration library'
+  spec.description   = 'Provides programatic access to config/config.yml'
+  spec.homepage      = 'http://github.com/opower/clean_config'
+
+  spec.authors       = ['John Crimmins', 'Crystal Hsiung', 'Adrian Cazacu']
+  spec.email         = ['john.crimmins@opower.com']
+
+  # This gem will work with 1.9.3 or greater...
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.license       = 'Apache 2'
+
+  # file attributes...
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rake', '~> 10.1')
+  spec.add_development_dependency('rspec', '~> 3.1')
+  spec.add_development_dependency('rspec-legacy_formatters', '~> 1.0')
+  spec.add_development_dependency('rspec-extra-formatters', '~> 1.0')
+  spec.add_development_dependency('rubocop', '= 0.26.1')
+  spec.add_development_dependency('fuubar', '~> 2.0')
+  spec.add_development_dependency('yard')
+  spec.add_development_dependency('redcarpet')
+  spec.add_development_dependency('simplecov', '~> 0.7')
+
+  spec.add_runtime_dependency('recursive-open-struct', '~> 0.5')
+  # We're using deep_merge which is available in all versions of activesupport so far.
+  spec.add_runtime_dependency('activesupport', '< 5.0')
+end

data/lib/clean_config.rb

@@ -0,0 +1,4 @@
+require_relative 'clean_config/version'
+require_relative 'clean_config/configuration'
+require_relative 'clean_config/configurable'
+require_relative 'clean_config/ext/recursive_open_struct'

data/lib/clean_config/configurable.rb

@@ -0,0 +1,33 @@
+require 'logger'
+require_relative 'configuration'
+
+module CleanConfig
+  # Module to help initialize and gain access to CleanConfig::Configuration object
+  module Configurable
+    class << self
+
+      # Initialize the CleanConfig::Configuration object
+      # Reads in from default config/config.yml file based on project root directory
+      def included(_parent)
+        log = ConfLogger.new(STDOUT)
+
+        # calling_file is the file name of the Ruby code that is our parent in the call stack.
+        calling_file = caller.first.split(':').first
+        log.debug("calling_file: #{calling_file}")
+        config_path = Configuration.resolve_config_path(calling_file)
+
+        if File.exist?(config_path)
+          Configuration.instance.add!(config_path)
+          log.debug("Reading configuration from #{config_path}")
+          begin
+            Configuration.instance.add!(config_path)
+          rescue InvalidConfigException
+            log.warn("Read configuration from #{config_path}, but configuration not valid. Ignoring, check your config")
+          end
+        else
+          log.debug("Expected config directory #{config_path} not found. Not loading configuration")
+        end
+      end
+    end
+  end
+end

data/lib/clean_config/configuration.rb

@@ -0,0 +1,161 @@
+require 'active_support/all'
+require 'forwardable'
+require 'recursive-open-struct'
+require 'singleton'
+require 'logger'
+require 'yaml'
+
+module CleanConfig
+  # Exception when file not found
+  FileNotFoundException  = Class.new(Exception)
+  # Exception for configuration parsing errors
+  InvalidConfigException = Class.new(Exception)
+
+  # Logger that reads DEBUG environment variable to set level
+  class ConfLogger < Logger
+    def initialize(*args)
+      super
+      self.level = ENV['DEBUG'] ? Logger::DEBUG : Logger::INFO
+    end
+  end
+
+  # Provides access to configuration data
+  # Supports both [:property] and '.property' style access to yml configuration
+  # Default configuration path is `config/config.yml`
+  class Configuration
+    include ::Singleton
+    extend ::Forwardable
+
+    # directory where configuration yml is expected to be, relative to project root directory
+    DEFAULT_CONFIGURATION_DIRECTORY = 'config'
+
+    # name of configuration yml
+    DEFAULT_CONFIGURATION_FILE_NAME = "#{DEFAULT_CONFIGURATION_DIRECTORY}.yml"
+
+    # directories commonly found at project root directory, used to find the project root
+    CODE_DIRECTORIES = %w(lib spec bin)
+
+    # logger
+    LOG = ConfLogger.new(STDOUT)
+
+    def_delegators :@data_hash, :[]
+
+    class << self
+      # Finds the full path to the project's configuration file
+      #
+      # @param [String] calling_file path of the file that invoked this code
+      # @return [String] full path to configuration
+      def resolve_config_path(calling_file)
+        config_location = File.join(Configuration::DEFAULT_CONFIGURATION_DIRECTORY,
+                                    Configuration::DEFAULT_CONFIGURATION_FILE_NAME)
+
+        config_path = find_execution_path(calling_file)
+        config_path.empty? ? config_path : File.join(config_path, config_location)
+      end
+
+      # Finds a Ruby project's lib directory by looking for a Gemfile sibling
+      #
+      # @param [String] path The path in which to look for the project's lib directory
+      # @return [String] the project root directory
+      def find_execution_path(path)
+        path = File.extname(path).empty? ? path : File.dirname(path)
+        directories = path.split(File::Separator)
+        project_directory = ''
+
+        until directories.nil? || directories.empty?
+          if CODE_DIRECTORIES.include?(directories.last) && project_directory.empty?
+            directories.pop
+            gemfile_location = File.join(directories.join(File::Separator), 'Gemfile')
+            project_directory = File.dirname(gemfile_location) if File.exist?(gemfile_location)
+          end
+          directories.pop
+        end
+        project_directory
+      end
+    end
+
+    # Loads configuration relative to Ruby's execution directory.
+    # Useful for accessing config in tests and Rake tasks
+    #
+    # @return [Configuration] self
+    def load!
+      add!(File.join(DEFAULT_CONFIGURATION_DIRECTORY, DEFAULT_CONFIGURATION_FILE_NAME))
+    end
+
+    # Allows the user to specify a config file other than 'config/config.yml'
+    #
+    # @param [String] config_path provided as a convenience, but should be avoided in favor of the default location
+    # @return [CleanConfig::Configuration] self
+    def add!(config_path = nil)
+      calling_code_file_path = caller.first.split(':').first
+      config_path ||= Configuration.resolve_config_path(calling_code_file_path)
+      fail FileNotFoundException, "#{config_path} not found" unless File.exist?(config_path)
+
+      LOG.debug("Reading configuration from #{config_path}")
+      config_hash = YAML.load_file(config_path)
+      fail InvalidConfigException, "YAML unable to parse empty #{config_path}" unless config_hash # empty YAML returns false
+
+      merge!(config_hash)
+    end
+
+    # Set and merge config at runtime without a file
+    #
+    # @param [Hash] config data to add to configuration
+    # @return [CleanConfig::Configuration] self
+    def merge!(config = {})
+      @data_hash = @data_hash.nil? ? config : @data_hash.deep_merge(config)
+      @data_model = RecursiveOpenStruct.new(@data_hash, recurse_over_arrays: true)
+      self
+    end
+
+    # Given a period-delimited string of keys, find the nested value stored in the configuration
+    #
+    # @param [String] config_key period-delimited string of nested keys
+    # @return [Object] value retrieved
+    def parse_key(config_key)
+      fail 'config_key required' if config_key.nil? || config_key.empty?
+      parse_key_recursive(@data_model, config_key.split('.').reverse, '')
+    end
+
+    # Pass along methods not recognized to the underlying data structure
+    def method_missing(method, *args, &block)
+      @data_model.send(method, *args, &block)
+    end
+
+    # Returns whether the configuration is empty or not
+    #
+    # @return [Boolean] true if configuration is empty
+    def empty?
+      @data_model.nil?
+    end
+
+    # Clear configuration
+    #
+    # @return [CleanConfig::Configuration] self
+    def reset!
+      @data_model = nil
+      @data_hash  = nil
+      self
+    end
+
+    private
+
+    # For nested configurations, recursively look for the key
+    #
+    # @param [Object] data_model configuration object to look for key in
+    # @param [String] config_keys period-delimited string of keys to look for
+    # @param [String] key_message period-delimited string of keys we are nested in, used for debug output
+    # @return [Object] value
+    def parse_key_recursive(data_model, config_keys, key_message)
+      if config_keys.length > 0
+        config_key = config_keys.pop
+        key_message << config_key
+        configuration = data_model.send(config_key.to_sym)
+        fail "config_key #{key_message} has no defined value" unless configuration
+        parse_key_recursive(configuration, config_keys, key_message << '.')
+      else
+        data_model
+      end
+    end
+  end
+end

data/lib/clean_config/ext/recursive_open_struct.rb

@@ -0,0 +1,16 @@
+# Monkeypatching RecursiveOpenStruct to respond to common Hash methods
+class RecursiveOpenStruct < OpenStruct
+  # Returns array with keys from the RecursiveOpenStruct
+  # @return [Array] keys
+  def keys
+    to_h.keys
+  end
+
+  # Returns value for given key
+  # @param [Object] key key to retrieve value
+  # @param [Object] default value to return if key is not found
+  # @return [Object] value associated with given key
+  def fetch(key, default = nil)
+    to_h.fetch(key, default)
+  end
+end

data/lib/clean_config/version.rb

@@ -0,0 +1,3 @@
+module CleanConfig
+  VERSION = '0.0.2'
+end

data/lib/tasks.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env rake
+# Please note this file does not use the test_support gem because test_support depends on orb_configuration.
+# As a work-around to avoid a circular-dependency, we're rolling our own task code here.
+# This is a special case. The vast majority of projects should be using test_support to provide Rspec tasks.
+require 'rspec'
+require 'rspec/core/rake_task'
+require 'rspec-extra-formatters'
+require 'fuubar'
+require 'rubocop/rake_task'
+require 'logger'
+
+TMP_DIR = 'tmp'
+LOG = Logger.new(open('rake.log', File::WRONLY | File::APPEND | File::CREAT))
+
+desc 'Run RuboCop on lib and spec directories, Gemfile, gemspec, Rakefile; Override with a space delimited list'
+RuboCop::RakeTask.new(:rubocop, :pattern) do |task, args|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'Gemfile', '*.gemspec', 'Rakefile']
+  task.patterns = args[:pattern].split(' ') if args[:pattern] # override default pattern
+  LOG.info("Running RuboCop against #{task.patterns}")
+end
+
+def timestamp
+  Time.now.strftime('%Y%m%d_%H%M%S')
+end
+
+def build_rspec_opts(test_type, task)
+  task.rspec_opts = ['-c']
+  task.rspec_opts << '--require' << 'fuubar'
+  task.rspec_opts << '--format' << Fuubar
+  task.rspec_opts << '--require' << 'rspec/legacy_formatters'
+  task.rspec_opts << '--require' << 'rspec-extra-formatters'
+  task.rspec_opts << '--format' << JUnitFormatter
+  task.rspec_opts << '--out' << "tmp/results/#{test_type}/#{timestamp}_results.xml"
+  task.rspec_opts << '--format' << 'html'
+  task.rspec_opts << '--out' << "tmp/results/#{test_type}/#{timestamp}_results.html"
+  task.pattern = "spec/#{test_type}/**/*_spec.rb"
+end
+
+namespace :clean do
+  desc 'Remove all tmp files'
+  task :tmp do
+    LOG.info("Deleting the #{TMP_DIR} directory...")
+    FileUtils.rm_rf(TMP_DIR)
+    LOG.info('Deleted.')
+  end
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    FileUtils.mkdir_p(TMP_DIR)
+    build_rspec_opts('unit', task)
+  end
+
+  RSpec::Core::RakeTask.new(:e2e) do |task|
+    FileUtils.mkdir_p(TMP_DIR)
+    build_rspec_opts('e2e', task)
+  end
+
+  desc 'Run all tests'
+  task full: %w(clean:tmp spec:unit spec:e2e)
+end
+
+LOG.close

data/spec/e2e/core/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+*.log

data/spec/e2e/core/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/spec/e2e/core/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/spec/e2e/core/.rubocop.yml

@@ -0,0 +1,22 @@
+#do not check for utf stamp
+Encoding:
+  Enabled: false
+
+LineLength:
+  Enabled: true
+  Max: 128
+
+# The rubocop Documentation cop is a duplicate of the Reek IrresponsibleModule
+# check.
+Documentation:
+  Enabled: false
+
+CaseIndentation:
+  Enabled: false
+
+# MethodLength is superseded by Reek's TooManyStatements smell-finder.
+MethodLength:
+  Enabled: false
+
+CyclomaticComplexity:
+  Max: 10

data/spec/e2e/core/Gemfile

@@ -0,0 +1,5 @@
+source :rubygems
+
+# Specify your gem's dependencies in core.gemspec
+gemspec
+gem 'clean_config', :path => '../../..'

data/spec/e2e/core/Rakefile

@@ -0,0 +1 @@
+require_relative 'lib/tasks'

data/spec/e2e/core/config/config.yml

@@ -0,0 +1,3 @@
+:data:
+  :core: core value
+  :foo: foo value

data/spec/e2e/core/core.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/core/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'core'
+  spec.version       = Core::VERSION
+  spec.summary       = 'TODO: Write a short summary. Required.'
+  spec.description   = 'TODO: Write a longer description. Optional.'
+  spec.homepage      = 'http://github.com/your-GH-name-here/core'
+
+  spec.authors       = ['foo']
+  spec.email         = ['your-email-here@email.com']
+
+  # This gem will work with 1.9.3 or greater...
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.license       = 'MIT'
+
+  # file attributes...
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('rake', '~> 10.1')
+  spec.add_development_dependency('rspec', ' 2.14.1')
+  spec.add_development_dependency('rspec-extra-formatters', ' 0.4')
+  spec.add_development_dependency('rubocop', ' 0.24.0')
+  spec.add_development_dependency('simplecov', ' 0.7.1')
+  spec.add_development_dependency('rspec', '~> 3.1')
+end

data/spec/e2e/core/lib/core.rb

@@ -0,0 +1,2 @@
+require_relative 'core/version'
+require_relative 'core/core_one'

data/spec/e2e/core/lib/core/core_one.rb

@@ -0,0 +1,13 @@
+require 'clean_config'
+
+module Core
+  class CoreOne
+    include CleanConfig::Configurable
+
+    attr_reader :config
+
+    def initialize
+      @config = CleanConfig::Configuration.instance
+    end
+  end
+end

data/spec/e2e/core/lib/core/version.rb

@@ -0,0 +1,4 @@
+module Core
+  VERSION = '0.0.1'
+  ORB_ARCHETYPER = '0.0.4'
+end

data/spec/e2e/core/lib/tasks.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+desc 'Run RuboCop on lib and spec directories, Gemfile, gemspec, Rakefile; Override with a space delimited list'
+RuboCop::RakeTask.new(:rubocop, :pattern) do |task, args|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb', 'Gemfile', '*.gemspec', 'Rakefile']
+  task.patterns = args[:pattern].split(' ') if args[:pattern] # override default pattern
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern = 'spec/**/*_spec.rb'
+  end
+end

data/spec/e2e/core/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# TODO: make spec_helper_gem and spec_helper_test. Take coverage out of test.
+require 'simplecov'
+
+SimpleCov.start do
+  coverage_dir 'tmp/coverage/unit'
+  add_filter 'tmp/'
+  add_filter 'spec/'
+end
+
+RSpec.configure do |config|
+  # Only accept expect syntax do not allow old should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/e2e/core/spec/unit/core_spec.rb

@@ -0,0 +1,12 @@
+require_relative '../../lib/core/core_one'
+
+module Core
+  describe CoreOne do
+    context 'layers config' do
+      it 'reads configs' do
+        core_one = CoreOne.new
+        expect(core_one.config.data.core).to eq('core value')
+      end
+    end
+  end
+end

data/spec/e2e/core_config_spec.rb

@@ -0,0 +1,14 @@
+require 'English'
+
+module CleanConfig
+  describe Configuration do
+    it 'should load correct config when required in a different gem' do
+      Dir.chdir(File.join('spec', 'e2e', 'core')) do
+        Bundler.with_clean_env do
+          `bundle install && bundle exec rake spec:unit`
+        end
+      end
+      expect($CHILD_STATUS.success?).to be true
+    end
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,5 @@
+:test:
+  :foo: bar
+other_test: 123
+:merge_test:
+  :foo: baz

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+
+SimpleCov.start do
+  coverage_dir 'tmp/coverage/unit'
+  add_filter 'tmp/'
+  add_filter 'spec/'
+end
+
+RSpec.configure do |config|
+  # Only accept expect syntax do not allow old should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/clean_configuration_spec.rb

@@ -0,0 +1,140 @@
+require_relative '../../lib/clean_config/configuration'
+
+module CleanConfig
+  describe Configuration do
+    context 'singleton creation' do
+      it 'only creates one instance' do
+        config = Configuration.instance
+        expect(config).to eql(Configuration.instance)
+      end
+
+      it '#new throws error' do
+        expect { Configuration.new }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'instance methods' do
+      let(:config_path) { File.join(File.dirname(__FILE__), '..', 'fixtures') }
+      let(:config) do
+        config = Configuration.instance
+        config.add!(File.join(config_path, 'config.yml'))
+        config
+      end
+
+      it '#load! loads the top-level config.yml' do
+        stub_const('CleanConfig::Configuration::DEFAULT_CONFIGURATION_DIRECTORY', config_path)
+        config = Configuration.instance
+        config.load!
+        expect(config.test.foo).to eq('bar')
+      end
+
+      it '#add! fails if YAML file is empty' do
+        config_path = File.join(File.dirname(__FILE__), '..', 'fixtures', 'empty.yml')
+        expect { config.add!(config_path) }.to raise_error("YAML unable to parse empty #{config_path}")
+      end
+
+      it '#merge! sets config as expected' do
+        expect(config.merge_test.foo).to eq('baz')
+        config.merge!(merge_test: { foo: 'asdf' })
+        expect(config.merge_test.foo).to eq('asdf')
+      end
+
+      context 'delegated methods' do
+        it '#[] accepts a symbol and provides access to config data' do
+          expect(config[:test][:foo]).to eq('bar')
+        end
+
+        it '#[] accepts a string and provides access to config data' do
+          expect(config['other_test']).to eq(123)
+        end
+      end
+
+      context 'config properties are methods' do
+        it '#method_missing forwards methods to internal RecursiveStruct' do
+          expect(config.test.foo).to eq('bar')
+        end
+
+        it '#method_missing returns nil when internal RecursiveStruct has no associated property' do
+          expect(config.fake).to be_nil
+        end
+      end
+
+      context 'configuration string parsing' do
+        it '#parse_config_key returns the correct property value for the given string' do
+          expect(config.parse_key('test.foo')).to eq('bar')
+          expect(config.parse_key('test').foo).to eq('bar')
+        end
+        it '#parse_config_key throws an error for nonexistant keys' do
+          # Providing 'fail' does not throw the error I expect. I am not sure why.
+          # expect(config.parse_config_key('fail')).to eq('bar')
+          expect { config.parse_key('nope') }.to raise_error(RuntimeError)
+          expect { config.parse_key('nope.again') }.to raise_error(RuntimeError)
+        end
+      end
+
+      context 'read config file' do
+        it 'add! throws FileNotFoundException if there is no file.' do
+          expect { config.add!('') }.to raise_error(FileNotFoundException)
+        end
+      end
+
+      it '#empty? should return false if config file was read.' do
+        expect(config.empty?).to be false
+      end
+
+      it '#empty? should return true if no config file was read.' do
+        config.reset!
+        expect(config.empty?).to be true
+      end
+
+    end
+
+    context 'class methods' do
+      let(:var_lib_jenkins_foo) { '/var/lib/jenkins/foo' }
+      let(:var_jenkins_foo) { '/var/jenkins/foo' }
+
+      it '#find_execution_dir finds a config location when code is in a bin directory' do
+        # We use `File.exist?` in configuration.rb to check if we have a Gemfile.
+        allow(File).to receive(:exist?).and_return(true)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/bin/file.rb')).to eq(var_lib_jenkins_foo)
+      end
+
+      it '#find_execution_dir does not find a config when none exists under a lib directory' do
+        allow(File).to receive(:exist?).and_return(false, false)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/lib/file.rb')).to be_empty
+      end
+
+      it '#find_execution_dir finds config location with nested libs' do
+        allow(File).to receive(:exist?).and_return(true)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/lib/file.rb')).to eq(var_lib_jenkins_foo)
+      end
+
+      it '#find_execution_dir finds config location with nested specs' do
+        allow(File).to receive(:exist?).and_return(false, true)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/spec/smoke/spec'))
+        .to eq(var_lib_jenkins_foo)
+      end
+
+      it '#find_execution_dir finds config location when calling code is deep under lib' do
+        allow(File).to receive(:exist?).and_return(true)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/lib/one/two/three/file.rb'))
+        .to eq(var_lib_jenkins_foo)
+      end
+
+      it '#find_execution_dir finds config location with spec nested under lib' do
+        allow(File).to receive(:exist?).and_return(true)
+        expect(Configuration.find_execution_path('/var/lib/jenkins/foo/spec/file.rb')).to eq(var_lib_jenkins_foo)
+      end
+
+      it '#find_execution_dir finds config location with one lib' do
+        allow(File).to receive(:exist?).and_return(true)
+        expect(Configuration.find_execution_path('/var/jenkins/foo/lib/file.rb')).to eq(var_jenkins_foo)
+      end
+
+      it '#find_execution_dir finds config location with one spec' do
+        allow(File).to receive(:exist?).and_return(true, true)
+        expect(Configuration.find_execution_path('/var/jenkins/foo/spec/file.rb')).to eq(var_jenkins_foo)
+      end
+    end
+  end
+end

data/spec/unit/configurable_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../../lib/clean_config/configurable'
+require_relative '../../lib/clean_config/configuration'
+
+module CleanConfig
+  describe Configurable do
+    context 'hooks' do
+      it 'does not fail on include when config/config.yml not found' do
+        expect do
+          class ConfigTest
+            include Configurable
+          end
+        end.not_to raise_error
+      end
+    end
+  end
+end

data/spec/unit/recursive_open_struct_spec.rb

@@ -0,0 +1,22 @@
+require_relative '../../lib/clean_config/ext/recursive_open_struct'
+
+module CleanConfig
+  describe RecursiveOpenStruct do
+    context 'monkey patched methods' do
+      let(:subject) do
+        hash = { key1: 'value1', key2: 'value2' }
+        RecursiveOpenStruct.new(hash, recurse_over_arrays: true)
+      end
+
+      it 'responds to keys' do
+        expect(subject.keys).to include(:key1)
+        expect(subject.keys).to include(:key2)
+      end
+
+      it 'responds to fetch' do
+        expect(subject.fetch(:key1)).to eql('value1')
+        expect(subject.fetch(:monkey, 'default')).to eql('default')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,261 @@
+--- !ruby/object:Gem::Specification
+name: clean_config
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- John Crimmins
+- Crystal Hsiung
+- Adrian Cazacu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-extra-formatters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.26.1
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides programatic access to config/config.yml
+email:
+- john.crimmins@opower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- build.sh
+- clean_config.gemspec
+- lib/clean_config.rb
+- lib/clean_config/configurable.rb
+- lib/clean_config/configuration.rb
+- lib/clean_config/ext/recursive_open_struct.rb
+- lib/clean_config/version.rb
+- lib/tasks.rb
+- spec/e2e/core/.gitignore
+- spec/e2e/core/.rakeTasks
+- spec/e2e/core/.rspec
+- spec/e2e/core/.rubocop.yml
+- spec/e2e/core/Gemfile
+- spec/e2e/core/Rakefile
+- spec/e2e/core/config/config.yml
+- spec/e2e/core/core.gemspec
+- spec/e2e/core/lib/core.rb
+- spec/e2e/core/lib/core/core_one.rb
+- spec/e2e/core/lib/core/version.rb
+- spec/e2e/core/lib/tasks.rb
+- spec/e2e/core/spec/spec_helper.rb
+- spec/e2e/core/spec/unit/core_spec.rb
+- spec/e2e/core_config_spec.rb
+- spec/fixtures/config.yml
+- spec/fixtures/empty.yml
+- spec/spec_helper.rb
+- spec/unit/clean_configuration_spec.rb
+- spec/unit/configurable_spec.rb
+- spec/unit/recursive_open_struct_spec.rb
+homepage: http://github.com/opower/clean_config
+licenses:
+- Apache 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A simple configuration library
+test_files:
+- spec/e2e/core/.gitignore
+- spec/e2e/core/.rakeTasks
+- spec/e2e/core/.rspec
+- spec/e2e/core/.rubocop.yml
+- spec/e2e/core/Gemfile
+- spec/e2e/core/Rakefile
+- spec/e2e/core/config/config.yml
+- spec/e2e/core/core.gemspec
+- spec/e2e/core/lib/core.rb
+- spec/e2e/core/lib/core/core_one.rb
+- spec/e2e/core/lib/core/version.rb
+- spec/e2e/core/lib/tasks.rb
+- spec/e2e/core/spec/spec_helper.rb
+- spec/e2e/core/spec/unit/core_spec.rb
+- spec/e2e/core_config_spec.rb
+- spec/fixtures/config.yml
+- spec/fixtures/empty.yml
+- spec/spec_helper.rb
+- spec/unit/clean_configuration_spec.rb
+- spec/unit/configurable_spec.rb
+- spec/unit/recursive_open_struct_spec.rb
+has_rdoc: