tap 0.8.0 → 0.9.0

data/lib/tap/generator/generators/file_task/USAGE

@@ -0,0 +1,3 @@
+Description:
+    Generates a new FileTask and test files.  Pass the task name, 
+    either CamelCased or under_scored.

data/lib/tap/generator/generators/file_task/file_task_generator.rb

@@ -2,5 +2,21 @@ require 'tap/generator/generators/task/task_generator'
 
 module Tap::Generator::Generators
   class FileTaskGenerator < TaskGenerator # :nodoc:
+    
+    def task_manifest(m)
+      return unless options[:test]
+      
+      test_path = @app.relative_filepath(:root, @app[:test])
+      m.directory File.join(test_path, class_name.underscore)
+        
+      method_test_path = File.join(test_path, class_name.underscore, "test_#{file_name.underscore}")
+      m.directory method_test_path
+      m.directory File.join(method_test_path, "input")
+      m.directory File.join(method_test_path, "expected")
+        
+      m.file "file.txt", File.join(method_test_path, "input", "file.txt")
+      m.file "file.yml", File.join(method_test_path, "expected", "file.yml")
+    end
+    
   end
 end

data/lib/tap/generator/generators/file_task/templates/file.txt

@@ -0,0 +1,2 @@
+Line One
+Line Two

data/lib/tap/generator/generators/file_task/templates/file.yml

@@ -0,0 +1,3 @@
+--- 
+- Line One
+- Line Two

data/lib/tap/generator/generators/file_task/templates/task.erb

@@ -1,34 +1,40 @@
 # == Description
-# Replace with a description for <%= class_name_without_nesting %>
+# Replace with a description.  The default task reads
+# in the lines of a text file and dumps them as YAML
+# into a yaml file.
 # === Usage
 # Replace with usage instructions
 #
 class <%= class_name_without_nesting %> < Tap::FileTask
-  # uncomment to:
-  # - pass all inputs to process at once 
-  # - define a task that takes no inputs
-  
-  #do_not_iterate
-  
   # use config to set task configurations
   # configs have accessors by default
   
-  #config :key, 'value'          # config documentation
+  config :key, 'value'           # a sample config
+  
+  # process defines what the task does; use the
+  # same number of inputs to enque the task
+  # as specified here
+  def process(filepath)
 
-  def process(input)
-    # The process logic goes here.
-    output = filepath(:data, input)
+    # infer an output filepath relative to the :data directory, 
+    # (this is convenient for testing) while changing the 
+    # basename of filepath to 'yml'.  See FileTask#filepath 
+    # for filepaths based on the task name.
+    target = app.filepath(:data, basename(filepath, '.yml') )
 
-    # prepare ensures the parent directory for
-    # output exists, and marks it for rollback
+    # prepare ensures the parent directory for 
+    # output exists, and that output does not; 
+    # any existing file is backed up and reverts
     # in the event of an error
-    prepare(output) 
-
-    File.open(input) do |source|
-      File.open(output, "w") do |target|
-        # ... do something ...
-      end
+    prepare(target) 
+    
+    # now perform the task...
+    array = File.read(filepath).split(/\r?\n/)
+    File.open(target, "wb") do |file|
+      file << array.to_yaml
     end
+    
+    target
   end
   
-end
+end

data/lib/tap/generator/generators/file_task/templates/test.erb

@@ -1,23 +1,33 @@
 require File.join(File.dirname(__FILE__), '<%= '../' * class_nesting_depth %>tap_test_helper.rb') 
 require '<%= class_path.empty? ? file_name : File.join(class_path, file_name) %>'
 
-class <%= class_name_without_nesting %>Test < Test::Unit::TestCase
+class <%= class_name %>Test < Test::Unit::TestCase
   acts_as_tap_test 
   
   def test_<%= file_name.underscore %>
