configuration 0.0.3

data/README

@@ -0,0 +1,210 @@
+NAME
+  configuration.rb
+
+SYNOPSIS
+  pure ruby scoped configuration files
+
+DESCRIPTION
+  configuration.rb provides a mechanism for configuring ruby programs with
+  ruby configuration files.  a configuration.rb file, for example
+  'config/app.rb', can be written simply as
+
+      Configuration.for('app'){
+        key 'value'
+        foo 'bar'
+        port 42
+      }
+  
+  and loaded via the normal ruby require/load mechanism
+
+      Kernel.load 'config/app.rb'
+  
+  or with a slightly augmented loading mechnanism which simply searches an
+  extra set of paths in *addition* to the standard ones
+
+      Configuration.path = %w( config configuration )
+
+      Configuration.load 'app'
+
+  configurations are completely open
+
+      Configuration.for('app'){
+        object_id 'very open'
+      }
+
+  support arbitrarily nested values
+
+      Configuration.for('app'){
+        a { b { c { d 42 } } }
+      }
+
+      c = Configuration.for 'app'
+
+      p c.a.b.c.d #=> 42
+
+  allow POLS scoped lookup of vars
+
+    Configuration.for('config'){
+      outer 'bar'
+
+      inner {
+        value 42
+      }
+    }
+
+    c = Configuration.for 'config'
+
+    p c.outer       #=> 'bar'
+    p c.inner.value #=> 42
+    p c.inner.outer #=> 'bar' 
+  
+
+  and not a whole lot else - configuration.rb is s very small library
+  consisting of one file and < 150 loc
+
+SAMPLES
+
+  <========< samples/a.rb >========>
+
+  ~ > cat samples/a.rb
+
+    #
+    # basic usage is quite, simple, load the config and use it's values.  the
+    # config syntax is fairly obvious, i think, but note that it *is* ruby and any
+    # ruby can be included.  also note that each config is named, allowing
+    # multiple configs to be places in one file 
+    #
+      require 'configuration'
+     
+      c = Configuration.load 'a'
+    
+      p c.a + c.b - c.c
+
+  ~ > cat config/a.rb
+
+    Configuration.for('a'){
+      a 40
+      b 4
+      c 2
+    }
+
+  ~ > ruby samples/a.rb
+
+    42
+
+
+  <========< samples/b.rb >========>
+
+  ~ > cat samples/b.rb
+
+    #
+    # configuration.rb supports a very natural nesting syntax.  note how values
+    # are scoped in a POLS fashion
+    #
+      require 'configuration'
+    
+      c = Configuration.for 'b' 
+    
+      p c.www.url
+      p c.db.url
+      p c.mail.url
+
+  ~ > cat config/b.rb
+
+    Configuration.for('b'){
+      host "codeforpeople.com"
+    
+      www {
+        port 80
+        url "http://#{ host }:#{ port }"
+      }
+    
+      db {
+        port 5342 
+        url "db://#{ host }:#{ port }"
+      }
+    
+      mail {
+        host "gmail.com"
+        port 25 
+        url "mail://#{ host }:#{ port }"
+      }
+    }
+
+  ~ > ruby samples/b.rb
+
+    "http://codeforpeople.com:80"
+    "db://codeforpeople.com:5342"
+    "mail://gmail.com:25"
+
+
+  <========< samples/c.rb >========>
+
+  ~ > cat samples/c.rb
+
+    #
+    # configuration.rb let's you keep code very dry.
+    #
+    
+      require 'configuration'
+    
+      Configuration.load 'c'
+    
+      p Configuration.for('development').db
+      p Configuration.for('production').db
+      p Configuration.for('testing').db
+
+  ~ > cat config/c.rb
+
+    %w( development production testing ).each do |environment|
+    
+      Configuration.for(environment){
+        adapter "sqlite3"
+        db "db/#{ environment }"
+      }
+    
+    end
+
+  ~ > ruby samples/c.rb
+
+    "db/development"
+    "db/production"
+    "db/testing"
+
+
+  <========< samples/d.rb >========>
+
+  ~ > cat samples/d.rb
+
+    #
+    # configuration.rb makes use of an external blank slate dsl, this means that
+    # you Configuration objects do, in fact, have all built-in ruby methods such
+    # as #inspect, etc, *unless* you configure over the top of them.  the effect
+    # is a configuration object that behaves like a nice ruby object, but which
+    # allows *any* key to be configured
+    #
+      require 'configuration'
+    
+      c = Configuration.for 'd' 
+    
+      p c.object_id
+      p c.inspect
+      p c.p
+
+  ~ > cat config/d.rb
+
+    Configuration.for('d'){
+      object_id 42
+      inspect 'forty-two'
+      p 42.0
+    }
+
+  ~ > ruby samples/d.rb
+
+    42
+    "forty-two"
+    42.0
+
+
+AUTHOR
+  ara.t.howard@gmail.com

