falsework 1.3.0 → 2.0.0

data/lib/falsework/mould.rb

@@ -2,8 +2,9 @@ require 'git'
 require 'erb'
 require 'digest/md5'
 require 'securerandom'
+require 'yaml'
 
-require_relative 'trestle'
+require_relative 'cliutils'
 
 module Falsework
   # The directory with template may have files beginning with # char
@@ -15,7 +16,7 @@ module Falsework
   #
   # %%VARIABLE%%
   #
-  # which is equivalent of erb's: <%= VARIABLE %>. See 'ruby-naive'
+  # which is equivalent of erb's: <%= VARIABLE %>. See 'ruby-cli'
   # template directory for examples.
   #
   # In the template files you may use any Mould instance variables. The
@@ -37,10 +38,10 @@ module Falsework
     # Where @user, @email & @gecos comes from.
     GITCONFIG = '~/.gitconfig'
     # The possible dirs for templates. The first one is system-wide.
-    @@template_dirs = [Trestle.gem_libdir + '/templates',
-                       File.expand_path('~/.' + Meta::NAME + '/templates')]
+    @@template_dirs = [CliUtils::DIR_LIB_SRC + 'templates',
+                       Pathname.new(Dir.home) + ".#{Meta::NAME}" + 'templates']
     # The template used if user didn't select one.
-    TEMPLATE_DEFAULT = 'ruby-naive'
+    TEMPLATE_DEFAULT = 'ruby-cli'
     # A file name with configurations for the inject commands.
     TEMPLATE_CONFIG = '#config.yaml'
     # A list of files to ignore in any template.
@@ -67,7 +68,7 @@ module Falsework
       @verbose = false
       @batch = false
       @template = template
