yacl 1.0.0

data/HISTORY.rdoc

@@ -0,0 +1,5 @@
+= YACL Changlog
+== Version 1.0.0
+
+* Initial Release - Yeah!
+

data/LICENSE

@@ -0,0 +1,16 @@
+ISC LICENSE - http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2012 Jeremy Hinegardner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/Manifest.txt

@@ -0,0 +1,48 @@
+HISTORY.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+example/myapp-simple/bin/myapp
+example/myapp-simple/config/database.yml
+example/myapp-simple/config/host.yml
+example/myapp-simple/config/pipeline.yml
+example/myapp-simple/lib/myapp.rb
+example/myapp/bin/myapp
+example/myapp/bin/myapp-job
+example/myapp/config/database.yml
+example/myapp/config/httpserver.yml
+example/myapp/config/pipeline.yml
+example/myapp/lib/myapp.rb
+example/myapp/lib/myapp/cli.rb
+example/myapp/lib/myapp/defaults.rb
+example/myapp/lib/myapp/job.rb
+lib/yacl.rb
+lib/yacl/define.rb
+lib/yacl/define/cli.rb
+lib/yacl/define/cli/options.rb
+lib/yacl/define/cli/parser.rb
+lib/yacl/define/cli/runner.rb
+lib/yacl/define/defaults.rb
+lib/yacl/define/plan.rb
+lib/yacl/loader.rb
+lib/yacl/loader/env.rb
+lib/yacl/loader/yaml_dir.rb
+lib/yacl/loader/yaml_file.rb
+lib/yacl/properties.rb
+lib/yacl/simple.rb
+spec/data/yaml_dir/database.yml
+spec/data/yaml_dir/httpserver.yml
+spec/define/cli/options_spec.rb
+spec/define/cli/parser_spec.rb
+spec/define/cli/runner_spec.rb
+spec/define/defaults_spec.rb
+spec/define/plan_spec.rb
+spec/loader/env_spec.rb
+spec/loader/yaml_dir_spec.rb
+spec/loader/yaml_file_spec.rb
+spec/loader_spec.rb
+spec/properties_spec.rb
+spec/simple_spec.rb
+spec/spec_helper.rb
+spec/version_spec.rb

data/README.rdoc

