falsework 2.1.1 → 3.0.0

data/templates/ruby-cli/#config.yaml

@@ -0,0 +1,26 @@
+---
+exe:
+- src: 'bin/%%@project%%'
+  dest: 'bin/%s'
+  mode_int: 0744
+
+doc:
+- src: 'doc/#doc.rdoc'
+  dest: 'doc/%s.rdoc'
+  mode_int: null
+
+test:
+- src: 'test/test_%%@project%%.rb'
+  dest: 'test/test_%s.rb'
+  mode_int: null
+
+version: 3.0.0
+
+upgrade:
+  obsolete:
+    - test/rake_git.rb
+  files:
+    - lib/%%@project%%/cliconfig.rb
+    - lib/%%@project%%/cliutils.rb
+    - test/helper_cliutils.rb
+  from: 2.0.0

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

@@ -1,21 +1,21 @@
-=Name
+= Name
 
 <%= @classy %>--[TODO: write a summary here.]
 
 
-==Synopsis
+== Synopsis
 
  <%= @project %> [options]
 
 
-==Description
+== Description
 
 The <%= @project %> utility [TODO: write a description here.]
 
 The options are as follows:
 
 --config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
+                            configuration file.
 
 --config NAME::             The name of the configuration file. If
                             it contains <tt>/</tt> in it, the list from
@@ -29,28 +29,26 @@ The options are as follows:
 
 --foobar NAME::             Huh?
 
-==Configuration
 
-<%= @project %> looks for its configuration at 3 places at start up.
+== Configuration
 
-1. At <tt><%= @project.upcase %>_CONF</tt> env variable.
-   (Its format is exactly similar to CL options.)
+From the least significant to the most:
 
-2. At the configuration file. Its default name is
-   <tt><%= @project %>.yaml</tt> and it can be stored in several
-   system directories which are observable by <tt>--config--dirs</tt> CL
-   option.
+1. <tt><%= @project.upcase %>_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
 
-3. At command line.
+2. Configuration file. Its default name is <tt><%= @project %>.yaml</tt>
+   and it can be stored in several directories which are observable by
+   <tt>--config--dirs</tt> CL option.
 
-Higher number levels overrides the values from lower number levels.
+3. Command line.
 
 The configuration file must be in YAML format. Look into <tt>`gem env
-gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for samples.
+gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for examples.
 
 
-==Examples
+== Examples
 
- % ri <%= @camelcase %>
- % <%= @project %> --config-dirs
- % <%= @project %> -V
+ $ ri <%= @camelcase %> # after gem installation
+ $ <%= @project %> --config-dirs
+ $ <%= @project %> -V

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

@@ -6,13 +6,13 @@ 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
+  o.on('--foobar STR', 'An example of the --foobar option') {|i|
+    $conf['foobar'] = i
   }
 }
 

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

@@ -1,21 +1,21 @@
-=Name
+= Name
 
 <%= target %>--[TODO: write a summary here.]
 
 
-==Synopsis
+== Synopsis
 
  <%= target %> [options]
 
 
-==Description
+== Description
 
 The <%= target %> utility [TODO: write a description here.]
 
 The options are as follows:
 
 --config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
+                            configuration file.
 
 --config NAME::             The name of the configuration file. If
                             it contains <tt>/</tt> in it, the list from
@@ -29,27 +29,25 @@ The options are as follows:
 
 --foobar NAME::             Huh?
 
-==Configuration
 
-<%= target %> looks for its configuration at 3 places at start up.
+== Configuration
 
-1. At <tt><%= @project.upcase %>_CONF</tt> env variable.
-   (Its format is exactly similar to CL options.)
+From the least significant to the most:
 
-2. At the configuration file. Its default name is
-   <tt><%= @project %>.yaml</tt> and it can be stored in several
-   system directories which are observable by <tt>--config--dirs</tt> CL
-   option.
+1. <tt><%= @project.upcase %>_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
 
-3. At command line.
+2. Configuration file. Its default name is <tt><%= @project %>.yaml</tt>
+   and it can be stored in several directories which are observable by
+   <tt>--config--dirs</tt> CL option.
 
-Higher number levels overrides the values from lower number levels.
+3. Command line.
 
 The configuration file must be in YAML format. Look into <tt>`gem env
-gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for samples.
+gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for examples.
 
 
-==Examples
+== Examples
 
- % <%= target %> --config-dirs
- % <%= target %> -V
+ $ <%= target %> --config-dirs
+ $ <%= target %> -V

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

@@ -1,21 +1,21 @@
-=Name
+= Name
 
 <%= @classy %>--[TODO: write a summary here.]
 
 
-==Synopsis
+== Synopsis
 
  <%= @project %> [options]
 
 
-==Description
+== Description
 
 The <%= @project %> utility [TODO: write a description here.]
 
 The options are as follows:
 
 --config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
+                            configuration file.
 
 --config NAME::             The name of the configuration file. If
                             it contains <tt>/</tt> in it, the list from
@@ -29,28 +29,26 @@ The options are as follows:
 
 --foobar NAME::             Huh?
 
-==Configuration
 
-<%= @project %> looks for its configuration at 3 places at start up.
+== Configuration
 
-1. At <tt><%= @project.upcase %>_CONF</tt> env variable.
-   (Its format is exactly similar to CL options.)
+From the least significant to the most:
 
-2. At the configuration file. Its default name is
-   <tt><%= @project %>.yaml</tt> and it can be stored in several
-   system directories which are observable by <tt>--config--dirs</tt> CL
-   option.
+1. <tt><%= @project.upcase %>_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
 
-3. At command line.
+2. Configuration file. Its default name is <tt><%= @project %>.yaml</tt>
+   and it can be stored in several directories which are observable by
+   <tt>--config--dirs</tt> CL option.
 
