really-confy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4a5653e5cc890738cf6afce11f7da262f814e78
+  data.tar.gz: 38f63ff32abbff0de095ebe6335d909ad8d935a1
+SHA512:
+  metadata.gz: 5af1c19f0ca561a5fe9dcd52fe019ad5e2bc5a20611934156f60ccc3b078daf3e8f5af37cc451b85b9d11c5d93e762f1d899c9f1ce012e78b736ee72856baa50
+  data.tar.gz: 99c36e189f874ede4a7226943a7fcd1530cc3235d3b08ac1234b8a81644fdca1af16d4766e7b987c61c7bc31d7b41febad54c3f9cef8560525a77f8a6ba5160c

data/lib/really_confy.rb

@@ -0,0 +1,235 @@
+require 'yaml'
+require 'rainbow'
+require 'active_support/core_ext/hash/deep_merge'
+
+class ReallyConfy
+
+  DEFAULT_OPTIONS = {
+    # look for config files under this directory
+    config_path: './config',
+    # load and reucrisvely merge the config from these files, in the given order (duplicate keys
+    # in later files will override those in earlier files)
+    config_files: [
+      'config.yml',
+      'config.secret.yml',
+      'config.local.yml'
+    ],
+    # load will raise a ConfigError if these files are in the git repo
+    local_config_files: [
+      'config.secret.yml',
+      'config.local.yml'
+    ],
+    # load will raise a ConfigError if these files are missing
+    required_config_files: [
+      'config.yml',
+      'config.secret.yml'
+    ],
+    # load will print a warning if these files are missing
+    suggested_config_files: [
+      'config.secret.yml'
+    ],
+    # the environment key will be selected based on this ENV variable
+    env_var_name: 'CONFY_ENV',
+    # use Symbols instead of Strings for all keys in the config Hash
+    symbol_keys: false,
+    # load will return an ActiveSupport::HashWithIndifferentAccess instead of a Hash
+    indifferent_keys: false,
+    # suppress output to stdout/stderr
+    quiet: false,
+    # enable colorized output; nil means 'auto', which enables color by default unless the
+    # terminal doesn't support it
+    color: nil,
+    # force the ruby interpreter to exit if ReallyConfy encounters an error during load
+    # ... not a good idea to use this with quiet:true unless you know exactly what you're doing
+    exit_on_error: false
+  }
+
+  attr_accessor :config_files
+  attr_accessor :config_path
+  attr_accessor :local_config_files
+  attr_accessor :required_config_files
+  attr_accessor :suggested_config_files
+  attr_accessor :env_var_name
+  attr_accessor :env
+
+  def initialize(opts = {})
+    setup(opts)
+  end
+
+  def setup(opts)
+    read_opts_into_instance_vars(opts, DEFAULT_OPTIONS.keys)
+    @env_var_name = @env_var_name.to_s if @env_var_name # ENV keys are always strings
+    @env = opts[:env] if opts.has_key? :env
+
+    @rainbow = Rainbow.new
+    @rainbow.enabled = @color unless @color.nil?
+
+    ensure_required_config_files_exist
+    check_suggested_config_files_exist
+    ensure_local_config_files_are_not_in_git
+
+    if @symbol_keys && @indifferent_keys
+      fail ArgumentError,
+        ":symbol_keys and :indifferent_keys options cannot be used together!"
+    end
+
+    require 'active_support/core_ext/hash/keys' if @symbol_keys
+    require 'active_support/core_ext/hash/indifferent_access' if @indifferent_keys
+  end
+
+  def load
+    existing_config_files =
+      config_files.select{|file| File.exists? full_path_to_config_file(file) }
+
+    print_info "Loading config from #{existing_config_files.inspect} for #{env.inspect}"+
+      " environment..."
+
+    multi_env_configs =
+      existing_config_files.map{|file| load_config_file(file) }
+
+    unless multi_env_configs.any?{|config| config.is_a?(Hash) && config.has_key?(env) }
+      fail ConfigError, "#{env.inspect} is not a valid environment! None of the loaded configs"+
+        " had a top-level #{env.inspect} key. All configurations should be nested under top"+
+        " level keys corresponding to environment names (e.g. 'test', 'development', ...)"
+    end
+
+    env_configs = multi_env_configs.map{|multi_env_config|
+        multi_env_config.fetch('DEFAULTS', {}).deep_merge multi_env_config.fetch(env, {})
+      }
+    merged_config = env_configs.reduce{|merged_config, config| merged_config.deep_merge(config) }
+
+    merged_config['env'] ||= env
+
+    merged_config.deep_symbolize_keys! if @symbol_keys
+    merged_config = merged_config.with_indifferent_access if @indifferent_keys
+
+    merged_config
+  rescue => e
+    header = "!!! Couldn't load config for #{env.inspect} environment! !!!"
+    print_error ""
+    print_error "!"*header.length
+    print_error "#{header}"
+    print_error "!"*header.length
+    print_error ""
+    print_error "#{e}"
+    print_error ""
+    print_error "!"*header.length
+    print_error ""
+    if @exit_on_error
+      print_error "Aborting because the :exit_on_error option is true!"
+      exit 666
+    end
+    raise e
+  end
+
+  def load_config_file(file)
+    full_path = full_path_to_config_file(file)
+    multi_env_config = (YAML.load_file full_path)
+
+    # YAML.load_file will return false if given an empty file to load
+    return {} if multi_env_config == false
+
+    unless multi_env_config.is_a? Hash
+      fail ConfigError, "Config file #{file.inspect} must contain a YAML-encoded Hash, but"+
+        " it seems to contain a #{multi_env_config.class}"
+    end
+
+    multi_env_config
+  end
+
+  private
+
+  def full_path_to_config_file(file)
+    File.absolute_path(relative_path_to_config_file(file))
+  end
+
+  def relative_path_to_config_file(file)
+    File.join(config_path,file)
+  end
+
+  def ensure_required_config_files_exist
+    required_config_files.each do |file|
+      full_path = full_path_to_config_file(file)
+      unless File.exists? full_path
+        fail ConfigError, "Required config file #{file.inspect} does not exist under"+
+          " #{full_path.inspect}!"
+      end
+    end
+  end
+
+  def check_suggested_config_files_exist
+    (suggested_config_files - required_config_files).each do |file|
+      full_path = full_path_to_config_file(file)
+      unless File.exists? full_path
+        print_warning "WARNING: Config file #{file.inspect} does not exist!"
+      end
+    end
+  end
+
+  def ensure_local_config_files_are_not_in_git
+    return unless git_available?
+    return unless we_are_in_a_git_repo?
+
+    local_config_files.each do |file|
+      relative_path = relative_path_to_config_file(file)
+      if file_is_in_git? relative_path
+        fail ConfigError, "Local config file #{relative_path.inspect} exists in the git repo!"
+          " Remove this file from your git repo and add it to your .gitignore"
+      end
+    end
+  end
+
+  def git_available?
+    begin
+      `git`
+      true
+    rescue Errno::ENOENT => e
+      false
+    end
+  end
+
+  def we_are_in_a_git_repo?
+    File.exists? '.git'
+  end
+
+  def file_is_in_git?(file)
+    git_cmd = "git ls-tree HEAD #{file}"
+    git_output = `#{git_cmd}`.strip
+
+    not git_output.empty?
+  end
+
+  def print_error(err)
+    $stderr.puts @rainbow.wrap(err).red.bright
+  end
+
+  def print_warning(warning)
+    $stderr.puts @rainbow.wrap(warning).yellow.bright
+  end
+
+  def print_info(info)
+    $stdout.puts @rainbow.wrap(info).cyan
+  end
+
+  def env
+    if @env
+      return @env
+    elsif ENV.has_key? env_var_name
+      ENV.fetch(env_var_name)
+    else
+      fail ConfigError, "Configuration environment couldn't be determined --"+
+        " ENV[#{env_var_name.inspect}] is not set! Try running with"+
+        " `#{env_var_name.inspect}=yourenvname ...`"
+    end
+  end
+
+  def read_opts_into_instance_vars(opts, instance_var_keys)
+    instance_var_keys.each do |key|
+      instance_variable_set(:"@#{key}", opts.fetch(key, ReallyConfy::DEFAULT_OPTIONS.fetch(key)))
+    end
+  end
+
+  class ConfigError < StandardError
+  end
+
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: really-confy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Zukowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email: mzukowski@adknowledge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/really_confy.rb
+homepage: 
+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.8
+signing_key: 
+specification_version: 4
+summary: Simple YAML configuration loader
+test_files: []
+has_rdoc: