guard-sclang 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ec4f743fda4d9f4624f0ac998c2c56116f41f7d7
-  data.tar.gz: 73d9b97ca0bd8e8693bc2e0f0e22756f7e08537d
+SHA256:
+  metadata.gz: ea35a0bfba850d4f17a1f3cf76f1df062053c28630e5eb17f7ccafa8f221de99
+  data.tar.gz: 30aa8b33db6642b9490f3ac451943acabfb6fe63e0a50bac88d240982560de62
 SHA512:
-  metadata.gz: ccb809137015499345dd6aa8166de1934d79105110fcecc943f4d4b5e044b125ac5317b3812c64aaf9681f70b26e914abc63b898a33bbfa508ffa657af5a3c13
-  data.tar.gz: d32873acf76ad416693b03cbcd1d97a1eabccd394158143905a474b978ffb10f578394cb28a5be313860ac2a22000e43b1ecfdf64561c0130cb56e95ea3fe488
+  metadata.gz: 6191fde9ce607a751469a55c78250c7ba77106c7beb02e9cc43039d1d87db39d0d709806664539ba056373c49807d5153d59991e2cffd20e0b9c4dbd68fbbb9c
+  data.tar.gz: c7d8a6ec4df2c08a2391ddf2ffb589f8d04b55c0ba979ce1346c743c62799cfeb6199d55823f7ff6e9ddd4dfc59c8ccbc6054145b71e95840af1eabe1b46c3d4

data/CONTRIBUTING.md

