bobbyno-shubox 0.8 → 0.8.1

data/History.txt

@@ -1,3 +1,13 @@
+== 0.8.1 2009-09-26
+
+* 2 minor enhancements:
+	* script/filter_test_unit can be called from within a test file in TextMate 
+	  using "Text -> Filter Through Command" and Document as Input; alternately
+	  create a TextMate command with the contents of the script.
+	* Comments and whitespace are now mostly preserved in test cases; comments
+	  appear after the test case in which they appear.
+	
+
 == 0.8 2009-09-22
 
 * 1 major enhancement:

data/Manifest.txt

@@ -26,6 +26,7 @@ bin/shubox
 cleaner_generators/test_unit_cleaner/USAGE
 cleaner_generators/test_unit_cleaner/lib/test_unit_cleaner.rb
 cleaner_generators/test_unit_cleaner/templates/clean_test_unit
+cleaner_generators/test_unit_cleaner/templates/filter_test_unit
 cleaner_generators/test_unit_cleaner/test_unit_cleaner_generator.rb
 lib/languages.rb
 lib/shubox.rb
@@ -33,9 +34,9 @@ lib/shubox_app_generator.rb
 script/console
 script/destroy
 script/generate
+test/cleaners/test_test_unit_cleaner.rb
+test/generators/test_java_generator.rb
+test/generators/test_ruby_generator.rb
+test/lib/test_languages.rb
 test/test_generator_helper.rb
 test/test_helper.rb
-test/test_java_generator.rb
-test/test_languages.rb
-test/test_ruby_generator.rb
-test/test_test_unit_cleaner.rb

data/README.rdoc

@@ -14,6 +14,20 @@ shubox currently creates environments for Ruby and Java, but can easily be exten
 lends itself to unit testing. shubox is built on newgem, so extending the framework is as simple as creating
 new generator scripts.
 
