guard-java 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzdmZTEwNzgxN2I1ZmNiZGZmMTQ1NzJhZmYyNjE0ZmJhOGZkNzI0NA==
+  data.tar.gz: !binary |-
+    NDEwOWE5MzA4MTM5NjQ1YzVkYTdmMjM0ZTk5MTIxNWE3NTNiZWNlYw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTRjMDgwOWVmZGE4N2QwMTE2MWY5NjgyNmFiMmI1NGQ1NzY3NzhkODJmZWVh
+    ZWMxN2I4ZDdlZmVmNjFkYjdiZmZjNjhkZmM5ZjcwZjU4MTQ5NmM2YTExMTQw
+    NGFlZjY4OGJlMmU2NDVkNGNlZTk2Y2QxNjQ1NjE2YWVmNWEzYTg=
+  data.tar.gz: !binary |-
+    NWI1YmQxYWE3ZmIyNDE4YWUxZWU3MjQ5OGRlNDE2NjdlMjNiYzQ5OWVhNzlk
+    MGNmNGI1NTI2YzNlZGVmNmZiMjc5Mzg0ZjRmOWU0ZGQzYjZjMTMzNThlZDVk
+    ZmFiZTk4Njg2M2I5ZjNhMzNiOTBhNjI0Yjk0Yjc4MjZjODRiMjA=

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Tony Heupel
+
+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/README.md

@@ -0,0 +1,131 @@
+# Guard::Java
+
+This guard allows you to build and test your Java code automatically when files are altered.
+
+
+## Install
+
+Install the gem with:
+
+    gem install guard-java
+
+Or add it to your Gemfile:
+
+    gem 'guard-java'
+
+And then add a basic setup to your Guardfile:
+
+    guard init java
+
+
+## Usage
+
+If you can do something in your shell, or in Ant, you can do it when a file changes
+with guard-java.
+
+You simply provide paths to watch, including how to map a class to it's unit-test class name
+and some other options.
+
+
+### Examples
+
+``` ruby
+require 'guard/java_translator'
+
+guard :java,  :project_name   => 'My Java Project',
+              :all_after_pass => false,                   # run the all_cli command if the specific test class passes (true/false)
+              :focused_cli    => 'ant clean debug',       # (required) command-line to run before running a specific test class
+              :all_cli        => 'ant package-and-test',  # (required) command-line to run that executes the "build and run all tests" concept
+              :classpath      => './bin/classes.jar:./libs/*:/usr/share/java/junit.jar' # (required) don't forget junit and your own jars here
+            # :all_on_start   => true                     # run all on startup of guard
+            # :test_runner_class => 'org.junit.runner.JUnitCore' # just in case you're using junit 3 or something other than 4
+  do
+
+  watch (%r{^tests/src/*/(.+)\.java$}) { |m| ::Guard::JavaTranslator.filename_to_classname(m[0]) }  # test file changes
+
+  watch(%r{^src/*/(.+)\.java$}) { |m|
+    test_filename = "tests/src/#{m[1]}Test.java"
+    ::Guard::JavaTranslator.filename_to_classname(test_filename)
+  } # when source files change, run the test for that file
+
+  # ignore(path) will ignore files that change automatically, such as generated code files
+end
+```
+
+
+### Using Guard
+
+From the project's root directory, simply run:
+
+```shell
+$ guard
+20:28:01 - INFO - Guard uses GNTP to send notifications.
+20:28:01 - INFO - Guard uses Tmux to send notifications.
+20:28:01 - INFO - Guard uses TerminalTitle to send notifications.
+20:28:01 - INFO - Guard::Java is running
+20:28:01 - INFO - Guard is now watching at '/Users/tchype/Projects/some_java_project'
+[1] guard(main)>
+```
+
+It tells you what notification methods it will use to tell you when it has detected changes,
+when it is building/testing, and whether those things have succeeded or failed.  In the example 
+above, I am running Growl as my system notifier and Tmux as my Terminal Multiplexer within 
+Mac OSX's Terminal program.
+
+You can see that it detected those things and is using GNTP to send Growl notifications
+(popups with detailed messages), Tmux color coding (Yellow for building/testing, Red for 
+failures, and Green for success), as well as updating the Terminal window/tab's title
+when guard detects a change.
+
+
+
+### Other Useful Tips
+#### Working with Android
+The template Guardfile you get when you run ```guard init``` has some samples in it.  You will want to include your Android SDK jar
+file in the ```classpath``` argument.  You can write a ruby function that reads it from a local or project
+properites file that you call when setting your classpath.  For example:
+
+```ruby
+require 'guard/java_translator'
+
+def android_sdk_dir
+  sdk_dir = ''
+  %w{project.properties local.properties}.each do |prop_file|
+    File.open(File.join(File.dirname(__FILE__), prop_file)).each do |line|
+      sdk_dir = line[8..-1] if line[0..7] == 'sdk.dir='
+    end
+  end
+
+  sdk_dir.strip
+end
+
+guard :java,  :project_name   => 'Search SDK',
+              :all_on_start   => false,
+              :all_after_pass => false,
+              :focused_cli    => 'ant guard-debug',
+              :all_cli        => 'ant clean debug',
+              :classpath      => "#{android_sdk_dir}:./bin/classes.jar:./libs/*:/usr/share/java/junit.jar" do
+
+  ignore(%r{^src/com/infospace/some_project/BuildTimeUpdatedFile.java}) # Build-time code-gen
+
+  watch (%r{^tests/src/com/infospace/some_project/*/(.+)\.java$})  { |m|
+    ::Guard::JavaTranslator.filename_to_classname(m[0])
+  } # Test file changes
+
+  watch(%r{^src/com/infospace/some_project/*/(.+)\.java$}) { |m|
+    test_filename = "tests/src/com/infospace/some_project/#{m[1]}Test.java"
+    ::Guard::JavaTranslator.filename_to_classname(test_filename)
+  } # when source files change, run the test for that file
+end
+```
+
+#### Latency
+In the case where many files are changing close together (e.g., saving a test file and saving the class under test), you can tell
+guard to wait a certain number of seconds when it detects a file change before triggering a test cycle using the
+```--latency``` (or ```-l```) command line option.  For example, to wait 10 seconds after a change is detected for other changes
+to also accumulate:
+
+
+```shell
+$ guard -l 10
+```

