falsework 0.0.1 → 0.1.2

data/README.rdoc

@@ -13,16 +13,21 @@ Ruby.
 
 The falsework utility generates a scaffold which have:
 
-* <tt>gem</tt>, <tt>doc</tt>, <tt>test</tt> targers.
+* auto-created git (but not github) project;
 
-* easy to use configuraton parser/loader; this includes scanning for:
+* <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;
 
-  * env variables;
+* easy to use configuraton parser/loader. This includes scanning for:
+
+  * env variable(s);
   * the flat YAML configuration file;
   * the command line.
 
 * an ability to pick up a user name & an email for a github project.
 
+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.
 
@@ -39,7 +44,7 @@ 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
+test NAME::                 Add a new minitest to an existing
                             project. You may use this command only in
                             the root project directory.
 
@@ -77,10 +82,10 @@ Add another CL util to the existing project:
  .../foobar
  % falsework exe foo
 
-(It will appear in bin/ subdirectory.)
+(It will appear in <tt>bin/</tt> sub-directory.)
 
 Add another test file:
 
  % falsework test foo
 
-(It will appear in test/ subdirectory.)
+(It will appear in <tt>test/</tt> sub-directory.)

data/Rakefile

@@ -1,14 +1,36 @@
 # -*-ruby-*-
 
-require 'erb'
 require 'rake'
 require 'rake/gempackagetask'
 require 'rake/clean'
 require 'rake/rdoctask'
 require 'rake/testtask'
 
+require_relative 'test/rake_git'
 NAME = 'falsework'
 
