falsework 1.3.0 → 2.0.0

data/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/Gemfile.lock

@@ -2,11 +2,11 @@ GEM
   remote: http://rubygems.org/
   specs:
     git (1.2.5)
-    open4 (1.2.0)
+    open4 (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   git (~> 1.2.5)
-  open4 (~> 1.2.0)
+  open4 (~> 1.3.0)

data/README.rdoc

@@ -10,7 +10,7 @@ falsework--A primitive scaffold generator for writing CLI programs.
 
 ==Description
 
-The falsework utility ships with 2 templates: <tt>ruby-naive</tt> and
+The falsework utility ships with 2 templates: <tt>ruby-cli</tt> and
 <tt>c-glib</tt>.
 
 Initially the template spec was designed only for Ruby projects but
@@ -53,8 +53,9 @@ list::                      Do nothing except listing all available
 
 listdirs::                  Do nothing except listing all available
                             templates directories. You can add another
-                            directory, modifying <tt>tdir</tt> option in
-                            the config file. (<tt>tdir</tt> is an array).
+                            directory by modifying <tt>tdir</tt> option
+                            in the config file. (<tt>tdir</tt> is an
+                            array).
                             
 new NAME::                  Create a new project. It creates a directory
                             <i>NAME</i> and populates it with files.
@@ -73,7 +74,7 @@ test NAME::                 Add a new test in
 
 upgrade::                   'Inject' or upgrade some vital files from the
                             template into the project. Currently only
-                            'ruby-naive' template supports this.
+                            'ruby-cli' template supports this.
 
 The options are as follows:
 
@@ -82,7 +83,7 @@ The options are as follows:
 -b::                        A batch mode. (No questions asked.)
 
 --no-git::                  Don't create a Git repository. Don't use
-                            this for 'ruby-naive' template.
+                            this for 'ruby-cli' template.
 
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.

data/Rakefile

@@ -18,15 +18,15 @@ require_relative 'test/rake_git'
 #
 require_relative 'test/rake_erb_templates'
 
-ERB_DYN_SKELETON = erb_skeletons(Meta::NAME, 'ruby-naive')
+ERB_DYN_SKELETON = erb_skeletons(Meta::NAME, 'ruby-cli')
 ERB_DYN_SKELETON.each {|k, v|
   file k => [v] do |t|
-    erb_make(Meta::NAME, 'ruby-naive', t.name, t.prerequisites[0])
+    erb_make(Meta::NAME, 'ruby-cli', t.name, t.prerequisites[0])
   end
 }
 
-desc "Generate some erb templates for ruby-naive template"
-task naive: ERB_DYN_SKELETON.keys
+desc "Generate some erb templates for ruby-cli template"
+task cli: ERB_DYN_SKELETON.keys
 
 CLOBBER.concat ERB_DYN_SKELETON.keys
 #pp CLOBBER
@@ -35,6 +35,10 @@ CLOBBER.concat ERB_DYN_SKELETON.keys
 # Gem staff
 #
 
+rdoc_task_excl = 'lib/**/templates/**/*'
+rdoc_spec_excl = 'lib/.+/templates/'
+rdoc_main = 'doc/README.rdoc'
+
 spec = Gem::Specification.new {|i|
   i.name = Meta::NAME
   i.version = `bin/#{i.name} -V`
@@ -53,25 +57,25 @@ spec = Gem::Specification.new {|i|
   
   i.test_files = FileList['test/test_*.rb']
   
-  i.rdoc_options << '-m' << 'doc/README.rdoc'
+  i.rdoc_options << '-m' << rdoc_main << '-x' << rdoc_spec_excl
   i.extra_rdoc_files = FileList['doc/*']
 
   i.add_dependency('git', '>=  1.2.5')
-  i.add_dependency('open4', '>= 1.2.0')
+  i.add_dependency('open4', '>= 1.3.0')
 }
 
 Gem::PackageTask.new(spec).define
 
-task default: [:naive, :repackage]
+task default: [:cli, :repackage]
 
 RDoc::Task.new('html') do |i|
-  i.main = 'doc/README.rdoc'
+  i.main = rdoc_main
   i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
-  i.rdoc_files.exclude("lib/**/templates/**/*")
+  i.rdoc_files.exclude rdoc_task_excl
 end
 
 Rake::TestTask.new do |i|
   i.test_files = FileList['test/test_*.rb']
 end
 
-task test: [:naive]
+task test: [:cli]

data/bin/falsework

@@ -1,13 +1,12 @@
 #!/usr/bin/env ruby
 # -*-ruby-*-
 
+require_relative '../lib/falsework/cliconfig'
 require_relative '../lib/falsework/mould'
 
 include Falsework
 
-$conf = Hash.new
-$t = Trestle.new($conf)
-
+$conf = CliConfig.new
 $conf[:banner] = <<EOF
 Usage: #{File.basename($0)} [options] command ...
 Available commands: list, listdirs, (new|exe|doc|test) NAME, upgrade.
@@ -24,9 +23,9 @@ def add_files(mode, files)
   m = Mould.new(File.basename(Dir.pwd), $conf[:template],
                 $conf[:user], $conf[:email], $conf[:gecos])
   files.each {|i|
-    created = m.add(mode, i) rescue Trestle.errx(1, $!.to_s)
+    created = m.add(mode, i) rescue CliUtils.errx(1, $!.to_s)
     if created.size > 0
-      created.each {|idx| $t.veputs(1, idx) }
+      created.each {|idx| CliUtils.veputs(1, idx) }
     else
       r = false
     end
@@ -35,34 +34,35 @@ def add_files(mode, files)
   r
 end
 
-# --[ main ]------------------------------------------------------------
 
-$t.config_parse([]) {|src|
-  o = $t.cl_parse(src) # create an OptionParser object
-  o.on('--user STR', 'Github user.') {|i| $conf[:user] = i}
-  o.on('--gecos STR', 'A gecos-like string.') {|i| $conf[:gecos] = i}
-  o.on('--email STR') {|i| $conf[:email] = i}
-  o.on('--no-git', "Don't create a git repo. (Will break 'ruby-naive'.)") {|i| $conf[:git] = false }
-  o.on('-t NAME', 'A template name.') {|i| $conf[:template] = i}
-  o.on('-b', 'Run in a batch mode, don\'t ask any questions.') { $conf[:batch] = true}
-  $t.cl_parse(src, o) # run cl parser
+### main
+
+$conf.load {|o|
+  o.on('--user STR', 'Github user.') {|i| $conf[:user] = i }
+  o.on('--gecos STR', 'A gecos-like string.') {|i| $conf[:gecos] = i }
+  o.on('--email STR') {|i| $conf[:email] = i }
+  o.on('--no-git', "Don't create a git repo.",
+       "(Will break 'ruby-cli'.)") { $conf[:git] = false }
+  o.on('-t NAME', 'A template name.') {|i| $conf[:template] = i }
+  o.on('-b', 'Run in a batch mode and',
+       'don\'t ask any questions.') { $conf[:batch] = true }
 }
 
-Trestle.errx(1, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] !~ /list|upgrade/)
+CliUtils.errx(EX_USAGE, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] !~ /list|upgrade/)
 
 # print our env
 if $conf[:verbose] >= 2
-  puts 'Libs dir: '+Trestle.gem_libdir
+  puts "Lib dir: #{CliUtils::DIR_LIB_SRC}"
   pp $conf
 end
 
 # modify a list of available template directories
-Mould.template_dirs_add $conf[:tdir]
+Mould.template_dirs_add $conf[:tdir].map {|i| Pathname.new i} if $conf[:tdir]
 
 case ARGV[0]
 when 'list'
   Mould.templates.each {|name, loc|
-    loc = '(system)' if loc == Mould.class_variable_get(:@@template_dirs)[0] +'/'+ name
+    loc = '(system)' if loc == (Mould.class_variable_get(:@@template_dirs)[0] + name).to_s
     puts "%-30s %s" % [name, loc]
   }
   
@@ -82,11 +82,11 @@ when 'upgrade'
                 $conf[:user], $conf[:email], $conf[:gecos])
   m.verbose = true if $conf[:verbose] > 0
   m.batch = $conf[:batch]
-  m.upgrade() rescue Trestle.errx(1, $!.to_s)
+  m.upgrade() rescue CliUtils.errx(1, $!.to_s)
 
 when 'new'
   if File.dirname(ARGV[1]) != '.'
-    Dir.chdir(File.dirname(ARGV[1])) rescue Trestle.errx(1, "cannot chdir to '#{File.dirname(ARGV[1])}'")
+    Dir.chdir(File.dirname(ARGV[1])) rescue CliUtils.errx(1, "cannot chdir to '#{File.dirname(ARGV[1])}'")
     ARGV[1] = File.basename ARGV[1]
   end
 
@@ -94,7 +94,7 @@ when 'new'
     m = Mould.new(ARGV[1], $conf[:template],
                   $conf[:user], $conf[:email], $conf[:gecos])
   rescue
-    Trestle.errx 1, $!
+    CliUtils.errx 1, $!
   end
   m.verbose = true if $conf[:verbose] > 0
   m.project_seed
@@ -102,12 +102,12 @@ when 'new'
   # create a git repository
   if $conf[:git]
     Dir.chdir m.project
-    $t.veputs(1, "Creating a git repository in #{Dir.pwd}... __NNL__")
+    CliUtils.veputs(1, "Creating a git repository in #{Dir.pwd}... __NNL__")
     g = Git.init
     g.add '.'
     g.commit "Initial import from #{Falsework::Meta::NAME} #{Falsework::Meta::VERSION}."
-    $t.veputs(1, 'OK')
+    CliUtils.veputs(1, 'OK')
   end
 else
-  Trestle.errx(1, "unknown command: " + ARGV[0])
+  CliUtils.errx(1, "unknown command: " + ARGV[0])
 end

data/doc/NEWS.rdoc

@@ -1,3 +1,21 @@
+=== 2.0.0
+
+Fri Jan 27 22:11:06 EET 2012
+
+* <b>WARNING:</b> 'ruby-naive' template is now called 'ruby-cli'. <b>You
+  cannot upgrade to it</b> because everything changed in it to be more
+  pretty.
+
+* New command: listdirs.
+
+* User can specify additional directories for templates.
+
+=== 1.3.1
+
+Fri Jan 27 12:07:55 EET 2012
+
+* Fixed exclude pattern in gemspec for rdoc.
+
 === 1.3.0
 
 Mon Nov  7 07:15:00 EET 2011

data/doc/README.rdoc

@@ -10,7 +10,7 @@ falsework--A primitive scaffold generator for writing CLI programs.
 
 ==Description
 
-The falsework utility ships with 2 templates: <tt>ruby-naive</tt> and
+The falsework utility ships with 2 templates: <tt>ruby-cli</tt> and
 <tt>c-glib</tt>.
 
 Initially the template spec was designed only for Ruby projects but
@@ -53,8 +53,9 @@ list::                      Do nothing except listing all available
 
 listdirs::                  Do nothing except listing all available
                             templates directories. You can add another
-                            directory, modifying <tt>tdir</tt> option in
-                            the config file. (<tt>tdir</tt> is an array).
+                            directory by modifying <tt>tdir</tt> option
+                            in the config file. (<tt>tdir</tt> is an
+                            array).
                             
 new NAME::                  Create a new project. It creates a directory
                             <i>NAME</i> and populates it with files.
@@ -73,7 +74,7 @@ test NAME::                 Add a new test in
 
 upgrade::                   'Inject' or upgrade some vital files from the
                             template into the project. Currently only
-                            'ruby-naive' template supports this.
+                            'ruby-cli' template supports this.
 
 The options are as follows:
 
@@ -82,7 +83,7 @@ The options are as follows:
 -b::                        A batch mode. (No questions asked.)
 
 --no-git::                  Don't create a Git repository. Don't use
-                            this for 'ruby-naive' template.
+                            this for 'ruby-cli' template.
 
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.

data/doc/TODO.org

@@ -1,4 +1,4 @@
-* TODO In the distant future [3/6]
+* TODO In the distant future [3/7] [42%]
 
 - [-] more templates [1/4]
   - [X] c glib
@@ -11,3 +11,4 @@
 - [ ] describe c-glib template
 - [X] normalize 'name' of the project before actually making a template
 - [X] target_uuid variable for exe/doc/test templates
+- [ ] relocate templates from lib/falsework directory to project root

data/lib/falsework/cliconfig.rb

@@ -0,0 +1,135 @@
+# :erb: ruby-cli
+
+require 'pathname'
+require 'yaml'
+require 'optparse'
+require 'shellwords'
+
+require_relative 'cliutils'
+
+module Falsework
+
+  # 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

data/lib/falsework/cliutils.rb

@@ -0,0 +1,112 @@
+# :erb: ruby-cli
+
+require 'pp'
+require 'open4'
+require 'pathname'
+
+require_relative 'meta'
+
+module Falsework
+
+  # 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

data/lib/falsework/meta.rb

@@ -2,7 +2,7 @@
 module Falsework
   module Meta # :nodoc:
     NAME = 'falsework'
-    VERSION = '1.3.0'
+    VERSION = '2.0.0'
     AUTHOR = 'Alexander Gromnitsky'
     EMAIL = 'alexander.gromnitsky@gmail.com'
     HOMEPAGE = 'http://github.com/gromnitsky/' + NAME