slightish 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8dcf08230b1ba15f62dfe96a21b16a320603501e
-  data.tar.gz: b651c070d9f46f071709a10cce04b1208856a8a8
+  metadata.gz: 51b6f31fd54515ff6b59a63f80ddfce65eeb5703
+  data.tar.gz: 16efeba26b6cb63d64557a01ac35ea0718e30be4
 SHA512:
-  metadata.gz: bca0ad40555d5ce4b79c2a657fe6ddafa2f8825f3913e202c735fd98d70ea3dba8130db90bd498d8321d06b9f4fd98e49c5fe58699a165fea4d05fc1f02765a5
-  data.tar.gz: e1a340b606a1e38ec9919a77a3843c9e6493bf34defd56fa437571850837f044ec0a8bc8f81230e08b0a9825b10ea87ef55fed94f2e5b012cd60fe47166d45aa
+  metadata.gz: c59d7efd070ec46a902d998c7c01c5f276ceb097e69b1259df9dc7eedb48a61593865fef9df5c37b47926a16618e7280f1b90a5df31efe1aa68f3bf7dd89dae5
+  data.tar.gz: 007865b79838119a79e91853dd11f129fc25526061ddde39a024b22e4a78a353da904507369ec5f4397dbef4ec0a427e77c54dc9e889927615b8ea30246541e6

data/Gemfile

@@ -5,9 +5,9 @@ gemspec
 
 group :development do
   gem 'bundler'
+  gem 'coveralls'
   gem 'minitest'
   gem 'rake'
   gem 'rubocop'
   gem 'simplecov'
-  gem 'coveralls'
 end

data/README.md

@@ -2,7 +2,7 @@
 
 *Literate testing of shell scripts*
 
