courtier 0.2.0

data/.ruby

@@ -0,0 +1,63 @@
+---
+source:
+- var
+- var/
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+requirements:
+- name: finder
+- name: loaded
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+alternatives: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/courtier.git
+  scm: git
+  name: upstream
+resources:
+- uri: http://rubyworks.github.com/courtier
+  name: home
+  type: home
+- uri: http://rubydoc.info/gems/courtier/frames
+  name: docs
+  type: doc
+- uri: http://github.com/rubyworks/courtier
+  name: code
+  type: code
+- uri: http://groups.google.com/group/rubyworks-mailinglist
+  name: mail
+  type: mail
+- uri: http://chat.us.freenode.net/rubyworks
+  name: chat
+  type: chat
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2011-11-06'
+summary: The best way to manage your application's configuration.
+title: Courtier
+version: 0.2.0
+name: courtier
+description: ! 'Courtier is a multi-tenant configuration system for Ruby projects.
+
+  Courtier can configure almost any Ruby tool or library.'
+organization: Rubyworks
+date: '2012-04-28'

data/.yardopts

@@ -0,0 +1,8 @@
+--title "Runtime Configuration"
+--readme README.rdoc
+--protected
+--private
+lib/**/*.rb
+-
+[A-Z]*.*
+

data/Config.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+config 'pry' do
+  puts "RC on Pry!"
+  $LOAD_PATH.unshift('lib')
+end
+
+#
+# Detroit assembly.
+#
+config 'detroit' do
+  service :email do |s|
+    s.mailto = ['ruby-talk@ruby-lang.org', 
+                'rubyworks-mailinglist@googlegroups.com']
+  end
+
+  service :gem do |s|
+    s.gemspec = 'pkg/courtier.gemspec'
+  end
+
+  service :github do |s|
+    s.folder = 'web'
+  end
+
+  service :dnote do |s|
+    s.title  = 'Source Notes'
+    s.output = 'log/notes.html'
+  end
+
+  service :locat do |s|
+    s.output = 'log/locat.html'
+  end
+
+  service :vclog do |s|
+    s.output = ['log/history.html',
+                'log/changes.html']
+  end
+end
+
+#
+# QED test coverage report using SimpleCov.
+#
+# Use `$properties.coverage_folder` to set directory in which to store
+# coverage report this defaults to `log/coverage`.
+#
+# IMPORTANT! Unfortunately this will not give us a reliable report
+# b/c QED uses the RC gem, so SimpleCov can't differentiate the two.
+#
+config 'qed', profile: 'cov' do
+  puts "QED w/coverage!"
+
+  require 'simplecov'
+
+  dir = $properties.coverage_folder
+
+  SimpleCov.start do
+    coverage_dir(dir || 'log/coverage')
+    #add_group "Label", "lib/qed/directory"
+  end
+end
+
+config 'qed' do
+  puts "QED!"
+end
+
+#
+# Rake tasks 
+#
+config 'rake' do
+  desc 'run unit tests'
+  task 'test' do
+    puts "Rake Boo!"
+  end
+end
+
+#
+# Example configuration.
+#
+config 'example' do
+  puts "Configuration Example!"
+end
+

data/HISTORY.md

@@ -0,0 +1,20 @@
+# RELEASE HISTORY
+
+## 0.2.0 | 2012-04-16
+
+Continued improvements to design and API. Basically,
+just read the README to see what is new.
+
+Changes:
+
+* 
+
+
+## 0.1.1 | 2012-04-09
+
+Initial release of RC. 
+
+Changes:
+
+* Happy first release.
+

data/LICENSE.txt

