falsework 0.2.8 → 1.3.0

data/{lib/falsework/templates/naive/Gemfile.erb → Gemfile}

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

data/Gemfile.lock

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

data/README.rdoc

@@ -1,7 +1,6 @@
 =Name
 
-falsework--A primitive scaffold generator for writing CLI programs in
-Ruby.
+falsework--A primitive scaffold generator for writing CLI programs.
 
 
 ==Synopsis
@@ -11,14 +10,28 @@ Ruby.
 
 ==Description
 
-The falsework utility generates a scaffold which have:
+The falsework utility ships with 2 templates: <tt>ruby-naive</tt> and
+<tt>c-glib</tt>.
+
+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
+project generation.
+
+
+==Ruby Template
+
+... is default. It generates a scaffold which have:
 
 * auto-created git (but not github) project;
 
-* <tt>gem</tt> (a file list is pulled from the git repository, no more
-  missing files in gems!), <tt>doc</tt>, <tt>test</tt> targers;
+* <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;
 
-* easy to use configuraton parser/loader. This includes scanning for:
+* easy to use configuration parser/loader. This includes scanning for:
 
   * env variable(s);
   * the flat YAML configuration file;
@@ -26,10 +39,11 @@ The falsework utility generates a scaffold which have:
 
 * an ability to pick up a user name & an email for a github project.
 
-The generated project <b>is not dependent</b> on falsework.
+Version & name of your project can be located at generated
+<tt>myproject/lib/myproject/meta.rb</tt> file.
+
 
-The utility can also add skeletons for tests end executables
-<i>after</i> the project generation.
+==Options
 
 The commands:
 
@@ -37,21 +51,29 @@ list::                      Do nothing except listing all available
                             templates. You can add your own templates in
                             <tt>~/.falsework/templates</tt> directory.
 
+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).
+                            
 new NAME::                  Create a new project. It creates a directory
                             <i>NAME</i> and populates it with files.
 
 The following commands works only from the root project directory:
 
 exe NAME::                  Add a new executable to an existing
-                            project and a corresponding <tt>.rdoc</tt>
-                            file in <tt>doc</tt> subdirectory.
+                            project and a corresponding doc in
+                            <tt>doc</tt> sub-directory.
 
-test NAME::                 Add a new minitest.
+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
-                            default 'naive' template into the
-                            project. (<b>Warning:</b> this works only
-                            from version 0.2.2 and (hopefully) above.)
+                            template into the project. Currently only
+                            'ruby-naive' template supports this.
 
 The options are as follows:
 
@@ -59,6 +81,9 @@ 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.
+
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.
 
@@ -72,11 +97,6 @@ The options are as follows:
                             times, viz. <tt>-vv</tt> dumps even more
                             debug info.
 
-==Meta
-
-Version & name of your project can be located at generated
-<tt>myproject/lib/myproject/meta.rb</tt> file.
-
 
 ==Examples
 
@@ -98,13 +118,17 @@ Add another test file:
 
 (It will appear in <tt>test/</tt> sub-directory.)
 
+Create a project from another template:
+
+ % falsework -t c-glib -v new foo-bar
+
 
 ==Bugs
 
 While falsework supports symlinks in templates, rubygems replaces
 symlinks with its corresponding source files. That is why you'll get 2
 <tt>README.rdoc</tt> files in generated project when it was intended to
-have 1 in <tt>doc</tt> subdirectory and the symlink to it in the root
+have 1 in <tt>doc</tt> sub-directory and the symlink to it in the root
 project directory.
 
 If you think that this is pathetic, then just grab the source of

data/Rakefile

@@ -18,14 +18,14 @@ require_relative 'test/rake_git'
 #
 require_relative 'test/rake_erb_templates'
 
-ERB_DYN_SKELETON = erb_skeletons(Meta::NAME, 'naive')
+ERB_DYN_SKELETON = erb_skeletons(Meta::NAME, 'ruby-naive')
 ERB_DYN_SKELETON.each {|k, v|
   file k => [v] do |t|
-    erb_make(Meta::NAME, 'naive', t.name, t.prerequisites[0])
+    erb_make(Meta::NAME, 'ruby-naive', t.name, t.prerequisites[0])
   end
 }
 
-desc "Generate some erb templates for naive template"
+desc "Generate some erb templates for ruby-naive template"
 task naive: ERB_DYN_SKELETON.keys
 
 CLOBBER.concat ERB_DYN_SKELETON.keys
@@ -57,7 +57,7 @@ spec = Gem::Specification.new {|i|
   i.extra_rdoc_files = FileList['doc/*']
 
   i.add_dependency('git', '>=  1.2.5')
-  i.add_dependency('open4', '>= 1.1.0')
+  i.add_dependency('open4', '>= 1.2.0')
 }
 
 Gem::PackageTask.new(spec).define
