courtier 0.2.0

data/lib/courtier/setup.rb

@@ -0,0 +1,46 @@
+module Courtier
+
+  # Tool configuration setup is used to customize how a tool handles
+  # configuration.
+  #
+  class Setup
+
+    #
+    # Intialize new configuration setup.
+    #
+    def initialize(feature, options={}, &block)
+      @feature = feature.to_s
+
+      @command = @feature
+      @command = options[:command] || options[:tool] if options.key?(:command) || options.key?(:tool)
+
+      @profile = options[:profile] if options.key?(:profile)
+
+      @block = block
+    end
+
+    #
+    # Feature for which this is the configuration setup.
+    #
+    attr :feature
+
+    #
+    #
+    #
+    def call(config)
+      return unless config.command == @command.to_s if @command
+      return unless config.profile == @profile.to_s if @profile
+
+      @block.call(config)
+    end
+
+    #
+    #
+    #
+    def to_proc
+      @block
+    end
+
+  end
+
+end

data/lib/courtier/tweaks/rake.rb

@@ -0,0 +1,31 @@
+require 'rake'
+
+court 'rake' do |config|
+  Module.new do
+    extend Rake::DSL
+    module_eval(&config)
+  end
+end
+
+module Rake
+  RC_FILES = '.config.rb', 'config.rb', 'Config.rb'
+
+  class Application
+    remove_const(:DEFAULT_RAKEFILES)
+    DEFAULT_RAKEFILES = [
+      'rakefile', 'Rakefile', 'rakefile.rb', 'Rakefile.rb',    
+    ] + RC_FILES
+  end
+
+  def self.load_rakefile(path)
+    case File.basename(path)
+    when *RC_FILES
+      # do nothing, RC will do it
+    else
+      load(path)
+    end
+  end
+end
+
+# Must manually configure tweaked libraries.
+RC.configure('rake')

data/lib/rc.rb

@@ -0,0 +1,2 @@
+# Use this script for dedicated configuration.
+require 'courtier/interface'

data/spec/00_concept.md

@@ -0,0 +1,23 @@
+# Ruby Courtier
+
+The purpose of Courtier is to provide unified configuration management
+for Ruby tools.
+
+Courtier designates a single per-project configuration file, named
+either `.config.rb`, `Config.rb` or `config.rb`, looked up in that 
+order. The structure of this configuration file is very simple.
+It is a ruby script sectioned into named `config` and `onload`
+blocks:
+
+  config 'rubytest' do
+    # ... configure rubytest command ...
+  end
+
+  onload 'rake' do
+    # ... when rake is required then ...
+  end
+
+Utilization of the these configurations may be handled by the consuming 
+application, but can be used on any Ruby-based tool if `-rc` is added 
+to RUBYOPT.
+

data/spec/01_config.md

@@ -0,0 +1,14 @@
+# Config Class
+
+The Config class encapsulates a single config entry. It has a tool, profile
+and procedure.
+
+    config = RC::Config.new('foo', :profile=>'bar') do
+      'example'
+    end
+
+    config.command       #=> 'foo'
+    config.feature       #=> 'foo'
+    config.profile       #=> 'bar'
+    config.to_proc.call  #=> 'example'
+

data/spec/02_configuration.md

@@ -0,0 +1,51 @@
+# Configuration
+
+The Configuration class handle evaluation of a project configuration file.
+
+   rc = RC::Configuration.new
+
+We can use the `#instance_eval` method to evaluate a configuration for our
+demonstration.
+
+    rc.evaluate(<<-HERE)
+      config :sample1 do
+        "block code"
+      end
+    HERE
+
+Evaluation of a configuration file, populate the Confection.config instance.
+
+    sample = rc.configurations.last
+    sample.tool     #=> 'sample1'
+    sample.profile  #=> 'default'
+    sample.class    #=> RC::Config
+
+A profile can be used as a means fo defining multiple configurations
+for a single tool. This can be done by setting the second argument to
+a Symbol.
+
+    rc.evaluate(<<-HERE)
+      config :sample2, profile: 'opt1' do
+        "block code"
+      end
+    HERE
+
+    sample = rc.configurations.last
+    sample.tool     #=> 'sample2'
+    sample.profile  #=> 'opt1'
+
+Or it can be done by using a `profile` block.
+
+    rc.evaluate(<<-HERE)
+      profile :opt1 do
+        config :sample2 do
+          "block code"
+        end
+      end
+    HERE
+
+    sample = rc.configurations.last
+    sample.tool     #=> 'sample2'
+    sample.profile  #=> 'opt1'
+
+

data/spec/03_import.md

