app_configuration 0.0.1

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,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in app_configuration.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', require: false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guido Marucci Blas
+
+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,144 @@
+# AppConfiguration
+
+[![Build Status](https://travis-ci.org/guidomb/app_configuration.png)](https://travis-ci.org/guidomb/app_configuration)
+[![Coverage Status](https://coveralls.io/repos/guidomb/app_configuration/badge.png?branch=master)](https://coveralls.io/r/guidomb/app_configuration)
+<a href="/github/guidomb/app_configuration/badges"><img alt="App_configuration" src="https://codeclimate.com/github/guidomb/app_configuration.png" style="position: relative; top: 4px"></a>
+
+**AppConfiguration** is a very simple gem that helps you configure your Ruby applications. It was extracted from a Rails project
+but it also can be used in non Rails projects. **AppConfiguration** uses YAML config files or environmental variales to set
+the configuration parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'app_configuration'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install app_configuration
+
+## Usage
+
+**AppConfiguration** comes with great default values. So if you want to setup a new config all you need to do is 
+
+```ruby
+config = AppConfiguration.new
+my_configurable_variable = config.foo
+my_other_variable = config['bar']
+```
+
+By default, when getting the variable `foo` **AppConfiguration** will look for the environmental variable `FOO`.
+If it cannot find it, **AppConfiguration** will look for the `.config.yml` file in the current working directory. 
+If there is no config file there, it will try to find the `.config.yml` in your home directory.
+
+A possible `.config.yml` for this example could look like this
+
+```yaml
+foo: 'This is the foo variable'
+bar: 'This is the bar variable'
+```
+
+### Customize your configuration ###
+
+**AppConfiguration** can be customized to fit your needs. Here is an example
+
+```ruby
+config = AppConfiguration.new('.setup.yml') do
+  base_local_path '/usr/local'
+  base_global_path '/config'
+  use_env_variables true
+  prefix 'my_app'
+end
+```
+
+You can set the configuration file name by passing the name to the new method or you can use the `config_file_name`
+method inside the configuration block.
+
+ * `config_file_name` Sets the name of the config file. Default `.config.yml`.
+ * `base_local_path` Sets the base path for the local configuration file. If there is no config file in this path it will
+look in the global configuration path. Default `./`
+ * `base_global_path` Sets the base path for the global configuration file. Default `~/`
+ * `use_env_variables` Flag that activates the use of enviromental variable. Default `true`
+ * `prefix` A prefix to be appended when looking for environmental variables. For example if `prefix` is set to `my_app`,
+when the `foo` variable is fetched, the `MY_APP_FOO` environmental variable will be checked. 
+This is used to avoid name collitions. Default `nil`
+
+### Variable lookup ###
+
+You can retrieve a variable from a `AppConfiguration::Config` object by doing
+
+```ruby
+foo = config.foo
+foo = config['foo']
+```
+
+Environmental variables will be checked first, adding the necesary prefix if provided. If there is no environmental
+variable, the local config file will be checked. If there is no local file or a value has not been defined for
+the given variable, the global config file will be checked. Otherwise it returns nil.
+
+### Configuration registry ###
+
+If you create a new config object by using `AppConfiguration.new`, then you must keep the reference to this configuration.
+Instead you can registers a configuration by using `AppConfiguration.for`. Then you can obtain a configuration by using
+`AppConfiguration[]`. For example
+
+```ruby
+AppConfiguration.for :github
+# ... Then somewhere else ...
+github = AppConfiguration[:github]
+github.api_key
+```
+
+In the previous example the name of the configuration file is assumed to be `.github.yml` and all the environmental variables
+will be prefixed with `GITHUB_`. You can change this behaviour by passing a configuration block to the `for` method.
+
+### Default values ###
+
+To change the default local path and the default global path for all the `AppConfiguration::Config` objects all you
+need to do is 
+
+```ruby
+AppConfiguration::Config.default_local_path = Rails.root
+AppConfiguration::Config.default_global_path = '/usr/configs'
+```
+
+## 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
+
+Please add specs for all new features. If you find a bug and an spec probing that the bug exists and in a separate commit
+add the bug fix.
+
+## License
+
+Copyright (c) 2013 Guido Marucci Blas
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app_configuration.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'app_configuration/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "app_configuration"
+  gem.version       = AppConfiguration::VERSION
+  gem.authors       = ["Guido Marucci Blas"]
+  gem.email         = ["guidomb@gmail.com"]
+  gem.description   = %q{A gem to handle ruby application configurations using both YAML config files or environmental variables}
+  gem.summary       = %q{A gem to handle ruby application configurations}
+  gem.homepage      = "http://github.com/guidomb/app_configuration"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+
+  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/app_configuration/config.rb

@@ -0,0 +1,75 @@
+require 'yaml'
+
+module AppConfiguration
+
+  class Config
+    include OptionalAttr
+
+    optional_attr :config_file_name,  default: '.config.yml'
+    optional_attr :base_local_path,   default: './'
+    optional_attr :base_global_path,  default: '~/'
+    optional_attr :use_env_variables, default: true
+    optional_attr :prefix            
+
+    # Class Methods
+
+    class << self
+
+      def default_local_path=(default_local_path)
+        defaults[:base_local_path] = default_local_path
+      end
+
+      def default_global_path=(default_global_path)
+        defaults[:base_global_path] = default_global_path
+      end
+
+    end
+
+    # Instance Methods
+
+    def initialize(config_file_name, &block)
+      super() # Sets default values for optional attributes
+      @config_file_name = config_file_name
+      self.instance_eval(&block) if block_given?
+    end
+
+    def local_config_path 
+      @local_config_path ||= config_path(@base_local_path)
+    end
+
+    def global_config_path 
+      @global_config_path ||= config_path(@base_global_path)
+    end
+
+    def [](name)
+      env_name = ''
+      env_name << "#{@prefix.upcase}_" if @prefix
+      env_name << name.to_s.upcase
+      if @use_env_variables && ENV[env_name]
+        ENV[env_name]
+      else
+        config[name]
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      self[method]
+    end
+
+    private
+
+      def config
+        return @config if @config
+
+        @config = {}
+        @config.merge!(YAML.load_file(global_config_path)) if File.exist?(global_config_path)
+        @config.merge!(YAML.load_file(local_config_path)) if File.exist?(local_config_path)
+        @config
+      end
+
+      def config_path(base_path)
+        File.expand_path(File.join(base_path, @config_file_name))
+      end
+  end
+
+end

data/lib/app_configuration/config_registry.rb

@@ -0,0 +1,22 @@
+module AppConfiguration
+
+  module ConfigRegistry
+   
+    def for(config, &block)
+      @configs[config] = new(".#{config}.yml") do
+        prefix config
+        block.call if block
+      end
+    end
+
+    def [](config)
+      @configs[config]
+    end
+
+    def self.extended(object)
+      object.instance_variable_set("@configs", {})
+    end
+
+  end
+
+end

data/lib/app_configuration/optional_attr.rb

@@ -0,0 +1,41 @@
+module AppConfiguration
+
+  module OptionalAttr
+  
+    module ClassMethods
+      
+      def defaults
+        @defaults ||= {}
+      end
+      protected :defaults
+
+      def optional_attr(attribute, options = {})
+        define_method(attribute) do |value| 
+          instance_variable_set("@#{attribute}", value) 
+        end
+
+        defaults[attribute] = options[:default] if options[:default]
+      end 
+      protected :optional_attr
+    
+    end
+    
+    module InstanceMethods
+      
+      def initialize
+        self.class.send(:defaults).each do |attribute, value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+
+    end
+    
+    def self.included(receiver)
+      receiver.extend         ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+
+  end
+
+end
+

data/lib/app_configuration/version.rb

@@ -0,0 +1,3 @@
+module AppConfiguration
+  VERSION = "0.0.1"
+end

data/lib/app_configuration.rb

@@ -0,0 +1,13 @@
+require "app_configuration/version"
+require "app_configuration/optional_attr"
+require "app_configuration/config_registry"
+require "app_configuration/config"
+
+module AppConfiguration
+  extend ConfigRegistry
+
+  def self.new(config_file_name, &block)
+    Config.new(config_file_name, &block)
+  end
+
+end

data/spec/app_configuration/config_spec.rb

@@ -0,0 +1,118 @@
+require 'spec_helper'
+
+describe AppConfiguration::Config do
+  
+  describe "#[]" do
+
+    before(:all) do
+      AppConfiguration::Config.default_local_path = File.join(fixture_path, 'local')
+      AppConfiguration::Config.default_global_path = File.join(fixture_path, 'global')
+    end
+
+    after(:all) do
+      AppConfiguration::Config.default_local_path = nil
+      AppConfiguration::Config.default_global_path = nil
+    end
+
+    context "when there is only a global config file" do
+
+      let(:config) do
+        AppConfiguration::Config.new('config.yml') do
+          base_local_path ''
+          use_env_variables false
+        end
+      end
+
+      it 'returns the resquested config parameter value' do
+        config['variable1'].should eq 'global1'
+      end
+
+    end
+
+    context "when there is only a local config file" do
+
+      let(:config) do
+        AppConfiguration::Config.new('config.yml') do
+          base_global_path ''
+          use_env_variables false
+        end
+      end
+
+      it 'returns the resquested config parameter value' do
+        config['variable1'].should eq 'local1'
+      end
+
+    end
+
+    context "when there are local and global config files" do
+
+      let(:config) do
+        AppConfiguration::Config.new('config.yml') do
+          use_env_variables false
+        end
+      end
+
+      it 'returns the local config parameter value' do
+        config['variable1'].should eq 'local1'
+      end
+
+    end
+
+    context "when environmental variables config parameters exists" do
+
+      before(:each) do
+        ENV.stub(:[]).with("VARIABLE1").and_return("env1")
+      end
+
+      context "when use_env_variables is set to false" do
+
+        let(:config) do
+          AppConfiguration::Config.new('config.yml') do
+            use_env_variables false
+          end
+        end
+
+        it 'returns the local config parameter value' do
+          config['variable1'].should eq 'local1'
+        end
+
+      end
+
+      context "when use_env_variables is set to true" do
+      
+        let(:config) do
+          AppConfiguration::Config.new('config.yml') do
+            use_env_variables true
+          end
+        end
+
+        it 'returns the environmental variable config parameter value' do
+          config['variable1'].should eq 'env1'
+        end
+
+        context "when a prefix is set" do
+
+          before(:each) do
+            ENV.stub(:[]).with("THE_PREFIX_VARIABLE1").and_return("env1")
+          end
+
+          let(:config) do
+            AppConfiguration::Config.new('config.yml') do
+              use_env_variables true
+              prefix 'the_prefix'
+            end
+          end
+
+          it 'returns the environmental variable config parameter value' do
+            config['variable1'].should eq 'env1'
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/app_configuration/optional_attr_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe AppConfiguration::OptionalAttr do
+
+  context 'when included into a class' do
+
+    let(:klass) { Class.new { include AppConfiguration::OptionalAttr } }
+
+    it 'defines the optional_attr method' do
+      klass.respond_to?(:optional_attr, true).should be_true
+    end
+
+    describe ".optional_attr" do
+
+      context "when invoked for the attribute 'foo'" do
+        
+        before do
+          klass.class_eval { optional_attr :foo }
+        end
+
+        let(:instance) do 
+          klass.new 
+        end
+
+        it "defines the 'foo' public method" do
+          instance.should respond_to(:foo).with(1).argument
+        end
+
+        describe "#foo" do
+
+          it "sets the instance variable @foo with the given value" do
+            instance.foo 1
+            instance.instance_variable_get("@foo").should be 1
+          end
+
+        end
+
+      end
+
+      context "when invoked for the attribute 'bar' with default option value '1'" do
+
+        before do
+          klass.class_eval { optional_attr :bar, default: 1 }
+        end
+
+        let(:instance) do 
+          klass.new 
+        end
+
+        it "sets the instance variable @bar with the default value" do
+          instance.instance_variable_get("@bar").should eq 1
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/app_configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe AppConfiguration do
+  
+  describe ".for" do
+
+    let(:config_name) { :spec }
+    before(:each) { AppConfiguration.for(config_name) }
+
+    it 'registers a new Config object' do
+      AppConfiguration[config_name].should_not be_nil 
+    end
+
+    it 'sets the config_file_name attribute based on the config name' do
+      AppConfiguration[config_name].instance_variable_get("@config_file_name").should eq ".#{config_name}.yml"
+    end
+
+    it 'sets the prefix attribute based on the config name' do
+      AppConfiguration[config_name].instance_variable_get("@prefix").should eq config_name
+    end
+
+  end
+
+end

data/spec/fixtures/global/config.yml

@@ -0,0 +1,2 @@
+variable1: 'global1'
+variable2: 'global2'

data/spec/fixtures/local/config.yml

@@ -0,0 +1,2 @@
+variable1: 'local1'
+variable2: 'local2'

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'bundler/setup'
+require 'coveralls'
+
+require 'app_configuration'
+
+module Helpers
+
+  def fixture_path
+    File.expand_path(File.join('.', 'spec', 'fixtures'))
+  end
+
+end
+
+Coveralls.wear!
+RSpec.configure do |config|
+
+  config.include(Helpers)
+
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: app_configuration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Guido Marucci Blas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
+description: A gem to handle ruby application configurations using both YAML config
+  files or environmental variables
+email:
+- guidomb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app_configuration.gemspec
+- lib/app_configuration.rb
+- lib/app_configuration/config.rb
+- lib/app_configuration/config_registry.rb
+- lib/app_configuration/optional_attr.rb
+- lib/app_configuration/version.rb
+- spec/app_configuration/config_spec.rb
+- spec/app_configuration/optional_attr_spec.rb
+- spec/app_configuration_spec.rb
+- spec/fixtures/global/config.yml
+- spec/fixtures/local/config.yml
+- spec/spec_helper.rb
+homepage: http://github.com/guidomb/app_configuration
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3752812428979833115
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3752812428979833115
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A gem to handle ruby application configurations
+test_files:
+- spec/app_configuration/config_spec.rb
+- spec/app_configuration/optional_attr_spec.rb
+- spec/app_configuration_spec.rb
+- spec/fixtures/global/config.yml
+- spec/fixtures/local/config.yml
+- spec/spec_helper.rb