+After installing shubox and generating a testing environment, you'll start off with some passing tests that exercise
+parts of the language's API. Write new learning tests, naming each method with the intent of the lesson, then write 
+the code that makes a test pass. 
+
+Can you complete the lesson again from memory? If not, you may need to study the concept more closely 
+and implement the tests again. According to {a paper by Karpicke and Roediger}[http://psych.wustl.edu/memory/Roddy%20article%20PDF's/Karpicke_Roediger_2008_Science.pdf],
+"repeated retrieval practice led to greater than 150% improvements in long-term retention than studying alone.
+...Although educators and psychologists often consider testing a neutral process that merely assesses the 
+contents of memory, practicing retrieval during tests clearly produces more learning than additional 
+encoding or study once an item has been recalled."
+
+shubox makes repeated testing easy by providing built-in test cleaners that delete your test implementations, 
+while keeping comments and test names to express the intent of the test.
+
 == INSTALL
 
 The <code>shubox</code> application is distributed as a RubyGem and is available immediately after installation.
@@ -34,17 +48,15 @@ Ruby is the default language option in shubox:
 
 <code>$ rake</code>
 
-If all goes well, you should start off with some passing tests. Write new learning tests, 
-naming each method with the intent of the lesson. Write the code that makes a test pass. 
-
-Now run script/clean. Cleaners will reset test files by deleting the method bodies. 
-Can you complete the lesson from memory? If so, can you do so faster than before? 
-If not, you may need to study the concept more closely. 
+To clean all tests in your project: 
 
-Repeat a test-driven lesson until you can easily rewrite it from scratch. Once you can do so, 
-you may move on to another lesson. 
+<code>$ script/clean_test_unit .</code>
 
-This is repetition with a retrieval step, which leads to long-term retention.
+If you're using TextMate, you can quickly reset a test file from within the editor using 
+"Text -> Filter Through Command". Select "/tmp/learn_ruby/script/filter_test_unit"
+as the command, select "Document" as input, and select "Replace Document" as output. Alternately,
+save the contents of the filter script to a custom TextMate command to easily run it with a 
+keyboard shortcut.
 
 == JAVA USAGE
 
@@ -69,7 +81,8 @@ app_generators are where we define the basic environment for one of our supporte
 
 cleaner_generators hold the test framework cleaning implementations to reset tests. 
 In the future, these can be mixed and matched to support polyglots like JRuby by installing both 
-JUnit and Test::Unit cleaners.
+JUnit and Test::Unit cleaners. Run script/generate in a generated shubox to see the list of 
+available cleaners and generators that can be installed.
 
 cleaner/lib folders hold the implementations of the cleaners referenced in the clean_xxx files 
 copied to the generated application. This makes it easy to upgrade existing shuboxes.

data/Rakefile

@@ -33,7 +33,7 @@ Dir['tasks/**/*.rake'].each { |t| load t }
 # task :default => [:spec, :features]
 
 desc "Create the gem and install it"
-task :dev => [:clean, :manifest, :clean_manifest, :gemspec, :package, :install_gem]
+task :dev => [:clean, :manifest, :clean_manifest, :gemspec, :package, :install_gem, :uat]
 
 desc "Strip out the entries in the .git folder for ppl who haven't updated .hoerc"
 task :clean_manifest do
@@ -48,5 +48,10 @@ task :clean do
 end
 
 task :uninstall do
+  rm_rf("/tmp/tester")
   sh "sudo gem uninstall shubox"
+end
+
+task :uat do
+  sh "shubox /tmp/tester"
 end

data/app_generators/ruby/templates/test_io.rb

@@ -6,9 +6,9 @@ require File.dirname(__FILE__) + '/test_helper'
 # Exploring the methods of the IO class: http://www.ruby-doc.org/core/classes/IO.html
 class TestIO < Test::Unit::TestCase
 
-  def test_readlines
+  # See String Match for =~ syntax: http://www.ruby-doc.org/core/classes/String.html#M000792
+  def test_readlines_reads_files_as_array
     contents = IO.readlines(File.join(Constants::TEST_DATA_DIR, "file.txt"))
-    # See String Match for =~ syntax: http://www.ruby-doc.org/core/classes/String.html#M000792
     assert(contents[0] =~ /Salam/)
   end
 

data/cleaner_generators/test_unit_cleaner/lib/test_unit_cleaner.rb

@@ -2,35 +2,22 @@ module Shubox
   class TestUnitCleaner
     
     def run(args)
-      if (%w(-h --help).include?(args.first) || args.empty?)
-        puts usage
-        return 0
-      end
-
       target = args.first
+      return usage if empty_or_help?(target)
       
-      if (/.rb$/ =~ target)
-        clean(target)
+      if File.file?(target)
+        clean_file(target)
       else
         clean_directory(target)
       end
     end
     
-    private    
-    def clean_directory(dir)
-      files = Dir["#{dir}/test/**/test_*.rb"].each { |file| clean(file) }
-    end
-    
-    def clean(filename)
-      return if /test_helper.rb/ =~ filename 
-      puts "cleaning: #{filename}"
-      
-      lines = File.readlines(filename)
+    def clean_class(lines)
       output = []
       outside_class = true
       
       lines.each do |line|
-        if (outside_class)
+        if (outside_class || comment?(line))
           output << line
         elsif (/^\s*def test_/ =~ line)
           output << line
@@ -42,15 +29,37 @@ module Shubox
         end
       end
       output << 'end'
-      
-      open(filename, 'w') do |f|
-        f.puts output.join
-      end
+      output.join
+    end
+    
+    def comment?(line)
+      (line =~ /^\s*#/ || line =~ /^\s*$/)
+    end
+    
+    def empty_or_help?(input)
+      return (input.nil? || input.empty? || %w(-h --help).include?(input))
     end
     
     def usage
       usage_file = File.dirname(__FILE__) + "/../USAGE"
       return File.readlines(usage_file)
     end
+    
+    private    
+    def clean_directory(dir)
+      files = Dir["#{dir}/test/**/test_*.rb"].each { |file| clean_file(file) }
+    end
+    
+    def clean_file(filename)
+      return if /test_helper.rb/ =~ filename 
+      puts "cleaning: #{filename}"
+      
+      lines = File.readlines(filename)
+      output = clean_class(lines)
+      
+      open(filename, 'w') do |f|
+        f.puts output
+      end
+    end
   end
 end

data/cleaner_generators/test_unit_cleaner/templates/clean_test_unit

@@ -9,4 +9,4 @@ end
 
 require 'test_unit_cleaner/lib/test_unit_cleaner'
 
-Shubox::TestUnitCleaner.new.run(ARGV)
+puts Shubox::TestUnitCleaner.new.run(ARGV)

data/cleaner_generators/test_unit_cleaner/templates/filter_test_unit

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'shubox'
+rescue LoadError
+  require 'rubygems'
+  require 'shubox'
+end
+
+require 'test_unit_cleaner/lib/test_unit_cleaner'
+
+doc = ARGF.readlines 
+puts Shubox::TestUnitCleaner.new.clean_class(doc)

data/cleaner_generators/test_unit_cleaner/test_unit_cleaner_generator.rb

@@ -10,7 +10,8 @@ class TestUnitCleanerGenerator < RubiGen::Base
        
     record do |m|
       m.directory 'script'
-      m.template "clean_test_unit", "script/clean_test_unit", script_options
+      m.file "clean_test_unit", "script/clean_test_unit", script_options
+      m.file "filter_test_unit", "script/filter_test_unit", script_options
     end
   end
   

data/lib/shubox.rb

@@ -5,7 +5,7 @@ $:.unshift(File.dirname(__FILE__) + '/../cleaner_generators') unless
   $:.include?(File.dirname(__FILE__) + '/../cleaner_generators') || $:.include?(File.expand_path(File.dirname(__FILE__) + '../cleaner_generators'))
 
 module Shubox
-  VERSION = '0.8'
+  VERSION = '0.8.1'
 end
 
 require 'test_unit_cleaner/lib/test_unit_cleaner'

data/test/{test_test_unit_cleaner.rb → cleaners/test_test_unit_cleaner.rb}

@@ -1,5 +1,5 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
-require File.join(File.dirname(__FILE__), '..', 'cleaner_generators', 'test_unit_cleaner', 'lib', 'test_unit_cleaner')
+require File.join(File.dirname(__FILE__), "..", "test_generator_helper.rb")
+require File.join(File.dirname(__FILE__), '..', '..', 'cleaner_generators', 'test_unit_cleaner', 'lib', 'test_unit_cleaner')
 require 'fileutils'
 require 'languages'
 
@@ -15,21 +15,25 @@ class TestTestUnitCleaner < Test::Unit::TestCase
     bare_teardown
   end
   
-  def test_display_usage_with_no_args
-    no_args = Shubox::TestUnitCleaner.new.run([])
-    assert_equal(0, no_args)
+  def test_display_usage_with_no_args_or_help
+    cleaner = Shubox::TestUnitCleaner.new
+    no_args = cleaner.run([""])
+    assert_equal(cleaner.usage, no_args)
+
+    help = cleaner.run(["--help"])
+    assert_equal(cleaner.usage, help)
   end
   
-  def test_display_usage_with_help
-    help = Shubox::TestUnitCleaner.new.run(["--help"])
-    assert_equal(0, help)
+  def test_detect_comments
+    line = "   # Comment here"
+    cleaner = Shubox::TestUnitCleaner.new
+    assert(cleaner.comment?(line))
+    assert(!cleaner.comment?("hello"))
   end
   
   def test_run_cleaner_on_directory
-    dir_to_clean = File.expand_path(File.join(File.dirname(__FILE__), 'tmp', 'myproject'))
-    puts "\n" + dir_to_clean
+    dir_to_clean = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'myproject'))
     clean_file = File.join(dir_to_clean, 'test', 'test_io.rb')
