rundoc 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64447cf981514498089c30f81d5a9885059db08ac2120b8bb700eed4089d0105
-  data.tar.gz: b46c802f280388c043adddcdfbe0a385fcf2bee8aa4c1fd76563452c7d24698c
+  metadata.gz: b6c32eddffc69778c7661f3c38ce6bc4c5f9a06dc18f46a737de2dfca2382fe8
+  data.tar.gz: cb1d8d74338a9dc4b8b39a9d6d21a51d6d89728ae14147ab2b9e9aa71a335e4b
 SHA512:
-  metadata.gz: cf89810f545312fd23e6759015473f5d64e9991f7348344649a4b672a3e97e774702ec04d5d3b91f64b8ebb14caecf78ac0f2d583d423b1c3f25c1915eaa1e5a
-  data.tar.gz: 9b7f288a0b23806729f07690faf8ec1b295c45652e7db07253aba38019c50d0e30a1cfb4b9973cc97ef36ac78bb8a1139228ed9b9fc5cbf15658770817a13e5e
+  metadata.gz: 327b5690d7ac1ab8985e0d8d338d38e79af97bae4c683204594bdb8f7ed3c2461fb4cbbb90c058c77120de00b1af95ed3e6bd0573d92e39d248a32315938125d
+  data.tar.gz: 1571964f78dd43e9b742729106e294813b970229d0424ee9af44f97be22d1c9293324605a3e85b92b7396cdc427955cd73f7958c9ac60ccb6cc9fa0aa14b583e

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## HEAD
 
+## 1.1.3
+
+- Bugfix: Bash commands that output to stderr and use `||` are now captured (https://github.com/schneems/rundoc/pull/29)
+
 ## 1.1.2
 
 - Fix pipe support (https://github.com/schneems/rundoc/pull/28)

data/lib/rundoc/code_command/bash.rb

@@ -32,12 +32,13 @@ class Rundoc::CodeCommand::Bash < Rundoc::CodeCommand
   end
 
   def shell(cmd, stdin = nil)
+    cmd = "(#{cmd}) 2>&1"
     msg  = "Running: $ '#{cmd}'"
     msg  << " with stdin: '#{stdin.inspect}'" if stdin && !stdin.empty?
     puts msg
 
     result = ""
-    IO.popen("#{cmd} 2>&1", "w+") do |io|
+    IO.popen(cmd, "w+") do |io|
       io << stdin if stdin
       io.close_write
       result = sanitize_escape_chars io.read
@@ -54,4 +55,4 @@ Rundoc.register_code_command(:bash, Rundoc::CodeCommand::Bash)
 Rundoc.register_code_command(:'$',  Rundoc::CodeCommand::Bash)
 Rundoc.register_code_command(:'fail.$',  Rundoc::CodeCommand::Bash)
 
-require 'rundoc/code_command/bash/cd'
+require 'rundoc/code_command/bash/cd'

data/lib/rundoc/version.rb

@@ -1,3 +1,3 @@
 module Rundoc
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/test/fixtures/rails_4/rundoc.md

@@ -9,7 +9,7 @@ end
 ```
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_4/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_4/rundoc.md
 -->
 
 > warning
@@ -224,15 +224,18 @@ Make sure you are in the directory that contains your Rails app, then create an
 You can verify that the remote was added to your project by running
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you may deploy your code. After you deploy your code, you will need to migrate your database, make sure it is properly scaled and use logs to debug any issues that come up.
 
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
@@ -394,7 +397,7 @@ Looks good, so press Ctrl-C to exit and you can deploy your changes to Heroku:
 ```term
 :::> $ git add .
 :::> $ git commit -m "use puma via procfile"
-:::> $ git push heroku master
+:::> $ git push heroku main
 ```
 
 Check `ps`, you'll see the web process uses your new command specifying Puma as the web server

data/test/fixtures/rails_5/rundoc.md

@@ -9,7 +9,7 @@ end
 ```
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_5/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_5/rundoc.md
 
   Command:
   $ bin/rundoc build --path test/fixtures/rails_5/rundoc.md
@@ -215,15 +215,19 @@ Make sure you are in the directory that contains your Rails app, then create an
 You can verify that the remote was added to your project by running:
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise you can deploy your code. After you deploy your code, you  need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
 
+
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.
@@ -370,7 +374,7 @@ Looks good, so press `Ctrl+C` to exit and you can deploy your changes to Heroku:
 ```term
 :::>- $ git add .
 :::>- $ git commit -m "use puma via procfile"
-:::>- $ git push heroku master
+:::>- $ git push heroku main
 ```
 
 Check `ps`. You'll see that the web process uses your new command specifying Puma as the web server.

data/test/fixtures/rails_6/rundoc.md

@@ -10,7 +10,7 @@ end
 
 <!--
   rundoc src:
-  https://github.com/schneems/rundoc/blob/master/test/fixtures/rails_6/rundoc.md
+  https://github.com/schneems/rundoc/blob/main/test/fixtures/rails_6/rundoc.md
 
   Command:
   $ bin/rundoc build --path test/fixtures/rails_6/rundoc.md
@@ -214,15 +214,18 @@ Make sure you are in the directory that contains your Rails app, then create an
 You can verify that the remote was added to your project by running:
 
 ```term
-:::>> $ git config --list | grep heroku
+:::>> $ git config --list --local | grep heroku
 ```
 
 If you see `fatal: not in a git directory` then you are likely not in the correct directory. Otherwise, you can deploy your code. After you deploy your code, you need to migrate your database, make sure it is properly scaled, and use logs to debug any issues that come up.
 
+>note
+>Following changes in the industry, Heroku has updated our default git branch name to `main`. If the project you’re deploying uses `master` as its default branch name, use `git push heroku master`.
+
 Deploy your code:
 
 ```term
-:::>> $ git push heroku main || git push heroku master
+:::>> $ git push heroku main
 ```
 
 It is always a good idea to check to see if there are any warnings or errors in the output. If everything went well you can migrate your database.

data/test/rundoc/code_commands/bash_test.rb

@@ -11,6 +11,13 @@ class BashTest < Minitest::Test
     Dir.chdir(original_dir.strip)
   end
 
+  def test_bash_stderr_with_or_is_capture
+
+    command = "1>&2 echo 'msg to STDERR 1' || 1>&2 echo 'msg to STDERR 2'"
+    bash = Rundoc::CodeCommand::Bash.new(command)
+    assert_equal "$ #{command}", bash.to_md
+    assert_equal "msg to STDERR 1\n",   bash.call
+  end
 
   def test_bash_shells_and_shows_correctly
     ["pwd", "ls"].each do |command|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor