falsework 0.2.2 → 0.2.3

data/README.rdoc

@@ -43,7 +43,8 @@ new NAME::                  Create a new project. It creates a directory
 The following commands works only from the root project directory:
 
 exe NAME::                  Add a new executable to an existing
-                            project.
+                            project and a corresponding <tt>.rdoc</tt>
+                            file in <tt>doc</tt> subdirectory.
 
 test NAME::                 Add a new minitest.
 
@@ -76,6 +77,7 @@ The options are as follows:
 Version & name of your project can be located at generated
 <tt>myproject/lib/myproject/meta.rb</tt> file.
 
+
 ==Examples
 
 Create a new project:
@@ -95,3 +97,17 @@ Add another test file:
  % falsework test foo
 
 (It will appear in <tt>test/</tt> sub-directory.)
+
+
+==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
+project directory.
+
+If you think that this is pathetic, then just grab the source of
+falsework, place its directory somewhere, create a symlink to
+<tt>/where/is/your/clone/falsework/bin/falsework</tt> file in one of
+your PATH directories and forget about the gem and this bug.

data/Rakefile

@@ -35,6 +35,7 @@ spec = Gem::Specification.new {|i|
   i.name = NAME
   i.version = `bin/#{i.name} -V`
   i.summary = "A primitive scaffold generator for writing CLI programs in Ruby."
+  i.description = i.summary
   i.author = 'Alexander Gromnitsky'
   i.email = 'alexander.gromnitsky@gmail.com'
   i.homepage = "http://github.com/gromnitsky/#{i.name}"

data/bin/falsework

@@ -44,8 +44,9 @@ when 'list'
 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} as... __NNL__")
-    u.veputs(1, m.create($conf[:template], ARGV[0], i) + '... __NNL__')
+    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')
   }
 when 'upgrade'

data/doc/NEWS.rdoc

@@ -1,3 +1,18 @@
+=== 0.2.3
+
+Mon Jan  3 12:41:16 EET 2011
+
+- 'exe' command will add 2 files: an executable and a corresponding
+  .rdoc file.
+
+- 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.
+
 === 0.1.2
 
 Wed Dec 22 19:09:01 EET 2010

data/doc/README.rdoc

@@ -43,7 +43,8 @@ new NAME::                  Create a new project. It creates a directory
 The following commands works only from the root project directory:
 
 exe NAME::                  Add a new executable to an existing
-                            project.
+                            project and a corresponding <tt>.rdoc</tt>
+                            file in <tt>doc</tt> subdirectory.
 
 test NAME::                 Add a new minitest.
 
@@ -76,6 +77,7 @@ The options are as follows:
 Version & name of your project can be located at generated
 <tt>myproject/lib/myproject/meta.rb</tt> file.
 
+
 ==Examples
 
 Create a new project:
@@ -95,3 +97,17 @@ Add another test file:
  % falsework test foo
 
 (It will appear in <tt>test/</tt> sub-directory.)
+
+
+==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
+project directory.
+
+If you think that this is pathetic, then just grab the source of
+falsework, place its directory somewhere, create a symlink to
+<tt>/where/is/your/clone/falsework/bin/falsework</tt> file in one of
+your PATH directories and forget about the gem and this bug.

data/lib/falsework/meta.rb

@@ -1,6 +1,6 @@
 module Falsework
   module Meta
     NAME = 'falsework'
-    VERSION = '0.2.2'
+    VERSION = '0.2.3'
   end
 end

data/lib/falsework/mould.rb

@@ -4,6 +4,28 @@ require 'digest/md5'
 
 require_relative 'trestle'
 
+# Class Mould heavily uses 'naive' template. Theoretically it can manage
+# any template as long as it has files mentioned in #add.
+#
+# The directory with template may have files beginning with _#_ char
+# which will be ignored in #project_seed (a method that creates a shiny
+# new project form a template).
+#
+# If you need to run through erb not only the contents of a file in a
+# template but it name itself, then use the following convention:
+#
+# %%VARIABLE%%
+#
+# which is equivalent of erb's: <%= VARIABLE %>. See naive template
+# directory for examples.
+#
+# In the template files you may use any Mould instance variables. The
+# most usefull are:
+#
+# [@project]  A project name.
+# [@user]     Github user name.
+# [@email]    User email.
+# [@gecos]    A full user name.
 module Falsework
   class Mould
     GITCONFIG = '~/.gitconfig'