@@ -0,0 +1,55 @@
+== YACL
+
+* Homepage[https://github.com/copiousfreetime/yacl/]
+* {Github Project}[https://github.com/copiousfreetime/yacl]
+* email jeremy at hinegardner dot org
+
+== DESCRIPTION
+
+YACL is your application configuration library.
+
+== FEATURES
+
+Yacl is a full featured commandline and application configuration library. It
+pulls together the different components of a system that provide application
+configuration properties:
+
+* Commandline options
+* Environment Variables
+* Configuration directory
+* Configuration files
+* Global Defaults
+
+It allows you to define the order and priority of the various contributors to
+the configuration in a fairly easy way.
+
+== Examples
+
+There are two full examples in the examples directory:
+
+myapp-simple:: This uses the Yacl::Simple library to quickly define
+               commandline options, global defaults, configuration directory and
+               environment parsing all in short amout of code using a dsl.
+myapp::        This is a more full featured approach that you may want to look
+               at should you have more complex application configuration needs.
+               Functionally it is very similar to myapp-simple
+
+== ISC LICENSE
+
+http://opensource.org/licenses/isc-license.txt
+
+Copyright (c) 2012 Jeremy Hinegardner
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/Rakefile

@@ -0,0 +1,308 @@
+# vim: syntax=ruby
+
+This.name     = "yacl"
+This.author   = "Jeremy Hinegardner"
+This.email    = "jeremy@copiousfreetime.org"
+This.homepage = "http://github.com/copiousfreetime/#{ This.name }"
+This.version  = Util.version
+
+#------------------------------------------------------------------------------
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
+#------------------------------------------------------------------------------
+namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
+  task :default do
+    require 'rubygems/dependency_installer'
+    installer = Gem::DependencyInstaller.new
+
+    # list these here instead of gem dependencies since there is not a way to
+    # specify ruby version specific dependencies
+    if RUBY_VERSION < "1.9.2"
+      Util.platform_gemspec.add_development_dependency( 'rcov', '~> 0.9.11' )
+    else
+      Util.platform_gemspec.add_development_dependency( 'simplecov', '~> 0.6.4' )
+    end
+
+    puts "Installing gem depedencies needed for development"
+    Util.platform_gemspec.dependencies.each do |dep|
+      if dep.matching_specs.empty? then
+        puts "Installing : #{dep}"
+        installer.install dep
+      else
+        puts "Skipping   : #{dep} -> already installed #{dep.matching_specs.first.full_name}"
+      end
+    end
+    puts "\n\nNow run 'rake test'"
+  end
+
+  # Create a Gemfile that just references the gemspec
+  file 'Gemfile' => :gemspec do
+    File.open( "Gemfile", "w+" ) do |f|
+      f.puts 'source :rubygems'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :using_bundler => 'Gemfile' do
+    puts "Now you can 'bundle'"
+  end
+
+  # Gemfiles are build artifacts
+  CLOBBER << FileList['Gemfile*']
+end
+desc "Boostrap development"
+task :develop => "develop:default"
+
+#------------------------------------------------------------------------------
+# Minitest - standard TestTask
+#------------------------------------------------------------------------------
+begin
+  require 'rake/testtask'
+  Rake::TestTask.new( :test ) do |t|
+    t.ruby_opts    = %w[ -w -rubygems ]
+    t.libs         = %w[ lib spec ]
+    t.pattern      = "spec/**/*_spec.rb"
+  end
+  task :default => :test
+rescue LoadError
+  Util.task_warning( 'test' )
+end
+
+#------------------------------------------------------------------------------
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
+#------------------------------------------------------------------------------
+begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
+  require 'rdoc/task'
+  RDoc::Task.new do |t|
+    t.markup   = 'tomdoc'
+    t.rdoc_dir = 'doc'
+    t.main     = 'README.rdoc'
+    t.title    = "#{This.name} #{This.version}"
+    t.rdoc_files.include( '*.rdoc', 'lib/**/*.rb' )
+  end
+rescue LoadError => le
+  Util.task_warning( 'rdoc' )
+end
+
+#------------------------------------------------------------------------------
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
+#------------------------------------------------------------------------------
+if RUBY_VERSION <= "1.9.2"
+  begin
+   require 'rcov/rcovtask'
+   Rcov::RcovTask.new( 'coverage' ) do |t|
+     t.libs      << 'spec'
+     t.pattern   = 'spec/**/*_spec.rb'
+     t.verbose   = true
+     t.rcov_opts << "-x ^/"           # remove all the global files
+     t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+   end
+  rescue LoadError
+   Util.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc 'Run tests with code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+    CLOBBER << FileList["coverage"]
+  rescue LoadError
+    Util.task_warning( 'simplecov' )
+  end
+end
+#------------------------------------------------------------------------------
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
+#------------------------------------------------------------------------------
+namespace 'manifest' do
+  desc "Check the manifest"
+  task :check => :clean do
+    files = FileList["**/*", ".*"].exclude( This.exclude_from_manifest ).to_a.sort
+    files = files.select{ |f| File.file?( f ) }
+
+    tmp = "Manifest.tmp"
+    File.open( tmp, 'w' ) do |f|
+      f.puts files.join("\n")
+    end
+
+    begin
+      sh "diff -du Manifest.txt #{tmp}"
+    ensure
+      rm tmp
+    end
+    puts "Manifest looks good"
+  end
+
+  desc "Generate the manifest"
+  task :generate => :clean do
+    files = %x[ git ls-files ].split("\n").sort
+    files.reject! { |f| f =~ This.exclude_from_manifest }
+    File.open( "Manifest.txt", "w" ) do |f|
+      f.puts files.join("\n")
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# Gem Specification
+#------------------------------------------------------------------------------
+This.gemspec = Hash.new
+This.gemspec['ruby'] = Gem::Specification.new do |spec|
+  spec.name        = This.name
+  spec.version     = This.version
+  spec.author      = This.author
+  spec.email       = This.email
+  spec.homepage    = This.homepage
+
+  spec.summary     = This.summary
+  spec.description = This.description
+
+  spec.files       = This.manifest
+  spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
+  spec.test_files  = spec.files.grep(/^spec/)
+
+  spec.extra_rdoc_files += spec.files.grep(/(txt|rdoc)$/)
+  spec.rdoc_options = [ "--main"  , 'README.rdoc', ]
+
+  # The Runtime Dependencies
+  spec.add_dependency( 'map', '~> 6.2.0')
+  spec.add_dependency( 'trollop', '~> 1.16' )
+
+  # The Development Dependencies
+  spec.add_development_dependency( 'rake'     , '~> 0.9.2.2')
+  spec.add_development_dependency( 'minitest' , '~> 3.3.0' )
+  spec.add_development_dependency( 'rdoc'     , '~> 3.12'   )
+end
+
+
+# The name of the gemspec file on disk
+This.gemspec_file = "#{This.name}.gemspec"
+
+# Really this is only here to support those who use bundler
+desc "Build the #{This.name}.gemspec file"
+task :gemspec do
+  File.open( This.gemspec_file, "wb+" ) do |f|
+    f.write Util.platform_gemspec.to_ruby
+  end
+end
+
+# the gemspec is also a dev artifact and should not be kept around.
+CLOBBER << This.gemspec_file
+
+# The standard gem packaging task, everyone has it.
+require 'rubygems/package_task'
+Gem::PackageTask.new( Util.platform_gemspec ) do
+  # nothing
+end
+
+#------------------------------------------------------------------------------
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
+#------------------------------------------------------------------------------
+task :release_check do
+  unless `git branch` =~ /^\* master$/
+    abort "You must be on the master branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+desc "Create tag v#{This.version}, build and push #{Util.platform_gemspec.full_name} to rubygems.org"
+task :release => [ :release_check, 'manifest:check', :gem ] do
+  sh "git commit --allow-empty -a -m 'Release #{This.version}'"
+  sh "git tag -a -m 'v#{This.version}' v#{This.version}"
+  sh "git push origin master"
+  sh "git push origin v#{This.version}"
+  sh "gem push pkg/#{Util.platform_gemspec.full_name}.gem"
+end
+
+#------------------------------------------------------------------------------
+# Rakefile Support - This is all the guts and utility methods that are
+#                    necessary to support the above tasks.
+#
+# Lots of Credit for this Rakefile goes to:
+#
+#   Ara T. Howard       - see the Rakefile in all of his projects -
+#                          https://github.com/ahoward/
+#   Tom Preston Werner  - his Rakegem project https://github.com/mojombo/rakegem
+#   Seattle.rb          - Hoe - cuz it has relly good stuff in there
+#------------------------------------------------------------------------------
+BEGIN {
+
+  require 'ostruct'
+  require 'rake/clean'
+  require 'rubygems' unless defined? Gem
+
+  module Util
+    def self.version
+      [ "lib/#{ This.name }.rb", "lib/#{ This.name }/version.rb" ].each do |v|
+        line = File.read( v )[/^\s*VERSION\s*=\s*.*/]
+        if line then
+          return line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+        end
+      end
+    end
+
+    # Partition an rdoc file into sections and return the text of the section
+    # as an array of paragraphs
+    def self.section_of( file, section_name )
+      re    = /^=+ (.*)$/
+      parts = File.read( file ).split( re )[1..-1]
+      parts.map! { |p| p.strip }
+
+      sections = Hash.new
+      Hash[*parts].each do |k,v|
+        sections[k] = v.split("\n\n")
+      end
+      return sections[section_name]
+    end
+
+    def self.task_warning( task )
+      warn "WARNING: '#{task}' tasks are not defined. Please run 'rake develop'"
+    end
+
+    def self.read_manifest
+      abort "You need a Manifest.txt" unless File.readable?( "Manifest.txt" )
+      File.readlines( "Manifest.txt" ).map { |l| l.strip }
+    end
+
+    def self.platform_gemspec
+      This.gemspec[This.platform]
+    end
+  end
+
+  # Hold all the metadata about this project
+  This = OpenStruct.new
+  This.platform = (RUBY_PLATFORM == "java") ? 'java' : Gem::Platform::RUBY
+
+  desc = Util.section_of( 'README.rdoc', 'DESCRIPTION')
+  This.summary     = desc.first
+  This.description = desc.join(" ").tr("\n", ' ').gsub(/[{}]/,'').gsub(/\[[^\]]+\]/,'') # strip rdoc
+
+
+  This.exclude_from_manifest = %r/tmp$|\.(git|DS_Store)|^(doc|coverage|pkg)|\.gemspec$|\.swp$|\.jar|\.rvmrc$|~$/
+  This.manifest = Util.read_manifest
+
+}

data/example/myapp-simple/bin/myapp

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# load path munging so the example works from a git checkout, do not do this
+# in your program
+$: << File.expand_path( "../../../../lib", __FILE__ ) # yacl library
+$: << File.expand_path( "../../lib", __FILE__ )       # lib dir of this sample app
+require 'rubygems'
+
+#------------------------------------------------------------------------------
+# This would be the top level commandline entry point for your program. Feel
+# free to have multiple of them if that is what your situation requires.
+#------------------------------------------------------------------------------
+
+require 'myapp'
+
+MyApp::Application.go( ARGV, ENV )