node_config 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/Gemfile

@@ -0,0 +1,3 @@
+source("http://rubygems.org")
+
+gemspec

data/README.md

@@ -0,0 +1,161 @@
+# NodeConfig
+
+Simple "node" configuration solution for Rails applications.
+
+## Prelude
+
+"node" is a single machine, which your Rails application is running on.
+So "node" configuration is the configuration for that specific machine. For example:
+
+* Your development laptop is also a "node" and needs a local configuration for _development_.
+* Your server is also a "node", but it needs a different configuration for _production_.
+
+## Purpose
+
+We need to maintain lots of configuration keys specific for a "node", like AWS access keys,
+Google-Analytics keys and much more...
+
+Also:
+
+* We want all of this keys to be defined in a _single_ _file_
+* We want all of this keys to be _loaded_ _automatically_ on Rails startup
+* We want all of this keys to be available inside Rails application
+* We want that a missing key results in a _descriptive_ _error_
+* We want this keys to be loaded into a process, which doesn't load the whole application
+
+This is what `NodeConfig` tries to simplify.
+
+## Installation
+
+```ruby
+# Gemfile
+gem("node_config")
+```
+
+```bash
+$ bundle install # Install the gem
+$ rails generate node_config # Generate configuration files
+```
+
+## Usage
+
+Put your node configuration into generated `RAILS_ROOT/config/node_config.yml`.
+
+
+### Within a loaded Rails application
+
+Your node configuration is available in Rails application config.
+This is done by the generated initializer `config/initializers/node_config.rb`.
+
+```yaml
+# config/node_config.yml
+foo:
+  bar: :baz
+```
+
+```ruby
+# rails console
+Rails.application.config.node_config.foo #=> {"bar" => :baz}
+Rails.application.config.node_config.foo.bar #=> :baz
+```
+
+In a Rake task:
+
+```ruby
+# Rakefile
+task :my_task do
+  puts(Rails.application.config.node_config.foo.bar) #=> baz
+end
+```
+
+### Using without loading Rails
+
+Outside the Rails you can access the node configuration through the top
+level module named as your Rails application:
+
+```ruby
+PetShop.node_config.foo.bar #=> :baz
+```
+
+This is done by loading the generated `RAILS_ROOT/config/node_config.rb`.
+
+If you have a Rake task for which the node configuration should be available
+_without_ loading whole Rails, use the generated shortcut task.
+
+```ruby
+# lib/tasks/my_task_which_doesnt_need_rails.rake
+load File.expand_path("../node_config.rake", __FILE__)
+
+task :my_task_which_doesnt_need_rails => :node_config do
+  puts(PetShop.node_config.foo.bar) #=> baz
+end
+```
+
+Or as command line in your `Procfile` (https://github.com/ddollar/foreman)
+for a worker (https://github.com/defunkt/resque):
+
+```ruby
+# Rakefile
+load File.expand_path("../lib/tasks/node_config.rake", __FILE__)
+```
+
+```
+worker: bundle exec rake node_config resque:work
+```
+
+If you have a script for which the node configuration should be available
+_without_ loading whole Rails, be aware that the process _has_ to be bundled.
+Otherwise it may not find the gem.
+
+For example in your backup script (https://github.com/meskyanichi/backup):
+
+```ruby
+# config/backup.rb
+require File.expand_path("../node_config", __FILE__)
+
+PetShop.node_config.foo.bar #=> :baz
+```
+
+Same when deploying with Capistrano (https://github.com/capistrano/capistrano):
+
+```ruby
+# config/deploy.rb
+require File.expand_path("../node_config", __FILE__)
+
+PetShop.node_config.foo.bar #=> :baz
+```
+
+Or even in an external Ruby script:
+
+```ruby
+# foo.rb
+require "/srv/www/pet_shop/current/config/node_config"
+
+PetShop.node_config.foo.bar #=> :baz
+```
+
+If you have a process, which isn't bundled, then require the gem manually:
+
+```ruby
+# foo.rb
+require "rubygems"
+require "node_config"
+
+require "/srv/www/pet_shop/current/config/node_config"
+
+PetShop.node_config.foo.bar #=> :baz
+```
+
+## Errors
+
+Under the hood `NodeConfig` uses `HashWithStructAccess`,
+so a missing key will result in appropriate `NoMethodError`
+(see https://github.com/kostia/hash_with_struct_access for details).
+
+
+## Using with Git
+
+Of course you have instruct Git to ignore `config/node.yml`.
+
+But it's a good practice to maintain a configuration template with the list of required keys,
+for example in `config/node.yml.template`.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList["test/*_test.rb"]
+end
+
+task(:default => :test)

data/lib/generators/node_config_generator.rb

@@ -0,0 +1,28 @@
+require "rails/generators"
+
+class NodeConfigGenerator < Rails::Generators::Base
+  desc("Install NodeConfig")
+  source_root(File.expand_path("../templates", __FILE__))
+
+  def generate_initializer
+    @both_app_modules = Rails.application.class.name
+    template("config/initializers/node_config.rb.erb", "config/initializers/node_config.rb")
+  end
+
+  def generate_loader
+    @top_level_app_module = Rails.application.class.name.split("::").first
+    template("config/node_config.rb.erb", "config/node_config.rb")
+  end
+
+  def create_rakefile
+    rakefile("node_config.rake") do
+      %Q{task :node_config do
+  load File.expand_path("../../../config/node_config.rb", __FILE__)
+end}
+    end
+  end
+
+  def create_configuration
+    create_file("config/node_config.yml")
+  end
+end

data/lib/generators/templates/config/initializers/node_config.rb.erb

@@ -0,0 +1 @@
+<%= @both_app_modules %>.config.node_config = NodeConfig.load_file(File.expand_path("../../node_config.yml", __FILE__))

data/lib/generators/templates/config/node_config.rb.erb

@@ -0,0 +1,7 @@
+require "node_config"
+
+module <%= @top_level_app_module %>
+  def self.node_config
+    @node_config ||= NodeConfig.load_file(File.expand_path("../node_config.yml", __FILE__))
+  end
+end

data/lib/node_config.rb

@@ -0,0 +1,8 @@
+require "hash_with_struct_access"
+require "yaml"
+
+module NodeConfig
+  def self.load_file(path)
+    HashWithStructAccess.new(YAML.load_file(path))
+  end
+end

data/lib/node_config/railtie.rb

@@ -0,0 +1,4 @@
+module NodeConfig
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/node_config/version.rb

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

data/node_config.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/node_config/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = "node_config"
+  gem.version = NodeConfig::VERSION
+  gem.description = %q{Simple "node" configuration solution for Rails applications}
+  gem.summary = %q{
+    Simple "node" configuration solution for Rails applications.
+
+    We need to maintain lots of configuration keys specific for a "node", like AWS access keys,
+    Google-Analytics keys and much more.
+
+    This is what this gem tries to simplify.
+  }
+  gem.homepage = "https://github.com/kostia/node_config"
+  gem.authors = ["Kostiantyn Kahanskyi"]
+  gem.email = %w(kostiantyn.kahanskyi@googlemail.com)
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- test/*`.split("\n")
+  gem.require_paths = %w(lib)
+  gem.required_ruby_version = ">= 1.9.2"
+  gem.add_dependency("hash_with_struct_access")
+  gem.add_dependency("rails", ">= 3.2.1")
+  gem.add_development_dependency("minitest")
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("turn")
+end

data/test/fixtures/node_config.yml

@@ -0,0 +1,2 @@
+foo:
+  bar: :baz

data/test/node_config_generator_test.rb

@@ -0,0 +1,51 @@
+require "./test/test_helper"
+
+require "generators/node_config_generator"
+
+module PetShop
+  class Application
+    def self.config
+    end
+  end
+end
+
+class NodeConfigGeneratorTest < Rails::Generators::TestCase
+  tests(NodeConfigGenerator)
+  destination("/tmp")
+  setup(:prepare_destination)
+
+  # Stub application module
+  def Rails.application
+    ::PetShop::Application.new
+  end
+
+  test "should create YAML config file" do
+    run_generator
+    assert_file("config/node_config.yml")
+  end
+
+  test "should create rakefile" do
+    run_generator
+    assert_file("lib/tasks/node_config.rake") do |rakefile|
+      rakefile.squeeze(" ").must_equal(%Q{task :node_config do
+  load File.expand_path("../../../config/node_config.rb", __FILE__)
+end}.squeeze(" "))
+    end
+  end
+
+  test "should generate loader" do
+    run_generator
+    assert_file("config/node_config.rb") do |loader|
+      loader.must_match(/^require "node_config"/)
+      eval(loader)
+      Proc.new { PetShop.node_config }.must_raise(Errno::ENOENT)
+    end
+  end
+
+  test "should generate initializer" do
+    run_generator
+    assert_file("config/initializers/node_config.rb") do |initializer|
+      Proc.new { eval(initializer) }.must_raise(Errno::ENOENT)
+    end
+  end
+end

data/test/node_config_test.rb

@@ -0,0 +1,22 @@
+require "./test/test_helper"
+
+require "node_config"
+
+describe NodeConfig do
+  describe "#load_config" do
+    before do
+      @config_path = File.expand_path("../fixtures/node_config.yml", __FILE__)
+    end
+
+    it "should load and parse YAML file with given path" do
+      node_config = NodeConfig.load_file(@config_path)
+      node_config.must_equal({"foo" => {"bar" => :baz}})
+    end
+
+    it "should create a hash with struct access from loaded data" do
+      node_config = NodeConfig.load_file(@config_path)
+      node_config.must_be_kind_of(HashWithStructAccess)
+      node_config.foo.bar.must_equal(:baz)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require "turn/autorun"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: node_config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kostiantyn Kahanskyi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_with_struct_access
+  requirement: &70327627737620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327627737620
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70327627735420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327627735420
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70327627747880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70327627747880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70327627745120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70327627745120
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70327627742600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70327627742600
+description: Simple "node" configuration solution for Rails applications
+email:
+- kostiantyn.kahanskyi@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- Gemfile
+- README.md
+- Rakefile
+- lib/generators/node_config_generator.rb
+- lib/generators/templates/config/initializers/node_config.rb.erb
+- lib/generators/templates/config/node_config.rb.erb
+- lib/node_config.rb
+- lib/node_config/railtie.rb
+- lib/node_config/version.rb
+- node_config.gemspec
+- test/fixtures/node_config.yml
+- test/node_config_generator_test.rb
+- test/node_config_test.rb
+- test/test_helper.rb
+homepage: https://github.com/kostia/node_config
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Simple "node" configuration solution for Rails applications.  We need to
+  maintain lots of configuration keys specific for a "node", like AWS access keys,
+  Google-Analytics keys and much more.  This is what this gem tries to simplify.
+test_files:
+- test/fixtures/node_config.yml
+- test/node_config_generator_test.rb
+- test/node_config_test.rb
+- test/test_helper.rb