doubleshot 0.4.0-java → 0.5.0-java

data/Doubleshot

@@ -4,7 +4,7 @@ Doubleshot.new do |config|
 
   config.project = "doubleshot"
   config.group   = "org.sam.doubleshot"
-  config.version = "0.4.0"
+  config.version = "0.5.0"
 
   config.gem "minitest", ">= 3.0.1"
   config.gem "minitest-wscolor", ">= 0"

data/README.markdown

@@ -0,0 +1,136 @@
+#Doubleshot
+
+Latest test results:
+
+[![Build Status](https://secure.travis-ci.org/sam/doubleshot.png)](http://travis-ci.org/sam/doubleshot)
+
+##Overview
+
+Doubleshot is for Developers using JRuby.
+
+It lets you write Java and Ruby, perform Continuous Testing (meaning whenever a file changes, both Java and Ruby code is sandboxed and reloaded and the appropriate tests run), and package it all up as a Gem or JAR.
+
+It's a substitute for writing your own Maven tasks, declaring Maven Dependencies, managing Ruby dependencies with Bundler, and packaging everything up as a Gem with a Rakefile.
+
+Before Doubleshot you might have a ```Buildfile``` (using Buildr), ```Jarfile``` and ```Gemfile```. Or a ```pom.xml```, ```Gemfile``` and ```Rakefile```. However you slice it, you'd be using multiple tools, with different syntaxes and styles, that required you to run them in a specific order to actually get your project to run.
+
+Doubleshot simplifies all that. One Doubleshot file defines your Gem dependencies *and* your JAR dependencies, and declares how to either test or package it all up as a Gem or a JAR. Once you have a Doubleshot file (take a look at the [examples](https://github.com/sam/doubleshot/tree/master/examples) folder for some basics), then you have a few simple commands you can run to do what you need. Here's the output of ```doubleshot help```:
+
+```
+Usage: doubleshot COMMAND [ OPTIONS ]
+
+Summary: Command line tool for creating and managing doubleshot projects.
+
+  doubleshot init     # Generate a Doubleshot file for your project.
+
+  doubleshot test     # A test harness that watches files, builds your
+                      # source, and executes tests based on filename
+                      # conventions. The location of your tests is
+                      # determined by the 'config.source.tests'
+                      # attribute of your Doubleshot configuration.
+
+  doubleshot build    # Download all dependencies and compile sources so that you
+                      # can use the project directly without installation, such
+                      # as with IRB.
+                      #
+                      # NOTE: Packaging and testing have a dependency on this
+                      # command. You don't need to build as a prerequisite.
+
+  doubleshot gem      # Package your project as a Rubygem, bundling any
+                      # JAR dependencies and Java classes in with the distribution.
+
+  doubleshot jar      # Package your project as a JAR.
+
+  doubleshot install  # Install your project as a Rubygem.
+
+  doubleshot pom      # Generate a pom.xml based on your Doubleshot file.
+```
+
+To get a descriptive ```Doubleshot``` that comments all the options, just run ```doubleshot init``` in your project. It'll read existing ```myproject.gemspec``` and ```pom.xml``` files, and use them to generate a Doubleshot file. Take a look at the ```Doubleshot.example``` file in this project if you just want to read up now.
+
+**Pro-Tip:** Similar to a ```Gem::Specification```, a ```Doubleshot::Configuration``` provides a ```#to_ruby``` method, so that example was generated in IRB from the actual project configuration (the existing ```Doubleshot``` file in the project) like this:
+
+```ruby
+require "lib/doubleshot"
+Pathname("Doubleshot.example").open("w+") do |example|
+  example << Doubleshot::current.config.to_ruby
+end
+```
+
+##Requirements
+* Java 6 or later
+* Maven
+* JRuby 1.7 or later
+* Ruby 1.9 syntax only
+
+##Installation
+
+```
+gem install doubleshot
+```
+
+##Development
+
+Here's how to get Doubleshot running locally yourself. You'll need Java, Maven and JRuby (1.7.x or -head) installed. Then, clone the repo:
+
+```
+git clone git://github.com/sam/doubleshot.git
+```
+
+Doubleshot bootstraps its own build using a slightly different process than what is used for projects actually using it. It's a chicken and egg situation. Since Doubleshot depends on some Java code to resolve JAR dependencies, and we can't compile without our dependencies, we can't use Doubleshot's normal code to resolve its own JAR dependencies. That's why Doubleshot has a ```pom.xml``` (generated with the ```doubleshot pom``` command). We shell out to the Maven command line while bootstrapping the build.
+
+All that just to clarify the process. The only thing left you actually need to do at this point is run one of the  ```doubleshot ``` commands to package or test. The internal bootstrapping will take care of the rest:
+
+```
+bin/doubleshot test --ci
+```
+
+##Project Layout
+
+The *default* project using Doubleshot as its build-tool will have the following layout:
+
+```
+/
+ext/
+java/
+    Hello.java       # Java sources appear under the ext/java folder.
+lib/
+    world.rb         # Ruby sources go in the standard location.
+test/
+    helper.rb
+    hello_spec.rb    # specs match up to lib/**/*.rb or ext/java/**/*.java
+    world_spec.rb
+Doubleshot           # Your Doubleshot file replaces your project's gemspec
+                     # and JBundler's Jarfile.
+```
+
+Your tests should be executable and look something like this:
+
+```Ruby
+#!/usr/local/env jruby
+
+require_relative "helper.rb"
+
+java_import org.sam.doubleshot.example.Hello
+
+describe Hello do
+  it "must rock you" do
+    Hello.rock(:you).must_equal true
+  end
+end
+```
+
+...and ```helper.rb``` would look something like this:
+
+```Ruby
+require "doubleshot"
+require "minitest/autorun"
+...
+```
+
+##FAQ
+
+###Does Doubleshot support Ruby 1.8.x syntax?
+No.
+
+##Happy coding!

data/lib/doubleshot.rb

@@ -89,6 +89,27 @@ class Doubleshot
     load_gems! unless @config.runtime.gems.empty? && @config.development.gems.empty?
     load_jars! unless @config.runtime.jars.empty? && @config.development.jars.empty?
   end
+  
+  def build!(conditional = true)
+    if !conditional && @config.target.exist?
+      @config.target.rmtree
+    end
+    
+    return unless @config.source.java.exist?
+    
+    compiler = Doubleshot::Compiler.new(@config.source.java, @config.target)
+    
+    lockfile.jars.each do |jar|
+      compiler.classpath << jar.path
+    end
+    
+    if !conditional || compiler.pending?
+      puts "Compiling..."
+      compiler.build! true
+    else
+      puts "Conditional build: No source changes."
+    end
+  end
 
   def load_gems!
     if lockfile.gems.empty?

data/lib/doubleshot/commands/build.rb

@@ -35,10 +35,6 @@ class Doubleshot::CLI::Commands::Build < Doubleshot::CLI
     options = self.options.parse!(args)
     doubleshot = Doubleshot::current
 
-    if options.conditional && doubleshot.config.target.exist?
-      doubleshot.config.target.rmtree
-    end
-
     if doubleshot.config.project == "doubleshot"
       puts "Bootstrapping Doubleshot build with Maven..."
       doubleshot.bootstrap!
@@ -47,28 +43,7 @@ class Doubleshot::CLI::Commands::Build < Doubleshot::CLI
       doubleshot.setup!
     end
 
-    if doubleshot.config.source.java.exist?
-      compiler = Doubleshot::Compiler.new(doubleshot.config.source.java, doubleshot.config.target)
-
-      if options.classpath.empty?
-        doubleshot.classpath
-      else
-        options.classpath
-      end.each do |path|
-        compiler.classpath << path
-      end
-
-      puts "[INFO] Using #{compiler.classpath}"
-      puts
-
-      if compiler.pending? || !options.conditional
-        puts "Compiling..."
-        compiler.build!
-      else
-        puts "Conditional build: No source changes."
-      end
-    end
-
+    doubleshot.build! options.conditional
     return 0
   end
 end

data/lib/doubleshot/commands/gem.rb

@@ -34,7 +34,8 @@ class Doubleshot::CLI::Commands::Gem < Doubleshot::CLI
         return 1
       end
     else
-      Doubleshot::CLI::Commands::Build.start(args)
+      doubleshot.setup!
+      doubleshot.build! false
     end
 
     target = doubleshot.config.target

data/lib/doubleshot/commands/jar.rb

@@ -38,7 +38,8 @@ class Doubleshot::CLI::Commands::Jar < Doubleshot::CLI
         return 1
       end
     else
-      Doubleshot::CLI::Commands::Build.start(args)
+      doubleshot.setup!
+      doubleshot.build!
     end
 
     unless Pathname::glob(doubleshot.config.source.java + "**/*.java").empty?

data/lib/doubleshot/commands/test.rb

@@ -19,7 +19,6 @@ class Doubleshot::CLI::Commands::Test < Doubleshot::CLI
       options.ci_test = false
       options.on "--ci", "Run all tests, then exit. (No continuous listening for file changes.)" do
         options.ci_test = true
-        options.build = true
       end
 
       options.force_tests = false
@@ -106,13 +105,16 @@ class Doubleshot::CLI::Commands::Test < Doubleshot::CLI
 
   def run
     if @ci_test
+      if @config.project == "doubleshot"
+        Doubleshot::current.bootstrap!
+        Doubleshot::current.build! false
+      end
       exit_status = run_all_specs
       unless @force_tests
         @@pid_file.delete if @@pid_file.exist?
       end
       exit_status
     else
-      Doubleshot::CLI::Commands::Build.start([ "--conditional" ])
       # Output here just so you know when changes will be
       # picked up after you start the program.
       puts "Listening for changes..."
@@ -151,7 +153,8 @@ class Doubleshot::CLI::Commands::Test < Doubleshot::CLI
 
         if test && test.exist?
           if path.extname == ".java"
-            Doubleshot::CLI::Commands::Build.start([])
+            Doubleshot::current.setup!
+            Doubleshot::current.build! false
           end
 
           duration = Time::measure do
@@ -180,8 +183,6 @@ class Doubleshot::CLI::Commands::Test < Doubleshot::CLI
     duration = Time::measure do
       puts "\n --- Running all tests ---\n\n"
 
-      Doubleshot::CLI::Commands::Build.start([ "--conditional" ])
-
       script = <<-RUBY
         begin
           #{

data/lib/doubleshot/configuration.rb

@@ -35,11 +35,17 @@ class Doubleshot
     EOS
 
     GEM_REPOSITORY_MESSAGE = <<-EOS.margin
-    # TODO
+    # Add your custom ruby gem repositories here.
+    #
+    # Default is http://rubygems.org
+    # (defined in Resolver::GemResolver::DEFAULT_REPOSITORY)
     EOS
 
     MVN_REPOSITORY_MESSAGE = <<-EOS.margin
-    # TODO
+    # Add your custom Maven repositories here.
+    #
+    # Default is http://repo1.maven.org/maven2
+    # (defined in Resolver::JarResolver::DEFAULT_REPOSITORY)
     EOS
 
     SOURCE_RUBY_MESSAGE   = <<-EOS.margin
@@ -487,7 +493,6 @@ class Doubleshot
           spec.author         = #{spec.author.inspect}
           spec.email          = #{spec.email.inspect}
           spec.license        = #{spec.license.inspect}
-          spec.executables    = #{spec.executables.inspect}
         end
       EOS
     end

data/lib/doubleshot/setup.rb

@@ -1,3 +1,5 @@
 require_relative "../doubleshot"
 
-Doubleshot::current.setup!
+doubleshot = Doubleshot::current
+doubleshot.setup!
+doubleshot.build!

data/test/configuration_spec.rb

@@ -362,7 +362,6 @@ describe Doubleshot::Configuration do
             spec.author         = "Sam Smoot"
             spec.email          = "ssmoot@gmail.com"
             spec.license        = "MIT-LICENSE"
-            spec.executables    = ["doubleshot"]
           end
         EOS
       end

metadata

@@ -2,14 +2,14 @@
 name: doubleshot
 version: !ruby/object:Gem::Version
   prerelease:
-  version: 0.4.0
+  version: 0.5.0
 platform: java
 authors:
 - Sam Smoot
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-11-13 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -145,7 +145,7 @@ files:
 - !binary |-
   UkVBRE1FLU9MRC50ZXh0aWxl
 - !binary |-
-  UkVBRE1FLnRleHRpbGU=
+  UkVBRE1FLm1hcmtkb3du
 - lib/doubleshot/cli/options.rb
 - lib/doubleshot/cli.rb
 - lib/doubleshot/commands/build.rb

data/README.textile

@@ -1,68 +0,0 @@
-h1. Doubleshot
-
-Latest test results:
-
-!https://secure.travis-ci.org/sam/doubleshot.png(Build Status)!:http://travis-ci.org/sam/doubleshot
-
-h2. Overview
-
-Doubleshot is for Developers using JRuby.
-
-It let's you write Java and Ruby, perform Continuous Testing (meaning whenever a file changes, both Java and Ruby code is sandboxed and reloaded and the appropriate tests run), and package it all up as a Gem or JAR.
-
-It's a substitute for writing your own Maven tasks, declaring Maven Dependencies, having Ruby dependencies managed by Bundler, and a Rakefile for packaging everything up as a Gem.
-
-Before Doubleshot you might have a @Buildfile@ (using Buildr), @Jarfile@ and @Gemfile@. Or a @pom.xml@, @Gemfile@ and @Rakefile@. However you slice it, you'd be using multiple tools, with different syntaxes and styles, that required you to run them in a specific order to actually get your project to run.
-
-Doubleshot simplifies all that. You have one Doubleshot file that defines your Gem dependencies, your JAR dependencies, and declares how to either test or package it all up as a Gem or a JAR. Once you have a Doubleshot file (take a look at the examples folder for some basics), then you have a few simple commands you can run to do what you need. Here's the output of @doubleshot help@:
-
-bc.. Usage: doubleshot COMMAND [ OPTIONS ]
-
-Summary: Command line tool for creating and managing doubleshot projects.
-
-  doubleshot init     # Generate a Doubleshot file for your project.
-
-  doubleshot test     # A test harness that watches files, builds your
-                      # source, and executes tests based on filename
-                      # conventions. The location of your tests is
-                      # determined by the 'config.source.tests'
-                      # attribute of your Doubleshot configuration.
-
-  doubleshot build    # Download all dependencies and compile sources so that you
-                      # can use the project directly without installation, such
-                      # as with IRB.
-                      #
-                      # NOTE: Packaging and testing have a dependency on this
-                      # command. You don't need to build as a prerequisite.
-
-  doubleshot gem      # Package your project as a Rubygem, bundling any
-                      # JAR dependencies and Java classes in with the distribution.
-
-  doubleshot jar      # Package your project as a JAR.
-
-  doubleshot install  # Install your project as a Rubygem.
-
-  doubleshot pom      # Generate a pom.xml based on your Doubleshot file.
-
-p. To get a descriptive @Doubleshot@ that comments all the options, just run @doubleshot init@ in your project. It'll read existing @myproject.gemspec@ and @pom.xml@ files, and use them to generate a Doubleshot file. Take a look at the @Doubleshot.example@ file in this project if you just want to read up now.
-
-Pro-Tip: Similarly to a @Gem::Specification@, a @Doubleshot::Configuration@ provides a @#to_ruby@ method, so that example was generated in IRB from the actual project configuration (the existing @Doubleshot@ file in the project) like this:
-
-bc.. require "lib/doubleshot"
-Pathname("Doubleshot.example").open("w+") do |example|
-  example << Doubleshot::current.config.to_ruby
-end
-
-h2. Development
-
-Here's how to get Doubleshot running locally yourself. You'll need Java, Maven and JRuby (1.7.x or -head) installed. Then, clone the repo:
-
-bc. git clone git://github.com/sam/doubleshot.git
-
-Doubleshot bootstraps it's own build using a slightly different process than used for projects actually using it. It's a chicken and egg situation. Since Doubleshot depends on some Java code to resolve JAR dependencies, and we can't compile without our dependencies, we can't use Doubleshot's normal code to resolve it's own JAR dependencies. That's why Doubleshot has a @pom.xml@ (generated with the @doubleshot pom@ command). We shell out to the Maven command line while bootstrapping the build.
-
-All that just to clarify the process. The only thing left you actually need to do at this point is run one of the @doubleshot@ commands to package or test. The internal bootstrapping will take care of the rest:
-
-bc. bin/doubleshot test --ci
-
-Happy coding!