@@ -109,37 +131,55 @@ module Falsework
       r
     end
 
-    # Create an executable or a test from the _template_.
+    # Add an executable or a test from the _template_.
     #
     # [mode] Is either 'exe' or 'test'.
     # [what] A test/exe file to create.
     #
     # Return a name of a created file.
-    def create(template, mode, what)
+    def add(template, mode, what)
       start = Mould.templates[template || TEMPLATE_DEFAULT] || Trestle.errx(1, "no such template: #{template}")
+      r = []
 
-      t = case mode
-          when 'exe'
-            to = ["bin/#{what}", true]
-            start + '/' + 'bin/%%@project%%.erb'
-          when 'test'
-            to = ["#{mode}/test_#{what}.rb", false]
-            start + '/' + 'test/test_%%@project%%.rb.erb'
-          else
-            fail "invalid mode #{mode}"
-          end
-      Mould.extract(t, binding, to[0])
-      File.chmod(0744, to[0]) if to[1]
-      return to[0]
+      case mode
+      when 'exe'
+        # script
+        f = {}
+        f[:from] = start + '/' + 'bin/%%@project%%.erb'
+        f[:exe] = true
+        f[:to] = "bin/#{what}"
+        r << f
+
+        # doc (reading an 'ignored' file from the template)
+        f = {}
+        f[:from] = start + '/' + 'doc/#util.rdoc.erb'
+        f[:exe] = false
+        f[:to] = "doc/#{what}.rdoc"
+        r << f
+      when 'test'
+        f = {}
+        f[:from] = start + '/' + 'test/test_%%@project%%.rb.erb'
+        f[:exe] = false
+        f[:to] = "#{mode}/test_#{what}.rb"
+        r << f
+      else
+        fail "invalid mode #{mode}"
+      end
+
+      r.each {|i|
+        Mould.extract(i[:from], binding, i[:to])
+        File.chmod(0744, i[:to]) if i[:exe]
+      }
     end
     
     # Walk through a directory tree, executing a block for each file or
-    # directory.
+    # directory. Ignores _._, _.._ and files starting with _#_
+    # character.
     #
     # [start] The directory to start with.
     def self.traverse(start, &block)
