rundoc 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e767697a50da725490c5a2af1dd2a8ef894c9fa79e8260230ec2a41000ffefa
-  data.tar.gz: b682ac2f59204b1a62edd00f46817c27a63c58a95c87fd312803d42a6dd7b668
+  metadata.gz: 64447cf981514498089c30f81d5a9885059db08ac2120b8bb700eed4089d0105
+  data.tar.gz: b46c802f280388c043adddcdfbe0a385fcf2bee8aa4c1fd76563452c7d24698c
 SHA512:
-  metadata.gz: cee0548716aa1cd4bb14f1eb21541dc010f5d8c706de49240b9e3245d847fbdfc08c34858a5ba7755d45d091671f3c712bd02a4d91e561927cae3b114780fd7f
-  data.tar.gz: aa340da522f964e0daeb3e7fd3b03bb340ecbe062a18c456474f00392ce660d0f28afdf427c99812013d4765b362e1bc11d1585330c8653118d1b8d0edd97d76
+  metadata.gz: cf89810f545312fd23e6759015473f5d64e9991f7348344649a4b672a3e97e774702ec04d5d3b91f64b8ebb14caecf78ac0f2d583d423b1c3f25c1915eaa1e5a
+  data.tar.gz: 9b7f288a0b23806729f07690faf8ec1b295c45652e7db07253aba38019c50d0e30a1cfb4b9973cc97ef36ac78bb8a1139228ed9b9fc5cbf15658770817a13e5e

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## master
+## HEAD
+
+## 1.1.2
+
+- Fix pipe support (https://github.com/schneems/rundoc/pull/28)
 
 ## 1.1.1
 

data/README.md

@@ -39,7 +39,7 @@ $ gem install rundoc
 or add it to your Gemfile:
 
 ```
-gem 'rundoc`
+gem 'rundoc'
 ```
 
 ## Use It
@@ -128,8 +128,6 @@ This code block might generate an output something like this to your markdown do
         Gemfile.lock  Rakefile  config    db    lib   public    test    vendor
     ```
 
-### Stdin
-
 Any items below the command will be passed into the stdin of the command. For example using a `$` command you can effectively pipe contents to stdin:
 
     ```
@@ -203,13 +201,13 @@ It looks like the command was run without any flags, but in reality `rails new m
 
 ## Rendering Cheat Sheet
 
-An arrow `>` is shorthand for "render this" and a dash `-` is shorthand for skip this section. The posions two positions are **command** first and **result** second.
+An arrow `>` is shorthand for "render this" and a dash `-` is shorthand for skip this section. The two positions are **command** first and **result** second.
 
 
-- `:::>-` (yes command, not result)
-- `:::>>` (yes command, yes result)
-- `:::--` (not command, not result)
-- `:::->` (not command, yes result)
+- `:::>-` (YES command output, not result output)
+- `:::>>` (YES command output, YES result output)
+- `:::--` (not command output, not result output)
+- `:::->` (not command output, YES result output)
 
 ## Shell Commands
 
@@ -463,7 +461,7 @@ You can configure your docs in your docs use the `RunDOC` command
 
 Note: Make sure you run this as a hidden command (with `-`).
 
-** After Build**
+**After Build**
 
 This will eval any code you put under that line (in Ruby). If you want to run some code after you're done building your docs you could use `Rundoc.configure` block and call the `after_build` method like this:
 
@@ -500,7 +498,7 @@ Sometimes sensitive info like usernames, email addresses, or passwords may be in
     ```
     :::-- rundoc.configure
     Rundoc.configure do |config|
-      config.filter_sensitive("schneems@exmaple.com" => "developer@example.com")
+      config.filter_sensitive("schneems@example.com" => "developer@example.com")
     end
     ```
 
@@ -508,4 +506,4 @@ This command `filter_sensitive` can be called multiple times with different valu
 
 ## Copyright
 
-All content Copyright Richard Schneeman © 2019
+All content Copyright Richard Schneeman © 2020

data/lib/rundoc/code_command/pipe.rb

@@ -8,6 +8,7 @@ module Rundoc
       def initialize(line)
         @delegate = parse(line)
       end
+
       # before: "",
       # after:  "",
       # commands:
@@ -25,15 +26,14 @@ module Rundoc
       end
 
       private def parse(code)
-        parser = Rundoc::PegParser.new.command
+        parser = Rundoc::PegParser.new.method_call
         tree = parser.parse(code)
         actual = Rundoc::PegTransformer.new.apply(tree)
 
-        if actual.is_a?(Array)
-          return actual.first
-        else
-          return actual
-        end
+        actual = actual.first if actual.is_a?(Array)
+
+        actual = Rundoc::CodeCommand::Bash.new(code) if actual.is_a?(Rundoc::CodeCommand::NoSuchCommand)
+        return actual
 
       # Since `| tail -n 2` does not start with a `$` assume any "naked" commands
       # are bash

data/lib/rundoc/version.rb

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

data/test/fixtures/rails_6/rundoc.md

@@ -19,7 +19,7 @@ end
 Ruby on Rails is a popular web framework written in [Ruby](http://www.ruby-lang.org/). This guide covers using Rails 6 on Heroku. For information on running previous versions of Rails on Heroku, see the tutorial for [Rails 5.x](getting-started-with-rails5) or [Rails 4.x](getting-started-with-rails4).
 
 ```
-:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.5'"
+:::-- $ ruby -e "exit 1 unless RUBY_VERSION == '2.6.6'"
 ```
 
 For this guide you will need:
@@ -157,13 +157,13 @@ end
 
 ## Specify your Ruby version
 
-Rails 6 requires Ruby 2.2.0 or above. Heroku has a recent version of Ruby installed by default, however you can specify an exact version by using the `ruby` DSL in your `Gemfile`. Depending on your version of Ruby that you are currently running it might look like this:
+Rails 6 requires Ruby 2.5.0 or above. Heroku has a recent version of Ruby installed by default, however you can specify an exact version by using the `ruby` DSL in your `Gemfile`. Depending on your version of Ruby that you are currently running it might look like this:
 
 
 ```ruby
 :::-- $ sed -i'' -e '/^ruby/d' ./Gemfile
 :::-> file.append Gemfile#4
-ruby "2.6.5"
+ruby "2.6.6"
 ```
 
 You should also be running the same version of Ruby locally. You can check this by running `$ ruby -v`. You can get more information on [specifying your Ruby version on Heroku here](https://devcenter.heroku.com/articles/ruby-versions).
@@ -222,7 +222,7 @@ If you see `fatal: not in a git directory` then you are likely not in the correc
 Deploy your code:
 
 ```term
-:::>> $ git push heroku master
+:::>> $ git push heroku main || git push heroku master
 ```
 
 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.
@@ -376,7 +376,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 || git push heroku master
 ```
 
 Check `ps`. You'll see that the web process uses your new command specifying Puma as the web server.

data/test/rundoc/code_commands/pipe_test.rb

@@ -1,7 +1,6 @@
 require 'test_helper'
 
 class PipeTest < Minitest::Test
-
   def test_pipe
     pipe_cmd = "tail -n 2"
     cmd      = "ls"
@@ -12,4 +11,15 @@ class PipeTest < Minitest::Test
     expected = `#{cmd} | #{pipe_cmd}`
     assert_equal expected, actual
   end
+
+  def test_moar_pipe_with_dollar
+    pipe_cmd = "tail -n 2"
+    cmd      = "ls"
+    out      = `#{cmd}`
+    pipe     = Rundoc::CodeCommand::Pipe.new("$ #{pipe_cmd}")
+    actual   = pipe.call(commands: [{command: cmd, output: out}])
+
+    expected = `#{cmd} | #{pipe_cmd}`
+    assert_equal expected, actual
+  end
 end

data/test/rundoc/peg_parser_test.rb

@@ -116,6 +116,16 @@ class PegParserTest < Minitest::Test
     assert_equal false, actual.result?
   end
 
+  def test_blerg_method_call
+    input = %Q{$ cat foo.rb}
+    parser = Rundoc::PegParser.new.method_call
+    tree = parser.parse_with_debug(input)
+
+    actual = @transformer.apply(tree)
+    assert_equal :"$", actual.keyword
+    assert_equal("cat foo.rb", actual.original_args)
+  end
+
   def test_command
     input = %Q{:::>> $ cat foo.rb\n}
     parser = Rundoc::PegParser.new.command

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rundoc
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Richard Schneeman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -225,7 +225,7 @@ homepage: https://github.com/schneems/rundoc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,8 +240,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: RunDOC generates runable code from docs
 test_files: