falsework 2.1.1 → 3.0.0

data/README.rdoc

@@ -17,21 +17,23 @@ Initially the template spec was designed only for Ruby projects but
 later (from version 1.3.0) hard-coded Ruby staff was removed which added
 more flexibility.
 
-The generated project <b>is not dependent</b> on falsework. The utility
-can also add skeletons for tests end executables <i>after</i> the
+Generated projects <b>are not dependent</b> on falsework. The utility
+can also add skeletons for tests end executables <b>after</b> the
 project generation.
 
 
 ==Ruby Template
 
-... is default. It generates a scaffold which have:
+... is default. It generates a scaffold which has:
 
 * auto-created git (but not github) project;
 
-* <tt>gem</tt> (a file list is pulled from the git repository, <b>no more
-  missing files in gems!</b>), <tt>doc</tt>, <tt>test</tt> targets;
+* <tt>gemspec</tt> (a file list is pulled from the git repository),
+  <tt>doc</tt>, <tt>test</tt> targets; +build+, +install+ & +release+
+  bundler targets.
 
-* easy to use configuration parser/loader. This includes scanning for:
+* easy to use configuration parser/loader. This includes auto-scanning
+  for:
 
   * env variable(s);
   * the flat YAML configuration file;
@@ -45,83 +47,41 @@ Version & name of your project can be located at generated
 
 ==Options
 
-The commands:
+Run
 
-list::                      Do nothing except listing all available
-                            templates. You can add your own templates in
-                            <tt>~/.falsework/templates</tt> directory.
+ $ falsework -h
 
-listdirs::                  Do nothing except listing all available
-                            templates directories. You can add another
-                            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.
+to read all possible commands & global options. All of them, except
++new+ & +list+, work from the root project directory.
 
-The following commands works only from the root project directory:
+Some of the commands support <tt>-h</tt> option too, for example:
 
-exe NAME::                  Add a new executable to an existing
-                            project and a corresponding doc in
-                            <tt>doc</tt> sub-directory.
-
-doc NAME::                  Add a new doc file in
-                            <tt>doc</tt> sub-directory.
-                            
-test NAME::                 Add a new test in
-                            <tt>test</tt> sub-directory.
-
-upgrade::                   'Inject' or upgrade some vital files from the
-                            template into the project. Currently only
-                            'ruby-cli' template supports this.
-
-The options are as follows:
-
--t::                        A template name.
-
--b::                        A batch mode. (No questions asked.)
-
---no-git::                  Don't create a Git repository. Don't use
-                            this for 'ruby-cli' template.
-
---config-dirs::             List all possible locations for the
-                            configuration file. The first found wins.
-
---config NAME::             The name of the configuration file. If
-                            it contains <tt>/</tt> in it, the list from
-                            <tt>--config-dirs</tt> is ignored.
-
--V::                        Show falsework version and exit.
-
--v::                        Be more verbose. You can supply it several
-                            times, viz. <tt>-vv</tt> dumps even more
-                            debug info.
+ $ falsework upgrade -h
 
 
 ==Examples
 
 Create a new project:
 
- % falsework -v new foobar
+ $ falsework -v new foobar
 
 Add another CL util to the existing project:
 
- % pwd
+ $ pwd
  .../foobar
- % falsework exe foo
+ $ falsework exe foo
 
 (It will appear in <tt>bin/</tt> sub-directory.)
 
 Add another test file:
 
- % falsework test foo
+ $ falsework test foo
 
 (It will appear in <tt>test/</tt> sub-directory.)
 
 Create a project from another template:
 
- % falsework -t c-glib -v new foo-bar
+ $ falsework -t c-glib -v new foo-bar
 
 
 ==Bugs

data/Rakefile

@@ -2,31 +2,39 @@
 
 require 'rake/clean'
 require 'rake/testtask'
-require 'bundler/gem_tasks'
 gem 'rdoc'
 require 'rdoc/task'
 