-    puts clean_file
     Shubox::TestUnitCleaner.new.run([dir_to_clean, "ignored extra parameter"])
     assert_equal <<-EOF, File.read(clean_file)
 require File.dirname(__FILE__) + '/test_helper'
@@ -39,33 +43,41 @@ require File.dirname(__FILE__) + '/test_helper'
 
 # Exploring the methods of the IO class: http://www.ruby-doc.org/core/classes/IO.html
 class TestIO < Test::Unit::TestCase
-  def test_readlines
+
+  # See String Match for =~ syntax: http://www.ruby-doc.org/core/classes/String.html#M000792
+  def test_readlines_reads_files_as_array
   end
+
 end
 EOF
   end
 
   def test_run_cleaner_on_single_file
-    file_to_clean = File.expand_path(File.join(File.dirname(__FILE__), 'tmp', 'myproject', 'test', 'samples', 'test_right_triangle.rb'))
-    Shubox::TestUnitCleaner.new.run([file_to_clean])
-    assert_equal <<-EOF, File.read(file_to_clean)
+    file_to_clean = File.expand_path(File.join(File.dirname(__FILE__), '..', 'tmp', 'myproject', 'test', 'samples', 'test_right_triangle.rb'))
+    contents = File.read(file_to_clean)
+
+    cleaner = Shubox::TestUnitCleaner.new
+    cleaner.run([file_to_clean])
+    cleaned_file = File.read(file_to_clean)
+    
+    assert_equal <<-EOF, cleaned_file
 require File.dirname(__FILE__) + '/../test_helper'
 require 'samples/right_triangle'
 
 # An example of testing a class in the lib folder.
 class TestRightTriangle < Test::Unit::TestCase
+
+
   def test_hypotenuse
   end
+
   def test_area
   end
+
 end
 EOF
-  end
-  
-private
-  def sources
-    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", "app_generators")),
-      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "cleaner_generators"))
-    ]
+
+    cleaned_contents = cleaner.clean_class(contents)
+    assert_equal(cleaned_contents, cleaned_file.strip)
   end
 end

data/test/{test_java_generator.rb → generators/test_java_generator.rb}