data/config/a.rb

@@ -0,0 +1,5 @@
+Configuration.for('a'){
+  a 40
+  b 4
+  c 2
+}

data/config/b.rb

@@ -0,0 +1,19 @@
+Configuration.for('b'){
+  host "codeforpeople.com"
+
+  www {
+    port 80
+    url "http://#{ host }:#{ port }"
+  }
+
+  db {
+    port 5342 
+    url "db://#{ host }:#{ port }"
+  }
+
+  mail {
+    host "gmail.com"
+    port 25 
+    url "mail://#{ host }:#{ port }"
+  }
+}

data/config/c.rb

@@ -0,0 +1,8 @@
+%w( development production testing ).each do |environment|
+
+  Configuration.for(environment){
+    adapter "sqlite3"
+    db "db/#{ environment }"
+  }
+
+end

data/config/d.rb

@@ -0,0 +1,5 @@
+Configuration.for('d'){
+  object_id 42
+  inspect 'forty-two'
+  p 42.0
+}

data/gemspec.rb

@@ -0,0 +1,35 @@
+lib, version = File::basename(File::dirname(File::expand_path(__FILE__))).split %r/-/, 2
+
+require 'rubygems'
+
+Gem::Specification::new do |spec|
+  $VERBOSE = nil
+
+  shiteless = lambda do |list|
+    list.delete_if do |file|
+      file =~ %r/\.svn/ or
+      file =~ %r/\.tmp/
+    end
+  end
+
+  spec.name = lib 
+  spec.version = version 
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = lib 
+
+  spec.files = shiteless[Dir::glob("**/**")]
+  spec.executables = shiteless[Dir::glob("bin/*")].map{|exe| File::basename exe}
+  
+  spec.require_path = "lib" 
+  spec.autorequire = lib
+
+  spec.has_rdoc = File::exist? "doc" 
+  spec.test_suite_file = "test/#{ lib }.rb" if File::directory? "test"
+  #spec.add_dependency 'lib', '>= version'
+
+  spec.extensions << "extconf.rb" if File::exists? "extconf.rb"
+
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://codeforpeople.com/lib/ruby/#{ lib }/"
+end

data/gen_readme.rb

@@ -0,0 +1,37 @@
+require 'pathname'
+
+$VERBOSE=nil
+
+def indent s, n = 2
+  ws = ' ' * n
+  s.gsub %r/^/, ws 
+end
+
+template = IO::read 'README.tmpl'
+
+samples = ''
+prompt = '~ > '
+
+Dir['sample*/*'].sort.each do |sample|
+  config = sample.gsub(%r/samples?/, 'config') 
+  samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+  cmd = "cat #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+  samples << indent(`#{ cmd }`, 4) << "\n" 
+
+  cmd = "cat #{ config }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+  samples << indent(`#{ cmd }`, 4) << "\n" 
+
+  cmd = "ruby #{ sample }" 
+  samples << indent(prompt + cmd, 2) << "\n\n" 
+
+  cmd = "ruby -Ilib -Iconfig #{ sample }" 
+  samples << indent(`#{ cmd } 2>&1`, 4) << "\n" 
+end
+
+#samples.gsub! %r/^/, '  '
+
+readme  = template.gsub %r/^\s*@samples\s*$/, samples
+print readme 

data/install.rb