-# Generate dynamic targets
-require_relative 'test/rake_erb_templates'
-
-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-cli', t.name, t.prerequisites[0])
-  end
-}
-
-desc "Generate ruby-cli dynamic files"
-file 'dynamic.ruby-cli' => ERB_DYN_SKELETON.keys do |t|
-  File.open(t.name, 'w+') {|fp|
-    ERB_DYN_SKELETON.keys.map {|i|
-      fp.puts i.sub(/#{Dir.pwd}\//, '')
-    }
+require 'yaml'
+require_relative 'lib/falsework/mould'
+
+def src2template target, prerequisite
+  src = File.read prerequisite
+  src.gsub! /#{Meta::NAME}/, '<%= @project %>'
+  src.gsub! /#{Mould.name_camelcase(Meta::NAME)}/, '<%= @camelcase %>'
+
+  File.open(target, 'w+') {|fp| fp.puts src }
+  puts "Created: #{target}"
+end
+
+# Create a dynamic target list
+def dynTargets
+  YAML.load_file 'dynamic.yaml'
+end
+
+DYNAMICS = dynTargets
+
+desc "Generate some dynamic template files"
+task :dynamic do
+  DYNAMICS.each {|key, val|
+    src2template key, val
   }
 end
 
 # add rubi-cli dynamic files to a clobber target
-CLOBBER.concat ERB_DYN_SKELETON.keys
+CLOBBER.concat DYNAMICS.keys
+
+require 'bundler/gem_tasks'
 
 task default: [:test]
 
@@ -40,5 +48,5 @@ Rake::TestTask.new do |i|
   i.test_files = FileList['test/test_*.rb']
 end
 
-task test: ['dynamic.ruby-cli']
-task build: ['dynamic.ruby-cli']
+task test: [:dynamic]
+task build: [:dynamic]

data/bin/falsework

@@ -2,28 +2,216 @@
 # -*-ruby-*-
 
 require_relative '../lib/falsework/cliconfig'
-require_relative '../lib/falsework/mould'
+require_relative '../lib/falsework/upgrader'
 
 include Falsework
 
-$conf = CliConfig.new
-$conf[:banner] = <<EOF
-Usage: #{File.basename($0)} [options] command ...
-Available commands: list, listdirs, (new|exe|doc|test) NAME, upgrade.
-EOF
-$conf[:user] = nil
-$conf[:gecos] = nil
-$conf[:email] = nil
-$conf[:template] = nil
-$conf[:batch] = false
-$conf[:git] = true
+module Commands
+  extend self
+
+  FORMAT = {
+    'new' => {
+      :help => 'Create a new project',
+      :arg => true,
+      :code => Proc.new {|arg| newProject arg },
+      :optionparse => Proc.new {|arg|
+        OptionParser.new do |o|
+          o.banner = "Usage: #{File.basename($0)} [options] new [options] NAME"
+          o.separator ""
+
+          o.on('--no-git', "Don't create a git repo.",
+               "(Will break 'ruby-cli'.)") { $conf[:git] = false }
+          o.on('--no-note', "Don't create a note file.") {
+            $conf[:note] = false
+          }
+          
+          o.parse!(arg)
+        end
+      }
+    },
+    
+    'list' => {
+      :help => 'List all available templates',
+      :code => Proc.new {|arg| list arg},
+      
+      'dirs' => {
+        :help => 'List all reachable template directories',
+        :code => Proc.new {|arg| listDirs arg}
+      }
+    },
+    
+    'upgrade' => {
+      :help => 'Upgrade current project',
+      :optionparse => Proc.new {|arg|
+        OptionParser.new do |o|
+          o.banner = "Usage: #{File.basename($0)} [options] upgrade [options] [command [command]]"
+          o.separator ""
+          o.on('-b', "Don't ask any questions.") {
+            $conf[:upgrader][:batch] = true
+          }
+          o.on('--save', "Keep old files as a copy with .orig", "extension.") {
+            $conf[:upgrader][:save] = true
+          }
+          
+          o.parse!(arg)
+        end
+      },
+      :code => Proc.new {|arg| upgrade arg},
+      
+      'check' => {
+        :help => 'Check if project can be upgraded',
+        :code => Proc.new {|arg| upgradeCheck arg}
+      },
+      'list' => {
+        :help => 'List files that will be updated',
+        :code => Proc.new {|arg| upgradeListFiles arg },
+        'obsolete' => {
+          :help => 'List files that can be deleted',
+          :code => Proc.new {|arg| upgradeListObsolete arg }
+        }
+      }
+    },
+
+    'exe' => {
+      :help => 'Add a new executable to an existing project',
+      :arg => true,
+      :code => Proc.new {|arg| addFiles 'exe', arg }
+    },
+    'doc' => {
+      :help => 'Add a new documentation file to an existing project',
+      :arg => true,
+      :code => Proc.new {|arg| addFiles 'doc', arg }
+    }, 
+    'test' => {
+      :help => 'Add a new test file to an existing project',
+      :arg => true,
+      :code => Proc.new {|arg| addFiles 'test', arg }
+    },
+    'file' => {
+      :help => 'Add a new file to an existing project',
+      :arg => true,
+      :code => Proc.new {|arg| addFiles 'file', arg }
+    }
+  }
+
+  DELIM = '~<x>~'
+
+  def tree start, r, indent = ''
+    start.each {|key, val|
+      next if key.is_a?(Symbol)
+      
+      t = indent
+      t += key
+      t += ' ARG' if val[:arg]
+      t += DELIM + val[:help]
+      r[:t] << t
+
+      # recursion
+      tree val, r, indent + '  '
+    }
+  end
+
+  def help
+    r = {}
+    r[:t] = []
+    tree FORMAT, r
+
+    max = 0
+    r[:t].each {|idx|
+      left = idx.split(DELIM).first
+      max = left.size if max < left.size
+    }
+
+    r[:t].each_with_index {|idx, index|
+      left = idx.split(DELIM).first
+      spaces = ' ' + ('.' * (max - left.size)) + '.... '
+      r[:t][index].sub!(/#{DELIM}/, spaces)
+    }
+
+    r[:t].join "\n"
+  end
+
+  def traverse format, argv
+    command = argv.first
+
+    found = false
+    format.each {|key, val|
+      if key == command
+        begin
+          format[key][:optionparse].call argv if format[key][:optionparse]
+        rescue
+          CliUtils.errx EX_USAGE, $!
+        end
+        
+        if format[key][:arg] || argv.size == 1
+          found = true
+          CliUtils.veputs 2, "Executing '#{key}'"
+          format[key][:code].call argv[1..-1]
+          break
+        else
+          # recursion
+          found = traverse val, argv[1..-1]
+        end
+      end
+    }
+
+    found
+  end
+  
+end
+
+def list args
+  Mould.templates.each {|name, loc|
+    loc = '(system)' if loc == (Mould.template_dirs.first + name)
+    puts "%-30s %s" % [name, loc]
+  }
+end
+
+def listDirs args
+  Mould.template_dirs.each {|idx| puts idx }
+end
+
+def newProject args
+  CliUtils.errx EX_USAGE, 'missing argument' if args.size == 0
+  name = args.first
+  
+  if File.dirname(name) != '.'
+    Dir.chdir(File.dirname(name)) rescue CliUtils.errx(EX_UNAVAILABLE, "cannot chdir to '#{File.dirname(name)}'")
+    name = File.basename name
+  end
+
+  ok = false
+  begin
+    m = Mould.new(name, $conf[:template],
+                  $conf[:user], $conf[:email], $conf[:gecos])
+    ok = m.project_seed
+  rescue
+    CliUtils.errx EX_SOFTWARE, $!
+  end
+  CliUtils.errx EX_SOFTWARE, "hm, nothing was created" unless ok
+
+  m.noteCreate if $conf[:note]
+
+  # create a git repository
+  if $conf[:git]
+    Dir.chdir m.project
+    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}."
+    CliUtils.veputs 1, 'OK'
+  end
+end
 
-def add_files(mode, files)
+def addFiles mode, files
+  CliUtils.errx EX_USAGE, 'missing argument(s)' if files.size == 0
+  
   r = true
   m = Mould.new(File.basename(Dir.pwd), $conf[:template],
                 $conf[:user], $conf[:email], $conf[:gecos])
+  
   files.each {|i|
-    created = m.add(mode, i) rescue CliUtils.errx(1, $!.to_s)
+    created = m.add(mode, i) rescue CliUtils.errx(1, $!)
     if created.size > 0
       created.each {|idx| CliUtils.veputs(1, idx) }
     else
@@ -31,24 +219,79 @@ def add_files(mode, files)
     end
   }
 
-  r
+  exit 1 unless r
+end
+
+def upgradeCheck args
+  u = Upgrader.new '.'
+  CliUtils.errx EX_UNAVAILABLE, "project '#{u.project}' cannot be upgraded" unless u.able?
+  CliUtils.veputs 1, "Yup, it's possible."
+rescue UpgradeError, MouldError
+  CliUtils.errx 1, $!
+end
+
+def upgradeListFiles args
+  u = Upgrader.new '.'
+  exit EX_UNAVAILABLE unless u.able?
+  u.files.each {|i|
+    puts Mould.resolve_filename i, u.getProjectBinding
+  }
+rescue UpgradeError, MouldError
+  CliUtils.errx 1, $!
+end
+
+def upgradeListObsolete args
+  u = Upgrader.new '.'
+  exit EX_UNAVAILABLE unless u.able?
+  exit EX_UNAVAILABLE unless u.obsolete.size > 0
+  u.obsolete.each {|i|
+    puts Mould.resolve_filename i, u.getProjectBinding
+  }
+rescue UpgradeError, MouldError
+  CliUtils.errx 1, $!
+end
+
+def upgrade args
+  u = Upgrader.new '.'
+  u.batch = $conf[:upgrader][:batch]
+  u.upgrade $conf[:upgrader][:save]
+rescue UpgradeError, MouldError
+  CliUtils.errx 1, $!
 end
 
 
 ### main
 
+$conf = CliConfig.new
+$conf[:cl_parse_in_order] = true
+$conf[:banner] = <<EOF
+Usage: #{File.basename($0)} [options] command ...
+
+Available commands:
+
+#{Commands.help}
+
+EOF
+$conf[:user] = nil
+$conf[:gecos] = nil
+$conf[:email] = nil
+$conf[:template] = nil
+$conf[:git] = true
+$conf[:note] = true
+
+$conf[:upgrader] = {}
+$conf[:upgrader][:batch] = false
+$conf[:upgrader][:save] = false
+
 $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 }
 }
 
