guard-jruby-minitest 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e4d62eb23a8e2272ecb8695cfe652894a67e542
-  data.tar.gz: c40df619c00bb170bdb008f355feaa72918219ed
+  metadata.gz: 4cc9d48d0d1386bd4ca79fb4f9e1ca82b8a551ae
+  data.tar.gz: 00b4602d66109f96118c237bfab966c177d3c7db
 SHA512:
-  metadata.gz: 055e04529697f8339f7f25a2a4f918da856b0d29397ec4368dff821c9ad95869fab78ff7f8c5ef088bdf00baa63e10b5c1769d3471c82c7c54a5e15317b92658
-  data.tar.gz: 920ce80fc8fbab97f380489529694052dac2a99c77abc0b2bc543bf8f8c6af3827b01d10d58a24b765b30ac8a9c380cff3c5d9cc848475c019641a60d73d26c7
+  metadata.gz: 2aaa340feb51fe6aef6c0a610e0f9ed539b4730398ca673290502301af9534110d24ddf278c280324fecd85fce63b1b5ddba5896f7dc21d2c760da70b6512b75
+  data.tar.gz: cb6588dcd37f5c058b218acb972a52159f9491accac00a67bb8b884017c32e944ae738f1021d59ab606f0a83b2c08443c750308e53c540b9ebea6abb8af46f75

data/README.md

@@ -1,6 +1,25 @@
-# Guard::Jruby::Minitest
+# guard-jruby-minitest
 
-TODO: Write a gem description
+Guard has been a great productivity booster when used in a TDD environment. However, JRuby makes TDD harder, if not impossible. It is due to the fact that, by default, every `run_on_modification` or `run_on_change` starts a new process, which incurs [the long JVM start time]. Some approaches have been attempted, such as [Drip] or [Nailgun].
+
+This guard extension allows you to run all of your tests on JRuby without the initial start up cost every time. It loads all of your application files in advance, and reloads any that change. That way, when you run test, the JVM is already running, and your files have already been required.
+
+Most of the configuration options available to `guard-minitest` work with this extension too.
+
+This gem should work with Rails as well as Rack applications.
+
+## Reloaders
+
+Currently, `guard` runs the following reloaders when part of application is changed:
+
+* `AppPathsReloader`: Reloads the application (non-test) code.
+* `FactoryGirlReloader`: Reloads the `factory_girl` factories.
+* `RailsReloader`: Reloads the entire application if the application is a Rails app.
+* `TestPathsReloader`: Reloads the tests. This is the most tricky part because of the way `minitest` run tests.
+
+## Caveats
+
+Reloading is not always clean and sometimes could lead to unpredictable results. In that case, it is best to exit and rerun `guard`.
 
 ## Installation
 
