falsework 0.1.2 → 0.2.2

data/README.rdoc

@@ -40,18 +40,24 @@ list::                      Do nothing except listing all available
 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. You may use this command only in
-                            the root project directory.
+                            project.
+
+test NAME::                 Add a new minitest.
 
-test NAME::                 Add a new minitest to an existing
-                            project. You may use this command only in
-                            the root project 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.)
 
 The options are as follows:
 
 -t::                        A template name.
 
+-b::                        A batch mode. (No questions asked.)
+
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.
 

data/Rakefile

@@ -17,7 +17,7 @@ require_relative 'test/rake_erb_templates'
 ERB_DYN_SKELETON = erb_skeletons(NAME, 'naive')
 ERB_DYN_SKELETON.each {|k, v|
   file k => [v] do |t|
-    erb_make(NAME, t.name, t.prerequisites[0])
+    erb_make(NAME, 'naive', t.name, t.prerequisites[0])
   end
 }
 
@@ -68,3 +68,5 @@ end
 Rake::TestTask.new do |i|
   i.test_files = FileList['test/test_*.rb']
 end
+
+task test: [:naive]

data/bin/falsework

@@ -6,16 +6,17 @@ require_relative '../lib/falsework/mould'
 include Falsework
 
 $conf = Hash.new
-u = Utils.new($conf)
+u = Trestle.new($conf)
 
 $conf[:banner] = <<EOF
 Usage: #{File.basename($0)} [options] command ...
-Available commands: list, new NAME, exe NAME or test NAME.
+Available commands: list, new NAME, exe NAME, test NAME or upgrade.
 EOF
 $conf[:user] = nil
 $conf[:gecos] = nil
 $conf[:email] = nil
 $conf[:template] = nil
+$conf[:batch] = false
 
 # --[ main ]------------------------------------------------------------
 
@@ -25,14 +26,15 @@ u.config_parse(['foobar']) {|src|
   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
 }
 
-Utils.errx(1, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] != 'list')
+Trestle.errx(1, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] !~ /list|upgrade/)
 
 # print our env
 if $conf[:verbose] >= 2
-  puts 'Libs dir: '+Utils.gem_libdir
+  puts 'Libs dir: '+Trestle.gem_libdir
   pp $conf
 end
 
@@ -40,18 +42,23 @@ case ARGV[0]
 when 'list'
   Mould.templates.each_key {|i| puts(i)}
 when /exe|test/
-  m = Mould.new('foo', $conf[:user], $conf[:email], $conf[:gecos])
+  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, 'OK')
   }
+when 'upgrade'
+  m = Mould.new(File.basename(Dir.pwd), $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)
 when 'new'
   if File.dirname(ARGV[1]) != '.'
-    Dir.chdir(File.dirname(ARGV[1])) rescue Utils.errx(1, "cannot chdir to '#{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
-  Utils.errx(1, 'project name cannot start with a digit') if ARGV[1].strip[0] =~ /\d/
+  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])
   m.verbose = true if $conf[:verbose] > 0
@@ -65,5 +72,5 @@ when 'new'
   g.commit("Initial import from #{Falsework::Meta::NAME} #{Falsework::Meta::VERSION}.")
   u.veputs(1, 'OK')
 else
-  Utils.errx(1, "unknown command: " + ARGV[0])
+  Trestle.errx(1, "unknown command: " + ARGV[0])
 end

data/doc/README.rdoc

@@ -40,18 +40,24 @@ list::                      Do nothing except listing all available
 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. You may use this command only in
-                            the root project directory.
+                            project.
+
+test NAME::                 Add a new minitest.
 
-test NAME::                 Add a new minitest to an existing
-                            project. You may use this command only in
-                            the root project 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.)
 
 The options are as follows:
 
 -t::                        A template name.
 
+-b::                        A batch mode. (No questions asked.)
+
 --config-dirs::             List all possible locations for the
                             configuration file. The first found wins.
 

data/doc/TODO.rdoc