@@ -1,4 +1,5 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require File.join(File.dirname(__FILE__), "..", "test_generator_helper.rb")
+require 'languages'
 
 class TestJavaGenerator < Test::Unit::TestCase
   include RubiGen::GeneratorTestHelper

data/test/{test_ruby_generator.rb → generators/test_ruby_generator.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require File.join(File.dirname(__FILE__), "..", "test_generator_helper.rb")
 require 'fileutils'
 require 'languages'
 
@@ -27,15 +27,8 @@ class TestRubyGenerator < Test::Unit::TestCase
     assert_generated_file   "test/test_io.rb"
     assert_generated_file   "test/test_helper.rb"
     assert_generated_file   "script/clean_test_unit"
+    assert_generated_file   "script/filter_test_unit"
 
     run_generated_build_script("rake")
   end
-  
-  private
-  def sources
-    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", "app_generators")),
-      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "cleaner_generators"))
-    ]
-  end
-
 end

data/test/{test_languages.rb → lib/test_languages.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+require File.join(File.dirname(__FILE__), "..", "test_generator_helper.rb")
 require 'languages'
 
 class TestLanguages < Test::Unit::TestCase

data/test/test_generator_helper.rb

@@ -49,14 +49,12 @@ module RubiGen::GeneratorTestHelper
       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))]
+    [ RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "app_generators")),
+      RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__), "..", "cleaner_generators"))]
   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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bobbyno-shubox
 version: !ruby/object:Gem::Version 
-  version: "0.8"
+  version: 0.8.1
 platform: ruby
 authors: 
 - Bobby Norton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-22 00:00:00 -07:00
+date: 2009-09-26 00:00:00 -07:00
 default_executable: shubox
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 2.3.3
     version: 
-description: "Test-driven learning is a way to master a programming language by writing unit tests around its API's. shubox 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."
+description: "Test-driven learning is a way to master a programming language by writing unit tests around its API's. shubox 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.  shubox currently creates environments for Ruby and Java, but can easily be extended to any language that lends itself to unit testing. shubox is built on newgem, so extending the framework is as simple as creating new generator scripts.  After installing shubox and generating a testing environment, you'll start off with some passing tests that exercise parts of the language's API. Write new learning tests, naming each method with the intent of the lesson, then write  the code that makes a test pass.   Can you complete the lesson again from memory? If not, you may need to study the concept more closely  and implement the tests again. According to {a paper by Karpicke and Roediger}[http://psych.wustl.edu/memory/Roddy%20article%20PDF's/Karpicke_Roediger_2008_Science.pdf], \"repeated retrieval practice led to greater than 150% improvements in long-term retention than studying alone. ...Although educators and psychologists often consider testing a neutral process that merely assesses the  contents of memory, practicing retrieval during tests clearly produces more learning than additional  encoding or study once an item has been recalled.\"  shubox makes repeated testing easy by providing built-in test cleaners that delete your test implementations,  while keeping comments and test names to express the intent of the test."
 email: 
 - codeculturist@gmail.com
 executables: 
@@ -74,6 +74,7 @@ files:
 - cleaner_generators/test_unit_cleaner/USAGE
 - cleaner_generators/test_unit_cleaner/lib/test_unit_cleaner.rb
 - cleaner_generators/test_unit_cleaner/templates/clean_test_unit
+- cleaner_generators/test_unit_cleaner/templates/filter_test_unit
 - cleaner_generators/test_unit_cleaner/test_unit_cleaner_generator.rb
 - lib/languages.rb
 - lib/shubox.rb
@@ -81,12 +82,12 @@ files:
 - script/console
 - script/destroy
 - script/generate
+- test/cleaners/test_test_unit_cleaner.rb
+- test/generators/test_java_generator.rb
+- test/generators/test_ruby_generator.rb
+- test/lib/test_languages.rb
 - test/test_generator_helper.rb
 - test/test_helper.rb
-- test/test_java_generator.rb
-- test/test_languages.rb
-- test/test_ruby_generator.rb
-- test/test_test_unit_cleaner.rb
 has_rdoc: false
 homepage: http://github.com/bobbyno/shubox/tree/master
 licenses: 
@@ -116,9 +117,9 @@ 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
 test_files: 
+- test/cleaners/test_test_unit_cleaner.rb
+- test/generators/test_java_generator.rb
+- test/generators/test_ruby_generator.rb
+- test/lib/test_languages.rb
 - test/test_generator_helper.rb
 - test/test_helper.rb
-- test/test_java_generator.rb
-- test/test_languages.rb
-- test/test_ruby_generator.rb
-- test/test_test_unit_cleaner.rb