@@ -0,0 +1,214 @@
+#!/usr/bin/env ruby
+require 'rbconfig'
+require 'find'
+require 'ftools'
+require 'tempfile'
+include Config
+
+LIBDIR      = "lib"
+LIBDIR_MODE = 0644
+
+BINDIR      = "bin"
+BINDIR_MODE = 0755
+
+
+$srcdir            = CONFIG["srcdir"]
+$version           = CONFIG["MAJOR"]+"."+CONFIG["MINOR"]
+$libdir            = File.join(CONFIG["libdir"], "ruby", $version)
+$archdir           = File.join($libdir, CONFIG["arch"])
+$site_libdir       = $:.find {|x| x =~ /site_ruby$/}
+$bindir            = CONFIG["bindir"] || CONFIG['BINDIR']
+$ruby_install_name = CONFIG['ruby_install_name'] || CONFIG['RUBY_INSTALL_NAME'] || 'ruby'
+$ruby_ext          = CONFIG['EXEEXT'] || ''
+$ruby              = File.join($bindir, ($ruby_install_name + $ruby_ext))
+
+if !$site_libdir
+  $site_libdir = File.join($libdir, "site_ruby")
+elsif $site_libdir !~ %r/#{Regexp.quote($version)}/
+  $site_libdir = File.join($site_libdir, $version)
+end
+
+def install_rb(srcdir=nil, destdir=nil, mode=nil, bin=nil)
+#{{{
+  path   = []
+  dir    = []
+  Find.find(srcdir) do |f|
+    next unless FileTest.file?(f)
+    next if (f = f[srcdir.length+1..-1]) == nil
+    next if (/CVS$/ =~ File.dirname(f))
+    next if (/\.svn/ =~ File.dirname(f))
+    next if f =~ %r/\.lnk/
+    next if f =~ %r/\.svn/
+    next if f =~ %r/\.swp/
+    next if f =~ %r/\.svn/
+    path.push f
+    dir |= [File.dirname(f)]
+  end
+  for f in dir
+    next if f == "."
+    next if f == "CVS"
+    File::makedirs(File.join(destdir, f))
+  end
+  for f in path
+    next if (/\~$/ =~ f)
+    next if (/^\./ =~ File.basename(f))
+    unless bin
+      File::install(File.join(srcdir, f), File.join(destdir, f), mode, true)
+    else
+      from = File.join(srcdir, f)
+      to = File.join(destdir, f)
+      shebangify(from) do |sf|
+        $deferr.print from, " -> ", File::catname(from, to), "\n"
+        $deferr.printf "chmod %04o %s\n", mode, to 
+        File::install(sf, to, mode, false)
+      end
+    end
+  end
+#}}}
+end
+def shebangify f
+#{{{
+  open(f) do |fd|
+    buf = fd.read 42 
+    if buf =~ %r/^\s*#\s*!.*ruby/o
+      ftmp = Tempfile::new("#{ $$ }_#{ File::basename(f) }")
+      begin
+        fd.rewind
+        ftmp.puts "#!#{ $ruby  }"
+        while((buf = fd.read(8192)))
+          ftmp.write buf
+        end
+        ftmp.close
+        yield ftmp.path
+      ensure
+        ftmp.close!
+      end
+    else
+      yield f
+    end
+  end
+#}}}
+end
+def ARGV.switch
+#{{{
+  return nil if self.empty?
+  arg = self.shift
+  return nil if arg == '--'
+  if arg =~ /^-(.)(.*)/
+    return arg if $1 == '-'
+    raise 'unknown switch "-"' if $2.index('-')
+    self.unshift "-#{$2}" if $2.size > 0
+    "-#{$1}"
+  else
+    self.unshift arg
+    nil
+  end
+#}}}
+end
+def ARGV.req_arg
+#{{{
+  self.shift || raise('missing argument')
+#}}}
+end
+def linkify d, linked = []
+#--{{{
+  if test ?d, d
+    versioned = Dir[ File::join(d, "*-[0-9].[0-9].[0-9].rb") ]
+    versioned.each do |v| 
+      src, dst = v, v.gsub(%r/\-[\d\.]+\.rb$/, '.rb')
+      lnk = nil
+      begin
+        if test ?l, dst
+          lnk = "#{ dst }.lnk"
+          puts "#{ dst } -> #{ lnk }"
+          File::rename dst, lnk
+        end
+        unless test ?e, dst
+          puts "#{ src } -> #{ dst }"
+          File::copy src, dst 
+          linked << dst
+        end
+      ensure
+        if lnk
+          at_exit do
+            puts "#{ lnk } -> #{ dst }"
+            File::rename lnk, dst
+          end
+        end
+      end
+    end
+  end
+  linked
+#--}}}
+end
+
+
+#
+# main program
+#
+
+libdir = $site_libdir
+bindir = $bindir
+no_linkify = false
+linked = nil
+help = false
+
+usage = <<-usage
+  #{ File::basename $0 }
+    -d, --destdir    <destdir>
+    -l, --libdir     <libdir>
+    -b, --bindir     <bindir>
+    -r, --ruby       <ruby>
+    -n, --no_linkify
+    -s, --sudo
+    -h, --help
+usage
+
+begin
+  while switch = ARGV.switch
+    case switch
+    when '-d', '--destdir'
+      libdir = ARGV.req_arg
+    when '-l', '--libdir'
+      libdir = ARGV.req_arg
+    when '-b', '--bindir'
+      bindir = ARGV.req_arg
+    when '-r', '--ruby'
+      $ruby = ARGV.req_arg
+    when '-n', '--no_linkify'
+      no_linkify = true
+    when '-s', '--sudo'
+      sudo = 'sudo' 
+    when '-h', '--help'
+      help = true
+    else
+      raise "unknown switch #{switch.dump}"
+    end
+  end
+rescue
+  STDERR.puts $!.to_s
+  STDERR.puts usage
+  exit 1
+end    
+
+if help
+  STDOUT.puts usage
+  exit
+end
+
+system "#{ sudo } #{ $ruby } pre-install.rb" if test(?s, 'pre-install.rb')
+
+unless no_linkify
+  linked = linkify('lib') + linkify('bin')
+end
+
+system "#{ $ruby } extconf.rb && make && #{ sudo } make install" if test(?s, 'extconf.rb')
+
+install_rb(LIBDIR, libdir, LIBDIR_MODE)
+install_rb(BINDIR, bindir, BINDIR_MODE, bin=true)
+
+if linked
+  linked.each{|path| File::rm_f path}
+end
+
+system "#{ sudo } #{ $ruby } post-install.rb" if test(?s, 'post-install.rb')

