falsework 2.1.1 → 3.0.0

data/test/test_mould.rb

@@ -1,3 +1,5 @@
+require 'fakefs/safe'
+
 require_relative 'helper'
 require_relative '../lib/falsework/mould'
 
@@ -7,19 +9,27 @@ class TestMould < MiniTest::Unit::TestCase
     @cmd = cmd('falsework') # get path to the exe & cd to tests directory
   end
 
-  def test_config_parse
-    refute Mould.config_parse "DOESN'T EXIST", nil, nil
+  def test_configParse
+    ClearFakeFS do
+      FileUtils.mkdir_p 't/ruby-cli'
+      Mould.template_dirs.unshift Pathname.new('t')
+
+      # no template config file
+      m = Mould.new 'foo', nil
+      refute m.conf[:upgrade]
 
-    o = {}
-    r = Mould.config_parse File.dirname(@cmd) + '/../etc/falsework.yaml', [], o
-    assert_equal true, r
+      # invalid template config file
+      File.open('t/ruby-cli/'+Mould::TEMPLATE_CONFIG, 'w+') {|fp|
+        fp.puts 'garbage'
+      }
+      out, err = capture_io { m = Mould.new 'foo', nil }
+      assert_match /cannot parse/, err
 
-    o = { foo: 1 }
-    out, err = capture_io do
-      r = Mould.config_parse File.dirname(@cmd) + '/../etc/falsework.yaml', ['bar'], o
+      Mould.template_dirs.shift
     end
-    assert_match "missing or nil 'bar' in", err
-    refute r
+
+    m = Mould.new 'foo', nil
+    assert_equal 'lib/%%@project%%/cliconfig.rb', m.conf['upgrade']['files'].first
   end
 
   def test_name_project
@@ -59,15 +69,15 @@ class TestMould < MiniTest::Unit::TestCase
     assert_equal 'FoobarPro', Mould.name_camelcase('foobar#pro,')
   end
 
-  def test_get_filename
+  def test_resolve_filename
     f = 'foo'
     b = 'bar'
     
-    assert_equal '', Mould.get_filename(nil, binding)
-    assert_equal '', Mould.get_filename('', binding)
-    assert_equal 'f/b', Mould.get_filename('f/b', binding)
-    assert_equal 'f/bar/q.txt', Mould.get_filename('f/%%b%%/q.txt', binding)
-    assert_equal 'foo/bar/q.txt', Mould.get_filename('%%f%%/%%b%%/q.txt', binding)
+    assert_equal '', Mould.resolve_filename(nil, binding)
+    assert_equal '', Mould.resolve_filename('', binding)
+    assert_equal 'f/b', Mould.resolve_filename('f/b', binding)
+    assert_equal 'f/bar/q.txt', Mould.resolve_filename('f/%%b%%/q.txt', binding)
+    assert_equal 'foo/bar/q.txt', Mould.resolve_filename('%%f%%/%%b%%/q.txt', binding)
   end
 
   def test_uuid
@@ -77,4 +87,19 @@ class TestMould < MiniTest::Unit::TestCase
       refute_match /\d/, t[0]
     }
   end
+
+  def test_listdirs
+    assert_equal 2, Mould.template_dirs.size
+    out, err = capture_io { Mould.template_dirs_add [Pathname.new("DOESN'T EXISI")] }
+    assert_equal 2, Mould.template_dirs.size
+    
+    assert_raises(RuntimeError) { Mould.template_dirs_add([Dir.pwd]) }
+    assert_equal 2, Mould.template_dirs.size
+    
+    Mould.template_dirs_add [Pathname.new(Dir.pwd)]
+    assert_equal 3, Mould.template_dirs.size
+
+    assert_equal true, Mould.templates.key?("templates")
+  end
+
 end

data/test/test_upgrader.rb

