dohutil 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2012 Makani Mason, Kem Mason
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/doh/config.rb

@@ -0,0 +1,21 @@
+require 'doh/root'
+
+module Doh
+
+def self.load_config_file(name)
+  path = File.join(Doh::root, 'config', name) + '.rb'
+  return false unless File.exist?(path)
+  require(path)
+  true
+end
+
+def self.config
+  @config ||= {}
+end
+
+def self.get_required_config_value(value, desc)
+  raise "Attempt to get configuration value: #{value.inspect}, but none exists.  #{desc}" if !config.key?(value)
+  config[value]
+end
+
+end

data/lib/doh/findup.rb

@@ -0,0 +1,12 @@
+module Doh
+  def self.findup(start_directory, filename, max_tries = 20)
+    curr_directory = start_directory
+    max_tries.times do
+      path = File.expand_path(File.join(curr_directory, filename))
+      return path if File.exist?(path)
+      return nil if (path == '/')
+      curr_directory = File.join(curr_directory, '..')
+    end
+    nil
+  end
+end

data/lib/doh/options.rb

@@ -0,0 +1,108 @@
+require 'ostruct'
+require 'optparse'
+
+module Doh
+
+class Options
+  # this class is for command line parsing
+  # the hash is of the form: {'variable_name' => option_list}
+  # you can also pass an array of hashes [{'var1' => optlist1}, {'var2' => optlist2}]
+  # if you use an array of hashes, the help will be shown in the order specified (otherwise it's random)
+
+  # option_list is an array, the first element of which is the default value of the option
+  # the others are of the form with examples shown on
+  # http://www.ruby-doc.org/stdlib/libdoc/optparse/rdoc/index.html
+  # returns any non-options parameters via method varargs
+  # set allow_unknown_options to true to allow for filename specification, etc..
+  # if the default value is :required for a field, then if that field isn't
+  # specified, an exception will be raised
+  def initialize(param_definition_hash_or_array, allow_unknown_options = false, explanation_text = '', unknown_options_name = 'file', allow_no_prefix = false)
+    @vals = OpenStruct.new
+
+    @opts = OptionParser.new
+    @opts.banner = "Usage: #{$0} [options]"
+    if explanation_text != ''
+      @opts.separator ""
+      @opts.separator explanation_text
+    end
+    @opts.separator ""
+    @opts.separator "Specific options:"
+    @opts.separator ""
+
+    if param_definition_hash_or_array.class == Array
+      param_definition_array = param_definition_hash_or_array
+      param_definition_hash = param_definition_hash_or_array.inject({}) {|sum, elem| sum.merge(elem)}
+    else
+      param_definition_array = param_definition_hash_or_array.collect {|elem1, elem2| {elem1 => elem2}}
+      param_definition_hash = param_definition_hash_or_array
+    end
+
+    param_definition_array.each do |elem|
+      keyname = elem.to_a[0][1][2]
+      if keyname =~ /^--no-/
+        raise "key name: #{keyname} will not behave as desired if meant to be a boolean, rename it, or pass in allow_no_prefix flag as 5th param"
+      end
+    end
+
+    param_definition_array.each do |elem|
+      key = elem.to_a[0][0]
+      val = elem.to_a[0][1]
+      default = val.shift
+      @vals.send("#{key}=", default)
+      val.last.insert(0, '(required) - ') if val.last.is_a?(String) && default == :required
+      @opts.on(*val) do |optval|
+        @vals.send("#{key}=", optval)
+      end
+    end
+
+    @opts.separator ""
+    @opts.separator "Common options:"
+    @opts.separator ""
+
+    @opts.on("-h", "-?", "--help", "Show this message") do
+      puts @opts
+      exit
+    end
+
+    varargs = []
+    @opts.order(ARGV) do |arg|
+      varargs.push(arg)
+    end
+    @vals.varargs = varargs
+
+    unset_vars = []
+    param_definition_hash.each do |key,val|
+      if @vals.send(key) == :required
+        unset_vars.push(key)
+      end
+    end
+
+    exception = ''
+    exception << "Required options not specified: #{unset_vars.inspect}\n" unless unset_vars.size == 0
+    exception << "Unknown options specified: #{varargs.inspect}\n" unless allow_unknown_options || (varargs.size == 0)
+    exception << "You must specify #{allow_unknown_options} #{unknown_options_name}#{allow_unknown_options > 1 ? 's' : ''}" if allow_unknown_options.class == Fixnum && varargs.size != allow_unknown_options
+    if allow_unknown_options.class == Range
+      if (allow_unknown_options.min == allow_unknown_options.max)
+        if (varargs.size < allow_unknown_options.min)
+          exception << "You must specify at least #{allow_unknown_options.min} #{unknown_options_name}#{allow_unknown_options.min > 1 ? 's' : ''}"
+        end
+      elsif !allow_unknown_options.include?(varargs.size)
+        exception << "You must specify between #{allow_unknown_options.min} and #{allow_unknown_options.max} #{unknown_options_name}s"
+      end
+    end
+    if exception != ''
+      puts @opts
+      raise exception
+    end
+  end
+
+  def method_missing(sym, *args)
+    @vals.send(sym, *args)
+  end
+
+  def to_s
+    @opts.to_s
+  end
+end
+
+end

data/lib/doh/root.rb

@@ -0,0 +1,41 @@
+require 'doh/findup'
+
+module Doh
+  def self.root
+    @root
+  end
+
+  def self.root=(directory)
+    @root = directory
+    # having a root lib/ directory in your gem or application tree is a common standard now
+    libdir = File.join(@root, 'lib')
+    $LOAD_PATH.push(libdir) if libdir
+  end
+
+  def self.find_root(start_directory, filename = 'dohroot', max_tries = 20)
+    rootfile = Doh::findup(start_directory, filename, max_tries)
+    if rootfile
+      Doh::root = File.dirname(rootfile)
+    end
+  end
+
+  def self.find_root_from_file(filepath = nil)
+    Doh::find_root(File.dirname(filepath || caller[0]))
+  end
+
+  def self.find_root_from_path(path)
+    if File.directory?(path)
+      Doh::find_root(path)
+    else
+      Doh::find_root(File.dirname(path))
+    end
+  end
+
+  def self.find_root_from_prog
+    Doh::find_root(File.dirname($PROGRAM_NAME))
+  end
+
+  def self.find_root_from_pwd
+    Doh::find_root(Dir.pwd)
+  end
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: dohutil
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Makani Mason
+- Kem Mason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-27 00:00:00.000000000Z
+dependencies: []
+description: This is a collection of tiny standalone utilities, built primarily to
+  support other doh* gems (note the gems that are dependent on dohutil), but designed
+  in a way that hopefully makes them more generally useful.
+email:
+- gitauthor@pqmland.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- MIT-LICENSE
+files:
+- lib/doh/config.rb
+- lib/doh/findup.rb
+- lib/doh/options.rb
+- lib/doh/root.rb
+- MIT-LICENSE
+homepage: https://github.com/pquimo/dohutil
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Tiny standalone utilities, packaged together for convenience.
+test_files: []