data/lib/configuration.rb

@@ -0,0 +1,165 @@
+
+class Configuration
+  Version = '0.0.3'
+  def Configuration.version() Version end
+
+  Path = [
+    if defined? CONFIGURATION_PATH
+      CONFIGURATION_PATH
+    else
+      ENV['CONFIGURATION_PATH']
+    end
+  ].compact.flatten.join(File::PATH_SEPARATOR).split(File::PATH_SEPARATOR)
+
+  Table = Hash.new
+  Error = Class.new StandardError
+  Import = Class.new Error
+
+  module ClassMethods
+    def for name, options = nil, &block
+      name = name.to_s
+      if Table.has_key?(name)
+        if options or block
+          configuration = Table[name]
+          Table[name] = DSL.evaluate(configuration, options || {}, &block)
+        else
+          Table[name]
+        end
+      else
+        if options or block
+          Table[name] = new name, options || {}, &block
+        else
+          load name
+        end
+      end
+    end
+
+    def path *value
+      return self.path = value.first unless value.empty?
+      Path
+    end
+
+    def path= value
+      Path.clear
+      Path.replace [value].compact.flatten.join(File::PATH_SEPARATOR).split(File::PATH_SEPARATOR)
+    end
+
+    def load name
+      name = name.to_s
+      name = name + '.rb' unless name[%r/\.rb$/]
+      key = name.sub %r/\.rb$/, ''
+      load_path = $LOAD_PATH.dup
+      begin
+        $LOAD_PATH.replace(path + load_path)
+        ::Kernel.load name
+      ensure
+        $LOAD_PATH.replace load_path
+      end
+      Table[key]
+    end
+  end
+  send :extend, ClassMethods 
+
+  module InstanceMethods
+    attr 'name'
+
+    def initialize *argv, &block
+      options = Hash === argv.last ? argv.pop : Hash.new
+      @name = argv.shift
+      DSL.evaluate(self, options, &block)
+    end
+
+    def method_missing m, *a, &b
+      return(Pure[@__parent].send m, *a, &b) rescue super if @__parent
+      super
+    end
+  end
+  send :include, InstanceMethods
+
+
+  class DSL
+    instance_methods.each do |m|
+      undef_method m unless m[%r/^__/]
+    end 
+
+    Kernel.methods.each do |m|
+      next if m[%r/^__/]
+      module_eval <<-code
+        def #{ m }(*a, &b)
+          method_missing '#{ m }', *a, &b
+        end
+      code
+    end
+
+    def self.evaluate configuration, options = {}, &block
+      dsl = new configuration
+      Pure[dsl].instance_eval &block if block
+      options.each{|key, value| Pure[dsl].send key, value}
+      Pure[dsl].instance_eval{ @__configuration }
+    end
+
+    def initialize configuration, &block
+      @__configuration = configuration
+      @__singleton_class =
+        class << @__configuration
+          self
+        end
+    end
+
+    def method_missing m, *a, &b
+      if(a.empty? and b.nil?)
+        return Pure[@__configuration].send(m, *a, &b)
+      end
+      if b
+        raise ArgumentError unless a.empty?
+        parent = @__configuration
+        name = m.to_s
+        configuration =
+          if @__configuration.respond_to?(name) and Configuration === @__configuration.send(name)
+            @__configuration.send name 
+          else
+            Configuration.new name
+          end
+        Pure[configuration].instance_eval{ @__parent = parent }
+        DSL.evaluate configuration, &b
+        value = configuration
+      end
+      unless a.empty?
+        value = a.size == 1 ? a.first : a
+      end
+      @__singleton_class.module_eval do
+        define_method(m){ value }
+      end
+    end
+  end
+
+  class Pure 
+    Instance_Methods = Hash.new
+
+    ::Object.instance_methods.each do |m|
+      Instance_Methods[m.to_s] = ::Object.instance_method m
+      undef_method m unless m[%r/^__/]
+    end 
+
+    def method_missing m, *a, &b
+      Instance_Methods[m.to_s].bind(@object).call(*a, &b)
+    end
+
+    def initialize object
+      @object = object
+    end
+
+    def Pure.[] object
+      new object
+    end
+  end
+end
+
+def Configuration(*a, &b)
+  if a.empty? and b.nil?
+    const_get :Configuration
+  else
+    Configuration.new(*a, &b)
+  end
+end
+

data/samples/a.rb

@@ -0,0 +1,11 @@
+#
+# basic usage is quite, simple, load the config and use it's values.  the
+# config syntax is fairly obvious, i think, but note that it *is* ruby and any
+# ruby can be included.  also note that each config is named, allowing
+# multiple configs to be places in one file 
+#
+  require 'configuration'
+ 
+  c = Configuration.load 'a'
+
+  p c.a + c.b - c.c

data/samples/b.rb

@@ -0,0 +1,11 @@
+#
+# configuration.rb supports a very natural nesting syntax.  note how values
+# are scoped in a POLS fashion
+#
+  require 'configuration'
+
+  c = Configuration.for 'b' 
+
+  p c.www.url
+  p c.db.url
+  p c.mail.url

data/samples/c.rb

@@ -0,0 +1,11 @@
+#
+# configuration.rb let's you keep code very dry.
+#
+
+  require 'configuration'
+
+  Configuration.load 'c'
+
+  p Configuration.for('development').db
+  p Configuration.for('production').db
+  p Configuration.for('testing').db

data/samples/d.rb

@@ -0,0 +1,14 @@
+#
+# configuration.rb makes use of an external blank slate dsl, this means that
+# you Configuration objects do, in fact, have all built-in ruby methods such
+# as #inspect, etc, *unless* you configure over the top of them.  the effect
+# is a configuration object that behaves like a nice ruby object, but which
+# allows *any* key to be configured
+#
+  require 'configuration'
+
+  c = Configuration.for 'd' 
+
+  p c.object_id
+  p c.inspect
+  p c.p

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: configuration
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Ara T. Howard
+autorequire: configuration
+bindir: bin
+cert_chain: []
+
+date: 2008-02-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ara.t.howard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- config
+- config/a.rb
+- config/b.rb
+- config/c.rb
+- config/d.rb
+- gemspec.rb
+- gen_readme.rb
+- install.rb
+- lib
+- lib/configuration.rb
+- README
+- samples
+- samples/a.rb
+- samples/b.rb
+- samples/c.rb
+- samples/d.rb
+has_rdoc: false
+homepage: http://codeforpeople.com/lib/ruby/configuration/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: configuration
+test_files: []
+