-[![Build Status](https://travis-ci.org/misterfifths/slightish.svg?branch=master)](https://travis-ci.org/misterfifths/slightish) [![Coverage Status](https://coveralls.io/repos/github/misterfifths/slightish/badge.svg?branch=master)](https://coveralls.io/github/misterfifths/slightish?branch=master) [![npm](https://img.shields.io/gem/v/slightish.svg)](https://rubygems.org/gems/slightish)
+[![Build Status](https://travis-ci.org/misterfifths/slightish.svg?branch=master)](https://travis-ci.org/misterfifths/slightish) [![Coverage Status](https://coveralls.io/repos/github/misterfifths/slightish/badge.svg?branch=master)](https://coveralls.io/github/misterfifths/slightish?branch=master) [![GPA](https://img.shields.io/codeclimate/github/misterfifths/slightish.svg)](https://codeclimate.com/github/misterfifths/slightish) [![npm](https://img.shields.io/gem/v/slightish.svg)](https://rubygems.org/gems/slightish)
 
 
 ### What's this then?
@@ -38,9 +38,9 @@ $ echo stdout; echo stderr >&2; echo "more stdout"; exit 2
 
 That example covers 90% of the functionality. The syntax in detail works like this:
 
-- Lines that start with `$ ` are interpreted as commands to run in the shell. The `$` must be in the first column of the file and must be followed by a space.
-- Lines starting with `| ` specify the stdout of the most recent command. As with `$ `, the `|` must be in the first column and must be followed by a space. You may specify more than one `| ` line to test for multiline output.
-- Lines starting with `@ ` specify the stderr of the most recent command. You may also specify more than one `@ ` line per command.
+- Lines that start with `$ ` are interpreted as commands to run in the shell. The `$` must be in the first column of the file and must be followed by a space.
+- Lines starting with `| ` specify the stdout of the most recent command. As with `$ `, the `|` must be in the first column and must be followed by a space. You may specify more than one `| ` line to test for multiline output.
+- Lines starting with `@ ` specify the stderr of the most recent command. You may also specify more than one `@ ` line per command to test for multiline output on stderr.
 - A line of the form `? <positive integer>` specifies the expected exit code of the most recent command. You may omit a `? ` line for an expected exit code of zero.
 
 Specifying any of the above magic lines out of order is a syntax error; you must specify a command (`$ `), and then optionally stdout (`| `), stderr (`@ `), and the exit code (`? `). If a command is expected to produce no output and have an exit code of zero, you may omit everything but the `$ ` line:
@@ -60,7 +60,7 @@ slightish my-first-test.md my-second-test
 
 This will run all the tests in all the specified files, and output details about any failures. The command will exit with status code 1 if any tests fail.
 
-Let's add a failing test real quick:
+As a demonstration, let's add a failing test:
 
 ```sh
 $ exit 2
@@ -79,15 +79,44 @@ Expected exit code: 0
 Actual exit code: 2
 
 ----------
-README.md 	6 passed	1 failed
+README.md 	11 passed	1 failed
 
-Total tests: 7
-Passed: 6
+Total tests: 12
+Passed: 11
 Failed: 1
 ```
 
 ### More features
 
+#### Command and variable expansion
+
+Environmental variables in your command, stdout, and stderr are all expanded. The syntax is `$VARIABLE` or `${VARIABLE}`. Note that escaping and quoting of such strings is *not* supported; they will be expanded regardless.
+
+```sh
+$ echo $USER
+| $USER
+
+$ echo "${HOME}/dir"
+| ${HOME}/dir
+```
+
+Nonexistent environmental variables will not be expanded, and the original string will be passed through unaltered:
+
+```sh
+$ echo '$_TOTAL_NONSENSE_'
+| $_TOTAL_NONSENSE_
+```
+
+Subcommands are also expanded, using the syntax `$(cmd)` or `` `cmd` ``. Only the stdout of subcommands is captured. If a subcommand produces output on stderr, or has a nonzero exit status, a warning is printed.
+
+```sh
+$ echo "$(pwd)"
+| `pwd`
+
+$ echo `whoami`
+| $USER
+```
+
 #### Sandboxes
 
 Each test file is run in its own sandbox directory, so you can safely write to files if your tests require it:

data/Rakefile

@@ -11,7 +11,9 @@ end
 task default: :test
 
 desc 'Run rubocop'
-RuboCop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop) do
+  $VERBOSE = true
+end
 
 desc 'Run rubocop'
 task lint: :rubocop

data/lib/slightish/test_case.rb

@@ -42,42 +42,15 @@ class Slightish::TestCase
 
   def failure_description
     res = ''
+    res += output_failure_description('stdout', @expected_output, @actual_output) unless @expected_output == @actual_output
 
-    if @actual_output != (@expected_output || '')
-      if @expected_output.empty?
-        res += "Expected stdout: empty\n".red.bold
-      else
-        res += "Expected stdout:\n".red.bold
-        res += @expected_output.gray + "\n"
-      end
-
-      if @actual_output.empty?
-        res += 'Actual stdout: empty'.green.bold
-      else
-        res += "Actual stdout:\n".green.bold
-        res += @actual_output.gray
-      end
-    end
-
-    if @actual_error_output != (@expected_error_output || '')
-      res += "\n\n" unless res == ''
-      if @expected_error_output.empty?
-        res += "Expected stderr: empty\n".red.bold
-      else
-        res += "Expected stderr:\n".red.bold
-        res += (@expected_error_output || '').gray + "\n"
-      end
-
-      if @actual_error_output.empty?
-        res += 'Actual stderr: empty'.green.bold
-      else
-        res += "Actual stderr:\n".green.bold
-        res += @actual_error_output.gray
-      end
+    if @expected_error_output != @actual_error_output
+      res += "\n\n" unless res.empty?
+      res += output_failure_description('stderr', @expected_error_output, @actual_error_output)
     end
 
     if @actual_exit_code != @expected_exit_code
-      res += "\n\n" unless res == ''
+      res += "\n\n" unless res.empty?
       res += 'Expected exit code: '.red.bold + @expected_exit_code.to_s.gray + "\n"
       res += 'Actual exit code: '.green.bold + @actual_exit_code.to_s.gray
     end
@@ -87,7 +60,7 @@ class Slightish::TestCase
 
   def source_description
     if @start_line == @end_line
-      "#{@source_file}:@{@start_line}"
+      "#{@source_file}:#{@start_line}"
     else
       "#{@source_file}:#{@start_line}-#{@end_line}"
     end
@@ -124,6 +97,26 @@ class Slightish::TestCase
 
   private
 
+  def output_failure_description(name, expected, actual)
+    res = ''
+
+    if expected.empty?
+      res += "Expected #{name}: empty\n".red.bold
+    else
+      res += "Expected #{name}:\n".red.bold
+      res += expected.gray + "\n"
+    end
+
+    if actual.empty?
+      res += "Actual #{name}: empty".green.bold
+    else
+      res += "Actual #{name}:\n".green.bold
+      res += actual.gray
+    end
+
+    res
+  end
+
   def expand(sandbox)
     @command = @raw_command.expand(chdir: sandbox.path, source: source_description)
     @expected_output = (@raw_expected_output || '').expand(chdir: sandbox.path, source: source_description)

data/lib/slightish/version.rb

@@ -1,3 +1,3 @@
 module Slightish
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/lib/string_mixins.rb

@@ -52,6 +52,13 @@ class String
 
   private
 
+  def puts_warning(message, cmd, source)
+    s = "warning: #{message} ("
+    s += source + '; ' unless source.nil? || source.empty?
+    s += "'#{cmd}')"
+    $stderr.puts(s.yellow) unless ENV['SLIGHTISH_NO_WARNINGS']
+  end
+
   def capture_stdout_with_logging(cmd, chdir, source)
     if chdir.nil?
       stdout, stderr, status = Open3.capture3(cmd)
@@ -59,19 +66,8 @@ class String
       stdout, stderr, status = Open3.capture3(cmd, { chdir: chdir })
     end
 
-    unless stderr.empty?
-      message = 'warning: stderr from command substitution ('
-      message += source + '; ' unless source.nil? || source.empty?
-      message += "'#{cmd}') will be ignored"
-      $stderr.puts(message.yellow) unless ENV['SLIGHTISH_NO_WARNINGS']
-    end
-
-    unless status.exitstatus.zero?
-      message = "warning: nonzero exit code (#{status.exitstatus}) from command substitution ("
-      message += source + '; ' unless source.nil? || source.empty?
-      message += "'#{cmd}')"
-      $stderr.puts(message.yellow) unless ENV['SLIGHTISH_NO_WARNINGS']
-    end
+    puts_warning('stderr from command substitution will be ignored', cmd, source) unless stderr.empty?
+    puts_warning("nonzero exit code (#{status.exitstatus}) from command substitution", cmd, source) unless status.exitstatus.zero?
 
     stdout.chomp
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slightish
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Clem
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-14 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies: []
 description: slightish lets you write and run tests for shell tools in a simple, flexible
   syntax, intermingled with any other file format (Markdown, plain text, HTML). Your