@@ -67,7 +67,7 @@ task default: [:naive, :repackage]
 RDoc::Task.new('html') do |i|
   i.main = 'doc/README.rdoc'
   i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
-  i.rdoc_files.exclude("lib/**/templates")
+  i.rdoc_files.exclude("lib/**/templates/**/*")
 end
 
 Rake::TestTask.new do |i|

data/bin/falsework

@@ -6,28 +6,46 @@ require_relative '../lib/falsework/mould'
 include Falsework
 
 $conf = Hash.new
-u = Trestle.new($conf)
+$t = Trestle.new($conf)
 
 $conf[:banner] = <<EOF
 Usage: #{File.basename($0)} [options] command ...
-Available commands: list, new NAME, exe NAME, test NAME or upgrade.
+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
+
+def add_files(mode, files)
+  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 Trestle.errx(1, $!.to_s)
+    if created.size > 0
+      created.each {|idx| $t.veputs(1, idx) }
+    else
+      r = false
+    end
+  }
+
+  r
+end
 
 # --[ main ]------------------------------------------------------------
 
-u.config_parse(['foobar']) {|src|
-  o = u.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}
+$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('-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}
-  u.cl_parse(src, o) # run cl parser
+  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
 }
 
 Trestle.errx(1, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] !~ /list|upgrade/)
@@ -38,40 +56,58 @@ if $conf[:verbose] >= 2
   pp $conf
 end
 
+# modify a list of available template directories
+Mould.template_dirs_add $conf[:tdir]
+
 case ARGV[0]
 when 'list'
-  Mould.templates.each_key {|i| puts(i)}
-when /exe|test/
-  m = Mould.new(File.basename(Dir.pwd), $conf[:user], $conf[:email], $conf[:gecos])
-  ARGV[1..-1].each {|i|
-    u.veputs(1, "Generating #{i}... __NNL__")
-#    u.veputs(1, m.create($conf[:template], ARGV[0], i) + '... __NNL__')
-    m.add($conf[:template], ARGV[0], i)
-    u.veputs(1, 'OK')
+  Mould.templates.each {|name, loc|
+    loc = '(system)' if loc == Mould.class_variable_get(:@@template_dirs)[0] +'/'+ name
+    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[:user], $conf[:email], $conf[:gecos])
+  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($conf[:template]) rescue Trestle.errx(1, $!.to_s)
+  m.upgrade() rescue Trestle.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])}'")
     ARGV[1] = File.basename ARGV[1]
   end
-  Trestle.errx(1, 'project name cannot start with a digit') if ARGV[1].strip[0] =~ /\d/
 
-  m = Mould.new(ARGV[1], $conf[:user], $conf[:email], $conf[:gecos])
+  begin
+    m = Mould.new(ARGV[1], $conf[:template],
+                  $conf[:user], $conf[:email], $conf[:gecos])
+  rescue
+    Trestle.errx 1, $!
+  end
   m.verbose = true if $conf[:verbose] > 0
-  m.project_seed($conf[:template], nil)
+  m.project_seed
 
   # create a git repository
-  Dir.chdir ARGV[1]
-  u.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}.")
-  u.veputs(1, 'OK')
+  if $conf[:git]
+    Dir.chdir m.project
+    $t.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')
+  end
 else
   Trestle.errx(1, "unknown command: " + ARGV[0])
 end

data/doc/NEWS.rdoc

@@ -1,49 +1,76 @@
+=== 1.3.0
+
+Mon Nov  7 07:15:00 EET 2011
+
+* <b>WARNING:</b> 'naive' template is now called 'ruby-naive'. To upgrade
+  to a new template you must manually find all files in your project
+  directory which contain a line like:
+
+    # Don't remove this: falsework/0.2.8/naive/2011-08-05T16:59:19+03:00
+
+  and replace it to:
+  
+    # Don't remove this: falsework/0.2.8/ruby-naive/2011-08-05T16:59:19+03:00
+
+  Then run 'falsework upgrade' as usual.
+	
+* Added 'c-glib' template.
+
+* '--no-git' CLO.
+
+* Generalized template spec: it's possible to have templates for
+  non-Ruby programs.
+
+* Template may have a '#config.yaml' file in its root directory.
+
+* 'list' command displays a directory where the template is located.
+
 === 0.2.8
 
 Fri Aug  5 16:57:06 EEST 2011
 
-- Fixed a bug with minitest's capture_io.
+* Fixed a bug with minitest's capture_io.
 
 === 0.2.7
 
 Sun Jul 17 01:23:32 EEST 2011
 
-- Fixed a bug with symlinks in Trestle.gem_libdir.
+* Fixed a bug with symlinks in Trestle.gem_libdir.
 
 === 0.2.6
 
 Fri Jul 15 20:07:45 EEST 2011
 