@@ -19,3 +19,7 @@ please follow these
 [guidelines on contributing](http://blog.adamspiers.org/2012/11/10/7-principles-for-contributing-patches-to-software-projects/) so that you can help me to help you ;-)
 
 Thanks in advance!
+
+## Guide for maintainers
+
+See [`MAINTAINERS.md`](MAINTAINERS.md).

data/README.md

@@ -1,13 +1,17 @@
+[![Build Status](https://travis-ci.org/aspiers/guard-sclang.svg?branch=master)](https://travis-ci.org/aspiers/guard-sclang)
+
 Guard::Sclang
 =============
 
-This [Guard](http://guardgem.org/) plugin allows you to run SuperCollider [`UnitTest` test
-suites](http://doc.sccode.org/Classes/UnitTest.html) commands when
-files are added or altered.
+This [Guard](http://guardgem.org/) plugin allows you to run
+SuperCollider [`UnitTest` test
+suites](http://doc.sccode.org/Classes/UnitTest.html) automatically
+when files are added or altered, so that you can immediately see the
+impact of code changes on your tests.
 
 
-Install
--------
+Installation
+------------
 
 Make sure you have [Guard](http://guardgem.org/) installed.
 
@@ -15,17 +19,25 @@ Install the gem with:
 
     gem install guard-sclang
 
-Or add it to your `Gemfile`:
+Or, better, add it to your `Gemfile`, and then use
+[Bundler](http://bundler.io/) to install it:
 
-    gem 'guard-sclang'
+    echo "gem 'guard-sclang'" >> Gemfile
+    bundle install
 
-And then add a basic setup to your `Guardfile`:
 
-    guard init sclang
+Configuring a `Guardfile`
+---------------------------
 
+Before you can launch Guard, you need to configure a `Guardfile` which
+tells Guard which of your SuperCollider tests to run via the
+`guard-sclang` plugin.
 
-Usage
------
+You can create a stub `Guardfile` from a built-in template via:
+
+    bundle exec guard init sclang
+
+The rest of this section explains how to configure the `Guardfile`.
 
 When one or more files matching a `watch` block's regular expression
 changes, guard-sclang simply runs the UnitTest subclass returned by
@@ -76,7 +88,7 @@ end
 
 ### Other options
 
-To run everything on start pass `:all_on_start` to `#guard`:
+To run everything on start, pass `:all_on_start` to `#guard`:
 
 ``` ruby
 guard :sclang, all_on_start: true do
@@ -84,6 +96,39 @@ guard :sclang, all_on_start: true do
 end
 ```
 
+To run everything after previously failing tests succeeded, pass
+`:all_after_pass` to `#guard`:
+
+``` ruby
+guard :sclang, all_after_pass: true do
+  ...
+end
+```
+
+
+Usage
+-----
+
+Once you have set up your `Guardfile` with the `guard-sclang` plugin
+enabled, you are ready to launch Guard.
+
+`guard-sclang` assumes that the `sclang` interpreter is to be found
+somewhere on your `$PATH`.  If you installed SuperCollider on Linux
+via a distribution package, this should happen automatically, in which
+case you can simply launch Guard by typing this into your shell:
+
+    bundle exec guard
+
+However if you installed from source, or you are using MacOS, maybe
+`sclang` won't be on the `$PATH`, in which case you will need to set
+it.  This can either be done temporarily for each invocation of Guard,
+e.g.
+
+    PATH=/path/to/dir/containing/sclang:$PATH bundle exec guard
+
+or by configuring your interactive shell setup (e.g. `~/.bashrc`) to
+set `$PATH` on startup.
+
 
 Development / support / feedback
 --------------------------------

data/lib/guard/sclang.rb

@@ -6,10 +6,13 @@ require 'guard/sclang/version'
 
 module Guard
   class Sclang < Plugin
+    attr_accessor :last_failed
+
     def initialize(options={})
       super
       options[:args] ||= []
       options[:timeout] ||= 3
+      @last_failed  = false
     end
 
     # Calls #run_all if the :all_on_start option is present.
@@ -21,10 +24,13 @@ module Guard
     def stop
     end
 
-    # Call #run_on_change for all files which match this guard.
+    # Test for all files which match this guard.
     def run_all
-      all = Compat.matching_files(self, Dir.glob('{,**/}*.sc{,d}'))
-      run_on_modifications(all)
+      run_sclang
+    end
+
+    def all_paths
+      Compat.matching_files(self, Dir.glob('{,**/}*.sc{,d}'))
     end
 
     def run_on_additions(paths)
@@ -53,10 +59,19 @@ module Guard
       else
         title = tester.join " "
       end
-      [cmd, title]
+      return [cmd, title]
+    end
+
+    def run_sclang(paths=nil)
+      success = run_sclang_once(paths || all_paths)
+      if paths && options[:all_after_pass] && success && last_failed
+        success = run_all
+      end
+      @last_failed = !success
+      return success
     end
 
-    def run_sclang(paths)
+    def run_sclang_once(paths)
       paths = paths.uniq
       cmd, title = _get_cmd_and_title(paths)
 
@@ -64,17 +79,40 @@ module Guard
       print Compat::UI.color("=" * (ENV["COLUMNS"] || "72").to_i, :blue)
       print Compat::UI.color("Running: " + cmd.join(" ") + "\n", :blue)
 
-      got_status, exit_status = _run_cmd(cmd, title)
+      run_status, exit_status = _run_cmd(cmd, title)
 
-      unless got_status
+      if run_status
+        return run_status == :success
+      else
+        # Couldn't figure out the result from the output.  Even if
+        # the exit code is 0, this could simply mean something went
+        # wrong in unit-test-cli.scd's handling of an error, so we
+        # assume the worst.
         _handle_missing_status(exit_status, title)
+        return :failed
       end
     end
 
+    # Returns [run_status, exit_status] pair.
+    #
+    # Run the test runner, add colour for PASS/FAIL/ERROR/WARNING, and
+    # try to extract the final test result (100% pass / some failures
+    # / compilation error) from the runner output.  If the test result
+    # is successfully extracted from the output, the appropriate
+    # notification will be sent, and the run_status value returned
+    # will be :success or :failed.  However if something goes wrong
+    # then we won't be able to determine the result from the output,
+    # in which case at least we capture the exit status of the runner
+    # process, and success is determined based on this exit status.
+    #
+    # Note that due to quirks in SuperCollider which are not yet
+    # understood, it is possible for the exit code to be non-zero even
+    # when the test suite passes 100% and the test runner is
+    # apparently working as designed.
     def _run_cmd(cmd, title)
       command, *args = *cmd
 
-      got_status = false
+      run_status = nil
       exit_status = nil
 
       # Using PTY instead of Open3.popen2e should work around
@@ -87,7 +125,7 @@ module Guard
               colors =
                 if line =~ /^PASS:/
                   [:green]
-                elsif line =~ /^FAIL:/
+                elsif line =~ /^FAIL:|^There were failures/
                   [:red]
                 elsif line =~ /^ERROR:/
                   [:bright, :red]
@@ -97,10 +135,18 @@ module Guard
                   []
                 end
 
-              status, msg, line = _check_line_for_status(line)
-              if status
-                got_status = true
-                Compat::UI.notify(msg, title: title, image: status)
+              line_status, msg, line = _check_line_for_status(line)
+              if line_status
+                # Allow for multiple summary lines just in case, e.g.
+                # some with no failures and others with failures.
+                # Hopefully this won't happen though.
+                if line_status == :success
+                  run_status ||= line_status
+                else
+                  run_status = line_status
+                end
+
+                Compat::UI.notify(msg, title: title, image: line_status)
               end
 
               print Compat::UI.color(line, *colors)
@@ -112,6 +158,9 @@ module Guard
           rescue Errno::EIO => e
             # Ran out of output to read
             exit_status = $?
+            unless exit_status
+              Compat::UI.error("$? returned #{exit_status}")
+            end
           end
         end
       rescue PTY::ChildExited => e
@@ -119,7 +168,7 @@ module Guard
         exit_status = e.status.exitstatus
       end
 
-      [got_status, exit_status]
+      [run_status, exit_status]
     end
 
     def _check_line_for_status(line)
@@ -140,13 +189,16 @@ module Guard
       [status, msg, line]
     end
 
+    # Couldn't figure out the result from the output, so rely on
+    # the exit code instead.
     def _handle_missing_status(exit_status, title)
       msg = "Pid %d exited with status %d" % [exit_status.pid, exit_status.exitstatus]
-      status = exit_status == 0 ? :success : :failed
+      status = exit_status.success? ? :success : :failed
       Compat::UI.notify(msg, title: title, image: status)
       level = status == :success ? :warning : :error
       Compat::UI.send(level, msg)
       Compat::UI.warning("Didn't find test results in output")
+      exit_status.success?
     end
   end
 end

data/lib/guard/sclang/version.rb

@@ -1,5 +1,5 @@
 module Guard
   module SclangVersion
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   end
 end

data/unit-test-cli.scd

@@ -31,6 +31,8 @@ var excludes = [
 // Have to wrap this in a Task so that we can wait.
 t = Task.new {
 	UnitTest.reset;
+	//UnitTest.reportPasses = false;
+	UnitTest.passVerbosity = UnitTest.brief;
 	if (thisProcess.argv.isEmpty) {
 		UnitTest.allSubclasses.do { |testClass|
 			if (excludes.includes(testClass.asString).not) {
@@ -44,7 +46,7 @@ t = Task.new {
 	} {
 		thisProcess.argv.do { |name|
 			if (name.contains("/")) {
-				name = name.basename.removeExtension;
+				name = PathName(name.basename).fileNameWithoutExtension;
 			};
 			if (name.contains(":")) {
 				UnitTest.runTest(name);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: guard-sclang
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Spiers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-29 00:00:00.000000000 Z
+date: 2018-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +112,6 @@ files:
 - LICENSE
 - README.md
 - lib/guard/sclang.rb
-- lib/guard/sclang.rb.orig
 - lib/guard/sclang/templates/Guardfile
 - lib/guard/sclang/version.rb
 - unit-test-cli.scd
@@ -122,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Guard gem for running sclang commands

data/lib/guard/sclang.rb.orig

@@ -1,166 +0,0 @@
-require 'open3'
-require 'pathname'
-
-require 'guard/compat/plugin'
-require 'guard/sclang/version'
-
-module Guard
-  class Sclang < Plugin
-<<<<<<< HEAD
-    def initialize
-=======
-    def initialize(options)
->>>>>>> c984ace... fix tests
-      super
-      options[:args] ||= []
-      options[:timeout] ||= 3
-    end
-
-    # Calls #run_all if the :all_on_start option is present.
-    def start
-      run_all if options[:all_on_start]
-    end
-
-    # Defined only to make callback(:stop_begin) and callback(:stop_end) working
-    def stop
-    end
-
-    # Call #run_on_change for all files which match this guard.
-    def run_all
-      all = Compat.matching_files(self, Dir.glob('{,**/}*.sc{,d}'))
-      run_on_modifications(all)
-    end
-
-    def run_on_additions(paths)
-      run_sclang(paths)
-    end
-
-    def run_on_modifications(paths)
-      run_sclang(paths)
-    end
-
-    def run_on_removals(paths)
-      run_sclang(paths)
-    end
-
-    def _get_cmd_and_title(paths)
-      # -i scqt is required to compile IDE libraries, otherwise we get
-      # compile warnings on Quarks which extend classes provided by those
-      # IDE libraries.
-      here = Pathname.new(__FILE__).dirname
-      runner = here.parent.parent + "unit-test-cli.scd"
-      tester = ["sclang"] + options[:args] + [runner.to_s]
-      cmd = ["timeout", options[:timeout].to_s] + tester
-      if paths
-        cmd += paths
-        title = paths.join " "
-      else
-        title = tester.join " "
-      end
-      [cmd, title]
-    end
-
-    def run_sclang(paths)
-      cmd, title = _get_cmd_and_title(paths)
-
-      outerr = ''
-      print Compat::UI.color("=" * (ENV["COLUMNS"] || "72").to_i, :blue)
-      print Compat::UI.color("Running: " + cmd.join(" ") + "\n", :blue)
-
-      got_status, exit_status = _run_cmd(cmd, title)
-
-      unless got_status
-        _handle_missing_status(exit_status)
-      end
-    end
-
-    def _run_cmd(cmd, title)
-      got_status = false
-      exit_status = nil
-
-      Open3.popen2e(*cmd) do |stdin, stdouterr, wait_thr|
-        stdouterr.each do |line|
-          #Compat::UI.info(line)
-          colors =
-            if line =~ /^PASS:/
-              [:green]
-            elsif line =~ /^FAIL:/
-              [:red]
-            elsif line =~ /^ERROR:/
-              [:bright, :red]
-            elsif line =~ /^WARNING:/
-              [:yellow]
-            else
-              []
-            end
-
-          status, msg, line = _check_line_for_status(line)
-          if status
-            got_status = true
-            Compat::UI.notify(msg, title: title, image: status)
-          end
-
-          print Compat::UI.color(line, *colors)
-        end
-
-        exit_status = wait_thr.value
-      end
-
-      [got_status, exit_status]
-    end
-
-    def _check_line_for_status(line)
-      status, msg = nil
-
-      if line =~ /Finished running test\(s\): (\d+ pass(?:es), (\d+) failures?)/
-        msg, failures = $1, $2
-        status = failures == "0" ? :success : :failed  # :pending also supported
-      elsif line =~ /(Library has not been compiled successfully)\./
-        msg = $1
-        status = :failed
-      end
-
-      if status
-        line = Compat::UI.color(line, status == :success ? :green : :red)
-      end
-
-      [status, msg, line]
-    end
-
-    def _handle_missing_status(exit_status)
-      msg = "Pid %d exited with status %d" % [exit_status.pid, exit_status]
-      status = exit_status == 0 ? :success : :failed
-      Compat::UI.notify(msg, title: title, image: status)
-      level = status == :success ? :warning : :error
-      Compat::UI.send(level, msg)
-      Compat::UI.warning("Didn't find test results in output")
-    end
-  end
-
-  class Dsl
-    # Easy method to display a notification
-    def n(msg, title='', image=nil)
-      Compat::UI.notify(msg, :title => title, :image => image)
-    end
-
-    # Eager prints the result for stdout and stderr as it would be written when
-    # running the command from the terminal. This is useful for long running
-    # tasks.
-    def eager(command)
-      require 'pty'
-
-      begin
-        PTY.spawn command do |r, w, pid|
-          begin
-            $stdout.puts
-            r.each {|line| print line }
-          rescue Errno::EIO
-            # the process has finished
-          end
-        end
-      rescue PTY::ChildExited
-        $stdout.puts "The child process exited!"
-      end
-    end
-  end
-end