guard-sclang 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b18831779dae4a3711cc6c01b382941999af0425
+  data.tar.gz: 8e281d8977a0af9ccbdaaecb38096405053b7be2
+SHA512:
+  metadata.gz: c3a44218758f7e3bd7236d2f9c20c54b34f9461b8b7a0b2622c73d6e498f9e37ed2fe0a8eb84897097b7c0ee66919bf553c0bd6eb74bb6009429ea57b8418fdb
+  data.tar.gz: 73e29afaa31bec0d8c2a67f9a3432d6d0982d7c9e56159df647f5c8ceca3afbe6cd36ec0b0ee66f71e8177640ed66f9793191f0b4757c27ae21d13ee39c2a818

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Adam Spiers, Joshua Hawxwell
+
+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,100 @@
+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.
+
+
+Install
+-------
+
+Make sure you have [Guard](http://guardgem.org/) installed.
+
+Install the gem with:
+
+    gem install guard-sclang
+
+Or add it to your `Gemfile`:
+
+    gem 'guard-sclang'
+
+And then add a basic setup to your `Guardfile`:
+
+    guard init sclang
+
+
+Usage
+-----
+
+When one or more files matching a `watch` block's regular expression
+changes, guard-sclang simply runs the UnitTest subclass returned by
+that block:
+
+``` ruby
+guard :sclang do
+  # Run any tests which are added or changed under lib/tests/
+  watch(%r{lib/tests/\w.*\.sc})
+
+  # For any class Foo added or changed under lib/classes/, run
+  # the corresponding test class TestFoo
+  watch(%r{lib/classes/(\w.*)\.sc}) do |m|
+    classname = "Test#{m[1]}"
+    puts "#{m[0]} changed; running #{classname}"
+    classname
+  end
+end
+```
+
+### `sclang` CLI arguments
+
+You can optionally provide arguments to be passed to `sclang`, e.g.
+
+``` ruby
+# Load the ScQT IDE classes
+guard :sclang, args: ["-i", "scqt"] do
+  ...
+end
+```
+
+### `sclang` execution timeout
+
+If `sclang` experiences a compilation error, it will hang, so
+invocation of `sclang` is currently wrapped by
+[`timeout(1)`](https://linux.die.net/man/1/timeout).  (This
+currently prevents `guard-sclang` from working outside Linux,
+but it should not be hard to convert the timeout mechanism to native
+Ruby to fix that.)
+
+The timeout defaults to 3 seconds, but can be changed:
+
+``` ruby
+guard :sclang, timeout: 10 do
+  ...
+end
+```
+
+### Other options
+
+To run everything on start pass `:all_on_start` to `#guard`:
+
+``` ruby
+guard :sclang, all_on_start: true do
+  ...
+end
+```
+
+
+Development / support / feedback
+--------------------------------
+
+Please see [the CONTRIBUTING file](CONTRIBUTING.md).
+
+
+History and license
+-------------------
+
+This plugin was based on
+[`guard-shell`](https://github.com/guard/guard-shell) by Joshua
+Hawxwell, so the original license has been preserved - see
+[LICENSE](LICENSE).

data/lib/guard/sclang.rb

@@ -0,0 +1,152 @@
+require 'pathname'
+require 'pty'
+
+require 'guard/compat/plugin'
+require 'guard/sclang/version'
+
+module Guard
+  class Sclang < Plugin
+    def initialize(options={})
+      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)
+      paths = paths.uniq
+      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, title)
+      end
+    end
+
+    def _run_cmd(cmd, title)
+      command, *args = *cmd
+
+      got_status = false
+      exit_status = nil
+
+      # Using PTY instead of Open3.popen2e should work around
+      # https://github.com/supercollider/supercollider/issues/3366
+      begin
+        PTY.spawn command, *args do |stdouterr, stdin, pid|
+          begin
+            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
+
+            # stdouterr should always raise Errno::EIO when EOF is reached.
+            # If this doesn't happen, probably the test suite is running.
+            raise Errno::EIO
+          rescue Errno::EIO => e
+            # Ran out of output to read
+            exit_status = $?
+          end
+        end
+      rescue PTY::ChildExited => e
+        $stdout.puts "The child process exited! #{e}"
+        exit_status = e.status.exitstatus
+      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, title)
+      msg = "Pid %d exited with status %d" % [exit_status.pid, exit_status.exitstatus]
+      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
+end

data/lib/guard/sclang.rb.orig

@@ -0,0 +1,166 @@
+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

data/lib/guard/sclang/templates/Guardfile

@@ -0,0 +1,12 @@
+guard :sclang do
+  # Run any tests which are added or changed under lib/tests/
+  watch(%r{lib/tests/\w.*\.sc})
+
+  # For any class Foo added or changed under lib/classes/, run
+  # the corresponding test class TestFoo
+  watch(%r{lib/classes/(\w.*)\.sc}) do |m|
+    classname = "Test#{m[1]}"
+    puts "#{m[0]} changed; running #{classname}"
+    classname
+  end
+end

data/lib/guard/sclang/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module SclangVersion
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: guard-sclang
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Spiers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: guard-compat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+description: |2
+      Guard::Sclang automatically runs sclang commands when watched files are
+      modified.
+email: guard@adamspiers.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/guard/sclang.rb
+- lib/guard/sclang.rb.orig
+- lib/guard/sclang/templates/Guardfile
+- lib/guard/sclang/version.rb
+homepage: http://github.com/aspiers/guard-sclang
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Guard gem for running sclang commands
+test_files: []