falsework 1.3.0 → 2.0.0

data/test/test_exe.rb

@@ -7,9 +7,9 @@ class TestFalsework < MiniTest::Unit::TestCase
   end
 
   def test_project_list
-    r = Trestle.cmd_run "#{@cmd} list"
+    r = CliUtils.exec "#{@cmd} list"
     assert_equal(0, r[0])
-    assert_match(/ruby-naive/, r[2])
+    assert_match(/ruby-cli/, r[2])
   end
 
   # very silly analogue of "sed -i'' -E 's/foo/bar/g' file"
@@ -18,9 +18,9 @@ class TestFalsework < MiniTest::Unit::TestCase
     File.open(file, 'w+') {|fp| fp.printf(o) }
   end
   
-  def test_project_ruby_naive
+  def test_project_ruby_cli
     rm_rf 'templates/foo'
-    r = Trestle.cmd_run "#{@cmd} new templates/foo -v"
+    r = CliUtils.exec "#{@cmd} new templates/foo -v"
 #    pp r
     assert_equal(0, r[0], r)
 
@@ -44,11 +44,12 @@ class TestFalsework < MiniTest::Unit::TestCase
             "templates/foo/etc/foo.yaml",
             "templates/foo/lib",
             "templates/foo/lib/foo",
+            "templates/foo/lib/foo/cliconfig.rb",
+            "templates/foo/lib/foo/cliutils.rb",
             "templates/foo/lib/foo/meta.rb",
-            "templates/foo/lib/foo/trestle.rb",
             "templates/foo/test",
             "templates/foo/test/helper.rb",
-            "templates/foo/test/helper_trestle.rb",
+            "templates/foo/test/helper_cliutils.rb",
             "templates/foo/test/rake_git.rb",
             "templates/foo/test/test_foo.rb"]
 
@@ -59,67 +60,71 @@ class TestFalsework < MiniTest::Unit::TestCase
 
     Dir.chdir('templates/foo') {
       # add files
-      r = Trestle.cmd_run "#{@cmd} exe qqq"
+      r = CliUtils.exec "#{@cmd} exe qqq"
       assert_equal(0, r[0])
       assert_equal(true, File.executable?('bin/qqq'))
       assert_equal(true, File.exist?('doc/qqq.rdoc'))
+      # smoke test of generated exe
+      r = CliUtils.exec "bin/qqq --version"
+      assert_equal 0, r[0]
+      assert_equal "0.0.1\n", r[2]
 
-      r = Trestle.cmd_run "#{@cmd} test qqq"
+      r = CliUtils.exec "#{@cmd} test qqq"
       assert_equal(0, r[0])
       assert_equal(true, File.exist?('test/test_qqq.rb'))
 
       # upgrade
-      r = Trestle.cmd_run "#{@cmd} upgrade -b"
+      r = CliUtils.exec "#{@cmd} upgrade -b"
       assert_equal(0, r[0])
-      rm ['test/helper_trestle.rb', 'test/rake_git.rb']
-      r = Trestle.cmd_run "#{@cmd} upgrade -b"
+      rm ['test/helper_cliutils.rb', 'test/rake_git.rb']
+      r = CliUtils.exec "#{@cmd} upgrade -b"
       assert_equal(0, r[0])
-      sed 'test/helper_trestle.rb',
+      sed 'test/helper_cliutils.rb',
       /^(# Don't.+falsework\/)\d+\.\d+\.\d+(\/.+)$/, '\1999.999.999\2'
-      r = Trestle.cmd_run "#{@cmd} upgrade -b"
+      r = CliUtils.exec "#{@cmd} upgrade -b"
       assert_equal(1, r[0])
       assert_match(/file .+ is from .+ falsework: 999.999.999/, r[1])
       mv('test', 'ttt')
-      r = Trestle.cmd_run "#{@cmd} upgrade -b"
+      r = CliUtils.exec "#{@cmd} upgrade -b"
       assert_equal(0, r[0])
     }
   end
 
   def test_project_invalid_name
-    r = Trestle.cmd_run "#{@cmd} new 123"
+    r = CliUtils.exec "#{@cmd} new 123"
     assert_equal(1, r[0])
     assert_match(/invalid project name/, r[1])
   end
 
   def test_project_c_glib
     rm_rf 'templates/c_glib'
-    r = Trestle.cmd_run "#{@cmd} new templates/c-glib -t c-glib --no-git"
+    r = CliUtils.exec "#{@cmd} new templates/c-glib -t c-glib --no-git"
     assert_equal(0, r[0])
 
     Dir.chdir('templates/c_glib') {
-      r = Trestle.cmd_run "#{@cmd} -t c-glib exe q-q-q"
+      r = CliUtils.exec "#{@cmd} -t c-glib exe q-q-q"
       assert_equal(0, r[0])
       assert_equal(true, File.exist?('src/q_q_q.h'))
       assert_equal(true, File.exist?('src/q_q_q.c'))
       assert_equal(true, File.exist?('doc/q_q_q.1.asciidoc'))
 
-      r = Trestle.cmd_run "#{@cmd} -t c-glib test q-q-q"
+      r = CliUtils.exec "#{@cmd} -t c-glib test q-q-q"
       assert_equal(0, r[0])
       assert_equal(true, File.exist?('test/test_q_q_q.c'))
       
       Dir.chdir('src') {
-        r = Trestle.cmd_run "gmake"
+        r = CliUtils.exec "gmake"
         assert_equal 0, r[0]
         assert_equal true, File.executable?('c_glib')
         assert_equal(true, File.exist?('q_q_q.o'))
       }
       Dir.chdir('test') {
-        r = Trestle.cmd_run "gmake"
+        r = CliUtils.exec "gmake"
         assert_equal 0, r[0]
         assert_equal true, File.executable?('test_utils')
         assert_equal true, File.executable?('test_q_q_q')
 
-        r = Trestle.cmd_run "gmake test"
+        r = CliUtils.exec "gmake test"
         assert_equal 0, r[0]
       }
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: falsework
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-27 00:00:00.000000000 Z
+date: 2012-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &75682810 !ruby/object:Gem::Requirement
+  requirement: &74400880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,18 +21,18 @@ dependencies:
         version: 1.2.5
   type: :runtime
   prerelease: false
-  version_requirements: *75682810
+  version_requirements: *74400880
 - !ruby/object:Gem::Dependency
   name: open4
-  requirement: &75682580 !ruby/object:Gem::Requirement
+  requirement: &74400650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
-  version_requirements: *75682580
+  version_requirements: *74400650
 description: A primitive scaffold generator for writing CLI programs in Ruby.
 email: alexander.gromnitsky@gmail.com
 executables:
@@ -56,6 +56,8 @@ files:
 - doc/TODO.org
 - doc/template-tutorial.rdoc
 - etc/falsework.yaml
+- lib/falsework/cliconfig.rb
+- lib/falsework/cliutils.rb
 - lib/falsework/meta.rb
 - lib/falsework/mould.rb
 - lib/falsework/templates/c-glib/#config.yaml
@@ -79,38 +81,41 @@ files:
 - lib/falsework/templates/c-glib/test/mycat.c
 - lib/falsework/templates/c-glib/test/semis/text/empty.txt
 - lib/falsework/templates/c-glib/test/test_utils.c
-- lib/falsework/templates/ruby-naive/#config.yaml
-- lib/falsework/templates/ruby-naive/.gitignore.#erb
-- lib/falsework/templates/ruby-naive/Gemfile
-- lib/falsework/templates/ruby-naive/README.rdoc
-- lib/falsework/templates/ruby-naive/Rakefile
-- lib/falsework/templates/ruby-naive/bin/%%@project%%
-- lib/falsework/templates/ruby-naive/doc/#doc.rdoc
-- lib/falsework/templates/ruby-naive/doc/LICENSE
-- lib/falsework/templates/ruby-naive/doc/NEWS.rdoc
-- lib/falsework/templates/ruby-naive/doc/README.rdoc
-- lib/falsework/templates/ruby-naive/etc/%%@project%%.yaml
-- lib/falsework/templates/ruby-naive/lib/%%@project%%/meta.rb
-- lib/falsework/templates/ruby-naive/test/helper.rb
-- lib/falsework/templates/ruby-naive/test/test_%%@project%%.rb
-- lib/falsework/trestle.rb
+- lib/falsework/templates/ruby-cli/#config.yaml
+- lib/falsework/templates/ruby-cli/.gitignore.#erb
+- lib/falsework/templates/ruby-cli/Gemfile
+- lib/falsework/templates/ruby-cli/README.rdoc
+- lib/falsework/templates/ruby-cli/Rakefile
+- lib/falsework/templates/ruby-cli/bin/%%@project%%
+- lib/falsework/templates/ruby-cli/doc/#doc.rdoc
+- lib/falsework/templates/ruby-cli/doc/LICENSE
+- lib/falsework/templates/ruby-cli/doc/NEWS.rdoc
+- lib/falsework/templates/ruby-cli/doc/README.rdoc
+- lib/falsework/templates/ruby-cli/etc/%%@project%%.yaml
+- lib/falsework/templates/ruby-cli/lib/%%@project%%/meta.rb
+- lib/falsework/templates/ruby-cli/test/helper.rb
+- lib/falsework/templates/ruby-cli/test/test_%%@project%%.rb
 - test/helper.rb
-- test/helper_trestle.rb
+- test/helper_cliutils.rb
 - test/rake_erb_templates.rb
 - test/rake_git.rb
 - test/templates/config-01.yaml
+- test/templates/config-02.yaml
 - test/test_cl.rb
 - test/test_exe.rb
 - test/test_mould.rb
-- lib/falsework/templates/ruby-naive/lib/%%@project%%/trestle.rb
-- lib/falsework/templates/ruby-naive/test/helper_trestle.rb
-- lib/falsework/templates/ruby-naive/test/rake_git.rb
+- lib/falsework/templates/ruby-cli/lib/%%@project%%/cliconfig.rb
+- lib/falsework/templates/ruby-cli/lib/%%@project%%/cliutils.rb
+- lib/falsework/templates/ruby-cli/test/helper_cliutils.rb
+- lib/falsework/templates/ruby-cli/test/rake_git.rb
 homepage: http://github.com/gromnitsky/falsework
 licenses: []
 post_install_message: 
 rdoc_options:
 - -m
 - doc/README.rdoc
+- -x
+- lib/.+/templates/
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement

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

@@ -1,31 +0,0 @@
-#!/usr/bin/env ruby
-# -*-ruby-*-
-
-require_relative '../lib/<%= @project %>/trestle.rb'
-
-include <%= @camelcase %>
-
-$conf = Hash.new
-$t = Trestle.new($conf)
-
-$conf[:banner] = "Usage: #{File.basename($0)} [options] hren'"
-$conf[:foobar] = ''
-
-
-# --[ main ]------------------------------------------------------------
-
-$t.config_parse(['foobar']) {|src|
-  o = $t.cl_parse(src) # create an OptionParser object
-  o.on('--foobar STR', 'An example of the option --foobar') {|i|
-    $conf[:foobar] = i
-  }
-  $t.cl_parse(src, o) # run cl parser
-}
-
-# print our env
-if $conf[:verbose] >= 2
-  puts 'Libs dir: ' + Trestle.gem_libdir
-  pp $conf
-end
-
-puts 'Hello, World!'

data/lib/falsework/templates/ruby-naive/lib/%%@project%%/trestle.rb

@@ -1,230 +0,0 @@
-# :erb:
-require 'yaml'
-require 'shellwords.rb'
-require 'optparse'
-require 'pp'
-require 'open4'
-
-require_relative 'meta'
-
-module <%= @camelcase %>
-  # A common routines from <%= @project %> with love.
-  class Trestle
-
-    # Execute _cmd_ and return a list [exit_status, stderr,
-    # stdout]. Very handy.
-    def self.cmd_run(cmd)
-      so = sr = ''
-      status = Open4::popen4(cmd) { |pid, stdin, stdout, stderr|
-        so = stdout.read
-        sr = stderr.read
-      }
-      [status.exitstatus, sr, so]
-    end
-
-    # Return a directory with program libraries.
-    def self.gem_libdir
-      t = ["#{File.dirname(File.realpath($0))}/../lib/#{<%= @camelcase %>::Meta::NAME}",
-           "#{Gem.dir}/gems/#{<%= @camelcase %>::Meta::NAME}-#{<%= @camelcase %>::Meta::VERSION}/lib/#{<%= @camelcase %>::Meta::NAME}",
-           "lib/#{<%= @camelcase %>::Meta::NAME}"]
-      t.each {|i| return i if File.readable?(i) }
-      fail "all paths are invalid: #{t}"
-    end
-
-    # Analogue to shell command +which+.
-    def self.in_path?(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
-
-    # Print an error message _t_ and exit if _ec_ > 0.
-    def self.errx(ec, t)
-      $stderr.puts File.basename($0) + ' error: ' + t.to_s
-      exit ec if ec > 0
-    end
-
-    # Print a warning.
-    def self.warnx(t)
-      $stderr.puts File.basename($0) + ' warning: ' + t.to_s
-    end
-
-    # #veputs uses this to decide to put a newline or not to put.
-    NNL_MARK = '__NNL__'
-
-    # Use this in your CL options to check if modifying some variable is
-    # not an idempotent act.
-    attr_reader :cl_opt_protect
-
-    # [conf] Typically must be a reference to some global variable.
-    def initialize(conf)
-      @conf = conf
-      @conf[:verbose] = 0
-      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
-      @conf[:config] =  Meta::NAME + '.yaml'
-      @conf[:config_dirs] =  [ENV['HOME']+'/.'+Meta::NAME,
-                              File.absolute_path("#{File.dirname(File.realpath($0))}/../etc"),
-                              '/usr/etc', '/usr/local/etc', '/etc',
-                              "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/etc"
-                             ]
-      @conf[:config_env] = [Meta::NAME.upcase + '_CONF']
-
-      @cl_parsing_times = 0 # not used
-      @cl_opt_protect = false
-    end
-
-    # [level] A verbose level.
-    # [t]     A string to print.
-    #
-    # Don't print _t_ with a newline if it contains NNL_MARK at the end.
-    def veputs(level, t)
-      t = t.dup
-      nnl = nil
-      if t.match(/#{NNL_MARK}$/)
-        t.sub!(/#{$&}/, '')
-        nnl = 1
-      end
-
-      if @conf[:verbose] >= level
-        nnl ? print(t) : print("#{t}\n")
-        $stdout.flush
-      end
-    end
-    
-    # Run all configuration parsing in a batch.
-    #
-    # [rvars] A list of variable names which must be in the
-    #         configuration file.
-    #
-    # If no block is given, only standard CL options will be analysed.
-    def config_parse(rvars, &block)
-      cb = ->(b, src) {
-        if b
-          block.call src
-        else
-          # very basic default options
-          cl_parse(src, nil, true)
-        end
-      }
-      
-      # 1. parse env
-      @conf[:config_env].each {|i|
-#        puts '0 run:'
-        cb.call(block_given?, ENV[i].shellsplit) if ENV.key?(i)
-      }
-
-      # 2. parse CL in case of '--config' option
-#      puts "\n1 run"
-      @cl_opt_protect = true
-      cb.call(block_given?, ARGV.dup)
-      @cl_opt_protect = false
-
-      # 3. load the configuration file & do the final CL parsing
-      begin
-#        puts "\n2 run"
-        r = config_flat_load(rvars)
-      rescue
-        Trestle.errx(1, "cannot load config: #{Trestle.get_backtrace}")
-      end
-      veputs(1, "OK") if r
-      cb.call(block_given?, ARGV)
-    end
-
-    # Load a config file immediately if it contains '/' in its name,
-    # otherwise search through several dirs for it.
-    #
-    # [rvars] a list of requied variables in the config
-    #
-    # Return a loaded filename or nil on error.
-    def config_flat_load(rvars)
-      p = ->(f) {
-        veputs(1, "Loading #{f}... " + NNL_MARK)
-        if File.file?(f)
-          begin
-            myconf = YAML.load_file(f)
-          rescue
-            abort("cannot parse #{f}: #{$!}")
-          end
-          rvars.each { |i|
-            fail "missing or nil '#{i}' in #{f}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
-          }
-          @conf.merge!(myconf)
-          return @conf[:config]
-        end
-        
-        veputs(1, "FAILED")
-        return nil
-      }
-
-      if @conf[:config].index('/')
-        return p.call(@conf[:config])
-      else
-        @conf[:config_dirs].each {|dir|
-          return dir+'/'+@conf[:config] if p.call(dir + '/' + @conf[:config])
-        }
-      end
-
-      return nil
-    end
-
-
-    # Parses CL-like options.
-    #
-    # [src] An array of options (usually +ARGV+).
-    #
-    # If _o_ is non nil function parses _src_ immediately, otherwise it
-    # only creates +OptionParser+ object and return it (if _simple_ is
-    # false).
-    def cl_parse(src, o = nil, simple = false)
-      if ! o then
-#        puts "NEW o (#{cl_opt_protect})" + src.to_s 
-        o = OptionParser.new
-        o.banner = @conf[:banner]
-        o.on('-v', 'Be more verbose.') { |i|
-#          puts "cl_parsing_times "+cl_parsing_times.to_s
-          @conf[:verbose] += 1 unless cl_opt_protect
-        }
-        o.on('-V', 'Show version & exit.') { |i|
-          puts Meta::VERSION
-          exit 0
-        }
-        o.on('--config NAME', "Set a config name (default is #{@conf[:config]}).") {|i|
-          @conf[:config] = i
-        }
-        o.on('--config-dirs', 'Show possible config locations.') {
-          mark = false
-          @conf[:config_dirs].each { |idx|
-            f = idx + '/' + @conf[:config]
-            if File.readable?(f) && !mark
-              puts "* " + f
-              mark = true
-            else
-              puts "  " + f
-            end
-          }
-          exit 0
-        }
-
-        return o if ! simple
-      end
-
-      begin
-        o.parse!(src)
-        @cl_parsing_times += 1
-      rescue
-        Trestle.errx(1, $!.to_s)
-      end
-    end
-
-    # A handy proc that return a nice formatted current global
-    # backtrace.
-    def self.get_backtrace
-      "#{$!}\n\nBacktrace:\n\n#{$!.backtrace.join("\n")}"
-    end
-    
-  end # trestle
-end
-
-# Don't remove this: falsework/1.3.0/ruby-naive/2012-01-27T02:39:48+02:00