-    # this test will make input/expected directories for the
-    # test_<%= file_name.underscore %> the first time it is
-    # run.  assert_expected_result_files runs t with all the 
-    # input files and returns true only if the expected and 
-    # output files are equal
+    # assert_expected_result_files provides a list of the
+    # files in '<%= class_name_without_nesting.underscore %>/test_<%= file_name.underscore %>/input'
+    # and expects that the block makes a list of output
+    # files in '<%= class_name_without_nesting.underscore %>/test_<%= file_name.underscore %>/output'
     #
-    # output files are cleaned up by default.  to preserve
-    # them use:
+    # These outputs are compared by content with the 
+    # files in '<%= class_name_without_nesting.underscore %>/test_<%= file_name.underscore %>/expected'
+    # 
+    # The output directory is cleaned up by default.  To 
+    # preserve it, set the KEEP_OUTPUTS env variable:
     #
-    #   % tap run test keep_outputs=true
+    #   % rake test keep_outputs=true
     
     t = <%= class_name %>.new 
-    assert_expected_result_files(t)
+    assert_files do |input_files|
+      input_files.each {|file| t.enq(file)}
+      
+      with_config :directories => {:data => 'output'} do 
+        app.run
+      end
+      
+      app.results(t)
+    end
   end
   
 end

data/lib/tap/generator/generators/generator/generator_generator.rb

@@ -10,7 +10,7 @@ module Tap::Generator::Generators
 
     def manifest
       record do |m|
-        generators_root = @app.relative_filepath(:root, @app[:generators])
+        generators_root = @app.relative_filepath(:root, @app['generators'])
         m.directory File.join(generators_root, file_name, "templates")
         
         m.template "generator.erb", File.join(generators_root,  file_name, file_name + "_generator.rb")

data/lib/tap/generator/generators/generator/templates/generator.erb

@@ -1,23 +1,32 @@
 class <%= class_name_without_nesting %>Generator < Rails::Generator::NamedBase 
+  attr_accessor :app
+  
   def initialize(*args)
-    super(*args)    
-    @destination_root  = Tap::App.instance[:root]
-    @app = Tap::App.instance
+    super(*args) 
+    @app = Tap::App.instance   
+    @destination_root = app[:root]
   end
 
   def manifest
     record do |m|
       # Use statements like these to make directories you need.
-      # Note directories will be created relative to @destination_root
-      # (ie @app[:root]) so the target dir must be a relative filepath
-      #target_dir = @app.relative_filepath(:root, @app[:target])
-      #m.directory target_dir
+      # Note directories will be created relative to @destination_root (ie app[:root])
+      target_dir = 'target'
+      m.directory target_dir
       
-      # These statements would create the following files:
-      #   templates/ruby_file.erb =>  target_dir/class_name.rb
-      #   tempaltes/text_file.erb  =>  target_dir/class_name.txt
-      #m.template "ruby_file.erb", File.join(target_dir, class_name.underscore + ".rb"), :class_nesting => class_nesting
-      #m.template "text_file.erb",  File.join(target_dir, class_name.underscore + ".txt")
+      # These statements use the templates to create the following files:
+      #   templates/ruby_file.erb  =>  target_dir/class_name.rb
+      #   templates/text_file.erb  =>  target_dir/class_name.txt
+      #
+      # In templates, use class_name_without_nesting in conjunction with 
+      # the :class_nesting option to properly indent nested classes, like:
+      #
+      #   [ruby_file.erb]
+      #   class <%= class_name_without_nesting %>
+      #   end
+      #
+      m.template "ruby_file.erb", File.join(target_dir, class_name.underscore + ".rb"), :class_nesting => class_nesting
+      m.template "text_file.erb",  File.join(target_dir, class_name.underscore + ".txt")
     end
   end
 end

data/lib/tap/generator/generators/root/templates/Rakefile

@@ -9,21 +9,29 @@ task :default => :test
 
 desc 'Run tests.'
 Rake::TestTask.new(:test) do |t|
+  
+  # Here the current load paths are used to define the load
+  # paths in the test.  This is convenient for development 
+  # but doesn't have to be here.  Note the patch is to
+  # allow spaces in the lib paths, as you find on Windows.
+  require 'tap/patches/rake/testtask'
+  t.libs = $: + ['lib']
+  
   t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+  t.verbose = true
   t.warning = true
 end
 
 desc 'Generate documentation.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