@@ -0,0 +1,96 @@
+require 'fakefs/safe'
+
+require_relative 'helper'
+require_relative '../lib/falsework/upgrader'
+
+class TestUpgrader < MiniTest::Unit::TestCase
+  def setup
+    # this runs every time before test_*
+    @cmd = cmd('falsework') # get path to the exe & cd to tests directory
+  end
+
+  # def test_note
+  #   rm_rf 'templates/foo'
+  #   r = CliUtils.exec "#{@cmd} new templates/foo"
+  #   assert_equal 0, r[0]
+    
+  #   Dir.chdir('templates/foo') {
+      
+  #   }
+  # end
+
+  def test_load_note
+    assert Upgrader.noteLoad('example/note/full')
+  end
+
+  def test_upgradable
+    e = assert_raises(UpgradeError) { Upgrader.new '/DOES/NOT/EXIST' }
+    assert_match /directory .+ is unreadable/, e.message
+
+    e = assert_raises(UpgradeError) { Upgrader.new 'templates' }
+    assert_match /No such file or directory - .+\.#{Meta::NAME}/, e.message
+    
+    e = assert_raises(UpgradeError) { Upgrader.new nil, nil }
+    assert_match /directory  is unreadable/, e.message
+    
+    e = assert_raises(UpgradeError) { Upgrader.new 'example/note', 'template-unknown' }
+    assert_match /unknown template/, e.message
+
+    u = Upgrader.new 'example/note', 'project-too-old'
+    refute u.able?
+    
+    u = Upgrader.new 'example/note', 'full'
+    assert u.able?
+  end
+
+  def test_files
+    u = Upgrader.new 'example/note', 'full'
+    assert_operator u.files.size, :>, 1
+    assert_operator u.obsolete.size, :>=, 1
+  end
+
+  def test_upgrade_fail
+    u = Upgrader.new 'example/note', 'project-too-old'
+    e = assert_raises(UpgradeError) { u.upgrade }
+    assert_match /this project cannot be upgraded/, e.message
+  end
+    
+  def test_upgrade
+    u = Upgrader.new 'example/note', 'full'
+    u.batch = true
+    temp = {}
+    u.files.each {|idx|
+      f = u.template_dir + idx
+      temp[f] = File.read f
+    }
+    
+    ClearFakeFS do
+      # copy some template files into fakefs
+      temp.each {|key, val|
+        FileUtils.mkdir_p File.dirname(key)
+        File.open(key, 'w+') {|fp| fp.write val}
+      }
+
+      # make a skeleton
+      checksum_old = []
+      u.files.each {|idx|
+        f = Mould.resolve_filename(idx, u.getProjectBinding)
+        FileUtils.mkdir_p File.dirname(f)
+        FileUtils.touch f
+        checksum_old << Digest::MD5.file(f)
+      }
+
+      u.upgrade true
+
+      checksum_new = []
+      u.files.each {|idx|
+        f = Mould.resolve_filename(idx, u.getProjectBinding)
+        assert File.readable?(f + '.orig')
+        checksum_new << Digest::MD5.file(f)
+      }
+
+      refute_equal checksum_old, checksum_new
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: falsework
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-24 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open4
@@ -75,6 +75,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: A primitive scaffold generator for writing CLI programs in Ruby
 email:
 - alexander.gromnitsky@gmail.com
@@ -98,65 +114,75 @@ files:
 - doc/README.rdoc
 - doc/TODO.org
 - doc/template-tutorial.rdoc
-- dynamic.ruby-cli
+- dynamic.yaml
 - etc/falsework.yaml
 - falsework.gemspec
 - lib/falsework/cliconfig.rb
 - lib/falsework/cliutils.rb
 - lib/falsework/meta.rb
 - lib/falsework/mould.rb
-- lib/falsework/templates/c-glib/#config.yaml
-- lib/falsework/templates/c-glib/README
-- lib/falsework/templates/c-glib/doc/#doc.ascii
-- lib/falsework/templates/c-glib/doc/%%@project%%.1.asciidoc
-- lib/falsework/templates/c-glib/doc/LICENSE
-- lib/falsework/templates/c-glib/doc/Makefile
-- lib/falsework/templates/c-glib/src/#exe.c
-- lib/falsework/templates/c-glib/src/#exe.h
-- lib/falsework/templates/c-glib/src/%%@project%%.c
-- lib/falsework/templates/c-glib/src/%%@project%%.h
-- lib/falsework/templates/c-glib/src/Makefile
-- lib/falsework/templates/c-glib/src/untest.c
-- lib/falsework/templates/c-glib/src/untest.h
-- lib/falsework/templates/c-glib/src/utils.c
-- lib/falsework/templates/c-glib/src/utils.h
-- lib/falsework/templates/c-glib/test/#test.c
-- lib/falsework/templates/c-glib/test/Makefile
-- lib/falsework/templates/c-glib/test/Makefile.test.mk
-- lib/falsework/templates/c-glib/test/mycat.c
-- lib/falsework/templates/c-glib/test/semis/text/empty.txt
-- lib/falsework/templates/c-glib/test/test_utils.c
-- lib/falsework/templates/ruby-cli/#config.yaml
-- lib/falsework/templates/ruby-cli/%%@project%%.gemspec
-- lib/falsework/templates/ruby-cli/.gitignore
-- lib/falsework/templates/ruby-cli/.gitignore.#erb
-- lib/falsework/templates/ruby-cli/Gemfile
-- lib/falsework/templates/ruby-cli/README.rdoc
-- lib/falsework/templates/ruby-cli/Rakefile
-- lib/falsework/templates/ruby-cli/bin/%%@project%%
-- lib/falsework/templates/ruby-cli/doc/#doc.rdoc
-- lib/falsework/templates/ruby-cli/doc/LICENSE
-- lib/falsework/templates/ruby-cli/doc/NEWS.rdoc
-- lib/falsework/templates/ruby-cli/doc/README.rdoc
-- lib/falsework/templates/ruby-cli/etc/%%@project%%.yaml
-- lib/falsework/templates/ruby-cli/lib/%%@project%%/meta.rb
-- lib/falsework/templates/ruby-cli/test/helper.rb
-- lib/falsework/templates/ruby-cli/test/test_%%@project%%.rb
+- lib/falsework/upgrader.rb
+- lib/falsework/utils.rb
+- templates/c-glib/#config.yaml
+- templates/c-glib/README
+- templates/c-glib/doc/#doc.ascii
+- templates/c-glib/doc/%%@project%%.1.asciidoc
+- templates/c-glib/doc/LICENSE
+- templates/c-glib/doc/Makefile
+- templates/c-glib/src/#exe.c
+- templates/c-glib/src/#exe.h
+- templates/c-glib/src/%%@project%%.c
+- templates/c-glib/src/%%@project%%.h
+- templates/c-glib/src/Makefile
+- templates/c-glib/src/untest.c
+- templates/c-glib/src/untest.h
+- templates/c-glib/src/utils.c
+- templates/c-glib/src/utils.h
+- templates/c-glib/test/#test.c
+- templates/c-glib/test/Makefile
+- templates/c-glib/test/Makefile.test.mk
+- templates/c-glib/test/mycat.c
+- templates/c-glib/test/semis/text/empty.txt
+- templates/c-glib/test/test_utils.c
+- templates/ruby-cli/#config.yaml
+- templates/ruby-cli/%%@project%%.gemspec
+- templates/ruby-cli/.gitignore
+- templates/ruby-cli/.gitignore.#erb
+- templates/ruby-cli/Gemfile
+- templates/ruby-cli/README.rdoc
+- templates/ruby-cli/Rakefile
+- templates/ruby-cli/bin/%%@project%%
+- templates/ruby-cli/doc/#doc.rdoc
+- templates/ruby-cli/doc/LICENSE
+- templates/ruby-cli/doc/NEWS.rdoc
+- templates/ruby-cli/doc/README.rdoc
+- templates/ruby-cli/etc/%%@project%%.yaml
+- templates/ruby-cli/lib/%%@project%%/meta.rb
+- templates/ruby-cli/test/helper.rb
+- templates/ruby-cli/test/test_%%@project%%.rb
+- test/example/note/full
+- test/example/note/project-too-old
+- test/example/note/template-unknown
 - test/helper.rb
 - test/helper_cliutils.rb
-- test/rake_erb_templates.rb
 - test/templates/.gitignore
 - test/templates/config-01.yaml
-- test/templates/config-02.yaml
-- test/test_cl.rb
-- test/test_exe.rb
+- test/test_cli.rb
 - test/test_mould.rb
-- lib/falsework/templates/ruby-cli/lib/%%@project%%/cliconfig.rb
-- lib/falsework/templates/ruby-cli/lib/%%@project%%/cliutils.rb
-- lib/falsework/templates/ruby-cli/test/helper_cliutils.rb
+- test/test_upgrader.rb
+- templates/ruby-cli/lib/%%@project%%/cliconfig.rb
+- templates/ruby-cli/lib/%%@project%%/cliutils.rb
+- templates/ruby-cli/test/helper_cliutils.rb
 homepage: http://github.com/gromnitsky/falsework
 licenses: []
-post_install_message: 
+post_install_message: ! 'Users of 2.x! Your custom templates must be updated--format
+
+  of #config.yaml has changed.
+
+
+  See also doc/NEWS.rdoc file even if you don''t have custom templates.
+
+'
 rdoc_options:
 - -m
 - doc/README.rdoc
@@ -183,6 +209,6 @@ signing_key:
 specification_version: 3
 summary: A primitive scaffold generator for writing CLI programs in Ruby.
 test_files:
