guard-super_shell 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6c62d9073bb7df0311b628dcc45b96f19b43826fa2b88643e31042b60eec3c48
+  data.tar.gz: 8fe11c8bf9f52d721884174e29a173172919452f2ccd03410000fb75c72180fa
+SHA512:
+  metadata.gz: e96a60669d3c81fe82cd32919e09ea3fe19d889cdf279b626acc68562e11e9b274e4a47413a3e93290fbb7eb2e2a7329a6952e6520da5686f3f085bd54c09b50
+  data.tar.gz: 74b11dba24d807fd9e8a53579448ccf8426767d2b94d9d567b3d47ce3f6ac0c265f711a10d6e3e0bc209bb642b215bc3add135eb86476ab33b7d2c1f0e16f894

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 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,103 @@
+# guard-super_shell
+
+Shell commands triggered by files changing.
+
+- [ ] TODO: Update specs
+
+## Differences from [guard-shell](https://github.com/guard/guard-shell)
+
+- Runs the shell command on a set of changes instead of once per file (like all other guards)
+- `run_on_start` option runs the command once, not once per file that will be watched
+- Shows notifications based on the command status, no additions to the DSL
+- Last line of command output is shown in the notification
+- `name` option provides a meaningful name for each instance which is displayed in console and notifications
+- Runs on all file changes, not just modifications of existing files.
+
+## Install
+
+Make sure you have [guard](http://github.com/guard/guard) installed.
+
+Install the gem with:
+
+    gem install guard-super_shell
+
+Or add it to your Gemfile:
+
+    gem 'guard-super_shell'
+
+And then add a basic setup to your Guardfile:
+
+    guard init shell
+
+
+## Usage
+
+If you can do something in your shell, or in ruby, you can do it when files change
+with guard-super_shell. It executes a shell command built by the `command` block you provide,
+if one or more matching files change.
+The output of the command is shown in the console.
+It shows a notification based on the return status of that shell command.
+
+``` ruby
+guard(
+  :shell,
+  name: "GraphQL Schema",
+  command: proc { |files| "bin/rake graphql:schema:idl" },
+) do
+  watch %r{app/graphql.+}
+end
+```
+
+will run a rake task and print the returned output from the rake task to the console.
+
+You can also return an array of command components. To have it run at startup:
+
+``` ruby
+guard(
+  :shell,
+  name: "GraphQL Schema",
+  run_at_start: true,
+  command: proc { |files| ["bin/rake", "graphql:schema:idl"] },
+) do
+  watch %r{app/graphql.+}
+end
+```
+
+### Examples
+
+#### Saying the Name of the File(s) You Changed
+
+``` ruby
+guard(
+  :shell,
+  name: "Speak Changes",
+  command: proc { |files| "say -v cello #{files.join(" ")}" },
+) do
+  watch /(.*)/
+end
+```
+
+#### Check Syntax of a Ruby File
+
+``` ruby
+guard(
+  :shell ,
+  name: "Check Ruby Syntax",
+  command: proc { |files| "ruby -c #{files.join(' ')}" },
+) do
+  watch /.*\.rb$/
+end
+```
+
+#### Run tests on corresponding file
+
+``` ruby
+guard(
+  :shell ,
+  name: "Run Corresponding Test",
+  command: proc { |files| "bin/test #{files.join(' ')}" },
+) do
+  # Translate the matching changed file path to get the path of the corresponding test file.
+  watch %r{app/stuff/(.*)\.rb$} { |m| "spec/stuff/#{m[1]}_test.rb" }
+end
+```

data/lib/guard/super_shell.rb

@@ -0,0 +1,59 @@
+require 'guard/compat/plugin'
+require 'guard/super_shell/version'
+require 'open3'
+
+module Guard
+  class SuperShell < Plugin
+    def start
+      if options[:run_at_start]
+        Compat::UI.info "#{name} running at start"
+        run_command
+      end
+    end
+
+    def stop
+    end
+
+    def run_on_changes(files)
+      Compat::UI.info "#{name}: #{files.join}"
+      run_command(files)
+    end
+
+    def run_all
+      run_command
+    end
+
+    def name
+      options[:name] || "shell"
+    end
+
+    private
+
+    def run_command(files = [])
+      command = options[:command].call(files)
+      (stdin, stdout_and_stderr, thread) = Open3.popen2e(command)
+      output = stdout_and_stderr.read
+      puts output
+
+      if thread.value.success?
+        Compat::UI.notify(output.lines.last, title: name, type: :success) if notify?
+      else
+        Compat::UI.notify(output.lines.last, title: name, type: :failed) if notify?
+        throw :task_has_failed
+      end
+    rescue => e
+      msg = "#{e.class.name}: #{e.message}"
+      Compat::UI.error "#{name}: raised error #{msg}"
+      Compat::UI.notify(msg, title: name, type: :failed) if notify?
+      throw :task_has_failed
+    end
+
+    def notify?
+      options.fetch(:notification, true)
+    end
+
+    def run_at_start?
+      options.fetch(:run_at_start, false)
+    end
+  end
+end

data/lib/guard/super_shell/templates/Guardfile

@@ -0,0 +1,6 @@
+# Add files and commands to this file, like the example:
+#   watch(%r{file/path}) { `command(s)` }
+#
+guard :shell do
+  watch(/(.*).txt/) {|m| `tail #{m[0]}` }
+end

data/lib/guard/super_shell/version.rb

@@ -0,0 +1,5 @@
+module Guard
+  module SuperShellVersion
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: guard-super_shell
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robin Daugherty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-09 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+description: |2
+      Runs a shell command when specific files change. Shows the output
+      and a notification based on the command's return status.
+      Runs command once per _set_ of file changes.
+email: robin@robindaugherty.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/guard/super_shell.rb
+- lib/guard/super_shell/templates/Guardfile
+- lib/guard/super_shell/version.rb
+homepage: http://github.com/RobinDaugherty/guard-super_shell
+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: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Guard plugin that simply runs a shell command
+test_files: []