-      l = Dir.glob(start + '/*', File::FNM_DOTMATCH).delete_if {
-        |i| i.match /\/?\.\.?$/
+      l = Dir.glob(start + '/*', File::FNM_DOTMATCH).delete_if {|i|
+        i.match(/\/?\.\.?$/) || i.match(/^#|\/#/)
       }
       # stop if directory is empty (contains only . and ..)
       return if l.size == 0

data/lib/falsework/templates/naive/README.rdoc.erb

@@ -1,7 +1,6 @@
 =Name
 
-<%= @project %>--an util to put a function in yo function so yo can return
-while yo return.
+<%= @project %>-- [TODO: write a summary here.]
 
 
 ==Synopsis
@@ -11,7 +10,7 @@ while yo return.
 
 ==Description
 
-The <%= @project %> utility does something.
+The <%= @project %> utility [TODO: write a description here.]
 
 The options are as follows:
 
@@ -22,13 +21,13 @@ The options are as follows:
                             it contains <tt>/</tt> in it, the list from
                             <tt>--config-dirs</tt> is ignored.
 
--V::                        Show falsework version and exit.
+-V::                        Show version and exit.
 
 -v::                        Be more verbose. You can supply it several
                             times, viz. <tt>-vv</tt> dumps even more
                             debug info.
 
---foobar NAME               Huh?
+--foobar NAME::             Huh?
 
 ==Configuration
 

data/lib/falsework/templates/naive/Rakefile.erb

@@ -12,6 +12,7 @@ spec = Gem::Specification.new {|i|
   i.name = '<%= @project %>'
   i.version = `bin/#{i.name} -V`
   i.summary = 'TO DO: fill this variable'
+  i.description = i.summary
   i.author = '<%= @gecos %>'
   i.email = '<%= @email %>'
   i.homepage = "http://github.com/<%= @user %>/#{i.name}"

data/lib/falsework/templates/naive/doc/#util.rdoc.erb

@@ -0,0 +1,55 @@
+=Name
+
+<%= what %>--[TODO: write a summary here.]
+
+
+==Synopsis
+
+ <%= what %> [options]
+
+
+==Description
+
+The <%= what %> 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.
+
+--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 version and exit.
+
+-v::                        Be more verbose. You can supply it several
+                            times, viz. <tt>-vv</tt> dumps even more
+                            debug info.
+
+--foobar NAME::             Huh?
+
+==Configuration
+
+<%= what %> looks for its configuration at 3 places at start up.
+
+1. At <tt><%= @project.upcase %>_CONF</tt> env variable.
+   (Its format is exactly similar to CL options.)
+
+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.
+
+3. At command line.
+
+Higher number levels overrides the values from lower number levels.
+
+The configuration file must be in YAML format. Look into <tt>`gem env
+gemdir`/gems/<%= @project %>-x.y.z/etc/</tt> directory for samples.
+
+
+==Examples
+
+ % <%= what %> --config-dirs
+ % <%= what %> -V

data/lib/falsework/templates/naive/doc/README.rdoc.erb

@@ -1,7 +1,6 @@
 =Name
 
-<%= @project %>--an util to put a function in yo function so yo can return
-while yo return.
+<%= @project %>-- [TODO: write a summary here.]
 
 
 ==Synopsis
@@ -11,7 +10,7 @@ while yo return.
 
 ==Description
 
-The <%= @project %> utility does something.
+The <%= @project %> utility [TODO: write a description here.]
 
 The options are as follows:
 
@@ -22,13 +21,13 @@ The options are as follows:
                             it contains <tt>/</tt> in it, the list from
                             <tt>--config-dirs</tt> is ignored.
 
--V::                        Show falsework version and exit.
+-V::                        Show version and exit.
 
 -v::                        Be more verbose. You can supply it several
                             times, viz. <tt>-vv</tt> dumps even more
                             debug info.
 
---foobar NAME               Huh?
+--foobar NAME::             Huh?
 
 ==Configuration
 

data/test/test_exe.rb

@@ -64,6 +64,7 @@ class TestFalsework < MiniTest::Unit::TestCase
     r = Trestle.cmd_run "../../#{CMD} exe qqq"
     assert_equal(0, r[0])
     assert_equal(true, File.executable?('bin/qqq'))
+    assert_equal(true, File.exist?('doc/qqq.rdoc'))
 
     r = Trestle.cmd_run "../../#{CMD} test qqq"
     assert_equal(0, r[0])

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 2
-  version: 0.2.2
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Alexander Gromnitsky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-26 00:00:00 +02:00
+date: 2011-01-03 00:00:00 +02:00
 default_executable: falsework
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -47,7 +47,7 @@ dependencies:
         version: 1.0.1
   type: :runtime
   version_requirements: *id002
-description: 
+description: A primitive scaffold generator for writing CLI programs in Ruby.
 email: alexander.gromnitsky@gmail.com
 executables: 
 - falsework
@@ -73,6 +73,7 @@ files:
 - lib/falsework/templates/naive/README.rdoc.erb
 - lib/falsework/templates/naive/Rakefile.erb
 - lib/falsework/templates/naive/bin/%%@project%%.erb
+- lib/falsework/templates/naive/doc/#util.rdoc.erb
 - lib/falsework/templates/naive/doc/LICENSE.erb
 - lib/falsework/templates/naive/doc/NEWS.rdoc.erb
 - lib/falsework/templates/naive/doc/README.rdoc.erb