lite_config 0.0.3 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5db4fcd568a95da45fd32bff70f82feafb5107c0
+  data.tar.gz: 72ee684d093272263d47850ff977cd126356cb3d
+SHA512:
+  metadata.gz: 97bd67457c73f00f51a481999530dfd237cef18f94bcdda01dfc190a4455346458316907319f06ac6657c86bef1caf67a0e8c7d02ba42798f1356a409fb2a7e4
+  data.tar.gz: 98c8e90c77d1366e037426d84ac79bb2c431139a04e2f8715b6b77c268d7d69fb5b45e7aa55e359fc03c3478f40ccbf5d88d86c5c60664f51f7e398663c62424

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
+before_install: gem update bundler
 cache: bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.0
+  - 2.2.0
+  - 2.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### Version 0.0.4
+
+* Allow ERB-processed config files (Federico Keen, Andy Dust)
+* Remove ActiveSupport dependency (Sergio Tulentsev)
+
 ### Version 0.0.3
 
 * Fix error on missing config (thanks RKushnir)

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/gtd/lite_config.png?branch=master)](https://travis-ci.org/gtd/lite_config)
 [![Code Climate](https://codeclimate.com/github/gtd/lite_config.png)](https://codeclimate.com/github/gtd/lite_config)
+[![Gem Version](https://badge.fury.io/rb/lite_config.png)](http://badge.fury.io/rb/lite_config)
 
 LiteConfig automates the loading of Rails-style YAML config files.  With a single line the config file is lazily loaded
 and cached, automatically choosing the current environment's hash.  It also supports local developer override via
@@ -50,6 +51,19 @@ you can do:
 
 Of course any valid YAML will work, but it works particularly nicely with simple hashes and arrays.
 
+#### ERB Config Files
+
+You might want part of your config file to be dynamic, the most obvious use of
+which would be to inject secrets from an environment variables.  You do so by
+adding an `.erb` extension to the file.  For instance if you have the file
+`config/options.yml.erb` you could pull in a secret key from the environment
+like this:
+
+    development:
+      secret_key: abc123
+    production:
+      secret_key: <%= ENV['SECRET_KEY'] %>
+
 #### Flat Config Files
 
 Do you ever cringe when your config file uses advanced YAML features do duplicate the exact same hash for every
@@ -104,7 +118,6 @@ changed after the first config file is loaded as that could lead to the wrong da
 ## Future Ideas
 
 * Convert LiteConfig to an insantiable class instead of a singleton
-* Remove ActiveSupport dependency
 * Ability to raise errors for undefined config keys
 * Support TOML or other config formats
 * Allow OpenStruct-like access to the config.  I'm not 100% sure on the ROI of this feature.

data/lib/lite_config.rb

@@ -1,9 +1,10 @@
 require "lite_config/version"
 
-require 'active_support/core_ext/hash/deep_merge'
-require 'active_support/core_ext/hash/indifferent_access'
+require 'lite_config/hash'
+require 'lite_config/hash_with_indifferent_access'
 
 require 'yaml'
+require 'erb'
 
 module LiteConfig
   class ImmutableError < StandardError; end
@@ -14,7 +15,7 @@ module LiteConfig
   def fetch(name)
     name = name.to_sym
     @configs ||= {}
-    @configs.key?(name) ? @configs[name] : (@configs[name] = HashWithIndifferentAccess.new(load(name)))
+    @configs.key?(name) ? @configs[name] : (@configs[name] = IndifferentHash.new(load(name)))
   end
 
   def config_path=(path)
@@ -52,7 +53,11 @@ module LiteConfig
   end
 
   def load_single(filename)
-    hash = YAML.load_file(filename)
+    hash = if File.extname(filename) == '.erb'
+      YAML.load ERB.new(IO.read(filename)).result
+    else
+      YAML.load_file filename
+    end
 
     has_environmenty_key?(hash) ? hash[app_env] : hash
   end
@@ -62,7 +67,9 @@ module LiteConfig
   end
 
   def config_filename(name)
-    File.join(config_path, name.to_s + '.yml')
+    filename = File.join(config_path, name.to_s + '.yml')
+    filename << '.erb' if File.exist?(filename + '.erb')
+    filename
   end
 
   def local_config_filename(name)

data/lib/lite_config/hash.rb

@@ -0,0 +1,19 @@
+class Hash
+  # Copied from active_support
+  # http://apidock.com/rails/Hash/deep_merge%21
+  def deep_merge!(other_hash, &block)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      if tv.is_a?(Hash) && v.is_a?(Hash)
+        self[k] = tv.deep_merge(v, &block)
+      else
+        self[k] = block && tv ? block.call(k, tv, v) : v
+      end
+    end
+    self
+  end
+
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash, &block)
+  end
+end

data/lib/lite_config/hash_with_indifferent_access.rb

@@ -0,0 +1,144 @@
+# Copied from https://raw.github.com/mikel/mail/master/lib/mail/indifferent_hash.rb
+# which itself is a copy from active_support
+
+module LiteConfig
+  class IndifferentHash < Hash
+
+    def initialize(constructor = {})
+      if constructor.is_a?(Hash)
+        super()
+        update(constructor)
+      else
+        super(constructor)
+      end
+    end
+
+    def default(key = nil)
+      if key.is_a?(Symbol) && include?(key = key.to_s)
+        self[key]
+      else
+        super
+      end
+    end
+
+    def self.new_from_hash_copying_default(hash)
+      IndifferentHash.new(hash).tap do |new_hash|
+        new_hash.default = hash.default
+      end
+    end
+
+    alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
+    alias_method :regular_update, :update unless method_defined?(:regular_update)
+
+    # Assigns a new value to the hash:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:key] = "value"
+    #
+    def []=(key, value)
+      regular_writer(convert_key(key), convert_value(value))
+    end
+
+    alias_method :store, :[]=
+
+    # Updates the instantized hash with values from the second:
+    #
+    #   hash_1 = HashWithIndifferentAccess.new
+    #   hash_1[:key] = "value"
+    #
+    #   hash_2 = HashWithIndifferentAccess.new
+    #   hash_2[:key] = "New Value!"
+    #
+    #   hash_1.update(hash_2) # => {"key"=>"New Value!"}
+    #
+    def update(other_hash)
+      other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
+      self
+    end
+
+    alias_method :merge!, :update
+
+    # Checks the hash for a key matching the argument passed in:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash["key"] = "value"
+    #   hash.key? :key  # => true
+    #   hash.key? "key" # => true
+    #
+    def key?(key)
+      super(convert_key(key))
+    end
+
+    alias_method :include?, :key?
+    alias_method :has_key?, :key?
+    alias_method :member?, :key?
+
+    # Fetches the value for the specified key, same as doing hash[key]
+    def fetch(key, *extras)
+      super(convert_key(key), *extras)
+    end
+
+    # Returns an array of the values at the specified indices:
+    #
+    #   hash = HashWithIndifferentAccess.new
+    #   hash[:a] = "x"
+    #   hash[:b] = "y"
+    #   hash.values_at("a", "b") # => ["x", "y"]
+    #
+    def values_at(*indices)
+      indices.collect {|key| self[convert_key(key)]}
+    end
+
+    # Returns an exact copy of the hash.
+    def dup
+      IndifferentHash.new(self)
+    end
+
+    # Merges the instantized and the specified hashes together, giving precedence to the values from the second hash
+    # Does not overwrite the existing hash.
+    def merge(hash)
+      self.dup.update(hash)
+    end
+
+    # Performs the opposite of merge, with the keys and values from the first hash taking precedence over the second.
+    # This overloaded definition prevents returning a regular hash, if reverse_merge is called on a HashWithDifferentAccess.
+    def reverse_merge(other_hash)
+      super self.class.new_from_hash_copying_default(other_hash)
+    end
+
+    def reverse_merge!(other_hash)
+      replace(reverse_merge( other_hash ))
+    end
+
+    # Removes a specified key from the hash.
+    def delete(key)
+      super(convert_key(key))
+    end
+
+    def stringify_keys!; self end
+    def stringify_keys; dup end
+    def symbolize_keys; to_hash.symbolize_keys end
+    def to_options!; self end
+
+    def to_hash
+      Hash.new(default).merge!(self)
+    end
+
+    protected
+
+    def convert_key(key)
+      key.kind_of?(Symbol) ? key.to_s : key
+    end
+
+    def convert_value(value)
+      if value.class == Hash
+        self.class.new_from_hash_copying_default(value)
+      elsif value.is_a?(Array)
+        value.dup.replace(value.map { |e| convert_value(e) })
+      else
+        value
+      end
+    end
+
+  end
+end

data/lib/lite_config/version.rb

@@ -1,3 +1,3 @@
 module LiteConfig
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lite_config.gemspec

@@ -18,10 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activesupport'
-
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", ">= 5.0.0"
-  spec.add_development_dependency "debugger"
 end

data/spec/fixtures/basic_erb.yml.erb

@@ -0,0 +1,2 @@
+development:
+  option: <%= 1 + 1 %>

data/spec/lite_config_spec.rb

@@ -35,6 +35,16 @@ describe LiteConfig do
     end
   end
 
+  describe "basic_erb config" do
+    before do
+      @config = LiteConfig(:basic_erb)
+    end
+
+    it "should find evaluated keys" do
+      @config[:option].must_equal 2
+    end
+  end
+
   describe "nested config" do
     before do
       @config = LiteConfig(:nested)

data/spec/spec_helper.rb

@@ -1,6 +1,5 @@
 require 'bundler/setup'
 require 'minitest/autorun'
-require 'debugger'
 
 require 'lite_config'
 

metadata

@@ -1,96 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: lite_config
 version: !ruby/object:Gem::Version
-  version: 0.0.3
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Gabe da Silveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-26 00:00:00.000000000 Z
+date: 2016-08-07 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Lightweight configuration for your ruby app.  Reads Rails-style YAML
   files from your config directory.  Features include optional environment namespacing,
   local convention-based override files, and indifferent (symbol vs string) access.
@@ -100,17 +61,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/lite_config.rb
+- lib/lite_config/hash.rb
+- lib/lite_config/hash_with_indifferent_access.rb
 - lib/lite_config/version.rb
 - lite_config.gemspec
 - spec/fixtures/basic.yml
+- spec/fixtures/basic_erb.yml.erb
 - spec/fixtures/empty_environment_override.yml
 - spec/fixtures/empty_environment_override_local.yml
 - spec/fixtures/empty_override.yml
@@ -126,30 +90,30 @@ files:
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Lightweight configuration for your ruby app
 test_files:
 - spec/fixtures/basic.yml
+- spec/fixtures/basic_erb.yml.erb
 - spec/fixtures/empty_environment_override.yml
 - spec/fixtures/empty_environment_override_local.yml
 - spec/fixtures/empty_override.yml
@@ -162,4 +126,3 @@ test_files:
 - spec/fixtures/override_local.yml
 - spec/lite_config_spec.rb
 - spec/spec_helper.rb
-has_rdoc: