ahoward-configuration 1.0.0

data/README

@@ -0,0 +1,186 @@
+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
+
+  ~ > 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
+
+  ~ > 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
+
+  ~ > 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
+
+  ~ > ruby samples/d.rb
+
+    42
+    "forty-two"
+    42.0
+
+
+  <========< samples/e.rb >========>
+
+  ~ > cat samples/e.rb
+
+    #
+    # configuration.rb uses a totally clean slate dsl for the block.  if you need
+    # to access base Object methods you can do this
+    #
+    
+      require 'configuration'
+    
+      c = Configuration.for 'e'
+    
+      p c.foo
+      p c.bar
+      p c.foobar
+
+  ~ > ruby samples/e.rb
+
+    42
+    "forty-two"
+    42.0
+
+
+
+AUTHOR
+  ara.t.howard@gmail.com

data/README.erb

@@ -0,0 +1,69 @@
+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 %>
+
+AUTHOR
+  ara.t.howard@gmail.com

data/Rakefile

@@ -0,0 +1,241 @@
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "http://github.com/ahoward/#{ This.lib }/tree/master"
+This.rubyforge_project = 'codeforpeople'
+
+task :default do
+  puts(Rake::Task.tasks.map{|task| task.name} - ['default'])
+end
+
+task :spec do
+  require 'spec/rake/spectask'
+  Spec::Rake::SpecTask.new do |t|
+    t.spec_files = FileList['spec/*_spec.rb']
+  end
+end
+
+task :gemspec do
+  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
+  ignore_directories = 'pkg'
+  ignore_files = 'test/log'
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+
+  extensions = This.extensions
+  if extensions.nil?
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## #{ lib }.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = #{ lib.inspect }
+            spec.version = #{ version.inspect }
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = #{ lib.inspect }
+
+            spec.files = #{ files.inspect }
+            spec.executables = #{ executables.inspect }
+            
+            <% if test(?d, 'lib') %>
+            spec.require_path = "lib"
+            <% end %>
+
+            spec.has_rdoc = #{ has_rdoc.inspect }
+            spec.test_files = #{ test_files.inspect }
+            #spec.add_dependency 'lib', '>= version'
+            #spec.add_dependency 'fattr'
+
+            spec.extensions.push(*#{ extensions.inspect })
+
+            spec.rubyforge_project = #{ This.rubyforge_project.inspect }
+            spec.author = #{ This.author.inspect }
+            spec.email = #{ This.email.inspect }
+            spec.homepage = #{ This.homepage.inspect }
+          end
+        __
+      }
+    end
+
+  open("#{ lib }.gemspec", "w"){|fd| fd.puts template}
+  This.gemspec = "#{ lib }.gemspec"
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p This.pkgdir
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv gem, This.pkgdir
+  This.gem = File.basename(gem)
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -Ilib -Iconfig #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'readme.erb')
+      Template{ IO.read('readme.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
+  puts cmd
+  system cmd
+end
+
+
+
+
+
+BEGIN {
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+
+  Fu = FileUtils
+
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd)
+  end
+  This.lib = lib
+
+  version = ENV['VERSION']
+  unless version
+    name = lib.capitalize
+    library = "./lib/#{ lib }.rb"
+    program = "./bin/#{ lib }"
+    if test(?e, library)
+      require library
+      version = eval(name).send(:version)
+    elsif test(?e, program)
+      version = `#{ program } --version`.strip
+    end
+    abort('no version') if(version.nil? or version.empty?)
+  end
+  This.version = version
+
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each do |line|
+      next if line =~ %r/^\s*$/
+      indent = line[%r/^\s*/] and break
+    end
+    indent ? s.gsub(%r/^#{ indent }/, "") : s
+  end
+    extend self
+  end
+
+  class Template
+    def initialize(&block)
+      @block = block
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result(b||@block)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+  Dir.chdir(This.dir)
+}

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/config/e.rb

@@ -0,0 +1,13 @@
+Configuration.for('e'){
+  foo 42
+
+  if Send('respond_to?', 'foo')
+    bar 'forty-two'
+  end
+
+  respond_to = Method('bar')
+
+  if respond_to.call('bar')
+    foobar 42.0 
+  end
+}

data/configuration.gemspec

@@ -0,0 +1,28 @@
+## configuration.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "configuration"
+  spec.version = "1.0.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "configuration"
+
+  spec.files = ["config", "config/a.rb", "config/b.rb", "config/c.rb", "config/d.rb", "config/e.rb", "configuration.gemspec", "lib", "lib/configuration.rb", "Rakefile", "README", "README.erb", "samples", "samples/a.rb", "samples/b.rb", "samples/c.rb", "samples/d.rb", "samples/e.rb"]
+  spec.executables = []
+  
+  
+  spec.require_path = "lib"
+  
+
+  spec.has_rdoc = true
+  spec.test_files = nil
+  #spec.add_dependency 'lib', '>= version'
+  #spec.add_dependency 'fattr'
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://github.com/ahoward/configuration/tree/master"
+end

data/lib/configuration.rb

@@ -0,0 +1,176 @@
+class Configuration
+  Configuration::Version = '1.0.0'
+  def Configuration.version() Configuration::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 Send(m, *a, &b)
+      Method(m).call(*a, &b)
+    end
+
+    def Method m
+      @__configuration.method(m)
+    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 __configuration__
+      @__configuration
+    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

data/samples/e.rb

@@ -0,0 +1,12 @@
+#
+# configuration.rb uses a totally clean slate dsl for the block.  if you need
+# to access base Object methods you can do this
+#
+
+  require 'configuration'
+
+  c = Configuration.for 'e'
+
+  p c.foo
+  p c.bar
+  p c.foobar

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: ahoward-configuration
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ara T. Howard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 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
+- config/e.rb
+- configuration.gemspec
+- lib
+- lib/configuration.rb
+- Rakefile
+- README
+- README.erb
+- samples
+- samples/a.rb
+- samples/b.rb
+- samples/c.rb
+- samples/d.rb
+- samples/e.rb
+has_rdoc: true
+homepage: http://github.com/ahoward/configuration/tree/master
+licenses: 
+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: codeforpeople
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: configuration
+test_files: []
+