-Higher number levels overrides the values from lower number levels.
+3. Command line.
 
 The configuration file must be in YAML format. Look into <tt>`gem env
-gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for samples.
+gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for examples.
 
 
-==Examples
+== Examples
 
- % ri <%= @camelcase %>
- % <%= @project %> --config-dirs
- % <%= @project %> -V
+ $ ri <%= @camelcase %> # after gem installation
+ $ <%= @project %> --config-dirs
+ $ <%= @project %> -V

data/templates/ruby-cli/etc/%%@project%%.yaml

@@ -0,0 +1,2 @@
+--- 
+foobar: foo & bar

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

@@ -1,5 +1,3 @@
-# :erb: ruby-cli
-
 require 'pathname'
 require 'yaml'
 require 'optparse'
@@ -31,6 +29,7 @@ module <%= @camelcase %>
       @conf[:config_name] = Meta::NAME + '.yaml'
       @conf[:config_env] = Meta::NAME.upcase + '_CONF'
       @conf[:config_dirs] = DIR_CONFIG
+      @conf[:cl_parse_in_order] = false
     end
 
     # Setter for @conf
@@ -55,7 +54,7 @@ module <%= @camelcase %>
         }
       end
 
-      CliUtils.warnx "no config file '#{@conf[:config_name]}' found" if @conf[:verbose] >= 2
+      CliUtils.warnx "config file '#{@conf[:config_name]}' not found" if @conf[:verbose] >= 2
       return nil
     end
 
@@ -75,15 +74,15 @@ module <%= @camelcase %>
     # 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 EX_CONFIG, "option #{idx} is either nil or missing"
+        if !@conf.key?(idx) || !@conf[idx]
+          CliUtils.errx EX_CONFIG, "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
+    def optParse argv
       OptionParser.new do |o|
         o.on('-v', 'Be more verbose.') { |i|
           self[:verbose] += 1
@@ -118,7 +117,13 @@ module <%= @camelcase %>
         env = ENV[@conf[:config_env]].shellsplit if ENV.key?(@conf[:config_env])
 
         begin
-          [env, ARGV].each { |i| o.parse!(i) if i }
+          [env, argv].each { |i|
+            if @conf[:cl_parse_in_order]
+              o.order!(i) if i
+            else
+              o.parse!(i) if i
+            end
+          }
         rescue
           CliUtils.errx EX_USAGE, $!.to_s
         end
@@ -129,13 +134,11 @@ module <%= @camelcase %>
     #
     # [reqOpts] an array of requied options
     # [&block]  a optional block for OptionParser
-    def load(reqOpts = [], &block)
-      optParse(&block)
+    def load(reqOpts = [], argv = ARGV, &block)
+      optParse(argv, &block)
       loadFile
       requiredOptions?(reqOpts)
     end
     
   end
 end
-
-# Don't remove this: falsework/2.1.0/ruby-cli/2012-04-23T16:09:03+03:00

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

@@ -1,5 +1,3 @@
-# :erb: ruby-cli
-
 require 'pp'
 require 'open4'
 require 'pathname'
@@ -110,5 +108,3 @@ module <%= @camelcase %>
   end
 
 end
-
-# Don't remove this: falsework/2.1.0/ruby-cli/2012-04-23T16:09:03+03:00

data/{lib/falsework/templates → templates}/ruby-cli/lib/%%@project%%/meta.rb

@@ -1,3 +1,4 @@
+# :include: ../../README.rdoc
 module <%= @camelcase %>
   module Meta # :nodoc:
     NAME = '<%= @project %>'

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

@@ -1,4 +1,3 @@
-# :erb: ruby-cli
 # Various staff for minitest. Include this file into your 'helper.rb'.
 
 require 'fileutils'
@@ -30,5 +29,3 @@ def cmd(c)
 
   File.absolute_path('../bin/' + c)
 end
-
-# Don't remove this: falsework/2.1.0/ruby-cli/2012-04-23T16:09:03+03:00

data/test/example/note/full

@@ -0,0 +1,10 @@
+# DO NOT DELETE THIS FILE
+# unless you don't want to upgrade scaffolds in the future.
+---
+project:
+  classy: Foo Bar Pro
+  created: 2012-04-26T14:32:36+03:00
+
+template:
+  version: 2.1.1
+  name: ruby-cli

data/test/example/note/project-too-old

@@ -0,0 +1,8 @@
+---
+project:
+  classy: Foo Bar Pro
+  created: 2012-04-26T14:32:36+03:00
+
+template:
+  version: 1.2.3
+  name: ruby-cli

data/test/example/note/template-unknown

@@ -0,0 +1,8 @@
+---
+project:
+  classy: Foo Bar Pro
+  created: 2012-04-26T14:32:36+03:00
+
+template:
+  version: 2.1.1
+  name: practical-english-usage

data/test/helper.rb

@@ -1 +1,12 @@
 require_relative 'helper_cliutils'
+
+def ClearFakeFS
+  return ::FakeFS unless block_given?
+  ::FakeFS.activate!
+  
+  yield
+
+ensure
+  ::FakeFS.deactivate!
+  ::FakeFS::FileSystem.clear
+end

data/test/helper_cliutils.rb

@@ -1,4 +1,3 @@
-# :erb: ruby-cli
 # Various staff for minitest. Include this file into your 'helper.rb'.
 
 require 'fileutils'

data/test/templates/config-01.yaml

@@ -1,2 +1,2 @@
 ---
-:tdir: ['templates']
+tdir: ['templates']

data/test/{test_exe.rb → test_cli.rb}

@@ -1,35 +1,25 @@
 require_relative 'helper'
 
-class TestExecution < MiniTest::Unit::TestCase
+# Heavy & slow.
+class TestCommandLine < MiniTest::Unit::TestCase
   def setup
     # this runs every time before test_*
     @cmd = cmd('falsework') # get path to the exe & cd to tests directory
   end
 
-  def test_project_list
-    r = CliUtils.exec "#{@cmd} list"
-    assert_equal(0, r[0])
-    assert_match(/ruby-cli/, r[2])
-  end
-
-  # very silly analogue of "sed -i'' -E 's/foo/bar/g' file"
-  def sed(file, re, repl)
-    o = File.read(file).gsub(re, repl)
-    File.open(file, 'w+') {|fp| fp.printf(o) }
-  end
-  
   def test_project_ruby_cli
     rm_rf 'templates/foo'
-    r = CliUtils.exec "#{@cmd} new templates/foo -v"
+    r = CliUtils.exec "#{@cmd} -v new templates/foo"
 #    pp r
     assert_equal(0, r[0], r)
 
     out = r[2].split("\n")
     assert_match(/^Project path: \//, out[0])
-    assert_equal("L: README.rdoc => doc/README.rdoc", out[-2])
+    assert_equal "N: .falsework", out[-2]
     assert_match(/Creating a git repository in .+... OK/, out[-1])
 
-    tree = ["templates/foo/.git",
+    tree = ["templates/foo/.falsework",
+            "templates/foo/.git",
             "templates/foo/.gitignore",
             "templates/foo/Gemfile",
             "templates/foo/README.rdoc",
@@ -62,12 +52,15 @@ class TestExecution < MiniTest::Unit::TestCase
       # check rake
       r = CliUtils.exec "rake -T"
       assert_equal 0, r[0]
+
+      # bundler targets test
+      r = CliUtils.exec "rake build"
+      assert_equal 0, r[0]
       
       # add files
       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]
@@ -79,30 +72,44 @@ class TestExecution < MiniTest::Unit::TestCase
 
       # upgrade
       r = CliUtils.exec "#{@cmd} upgrade -b"
-      assert_equal(0, r[0])
+#      pp r
+      assert_equal 0, r[0]
       rm ['test/helper_cliutils.rb']
+      
       r = CliUtils.exec "#{@cmd} upgrade -b"
-      assert_equal(0, r[0])
-      sed 'test/helper_cliutils.rb',
-      /^(# Don't.+falsework\/)\d+\.\d+\.\d+(\/.+)$/, '\1999.999.999\2'
-      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')
+      assert_equal 0, r[0]
+      
+      File.open('test/helper_cliutils.rb', 'w+') {|fp| fp.puts 'garbage' }
+      r = CliUtils.exec "#{@cmd} upgrade -b --save"
+      assert_equal 0, r[0]
+
+      mv 'test', 'ttt'
       r = CliUtils.exec "#{@cmd} upgrade -b"
-      assert_equal(0, r[0])
+      assert_equal 0, r[0]
+
+      # upgrade info
+      r = CliUtils.exec "#{@cmd} upgrade check"
+      assert_equal 0, r[0]
+      
+      r = CliUtils.exec "#{@cmd} upgrade list"
+      assert_equal 0, r[0]
+      assert_operator 1, :<=, r[2].split("\n").size
+
+      r = CliUtils.exec "#{@cmd} upgrade list obsolete"
+      assert_equal 0, r[0]
+      assert_operator 1, :<=, r[2].split("\n").size
     }
   end
 
   def test_project_invalid_name
     r = CliUtils.exec "#{@cmd} new 123"
-    assert_equal(1, r[0])
+    assert_equal(EX_SOFTWARE, r[0])
     assert_match(/invalid project name/, r[1])
   end
 
   def test_project_c_glib
     rm_rf 'templates/c_glib'
-    r = CliUtils.exec "#{@cmd} new templates/c-glib -t c-glib --no-git"
+    r = CliUtils.exec "#{@cmd} -t c-glib new templates/c-glib --no-git"
     assert_equal(0, r[0])
 
     Dir.chdir('templates/c_glib') {
@@ -110,7 +117,6 @@ class TestExecution < MiniTest::Unit::TestCase
       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 = CliUtils.exec "#{@cmd} -t c-glib test q-q-q"
       assert_equal(0, r[0])
@@ -133,4 +139,21 @@ class TestExecution < MiniTest::Unit::TestCase
       }
     }
   end
+
+  def test_new_dir_from_config
+    r = CliUtils.exec "#{@cmd} --config /NO_SUCH_FILE.yaml list dirs"
+    assert_equal(0, r[0])
+    assert_equal(2, r[2].split("\n").size)
+    
+    r = CliUtils.exec "#{@cmd} --config templates/config-01.yaml list dirs"
+    assert_equal(0, r[0])
+    assert_equal(3, r[2].split("\n").size)
+  end
+
+  def test_project_list
+    r = CliUtils.exec "#{@cmd} list"
+    assert_equal(0, r[0])
+    assert_match(/ruby-cli/, r[2])
+  end
+
 end