guard-rackunit 1.0.0

data/README.md

@@ -0,0 +1,82 @@
+# Guard::RackUnit
+
+`Guard::RackUnit` is a Guard plugin to run
+[Racket's](http:/racket-lang.org)
+[RackUnit](http://docs.racket-lang.org/rackunit/index.html) unit
+tests.
+
+By default, `Guard::RackUnit` uses the `raco test` command to run
+tests. Consequently, your RackUnit tests should be placed in
+Racket test modules: `(module+ test ...)`.
+
+```
+guard init rackunit
+```
+
+## Setup
+There are many ways to set up Guard. For the non-Rubyist, the ceremony
+described below is a typical setup.
+
+1. Install a relatively recent version of Ruby.
+2. Install [bundler](http://bundler.io)
+3. Install [rvm](https://rvm.io)
+4. Create a `Gemfile` in your Racket project's root directory. To the
+   `Gemfile`, add both the guard gem and the guard-rackunit gem. See
+   the example below.
+5. In the directory where the `Gemfile` is stored, run `bundle install`
+
+If everything successfully installs, you are now ready to use
+Guard. Consult the usage section below on how to use the RackUnit
+plugin.
+
+### Example Gemfile
+``` ruby
+source 'https://www.rubygems.org'
+gem "guard", "~> 2.5.1"
+gem 'guard-rackunit', path: '/home/calbers/src/mine/guard-rackunit'
+```
+
+## Usage
+To use the RackUnit Guard plugin, Guard must be initialized. To do so,
+execute the following command in your project's root directory: `bundle
+exec guard init`. This should create a `Guardfile` with a default
+setup for RackUnit.
+
+Now, to start Guard, execute the following command: `bundle exec guard
+start`.
+
+Please consult Guard's own
+[usage notes](https://github.com/guard/guard#readme) for more
+information.
+
+##List of available options:
+``` ruby
+test_paths: ['tests/']  # Specify an array of paths that contain unit test files
+all_on_start: true      # Run all the tests at startup, default: false
+```
+
+## Support and Issues
+Please submit support questions, feature requests, and issues to
+the Github repository's [issue tracker](https://github.com/neomantic/guard-rackunit/issues).
+
+## Updates
+Consult the ChangeLog when upgrading to newer versions.
+
+## Development
+The source code is hosted at
+[GitHub](https://github.com/neomantic/guard-rackunit).
+
+Pull requests are more than welcome. To contribute, please add new
+unit tests to the existing suite of Ruby
+[rspec](https://relishapp.com/rspec) unit tests.
+
+## Requirements
+1. Racket, with `raco test` support
+2. Ruby, and the gems which `Guard::RackUnit` depends on.
+
+## Author
+[Chad Albers](https://github.com/neomantic)
+
+## License
+This Guard plugin is released under the GPLv3. Consult the LICENSE
+file for more details

data/lib/guard/rackunit.rb

@@ -0,0 +1,88 @@
+require 'guard/plugin'
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Guard
+  class RackUnit < Plugin
+
+    require_relative 'rackunit/runner'
+
+    # Initializes a Guard plugin.
+    # Don't do any work here, especially as Guard plugins get initialized even if they are not in an active group!
+    #
+    # @param [Hash] options the custom Guard plugin options
+    # @option options [Array<Guard::Watcher>] watchers the Guard plugin file watchers
+    # @option options [Symbol] group the group this Guard plugin belongs to
+    # @option options [Boolean] any_return allow any object to be returned from a watcher
+    #
+    def initialize(options = {})
+      super
+      @start_on_run = options.delete(:all_on_start) || false
+      @test_paths = options.delete(:test_paths) || []
+      @runner = RackUnit::Runner.new
+    end
+
+    # Called once when Guard starts. Please override initialize method to init stuff.
+    #
+    # @raise [:task_has_failed] when start has failed
+    # @return [Object] the task result
+    #
+    def start
+      ::Guard::UI.info 'Guard::RackUnit is running'
+      return run_all if @start_on_run
+      pending_result
+    end
+
+    # Called when just `enter` is pressed
+    # This method should be principally used for long action like running all specs/tests/...
+    #
+    # @raise [:task_has_failed] when run_all has failed
+    # @return [Object] the task result
+    #
+    def run_all
+      return pending_result unless test_paths?
+      Guard::UI.info("Resetting", reset: true)
+      do_run{ @runner.run(@test_paths) }
+    end
+
+    # Called on file(s) modifications that the Guard plugin watches.
+    #
+    # @param [Array<String>] paths the changes files or paths
+    # @raise [:task_has_failed] when run_on_modifications has failed
+    # @return [Object] the task result
+    #
+    def run_on_modifications(paths)
+      return pending_result if paths.empty?
+      Guard::UI.info("Running: #{paths.join(', ')}", reset: true)
+      do_run{ @runner.run(paths) }
+    end
+
+    private
+    def do_run
+      run_result = yield
+      run_result.issue_notification
+      run_result.successful? ? run_result : throw(:task_has_failed)
+    end
+
+    def test_paths?
+      !@test_paths.nil? && !@test_paths.empty?
+    end
+
+    def pending_result
+      @pending ||= RunResult::Pending.new
+    end
+  end
+end

data/lib/guard/rackunit/command.rb

@@ -0,0 +1,48 @@
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'open3'
+require_relative './run_result'
+module Guard
+  class RackUnit
+    class Command
+
+      def execute(paths)
+        return RunResult::Pending.new if paths.empty?
+        cmd = sprintf('%s %s', DEFAULT_CMD_STR, paths.join(' '))
+        with_environment do
+          Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+            pid = wait_thr.pid
+            wait_thr.value
+            RunResult.create(stdout, stderr)
+          end
+        end
+      end
+
+      def with_environment
+        if defined?(::Bundler)
+          ::Bundler.with_clean_env { yield }
+        else
+          yield
+        end
+      end
+
+      private
+      DEFAULT_CMD_STR = 'raco test'.freeze
+
+    end
+  end
+end

data/lib/guard/rackunit/notifier.rb

@@ -0,0 +1,35 @@
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Guard
+  class RackUnit
+    class Notifier
+
+      DEFAULT_OPTIONS = {
+        title: 'RackUnit Results',
+      }.freeze
+
+      def initialize(message)
+        @message = message
+      end
+
+      def notify(options)
+        ::Guard::Notifier.notify(@message,
+                                 DEFAULT_OPTIONS.merge(options))
+      end
+    end
+  end
+end

data/lib/guard/rackunit/run_result.rb

@@ -0,0 +1,108 @@
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'set'
+require_relative './notifier'
+module Guard
+  class RackUnit
+    class RunResult
+
+      def self.create(stdout, stderr)
+        err_byte = stderr.getbyte
+        if err_byte.nil?
+          Success.new(stdout)
+        else
+          puts stdout.readlines
+          stderr.ungetbyte(err_byte)
+          Failure.new(stderr)
+        end
+      end
+
+      class Pending
+        def issue_notification; end
+        def paths; Set[]; end
+        def successful?; false; end
+      end
+
+      class Success
+
+        def initialize(result_io)
+          @message = "Success"
+          result_io.each_line do |line|
+            puts @message = line
+          end
+          @message.chomp!
+        end
+
+        def issue_notification
+          Notifier.new(@message).notify NOTIFY_OPTIONS
+        end
+
+        def paths; Set[]; end
+
+        def successful?; true; end
+
+        private
+        NOTIFY_OPTIONS = {image: :success, priority: -2}.freeze
+
+      end
+
+
+      class Failure
+
+        def initialize(stderr)
+          @message = "Failed"
+          @failed_paths_set = Set[]
+          stderr.each_line do |line|
+            puts line # give user some feedback
+
+            if line =~ ERROR_REGEX
+              # an exception as raised
+              @message = stderr.readline
+              puts @message
+              @message = "ERROR: #{@message.strip}"
+              stderr.each_line{|line| puts line}
+            else
+              match_data = line.match(FAILURE_REGEX)
+              unless match_data.nil?
+                @failed_paths_set.add(match_data[1])
+              else
+                # the last line should have the results summary
+                @message = line
+              end
+            end
+          end
+          @message.chomp!
+        end
+
+        def issue_notification
+          Notifier.new(@message).notify NOTIFY_OPTIONS
+        end
+
+        def paths
+          @failed_paths_set || Set[]
+        end
+
+        def successful?; false; end
+
+        private
+        FAILURE_REGEX = /\Alocation:.+path:(.+)>/
+        NOTIFY_OPTIONS = {image: :failed, priority: 2}.freeze
+        ERROR_REGEX = /context#{Regexp.escape('...')}:/
+      end
+    end
+  end
+end

data/lib/guard/rackunit/runner.rb

@@ -0,0 +1,61 @@
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative './run_result'
+require_relative './command'
+
+module Guard
+  class RackUnit
+    class Runner
+
+      def initialize
+        @last_run_result = pending_result
+      end
+
+      # This class runs a Command (which will be customizable)
+      # And produces a run result
+      def run(paths = [])
+        return pending_result if paths.empty?
+        path_set = PathSet.new(@last_run_result.paths, Set.new(paths))
+        @last_run_result = Command.new.execute(path_set.to_a)
+      end
+
+      private
+      def pending_result
+        RunResult::Pending.new
+      end
+
+    end
+
+    private
+
+    class PathSet
+
+      def initialize(previous_set, new_set)
+        @set = previous_set | select_existing(new_set)
+      end
+
+      def to_a
+        @set.to_a
+      end
+
+      private
+      def select_existing(paths)
+        paths.select{|path| File.exists?(path)}
+      end
+    end
+  end
+end

data/lib/guard/rackunit/templates/Guardfile

@@ -0,0 +1,4 @@
+# This Guardfile was generated from Guard::RackUnit
+guard :rack_unit, all_on_start: true, test_paths: ["tests/"] do
+  watch(%r{^tests/.+-tests.rkt$})
+end

data/lib/guard/rackunit/version.rb

@@ -0,0 +1,22 @@
+# Guard::RackUnit
+# Copyright (C) 2014 Chad Albers
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'guard'
+module Guard
+  class RackUnit
+    VERSION = '1.0.0'
+  end
+end