+Rake::RDocTask.new(:rdoc) do |rdoc|
   # options to specify TDoc
-  require 'tap/support/tdoc'
-  rdoc.template = 'tap/support/tdoc/tdoc_html_template' 
-  rdoc.options << '--fmt' << 'tdoc'
-  
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = '<%= file_name %>'
-  rdoc.template = 'tap/support/tdoc/tdoc_html_template' 
+  require 'tap/support/tdoc'
+  rdoc.template = 'tap/support/tdoc/tdoc_html_template' 
+  rdoc.options << '--fmt' << 'tdoc'
+  
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = '<%= file_name %>'
+  rdoc.template = 'tap/support/tdoc/tdoc_html_template' 
   rdoc.options << '--line-numbers' << '--inline-source'
   rdoc.rdoc_files.include('ReadMe.txt')
   rdoc.rdoc_files.include('lib/**/*.rb')
@@ -32,23 +40,24 @@ end
 #
 # Gem specification
 #
+
 spec = Gem::Specification.new do |s|
-	s.name = "<%= file_name %>"
-	s.version = "0.0.1"
-	s.author = "Your Name Here"
-	#s.email = "your.email@pubfactory.edu"
-	#s.homepage = "http://rubyforge.org/projects/gemname/"
-	s.platform = Gem::Platform::RUBY
-	s.summary = "Add Description"
-	s.files = Dir.glob("{test,lib}/**/*") + ["Rakefile", "ReadMe.txt"]
-	s.require_path = "lib"
-	s.test_file = "test/tap_test_suite.rb"
-	
-	s.has_rdoc = true
-	s.extra_rdoc_files = ["ReadMe.txt"]
-	s.add_dependency("tap", ">= <%= Tap::VERSION %>")
+  s.name = "<%= file_name %>"
+  s.version = "0.0.1"
+  s.author = "Your Name Here"
+  #s.email = "your.email@pubfactory.edu"
+  #s.homepage = "http://rubyforge.org/projects/gemname/"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Add Description"
+  s.files = Dir.glob("{test,lib}/**/*") + ["Rakefile", "ReadMe.txt"]
+  s.require_path = "lib"
+  s.test_file = "test/tap_test_suite.rb"
+  
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["ReadMe.txt"]
+  s.add_dependency("tap", ">= <%= Tap::VERSION %>")
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
-	pkg.need_tar = true
+  pkg.need_tar = true
 end

data/lib/tap/generator/generators/root/templates/tap.yml

@@ -1,9 +1,8 @@
 ######################################################
 # App Configurations:
 #
-# These are configurations that directly affect the
-# application, including the directory structure
-# options, and logging.
+# These are configurations that directly affect the application, 
+# including the directory structure options, and logging.
 #
 ######################################################
   
@@ -11,27 +10,24 @@
 # an odd and perhaps unwise thing to do
 #root:                         
 
-# Uncomment to specify aliases for directories relative to root.  
-# Access using:  app['lib']           # => root/alt_lib
-# By default:    app['lib']           # => root/lib
+# Specify aliases for directories relative to root.  
 #directories:                  
-  #lib: alt_lib             
+  #lib: path/to/lib 
+  #lib/generators: path/to/lib/generators              
   #...
   
-# Uncomment to specify aliases for absolute paths
-# Access using:  app['log']           # => /path/to/logs
+# Specify aliases for absolute paths
 #absolute_paths:                  
   #log: /path/to/logs      
   #...
 
-# Uncomment to specify options.
-# Access using:  app.options.debug    # => true 
+# Specify options
 #options:                      
   #debug: true                   # full error output, increased logging
   #quiet: true                   # supresses logging
   #...                           # you can add your own options
   
-# Specify logging options here.  
+# Specify logging options
 #logger:
   #device:                       # STDOUT by default
   #level: 1                      # [DEBUG, INFO, WARN, ERROR, FATAL, ANY]
@@ -44,33 +40,34 @@
 #  some/task_name: Tap::FileTask
 #  CapsAreOk: Tap::Task
 