-- Updates for rubygems 1.8.5 and rake 0.9.2.
+* Updates for rubygems 1.8.5 and rake 0.9.2.
 
 === 0.2.4
 
 Thu May  5 23:45:24 EEST 2011
 
-- Minor Rakefile update (including the template) to reflect rubygems 1.8
+* Minor Rakefile update (including the template) to reflect rubygems 1.8
   changes.
 
-- Added Gemfile.erb to naive template.
+* Added Gemfile.erb to naive template.
 
 === 0.2.3
 
 Mon Jan  3 12:41:16 EET 2011
 
-- 'exe' command will add 2 files: an executable and a corresponding
+* 'exe' command will add 2 files: an executable and a corresponding
   .rdoc file.
 
-- Fix a small bug in naive template.
+* Fix a small bug in naive template.
 
 === 0.2.2
 
 Sun Dec 26 04:48:46 EET 2010
 
--  An ability to upgrade a project from a newest template.
+*  An ability to upgrade a project from a newest template.
 
 === 0.1.2
 
 Wed Dec 22 19:09:01 EET 2010
 
-- Create a git repository automatically for a new project.
+* Create a git repository automatically for a new project.
 
-- Generate a gem file list from git ls-tree.
+* Generate a gem file list from git ls-tree.

data/doc/README.rdoc

@@ -1,7 +1,6 @@
 =Name
 
-falsework--A primitive scaffold generator for writing CLI programs in
-Ruby.
+falsework--A primitive scaffold generator for writing CLI programs.
 
 
 ==Synopsis
@@ -11,14 +10,28 @@ Ruby.
 
 ==Description
 
-The falsework utility generates a scaffold which have:
+The falsework utility ships with 2 templates: <tt>ruby-naive</tt> and
+<tt>c-glib</tt>.
+
+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
+project generation.
+
+
+==Ruby Template
+
+... is default. It generates a scaffold which have:
 
 * auto-created git (but not github) project;
 
-* <tt>gem</tt> (a file list is pulled from the git repository, no more
-  missing files in gems!), <tt>doc</tt>, <tt>test</tt> targers;
+* <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;
 
-* easy to use configuraton parser/loader. This includes scanning for:
+* easy to use configuration parser/loader. This includes scanning for:
 
   * env variable(s);
   * the flat YAML configuration file;
@@ -26,10 +39,11 @@ The falsework utility generates a scaffold which have:
 
 * an ability to pick up a user name & an email for a github project.
 
-The generated project <b>is not dependent</b> on falsework.
+Version & name of your project can be located at generated
+<tt>myproject/lib/myproject/meta.rb</tt> file.
+
 
-The utility can also add skeletons for tests end executables
-<i>after</i> the project generation.
+==Options
 
 The commands:
 
@@ -37,21 +51,29 @@ list::                      Do nothing except listing all available
                             templates. You can add your own templates in
                             <tt>~/.falsework/templates</tt> directory.
 
+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).
+                            
 new NAME::                  Create a new project. It creates a directory
                             <i>NAME</i> and populates it with files.
 
 The following commands works only from the root project directory:
 
 exe NAME::                  Add a new executable to an existing
-                            project and a corresponding <tt>.rdoc</tt>
-                            file in <tt>doc</tt> subdirectory.
+                            project and a corresponding doc in
+                            <tt>doc</tt> sub-directory.
 
-test NAME::                 Add a new minitest.
+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
-                            default 'naive' template into the
-                            project. (<b>Warning:</b> this works only
-                            from version 0.2.2 and (hopefully) above.)
+                            template into the project. Currently only
+                            'ruby-naive' template supports this.
 
 The options are as follows:
 
@@ -59,6 +81,9 @@ 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.
+
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.
 
@@ -72,11 +97,6 @@ The options are as follows:
                             times, viz. <tt>-vv</tt> dumps even more
                             debug info.
 
-==Meta
-
-Version & name of your project can be located at generated
-<tt>myproject/lib/myproject/meta.rb</tt> file.
-
 
 ==Examples
 
@@ -98,13 +118,17 @@ Add another test file:
 
 (It will appear in <tt>test/</tt> sub-directory.)
 
+Create a project from another template:
+
+ % falsework -t c-glib -v new foo-bar
+
 
 ==Bugs
 
 While falsework supports symlinks in templates, rubygems replaces
 symlinks with its corresponding source files. That is why you'll get 2
 <tt>README.rdoc</tt> files in generated project when it was intended to
-have 1 in <tt>doc</tt> subdirectory and the symlink to it in the root
+have 1 in <tt>doc</tt> sub-directory and the symlink to it in the root
 project directory.
 
 If you think that this is pathetic, then just grab the source of