-- test/test_cl.rb
-- test/test_exe.rb
+- test/test_cli.rb
 - test/test_mould.rb
+- test/test_upgrader.rb

data/dynamic.ruby-cli

@@ -1,3 +0,0 @@
-lib/falsework/templates/ruby-cli/lib/%%@project%%/cliconfig.rb
-lib/falsework/templates/ruby-cli/lib/%%@project%%/cliutils.rb
-lib/falsework/templates/ruby-cli/test/helper_cliutils.rb

data/lib/falsework/templates/c-glib/#config.yaml

@@ -1,18 +0,0 @@
----
-:exe:
-- :src: 'src/#exe.h'
-  :dest: 'src/%s.h'
-  :mode_int: null
-- :src: 'src/#exe.c'
-  :dest: 'src/%s.c'
-  :mode_int: null
-
-:doc:
-- :src: 'doc/#doc.ascii'
-  :dest: 'doc/%s.1.asciidoc'
-  :mode_int: null
-
-:test:
-- :src: 'test/#test.c'
-  :dest: 'test/test_%s.c'
-  :mode_int: null

data/lib/falsework/templates/ruby-cli/#config.yaml

@@ -1,15 +0,0 @@
----
-:exe:
-- :src: 'bin/%%@project%%'
-  :dest: 'bin/%s'
-  :mode_int: 0744
-
-:doc:
-- :src: 'doc/#doc.rdoc'
-  :dest: 'doc/%s.rdoc'
-  :mode_int: null
-
-:test:
-- :src: 'test/test_%%@project%%.rb'
-  :dest: 'test/test_%s.rb'
-  :mode_int: null

data/lib/falsework/templates/ruby-cli/etc/%%@project%%.yaml

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

data/test/rake_erb_templates.rb

@@ -1,60 +0,0 @@
-#!/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]?', "lib/#{local_prj}/templates", '/html', '/pkg',
-              '/test/templates', 'rake_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: [^\s]+/
-          t = i.sub(/^.+?\//, '')
-          r[target + '/' + t.sub(/#{local_prj}/, '%%@project%%')] = t
-          break
-        end
-        n += 1
-      end
-    }
-  }
-  
-  r
-end
-
-def erb_make(local_prj, template, target, tmplt)
-  raw = File.read(tmplt)
-  raw.gsub!(/#{local_prj}/, '<%= @project %>')
-  raw.gsub!(/#{Mould.name_camelcase(local_prj)}/, '<%= @camelcase %>')
-
-  mark = <<-EOF
-
-# Don't remove this: <%= #{Mould.name_camelcase(local_prj)}::Meta::NAME %>/<%= #{local_prj.capitalize}::Meta::VERSION %>/#{template}/<%= DateTime.now %>
-  EOF
-  File.open(target, 'w+') {
-    |fp| fp.puts raw + ERB.new(mark).result(binding)
-  }
-end
-
-
-pp erb_skeletons(Falsework::Meta::NAME, 'ruby-cli') if __FILE__ == $0

data/test/templates/config-02.yaml

@@ -1,2 +0,0 @@
----
-:tdir: 'templates'

data/test/test_cl.rb

@@ -1,33 +0,0 @@
-require_relative 'helper'
-require_relative '../lib/falsework/mould'
-
-class Test3867654745 < MiniTest::Unit::TestCase
-  def setup
-    # this runs every time before test_*
-    @cmd = cmd('falsework') # get path to the exe & cd to tests directory
-  end
-
-  def test_listdirs
-    assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
-    out, err = capture_io { Mould.template_dirs_add [Pathname.new("DOESN'T EXISI")] }
-    assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
-    
-    assert_raises(RuntimeError) { Mould.template_dirs_add([Dir.pwd]) }
-    assert_equal 2, Mould.class_variable_get(:@@template_dirs).size
-    
-    Mould.template_dirs_add [Pathname.new(Dir.pwd)]
-    assert_equal 3, Mould.class_variable_get(:@@template_dirs).size
-
-    assert_equal true, Mould.templates.key?("templates")
-  end
-
-  def test_new_dir_from_config
-    r = CliUtils.exec "#{@cmd} --config /NO_SUCH_FILE.yaml listdirs"
-    assert_equal(0, r[0])
-    assert_equal(2, r[2].split("\n").size)
-    
-    r = CliUtils.exec "#{@cmd} --config templates/config-01.yaml listdirs"
-    assert_equal(0, r[0])
-    assert_equal(3, r[2].split("\n").size)
-  end
-end