@@ -18,12 +37,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create or add to the `Guardfile` by running the following command in your application directory:
+
+    $ bundle exec guard init jruby-minitest
+
+Then run `guard` like this:
+
+    $ bundle exec guard
+
+The first time the test runs in Guard, it will take some time. However, after that, it should be quite fast.
+
+## Thank You
+
+Many thanks to [guard-jruby-rspec] for the inspiration.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/guard-jruby-minitest/fork )
+1. Fork it ( https://github.com/jackxxu/guard-jruby-minitest/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+[the long JVM start time]: https://github.com/jruby/jruby/wiki/Improving-startup-time
+[Drip]: https://github.com/ninjudd/drip/wiki/JRuby
+[Nailgun]: https://github.com/jruby/jruby/wiki/JRubyWithNailgun
+[guard-jruby-rspec]: https://github.com/jkutner/guard-jruby-rspec

data/guard-jruby-minitest.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'guard/jruby/minitest/version'
+require 'guard/jruby-minitest/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "guard-jruby-minitest"
-  spec.version       = Guard::Jruby::Minitest::VERSION
+  spec.version       = Guard::JRubyMinitestVersion::VERSION
   spec.authors       = ["Jack Xu"]
   spec.email         = ["jackxxu@gmail.com"]
   spec.summary       = %q{Guard gem for JRuby Minitest}
@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'guard', '>= 0.10.0'
-  spec.add_dependency 'guard-minitest', '>= 0.7.3'
+  spec.add_dependency 'guard-minitest', '>= 2.3.0'
+  spec.add_dependency 'ruby_parser', '>= 3.0'
+  spec.add_dependency 'pry', '~> 0.9.12'
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"

data/lib/guard-jruby-minitest.rb

@@ -0,0 +1 @@
+require_relative 'guard/jruby-minitest'

data/lib/guard/jruby-minitest.rb

@@ -0,0 +1,68 @@
+require 'guard/guard'
+require 'guard/minitest'
+require_relative 'jruby-minitest/version'
+
+module Guard
+  class JRubyMinitest < ::Guard::Minitest
+    require_relative 'jruby-minitest/containment'
+    require_relative 'jruby-minitest/runner'
+    require_relative 'jruby-minitest/reloaders/test_paths'
+    require_relative 'jruby-minitest/reloaders/rails_reloader'
+    require_relative 'jruby-minitest/reloaders/factory_girl_reloader'
+    require_relative 'jruby-minitest/reloaders/app_paths_reloader'
+    require_relative 'jruby-minitest/reloaders/test_paths_reloader'
+
+    unless Utils.minitest_version_gte_5?
+      require_relative 'jruby-minitest/runners/old_runner'
+    end
+
+    def initialize(options = {})
+      @custom_watchers = options[:watchers]
+      general_watchers = [Watcher.new(%r{^(.+)\.rb$}), Watcher.new(%r{^(.+)\.(erb|haml)$})]
+      super(options.merge(watchers: general_watchers))
+      TestPaths.test_folders = options[:test_folders]
+      super
+    end
+
+    def run_all
+      unload_previous_tests
+      super
+    end
+
+    %w(run_on_modifications run_on_additions run_on_removals).each do |method_name|
+      define_method method_name do |raw_paths = []|
+        unload_previous_tests
+        reload_application(raw_paths)
+        super matched_paths(raw_paths)
+      end
+    end
+
+    private
+
+      def matched_paths(raw_paths)
+        [].tap do |paths|
+          raw_paths.each do |p|
+            @custom_watchers.each do |w|
+              if (m = w.match(p))
+                paths << (w.action.nil? ? p : w.call_action(m))
+              end
+            end
+          end
+        end
+      end
+
+      def reload_application(paths)
+        [RailsReloader, AppPathsReloader, FactoryGirlReloader].each do |reloader|
+          reloader.run(paths)
+        end
+      end
+
+      def unload_previous_tests
+        if Utils.minitest_version_gte_5?
+          ::Minitest::Test.reset
+        else
+          ::MiniTest::Unit::TestCase.reset
+        end
+      end
+  end
+end

data/lib/guard/jruby-minitest/containment.rb

@@ -0,0 +1,26 @@
+module Guard
+  class JRubyMinitest
+    class Containment
+
+      def initialize(options = {})
+        @error_handler = options.fetch(:error_handler, method(:output_as_guard_error))
+      end
+
+      def protect
+        yield
+      rescue Exception => e
+        error_handler.call e
+        throw :task_has_failed
+      end
+
+      private
+
+      attr_reader :error_handler
+
+      def output_as_guard_error(exception)
+        UI.error $!.message
+        UI.error $!.backtrace.join "\n"
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/reloaders/app_paths_reloader.rb

@@ -0,0 +1,16 @@
+module Guard
+  class JRubyMinitest
+    class AppPathsReloader
+      extend TestPaths
+
+      def self.run(paths)
+
+        paths.select{|p| !in_test_folders?(p)}.each do |p|
+          if File.exists?(p)
+            Containment.new.protect { load p }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/reloaders/factory_girl_reloader.rb

@@ -0,0 +1,11 @@
+module Guard
+  class JRubyMinitest
+    class FactoryGirlReloader
+      def self.run(*)
+        if defined? ::FactoryGirl
+          Containment.new.protect { FactoryGirl.reload }
+        end
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/reloaders/rails_reloader.rb

@@ -0,0 +1,14 @@
+module Guard
+  class JRubyMinitest
+    class RailsReloader
+      def self.run(*)
+        if defined? ::ActionDispatch::Reloader
+          Containment.new.protect do
+            ActionDispatch::Reloader.cleanup!
+            ActionDispatch::Reloader.prepare!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/reloaders/test_paths.rb

@@ -0,0 +1,17 @@
+module Guard
+  class JRubyMinitest
+    module TestPaths
+      extend self
+
+      attr_writer :test_folders
+
+      def test_folders
+        @test_folders ||= ['test', 'spec']
+      end
+
+      def in_test_folders?(path)
+        test_folders.any? {|folder| path.start_with?("#{folder}/")}
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/reloaders/test_paths_reloader.rb

@@ -0,0 +1,27 @@
+require 'ruby_parser'
+
+module Guard
+  class JRubyMinitest
+    class TestPathsReloader
+      extend TestPaths
+
+      def self.run(paths)
+        paths.select{|p| in_test_folders?(p)}.each do |p|
+          if File.exists?(p)
+            Containment.new.protect { unload p; load p }
+          end
+        end
+      end
+
+      def self.unload(path)
+        code = RubyParser.new.parse(IO.read(path))
+        test_classes = []
+        test_classes << code[1] if code[0] == :class
+        code.each_of_type(:class) {|c| test_classes << c[1] if c[1].is_a?(Symbol) }
+        test_classes.each do |c|
+          Object.send(:remove_const, c) if Object.const_defined?(c)
+        end
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/runner.rb

@@ -0,0 +1,36 @@
+require 'minitest/unit'
+
+module Guard
+  class Minitest
+    class Runner
+
+      def _run_command(paths, all)
+        $LOAD_PATH << 'test' unless $LOAD_PATH.include?('test')
+        paths.each {|path| reload path, all}
+
+        # if ::MiniTest.respond_to?(:run) # minitest 5
+        if Utils.minitest_version_gte_5?
+          ::MiniTest.run(ARGV)
+          ::MiniTest.class_variable_get(:@@after_run).reverse_each(&:call)
+        else
+          ::Minitest::Unit.runner = nil # resets the runner for minitest
+          ::MiniTest::Unit.new.run(ARGV)
+          ::MiniTest::Unit.class_variable_get(:@@after_tests).reverse_each(&:call)
+        end
+      end
+
+      private
+
+        def reload(path, all)
+          if all
+           load path
+          else
+            ::Guard::JRubyMinitest::TestPathsReloader.run([path])
+          end
+        end
+
+    end
+  end
+end
+
+

data/lib/guard/jruby-minitest/runners/old_runner.rb

@@ -0,0 +1,16 @@
+require 'minitest/unit'
+require 'guard/minitest/notifier'
+
+module MiniTest
+  class MiniTest::Unit
+    begin
+      alias_method :_run_anything_without_guard, :_run_anything
+      def _run_anything(type)
+        start = Time.now
+        _run_anything_without_guard(type)
+        duration = Time.now - start
+        ::Guard::Minitest::Notifier.notify(test_count, assertion_count, failures, errors, skips, duration)
+      end
+    end
+  end
+end

data/lib/guard/jruby-minitest/templates/Guardfile

@@ -0,0 +1,9 @@
+# This eliminates the stty warning.
+interactor :simple
+guard 'jruby-minitest', :spec_paths => ["test"] do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end
+

data/lib/guard/jruby-minitest/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module JRubyMinitestVersion
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-jruby-minitest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jack Xu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -30,12 +30,40 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 2.3.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.7.3
+        version: 2.3.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: pry
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
@@ -81,8 +109,18 @@ files:
 - README.md
 - Rakefile
 - guard-jruby-minitest.gemspec
-- lib/guard/jruby/minitest.rb
-- lib/guard/jruby/minitest/version.rb
+- lib/guard-jruby-minitest.rb
+- lib/guard/jruby-minitest.rb
+- lib/guard/jruby-minitest/containment.rb
+- lib/guard/jruby-minitest/reloaders/app_paths_reloader.rb
+- lib/guard/jruby-minitest/reloaders/factory_girl_reloader.rb
+- lib/guard/jruby-minitest/reloaders/rails_reloader.rb
+- lib/guard/jruby-minitest/reloaders/test_paths.rb
+- lib/guard/jruby-minitest/reloaders/test_paths_reloader.rb
+- lib/guard/jruby-minitest/runner.rb
+- lib/guard/jruby-minitest/runners/old_runner.rb
+- lib/guard/jruby-minitest/templates/Guardfile
+- lib/guard/jruby-minitest/version.rb
 - test/test_helper.rb
 homepage: https://github.com/jackxxu/guard-jruby-minitest
 licenses:

data/lib/guard/jruby/minitest.rb

@@ -1,12 +0,0 @@
-require 'guard/guard'
-require 'guard/minitest'
-require "guard/jruby/minitest/version"
-
-module Guard
-  module Jruby
-    class Minitest < ::Guard::Minitest
-
-
-    end
-  end
-end

data/lib/guard/jruby/minitest/version.rb

@@ -1,7 +0,0 @@
-module Guard
-  module Jruby
-    module Minitest
-      VERSION = "0.0.1"
-    end
-  end
-end