jet_black 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 492919b04c06523b9dca80a4d30939272ae1d435ea83c183f94cae6ab7d11501
-  data.tar.gz: c5157a559982f91bfe2560a6283b96229dade980b35fd52f9e446c4e339772e5
+  metadata.gz: 3cb06cc77894ad09aa2a5c00da5226227b6416624ac7c02a0d0c558e457667c1
+  data.tar.gz: 494d96406354c2d46fd34ea105830ee54f2b84da23fe43167446d9ab41d3cad9
 SHA512:
-  metadata.gz: d2e3877e059b410b276486990e042722d134abb2c9a4111183a9fcfdd3f902bcd742ff426003fb4c44966e4f0d70ba651709f3833f1cc44048fd3ccddee6e764
-  data.tar.gz: ed0f71a6940b5cde28e0c61bcdcbcd76db183a0808a0d7d97d56ba476aab4f885954ab24386f2329c167972430a04d0591105273a93ee4e63a005647ad38df17
+  metadata.gz: b27d58676baaa1ef5d3513b0515398798aa137461e5eb649a8cd598e51bd24e344db543e67d68c2a12449e44808a775abc769fcc0adffd5e7bc0c0a22404f463
+  data.tar.gz: 99451118f6c55638e989f41c8ef83773c5f9e6fa86d281ae0087282e2ea6694788eed7637d47e02f9e431c4472782f10007cc4fcd1d6a9ccbf7720268075679a

data/.circleci/config.yml

@@ -1,43 +1,62 @@
+---
 version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.5
-    environment:
-      ENABLE_COVERAGE: 1
 
-    working_directory: ~/repo
+#-------------------------------------------------------------------------------
 
-    steps:
-      - checkout
+base_job: &base_job
+  working_directory: ~/repo
+  steps:
+    - checkout
 
-      - restore_cache:
-          keys:
+    - restore_cache:
+        keys:
           - v1-dependencies-{{ checksum "Gemfile.lock" }}
           # fallback to using the latest cache if no exact match is found
           - v1-dependencies-
 
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run:
-          name: run tests
-          command: |
-            mkdir /tmp/test-results
-            bundle exec rspec --format progress \
+    - run:
+        name: install dependencies
+        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+    - save_cache:
+        paths:
+          - ./vendor/bundle
+        key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+    - run:
+        name: run tests
+        command: |
+          mkdir /tmp/test-results
+          bundle exec rspec --format progress \
                             --format RspecJunitFormatter \
                             --out /tmp/test-results/rspec.xml
 