-CliUtils.errx(EX_USAGE, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] !~ /list|upgrade/)
+CliUtils.errx(EX_USAGE, $conf[:banner]) if ARGV.size == 0
 
 # print our env
 if $conf[:verbose] >= 2
@@ -57,57 +300,7 @@ if $conf[:verbose] >= 2
 end
 
 # modify a list of available template directories
-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).to_s
-    puts "%-30s %s" % [name, loc]
-  }
-  
-when 'listdirs'
-  Mould.class_variable_get(:@@template_dirs).each {|idx|
-    puts idx
-  }
-  
-when /exe|doc|test/
-  r1 = add_files ARGV[0], ARGV[1..-1]
-  r2 = true
-  (r2 = add_files 'doc', ARGV[1..-1]) if ARGV[0] == 'exe'
-  exit 1 if !r1 || !r2
-  
-when 'upgrade'
-  m = Mould.new(File.basename(Dir.pwd), $conf[:template],
-                $conf[:user], $conf[:email], $conf[:gecos])
-  m.verbose = true if $conf[:verbose] > 0
-  m.batch = $conf[:batch]
-  m.upgrade() rescue CliUtils.errx(1, $!.to_s)
-
-when 'new'
-  if 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
+Mould.template_dirs_add $conf['tdir'].map {|i| Pathname.new i} if $conf['tdir']
 
