bobbyno-tbox 0.5.2 → 0.6

data/app_generators/{tbox → ruby}/USAGE

@@ -2,8 +2,7 @@ Description:
 
 tbox lowers the barrier to entry for test-driven learning by providing a basic infrastructure in which 
 to start coding: A directory structure, some classes and unit tests to get started, and a Rakefile to run
-all tests. For now, tbox is geared toward Ruby, though the technique is applicable to any language that 
-lends itself to TDD.
+all tests. 
   
 Usage:
   

data/app_generators/ruby/ruby_generator.rb

@@ -0,0 +1,34 @@
+require 'tbox_app_generator'
+
+class RubyGenerator < TboxAppGenerator
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      m.file "rakefile.rb", "rakefile.rb"
+      m.directory "lib/samples"
+      m.file "right_triangle.rb", "lib/samples/right_triangle.rb"
+      m.file "tbox.rb", "lib/tbox.rb"
+      m.directory "test/samples"
+      m.directory "test/data"
+      m.file "test_right_triangle.rb", "test/samples/test_right_triangle.rb"
+      m.file "test_io.rb", "test/test_io.rb"
+      m.file "file.txt", "test/data/file.txt"
+      m.file "test_helper.rb", "test/test_helper.rb"
+
+      m.dependency "install_rubigen_scripts", [destination_root, 'tbox'],
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    # Installation skeleton.
+    BASEDIRS = %w(
+      lib
+      script
+      test
+    )
+end

data/app_generators/{tbox → ruby}/templates/right_triangle.rb

@@ -14,11 +14,5 @@ class RightTriangle
   def area
     0.5 * @a * @b
   end
-  
-private
 
-  def s
-    semiperimeter
-  end
-  
 end

data/app_generators/ruby/templates/test_helper.rb

@@ -0,0 +1,9 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/tbox'
+
+module Constants  
+  if (!defined? TEST_DATA_DIR)
+    TEST_DATA_DIR = File.join(File.expand_path(File.dirname(__FILE__)), "data")
+  end
+end

data/bin/tbox

@@ -2,16 +2,19 @@
 
 require 'rubygems'
 require 'rubigen'
-
+require File.dirname(__FILE__) + "/../lib/tbox"
+require File.dirname(__FILE__) + "/../lib/languages"
+  
 if %w(-v --version).include? ARGV.first
-  require File.dirname(__FILE__) + "/../lib/tbox"
   puts "#{File.basename($0)} #{Tbox::VERSION}"
   exit(0)
 end
 
 require 'rubigen/scripts/generate'
+
 source = RubiGen::PathSource.new(:application, 
   File.join(File.dirname(__FILE__), "../app_generators"))
 RubiGen::Base.reset_sources
 RubiGen::Base.append_sources source
-RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'tbox')
+
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => Languages.parse(ARGV))

data/lib/languages.rb

@@ -0,0 +1,22 @@
+class Languages
+
+  def self.parse(args)
+    lang = args.find {|arg| ((arg =~ /-l=/) or (arg =~ /--language=/)) }
+    lang = "-l=ruby" if lang.nil?
+    lang = lang.split('=')[1]
+    raise "Supported languages: #{current.inspect}" if (!current.member?(lang))
+    lang
+  end
+  
+  def self.current
+    langs = Dir.entries(File.join(File.dirname(__FILE__), "../app_generators"))
+    langs.reject {|i| ((i == ".") or (i == ".."))}
+  end
+  
+  def self.print
+    list = ""
+    current.each {|lang| list << lang << '|'}
+    list.chomp('|')
+  end
+  
+end

data/lib/tbox.rb

@@ -2,5 +2,5 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 module Tbox
-  VERSION = '0.5.2'
+  VERSION = '0.6'
 end

data/lib/tbox_app_generator.rb

@@ -0,0 +1,41 @@
+class TboxAppGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+
+  default_options :language => 'ruby'
+
+  attr_reader :language
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+  
+  protected
+  
+    def banner
+      "\n" << IO.readlines(File.join(File.dirname(__FILE__), "../README.rdoc"))[0]
+    end
+    
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |o| options[:author] = o }
+      opts.on("-l", "--language=name", "Language of the environment to generate. Options: #{Languages.print}", "Default: ruby")
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      @language = options[:language]
+    end
+  
+end

data/test/test_generator_helper.rb

@@ -27,3 +27,40 @@ rescue LoadError
   require 'rubigen'
 end
 require 'rubigen/helpers/generator_test_helper'
