shubox 0.9

data/History.txt

@@ -0,0 +1,57 @@
+== 0.9	2009-10-22
+
+* 1 major enhancement:
+	* added clojure environment based on Stu Halloway's clojure_bowling
+
+== 0.8.2 2009-09-26
+
+* 1 minor enhancements:
+	* test_unit_cleaner now also cleans ruby_koans.
+
+== 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:
+	* clean script now included in generated shubox to reset tests in ruby. 
+	* Thanks to bendyworks for the original concept in his patch.
+	* cleaners organized as generators to simplify new cleaner creation.
+	* cleaners can operate on directories or individual files.
+	
+
+== 0.7 2009-08-26
+
+* Project rename:
+  * tbox -> shubox: Shubox helps you move more quickly from Shu to Ha and Ri.
+  * Thanks to Alistair Cockburn @ Agile 2009 for this one.
+
+
+== 0.6 2009-06-24
+
+* 1 major enhancement:
+  * Added ability to generate Java sandboxes with Ant, JUnit, and IntelliJ support.
+
+
+== 0.5.2 2009-06-18
+
+* 1 minor enhancement:
+  * Changed newgem from dev to runtime dependency.
+
+
+== 0.5.1 2009-06-15
+
+* 1 minor enhancement:
+  * Refactoring gemspec to work with github.
+
+
+== 0.5.0 2009-06-15
+
+* 1 major enhancement:
+  * Refactored to use newgem / rubigen file generation.

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Bobby Norton
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,57 @@
+History.txt
+MIT-LICENSE
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+app_generators/clojure/USAGE
+app_generators/clojure/clojure_generator.rb
+app_generators/clojure/templates/README.rdoc
+app_generators/clojure/templates/bin/repl.sh
+app_generators/clojure/templates/bin/runtests.sh
+app_generators/clojure/templates/lib/clojure-contrib.jar
+app_generators/clojure/templates/lib/clojure.jar
+app_generators/clojure/templates/lib/jline-0.9.94.jar
+app_generators/clojure/templates/project.iml
+app_generators/clojure/templates/project.ipr
+app_generators/clojure/templates/src/repl.clj
+app_generators/clojure/templates/test/core/about_clojure_testing.clj
+app_generators/clojure/templates/test/core/about_forms.clj
+app_generators/clojure/templates/test/tests.clj
+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/shubox.rb
+app_generators/ruby/templates/test_helper.rb
+app_generators/ruby/templates/test_io.rb
+app_generators/ruby/templates/test_right_triangle.rb
+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
+lib/shubox_app_generator.rb
+script/console
+script/destroy
+script/generate
+test/cleaners/test_test_unit_cleaner.rb
+test/generators/test_clojure_generator.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

data/PostInstall.txt

@@ -0,0 +1,6 @@
+
+For more information on shubox, see http://github.com/bobbyno/shubox/tree/master
+
+
+
+

data/README.rdoc

@@ -0,0 +1,128 @@
+= shubox - A framework to create sandboxes for test-driven learning
+
+http://github.com/bobbyno/shubox/tree/master
+
+More on Test-Driven Learning: http://www.bobbynorton.com/?p=36
+
+== DESCRIPTION
+
+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.
+
+== TEST-DRIVEN LEARNING
+
+Test-driven learning is a way to master a programming language by writing unit tests around its API's.
+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. 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.
+
+== INSTALL
+
+The <code>shubox</code> application is distributed as a RubyGem and is available immediately after installation.
+
+<code>$ gem sources -a http:http://gems.github.com</code>
+
+<code>$ sudo gem install bobbyno-shubox</code>
+
+Alternately, download the gem and install manually from github.
+
+== RUBY USAGE
+
+Ruby is the default language option in shubox:
+
+<code>$ shubox /tmp/learn_ruby</code>
+
+<code>$ cd /tmp/learn_ruby</code>
+
+<code>$ rake</code>
+
+To clean all tests in your project: 
+
+<code>$ script/clean_test_unit .</code>
+
+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
+
+shubox supports Java:
+
+<code>$ shubox -l=java /tmp/LearnJava</code>
+
+<code>$ cd /tmp/LearnJava</code>
+
+<code>$ ant -f build/build.xml</code>
+
+The Java command will also generate a <project name>.ipr file to allow the project to easily be
+opened in IntelliJ 8.
+
+shubox does not currently include a JUnit cleaner script. Patches welcome. ;-)
+
+== CLOJURE USAGE
+
+shubox also supports Clojure: 
+
+<code>$ shubox -l=clojure /tmp/learn_clojure</code>
+
+<code>$ cd /tmp/learn_clojure</code>
+
+<code>$ bin/runtests.sh</code>
+
+The Clojure command will also generate a <project name>.ipr file to allow the project to easily be
+opened in IntelliJ 8.
+
+shubox does not currently include a clojure test cleaner script. Patches welcome. ;-)
+
+== APPLICATION ARCHITECTURE
+
+shubox is organized as a set of generators, as in newgem and RubiGen. 
+
+app_generators are where we define the basic environment for one of our supported languages.
+
+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. 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.
+
+== REQUIREMENTS
+
+* newgem
+
+== CONTRIBUTORS
+
+Initial concept - Bobby Norton
+
+bendyworks for {Test::Unit cleaner patch}[http://github.com/bendyworks/shubox]
+
+== THANKS!
+
+{DRW Trading Group}[http://www.drwtrading.com] for time and feedback
+
+Test-Driven Learning Attendees at {SCNA 2009}[http://scna.softwarecraftsmanship.org/schedule#bobby_norton]
+
+Dr. Nic Williams for newgem and rubigen: {RubyConf 2007 Presentation}[http://rubyconf2007.confreaks.com/d3t1p1_rubigen.html]
+
+Jim Weirich and EdgeCase for {ruby_koans}[http://github.com/edgecase/ruby_koans]
+
+Stu Halloway for the clojure project structure in {clojure_bowling}[http://github.com/stuarthalloway/clojure-bowling/]
+
+
+

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/shubox'
+
+Hoe.plugin :newgem
+
+# require 'rubygems' unless ENV['NO_RUBYGEMS']
+# %w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+# require File.dirname(__FILE__) + '/lib/shubox'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'shubox' do |p|
+  p.developer('Bobby Norton', 'codeculturist@gmail.com')
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name = p.name # TODO this is default value
+  p.extra_deps = [['newgem', "= #{::Newgem::VERSION}"]]
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+  p.readme_file          = 'README.rdoc'
+  p.extra_rdoc_files     = ['README.rdoc']
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]
+
+desc "Create the gem and install it"
+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
+  manifest = IO.readlines("Manifest.txt")
+  clean = manifest.reject {|item| item =~ /.git/ }
+  File.open("Manifest.txt", mode_string="w" ) {|file| file.puts(clean)}
+end
+
+task :clean do
+  rm_f("shubox.gemspec")
+  rm_rf("pkg")
+end
+
+task :uninstall do
+  rm_rf("/tmp/clojure_test")
+  rm_rf("/tmp/JavaTest")
+  rm_rf("/tmp/ruby_test")
+  sh "sudo gem uninstall shubox"
+end
+
+task :uat do
+  sh "shubox -l=clojure /tmp/clojure_test"
+  sh "shubox -l=java /tmp/JavaTest"
+  sh "shubox /tmp/ruby_test"
+end

data/app_generators/clojure/USAGE

@@ -0,0 +1,15 @@
+Description:
+
+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
+to run all tests.
+
+Usage:
+
+ $ shubox -l=clojure /tmp/learn_clojure
+ $ cd /tmp/learn_clojure
+ $ bin/runtests.sh
+
+If you have IntelliJ, install the La Clojure plugin, then open the IPR file to get started with adding 
+your learning tests. If you have a different IDE, follow the instructions to import your application as 
+existing source.

data/app_generators/clojure/clojure_generator.rb

@@ -0,0 +1,46 @@
+require 'shubox_app_generator'
+
+class ClojureGenerator < ShuboxAppGenerator
+
+  def manifest
+    script_options     = { :chmod => 0755 }
+    
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # root
+      m.template("project.ipr", "#{@name}.ipr")
+      m.file("project.iml", "#{@name}.iml")
+      m.template("README.rdoc", "README.rdoc")
+
+      # bin
+      m.directory "bin"
+      m.file_copy_each %w(repl.sh runtests.sh), "bin", script_options
+
+      # lib
+      m.directory "lib"
+      m.file_copy_each  %w(clojure-contrib.jar clojure.jar jline-0.9.94.jar), "lib"
+
+      # src
+      m.directory "src"
+      m.file("src/repl.clj", "src/repl.clj")
+
+      # test
+      m.directory "test/core"
+      m.file("test/core/about_clojure_testing.clj", "test/core/about_clojure_testing.clj")
+      m.file("test/core/about_forms.clj", "test/core/about_forms.clj")
+      m.file("test/tests.clj", "test/tests.clj")
+    end
+  end
+
+  protected
+    # Installation skeleton.
+    BASEDIRS = %w(
+      build
+      lib
+      src
+      test
+    )
+end

data/app_generators/clojure/templates/README.rdoc

@@ -0,0 +1,29 @@
+= Clojure Shubox
+
+Generated from http://www.github.com/bobbyno/shubox
+
+== Running via command line
+
+REPL: <code>bin/repl.sh</code>
+
+Tests: <code>bin/runtests.sh</code>
+
+== Running in IntelliJ
+
+* Install the La Clojure plugin
+* Create a run configuration for tests.clj
+* Check "Run script in REPL" and uncheck "Display settings before launching"
+* Run tests.clj - output displays in the run tab
+* Enter <code>(. System exit 0)</code> or hit the stop button if the REPL doesn't exit.
+
+== Credits
+
+Project structure based on Stuart Halloway's clojure-bowling: http://github.com/stuarthalloway/clojure-bowling/
+
+Note that this requires a post-1.0 version of Clojure and contrib to use the new 'are' syntax.
+
+Required JARs are in lib, and there are scripts to run a REPL or the tests in bin.
+
+== Author
+
+Bobby Norton

data/app_generators/clojure/templates/bin/repl.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+java -cp src:test:lib/jline-0.9.94.jar:lib/clojure.jar:lib/clojure-contrib.jar jline.ConsoleRunner clojure.main -i src/repl.clj -r

data/app_generators/clojure/templates/bin/runtests.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+java -Xmx1G -cp test:src:lib/clojure.jar:lib/clojure-contrib.jar:lib/hsqldb.jar:lib/ant.jar:lib/ant-launcher.jar clojure.lang.Script test/tests.clj