@@ -1,10 +1,9 @@
 + create a git repository automatically for a new project
 + generate a gem file list from git ls-tree
 + check for every generated file in naive test template generation
-- an ability to upgrade project to a newest template
-- more templates (a light one?)
++ an ability to upgrade project from a newest template
+- more templates (a lighter one?)
 - write a small tutorial 'how to write a template'
 - release to rubygems.org (it must run test, pull to github, tag, create
   gem & upload it)
-+ generate utils.rb.erb from the current falsework utils.rb
 + the config in home dir

data/lib/falsework/meta.rb

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

data/lib/falsework/mould.rb

@@ -2,20 +2,21 @@ require 'git'
 require 'erb'
 require 'digest/md5'
 
-require_relative 'utils'
+require_relative 'trestle'
 
 module Falsework
   class Mould
     GITCONFIG = '~/.gitconfig'
-    TEMPLATE_DIRS = [Utils.gem_libdir + '/templates',
+    TEMPLATE_DIRS = [Trestle.gem_libdir + '/templates',
                      File.expand_path('~/.' + Meta::NAME + '/templates')]
     TEMPLATE_DEFAULT = 'naive'
     IGNORE_FILES = ['.gitignore']
 
-    attr_accessor :verbose
+    attr_accessor :verbose, :batch
     
     def initialize(project, user = nil, email = nil, gecos = nil)
       @verbose = false
+      @batch = false
       
       gc = Git.global_config rescue gc = {}
       @project = project
@@ -26,7 +27,7 @@ module Falsework
       [['github.user', @user],
        ['user.email', @email],
        ['user.name', @gecos]].each {|i|
-        Utils.errx(1, "missing #{i.first} in #{GITCONFIG}") if i.last.to_s == ''
+        Trestle.errx(1, "missing #{i.first} in #{GITCONFIG}") if i.last.to_s == ''
       }
     end
 
@@ -51,11 +52,11 @@ module Falsework
     # Return false if nothing was extracted.
     def project_seed(template, filter)
       sl = ->(is_dir, *args) {
-        is_dir ? Mould.erb_dirname(*args) : Mould.erb_filename(*args)
+        is_dir ? Mould.erb_fname(*args) : Mould.erb_fname(*args).sub(/\.erb$/, '')
       }
       
       # check for existing project
-      Utils.errx(1, "directory '#{@project}' is not empty") if Dir.glob(@project + '/*').size > 0
+      Trestle.errx(1, "directory '#{@project}' is not empty") if Dir.glob(@project + '/*').size > 0
 
       Dir.mkdir(@project) unless File.directory?(@project)
       prjdir = File.expand_path(@project)
@@ -65,7 +66,7 @@ module Falsework
       Dir.chdir @project
 
       r = false
-      start = Mould.templates[template || TEMPLATE_DEFAULT] || Utils.errx(1, "no such template: #{template}")
+      start = Mould.templates[template || TEMPLATE_DEFAULT] || Trestle.errx(1, "no such template: #{template}")
       puts "Template: #{start}" if @verbose
       symlinks = []
       Mould.traverse(start) {|i|
@@ -80,13 +81,13 @@ module Falsework
                        sl.call(is_dir, file, binding)]
         elsif File.directory?(i)
           puts("D: #{file}") if @verbose
-          file = Mould.erb_dirname(file, binding)
+          file = Mould.erb_fname(file, binding)
 #          FileUtils.mkdir_p(prjdir + '/' + file)
           Dir.mkdir(prjdir + '/' + file)
           Dir.chdir(prjdir + '/' + file)
         else
           puts("N: #{file}") if @verbose
-          to = File.basename(Mould.erb_filename(file, binding), '.erb')
+          to = File.basename(Mould.erb_fname(file, binding), '.erb')
           Mould.extract(start + '/' + file, binding, to)
           # make files in bin/ executable
           File.chmod(0744, to) if file =~ /bin\//
@@ -97,8 +98,10 @@ module Falsework
       # create saved symlinks
       Dir.chdir prjdir
       symlinks.each {|i|
-        src = i[0].sub(/#{File.extname(i[0])}$/, '')
-        dest = i[1].sub(/#{File.extname(i[1])}$/, '')
+#        src = i[0].sub(/#{File.extname(i[0])}$/, '')
+#        dest = i[1].sub(/#{File.extname(i[1])}$/, '')
+        src = i[0]
+        dest = i[1]
         puts "L: #{dest} => #{src}" if @verbose
         File.symlink(src, dest)
       }
@@ -113,15 +116,15 @@ module Falsework
     #
     # Return a name of a created file.
     def create(template, mode, what)
-      start = Mould.templates[template || TEMPLATE_DEFAULT] || Utils.errx(1, "no such template: #{template}")
+      start = Mould.templates[template || TEMPLATE_DEFAULT] || Trestle.errx(1, "no such template: #{template}")
 
       t = case mode
           when 'exe'
             to = ["bin/#{what}", true]
-            start + '/' + 'bin/.@project..erb'
+            start + '/' + 'bin/%%@project%%.erb'
           when 'test'
             to = ["#{mode}/test_#{what}.rb", false]
-            start + '/' + 'test/test_.@project..rb.erb'
+            start + '/' + 'test/test_%%@project%%.rb.erb'
           else
             fail "invalid mode #{mode}"
           end
@@ -135,11 +138,13 @@ module Falsework
     #
     # [start] The directory to start with.
     def self.traverse(start, &block)
-      l = Dir.glob(start + '/{*}', File::FNM_DOTMATCH)
+      l = Dir.glob(start + '/*', File::FNM_DOTMATCH).delete_if {
+        |i| i.match /\/?\.\.?$/
+      }
       # stop if directory is empty (contains only . and ..)
-      return if l.size <= 2
+      return if l.size == 0
       
-      l.sort[2..-1].each {|i|
+      l.sort.each {|i|
         yield i
         # recursion!
         self.traverse(i) {|j| block.call j} if File.directory?(i)
@@ -157,7 +162,7 @@ module Falsework
 #        pp t.result
         md5_system = Digest::MD5.hexdigest(t.result(bin))
       rescue Exception
-        Utils.errx(1, "cannot read the template file: #{$!}")
+        Trestle.errx(1, "cannot read the template file: #{$!}")
       end
 
       skeleton = to || File.basename(path, '.erb')
@@ -166,34 +171,138 @@ module Falsework
         begin
           File.open(skeleton, 'w+') { |fp| fp.puts t.result(bin) }
         rescue
-          Utils.errx(1, "cannot write the skeleton: #{$!}")
+          Trestle.errx(1, "cannot write the skeleton: #{$!}")
         end
       elsif
         # warn a careless user
         if md5_system != Digest::MD5.file(skeleton).hexdigest
-          Utils.errx(1, "#{skeleton} already exists")
+          Trestle.errx(1, "#{skeleton} already exists")
         end
       end
     end
 
-    # Evaluate _t_ as a special directory name.
-    #
-    # [bin] A binding for eval.
-    def self.erb_dirname(t, bin)
-      if t =~ /^(.+\/)?\.(.+)\.$/
-        return ERB.new("#{$1}<%= #{$2} %>").result(bin)
-      end
+    def self.erb_fname(t, bin)
+      re = /%%([^.]+)?%%/
+      return ERB.new(t.gsub(re, '<%= \1 %>')).result(bin) if t =~ re
       return t
     end
+    
 
-    # Evaluate _t_ as a special file name.
+    # Search for all files in the _template_ for the line
     #
-    # [bin] A binding for eval.
-    def self.erb_filename(t, bin)
-      if t =~ /^(.+)?\.(.+)\.(\..+)?.erb$/
-        return ERB.new("#{$1}<%= #{$2} %>#{$3}").result(bin)
+    # /^..? :erb:/
+    #
+    # in first n lines. If the line is found, the file is considered a
+    # candidate for an upgrade. Return a hash {target:template}
+    def upgradable_files(template)
+      line_max = 4
+      r = {}
+      Falsework::Mould.traverse(template) {|i|
+        next if File.directory?(i)
+        next if File.symlink?(i) # hm...
+
+        File.open(i) {|fp|
+          n = 0
+          while n < line_max && line = fp.gets
+            if line =~ /^..? :erb:/
+              t = i.sub(/#{template}\//, '')
+              r[Mould.erb_fname(t, binding).sub(/\.erb$/, '')] = i
+              break
+            end
+            n += 1
+          end
+        }
+      }
+      
+      r
+    end
+
+    # We can upgrade only those files, which were explicitly marked by
+    # ':erb' sign a the top the file. They are collected by
+    # upgradable_files() method.
+    #
+    # The upgrade can happened only if one following conditions is met:
+    # 
+    # 1. there is no such files (all or some of them) in the project at
+    #    all;
+    #
+    # 2. the files are from the previous version of falsework.
+    #
+    # The situation may combine: you may have some missing and some old
+    # files. But if there is at least 1 file from a newer version of
+    # falsework then no upgrade is possible--it's considered a user
+    # decision to intentionally have some files from the old versions of
+    # falsework.
+    #
+    # Neithe we do check for a content of upgradable files nor try to
+    # merge old with new. (Why?)
+    def upgrade(template)
+      # 0. search for 'new' files in the template
+      t = Mould.templates[template || TEMPLATE_DEFAULT] || Trestle.errx(1, "no such template: #{template}")
+      uf = upgradable_files(t)
+      fail "template #{template} cannot offer to you files for an upgrade" if uf.size == 0
+ #     pp uf
+      
+      # 1. analyse 'old' files
+      u = {}
+      uf.each {|k, v|
+        if ! File.readable?(k)
+          u[k] = v
+        else
+          # check for its version
+          File.open(k) {|fp|
+            is_versioned = false
+            while line = fp.gets
+              if line =~ /^# Don't remove this: falsework\/(#{Gem::Version::VERSION_PATTERN})\/(\w+)\/.+/
+                is_versioned = true
+                if $3 != (template || TEMPLATE_DEFAULT)
+                  fail "file #{k} is from #{$3} template"
+                end
+                if Gem::Version.new(Meta::VERSION) >= Gem::Version.new($1)
+#                  puts "#{k}: #{$1}"
+                  u[k] = v
+                  break
+                else
+                  fail "file #{k} is from a newer version of #{Meta::NAME}: " + $1
+                end
+              end
+            end
+
+            Trestle.warnx("#{k}: unversioned") if ! is_versioned
+          }
+        end
+      }
+      fail "template #{template || TEMPLATE_DEFAULT} cannot find files for an upgrade" if u.size == 0
+
+      # 2. ask user for a commitment
+      if ! @batch
+        puts "Here is a list of files in project #{@project} we can try to upgrade/add:\n\n"
+        u.each {|k,v| puts "\t#{k}"}
+        printf %{
+Does this look fine? Type y/n and press enter. If you choose 'y', those files
+will be replaced with newer versions. Your old files will be preserved with
+an '.old' extension. So? }
+        if STDIN.gets =~ /^y/i
+          puts ""
+        else
+          puts "\nNo? See you later."
+          exit 0
+        end
       end
-      return t
+
+      # 3. rename & write new
+      count = 1
+      total = u.size
+      tsl = total.to_s.size*2+1
+      u.each {|k, v|
+        printf("%#{tsl}s) mv %s %s\n",
+               "#{count}/#{total}", k, "#{k}.old") if @verbose
+        File.rename(k, "#{k}.old") rescue Trestle.warnx('renaming failed')
+        printf("%#{tsl}s  Extracting %s ...\n", "", File.basename(v)) if @verbose
+        FileUtils.mkdir_p(File.dirname(k))
+        Mould.extract(v, binding, k)
+        count += 1
+      }
     end
     
   end # Mould

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

@@ -1,6 +1,6 @@
 =Name
 
-<%= @project %>--an util to put function in yo function so yo can return
+<%= @project %>--an util to put a function in yo function so yo can return
 while yo return.
 
 

data/lib/falsework/templates/naive/bin/{.@project..erb → %%@project%%.erb}

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 # -*-ruby-*-
 
-require_relative '../lib/<%= @project %>/utils.rb'
+require_relative '../lib/<%= @project %>/trestle.rb'
 
 include <%= @project.capitalize %>
 
 $conf = Hash.new
-u = Utils.new($conf)
+u = Trestle.new($conf)
 
 $conf[:banner] = "Usage: #{File.basename($0)} [options] hren'"
 $conf[:foobar] = ''
@@ -24,7 +24,7 @@ u.config_parse(['foobar']) {|src|
 
 # print our env
 if $conf[:verbose] >= 2
-  puts 'Libs dir: '+Utils.gem_libdir
+  puts 'Libs dir: ' + Trestle.gem_libdir
   pp $conf
 end
 

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

@@ -1,6 +1,6 @@
 =Name
 
-<%= @project %>--an util to put function in yo function so yo can return
+<%= @project %>--an util to put a function in yo function so yo can return
 while yo return.
 
 

data/lib/falsework/templates/naive/lib/{.@project./utils.rb.erb → %%@project%%/trestle.rb.erb}

@@ -3,13 +3,26 @@ require 'yaml'
 require 'shellwords.rb'
 require 'optparse'
 require 'pp'
+require 'open4'
 
 require_relative 'meta'
 
 # :include: ../../README.rdoc
 module <%= @project.capitalize %>
 
-  class Utils
+  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.expand_path($0))}/../lib/#{<%= @project.capitalize %>::Meta::NAME}",
@@ -114,7 +127,7 @@ module <%= @project.capitalize %>
 #        puts "\n2 run"
         r = config_flat_load(rvars)
       rescue
-        Utils.errx(1, "cannot load config: #{$!}")
+        Trestle.errx(1, "cannot load config: #{$!}")
       end
       veputs(1, "Loaded config: #{r}")
       cb.call(block_given?, ARGV)
@@ -193,11 +206,11 @@ module <%= @project.capitalize %>
         o.parse!(src)
         @cl_parsing_times += 1
       rescue
-        Utils.errx(1, $!.to_s)
+        Trestle.errx(1, $!.to_s)
       end
     end
     
-  end # Utils
+  end # trestle
 end
 
-# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2
+# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/lib/falsework/templates/naive/test/helper.rb.erb

@@ -1,48 +1,4 @@
-# :erb:
-# Various staff for minitest.
+# This is supposed to be your helper for all your test. Feel free to
+# add staff here.
 
-require 'fileutils'
-require 'open4'
-
-include FileUtils
-
-require_relative '../lib/<%= @project %>/utils'
-include <%= @project.capitalize %>
-
-# don't run tests automatically if they were invoked as 'gem check -t ...'
-if $0 =~ /gem/
-  require 'minitest/unit'
-else
-  require 'minitest/autorun'
-end
-
-def 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 the right directory for (probably executable) _c_.
-def cmd(c)
-  case File.basename(Dir.pwd)
-  when Meta::NAME.downcase
-    # test probably is executed from the Rakefile
-    Dir.chdir('test')
-  when 'test'
-    # we are in the test directory, there is nothing special to do
-  else
-    # tests were invoked by 'gem check -t <%= @project %>'
-    begin
-      Dir.chdir(Utils.gem_libdir + '/../../test')
-    rescue
-      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
-    end
-  end
-
-  '../bin/' + c
-end
-
-# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2
+require_relative 'helper_trestle'

data/lib/falsework/templates/naive/test/helper_trestle.rb.erb

@@ -0,0 +1,37 @@
+# :erb:
+# Various staff for minitest. Include this file into your 'helper.rb'.
+
+require 'fileutils'
+include FileUtils
+
+require_relative '../lib/<%= @project %>/trestle'
+include <%= @project.capitalize %>
+
+# don't run tests automatically if they were invoked as 'gem check -t ...'
+if $0 =~ /gem/
+  require 'minitest/unit'
+else
+  require 'minitest/autorun'
+end
+
+# Return the right directory for (probably executable) _c_.
+def cmd(c)
+  case File.basename(Dir.pwd)
+  when Meta::NAME.downcase
+    # test probably is executed from the Rakefile
+    Dir.chdir('test')
+  when 'test'
+    # we are in the test directory, there is nothing special to do
+  else
+    # tests were invoked by 'gem check -t <%= @project %>'
+    begin
+      Dir.chdir(Trestle.gem_libdir + '/../../test')
+    rescue
+      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
+    end
+  end
+
+  '../bin/' + c
+end
+
+# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/lib/falsework/templates/naive/test/rake_git.rb.erb

@@ -2,10 +2,23 @@
 # -*-ruby-*-
 # :erb:
 
+# This is a helper for your Rakefile. Read the comments for each
+# function.
+
 require 'git'
 require 'pp'
 
-# Return a list of files in a git repository _repdir_
+# Return a list of files in a git repository _repdir_.
+#
+# Add this to your gem spec:
+#
+# spec = Gem::Specification.new {|i|
+#   i.files = git_ls('.')
+# }
+#
+# What it does is just collecting the list of the files from the git
+# repository. The idea is to use that list for the gem spec. No more
+# missing or redundant files in gems!
 def git_ls(repdir, ignore_some = true)
   ignore = ['/?\.gitignore$']
 
@@ -20,4 +33,4 @@ end
 
 pp git_ls('.') if __FILE__ == $0
 
-# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2
+# Don't remove this: falsework/0.2.2/naive/2010-12-26T04:50:00+02:00

data/lib/falsework/{utils.rb → trestle.rb}

@@ -3,13 +3,26 @@ require 'yaml'
 require 'shellwords.rb'
 require 'optparse'
 require 'pp'
+require 'open4'
 
 require_relative 'meta'
 
 # :include: ../../README.rdoc
 module Falsework
 
-  class Utils
+  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.expand_path($0))}/../lib/#{Falsework::Meta::NAME}",
@@ -114,7 +127,7 @@ module Falsework
 #        puts "\n2 run"
         r = config_flat_load(rvars)
       rescue
-        Utils.errx(1, "cannot load config: #{$!}")
+        Trestle.errx(1, "cannot load config: #{$!}")
       end
       veputs(1, "Loaded config: #{r}")
       cb.call(block_given?, ARGV)
@@ -193,9 +206,9 @@ module Falsework
         o.parse!(src)
         @cl_parsing_times += 1
       rescue
-        Utils.errx(1, $!.to_s)
+        Trestle.errx(1, $!.to_s)
       end
     end
     
-  end # Utils
+  end # trestle
 end

data/test/helper.rb

@@ -1,46 +1 @@
-# :erb:
-# Various staff for minitest.
-
-require 'fileutils'
-require 'open4'
-
-include FileUtils
-
-require_relative '../lib/falsework/utils'
-include Falsework
-
-# don't run tests automatically if they were invoked as 'gem check -t ...'
-if $0 =~ /gem/
-  require 'minitest/unit'
-else
-  require 'minitest/autorun'
-end
-
-def 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 the right directory for (probably executable) _c_.
-def cmd(c)
-  case File.basename(Dir.pwd)
-  when Meta::NAME.downcase
-    # test probably is executed from the Rakefile
-    Dir.chdir('test')
-  when 'test'
-    # we are in the test directory, there is nothing special to do
-  else
-    # tests were invoked by 'gem check -t falsework'
-    begin
-      Dir.chdir(Utils.gem_libdir + '/../../test')
-    rescue
-      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
-    end
-  end
-
-  '../bin/' + c
-end
+require_relative 'helper_trestle'

data/test/helper_trestle.rb

@@ -0,0 +1,35 @@
+# :erb:
+# Various staff for minitest. Include this file into your 'helper.rb'.
+
+require 'fileutils'
+include FileUtils
+
+require_relative '../lib/falsework/trestle'
+include Falsework
+
+# don't run tests automatically if they were invoked as 'gem check -t ...'
+if $0 =~ /gem/
+  require 'minitest/unit'
+else
+  require 'minitest/autorun'
+end
+
+# Return the right directory for (probably executable) _c_.
+def cmd(c)
+  case File.basename(Dir.pwd)
+  when Meta::NAME.downcase
+    # test probably is executed from the Rakefile
+    Dir.chdir('test')
+  when 'test'
+    # we are in the test directory, there is nothing special to do
+  else
+    # tests were invoked by 'gem check -t falsework'
+    begin
+      Dir.chdir(Trestle.gem_libdir + '/../../test')
+    rescue
+      raise "running tests from '#{Dir.pwd}' isn't supported: #{$!}"
+    end
+  end
+
+  '../bin/' + c
+end

data/test/rake_erb_templates.rb

@@ -13,8 +13,8 @@ def erb_skeletons(local_prj, template)
   line_max = 4
   target = File.absolute_path("lib/#{local_prj}/templates/#{template}")
   r = {}
-  skiplist = ['/.git[^i]?', template, '/html', '/pkg', '/test/templates',
-             'find_erb_templates.rb']
+  skiplist = ['/.git[^i]?', "lib/#{local_prj}/templates", '/html', '/pkg',
+              '/test/templates', 'rake_erb_templates.rb']
 
   Falsework::Mould.traverse('.') {|i|
     next if File.directory?(i)
@@ -31,7 +31,7 @@ def erb_skeletons(local_prj, template)
 #        puts line
         if line =~ /^..? :erb:/
           t = i.sub(/^.+?\//, '')
-          r[target + '/' + t.sub(/#{local_prj}/, '.@project.') + '.erb'] = t
+          r[target + '/' + t.sub(/#{local_prj}/, '%%@project%%') + '.erb'] = t
           break
         end
         n += 1
@@ -42,14 +42,14 @@ def erb_skeletons(local_prj, template)
   r
 end
 
-def erb_make(local_prj, target, template)
-  raw = File.read(template)
+def erb_make(local_prj, template, target, tmplt)
+  raw = File.read(tmplt)
   raw.gsub!(/#{local_prj}/, '<%= @project %>')
   raw.gsub!(/#{local_prj.capitalize}/, '<%= @project.capitalize %>')
 
   mark = <<-EOF
 
-# Don't remove this: <%= DateTime.now %> <%= #{local_prj.capitalize}::Meta::NAME %> <%= #{local_prj.capitalize}::Meta::VERSION %>
+# Don't remove this: <%= #{local_prj.capitalize}::Meta::NAME %>/<%= #{local_prj.capitalize}::Meta::VERSION %>/#{template}/<%= DateTime.now %>
   EOF
   File.open(target, 'w+') {
     |fp| fp.puts raw + ERB.new(mark).result(binding)

data/test/rake_git.rb

@@ -2,10 +2,23 @@
 # -*-ruby-*-
 # :erb:
 
+# This is a helper for your Rakefile. Read the comments for each
+# function.
+
 require 'git'
 require 'pp'
 
-# Return a list of files in a git repository _repdir_
+# Return a list of files in a git repository _repdir_.
+#
+# Add this to your gem spec:
+#
+# spec = Gem::Specification.new {|i|
+#   i.files = git_ls('.')
+# }
+#
+# What it does is just collecting the list of the files from the git
+# repository. The idea is to use that list for the gem spec. No more
+# missing or redundant files in gems!
 def git_ls(repdir, ignore_some = true)
   ignore = ['/?\.gitignore$']
 

data/test/test_exe.rb

@@ -8,14 +8,20 @@ class TestFalsework < MiniTest::Unit::TestCase
   end
 
   def test_project_list
-    r = cmd_run "#{CMD} list"
+    r = Trestle.cmd_run "#{CMD} list"
     assert_equal(0, r[0])
     assert_match(/naive\n/, 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_new
     rm_rf 'templates/foo'
-    r = cmd_run "#{CMD} new templates/foo -v"
+    r = Trestle.cmd_run "#{CMD} new templates/foo -v"
 #    pp r
     assert_equal(0, r[0], r)
 
@@ -39,9 +45,10 @@ class TestFalsework < MiniTest::Unit::TestCase
             "templates/foo/lib",
             "templates/foo/lib/foo",
             "templates/foo/lib/foo/meta.rb",
-            "templates/foo/lib/foo/utils.rb",
+            "templates/foo/lib/foo/trestle.rb",
             "templates/foo/test",
             "templates/foo/test/helper.rb",
+            "templates/foo/test/helper_trestle.rb",
             "templates/foo/test/rake_git.rb",
             "templates/foo/test/test_foo.rb"]
 
@@ -54,19 +61,34 @@ class TestFalsework < MiniTest::Unit::TestCase
     origdir = pwd
     cd 'templates/foo'
 
-    r = cmd_run "../../#{CMD} exe qqq"
+    r = Trestle.cmd_run "../../#{CMD} exe qqq"
     assert_equal(0, r[0])
     assert_equal(true, File.executable?('bin/qqq'))
 
-    r = cmd_run "../../#{CMD} test qqq"
+    r = Trestle.cmd_run "../../#{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"
+    assert_equal(0, r[0])
+    rm ['test/helper_trestle.rb', 'test/rake_git.rb']
+    r = Trestle.cmd_run "../../#{CMD} upgrade -b"
+    assert_equal(0, r[0])
+    sed 'test/helper_trestle.rb',
+    /^(# Don't.+falsework\/)\d+\.\d+\.\d+(\/.+)$/, '\1999.999.999\2'
+    r = Trestle.cmd_run "../../#{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"
+    assert_equal(0, r[0])
     
     cd origdir
   end
 
   def test_project_invalid_name
-    r = cmd_run "#{CMD} new 123"
+    r = Trestle.cmd_run "#{CMD} new 123"
     assert_equal(1, r[0])
     assert_match(/project name cannot start with a digit/, r[1])
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Alexander Gromnitsky
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 +02:00
+date: 2010-12-26 00:00:00 +02:00
 default_executable: falsework
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,21 +72,23 @@ files:
 - lib/falsework/templates/naive/.gitignore.erb
 - lib/falsework/templates/naive/README.rdoc.erb
 - lib/falsework/templates/naive/Rakefile.erb
-- lib/falsework/templates/naive/bin/.@project..erb
+- lib/falsework/templates/naive/bin/%%@project%%.erb
 - lib/falsework/templates/naive/doc/LICENSE.erb
 - lib/falsework/templates/naive/doc/NEWS.rdoc.erb
 - lib/falsework/templates/naive/doc/README.rdoc.erb
-- lib/falsework/templates/naive/etc/.@project..yaml.erb
-- lib/falsework/templates/naive/lib/.@project./meta.rb.erb
-- lib/falsework/templates/naive/test/test_.@project..rb.erb
-- lib/falsework/utils.rb
+- lib/falsework/templates/naive/etc/%%@project%%.yaml.erb
+- lib/falsework/templates/naive/lib/%%@project%%/meta.rb.erb
+- lib/falsework/templates/naive/test/helper.rb.erb
+- lib/falsework/templates/naive/test/test_%%@project%%.rb.erb
+- lib/falsework/trestle.rb
 - test/helper.rb
+- test/helper_trestle.rb
 - test/rake_erb_templates.rb
 - test/rake_git.rb
 - test/templates/.keep_me
 - test/test_exe.rb
-- lib/falsework/templates/naive/lib/.@project./utils.rb.erb
-- lib/falsework/templates/naive/test/helper.rb.erb
+- lib/falsework/templates/naive/lib/%%@project%%/trestle.rb.erb
+- lib/falsework/templates/naive/test/helper_trestle.rb.erb
 - lib/falsework/templates/naive/test/rake_git.rb.erb
 has_rdoc: true
 homepage: http://github.com/gromnitsky/falsework