rc 0.1.1

data/lib/rc/tool_configuration.rb

@@ -0,0 +1,54 @@
+module RC
+
+  # ToolConfiguration encapsulates configurations for a specific tool.
+  # It is essentially a subset taken from a project's full set of
+  # configurations.
+  #
+  class ToolConfiguration < Module
+    include Enumerable
+
+    #
+    # Initialize new ToolConfiguration.
+    #
+    # @param [String,Symbol] Tool name.
+    #
+    # @param [Configuraiton] Project configuration instance.
+    #
+    def initialize(tool, configuration)
+      include configuration
+
+      @_tool = tool.to_s
+      @_list = configuration.select{ |c| c.tool?(tool) }
+    end   
+
+    #
+    #
+    #
+    def tool
+      @_tool
+    end
+
+    #
+    #
+    #
+    def [](profile)
+      @_list.select{ |c| c.profile?(profile) }
+    end
+
+    #
+    #
+    #
+    def each(&block)
+      @_list.each(&block)
+    end
+
+    #
+    #
+    #
+    def size
+      @_list.size
+    end
+
+  end
+
+end

data/lib/rc/tweaks/rake.rb

@@ -0,0 +1,28 @@
+require 'rake'
+
+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
+
+module RC
+  class Configuration
+    include Rake::DSL
+  end
+end
+

data/spec/00_concept.md

@@ -0,0 +1,22 @@
+= RC
+
+The purpose of RC is to provide unified configuration management across multiple
+tools for Ruby. The structure of an RC configuration file is very simple.
+It is a ruby script sectioned into named blocks:
+
+  config :rake do
+    # ... rake tasks ...
+  end
+
+  config :vclog do
+    # ... configure vclog ...
+  end
+
+Utilization of the these configurations may be handled by the consuming 
+application, but can be used by any tool if `rc` is loaded via RUBYOPT.
+
+To work with RC in this specification, we want to avoid the automatic
+bootstrap, so we load the `interface` script instead.
+
+  require 'rc/interface'
+

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', 'bar') do
+      :baz
+    end
+
+    config.tool          #=> :foo
+    config.profile       #=> :bar
+    config.to_proc.call  #=> :baz
+
+

data/spec/02_configuration.md

@@ -0,0 +1,65 @@
+# 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.instance_eval(<<-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  #=> nil
+    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.instance_eval(<<-HERE)
+      config :sample2, :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.instance_eval(<<-HERE)
+      profile :opt1 do
+        config :sample2 do
+          "block code"
+        end
+      end
+    HERE
+
+    sample = rc.configurations.last
+    sample.tool     #=> :sample2
+    sample.profile  #=> :opt1
+
+RC also support YAML-based configuration, if the last argument is
+a multi-line string it will create a block using `YAML.load`.
+
+    rc.instance_eval(<<-HERE)
+      config :sample3, %{
+        ---
+        note: This is the note.
+      }
+    HERE
+
+    sample = rc.configurations.last
+    sample.tool        #=> :sample3
+    sample.profile     #=> nil
+    sample.call.assert == {'note'=>'This is the note.'}
+

data/spec/03_import.md

@@ -0,0 +1,48 @@
+# 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.size.assert == 1
+
+The configuration can also be imported from a different profile.
+
+    rc.config :qed, :coverage, :from=>'qed', :profile=>:simplecov
+
+    rc.size.assert == 2
+
+Although it will rarely be useful, it may also be imported from another tool.
+
+    rc.config :example, :from=>'qed', :tool=>: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.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,36 @@
+# 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, :something do
+      "example config using profile"
+    end
+
+To get the configuration of the current project --relative to the 
+current working directory, we can 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 `profiles`
+method.
+
+    RC.profiles(:example)
+
+The number of configurations in the current project can be had via
+the `size` method. (This is the number of configurations we have
+defined in our test fixture.)
+
+    RC.configuration.configurations.size.assert == 2
+

data/spec/applique/ae.rb

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

data/spec/applique/file.rb

@@ -0,0 +1,8 @@
+require 'rc/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
+

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: rc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: finder
+  requirement: &8666580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *8666580
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &8663120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *8663120
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &6999260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6999260
+- !ruby/object:Gem::Dependency
+  name: ae
+  requirement: &6997500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *6997500
+description: ! "RC is a multi-tenant configuration system for Ruby projects.\nIt is
+  a spin-off of the original Confection project with\na simplifed overall design and
+  the ability to work with \nalmost any Ruby-based command line tool."
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- NOTES.md
+- HISTORY.md
+- README.md
+files:
+- .ruby
+- .yardopts
+- lib/c.rb
+- lib/rc/config.rb
+- lib/rc/configuration.rb
+- lib/rc/core_ext.rb
+- lib/rc/interface.rb
+- lib/rc/properties.rb
+- lib/rc/tool_configuration.rb
+- lib/rc/tweaks/rake.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
+- NOTES.md
+- LICENSE.txt
+- HISTORY.md
+- README.md
+- Config.rb
+homepage: http://rubyworks.github.com/rc
+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: Multi-tenant configuration for Ruby.
+test_files: []