+
+module RubiGen::GeneratorTestHelper
+  def assert_file_contains(keyword, filename)
+    ipr = IO.readlines(File.join(APP_ROOT, filename)).to_s
+    assert(ipr =~ Regexp.new(keyword))
+  end
+
+  def run_generated_build_script(cmd)
+    FileUtils::cd(APP_ROOT) do
+      puts "Running generated build script in #{FileUtils::pwd} with #{cmd}"
+      `#{cmd}`
+      raise "Exit code #{$?} while running generated build script with #{cmd}" if ($?.to_s != "0")
+    end
+  end
+
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))]
+  end
+
+  def generator_path
+    "app_generators"
+  end
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+end
+

data/test/test_java_generator.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+class TestJavaGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  def test_generator_without_options
+    run_generator('java', [APP_ROOT], sources)
+    assert_generated_file   "myproject.ipr"
+    assert_generated_file   "myproject.iml"
+    assert_file_contains(PROJECT_NAME, "myproject.ipr")
+
+    assert_directory_exists "build"
+    assert_generated_file   "build/build.xml"
+    assert_file_contains(PROJECT_NAME, "build/build.xml")
+    
+    assert_directory_exists "lib"
+    assert_generated_file   "lib/junit.jar"
+    assert_generated_file   "lib/hamcrest-core.jar"    
+    
+    assert_directory_exists "src"
+    assert_generated_file   "src/com/samples/Greeting.java"
+    
+    assert_directory_exists "test"    
+    assert_generated_file   "test/com/samples/GreetingTest.java"
+    
+    run_generated_build_script("ant -f build/build.xml")
+  end
+
+end

data/test/test_languages.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require 'languages'
+
+class TestLanguages < Test::Unit::TestCase
+  
+  def test_list_current_languages
+    langs = Languages.current
+    assert(langs.length > 1)
+    assert(!langs.include?("."))
+    assert(!langs.include?(".."))
+  end
+  
+  def test_parse_command_for_valid_language
+    args = %w{-l=java MyAppName}
+    assert_equal("java", Languages.parse(args))
+    args = %w{--language=ruby app_name}
+    assert_equal("ruby", Languages.parse(args))
+  end
+  
+  def test_reject_invalid_language
+    args = %w{-l=non sense}
+    assert_raise RuntimeError do 
+      Languages.parse(args)
+    end
+  end
+  
+  def test_print_languages
+    base = "java|ruby"
+    print = Languages.print
+    assert(print.include?(base))
+  end
+end

data/test/test_ruby_generator.rb

@@ -0,0 +1,32 @@
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require 'fileutils'
+
+class TestRubyGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  def test_generator_without_options
+    run_generator('ruby', [APP_ROOT], sources)
+    
+    assert_generated_file   "rakefile.rb"
+    assert_directory_exists "lib/samples"
+    assert_generated_file   "lib/samples/right_triangle.rb"
+    assert_generated_file   "lib/tbox.rb"
+    assert_directory_exists "test/samples"
+    assert_generated_file   "test/samples/test_right_triangle.rb"
+    assert_directory_exists "test/data"
+    assert_generated_file   "test/data/file.txt"
+    assert_generated_file   "test/test_io.rb"
+    assert_generated_file   "test/test_helper.rb"
+    
+    run_generated_build_script("rake")
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bobbyno-tbox
 version: !ruby/object:Gem::Version 
-  version: 0.5.2
+  version: "0.6"
 platform: ruby
 authors: 
 - Bobby Norton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-18 00:00:00 -07:00
+date: 2009-06-24 00:00:00 -07:00
 default_executable: tbox
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: Provides a basic directory structure for test-driven learning.
+description: "Test-driven learning is a way to master a programming language by writing unit tests around its API's.  tbox lowers the barrier to entry for test-driven learning by providing a basic infrastructure in which  to start coding: A directory structure, some classes and unit tests to get started, and a build script."
 email: 
 - codeculturist@gmail.com
 executables: 
@@ -44,7 +44,7 @@ extra_rdoc_files:
 - Manifest.txt
 - PostInstall.txt
 - README.rdoc
-- app_generators/tbox/templates/file.txt
+- app_generators/ruby/templates/file.txt
 files: 
 - History.txt
 - MIT-LICENSE
@@ -52,25 +52,36 @@ files:
 - PostInstall.txt
 - README.rdoc
 - Rakefile