@@ -0,0 +1,27 @@
+(BSD-2-Clause license)
+
+Ruby Confection (http://rubyworks.github.com/rc)
+
+Copyright (c) 2011 Rubyworks. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/NOTES.md

@@ -0,0 +1,38 @@
+# Developer Notes
+
+
+## 2012-04-07 | Toplevel DSLs
+
+If it were not for Ruby's mixing toplevel definitions into all
+objects, I likely would have used the simpler design of 
+just loading the config files directly (via `#load`).
+
+It's dissapointing that Ruby continues to insist on mixing toplevel
+methods into all objects. It would be much easier to write script
+DSLs if it did not, saving a good bit of code. In this case, for
+instance, I probably could have shaved off 20% to 40% of the 
+current code --neither the Config or the Configuration class
+would be needed, and the parser could be stripped down to just
+enough code to collect a list of profiles since that is all it
+would really be useful for then.
+
+
+## 2012-04-05 | Multiple Configurations
+
+Should multiple definitions for the same tool and profile be
+allowed?
+
+    config :qed, :cov do
+      ...
+    end
+
+    config :qed, :cov do
+      ...
+    end
+
+    configuration.invoke(:qed, :cov)
+
+Should both definitions be called, or just the later? I have decide
+that both will be called. If this becomes a concern, I may add a `#reconfig`
+method which would first clear the list of matching configurations.
+

data/README.md

@@ -0,0 +1,185 @@
+# Ruby Courtier
+
+[Homepage](http://rubyworks.github.com/courtier) /
+[Source Code](http://github.com/rubyworks/courtier) /
+[Report Issue](http://github.com/rubyworks/courtier/issues) /
+[Mailing List](http://googlegroups.com/group/rubyworks-mailinglist) /
+[IRC Channel](http://chat.us.freenode.net/rubyworks)
+
+[![Build Status](https://secure.travis-ci.org/rubyworks/courtier.png)](http://travis-ci.org/rubyworks/courtier)
+
+
+## About
+
+*Ruby Courtier*, RC for short, is a is multi-tenant runtime configuration system
+for Ruby tools. If was designed to facilitate Ruby-based configuration for
+multiple tools in a single file. It is extremely simple, and univerally applicable
+which makes it easy to understand and flexible in use.
+
+
+## Installation
+
+To use RC via tools that support RC directly, there is nothing you need to
+install. Installing the said tool should install `courtier` via a dependency and
+load `courtier` when the tool is used.
+
+To use RC with tools that don't provide direct support, first install RC
+in the usual manner via RubyGems.
+
+    $ gem install courtier
+
+Then add `-rc` to your system's `RUBYOPT` environment variable.
+
+    $ export RUBYOPT='-rc'
+
+You will want to add that to your `.bashrc`, `.profile` or equivalent configuration
+script.
+
+
+## Instruction
+
+To use RC in a project create a master configuration file for the project called
+`Config.rb`. The file can have any name that matches `.config.rb`, `Config.rb`
+or `config.rb`, in that order of precedence. In this file add configuration
+blocks by name of the commandline tool. For example, let's demonstrate how we could
+use this to configure Rake tasks.
+
+    $ cat Config.rb
+    config :rake do
+      desc 'generate yard docs'
+      task :yard do
+        sh 'yard'
+      end
+    end
+
+Now when `rake` is run the tasks defined in this configuration will be available.
+
+You might wonder why anyone would do this. That's where the *multi-tenancy*
+comes into play. Let's add another configuration.
+
+    $ cat Config.rb
+    title = "MyApp"
+
+    config :rake do
+      desc 'generate yard docs'
+      task :yard do
+        sh "yard doc --title #{title}"
+      end
+    end
+
+    config :qedoc do |doc|
+      doc.title = "#{title} Demos"
+    end
+
+Now we have configuration for both the rake tool and the qedoc tool in
+a single file. Thus we gain the advantage of reducing the file count of our 
+project while pulling our tool configurations together into one place.
+Moreover, these configurations can potentially share settings as demonstrated
+here via the `title` local variable.
+
+RC also supports profiles, either via a `profile` block:
+
+    profile :cov
+      config :qed do
+        require 'simplecov'
+        ...
+      end
+    end
+
+Or via a second config argument:
+
+    config :qed, :cov do
+      require 'simplecov'
+      ...
+    end
+
+When utilizing the tool, set the profile via an environment variable.
+
+    $ profile='cov' qed
+
+Some tools that support RC out-of-the-box, may support a profile command
+line option for specifying the profile.
+
+    $ qed -p cov
+
+Still other tools might utilize profiles to a more specific purpose of
+the tool at hand. Consult the tool's documentation for details.
+
+
+## Qualifications
+
+RC can be used with any Ruby-based commandline tool and there exists some
+means of configuring the tool via a toplevel/global interface, or the tool
+has been desinged to directly support RC.
+
+
+## Customization
+
+A tool can provide dedicated support for RC by loading `rc` or `courtier`
+and using the `court` method to define a configuration procedure. For example, 
+the `detroit` project defines:
+
+    require 'rc'
+
+    court 'detroit' do |config|
+      if config.command?
+        Detroit.rc_config << config
+      end
+    end
+
+In our example, `detroit` is required this configuration will be proccessed.
+The `if config.command?` condition ensures that it only happens if the config's
+`command` property matches the current command, i.e. `$0 == 'detroit'`. We can
+see that Detroit stores the configuration for later us. When Detroit gets
+around to loading a project's build assemblies, it will check this `rc_config`
+setting and evaluate the configurations found there via Detroit's own DSL.
+
+It is important that Courtier be required first, ideally before anything else. This
+ensures it will pick up all configured features.
+
+Some tools will want to support a command line option for selecting a 
+configuration profile. RC has a convenience method to make this very
+easy to do.
+
+    Courtier.profile_switch('qed', '-p', '--profile')
+
+It does not remove the argument from `ARGV`, so the tool's command line option
+parser should still account for it. This simply ensures RC will know what the
+profile is by setting `ENV['profile']` to the entry following the switch.
+
+
+## Dependencies
+
+### Libraries
+
+RC depends on the [Finder](http://rubyworks.github.com/finder) library
+to provide reliable load path and Gem searching. This is used when importing
+configurations from other projects.
+
+### Core Extensions
+
+RC uses two core extensions, `#to_h`, which applies to a few different
+classes, and `String#tabto`. These are *copied* from
+[Ruby Facets](http://rubyworks.github.com/facets) to ensure a high
+standard of interoperability.
+
+Both of these methods have been suggested for inclusion in Ruby proper.
+Please head over to Ruby Issue Tracker and add your support.
+
+* http://bugs.ruby-lang.org/issues/749
+* http://bugs.ruby-lang.org/issues/6056
+
+
+## Release Notes
+
+Please see HISTORY.rdoc file.
+
+
+## Copyrights
+
+Copyright (c) 2011 Rubyworks
+
+Confection is distributable in accordance with the **BSD-2-Clause** license.
+
+See LICENSE.txt file for details.
+

data/lib/c.rb

@@ -0,0 +1,7 @@
+# This script is for use in the RUBYOPT, e.g. RUBYOPT="-rc".
+#
+# My apologies to the author of the `c` gem, but honestly
+# I think it would be much better off that functionality
+# were provided via some other gems, e.g. the `github` gem.
+
+require 'courtier'

data/lib/courtier.rb

@@ -0,0 +1,8 @@
+# Runtime Configuration for Ruby
+#
+module Courtier
+  require 'courtier/interface'
+  autoconfigure
+end
+
+# Copyright (c) 2011 Rubyworks (BSD-2-Clause)