flexible-config 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ca26fc729ad030745058cbb8a429e8dcc673beb
+  data.tar.gz: 9d55e6bbc819b243a515e2064c54669113db26e9
+SHA512:
+  metadata.gz: 4039b9ee15390d0813973f0651a4d9946949f36bada242ae60ab5ccb1b733a692cc384697258cc1f132cf0b6bf2c1fec090be1efd342c03e38540e73afa5adcb
+  data.tar.gz: 2e816cf6fd3d2bd5bcbdf0a49ff6005c24cb75dd635aaccc3e4a9e5a6b7372e7975393555c78f9053e871daad4cb63c199ce908176f3427188aa12d40b2ce542

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard 'bundler' do
+	watch 'Gemfile'
+	watch /^.+\.gemspec/
+end
+
+guard(
+  :rspec, cmd: "bundle exec rspec", failed_mode: :keep,
+  all_after_pass: true, all_on_start: true
+) do
+  watch %r{^spec/.+_spec\.rb$}
+	watch %r{^spec/fixtures/.+\.rb$}
+	watch(%r{^lib/.+\.rb$})      { 'spec' }
+	watch('spec/spec_helper.rb') { 'spec' }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011, 2012, 2013 by Grouper
+
+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,125 @@
+[![Build Status](https://travis-ci.org/Grouper/flexible-config.png?branch=master)](https://travis-ci.org/Grouper/flexible-config)
+
+
+FlexibleConfig
+==============
+
+FlexibleConfig promotes good OOP design, and the separation of logic and
+configuration in your Ruby classes.
+
+FlexibleConfig allows you to set class constants cleanly in ruby with the
+heirarchical structure and clean workflow of YML config, without sacrificing
+the flexibility and immediacy of ENVironment variables.
+
+### Here is how your class constants could look like using FlexibleConfig:
+
+```ruby
+module Bidding
+  class Calculator
+    FlexibleConfig.use 'auction.bidding' do |config|
+      BASE_RATE   = config['base_rate']
+      TIME_DECAY  = config['time_decay']
+      WIGGLE_ROOM = config['wiggle_room']
+    end
+  end
+end
+```
+
+Or the more safer, (but more verbose) syntax:
+
+```ruby
+module Bidding
+  class Calculator
+    FlexibleConfig.use 'auction.bidding' do |cfg|
+      BIDDING_ENABLED = cfg.fetch('enabled') { true }
+      BIDDER_EMAIL    = cfg.to_s('email_from')
+      BASE_RATE       = cfg.to_f('base_rate') { 1.0 }
+      TIME_DECAY      = cfg.to_f('time_decay') { 3.0 }
+      ATTEMPTS        = cfg.to_i('wiggle_room') { 2 }
+    end
+  end
+end
+```
+
+### Then config as follows:
+
+#### In YAML:
+
+`config/settings/auction.yml`
+
+```yml
+default:
+  base_rate: 1.0
+  time_decay: 3.0
+  wiggle_room: 0.2
+
+development:
+  wiggle_room: 0.6
+
+production:
+  wiggle_room: 0.2
+```
+
+#### Using ENV variables to override:
+
+```
+AUCTION_BIDDING_BASE_RATE=1.0
+AUCTION_BIDDING_TIME_DECAY=3.0
+AUCTION_BIDDING_WIGGLE_ROOM=0.2
+```
+
+#### Casting Booleans from ENV
+
+If your ENV variable is equal to the string 'true' or 'false' then
+using the default `#fetch` method on the config object will cast it to the
+Ruby `TrueClass` or `FalseClass` automatically.
+
+#### Casting of Other Types
+
+Casting to any Ruby type will work as long as the Ruby object and its string
+representation are safely interchangable:
+
+```
+example.yml
+
+default:
+  safe: '123'
+  unsafe: '123oops'
+```
+
+```ruby
+FlexibleConfig.use 'example' do |cfg|
+  BASE_RATE  = cfg.to_i('safe') # => 123
+  TIME_DECAY = cfg.to_i('unsafe') # => raises UnsafeConversion
+end
+```
+
+#### Viewing actual config variables in an environment
+
+Add this to the `Rakefile` of your project:
+
+```
+# Load flexible config tasks
+spec = Gem::Specification.find_by_name 'flexible-config'
+load "#{spec.gem_dir}/lib/tasks/flexible_config.rake"
+```
+
+Type into the command line:
+```
+bundle exec rake flexible_config:print
+```
+
+- - - - -
+
+## Contributing
+
+If you'd like to become a contributor, the easiest way it to fork this repo, make your changes, run the specs and submit a pull request once they pass.
+
+To run specs, run `bundle install && bundle exec rspec`
+
+If your changes seem reasonable and the specs pass I'll give you commit rights to this repo and add you to the list of people who can push the gem.
+
+
+## Copyright
+
+Copyright (c) 2015 Grouper. See LICENSE for details.

data/lib/flexible-config.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require 'yaml'
+
+module FlexibleConfig
+  module_function
+
+  def use(config_key = '', &block)
+    yield Builder.new config_key
+  end
+end
+
+require 'flexible_config/overview'
+require 'flexible_config/not_found'
+require 'flexible_config/builder'
+require 'flexible_config/wrapped_env'
+require 'flexible_config/wrapped_yaml'

data/lib/flexible_config/builder.rb

@@ -0,0 +1,36 @@
+module FlexibleConfig
+  UnsafeConversion = Class.new(RuntimeError)
+
+  class Builder
+    def initialize(base_key = '')
+      @base_key = base_key
+    end
+
+    def fetch(additional_key, default = nil)
+      key  = "#{base_key}.#{additional_key}"
+      item = [WrappedEnv[key], WrappedYaml[key], default].detect { |i| !i.nil? }
+
+      return item unless item.nil?
+      return yield if block_given?
+
+      raise NotFound.new key
+    end
+    alias_method :[], :fetch
+
+    def method_missing(method, *args, &block)
+      value = fetch(*args, &block)
+      return super unless value.respond_to? method
+
+      result = value.send method
+
+      raise UnsafeConversion.new(
+        "Tried to convert #{value} to int #{result} but was deemed unsafe."
+      ) unless result.to_s == value.to_s
+
+      result
+    end
+
+    private
+    attr_reader :base_key
+  end
+end

data/lib/flexible_config/not_found.rb

@@ -0,0 +1,22 @@
+module FlexibleConfig
+  class NotFound < RuntimeError
+    def initialize(key = 'unknown.key')
+      super error_message_from key
+    end
+
+    private
+
+    def error_message_from(key)
+      file_base_name, *yml_keys = key.split '.'
+
+      env_var     = key.upcase.gsub '.', '_'
+      environment = WrappedEnv.fetch('RAILS_ENV') { 'default' }
+      yml_key     = "#{environment}.#{yml_keys.join '.'}"
+      file_name   = "./config/settings/#{file_base_name}.yml"
+
+      "#{self.class} Exception. Configuration value not found. Consider " \
+        "setting the #{env_var} environment variable, or setting the " \
+        "#{yml_key} property in the following file: #{file_name}"
+    end
+  end
+end

data/lib/flexible_config/overview.rb

@@ -0,0 +1,56 @@
+module FlexibleConfig
+  class Overview
+    def call
+      available_files.reduce({}) do |memo, i|
+        memo[i] = config_lines_for_file i
+        memo
+      end
+    end
+
+    def print
+      call.each do |key, value|
+        Kernel.puts "#===== #{key.upcase} (#{key}.yml) ====="
+        value.each { |v| Kernel.puts v }
+        Kernel.puts "\n"
+      end
+    end
+
+    private
+
+    def available_files
+      WrappedYaml.config_data.keys
+    end
+
+    def config_lines_for_file(category)
+      builder = FlexibleConfig::Builder.new category
+      keys    = []
+
+      WrappedYaml.config_data[category].values.each do |env|
+        keys += flat_hash(env).keys
+      end
+
+      keys.uniq.sort.map do |keys|
+        value = begin
+          builder[keys.join '.']
+        rescue FlexibleConfig::NotFound => e
+          "### NO VALUE ###"
+        end
+
+        combined_keys = [category] + keys
+        dotted_key    = keys.join '.'
+        env_key       = combined_keys.map(&:upcase).join '_'
+        from_env      = !WrappedEnv[env_key].nil? ? 'ENV OVERRIDE' : ''
+
+        sprintf("%-40s|%-12s|  %-45s = %s",
+          dotted_key, from_env, env_key, value
+        )
+      end
+    end
+
+    def flat_hash(h, f = [], g = {})
+      return g.update(f => h) unless h.is_a? Hash
+      h.each { |k, r| flat_hash r, f+[k], g }
+      g
+    end
+  end
+end

data/lib/flexible_config/version.rb

@@ -0,0 +1,3 @@
+module FlexibleConfig
+  VERSION = '1.1.0'
+end

data/lib/flexible_config/wrapped_env.rb

@@ -0,0 +1,55 @@
+module FlexibleConfig
+  module WrappedEnv
+    class << self
+      def [](generic_key)
+        key = normalize_key generic_key
+        normalize(overrides.key?(key) ? overrides[key] : ENV[key])
+      end
+
+      def fetch(generic_key, &block)
+        key = normalize_key generic_key
+        return overrides[key] if overrides.key?(key)
+
+        normalize ENV.fetch(key, &block)
+      rescue KeyError => e
+        raise NotFound.new key
+      end
+
+      def int(generic_key, &block)
+        key = normalize_key generic_key
+        val = fetch(key)
+        return block.call if val.nil? && block_given?
+
+        raise NotFound.new if val.nil?
+        val.to_i
+      end
+
+      def normalize(val)
+        case val.to_s.downcase
+        when 'true'  then true
+        when 'false' then false
+        when ''      then nil
+        else val
+        end
+      end
+
+      def override(key, value)
+        overrides[key] = value
+      end
+
+      def reset
+        @overrides = {}
+      end
+
+      private
+
+      def overrides
+        @overrides ||= {}
+      end
+
+      def normalize_key(key)
+        key.upcase.gsub('.', '_')
+      end
+    end
+  end
+end

data/lib/flexible_config/wrapped_yaml.rb

@@ -0,0 +1,39 @@
+module FlexibleConfig
+  class WrappedYaml
+    CONFIG_PATH = "config/settings/**/*.yml"
+
+    class << self
+      def [](key)
+        environment_specific = get_config(key, env: app_environment)
+        environment_specific.nil? ? get_config(key) : environment_specific
+      end
+
+      def config_data
+        @config_data ||= Dir[CONFIG_PATH].reduce({}) do |memo, file|
+          category = File.basename(file, '.yml')
+          memo[category] = YAML.load File.open file
+          memo
+        end
+      end
+
+      private
+
+      def get_config(key, env: 'default')
+        keys_with_injected_env = key.sub('.', ".#{env}.").split '.'
+
+        keys_with_injected_env.reduce(config_data) do |memo, i|
+          memo[i] unless memo.nil?
+        end
+      end
+
+      def app_environment
+        (
+          ENV['CONFIG_ENV'] ||
+          ENV['RAILS_ENV']  ||
+          ENV['RACK_ENV']   ||
+          'development'
+        )
+      end
+    end
+  end
+end

data/lib/tasks/flexible_config.rake

@@ -0,0 +1,6 @@
+namespace :flexible_config do
+  task :print do
+    require 'flexible-config'
+    FlexibleConfig::Overview.new.print
+  end
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: flexible-config
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Brett Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: guard
+  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: guard-rspec
+  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: guard-bundler
+  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: growl
+  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: pry
+  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'
+description: Use environment-specific YAML for configuration while allowing for ENV
+  variables to override
+email:
+- brett.richardson.nz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- lib/flexible-config.rb
+- lib/flexible_config/builder.rb
+- lib/flexible_config/not_found.rb
+- lib/flexible_config/overview.rb
+- lib/flexible_config/version.rb
+- lib/flexible_config/wrapped_env.rb
+- lib/flexible_config/wrapped_yaml.rb
+- lib/tasks/flexible_config.rake
+homepage: https://github.com/brett-richardson/flexible-config
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Flexible Configuration for Ruby constants
+test_files: []
+has_rdoc: