falsework 0.0.1

data/README.rdoc

@@ -0,0 +1,86 @@
+=Name
+
+falsework--A primitive scaffold generator for writing CLI programs in
+Ruby.
+
+
+==Synopsis
+
+ falsework [options] command ...
+
+
+==Description
+
+The falsework utility generates a scaffold which have:
+
+* <tt>gem</tt>, <tt>doc</tt>, <tt>test</tt> targers.
+
+* easy to use configuraton parser/loader; this includes scanning for:
+
+  * env variables;
+  * the flat YAML configuration file;
+  * the command line.
+
+* an ability to pick up a user name & an email for a github project.
+
+The utility can also add skeletons for tests end executables
+<i>after</i> the project generation.
+
+The commands:
+
+list::                      Do nothing except listing all available
+                            templates. You can add your own templates in
+                            <tt>~/.falsework/templates</tt> directory.
+
+new NAME::                  Create a new project. It creates a directory
+                            <i>NAME</i> and populates it with files.
+
+exe NAME::                  Add a new executable to an existing
+                            project. You may use this command only in
+                            the root project directory.
+
+test NAME::                 Add a new test to an existing
+                            project. You may use this command only in
+                            the root project directory.
+
+The options are as follows:
+
+-t::                        A template name.
+
+--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.
+
+==Meta
+
+Version & name of your project can be located at generated
+<tt>myproject/lib/myproject/meta.rb</tt> file.
+
+==Examples
+
+Create a new project:
+
+ % falsework -v new foobar
+
+Add another CL util to the existing project:
+
+ % pwd
+ .../foobar
+ % falsework exe foo
+
+(It will appear in bin/ subdirectory.)
+
+Add another test file:
+
+ % falsework test foo
+
+(It will appear in test/ subdirectory.)

data/Rakefile

@@ -0,0 +1,69 @@
+# -*-ruby-*-
+
+require 'erb'
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+NAME = 'falsework'
+
+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.author = 'Alexander Gromnitsky'
+  i.email = 'alexander.gromnitsky@gmail.com'
+  i.homepage = "http://github.com/gromnitsky/#{i.name}"
+  i.platform = Gem::Platform::RUBY
+  i.required_ruby_version = '>= 1.9.2'
+  i.files = FileList.new('bin/*', 'doc/*',
+                         'etc/*', '[A-Z]*', 'test/**/*') {|f|
+    f.exclude('test/templates/*')
+    f.include('test/templates/.keep_me')
+    f.include(Dir.glob('lib/**/*', File::FNM_DOTMATCH))
+    f.exclude('lib/**/{.*,*}/.gitignore')
+  }
+
+  i.executables = FileList['bin/*'].gsub(/^bin\//, '')
+  i.default_executable = i.name
+  
+  i.test_files = FileList['test/test_*.rb']
+  
+  i.rdoc_options << '-m' << 'doc/README.rdoc'
+  i.extra_rdoc_files = FileList['doc/*']
+
+  i.add_dependency('git', '>=  1.2.5')
+  i.add_dependency('open4', '>= 1.0.1')
+}
+
+Rake::GemPackageTask.new(spec).define
+
+task default: [:naive, :repackage]
+
+Rake::RDocTask.new('doc') do |i|
+  i.main = 'doc/README.rdoc'
+  i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
+  i.rdoc_files.exclude("lib/**/templates")
+end
+
+Rake::TestTask.new do |i|
+  i.test_files = FileList['test/test_*.rb']
+end
+
+
+#
+# Generate dynamic targets
+#
+require_relative 'test/find_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])
+  end
+}
+
+desc "Generate some erb templates for naive template"
+task naive: ERB_DYN_SKELETON.keys

data/bin/falsework

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require_relative '../lib/falsework/mould'
+
+include Falsework
+
+$conf = Hash.new
+u = Utils.new($conf)
+
+$conf[:banner] = <<EOF
+Usage: #{File.basename($0)} [options] command ...
+Available commands: list, new NAME, exe NAME or test NAME.
+EOF
+$conf[:user] = nil
+$conf[:gecos] = nil
+$conf[:email] = nil
+$conf[:template] = nil
+
+# --[ 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}
+  o.on('--email STR') {|i| $conf[:email] = i}
+  o.on('-t NAME', 'A template name') {|i| $conf[:template] = i}
+  u.cl_parse(src, o) # run cl parser
+}
+
+Utils.errx(1, $conf[:banner]) if (ARGV.size < 2 && ARGV[0] != 'list')
+
+# print our env
+if $conf[:verbose] >= 2
+  puts 'Libs dir: '+Utils.gem_libdir
+  pp $conf
+end
+
+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])
+  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 'new'
+  Utils.errx(1, 'project name cannot start with a digit') if ARGV[1].strip[0] =~ /\d/
+  if File.dirname(ARGV[1]) != '.'
+    Dir.chdir(File.dirname(ARGV[1])) rescue Utils.errx(1, "cannot chdir to '#{File.dirname(ARGV[1])}'")
+    ARGV[1] = File.basename ARGV[1]
+  end
+
+  m = Mould.new(ARGV[1], $conf[:user], $conf[:email], $conf[:gecos])
+  m.verbose = true if $conf[:verbose] > 0
+  m.project_seed($conf[:template], nil)
+else
+  Utils.errx(1, "unknown command: " + ARGV[0])
+end

data/doc/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Alexander Gromnitsky.
+
+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/doc/README.rdoc

@@ -0,0 +1,86 @@
+=Name
+
+falsework--A primitive scaffold generator for writing CLI programs in
+Ruby.
+
+
+==Synopsis
+
+ falsework [options] command ...
+
+
+==Description
+
+The falsework utility generates a scaffold which have:
+
+* <tt>gem</tt>, <tt>doc</tt>, <tt>test</tt> targers.
+
+* easy to use configuraton parser/loader; this includes scanning for:
+
+  * env variables;
+  * the flat YAML configuration file;
+  * the command line.
+
+* an ability to pick up a user name & an email for a github project.
+
+The utility can also add skeletons for tests end executables
+<i>after</i> the project generation.
+
+The commands:
+
+list::                      Do nothing except listing all available
+                            templates. You can add your own templates in
+                            <tt>~/.falsework/templates</tt> directory.
+
+new NAME::                  Create a new project. It creates a directory
+                            <i>NAME</i> and populates it with files.
+
+exe NAME::                  Add a new executable to an existing
+                            project. You may use this command only in
+                            the root project directory.
+
+test NAME::                 Add a new test to an existing
+                            project. You may use this command only in
+                            the root project directory.
+
+The options are as follows:
+
+-t::                        A template name.
+
+--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.
+
+==Meta
+
+Version & name of your project can be located at generated
+<tt>myproject/lib/myproject/meta.rb</tt> file.
+
+==Examples
+
+Create a new project:
+
+ % falsework -v new foobar
+
+Add another CL util to the existing project:
+
+ % pwd
+ .../foobar
+ % falsework exe foo
+
+(It will appear in bin/ subdirectory.)
+
+Add another test file:
+
+ % falsework test foo
+
+(It will appear in test/ subdirectory.)

data/doc/TODO.rdoc

@@ -0,0 +1,4 @@
+- tests
+- more templates
++ generate utils.rb.erb from the current falsework utils.rb
++ the config in home dir

data/etc/falsework.yaml

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

data/lib/falsework/meta.rb

@@ -0,0 +1,6 @@
+module Falsework
+  module Meta
+    NAME = 'falsework'
+    VERSION = '0.0.1'
+  end
+end

data/lib/falsework/mould.rb

@@ -0,0 +1,200 @@
+require 'git'
+require 'erb'
+require 'digest/md5'
+
+require_relative 'utils'
+
+module Falsework
+  class Mould
+    GITCONFIG = '~/.gitconfig'
+    TEMPLATE_DIRS = [Utils.gem_libdir + '/templates',
+                     File.expand_path('~/.' + Meta::NAME + '/templates')]
+    TEMPLATE_DEFAULT = 'naive'
+    IGNORE_FILES = ['.gitignore']
+
+    attr_accessor :verbose
+    
+    def initialize(project, user = nil, email = nil, gecos = nil)
+      @verbose = false
+      
+      gc = Git.global_config rescue gc = {}
+      @project = project
+      @user = user || gc['github.user']
+      @email = email || ENV['GIT_AUTHOR_EMAIL'] || ENV['GIT_COMMITTER_EMAIL'] || gc['user.email']
+      @gecos = gecos || ENV['GIT_AUTHOR_NAME'] || ENV['GIT_COMMITTER_NAME']  || gc['user.name']
+
+      [['github.user', @user],
+       ['user.email', @email],
+       ['user.name', @gecos]].each {|i|
+        Utils.errx(1, "missing #{i.first} in #{GITCONFIG}") if i.last.to_s == ''
+      }
+    end
+
+    # Return a hash {name => dir} with current possible template names
+    # and corresponding directories.
+    def self.templates
+      r = {}
+      TEMPLATE_DIRS.each {|i|
+        Dir.glob(i + '/*').each {|j|
+          r[File.basename(j)] = j if File.directory?(j)
+        }
+      }
+      r
+    end
+
+    # Generate a new project in @project directory from _template_.
+    #
+    # [template] If it's nil TEMPLATE_DEFAULT will be used.
+    # [filter]   A regexp for matching particular files in the
+    #            template directory.
+    #
+    # 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)
+      }
+      
+      # check for existing project
+      Utils.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)
+      puts "Project path: #{prjdir}" if @verbose
+
+      origdir = Dir.pwd;
+      Dir.chdir @project
+
+      r = false
+      start = Mould.templates[template || TEMPLATE_DEFAULT] || Utils.errx(1, "no such template: #{template}")
+      puts "Template: #{start}" if @verbose
+      symlinks = []
+      Mould.traverse(start) {|i|
+        file = i.sub(/^#{start}\//, '')
+        next if filter ? file =~ filter : false
+        next if IGNORE_FILES.index {|ign| file.match(/#{ign}$/) }
+
+        if File.symlink?(i)
+          # we'll process them later on
+          is_dir = File.directory?(start + '/' + File.readlink(i))
+          symlinks << [sl.call(is_dir, File.readlink(i), binding),
+                       sl.call(is_dir, file, binding)]
+        elsif File.directory?(i)
+          puts("D: #{file}") if @verbose
+          file = Mould.erb_dirname(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')
+          Mould.extract(start + '/' + file, binding, to)
+          # make files in bin/ executable
+          File.chmod(0744, to) if file =~ /bin\//
+        end
+        r = true
+      }
+
+      # 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])}$/, '')
+        puts "L: #{dest} => #{src}" if @verbose
+        File.symlink(src, dest)
+      }
+      Dir.chdir origdir
+      r
+    end
+
+    # Create 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)
+      start = Mould.templates[template || TEMPLATE_DEFAULT] || Utils.errx(1, "no such template: #{template}")
+
+      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]
+    end
+    
+    # Walk through a directory tree, executing a block for each file or
+    # directory.
+    #
+    # [start] The directory to start with.
+    def self.traverse(start, &block)
+      l = Dir.glob(start + '/{*}', File::FNM_DOTMATCH)
+      # stop if directory is empty (contains only . and ..)
+      return if l.size <= 2
+      
+      l.sort[2..-1].each {|i|
+        yield i
+        # recursion!
+        self.traverse(i) {|j| block.call j} if File.directory?(i)
+      }
+    end
+    
+    # Extract into the current directory 1 file from _path_.
+    #
+    # [bin] A binding for eval.
+    # [to]  If != nil write to a particular, not guessed file name.
+    def self.extract(path, bin, to = nil)
+      t = ERB.new(File.read(path))
+      t.filename = path # to report errors relative to this file
+      begin
+#        pp t.result
+        md5_system = Digest::MD5.hexdigest(t.result(bin))
+      rescue Exception
+        Utils.errx(1, "cannot read the template file: #{$!}")
+      end
+
+      skeleton = to || File.basename(path, '.erb')
+      if ! File.exists?(skeleton)
+        # write a skeleton
+        begin
+          File.open(skeleton, 'w+') { |fp| fp.puts t.result(bin) }
+        rescue
+          Utils.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")
+        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
+      return t
+    end
+
+    # Evaluate _t_ as a special file name.
+    #
+    # [bin] A binding for eval.
+    def self.erb_filename(t, bin)
+      if t =~ /^(.+)?\.(.+)\.(\..+)?.erb$/
+        return ERB.new("#{$1}<%= #{$2} %>#{$3}").result(bin)
+      end
+      return t
+    end
+    
+  end # Mould
+end

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

@@ -0,0 +1,2 @@
+pkg
+html

data/lib/falsework/templates/naive/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/Rakefile.erb

@@ -0,0 +1,44 @@
+# -*-ruby-*-
+
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+spec = Gem::Specification.new {|i|
+  i.name = '<%= @project %>'
+  i.version = `bin/#{i.name} -V`
+  i.summary = 'TO DO: fill this variable'
+  i.author = '<%= @gecos %>'
+  i.email = '<%= @email %>'
+  i.homepage = "http://github.com/<%= @user %>/#{i.name}"
+  i.platform = Gem::Platform::RUBY
+  i.required_ruby_version = '>= <%= RUBY_VERSION %>'
+  i.files = FileList['lib/**/*', 'bin/*', 'doc/*',
+                     'etc/*', '[A-Z]*', 'test/**/*']
+
+  i.executables = FileList['bin/*'].gsub(/^bin\//, '')
+  i.default_executable = i.name
+  
+  i.test_files = FileList['test/test_*.rb']
+  
+  i.rdoc_options << '-m' << 'doc/README.rdoc'
+  i.extra_rdoc_files = FileList['doc/*']
+
+  i.add_dependency('open4', '>= 1.0.1')
+}
+
+Rake::GemPackageTask.new(spec).define
+
+task default: [:repackage]
+
+Rake::RDocTask.new('doc') {|i|
+  i.main = 'doc/README.rdoc'
+  i.rdoc_files = FileList['doc/*', 'lib/**/*.rb']
+#  i.rdoc_files.exclude("lib/**/some-nasty-staff")
+}
+
+Rake::TestTask.new {|i|
+  i.test_files = FileList['test/test_*.rb']
+}

data/lib/falsework/templates/naive/bin/.@project..erb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+
+require_relative '../lib/<%= @project %>/utils.rb'
+
+include <%= @project.capitalize %>
+
+$conf = Hash.new
+u = Utils.new($conf)
+
+$conf[:banner] = "Usage: #{File.basename($0)} [options] hren'"
+$conf[:foobar] = ''
+
+
+# --[ main ]------------------------------------------------------------
+
+u.config_parse(['foobar']) {|src|
+  o = u.cl_parse(src) # create an OptionParser object
+  o.on('--foobar STR', 'An example of the option --foobar') {|i|
+    $conf[:foobar] = i
+  }
+  u.cl_parse(src, o) # run cl parser
+}
+
+# print our env
+if $conf[:verbose] >= 2
+  puts 'Libs dir: '+Utils.gem_libdir
+  pp $conf
+end
+
+puts 'Hello, World!'