conf_conf 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63aae1d8878cbe6e4d5f09c34dcc18ecb499e2f9
+  data.tar.gz: f6d2bda882b8536b8cae8cd28e2675e3341b63fc
+SHA512:
+  metadata.gz: 9639ee0edcc66ff8811851e52f68885b473eeb6f67042b0859a6e6af27b6f4e036b54be94e1e4061684113f27f82952f7e5105d0e714a225cba1fc90dd43c7e5
+  data.tar.gz: 6a89fdba345053101e40e54585fbfaf000479132656438c24df9bf0f676d940357989cef74b0932796f95c52c99d314cd71a231242374b76f795b3b0dc49ba0e

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+# ConfConf
+
+Twelve factor applications pull configuration values from the 
+environment. These variables should be verified at application
+boot to prevent exceptions and unexpected behavior during
+run time.
+
+ConfConf is a simple pattern and utility for verifying the
+correctness of the environment variables at application boot so
+we can fail fast when there's a configuration problem.
+
+## Installation
+
+Add `gem 'conf_conf'` to your application's Gemfile.
+
+## Rails 
+
+Add a new initializer - if you use conf_conf.rb, as a matter
+of convention you shouldn't add ConfConf configuration blocks
+to other initializers.
+
+```ruby
+# config/initializers/conf_conf.rb
+ConfConf.rails_configuration do
+  # Sets Rails.configuration.secret_key, app fails to boot if not present
+  config :secret_key
+
+  # Sets Rails.configuration.public_key from ENV["public_key"], or uses the default if not available in ENV
+  config :public_key, default: "XYZ123"
+
+  # Sets Rails.configuration.admin to a boolean value of true or false, app fails to boot if not present
+  config :admin, { |admin| admin ? true : false } 
+end
+```
+
+In the case above, if SECRET_KEY is not present, then
+`ConfConf::MissingConfigurationValueError` is raised:
+
+```
+  $ bin/rails s
+  ...
+  Exiting
+  conf_conf/lib/conf_conf.rb:50:in `default_value': Please set SECRET_KEY or supply a default value
+(ConfConf::MissingConfigurationValueError)
+    from conf_conf/lib/conf_conf.rb:42
+    ...
+```

data/conf_conf.gemspec

@@ -0,0 +1,17 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name             = "conf_conf"
+  s.version          = "1.0.0"
+  s.licenses         = ["MIT"]
+  s.authors          = ["James Kassemi"] 
+  s.email            = ["jkassemi@gmail.com"]
+  s.homepage         = "https://github.com/jkassemi/conf_conf"
+  s.description      = "Verify correctness of environment variables"
+  s.summary          = "A simple pattern and utility for verifying the correctness of the environment variables at application boot so we can fail fast when there's a configuration problem."
+  s.files            = `git ls-files`.split($/)
+
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/conf_conf.rb

@@ -0,0 +1,62 @@
+Dir["tasks/**/*.rake"].each { |ext| load ext } if defined?(Rake)
+
+module ConfConf
+  class MissingConfigurationValueError < StandardError; end;
+
+  class << self
+    def rails_configuration(&block)
+      configuration = Configuration.new
+
+      configuration.run(block)
+
+      configuration.parsed_values.each do |key, value|
+        Rails.configuration.send("#{key}=", value)
+      end
+    end
+  end
+
+  class Configuration
+    attr_reader :parsed_values
+
+    def initialize
+      @parsed_values = {}
+    end
+
+    def run(block)
+      instance_eval(&block)
+    end
+
+    def config(key, options={})
+      value = Reference.new(key, options).value
+
+      if block_given?
+        value = yield(value)
+      end
+
+      @parsed_values[key] = value
+    end
+  end
+
+  class Reference < Struct.new(:key, :options)
+    def value
+      environment_value || default_value
+    end 
+
+    private
+    def default_value
+      if options.has_key? :default
+        options[:default]
+      else
+        raise MissingConfigurationValueError.new("Please set #{environment_key} or supply a default value")
+      end
+    end
+
+    def environment_value
+      ENV[environment_key]
+    end
+
+    def environment_key
+      key.to_s.upcase
+    end
+  end
+end

data/spec/conf_conf_spec.rb

@@ -0,0 +1,45 @@
+require 'conf_conf'
+
+module Rails; end;
+
+describe ConfConf do
+  let(:configuration){ double() }
+  before { allow(Rails).to receive(:configuration).and_return(configuration) }
+
+  it "sets a value from the environment" do
+    ENV["TEST_KEY"] = "hey"
+    expect(configuration).to receive(:test_key=).with("hey")
+
+    ConfConf.rails_configuration do
+      config :test_key
+    end
+  end
+
+  it "sets the default value when key not present" do
+    expect(configuration).to receive(:key_not_present=).with("hey")
+
+    ConfConf.rails_configuration do
+      config :key_not_present, default: "hey"
+    end
+  end
+
+  it "throws an exception when required key not present" do
+    expect {
+      ConfConf.rails_configuration do
+        config :key_not_present
+      end
+    }.to raise_error(ConfConf::MissingConfigurationValueError)
+  end
+
+  it "evaluates a block to establish the actual configuration value" do
+    ENV["INTEGER_VALUE"] = "2"
+
+    expect(configuration).to receive(:integer_value=).with(2)
+
+    ConfConf.rails_configuration do
+      config :integer_value do |value|
+        value.to_i
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,78 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: conf_conf
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Kassemi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Verify correctness of environment variables
+email:
+- jkassemi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- conf_conf.gemspec
+- lib/conf_conf.rb
+- spec/conf_conf_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jkassemi/conf_conf
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple pattern and utility for verifying the correctness of the environment
+  variables at application boot so we can fail fast when there's a configuration problem.
+test_files: []