@@ -0,0 +1,49 @@
+# Importing
+ 
+## Configuration Importing
+
+Configurations can be imported from another project
+using the `:from` option.
+
+    rc = RC::Configuration.new
+
+    rc.config :qed, :profile=>'example', :from=>'qed'
+
+    rc.to_a.size.assert == 1
+
+The configuration can also be imported from a different profile.
+
+    rc.config :qed, :profile=>:coverage, :from=>['qed', :profile=>:simplecov]
+
+    rc.to_a.size.assert == 2
+
+Although it will rarely be of use, it may also be imported from another
+feature or commandline tool.
+
+    rc.config :example, :from=>['qed', :command=>:sample]
+
+Imported configurations can also be augmented via a block.
+
+    rc = RC::Configuration.new
+
+    rc.config :qed, :from=>['qed', :profile=>:simplecov] do
+      # additional code here
+    end
+
+    rc.to_a.size.assert == 2
+
+Technically this last form just creates two configurations for the same
+tool and profile, but the ultimate effect is the same.
+
+## Script Importing
+
+Library files can be imported directly into configuration blocks via the
+`#import` method.
+
+    rc.config :example do
+      import "fruitbasket/example.rb"
+    end
+
+This looks up the file via the `finder` gem and then evals it in the context
+of the config block.
+

data/spec/06_interface.md

@@ -0,0 +1,39 @@
+# Interface
+
+The main means of workin with RC's API are the RC class methods,
+collectively called the Inteface.
+
+Let's say we have a configuration file `config.rb` containing:
+
+    config :example do
+      "example config"
+    end
+
+    config :example, :profile=>:something do
+      "example config using profile"
+    end
+
+To get the configuration of the current project --relative to the 
+current working directory, use the `configuration` method.
+
+    RC.configuration
+
+The configuration properties of the current project can be
+had via the `properties` method.
+
+    RC.properties
+
+The profile names can be looked up for any given tool via the `profile_names`
+method.
+
+    RC.profile_names(:example)  #=> ['default', 'something']
+
+The number of feature configurations in the current project can be
+had via the `size` method.
+
+    RC.configuration.size  #=> 1
+
+A list of all configuration entries can be had by calling #to_a.
+
+    RC.configuration.to_a.size  #=> 2
+

data/spec/applique/ae.rb

@@ -0,0 +1 @@
+require 'ae'

data/spec/applique/file.rb

@@ -0,0 +1,8 @@
+require 'courtier/interface'
+
+When 'configuration file `(((\S+)))` containing' do |slots, text|
+  RC.clear! #configurations.clear
+  fname = [slots].flatten.first  # temporary transition to new QED
+  File.open(fname, 'w'){ |f| f << text }
+end
+

data/spec/applique/fixture.rb

@@ -0,0 +1,10 @@
+# Setup the fixtures.
+
+dir = File.dirname(__FILE__) + '/fixture'
+Dir.entries(dir).each do |file|
+  next if file == '.' or file == '..'
+  path = File.join(dir, file)
+  next if File.directory?(path)
+  FileUtils.install(path, Dir.pwd)
+end
+

data/spec/applique/fixture/config.rb

@@ -0,0 +1,16 @@
+# exmaple configuration file
+
+config :example do
+  "example config"
+end
+
+config :example, :yaml, %{
+  ---
+  note: example text config
+}
+
+config :example, :data do |ex|
+  ex.name = 'Tommy'
+  ex.age  = 42
+end
+

data/spec/cov.rb

@@ -0,0 +1,7 @@
+# Usage: qed -r ./spec/cov
+require 'simplecov'
+SimpleCov.start do
+  coverage_dir 'log/coverage'
+  #add_group "Label", "lib/qed/directory"
+end
+

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: courtier
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: finder
+  requirement: &29133520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *29133520
+- !ruby/object:Gem::Dependency
+  name: loaded
+  requirement: &29132980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *29132980
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &29132460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *29132460
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &29131940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *29131940
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: &29131420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *29131420
+description: ! 'Courtier is a multi-tenant configuration system for Ruby projects.
+
+  Courtier can configure almost any Ruby tool or library.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- NOTES.md
+- HISTORY.md
+- README.md
+files:
+- .ruby
+- .yardopts
+- lib/c.rb
+- lib/courtier/config.rb
+- lib/courtier/config_filter.rb
+- lib/courtier/configuration.rb
+- lib/courtier/core_ext.rb
+- lib/courtier/interface.rb
+- lib/courtier/properties.rb
+- lib/courtier/setup.rb
+- lib/courtier/tweaks/rake.rb
+- lib/courtier.rb
+- lib/rc.rb
+- spec/00_concept.md
+- spec/01_config.md
+- spec/02_configuration.md
+- spec/03_import.md
+- spec/06_interface.md
+- spec/applique/ae.rb
+- spec/applique/file.rb
+- spec/applique/fixture/config.rb
+- spec/applique/fixture.rb
+- spec/cov.rb
+- NOTES.md
+- LICENSE.txt
+- HISTORY.md
+- README.md
+- Config.rb
+homepage: http://rubyworks.github.com/courtier
+licenses:
+- BSD-2-Clause
+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.11
+signing_key: 
+specification_version: 3
+summary: The best way to manage your application's configuration.
+test_files: []