configurethis 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73d8b25e91d50bd79c5daf51fefece507c39ace8
+  data.tar.gz: fe0402a579f5a74cfe79c7e741d64ea5f9628ea5
+SHA512:
+  metadata.gz: dbac3f113ac7620eb98d1a1068ab23f3420497cfee0e737ca0ed98a0729eaaa9e0631a5ae5054cff412d663128d1bcce5f82f2ad0d86cb4d7d11eae853f4340e
+  data.tar.gz: 85eb1c79f1a913fd3e7f165249b9909314f73cb67c6196a812146d6f4b382c1e46605dfe5f6febcaa59b3d325825d48d3b07f54225aaecaed5ed5c8492ac883a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "1.9.3"
+script:
+  - rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matt Snyder
+
+MIT License
+
+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,116 @@
+[![Build Status](https://travis-ci.org/mattsnyder/configurethis.png?branch=master)](https://travis-ci.org/mattsnyder/configurethis)
+# Configurethis
+Clean up your configuration approach by using Configurethis. Configurethis allows you to access your config values using
+method names instead of string literals to identify which config value you want to retrieve. 
+
+Typical Ruby code has craziness like this all over the place:
+```ruby
+# config/initializers/load_config.rb
+APP_CONFIG = YAML.load_file("#{Rails.root}/config/config.yml")[Rails.env]
+
+# application.rb
+if APP_CONFIG['perform_authentication']
+  # Do stuff
+end
+```
+But that's just ugly. It relies on string literals, constants, and gets worse if you have multiple config values, or even nested config values for that matter.
+`Configurethis` makes your life better and your code healthier by avoiding literals, constants and makes it easy to setup multiple config files.
+All you need to do is define a Class to act as your configuration container object, create a matching YAML file, and then access your values
+as needed using method calls to your new Class!
+```ruby
+# A cleaner way!
+# config/initializers/configurethis.rb
+Configurethis.root_path = File.join(Rails.root, "config")
+
+# lib/password_settings.rb
+class PasswordSettings
+  extend Configurethis
+end
+
+# some_ruby_file_in_my_app.rb
+PasswordSettings.min_length        #=> 10
+PasswordSettings.require_uppercase #=> true
+PasswordSettings.storage.keep_last #=> 3
+```
+```yml
+---
+# config/password_settings.yml
+minLength: 10
+require_uppercase: true
+storage:
+  keep_last: 3
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'configurethis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install configurethis
+
+## Usage
+
+### Setup
+To get started, specify where you want `Configurethis` to look for your .yml files at.
+```ruby
+Configurethis.root_path = '/etc/my_app'
+```
+
+If you are using `Configurethis` in a Rails app, create an initializer for `Configurethis` and add the following:
+```ruby
+# config/initializers/configurethis.rb
+Configurethis.root_path = File.join(Rails.root, "config")
+```
+
+If your configuration is dependent on environment variables, you can specify it (Unfortunately at this time you need to do this once per each class that is environmentally dependent):
+```ruby
+MyConfigurationClass.set_root = RAILS_ENV
+```
+
+### Creating a configuration
+To turn your class into a configuration class, simply extend `Configurethis`
+```ruby
+class MyRiakConfiguration
+  extend Configurethis
+end
+```
+And create a `.yml` file that matches your class name. In this case our `.yml` file would be named `my_riak_configuration.yml`:
+And it might contain something like this:
+```yml
+---
+pb_port: 9002
+http_port: 9000
+host: 127.0.0.1
+riak_control:
+  cert: /opt/local/var/riak-1.2.0/riak.crt
+```
+Now you can access those values as methods off your configuration class.
+```ruby
+MyRiakConfiguration.pb_port            #=> 9002
+MyRiakConfiguration.http_port          #=> 9000
+MyRiakConfiguration.riak_control.cert  #=> "/opt/local/var/riak-1.2.0/riak.crt"
+```
+
+### Overriding
+If you do not want your `.yml` file to follow convention, you can choose your own name.
+```ruby
+class IWantToBeDifferent
+  extend Configurethis
+  configure_this_with 'my_configuration_file.yml'
+end
+```
+
+## Contributing
+
+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 "bundler/gem_tasks"

data/configurethis.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'configurethis/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "configurethis"
+  gem.version       = Configurethis::VERSION
+  gem.authors       = ["Matt Snyder"]
+  gem.email         = ["snyder2112@me.com"]
+  gem.description   = %q{Clean up your configuration approach by using Configurethis. Configurethis allows you to access your config values using method names instead of string literals to identify which config value you want to retrieve.}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/mattsnyder/configurethis"
+
+  gem.add_development_dependency "rspec-given", ">= 3.0.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/configurethis.rb

@@ -0,0 +1,60 @@
+require "configurethis/version"
+require "configurethis/value_container"
+require "configurethis/configuration"
+require "configurethis/configurethis_properties"
+
+module Configurethis
+  class << self
+    def root_path=(path)
+      ConfigurethisProperties.root_path = path
+    end
+
+    def use_defaults
+      ConfigurethisProperties.use_defaults
+    end
+  end
+
+  def configuration_path
+    configuration.path
+  end
+
+  def set_root=(key)
+    configuration.root = key.to_s
+  end
+
+  def configure_this_with(path)
+    @configuration_file = path
+  end
+
+  def method_missing(method, *args)
+    configuration[method.to_s]
+  end
+
+  def reload_configuration
+    @configuration = nil
+    return self
+  end
+
+  def configuration
+    @configuration ||= Configuration.new(configuration_file)
+  end
+  protected :configuration
+
+  def configuration_file
+    @configuration_file ||= underscore(self.to_s) + '.yml'
+  end
+  private :configuration_file
+
+  # Borrowed from activesupport/lib/active_support/inflector/methods.rb
+  # No need to bring in ActiveSupport for just this.
+  def underscore(camel_cased_word)
+    word = camel_cased_word.to_s.dup
+    word.gsub!('::', '/')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+  private :underscore
+end

data/lib/configurethis/configuration.rb

@@ -0,0 +1,34 @@
+require 'yaml'
+
+module Configurethis
+  class Configuration
+    attr_reader :path
+
+    def initialize(configuration_file)
+      @path = File.join(ConfigurethisProperties.root_path, configuration_file)
+    end
+
+    def root=(key)
+      @values = load_configuration.fetch(key)
+    rescue ::KeyError
+      raise "'#{key}' is not configured in #{path}"
+    end
+
+    def [](key)
+      @values ||= load_configuration
+      val = @values.fetch(key)
+      return ValueContainer.new(val, path) if val.is_a?(Hash)
+      val
+    rescue ::KeyError
+      raise "'#{key}' is not configured in #{path}"
+    end
+
+    def load_configuration
+      File.open(path){ |f| ::YAML::load(f) }
+    rescue Exception => caught
+      raise "Could not locate configuration file: #{path}"
+    end
+
+
+  end
+end

data/lib/configurethis/configurethis_properties.rb

@@ -0,0 +1,17 @@
+module Configurethis
+  class ConfigurethisProperties
+    class << self
+      def root_path=(path)
+        @@root_path = path
+      end
+
+      def root_path
+        @@root_path ||= ''
+      end
+
+      def use_defaults
+        @@root_path = nil
+      end
+    end
+  end
+end

data/lib/configurethis/value_container.rb

@@ -0,0 +1,16 @@
+module Configurethis
+  class ValueContainer
+    def initialize(original, config_path)
+      @original_value = original
+      @config_path = config_path
+    end
+
+    def method_missing(method, *args)
+      val = @original_value.fetch(method.to_s)
+      return ValueContainer.new(val, @config_path) if val.is_a?(Hash)
+      val
+    rescue KeyError => caught
+      raise "Nested value '#{method.to_s}' is not configured in #{@config_path}"
+    end
+  end
+end

data/lib/configurethis/version.rb

@@ -0,0 +1,3 @@
+module Configurethis
+  VERSION = "1.0.1"
+end

data/spec/configurethis/configurethis_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+describe Configurethis do
+  describe "making a class configurable from a yml file" do
+    context "when the base path is unmodified" do
+      Given { Configurethis.use_defaults }
+      Given (:klass) { ConventionalPath.reload_configuration }
+      Then  { expect(klass.configuration_path).to eql('/conventional_path.yml') }
+    end
+
+    context "when the base configuration path has been modified" do
+      Given { Configurethis.root_path = '/my/custom/path' }
+
+      context "and the class specifies it's own configuration filename" do
+        Given (:klass) { OverridePath }
+        Then  { expect(klass.configuration_path).to eql('/my/custom/path/configure/custom.yml') }
+      end
+
+      describe "and the class relies on convention over configuration for filename" do
+        context "and there is no namespace" do
+          Given (:klass) { ConventionalPath.reload_configuration }
+          Then  { expect(klass.configuration_path).to eql('/my/custom/path/conventional_path.yml') }
+        end
+
+        context "and the class is namespaced" do
+          Given (:klass) { MyModule::ConventionalPath }
+          Then  { expect(klass.configuration_path).to eql('/my/custom/path/my_module/conventional_path.yml') }
+        end
+      end
+    end
+  end
+
+  describe "specifying a root config value for all access" do
+    Given { Configurethis.root_path = File.join(File.dirname(__FILE__), 'support/config') }
+
+    context "when the root value exists" do
+      Given (:rails_config) { RailsAppConfig }
+      Given { rails_config.set_root = :development }
+      Then  { expect(rails_config.assets.compile).to be_false }
+
+      describe "and then we change the root value and access more values" do
+        Given { rails_config.set_root = :production }
+        Then  { expect(rails_config.assets.compile).to be_true }
+      end
+    end
+
+    context "when the root value does not exist" do
+      Given (:rails_config) { RailsAppConfig }
+      Then  { expect{ rails_config.set_root = :qa }.to raise_error(RuntimeError, "'qa' is not configured in #{rails_config.configuration_path}") }
+    end
+  end
+
+  describe "using configured values" do
+    Given { Configurethis.root_path = File.join(File.dirname(__FILE__), 'support/config') }
+
+    context "when the classes config file does not exist" do
+      Given (:config) { MissingConfiguration }
+      Then  { expect{ config.some_value }.to raise_error(RuntimeError, "Could not locate configuration file: #{config.configuration_path}") }
+    end
+
+    context "when the value has not been set" do
+      Given (:config) { RiakConfig }
+      Then { expect{ config.storage_backend }.to raise_error(RuntimeError, "'storage_backend' is not configured in #{config.configuration_path}") }
+    end
+
+    context "when values are set" do
+      Given (:config) { RiakConfig }
+      Then  { expect(config.pb_port).to   eq(9002) }
+      Then  { expect(config.http_port).to eq(9000) }
+      Then  { expect(config.host).to      eql('127.0.0.1') }
+
+      context "and nested" do
+        Then { expect(config.riak_control.cert).to eql('/opt/local/var/riak-1.2.0/riak.crt') }
+        Then { expect(config.production.riak_control.cert).to eql('/opt/local/var/riak-1.1.0/riak.crt') }
+      end
+
+      context "and deeply nested" do
+        Given (:nested_config) { NestedConfig }
+        Then { expect(nested_config.level1.level2.level3.level4).to eql("Hello World") }
+
+        context "and the value is not set" do
+          Then { expect{ nested_config.level1.level2.level7 }.to raise_error(RuntimeError, "Nested value 'level7' is not configured in #{nested_config.configuration_path}") }
+        end
+      end
+    end
+  end
+end

data/spec/configurethis/support/classes.rb

@@ -0,0 +1,11 @@
+%w[
+  conventional_path
+  missing_configuration
+  namespaced_conventional_path
+  nested_config
+  override_path
+  rails_app_config
+  riak_config
+ ].each do |file|
+  require File.join("configurethis", "support", "classes", file)
+end

data/spec/configurethis/support/classes/conventional_path.rb

@@ -0,0 +1,3 @@
+class ConventionalPath
+  extend Configurethis
+end

data/spec/configurethis/support/classes/missing_configuration.rb

@@ -0,0 +1,3 @@
+class MissingConfiguration
+  extend Configurethis
+end

data/spec/configurethis/support/classes/my_custom_conf.rb

@@ -0,0 +1,4 @@
+ class MyCustomConf
+   include Configurethis
+   configure_this_with 'config/custom.yml'
+ end

data/spec/configurethis/support/classes/namespaced_conventional_path.rb

@@ -0,0 +1,5 @@
+module MyModule
+  class ConventionalPath
+    extend Configurethis
+  end
+end

data/spec/configurethis/support/classes/nested_config.rb

@@ -0,0 +1,3 @@
+class NestedConfig
+  extend Configurethis
+end

data/spec/configurethis/support/classes/override_path.rb

@@ -0,0 +1,4 @@
+ class OverridePath
+   extend Configurethis
+   configure_this_with 'configure/custom.yml'
+ end

data/spec/configurethis/support/classes/rails_app_config.rb

@@ -0,0 +1,3 @@
+class RailsAppConfig
+  extend Configurethis
+end

data/spec/configurethis/support/classes/riak_config.rb

@@ -0,0 +1,3 @@
+class RiakConfig
+  extend Configurethis
+end

data/spec/configurethis/support/config/nested_config.yml

@@ -0,0 +1,4 @@
+level1:
+  level2:
+    level3:
+      level4: "Hello World"

data/spec/configurethis/support/config/rails_app_config.yml

@@ -0,0 +1,8 @@
+---
+development:
+  assets:
+    compile: false
+
+production:
+  assets:
+    compile: true

data/spec/configurethis/support/config/riak_config.yml

@@ -0,0 +1,10 @@
+---
+pb_port: 9002
+http_port: 9000
+host: 127.0.0.1
+riak_control:
+  cert: /opt/local/var/riak-1.2.0/riak.crt
+
+production:
+  riak_control:
+    cert: /opt/local/var/riak-1.1.0/riak.crt

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'configurethis'
+require './spec/configurethis/support/classes'
+
+
+require 'rspec/given'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: configurethis
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Matt Snyder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Clean up your configuration approach by using Configurethis. Configurethis
+  allows you to access your config values using method names instead of string literals
+  to identify which config value you want to retrieve.
+email:
+- snyder2112@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- configurethis.gemspec
+- lib/configurethis.rb
+- lib/configurethis/configuration.rb
+- lib/configurethis/configurethis_properties.rb
+- lib/configurethis/value_container.rb
+- lib/configurethis/version.rb
+- spec/configurethis/configurethis_spec.rb
+- spec/configurethis/support/classes.rb
+- spec/configurethis/support/classes/conventional_path.rb
+- spec/configurethis/support/classes/missing_configuration.rb
+- spec/configurethis/support/classes/my_custom_conf.rb
+- spec/configurethis/support/classes/namespaced_conventional_path.rb
+- spec/configurethis/support/classes/nested_config.rb
+- spec/configurethis/support/classes/override_path.rb
+- spec/configurethis/support/classes/rails_app_config.rb
+- spec/configurethis/support/classes/riak_config.rb
+- spec/configurethis/support/config/nested_config.yml
+- spec/configurethis/support/config/rails_app_config.yml
+- spec/configurethis/support/config/riak_config.yml
+- spec/spec_helper.rb
+homepage: https://github.com/mattsnyder/configurethis
+licenses: []
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Clean up your configuration approach by using Configurethis. Configurethis
+  allows you to access your config values using method names instead of string literals
+  to identify which config value you want to retrieve.
+test_files:
+- spec/configurethis/configurethis_spec.rb
+- spec/configurethis/support/classes.rb
+- spec/configurethis/support/classes/conventional_path.rb
+- spec/configurethis/support/classes/missing_configuration.rb
+- spec/configurethis/support/classes/my_custom_conf.rb
+- spec/configurethis/support/classes/namespaced_conventional_path.rb
+- spec/configurethis/support/classes/nested_config.rb
+- spec/configurethis/support/classes/override_path.rb
+- spec/configurethis/support/classes/rails_app_config.rb
+- spec/configurethis/support/classes/riak_config.rb
+- spec/configurethis/support/config/nested_config.yml
+- spec/configurethis/support/config/rails_app_config.yml
+- spec/configurethis/support/config/riak_config.yml
+- spec/spec_helper.rb