-- app_generators/tbox/USAGE
-- app_generators/tbox/tbox_generator.rb
-- app_generators/tbox/templates/README
-- app_generators/tbox/templates/file.txt
-- app_generators/tbox/templates/rakefile.rb
-- app_generators/tbox/templates/right_triangle.rb
-- app_generators/tbox/templates/tbox.rb
-- app_generators/tbox/templates/test_helper.rb
-- app_generators/tbox/templates/test_io.rb
-- app_generators/tbox/templates/test_right_triangle.rb
+- app_generators/java/USAGE
+- app_generators/java/java_generator.rb
+- app_generators/java/templates/Greeting.java
+- app_generators/java/templates/GreetingTest.java
+- app_generators/java/templates/build.xml
+- app_generators/java/templates/lib/hamcrest-core.jar
+- app_generators/java/templates/lib/junit.jar
+- app_generators/java/templates/project.iml
+- app_generators/java/templates/project.ipr
+- app_generators/ruby/USAGE
+- app_generators/ruby/ruby_generator.rb
+- app_generators/ruby/templates/file.txt
+- app_generators/ruby/templates/rakefile.rb
+- app_generators/ruby/templates/right_triangle.rb
+- app_generators/ruby/templates/tbox.rb
+- app_generators/ruby/templates/test_helper.rb
+- app_generators/ruby/templates/test_io.rb
+- app_generators/ruby/templates/test_right_triangle.rb
 - bin/tbox
+- lib/languages.rb
 - lib/tbox.rb
+- lib/tbox_app_generator.rb
 - script/console
 - script/destroy
 - script/generate
-- tbox.gemspec
 - test/test_generator_helper.rb
 - test/test_helper.rb
-- test/test_tbox_generator.rb
+- test/test_java_generator.rb
+- test/test_languages.rb
+- test/test_ruby_generator.rb
 has_rdoc: false
 homepage: http://github.com/bobbyno/tbox/tree/master
 post_install_message: PostInstall.txt
@@ -97,8 +108,10 @@ rubyforge_project: tbox
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 3
-summary: "Test-driven learning is a way to master a programming language by writing unit tests around its API's,  tbox lowers the barrier to entry for test-driven learning by providing a basic infrastructure in which  to start coding: A directory structure, some classes and unit tests to get started, and a Rakefile to run all tests."
+summary: Test-driven learning is a way to master a programming language by writing unit tests around its API's
 test_files: 
 - test/test_generator_helper.rb
 - test/test_helper.rb
-- test/test_tbox_generator.rb
+- test/test_java_generator.rb
+- test/test_languages.rb
+- test/test_ruby_generator.rb

data/app_generators/tbox/tbox_generator.rb

@@ -1,84 +0,0 @@
-class TboxGenerator < RubiGen::Base
-
-  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
-                              Config::CONFIG['ruby_install_name'])
-
-  default_options :author => nil
-
-  attr_reader :name
-
-  def initialize(runtime_args, runtime_options = {})
-    super
-    usage if args.empty?
-    @destination_root = File.expand_path(args.shift)
-    @name = base_name
-    extract_options
-  end
-
-  def manifest
-    record do |m|
-      # Ensure appropriate folder(s) exists
-      m.directory ''
-      BASEDIRS.each { |path| m.directory path }
-
-      m.file "rakefile.rb", "rakefile.rb"
-      m.file "README", "README"
-      m.file "../../../MIT-LICENSE", "MIT-LICENSE"
-      # Create stubs
-      # m.template "template.rb",  "some_file_after_erb.rb"
-      # m.template_copy_each ["template.rb", "template2.rb"]
-      # m.file     "file",         "some_file_copied"
-      # m.file_copy_each ["path/to/file", "path/to/file2"]
-      m.directory "lib/samples"
-      m.file "right_triangle.rb", "lib/samples/right_triangle.rb"
-      m.file "tbox.rb", "lib/tbox.rb"
-      m.directory "test/samples"
-      m.directory "test/data"
-      m.file "test_right_triangle.rb", "test/samples/test_right_triangle.rb"
-      m.file "test_io.rb", "test/test_io.rb"
-      m.file "file.txt", "test/data/file.txt"
-      m.file "test_helper.rb", "test/test_helper.rb"
-
-      m.dependency "install_rubigen_scripts", [destination_root, 'tbox'],
-        :shebang => options[:shebang], :collision => :force
-    end
-  end
-
-  protected
-    def banner
-      <<-EOS
-Creates a test-driven learning environment: A directory structure, some sample classes and unit tests, 
-and a Rakefile to run all tests.
-
-USAGE: #{spec.name} dir_name
-EOS
-    end
-
-    def add_options!(opts)
-      opts.separator ''
-      opts.separator 'Options:'
-      # For each option below, place the default
-      # at the top of the file next to "default_options"
-      # opts.on("-a", "--author=\"Your Name\"", String,
-      #         "Some comment about this option",
-      #         "Default: none") { |o| options[:author] = o }
-      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
-    end
-
-    def extract_options
-      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
-      # Templates can access these value via the attr_reader-generated methods, but not the
-      # raw instance variable value.
-      # @author = options[:author]
-    end
-
-    # Installation skeleton.  Intermediate directories are automatically
-    # created so don't sweat their absence here.
-    BASEDIRS = %w(
-      lib
-      log
-      script
-      test
-      tmp
-    )
-end