-      # collect reports
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
+    # collect reports
+    - store_test_results:
+        path: /tmp/test-results
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: test-results
+
+#-------------------------------------------------------------------------------
+
+jobs:
+  ruby-2.4:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.4
+  ruby-2.5:
+    <<: *base_job
+    docker:
+      - image: circleci/ruby:2.5
+    environment:
+      ENABLE_COVERAGE: 1
+
+#-------------------------------------------------------------------------------
+
+workflows:
+  version: 2
+  multiple-rubies:
+    jobs:
+      - ruby-2.5
+      - ruby-2.4

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.4.0
+
+- Scrub ANSI escape sequences in stdout and stderr
+- Allow environment variables to be unset
+
 ## v0.3.0
 
 - Allows `stdin` data to be provided when running commands

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.5-alpine
+
+RUN apk update && \
+    apk add git && \
+    mkdir -p /app/lib/jet_black
+
+WORKDIR /app
+
+COPY Gemfile* jet_black.gemspec /app/
+COPY lib/jet_black/version.rb /app/lib/jet_black/version.rb
+
+RUN bundle install --jobs=4 --retry=3
+
+COPY . /app

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jet_black (0.3.0)
+    jet_black (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -8,22 +8,22 @@ with [RSpec] in mind. Features:
 [RSpec]: http://rspec.info/
 
 - Each session takes place within a unique temporary directory, outside the project
-- Synchronously [run commands](#running-commands) then write assertions on the:
-  - `stdout` / `stderr` content
-  - exit status of the process
-- Conveniently manipulate files in the temporary directory:
+- Synchronously [run commands](#running-commands) then write assertions on:
+  - The `stdout` / `stderr` content
+  - The exit status of the process
+- Manipulate files in the temporary directory:
   - [Create files](#file-manipulation)
   - [Create executable files](#file-manipulation)
   - [Append content to files](#file-manipulation)
   - [Copy fixture files](#copying-fixture-files) from your project
-- Modify the environment without modifying the parent test process:
+- Modify the environment without changing the parent test process:
   - [Override environment variables](#environment-variable-overrides)
   - [Escape the current Bundler context](#clean-bundler-environment)
   - [Adjust `$PATH`](#path-prefix) to include your executable / Subject Under Test
 - [RSpec matchers](#rspec-matchers) (optional)
 
-The temporary directory is discarded after each spec. This means you can write
-& modify files and run commands (like `git init`) without worrying about tidying
+The temporary directory is discarded after each spec. This means you can write &
+modify files and run commands (like `git init`) without worrying about tidying
 up after or impacting your actual project.
 
 ## Setup
@@ -48,6 +48,8 @@ require "jet_black/rspec"
 Any specs you write in the `spec/black_box` folder will then have an inferred
 `:black_box` meta type, and the matchers will be available in those examples.
 
+#### Manual RSpec setup
+
 Alternatively you can manually include the matchers:
 
 ```ruby
@@ -114,30 +116,30 @@ TXT
 ### Copying fixture files
 
 It's ideal to create pertinent files inline within a spec, to provide context
-for the reader, but sometimes a large or non-readable file is best copied
-across.
+for the reader, but sometimes it's better to copy across a large or
+non-human-readable file.
 
-First create a fixture directory in your project, such as
-`spec/fixtures/black_box`. Then configure the fixture path in
-`spec/support/jet_black.rb`:
+1.    Create a fixture directory in your project, such as `spec/fixtures/black_box`.
 
-```ruby
-require "jet_black"
+2.    Configure the fixture path in `spec/support/jet_black.rb`:
 
-JetBlack.configure do |config|
-  config.fixture_directory = File.expand_path("../fixtures/black_box", __dir__)
-end
-```
+      ```ruby
+      require "jet_black"
 
-Now you can copy fixtures across into a session's temporary directory:
+      JetBlack.configure do |config|
+        config.fixture_directory = File.expand_path("../fixtures/black_box", __dir__)
+      end
+      ```
 
-```ruby
-session = JetBlack::Session.new
-session.copy_fixture("src-config.json", "config.json")
+3.    Copy fixtures across into a session's temporary directory:
 
-# Destination subdirectories are created for you:
-session.copy_fixture("src-config.json", "config/config.json")
-```
+      ```ruby
+      session = JetBlack::Session.new
+      session.copy_fixture("src-config.json", "config.json")
+
+      # Destination subdirectories are created for you:
+      session.copy_fixture("src-config.json", "config/config.json")
+      ```
 
 ### Environment variable overrides
 
@@ -148,6 +150,8 @@ result = subject.run("echo $FOO", env: { FOO: "bar" })
 result.stdout # => "bar"
 ```
 
+Provide a `nil` value to unset an environment variable.
+
 ### Clean Bundler environment
 
 If your project's test suite is invoked with Bundler (e.g. `bundle exec rspec`)
@@ -179,7 +183,7 @@ Configure the `path_prefix` to the directory containing with your executable(s):
 require "jet_black"
 
 JetBlack.configure do |config|
-  config.path_prefix = File.expand("../../bin", __dir__)
+  config.path_prefix = File.expand_path("../../bin", __dir__)
 end
 ```
 

data/bin/docker_test

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+set -euo pipefail
+
+docker build -t odlp/jet_black .
+docker run odlp/jet_black bundle exec rspec --tty

data/bin/jet_black_bin_example

@@ -1,3 +1,3 @@
-#!/usr/bin/env bash
+#!/bin/sh
 
 echo "Hello from example bin"

data/lib/jet_black/ansi_scrubber.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module JetBlack
+  class AnsiScrubber
+    ESCAPE_SEQUENCE = /
+      \x1B # ESC char - start of the sequence
+      (
+        [\x20-\x2F]*
+        [\x40-\x5A\x5C-\x7E]
+        |
+        \[           # Start CSI sequence
+        [\x30-\x3F]+ # CSI Parameter bytes
+        [\x20-\x2F]* # CSI Intermediate bytes
+        [\x40-\x7E]  # CSI Finishing byte
+      )
+    /x
+
+    def self.call(string)
+      string.gsub(ESCAPE_SEQUENCE, "")
+    end
+  end
+end

data/lib/jet_black/environment.rb

@@ -14,7 +14,7 @@ module JetBlack
 
     def stringify_env(env)
       env.map do |key, value|
-        [key.to_s, value.to_s]
+        [key.to_s, value&.to_s]
       end.to_h
     end
 

data/lib/jet_black/executed_command.rb

@@ -1,11 +1,16 @@
+require_relative "ansi_scrubber"
+
 module JetBlack
   class ExecutedCommand
-    attr_reader :raw_command, :stdout, :stderr, :exit_status
+    attr_reader :raw_command, :raw_stdout, :raw_stderr,
+                :stdout, :stderr, :exit_status
 
     def initialize(raw_command:, stdout:, stderr:, exit_status:)
       @raw_command = raw_command
-      @stdout = stdout.chomp
-      @stderr = stderr.chomp
+      @raw_stdout = stdout
+      @raw_stderr = stderr
+      @stdout = scrub(stdout)
+      @stderr = scrub(stderr)
       @exit_status = exit_status.to_i
     end
 
@@ -16,5 +21,11 @@ module JetBlack
     def failure?
       !success?
     end
+
+    private
+
+    def scrub(output_string)
+      AnsiScrubber.call(output_string.to_s.chomp)
+    end
   end
 end

data/lib/jet_black/version.rb

@@ -1,3 +1,3 @@
 module JetBlack
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jet_black
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Oli Peate
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-06 00:00:00.000000000 Z
+date: 2018-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,15 +118,18 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/docker_test
 - bin/jet_black_bin_example
 - bin/setup
 - jet_black.gemspec
 - lib/jet_black.rb
+- lib/jet_black/ansi_scrubber.rb
 - lib/jet_black/configuration.rb
 - lib/jet_black/environment.rb
 - lib/jet_black/errors.rb