data/lib/guard/java/templates/Guardfile

@@ -0,0 +1,18 @@
+guard :java,  :project_name   => 'My Java Project',
+              :all_after_pass => false,                   # run the all_cli command if the specific test class passes (true/false)
+              :focused_cli    => 'ant clean debug',       # (required) command-line to run before running a specific test class
+              :all_cli        => 'ant package-and-test',  # (required) command-line to run that executes the "build and run all tests" concept
+              :classpath      => './bin/classes.jar:./libs/*:/usr/share/java/junit.jar' # (required) don't forget junit and your own jars here
+            # :all_on_start   => true                     # run all on startup of guard
+            # test_runner_class => 'org.junit.runner.JUnitCore' # just in case you're using junit 3 or something other than 4
+  do
+
+  watch (%r{^src/test/java/*/(.+)\.java$}) { |m| ::Guard::JavaTranslator.filename_to_classname(m[0], 'src/test/java/') }  # test file changes
+
+  watch(%r{^src/main/java/*/(.+)\.java$}) { |m|
+     test_filename = "tests/src/#{m[1]}Test.java"
+     ::Guard::JavaTranslator.filename_to_classname(test_filename)
+   } # when source files change, run the test for that file
+
+  # ignore(path) will ignore files that change automatically, such as generated code filesjt
+end

data/lib/guard/java/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module JavaVersion
+    VERSION = "0.0.3"
+  end
+end

data/lib/guard/java.rb

@@ -0,0 +1,89 @@
+require 'guard/guard'
+
+module ::Guard
+  class Java < ::Guard::Guard
+    def initialize(watchers=[], options={})
+      super
+      @options = {
+        :all_after_pass     => true,
+        :all_on_start       => true,
+        :test_runner_class  => 'org.junit.runner.JUnitCore',
+        :project_name       => 'Java Project',
+        :focused_cli        => nil,
+        :all_cli            => nil,
+        :classpath          => '.'
+      }.merge(options)
+    end
+
+    def start
+      UI.info 'Guard::Java is running'
+      raise ArgumentError, ":focused_cli and :all_cli options must be set" if @options[:focused_cli].nil? || @options[:all_cli].nil?
+
+      run_all if @options[:all_on_start]
+    end
+
+    def run_all
+      project_name = @options[:project_name]
+      notify project_name, "Build and run all", :pending
+      result = do_shell(all_command)
+      result_description = "#{project_name} build results"
+      notify result_description, "Build #{result.to_s.capitalize}", result # Notify of success or failure
+    end
+
+    def run_on_changes(classes)
+      run_focused_tests(classes)
+    end
+
+    def stop
+    end
+
+    def run_focused_tests(classes)
+      project_name = @options[:project_name]
+      klass = classes[0]
+
+      notify "Running tests in #{klass}", "#{project_name} file change detected", :pending  # notify any interested listeners
+      result = do_shell(focused_command)
+      result = run_test_class(klass) unless result == :failed
+      result_description = "#{project_name}: test run for #{klass}"
+
+      notify result_description, "Build #{result.to_s.capitalize}", result # Notify of success or failure
+
+      if result == :success && @options[:all_after_pass]
+        run_all
+      end
+      nil
+    end
+
+    def focused_command
+      @options[:focused_cli]
+    end
+
+    def all_command
+      @options[:all_cli]
+    end
+
+    def notify(msg, title='', image=nil)
+      Notifier.notify(msg, title: title, image: image)
+    end
+
+    def do_shell(command)
+      IO.popen(command) do |out|
+        until out.eof?
+          puts out.gets
+        end
+      end
+
+      code = $?  # Get the status code of the last-finished process
+      (code == 0) ? :success : :failed
+    end
+
+
+    def run_test_class(klass)
+      test_command = "java -cp #{options[:classpath]} #{options[:test_runner_class]} #{klass}"
+      puts test_command
+      do_shell test_command
+    end
+  end
+
+end
+

data/lib/guard/java_translator.rb

@@ -0,0 +1,12 @@
+module ::Guard
+  class JavaTranslator
+    class << self
+      def filename_to_classname(filename_path, src_root_path='src/')
+        klass = filename_path.gsub(src_root_path, '').gsub('/', '.').gsub('.java', '')
+        klass = klass[1..-1] if klass[0] == '.'
+        klass
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: guard-java
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Tony C. Heupel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: Guard::Java automatically run your unit tests when you save files (much
+  like Eclipse's Build on Save
+email:
+- tony@heupel.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/guard/java/templates/Guardfile
+- lib/guard/java/version.rb
+- lib/guard/java.rb
+- lib/guard/java_translator.rb
+- LICENSE
+- README.md
+homepage: http://github.com/infospace/guard-java
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: guard-rspec
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Guard gem for Java
+test_files: []