+#
+# Generate dynamic targets
+#
+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])
+  end
+}
+
+desc "Generate some erb templates for naive template"
+task naive: ERB_DYN_SKELETON.keys
+
+CLOBBER.concat ERB_DYN_SKELETON.keys
+#pp CLOBBER
+
+#
+# Gem staff
+#
+
 spec = Gem::Specification.new {|i|
   i.name = NAME
   i.version = `bin/#{i.name} -V`
@@ -18,13 +40,8 @@ spec = Gem::Specification.new {|i|
   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.files = git_ls('.')
+  i.files.concat ERB_DYN_SKELETON.keys.map {|i| i.sub(/#{Dir.pwd}\//, '') }
 
   i.executables = FileList['bin/*'].gsub(/^bin\//, '')
   i.default_executable = i.name
@@ -51,19 +68,3 @@ 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

@@ -47,15 +47,23 @@ when /exe|test/
     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
+  Utils.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
   m.project_seed($conf[:template], nil)
+
+  # 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')
 else
   Utils.errx(1, "unknown command: " + ARGV[0])
 end

data/doc/NEWS.rdoc

@@ -0,0 +1,7 @@
+=== 0.1.2
+
+Wed Dec 22 19:09:01 EET 2010
+
+- Create a git repository automatically for a new project.
+
+- Generate a gem file list from git ls-tree.

data/doc/README.rdoc

@@ -13,16 +13,21 @@ Ruby.
 
 The falsework utility generates a scaffold which have:
 
-* <tt>gem</tt>, <tt>doc</tt>, <tt>test</tt> targers.
+* auto-created git (but not github) project;
 
-* easy to use configuraton parser/loader; this includes scanning for:
+* <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;
 
-  * env variables;
+* easy to use configuraton parser/loader. This includes scanning for:
+
+  * env variable(s);
   * the flat YAML configuration file;
   * the command line.
 
 * an ability to pick up a user name & an email for a github project.
 
+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.
 
@@ -39,7 +44,7 @@ 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
+test NAME::                 Add a new minitest to an existing
                             project. You may use this command only in
                             the root project directory.
 
@@ -77,10 +82,10 @@ Add another CL util to the existing project:
  .../foobar
  % falsework exe foo
 
-(It will appear in bin/ subdirectory.)
+(It will appear in <tt>bin/</tt> sub-directory.)
 
 Add another test file:
 
  % falsework test foo
 
-(It will appear in test/ subdirectory.)
+(It will appear in <tt>test/</tt> sub-directory.)

data/doc/TODO.rdoc

@@ -1,4 +1,10 @@
-- tests
-- more templates
++ 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?)
+- 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.0.1'
+    VERSION = '0.1.2'
   end
 end

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

@@ -6,6 +6,8 @@ require 'rake/clean'
 require 'rake/rdoctask'
 require 'rake/testtask'
 
+require_relative 'test/rake_git'
+
 spec = Gem::Specification.new {|i|
   i.name = '<%= @project %>'
   i.version = `bin/#{i.name} -V`
@@ -15,8 +17,7 @@ spec = Gem::Specification.new {|i|
   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.files = git_ls('.')
 
   i.executables = FileList['bin/*'].gsub(/^bin\//, '')
   i.default_executable = i.name

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

@@ -0,0 +1,5 @@
+=== 0.0.1
+
+<%= DateTime.now.rfc2822 %>
+
+- Created a first skeleton.

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

@@ -200,4 +200,4 @@ module <%= @project.capitalize %>
   end # Utils
 end
 
-# Don't remove this: 2010-12-22T01:03:15+02:00 falsework 0.0.1
+# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2

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

@@ -45,4 +45,4 @@ def cmd(c)
   '../bin/' + c
 end
 
-# Don't remove this: 2010-12-22T01:03:15+02:00 falsework 0.0.1
+# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2

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

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+# :erb:
+
+require 'git'
+require 'pp'
+
+# Return a list of files in a git repository _repdir_
+def git_ls(repdir, ignore_some = true)
+  ignore = ['/?\.gitignore$']
+
+  r = []
+  g = Git.open repdir
+  g.ls_files.each {|i, v|
+    next if ignore_some && ignore.index {|ign| i.match(/#{ign}/) }
+    r << i
+  }
+  r
+end
+
+pp git_ls('.') if __FILE__ == $0
+
+# Don't remove this: 2010-12-22T19:42:32+02:00 falsework 0.1.2

data/test/rake_git.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# -*-ruby-*-
+# :erb:
+
+require 'git'
+require 'pp'
+
+# Return a list of files in a git repository _repdir_
+def git_ls(repdir, ignore_some = true)
+  ignore = ['/?\.gitignore$']
+
+  r = []
+  g = Git.open repdir
+  g.ls_files.each {|i, v|
+    next if ignore_some && ignore.index {|ign| i.match(/#{ign}/) }
+    r << i
+  }
+  r
+end
+
+pp git_ls('.') if __FILE__ == $0

data/test/test_exe.rb

@@ -0,0 +1,73 @@
+require_relative 'helper'
+
+class TestFalsework < MiniTest::Unit::TestCase
+  CMD = cmd('falsework') # get path to the exe & cd to tests directory
+  
+  def setup
+    # this runs every time before test_*
+  end
+
+  def test_project_list
+    r = cmd_run "#{CMD} list"
+    assert_equal(0, r[0])
+    assert_match(/naive\n/, r[2])
+  end
+
+  def test_project_new
+    rm_rf 'templates/foo'
+    r = cmd_run "#{CMD} new templates/foo -v"
+#    pp r
+    assert_equal(0, r[0], r)
+
+    out = r[2].split("\n")
+    assert_match(/^Project path: \//, out[0])
+    assert_equal("L: README.rdoc => doc/README.rdoc", out[-2])
+    assert_match(/Creating a git repository in .+... OK/, out[-1])
+
+    tree = ["templates/foo/.git",
+            "templates/foo/.gitignore",
+            "templates/foo/README.rdoc",
+            "templates/foo/Rakefile",
+            "templates/foo/bin",
+            "templates/foo/bin/foo",
+            "templates/foo/doc",
+            "templates/foo/doc/LICENSE",
+            "templates/foo/doc/NEWS.rdoc",
+            "templates/foo/doc/README.rdoc",
+            "templates/foo/etc",
+            "templates/foo/etc/foo.yaml",
+            "templates/foo/lib",
+            "templates/foo/lib/foo",
+            "templates/foo/lib/foo/meta.rb",
+            "templates/foo/lib/foo/utils.rb",
+            "templates/foo/test",
+            "templates/foo/test/helper.rb",
+            "templates/foo/test/rake_git.rb",
+            "templates/foo/test/test_foo.rb"]
+
+    assert_equal(tree,
+                 Dir.glob('templates/foo/**/*', File::FNM_DOTMATCH).sort.delete_if {|i|
+                   i.match(/\.\.?$/) || i.match(/\.git[^i]/)
+                 })
+
+    # add files
+    origdir = pwd
+    cd 'templates/foo'
+
+    r = cmd_run "../../#{CMD} exe qqq"
+    assert_equal(0, r[0])
+    assert_equal(true, File.executable?('bin/qqq'))
+
+    r = cmd_run "../../#{CMD} test qqq"
+    assert_equal(0, r[0])
+    assert_equal(true, File.exist?('test/test_qqq.rb'))
+    
+    cd origdir
+  end
+
+  def test_project_invalid_name
+    r = cmd_run "#{CMD} new 123"
+    assert_equal(1, r[0])
+    assert_match(/project name cannot start with a digit/, r[1])
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Alexander Gromnitsky
@@ -57,32 +57,37 @@ extra_rdoc_files:
 - doc/LICENSE
 - doc/README.rdoc
 - doc/TODO.rdoc
+- doc/NEWS.rdoc
 files: 
+- README.rdoc
+- Rakefile
 - bin/falsework
 - doc/LICENSE
+- doc/NEWS.rdoc
 - doc/README.rdoc
 - doc/TODO.rdoc
 - etc/falsework.yaml
-- Rakefile
-- README.rdoc
-- test/helper.rb
-- test/test_utils.rb
-- test/find_erb_templates.rb
-- test/templates/.keep_me
 - lib/falsework/meta.rb
-- lib/falsework/utils.rb
+- lib/falsework/mould.rb
+- 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/doc/LICENSE.erb
+- lib/falsework/templates/naive/doc/NEWS.rdoc.erb
 - lib/falsework/templates/naive/doc/README.rdoc.erb
-- lib/falsework/templates/naive/Rakefile.erb
-- lib/falsework/templates/naive/test/helper.rb.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
+- test/helper.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/lib/.@project./meta.rb.erb
-- lib/falsework/templates/naive/etc/.@project..yaml.erb
-- lib/falsework/templates/naive/bin/.@project..erb
-- lib/falsework/templates/naive/README.rdoc.erb
-- lib/falsework/templates/naive/.gitignore.erb
-- lib/falsework/mould.rb
+- lib/falsework/templates/naive/test/helper.rb.erb
+- lib/falsework/templates/naive/test/rake_git.rb.erb
 has_rdoc: true
 homepage: http://github.com/gromnitsky/falsework
 licenses: []
@@ -119,4 +124,4 @@ signing_key:
 specification_version: 3
 summary: A primitive scaffold generator for writing CLI programs in Ruby.
 test_files: 
-- test/test_utils.rb
+- test/test_exe.rb

data/test/test_utils.rb

@@ -1,47 +0,0 @@
-require_relative 'helper'
-
-class TestFalsework < MiniTest::Unit::TestCase
-  CMD = cmd('falsework') # get path to the exe & cd to tests directory
-  
-  def setup
-    # this runs every time before test_*
-  end
-
-  def test_project_list
-    r = cmd_run "#{CMD} list"
-    assert_equal(0, r[0])
-    assert_match(/naive\n/, r[2])
-  end
-
-  def test_project_new
-    rm_rf 'templates/foo'
-    r = cmd_run "#{CMD} new templates/foo -v"
-#    pp r
-    assert_equal(0, r[0], r)
-
-    # check for first & last lines only
-    out = r[2].split("\n")
-    assert_match(/^Project path: \//, out.first)
-    assert_equal("L: README.rdoc => doc/README.rdoc", out.last)
-
-    # add files
-    origdir = pwd
-    cd 'templates/foo'
-
-    r = cmd_run "../../#{CMD} exe qqq"
-    assert_equal(0, r[0])
-    assert_equal(true, File.executable?('bin/qqq'))
-
-    r = cmd_run "../../#{CMD} test qqq"
-    assert_equal(0, r[0])
-    assert_equal(true, File.exist?('test/test_qqq.rb'))
-    
-    cd origdir
-  end
-
-  def test_project_invalid_name
-    r = cmd_run "#{CMD} new 123"
-    assert_equal(1, r[0])
-    assert_match(/project name cannot start with a digit/, r[1])
-  end
-end