confection 0.0.1

data/.ruby

@@ -0,0 +1,43 @@
+---
+source:
+- profile
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2011'
+  license: BSD-2-Clause
+replacements: []
+alternatives: []
+requirements:
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: qed
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/confection.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/confection
+  code: http://github.com/rubyworks/confection
+  mail: http://groups.google.com/group/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+created: '2011-11-06'
+summary: Multi-tenant configuration for Ruby
+title: Confection
+version: 0.0.1
+name: confection
+description: Confection is a multi-tenant configuration system for Ruby projects.
+organization: Rubyworks
+date: '2011-11-07'

data/COPYING.rdoc

@@ -0,0 +1,31 @@
+= COPYRIGHT NOTICES
+
+== Confection
+
+Copyright:: (c) 2011 Rubyworks
+License:: BSD-2-Clause
+Website:: http://rubyworks.github.com/tapout
+
+    Copyright 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/HISTORY.rdoc

@@ -0,0 +1,10 @@
+= RELEASE HISTORY
+
+== 0.0.1 / 2011-11-06
+
+This is the initial release of Confection.
+
+Changes:
+
+* Happy 1st Release!
+

data/README.rdoc

@@ -0,0 +1,80 @@
+= Confection
+
+{Homepage}[http://rubyworks.github.com/confection] |
+{Source Code}[http://github.com/rubyworks/confection] |
+{Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
+
+{<img src="http://travis-ci.org/rubyworks/confection.png" />}[http://travis-ci.org/rubyworks/confection]
+
+
+== Description
+
+Confection is multi-tenant configuration system for Ruby projects. If was 
+designed to faciliate Ruby-based configuration for multiple tools in a
+single file. If is extremely simple, which makes it easy to understand
+and flexible in use.
+
+
+== Synopsis
+
+Create a file in you project called `.co.rb`. In it, add configuration blocks
+by name. As an example let's demonstrate how we could use this for Rake tasks.
+
+  $ cat .co.rb
+  rake do
+    desc 'generate yard docs'
+    task :yard do
+      sh 'yard'
+    end
+  end
+
+In our Rakefile:
+
+  $ cat Rakefile
+  require 'confection'
+  confection(:rake).call
+
+Now you might wonder why the heck you would do this. That's where the
+ *multi-tenancy* comes into play. Let's add another configuration. This time
+for a tool that has native support for Confection.
+
+  $ cat .confection
+  title = "myapp"
+
+  rake do
+    desc 'generate yard docs'
+    task :yard do
+      sh "yard doc --title #{title}"
+    end
+  end
+
+  qed do |config|
+    config.title = "#{title} Demonstrandum"
+  end
+
+Now we have configuration for both the rake tool and the qed test tool in
+a single file. Thus we gain the advantage of reducing the file count of our 
+project while pulling our project configuration together into one place.
+Moreover, these configurations can potentially share settings as demonstrated
+here via the `TITLE` constant.
+
+Using Confection in your libraries is very simele. As you can see from our
+example Rakefile the #confection method is used to get a handle on a name
+configuration. With it you have two options, `#call` or `#exec`. The first
+evaluates the configuration block at the toplevel, while the later evaluates
+the block in the context of the caller.
+
+
+== Release Notes
+
+Please see HISTORY.rdoc file.
+
+
+== Copyrights
+
+Copyright (c) 2011 Rubyworks
+
+Confection is distributable in accordance with the terms of the BSD-2-Clause license.
+
+See COPYING.rdoc for detiails.
+

data/lib/confection.rb

@@ -0,0 +1,139 @@
+# Welcome to Confection. Your easy means to tool configuration.
+#
+module Confection
+
+  #
+  FILENAMES = ['.config.rb', 'config.rb']
+
+  # Bootstrap the system, loading current configurations.
+  #
+  def self.bootstrap
+    begin
+      ::Kernel.eval(read, Evaluator.binding, file)
+    rescue => e
+      raise e if $DEBUG
+      abort e.message
+    end
+  end
+
+  # Stores the configuration blocks.
+  #
+  # @return [Hash] configuration store
+  def self.config
+    @config ||= {}
+  end
+
+  # Look-up configuration block.
+  #
+  # @param name [Symbol,String]
+  #   The identifying name for the config block.
+  #
+  def self.[](name)
+    config[name.to_sym]
+  end
+
+  # Set configuration block.
+  #
+  # @param name [Symbol,String]
+  #   The identifying name for the config block.
+  #
+  # @param block [Proc]
+  #   Code block for configuration.
+  #
+  # @return [Proc] code block
+  def self.[]=(name, block)
+    config[name.to_sym] = block.to_proc
+  end
+
+  # Read config file.
+  #
+  # @return [String] contents of the `.co.rb` file
+  def self.read
+    File.read(file)
+  end
+
+  # Find config file by looking up the '.co.rb' file.
+  #
+  # @param dir [String]
+  #   Optional directory to begin search.
+  #
+  # @return [String] file path
+  def self.file(dir=nil)
+    @file ||= (
+      file = nil
+      dir  = dir || Dir.pwd
+      while dir != '/'
+        FILENAMES.each do |fname|
+          f = File.join(dir, fname)
+          break(file = f) if File.exist?(f)
+        end
+        dir = File.dirname(dir)
+      end
+      file
+    )
+  end
+
+  # Root directory, where config file is located.
+  #
+  # @param dir [String]
+  #   Optional directory to begin search.
+  #
+  # @return [String] directory path
+  def self.root(dir=nil)
+    f = file(dir)
+    f ? File.dirname(f) : nil
+  end
+
+  # The Evaluator class is used to evaluate the `.co.rb` file.
+  #
+  class Evaluator < Module #BasicObject
+    def self.binding
+      new.__binding__
+    end
+    def __binding__ 
+      ::Kernel.binding
+    end
+    def method_missing(sym, *args, &block)
+      #def block.call
+      #  ::Kernel.eval('self',::TOPLEVEL_BINDING).instance_exec(&self)
+      #end
+      ::Confection[sym] = block
+    end
+  end
+
+  # The Controller class is used to encapsulate the two types of invocation
+  # that are posible on configuration blocks.
+  #
+  class Controller
+    def initialize(block, &exec_block)
+      @block      = block
+      @exec_block = exec_block
+    end
+    def exec(*args)
+      @exec_block.call(*args)
+    end
+    def call(*args)
+      ::Kernel.eval('self',::TOPLEVEL_BINDING).instance_exec(*args, &@block)
+    end
+  end
+
+end
+
+# Confection's primary use method.
+#
+# @return [Confection::Controller] config controller
+def confection(name, *args)
+  config_block = Confection[name.to_sym]
+  if config_block
+    Confection::Controller.new(config_block) do |*args|
+      instance_exec *args, &config_block
+    end
+  else
+    warn "no configuration -- `#{name}'"
+  end
+end
+
+# Load configuration.
+Confection.bootstrap #(self)
+
+# Copyright (c) 2011 Rubyworks (BSD-2-Clause)

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: confection
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: &26027680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26027680
+- !ruby/object:Gem::Dependency
+  name: qed
+  requirement: &26026820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *26026820
+description: Confection is a multi-tenant configuration system for Ruby projects.
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- HISTORY.rdoc
+- README.rdoc
+- COPYING.rdoc
+files:
+- .ruby
+- lib/confection.rb
+- HISTORY.rdoc
+- README.rdoc
+- COPYING.rdoc
+homepage: http://rubyworks.github.com/confection
+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.10
+signing_key: 
+specification_version: 3
+summary: Multi-tenant configuration for Ruby
+test_files: []