-      @dir_t = Mould.templates[@template || TEMPLATE_DEFAULT] || Trestle.errx(1, "no such template: #{template}")
+      @dir_t = Mould.templates[@template || TEMPLATE_DEFAULT] || CliUtils.errx(1, "no such template: #{template}")
 
       # default config
       @conf = {
@@ -97,7 +98,7 @@ module Falsework
       [['github.user', @user],
        ['user.email', @email],
        ['user.name', @gecos]].each {|i|
-        Trestle.errx(1, "missing #{i.first} in #{GITCONFIG}") if i.last.to_s == ''
+        CliUtils.errx(1, "missing #{i.first} in #{GITCONFIG}") if i.last.to_s == ''
       }
     end
 
@@ -106,8 +107,10 @@ module Falsework
       return unless defined? dirs.each
 
       dirs.each {|idx|
+        fail "#{idx} is not a Pathname" unless idx.instance_of?(Pathname)
+        
         if ! File.directory?(idx)
-          Trestle.warnx "invalid additional template directory: #{idx}"
+          CliUtils.warnx "invalid additional template directory: #{idx}"
         else
           @@template_dirs << idx
         end
@@ -167,7 +170,7 @@ module Falsework
     def self.templates
       r = {}
       @@template_dirs.each {|i|
-        Dir.glob(i + '/*').each {|j|
+        Dir.glob(i + '*').each {|j|
           r[File.basename(j)] = j if File.directory?(j)
         }
       }
@@ -181,7 +184,7 @@ module Falsework
       uuid = Mould.uuidgen_fake # useful variable for the template
       
       # check for existing project
-      Trestle.errx(1, "directory '#{@project}' is not empty") if Dir.glob(@project + '/*').size > 0
+      CliUtils.errx(1, "directory '#{@project}' is not empty") if Dir.glob(@project + '/*').size > 0
 
       Dir.mkdir @project unless File.directory?(@project)
       puts "Project path: #{File.expand_path(@project)}" if @verbose
@@ -234,11 +237,11 @@ module Falsework
         begin
           myconf = YAML.load_file(file)
         rescue
-          Trestle.warnx "cannot parse #{file}: #{$!}"
+          CliUtils.warnx "cannot parse #{file}: #{$!}"
           return false
         end
         rvars.each { |i|
-          Trestle.warnx "missing or nil '#{i}' in #{file}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
+          CliUtils.warnx "missing or nil '#{i}' in #{file}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
           r = false
         }
         
@@ -282,7 +285,7 @@ module Falsework
           Mould.extract(@dir_t + '/' + idx[:src], binding, to)
           File.chmod(idx[:mode_int], to) if idx[:mode_int]
         rescue
-          Trestle.warnx "failed to create '#{to}' (check your #config.yaml): #{$!}"
+          CliUtils.warnx "failed to create '#{to}' (check your #config.yaml): #{$!}"
         else
           created << to
         end
@@ -320,7 +323,7 @@ module Falsework
         output = t.result(binding)
         md5_system = Digest::MD5.hexdigest(output)
       rescue Exception
-        Trestle.errx(1, "bogus template file '#{from}': #{$!}")
+        CliUtils.errx(1, "bogus template file '#{from}': #{$!}")
       end
 
       if ! File.exists?(to)
@@ -330,12 +333,12 @@ module Falsework
           # transfer the exec bit to the generated result
           File.chmod(0744, to) if File.stat(from).executable?
         rescue
-          Trestle.errx(1, "cannot generate: #{$!}")
+          CliUtils.errx(1, "cannot generate: #{$!}")
         end
       elsif
         # warn a careless user
         if md5_system != Digest::MD5.file(to).hexdigest
-          Trestle.errx(1, "'#{to}' already exists")
+          CliUtils.errx(1, "'#{to}' already exists")
         end
       end
     end
@@ -346,7 +349,7 @@ module Falsework
       
       re = /%%([^%]+)%%/
       t = ERB.new(t.gsub(re, '<%= \+ %>')).result(binding) if t =~ re
-      t.sub /\.#erb$/, ''
+      t.sub(/\.#erb$/, '')
     end
     
 
@@ -359,7 +362,7 @@ module Falsework
     def upgradable_files()
       line_max = 4
       r = {}
-      Falsework::Mould.traverse(@dir_t) {|i|
+      Mould.traverse(@dir_t) {|i|
         next if File.directory?(i)
         next if File.symlink?(i) # hm...
 
@@ -429,7 +432,7 @@ module Falsework
               end
             end
 
-            Trestle.warnx("#{k}: unversioned") if ! is_versioned
+            CliUtils.warnx("#{k}: unversioned") if ! is_versioned
           }
         end
       }
@@ -458,7 +461,7 @@ an '.old' extension. So? }
       u.each {|k, v|
         printf("%#{tsl}s) mv %s %s\n",
                "#{count}/#{total}", k, "#{k}.old") if @verbose
-        File.rename(k, "#{k}.old") rescue Trestle.warnx('renaming failed')
+        File.rename(k, "#{k}.old") rescue CliUtils.warnx('renaming failed')
         printf("%#{tsl}s  Extracting %s ...\n", "", File.basename(v)) if @verbose
         FileUtils.mkdir_p(File.dirname(k))
         Mould.extract(v, binding, k)

data/lib/falsework/templates/{ruby-naive → ruby-cli}/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-gem "open4", "~>1.2.0"
+gem "open4", "~>1.3.0"
 gem "git", "~>1.2.5"

data/lib/falsework/templates/{ruby-naive/doc → ruby-cli}/README.rdoc

@@ -21,7 +21,7 @@ The options are as follows:
                             it contains <tt>/</tt> in it, the list from
                             <tt>--config-dirs</tt> is ignored.
 
--V::                        Show version and exit.
+-V, --version::             Show version and exit.
 
 -v::                        Be more verbose. You can supply it several
                             times, viz. <tt>-vv</tt> dumps even more

data/lib/falsework/templates/ruby-cli/bin/%%@project%%

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require_relative '../lib/<%= @project %>/cliconfig'
+
+include <%= @camelcase %>
+
+$conf = CliConfig.new
+$conf[:banner] = "Usage: #{File.basename($0)} [options] hren'"
+$conf[:foobar] = ''
+
+### main
+
+$conf.load(['foobar']) {|o|
+  o.on('--foobar STR', 'An example of the option --foobar') {|i|
+    $conf[:foobar] = i
+  }
+}
+
+# print our env
+if $conf[:verbose] >= 2
+  puts "Libs dir: #{CliUtils::DIR_LIB_SRC}"
+  pp $conf
+end
+
+puts 'Hello, World!'

data/lib/falsework/templates/{ruby-naive → ruby-cli}/doc/#doc.rdoc

@@ -21,7 +21,7 @@ The options are as follows:
                             it contains <tt>/</tt> in it, the list from
                             <tt>--config-dirs</tt> is ignored.
 
--V::                        Show version and exit.
+-V, --version::             Show version and exit.
 
 -v::                        Be more verbose. You can supply it several
                             times, viz. <tt>-vv</tt> dumps even more

data/lib/falsework/templates/{ruby-naive → ruby-cli/doc}/README.rdoc

@@ -21,7 +21,7 @@ The options are as follows:
                             it contains <tt>/</tt> in it, the list from
                             <tt>--config-dirs</tt> is ignored.
 
--V::                        Show version and exit.
+-V, --version::             Show version and exit.
 
 -v::                        Be more verbose. You can supply it several
                             times, viz. <tt>-vv</tt> dumps even more

data/lib/falsework/templates/ruby-cli/lib/%%@project%%/cliconfig.rb

@@ -0,0 +1,137 @@
+# :erb: ruby-cli
+
+require 'pathname'
+require 'yaml'
+require 'optparse'
+require 'shellwords'
+
+require_relative 'cliutils'
+
+module <%= @camelcase %>
+
+  # Load configuration from 3 places (starting from least significant):
+  # config file, env variable, command line.
+  class CliConfig
+    # Possible config file locations.
+    DIR_CONFIG = [Pathname.new(Dir.home) + ".#{Meta::NAME}",
+                  Pathname.new('/etc'),
+                  Pathname.new('/usr/etc'),
+                  Pathname.new('/usr/local/etc'),
+                  CliUtils::DIR_LIB_SRC.parent.parent + 'etc']
+
+    # Example:
+    #
+    # conf = CliConfig.new
+    # conf[:my_option] = 123
+    # conf.load
+    def initialize
+      @conf = Hash.new
+      @conf[:verbose] = 0
+      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
+      @conf[:config_name] = Meta::NAME + '.yaml'
+      @conf[:config_env] = Meta::NAME.upcase + '_CONF'
+      @conf[:config_dirs] = DIR_CONFIG
+    end
+
+    # Setter for @conf
+    def []=(key, val)
+      CliUtils.verbose = val if key == :verbose # sync verbosity levels
+      @conf[key] = val
+    end
+
+    # Getter for @conf
+    def [](key)
+      @conf[key]
+    end
+
+    # Return a full path to a config file or nil if no config file found.
+    def getConfigPath
+      if @conf[:config_name].index('/')
+        return @conf[:config_name] if File.file?(@conf[:config_name])
+      else 
+        @conf[:config_dirs].each {|i|
+          r = Pathname.new(i) + @conf[:config_name]
+          return r if File.file?(r)
+        }
+      end
+
+      CliUtils.warnx "no config file '#{@conf[:config_name]}' found" if @conf[:verbose] >= 2
+      return nil
+    end
+
+    # Load a config from file. Return true on success or false otherwise.
+    def loadFile
+      file = getConfigPath
+      return false unless file
+
+      CliUtils::veputs(2, "Loading #{File.basename(file)}... " + CliUtils::NNL_MARK)
+      myconf = YAML.load_file(file) rescue CliUtils.errx(1, "cannot parse config #{file}: #{$!}")
+      # preserve existing values
+      @conf.merge!(myconf) {|key, oldval, newval| oldval }
+      CliUtils::veputs(2, "OK")
+      return true
+    end
+
+    # Check if options in array opts are in @conf.
+    def requiredOptions?(opts)
+      opts.each {|idx|
+        if !@conf.key?(idx.to_sym) || !@conf[idx.to_sym]
+          CliUtils.errx(1, "option #{idx} is either nil or missing")
+        end
+      }
+    end
+
+    # Parse CLO and env variable. If block is given it is passed with
+    # OptionParser object as a parameter.
+    def optParse
+      o = OptionParser.new do |o|
+        o.banner = @conf[:banner]
+        o.banner = @conf[:banner]
+        o.on('-v', 'Be more verbose.') { |i|
+          self[:verbose] += 1
+        }
+        o.on('-V', '--version', 'Show version & exit.') { |i|
+          puts Meta::VERSION
+          exit 0
+        }
+        o.on('--config NAME',
+             "Set a config name or file",
+             "(default is #{@conf[:config_name]}).") {|arg|
+          @conf[:config_name] = arg
+        }
+        o.on('--config-dirs', 'Show possible config locations.') {
+          mark = false
+          @conf[:config_dirs].each { |idx|
+            f = Pathname(idx) + @conf[:config_name]
+            if File.file?(f) && !mark
+              puts "* #{f}"
+              mark = true
+            else
+              puts "  #{f}"
+            end
+          }
+          exit 0
+        }
+
+        yield o if block_given?
+
+        env = nil
+        env = ENV[@conf[:config_env]].shellsplit if ENV.key?(@conf[:config_env])
+        [env, ARGV].each { |i| o.parse!(i) if i }
+      end
+    end
+
+    # Parse CLO, env variables and load config file.
+    #
+    # [reqOpts] an array of requied options
+    # [&block]  a optional block for OptionParser
+    def load(reqOpts = [], &block)
+      optParse &block
+      loadFile
+      requiredOptions?(reqOpts)
+    end
+    
+  end
+end
+
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/lib/falsework/templates/ruby-cli/lib/%%@project%%/cliutils.rb

@@ -0,0 +1,114 @@
+# :erb: ruby-cli
+
+require 'pp'
+require 'open4'
+require 'pathname'
+
+require_relative 'meta'
+
+module <%= @camelcase %>
+
+  # Preferable exit codes. See sysexits(3) in FreeBSD.
+  EX_OK = 0
+  EX_USAGE = 64
+  EX_DATAERR = 65
+  EX_NOINPUT = 66
+  EX_NOUSER = 67
+  EX_NOHOST = 68
+  EX_UNAVAILABLE = 69
+  EX_SOFTWARE = 70
+  EX_OSERR = 71
+  EX_OSFILE = 72
+  EX_CANTCREAT = 73
+  EX_IOERR = 74
+  EX_TEMPFAIL = 75
+  EX_PROTOCOL = 76
+  EX_NOPERM = 77
+  EX_CONFIG = 78
+  
+  # Common routines useful in any CLI program.
+  class CliUtils
+    # Physical location of program libraries.
+    DIR_LIB_SRC = Pathname.new File.dirname(__FILE__)
+    # veputs uses this to decide to put a newline or not to put.
+    NNL_MARK = '__NNL__'
+
+    # Class-wide verbosity level.
+    @@verbose = 0
+
+    # Setter.
+    def self.verbose=(val)
+      @@verbose = val
+    end
+
+    # Getter.
+    def self.getVerbose
+      @@verbose
+    end
+
+    # A handy check. Use it like:
+    #
+    # puts (CliUtils.debug ? "DEBUG mode" : "")
+    def self.debug
+      @@verbose >= 2
+    end
+
+    # A handy method that return a nicely formatted current global
+    # backtrace.
+    def self.getBacktrace
+      "#{$!}\n\nBacktrace:\n\n#{$!.backtrace.join("\n")}"
+    end
+
+    # Print an error msg & exit if exit_code > 0.
+    def self.errx(exit_code = 0, msg)
+      $stderr.puts File.basename($0) + ' error: ' + msg.to_s
+      exit exit_code if exit_code > 0
+    end
+
+    # Print a warning.
+    def self.warnx(msg)
+      $stderr.puts File.basename($0) + ' warning: ' + msg.to_s
+    end
+
+    # [level] Verbosity level.
+    # [msg]   A message to print.
+    #
+    # Don't print msg with a newline if it contains NNL_MARK at the end.
+    def self.veputs(level, msg)
+      t = msg.dup
+      
+      nnl = false
+      if t.match(/#{NNL_MARK}$/)
+        t.sub!(/#{$&}/, '')
+        nnl = true
+      end
+
+      if @@verbose >= level
+        nnl ? print(t) : print("#{t}\n")
+        $stdout.flush
+      end
+    end
+
+    # Analogue to a shell command +which+.
+    def self.which(file)
+      return true if file =~ %r%\A/% and File.exist? file
+      
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
+        File.exist? File.join(path, file)
+      end
+    end
+    
+    # Execute cmd and return an array [exit_status, stderr, stdout].
+    def self.exec(cmd)
+      so = sr = ''
+      status = Open4::popen4(cmd) { |pid, stdin, stdout, stderr|
+        so = stdout.read
+        sr = stderr.read
+      }
+      [status.exitstatus, sr, so]
+    end
+  end
+
+end
+
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/lib/falsework/templates/{ruby-naive → ruby-cli}/test/helper.rb

@@ -1,4 +1,4 @@
 # This is supposed to be your helper for all your test. Feel free to
 # add staff here.
 
-require_relative 'helper_trestle'
+require_relative 'helper_cliutils'

data/lib/falsework/templates/{ruby-naive/test/helper_trestle.rb → ruby-cli/test/helper_cliutils.rb}

@@ -1,10 +1,10 @@
-# :erb:
+# :erb: ruby-cli
 # Various staff for minitest. Include this file into your 'helper.rb'.
 
 require 'fileutils'
 include FileUtils
 
-require_relative '../lib/<%= @project %>/trestle'
+require_relative '../lib/<%= @project %>/cliutils'
 include <%= @camelcase %>
 
 require 'minitest/autorun'
@@ -22,7 +22,7 @@ def cmd(c)
     # tests were invoked by 'gem check -t <%= @project %>'
     # (for a classic rubygems 1.3.7)
     begin
-      Dir.chdir(Trestle.gem_libdir + '/../../test')
+      Dir.chdir(CliUtils::DIR_LIB_SRC.parent.parent + test)
     rescue
       raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
     end
@@ -31,4 +31,4 @@ def cmd(c)
   File.absolute_path('../bin/' + c)
 end
 
-# Don't remove this: falsework/1.3.0/ruby-naive/2012-01-27T02:39:48+02:00
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/lib/falsework/templates/{ruby-naive → ruby-cli}/test/rake_git.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # -*-ruby-*-
-# :erb:
+# :erb: ruby-cli
 
 # This is a helper for your Rakefile. Read the comments for each
 # function.
@@ -33,4 +33,4 @@ end
 
 pp git_ls('.') if __FILE__ == $0
 
-# Don't remove this: falsework/1.3.0/ruby-naive/2012-01-27T02:39:48+02:00
+# Don't remove this: falsework/2.0.0/ruby-cli/2012-03-05T05:04:11+02:00

data/test/helper.rb

@@ -1 +1 @@
-require_relative 'helper_trestle'
+require_relative 'helper_cliutils'

data/test/{helper_trestle.rb → helper_cliutils.rb}

@@ -1,10 +1,10 @@
-# :erb:
+# :erb: ruby-cli
 # Various staff for minitest. Include this file into your 'helper.rb'.
 
 require 'fileutils'
 include FileUtils
 
-require_relative '../lib/falsework/trestle'
+require_relative '../lib/falsework/cliutils'
 include Falsework
 
 require 'minitest/autorun'
@@ -22,7 +22,7 @@ def cmd(c)
     # tests were invoked by 'gem check -t falsework'
     # (for a classic rubygems 1.3.7)
     begin
-      Dir.chdir(Trestle.gem_libdir + '/../../test')
+      Dir.chdir(CliUtils::DIR_LIB_SRC.parent.parent + test)
     rescue
       raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
     end

data/test/rake_erb_templates.rb

@@ -5,7 +5,7 @@ require_relative '../lib/falsework/mould'
 
 # Search for all files in the project (except .git directory) for the line
 #
-# /^..? :erb:/
+# /^..? :erb: [^ ]+/
 #
 # in first 4 lines. If the line is found, the file is considered a
 # skeleton for a template. Return a hash {target:template}
@@ -29,7 +29,7 @@ def erb_skeletons(local_prj, template)
       n = 0
       while n < line_max && line = fp.gets
 #        puts line
-        if line =~ /^..? :erb:/
+        if line =~ /^..? :erb: [^\s]+/
           t = i.sub(/^.+?\//, '')
           r[target + '/' + t.sub(/#{local_prj}/, '%%@project%%')] = t
           break
@@ -57,4 +57,4 @@ def erb_make(local_prj, template, target, tmplt)
 end
 
 
-pp erb_skeletons(Falsework::Meta::NAME, 'ruby-naive') if __FILE__ == $0
+pp erb_skeletons(Falsework::Meta::NAME, 'ruby-cli') if __FILE__ == $0

data/test/rake_git.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 # -*-ruby-*-
-# :erb:
+# :erb: ruby-cli
 
 # This is a helper for your Rakefile. Read the comments for each
 # function.

data/test/templates/config-02.yaml

@@ -0,0 +1,2 @@
+---
+:tdir: 'templates'

data/test/test_cl.rb

@@ -9,20 +9,24 @@ class TestFalsework_3867654745 < MiniTest::Unit::TestCase
 
   def test_listdirs
     assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
-    out, err = capture_io { Mould.template_dirs_add ["DOESN'T EXISI"] }
+    out, err = capture_io { Mould.template_dirs_add [Pathname.new("DOESN'T EXISI")] }
+    assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
+    
+    assert_raises(RuntimeError) { Mould.template_dirs_add([Dir.pwd]) }
     assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
-    Mould.template_dirs_add [Dir.pwd]
-    assert_equal 3, Mould.class_variable_get(:@@template_dirs).size
     
+    Mould.template_dirs_add [Pathname.new(Dir.pwd)]
+    assert_equal 3, Mould.class_variable_get(:@@template_dirs).size
+
     assert_equal true, Mould.templates.key?("templates")
   end
 
   def test_new_dir_from_config
-    r = Trestle.cmd_run "#{@cmd} --config /NO_SUCH_FILE.yaml listdirs"
+    r = CliUtils.exec "#{@cmd} --config /NO_SUCH_FILE.yaml listdirs"
     assert_equal(0, r[0])
     assert_equal(2, r[2].split("\n").size)
     
-    r = Trestle.cmd_run "#{@cmd} --config templates/config-01.yaml listdirs"
+    r = CliUtils.exec "#{@cmd} --config templates/config-01.yaml listdirs"
     assert_equal(0, r[0])
     assert_equal(3, r[2].split("\n").size)
   end