-  begin
-    m = Mould.new(ARGV[1], $conf[:template],
-                  $conf[:user], $conf[:email], $conf[:gecos])
-  rescue
-    CliUtils.errx 1, $!
-  end
-  m.verbose = true if $conf[:verbose] > 0
-  m.project_seed
-
-  # create a git repository
-  if $conf[:git]
-    Dir.chdir m.project
-    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}."
-    CliUtils.veputs(1, 'OK')
-  end
-else
-  CliUtils.errx(1, "unknown command: " + ARGV[0])
-end
+found = Commands.traverse Commands::FORMAT, ARGV
+CliUtils.errx EX_USAGE, "unknown command '#{ARGV.join ' '}'" unless found

data/doc/NEWS.rdoc

@@ -1,3 +1,27 @@
+=== 3.0.0
+
+Sun Apr 29 12:22:27 EEST 2012
+
+* *INCOMPATIBILITY:* symbols in template's <tt>#config.yaml</tt> are
+  strings.
+
+* *INCOMPATIBILITY:* 'listdirs' is 'list dirs' now.
+
+* *INCOMPATIBILITY:* <tt>:tdir</tt> symbol in falsework.yaml is a string 'tdir'.
+
+* *INCOMPATIBILITY:* CLO are parsed from left to right only & some
+  options are command-specific, for example, 'falsework new foo -v -t
+  c-glib' won't work, because 'new' command doesn't know '-v' and '-t'
+  options (they are global).
+
+* New command: file.
+
+* 'upgrade' command has subcommands: list, list obsolete, check.
+
+* Upgrading procedure injects a special 'note' into projects:
+  <tt>.falsework</tt> file. Upgraded files are no longer contain
+  embedded marks in them.
+
 === 2.1.0
 
 Mon Apr 23 16:17:18 EEST 2012