yaml_conf 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/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@yaml_conf"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.11.3 ()" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 David van Geest
+
+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,40 @@
+# YamlConf
+
+This is a very simple gem to automate the setup and initialization of a YAML config file for Rails 3.0+ apps.
+
+Configuration variables are environment-specific, allowing for different configs in dev, test, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaml_conf'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_conf
+
+Once the gem is installed, generate the `config/config.yml` file:
+
+    $ rails g yaml_conf:install
+
+## Usage
+
+Access config variables like so:
+
+    CONFIG[:foo]
+    => "bar"
+
+Modify `config/config.yml` to add additional variables.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/lib/generators/yaml_conf/install/install_generator.rb

@@ -0,0 +1,12 @@
+module YamlConf
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      # all public methods in here will be run in order
+      def add_config_file
+        template "config.yml", "config/config.yml"
+      end
+    end
+  end
+end

data/lib/generators/yaml_conf/install/templates/config.yml

@@ -0,0 +1,19 @@
+# Edit this YAML file to add configuration values to your application.
+#
+# Variables may be accessed as follows:
+#   CONFIG[:foo]
+#   => "bar" 
+#
+# You can remove the "foo" key, it's just for illustration and to make a valid YAML file
+
+common: &common
+  foo: bar
+  
+development:
+  <<: *common
+  
+test:
+  <<: *common
+  
+production:
+  <<: *common

data/lib/yaml_conf/railtie.rb

@@ -0,0 +1,12 @@
+module YamlConf
+  class Railtie < Rails::Railtie
+    initializer "railtie.load_config" do
+      begin
+        ::CONFIG = YAML.load_file(File.join(Rails.root, "config", "config.yml"))[Rails.env].with_indifferent_access
+      rescue Errno::ENOENT
+        # config file does not exist yet
+        ::CONFIG = {}
+      end
+    end
+  end
+end

data/lib/yaml_conf/version.rb

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

data/lib/yaml_conf.rb

@@ -0,0 +1,2 @@
+require "yaml_conf/version"
+require 'yaml_conf/railtie' if defined?(Rails)

data/test/lib/generators/yaml_conf/install/install_generator_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'generators/yaml_conf/install/install_generator'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests YamlConf::Generators::InstallGenerator
+  destination File.expand_path("../../../../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "application config file is created" do
+    run_generator
+    
+    assert_file "config/config.yml"
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'rails/generators/test_case'

data/yaml_conf.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yaml_conf/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["David van Geest"]
+  gem.email         = ["david.vangeest@gmail.com"]
+  gem.description   = %q{Organize your Rails application configuration into a YAML file}
+  gem.summary       = %q{Creates a YAML file to store Rails application configuration and loads it into a global variable}
+  gem.homepage      = "https://github.com/DWvanGeest/yaml_conf"
+
+  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.name          = "yaml_conf"
+  gem.require_paths = ["lib"]
+  gem.version       = YamlConf::VERSION
+
+  gem.add_dependency 'rails', '>= 3.0.0'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: yaml_conf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David van Geest
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Organize your Rails application configuration into a YAML file
+email:
+- david.vangeest@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/yaml_conf/install/install_generator.rb
+- lib/generators/yaml_conf/install/templates/config.yml
+- lib/yaml_conf.rb
+- lib/yaml_conf/railtie.rb
+- lib/yaml_conf/version.rb
+- test/lib/generators/yaml_conf/install/install_generator_test.rb
+- test/test_helper.rb
+- yaml_conf.gemspec
+homepage: https://github.com/DWvanGeest/yaml_conf
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Creates a YAML file to store Rails application configuration and loads it
+  into a global variable
+test_files:
+- test/lib/generators/yaml_conf/install/install_generator_test.rb
+- test/test_helper.rb