-
 ######################################################
-# Script Configurations:
+# Environment Configurations:
+#
+# These are configurations that affect the execution environment 
+# for Tap and are NOT passed to the application itself.
 #
-# These are configurations that affect the execution 
-# environment for Tap and are NOT passed to the 
-# application itself.
+# All paths are resolved to the directories setup above.
 #
 ######################################################
 
-# Designate load paths here for automatic loading and
-# reloading of tasks through the active_support 
-# Dependencies module.  The default is 'lib'.  Paths 
-# are resolved to the aliases setup above, 
-# 'lib' => app['lib']
+# Designate load paths here for automatic loading of modules
+# through the active_support Dependencies module.  
+# load_paths are also added to $LOAD_PATH.  
 #load_paths: 
-#  - 'lib'
+#  - lib
+
+# Specifies load_once_paths for Dependencies.
+#load_once_paths:
+
+# Designate paths for discovering and executing commands.  
+#command_paths:
+#  - cmd
 
-# Designate script paths for discovering and executing
-# commands.  The default is 'script'. Paths are resolved 
-# to the aliases setup above, 'script' => app['script']
-#script_paths:
-#  - 'script'
+# Designate paths for discovering generators.  
+#generator_paths:
+#  - lib/generators
 
-# Specify gems that contain load_paths and script_paths
-# that you likewise want to be automatically loaded.
-# Specify versions directly.             
+# Specify gems to add to the environment.  Versions may be specified.
 #gems: 
 #  - gem_name
 #  - gem_with_version > 1.0.0

data/lib/tap/generator/generators/root/templates/test/tap_test_helper.rb

@@ -1,2 +1,3 @@
+require 'rubygems'
 require 'tap'
 require 'tap/test'

data/lib/tap/generator/generators/task/USAGE

@@ -0,0 +1,3 @@
+Description:
+    Generates a new Task and test files.  Pass the task name, 
+    either CamelCased or under_scored.

data/lib/tap/generator/generators/task/task_generator.rb

@@ -10,12 +10,25 @@ module Tap::Generator::Generators
       record do |m|
         lib_path = @app.relative_filepath(:root, @app[:lib])
         m.directory File.join(lib_path, class_path)
-        m.template "task.erb", File.join(lib_path, class_name.underscore + ".rb"), :class_nesting => class_nesting
-    
-        test_path = @app.relative_filepath(:root, @app[:test])
-        m.directory File.join(test_path, class_path)
-        m.template "test.erb", File.join(test_path, class_name.underscore + "_test.rb")
+        m.template "task.erb", File.join(lib_path, class_name.underscore + ".rb"), :class_nesting => class_nesting
+        
+        if options[:test]
+          test_path = @app.relative_filepath(:root, @app[:test])
+          m.directory File.join(test_path, class_path)
+          m.template "test.erb", File.join(test_path, class_name.underscore + "_test.rb")
+        end
+        
+        task_manifest(m)
       end
     end
+    
+    def task_manifest(m)
+    end
+    
+    def add_options!(opt)
+      options[:test] = true
+      opt.on(nil, '--[no-]test', 'Generates the task without test files.') { |value| options[:test] = value }
+    end
+
   end
 end

data/lib/tap/generator/generators/task/templates/task.erb

@@ -5,25 +5,20 @@
 # Replace with usage instructions
 #
 class <%= class_name_without_nesting %> < Tap::Task
-  # uncomment to:
-  # - pass all inputs to process at once 
-  # - define a task that takes no inputs
-  
-  #do_not_iterate
-  
   # use config to set task configurations
   # configs have accessors by default
   
-  config :label, 'input'           # a label for output
+  config :key, 'value'           # a sample config
   
+  # process defines what the task does; use the
+  # same number of inputs to enque the task
+  # as specified here
   def process(input)
-    # the process logic goes here.
-  
     # use log to record information
-    log label, input
+    result = "#{input} was processed with #{key}"
+    log self.name, result
   
-    # the return of process is the task output
-    "#{label}: #{input} was processed"
+    result
   end
   
 end