falsework 0.0.1

data/lib/falsework/templates/naive/doc/LICENSE.erb

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 <%= @gecos %>.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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

@@ -0,0 +1,57 @@
+=Name
+
+<%= @project %>--an util to put function in yo function so yo can return
+while yo return.
+
+
+==Synopsis
+
+ <%= @project %> [options]
+
+
+==Description
+
+The <%= @project %> utility does something.
+
+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 falsework 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
+
+<%= @project %> 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
+
+ % ri <%= @project.capitalize %>
+ % <%= @project %> --config-dirs
+ % <%= @project %> -V

data/lib/falsework/templates/naive/etc/.@project..yaml.erb

@@ -0,0 +1,2 @@
+--- 
+:foobar: foobar

data/lib/falsework/templates/naive/lib/.@project./meta.rb.erb

@@ -0,0 +1,6 @@
+module <%= @project.capitalize %>
+  module Meta
+    NAME = '<%= @project %>'
+    VERSION = '0.0.1'
+  end
+end

data/lib/falsework/templates/naive/lib/.@project./utils.rb.erb

@@ -0,0 +1,203 @@
+# :erb:
+require 'yaml'
+require 'shellwords.rb'
+require 'optparse'
+require 'pp'
+
+require_relative 'meta'
+
+# :include: ../../README.rdoc
+module <%= @project.capitalize %>
+
+  class Utils
+    # Return a directory with program libraries.
+    def self.gem_libdir
+      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{<%= @project.capitalize %>::Meta::NAME}",
+           "#{Gem.dir}/gems/#{<%= @project.capitalize %>::Meta::NAME}-#{<%= @project.capitalize %>::Meta::VERSION}/lib/#{<%= @project.capitalize %>::Meta::NAME}",
+           "lib/#{<%= @project.capitalize %>::Meta::NAME}"]
+      t.each {|i| return i if File.readable?(i) }
+      fail "all paths are invalid: #{t}"
+    end
+
+    # Analogue to shell command +which+.
+    def self.in_path?(file)
+      return true if file =~ %r%\A/% and File.exist? file
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
+        File.exist? File.join(path, file)
+      end
+    end
+
+    # Print an error message _t_ and exit if _ec_ > 0.
+    def self.errx(ec, t)
+      STDERR.puts File.basename($0) + ' error: ' + t.to_s
+      exit ec if ec > 0
+    end
+
+    # Print a warning.
+    def self.warnx(t)
+      STDERR.puts File.basename($0) + ' warning: ' + t.to_s
+    end
+
+    # #veputs uses this to decide to put a newline or not to put.
+    NNL_MARK = '__NNL__'
+
+    # Use this in your CL options to check if modifying some variable is
+    # not an idempotent act.
+    attr_reader :cl_opt_protect
+
+    # [conf] Typically must be a reference to some global variable.
+    def initialize(conf)
+      @conf = conf
+      @conf[:verbose] = 0
+      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
+      @conf[:config] =  Meta::NAME + '.yaml'
+      @conf[:config_dirs] =  [ENV['HOME']+'/.'+Meta::NAME,
+                              File.absolute_path("#{File.dirname(File.expand_path($0))}/../etc"),
+                              '/usr/etc', '/usr/local/etc', '/etc',
+                              "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/etc"
+                             ]
+      @conf[:config_env] = [Meta::NAME.upcase + '_CONF']
+
+      @cl_parsing_times = 0 # not used
+      @cl_opt_protect = false
+    end
+
+    # [level] A verbose level.
+    # [t]     A string to print.
+    #
+    # Don't print _t_ with a newline if it contains NNL_MARK at the end.
+    def veputs(level, t)
+      t = t.dup
+      nnl = nil
+      if t.match(/#{NNL_MARK}$/)
+        t.sub!(/#{$&}/, '')
+        nnl = 1
+      end
+
+      if @conf[:verbose] >= level
+        nnl ? print(t) : puts(t)
+        STDOUT.flush
+      end
+    end
+    
+    # Run all configuration parsing in a batch.
+    #
+    # [rvars] A list of variable names which must be in the
+    #         configuration file.
+    #
+    # If no block is given, only standard CL options will be analysed.
+    def config_parse(rvars, &block)
+      cb = ->(b, src) {
+        if b
+          block.call src
+        else
+          # very basic default options
+          cl_parse(src, nil, true)
+        end
+      }
+      
+      # 1. parse env
+      @conf[:config_env].each {|i|
+#        puts '0 run:'
+        cb.call(block_given?, ENV[i].shellsplit) if ENV.key?(i)
+      }
+
+      # 2. parse CL in case of '--config' option
+#      puts "\n1 run"
+      @cl_opt_protect = true
+      cb.call(block_given?, ARGV.dup)
+      @cl_opt_protect = false
+
+      # 3. load the configuration file & do the final CL parsing
+      begin
+#        puts "\n2 run"
+        r = config_flat_load(rvars)
+      rescue
+        Utils.errx(1, "cannot load config: #{$!}")
+      end
+      veputs(1, "Loaded config: #{r}")
+      cb.call(block_given?, ARGV)
+    end
+
+    # Load a config file immediately if it contains '/' in its name,
+    # otherwise search through several dirs for it.
+    #
+    # [rvars] a list of requied variables in the config
+    #
+    # Return a loaded filename or nil on error.
+    def config_flat_load(rvars)
+      p = ->(f) {
+        if File.readable?(f)
+          begin
+            myconf = YAML.load_file(f)
+          rescue
+            abort("cannot parse #{f}: #{$!}")
+          end
+          rvars.each { |i|
+            fail "missing or nil '#{i}' in #{f}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
+          }
+          @conf.merge!(myconf)
+          return @conf[:config]
+        end
+        return nil
+      }
+
+      if @conf[:config].index('/')
+        return p.call(@config[:config])
+      else
+        @conf[:config_dirs].each {|dir|
+          return dir+'/'+@conf[:config] if p.call(dir + '/' + @conf[:config])
+        }
+      end
+
+      return nil
+    end
+
+
+    # Parses CL-like options.
+    #
+    # [src] An array of options (usually +ARGV+).
+    #
+    # If _o_ is non nil function parses _src_ immediately, otherwise it
+    # only creates +OptionParser+ object and return it (if _simple_ is
+    # false).
+    def cl_parse(src, o = nil, simple = false)
+      if ! o then
+#        puts "NEW o (#{cl_opt_protect})" + src.to_s 
+        o = OptionParser.new
+        o.banner = @conf[:banner]
+        o.on('-v', 'Be more verbose.') { |i|
+#          puts "cl_parsing_times "+cl_parsing_times.to_s
+          @conf[:verbose] += 1 unless cl_opt_protect
+        }
+        o.on('-V', 'Show version & exit.') { |i|
+          puts Meta::VERSION
+          exit 0
+        }
+        o.on('--config NAME', "Set a config name (default is #{@conf[:config]})") {|i|
+          @conf[:config] = i
+        }
+        o.on('--config-dirs', 'Show possible config locations') {
+          @conf[:config_dirs].each { |j|
+            f = j + '/' + @conf[:config]
+            puts (File.readable?(f) ? '* ' : '  ') +  f
+          }
+          exit 0
+        }
+
+        return o if ! simple
+      end
+
+      begin
+        o.parse!(src)
+        @cl_parsing_times += 1
+      rescue
+        Utils.errx(1, $!.to_s)
+      end
+    end
+    
+  end # Utils
+end
+
+# Don't remove this: 2010-12-22T01:03:15+02:00 falsework 0.0.1

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

@@ -0,0 +1,48 @@
+# :erb:
+# Various staff for minitest.
+
+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-22T01:03:15+02:00 falsework 0.0.1

data/lib/falsework/templates/naive/test/test_.@project..rb.erb

@@ -0,0 +1,13 @@
+require_relative 'helper'
+
+class Test<%= @project.capitalize %>_<%= rand 2**32 %> < MiniTest::Unit::TestCase
+  CMD = cmd('<%= @project %>') # get path to the exe & cd to tests directory
+  
+  def setup
+    # this runs every time before test_*
+  end
+
+  def test_foobar
+    fail "\u0430\u0439\u043D\u044D\u043D\u044D".encode(Encoding.default_external, 'UTF-8')
+  end
+end

data/lib/falsework/utils.rb

@@ -0,0 +1,201 @@
+# :erb:
+require 'yaml'
+require 'shellwords.rb'
+require 'optparse'
+require 'pp'
+
+require_relative 'meta'
+
+# :include: ../../README.rdoc
+module Falsework
+
+  class Utils
+    # Return a directory with program libraries.
+    def self.gem_libdir
+      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Falsework::Meta::NAME}",
+           "#{Gem.dir}/gems/#{Falsework::Meta::NAME}-#{Falsework::Meta::VERSION}/lib/#{Falsework::Meta::NAME}",
+           "lib/#{Falsework::Meta::NAME}"]
+      t.each {|i| return i if File.readable?(i) }
+      fail "all paths are invalid: #{t}"
+    end
+
+    # Analogue to shell command +which+.
+    def self.in_path?(file)
+      return true if file =~ %r%\A/% and File.exist? file
+
+      ENV['PATH'].split(File::PATH_SEPARATOR).any? do |path|
+        File.exist? File.join(path, file)
+      end
+    end
+
+    # Print an error message _t_ and exit if _ec_ > 0.
+    def self.errx(ec, t)
+      STDERR.puts File.basename($0) + ' error: ' + t.to_s
+      exit ec if ec > 0
+    end
+
+    # Print a warning.
+    def self.warnx(t)
+      STDERR.puts File.basename($0) + ' warning: ' + t.to_s
+    end
+
+    # #veputs uses this to decide to put a newline or not to put.
+    NNL_MARK = '__NNL__'
+
+    # Use this in your CL options to check if modifying some variable is
+    # not an idempotent act.
+    attr_reader :cl_opt_protect
+
+    # [conf] Typically must be a reference to some global variable.
+    def initialize(conf)
+      @conf = conf
+      @conf[:verbose] = 0
+      @conf[:banner] = "Usage: #{File.basename($0)} [options]"
+      @conf[:config] =  Meta::NAME + '.yaml'
+      @conf[:config_dirs] =  [ENV['HOME']+'/.'+Meta::NAME,
+                              File.absolute_path("#{File.dirname(File.expand_path($0))}/../etc"),
+                              '/usr/etc', '/usr/local/etc', '/etc',
+                              "#{Gem.dir}/gems/#{Meta::NAME}-#{Meta::VERSION}/etc"
+                             ]
+      @conf[:config_env] = [Meta::NAME.upcase + '_CONF']
+
+      @cl_parsing_times = 0 # not used
+      @cl_opt_protect = false
+    end
+
+    # [level] A verbose level.
+    # [t]     A string to print.
+    #
+    # Don't print _t_ with a newline if it contains NNL_MARK at the end.
+    def veputs(level, t)
+      t = t.dup
+      nnl = nil
+      if t.match(/#{NNL_MARK}$/)
+        t.sub!(/#{$&}/, '')
+        nnl = 1
+      end
+
+      if @conf[:verbose] >= level
+        nnl ? print(t) : puts(t)
+        STDOUT.flush
+      end
+    end
+    
+    # Run all configuration parsing in a batch.
+    #
+    # [rvars] A list of variable names which must be in the
+    #         configuration file.
+    #
+    # If no block is given, only standard CL options will be analysed.
+    def config_parse(rvars, &block)
+      cb = ->(b, src) {
+        if b
+          block.call src
+        else
+          # very basic default options
+          cl_parse(src, nil, true)
+        end
+      }
+      
+      # 1. parse env
+      @conf[:config_env].each {|i|
+#        puts '0 run:'
+        cb.call(block_given?, ENV[i].shellsplit) if ENV.key?(i)
+      }
+
+      # 2. parse CL in case of '--config' option
+#      puts "\n1 run"
+      @cl_opt_protect = true
+      cb.call(block_given?, ARGV.dup)
+      @cl_opt_protect = false
+
+      # 3. load the configuration file & do the final CL parsing
+      begin
+#        puts "\n2 run"
+        r = config_flat_load(rvars)
+      rescue
+        Utils.errx(1, "cannot load config: #{$!}")
+      end
+      veputs(1, "Loaded config: #{r}")
+      cb.call(block_given?, ARGV)
+    end
+
+    # Load a config file immediately if it contains '/' in its name,
+    # otherwise search through several dirs for it.
+    #
+    # [rvars] a list of requied variables in the config
+    #
+    # Return a loaded filename or nil on error.
+    def config_flat_load(rvars)
+      p = ->(f) {
+        if File.readable?(f)
+          begin
+            myconf = YAML.load_file(f)
+          rescue
+            abort("cannot parse #{f}: #{$!}")
+          end
+          rvars.each { |i|
+            fail "missing or nil '#{i}' in #{f}" if ! myconf.key?(i.to_sym) || ! myconf[i.to_sym]
+          }
+          @conf.merge!(myconf)
+          return @conf[:config]
+        end
+        return nil
+      }
+
+      if @conf[:config].index('/')
+        return p.call(@config[:config])
+      else
+        @conf[:config_dirs].each {|dir|
+          return dir+'/'+@conf[:config] if p.call(dir + '/' + @conf[:config])
+        }
+      end
+
+      return nil
+    end
+
+
+    # Parses CL-like options.
+    #
+    # [src] An array of options (usually +ARGV+).
+    #
+    # If _o_ is non nil function parses _src_ immediately, otherwise it
+    # only creates +OptionParser+ object and return it (if _simple_ is
+    # false).
+    def cl_parse(src, o = nil, simple = false)
+      if ! o then
+#        puts "NEW o (#{cl_opt_protect})" + src.to_s 
+        o = OptionParser.new
+        o.banner = @conf[:banner]
+        o.on('-v', 'Be more verbose.') { |i|
+#          puts "cl_parsing_times "+cl_parsing_times.to_s
+          @conf[:verbose] += 1 unless cl_opt_protect
+        }
+        o.on('-V', 'Show version & exit.') { |i|
+          puts Meta::VERSION
+          exit 0
+        }
+        o.on('--config NAME', "Set a config name (default is #{@conf[:config]})") {|i|
+          @conf[:config] = i
+        }
+        o.on('--config-dirs', 'Show possible config locations') {
+          @conf[:config_dirs].each { |j|
+            f = j + '/' + @conf[:config]
+            puts (File.readable?(f) ? '* ' : '  ') +  f
+          }
+          exit 0
+        }
+
+        return o if ! simple
+      end
+
+      begin
+        o.parse!(src)
+        @cl_parsing_times += 1
+      rescue
+        Utils.errx(1, $!.to_s)
+      end
+    end
+    
+  end # Utils
+end

data/test/find_erb_templates.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require_relative '../lib/falsework/mould'
+
+# Search for all files in the project (except .git directory) for the line
+#
+# /^..? :erb:/
+#
+# in first 4 lines. If the line is found, the file is considered a
+# skeleton for a template. Return a hash {target:template}
+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']
+
+  Falsework::Mould.traverse('.') {|i|
+    next if File.directory?(i)
+    next if File.symlink?(i)
+    if skiplist.index {|ign| i.match(/\/?#{ign}\/?/) }
+#      puts "skipped: #{i}"
+     next
+    end
+#    puts "looking into: #{i}"
+    
+    File.open(i) {|fp|
+      n = 0
+      while n < line_max && line = fp.gets
+#        puts line
+        if line =~ /^..? :erb:/
+          t = i.sub(/^.+?\//, '')
+          r[target + '/' + t.sub(/#{local_prj}/, '.@project.') + '.erb'] = t
+          break
+        end
+        n += 1
+      end
+    }
+  }
+  
+  r
+end
+
+def erb_make(local_prj, target, template)
+  raw = File.read(template)
+  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 %>
+  EOF
+  File.open(target, 'w+') {
+    |fp| fp.puts raw + ERB.new(mark).result(binding)
+  }
+end
+
+
+pp erb_skeletons(Falsework::Meta::NAME, 'naive') if __FILE__ == $0

data/test/helper.rb

@@ -0,0 +1,46 @@
+# :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