markdown_helper 2.3.0 → 2.4.0

data/markdown/use_cases/run_irb/run_irb.rb

@@ -0,0 +1,5 @@
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new(:pristine => true)
+markdown_helper.run_irb('template.md', 'markdown.md')

data/markdown/use_cases/run_irb/run_irb/markdown.md

@@ -0,0 +1,43 @@
+# About Hashes
+
+Create a hash:
+
+```ruby
+h = {}
+p h.class
+Hash
+p h
+{}
+```
+
+Initialize a hash:
+
+```ruby
+h = {:a => 0, :b => 1}
+p h
+{:a=>0, :b=>1}
+```
+
+Change a value:
+
+```ruby
+h[:b] = 2
+p h
+{:a=>0, :b=>2}
+```
+
+Add a new entry:
+
+```ruby
+h[:c] = 2
+p h
+{:a=>0, :b=>2, :c=>2}
+```
+
+Delete an entry:
+
+```ruby
+h.delete(:a)
+p h
+{:b=>2, :c=>2}
+```

data/markdown/use_cases/run_irb/run_irb/template.md

@@ -0,0 +1,37 @@
+# About Hashes
+
+Create a hash:
+
+```#run_irb
+h = {}
+p h.class
+p h
+```
+
+Initialize a hash:
+
+```#run_irb
+h = {:a => 0, :b => 1}
+p h
+```
+
+Change a value:
+
+```#run_irb
+h[:b] = 2
+p h
+```
+
+Add a new entry:
+
+```#run_irb
+h[:c] = 2
+p h
+```
+
+Delete an entry:
+
+```#run_irb
+h.delete(:a)
+p h
+```

data/markdown/use_cases/run_irb/run_irb/use_case.md

@@ -0,0 +1,178 @@
+### Run Irb
+
+Use the ```run_irb``` feature to execute selected Ruby snippets in the Ruby interactive shell, ```irb```.
+
+This allows you to interleave *any* markdown (usually explanatory text, but actually anything) with the Ruby snippets.
+
+In the example template below, snippets of Ruby are interleaved with other markdown elements.
+
+Each Ruby snippet that's to be executed in ```irb``` is bracketed by pragmas <code>\`\`\`#run_irb</code> and <code>\`\`\`</code>.
+
+In the example, each snippet has some Ruby code that shows values using method ```p```.
+
+<pre>
+# About Hashes
+
+Create a hash:
+
+```#run_irb
+h = {}
+p h.class
+p h
+```
+
+Initialize a hash:
+
+```#run_irb
+h = {:a => 0, :b => 1}
+p h
+```
+
+Change a value:
+
+```#run_irb
+h[:b] = 2
+p h
+```
+
+Add a new entry:
+
+```#run_irb
+h[:c] = 2
+p h
+```
+
+Delete an entry:
+
+```#run_irb
+h.delete(:a)
+p h
+```</pre>
+
+#### Run Irb Via <code>markdown_helper</code>
+<details>
+<summary>CLI</summary>
+
+```sh
+markdown_helper run_irb --pristine template.md markdown.md
+```
+
+(Option ```--pristine``` suppresses comment insertion.)
+</details>
+<details>
+<summary>API</summary>
+
+```run_irb.rb```:
+```ruby
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new(:pristine => true)
+markdown_helper.run_irb('template.md', 'markdown.md')
+```
+
+</details>
+
+The resulting markdown (raw) shows the output from ```irb``` for each snippet:
+
+<pre>
+# About Hashes
+
+Create a hash:
+
+```ruby
+h = {}
+p h.class
+Hash
+p h
+{}
+```
+
+Initialize a hash:
+
+```ruby
+h = {:a => 0, :b => 1}
+p h
+{:a=>0, :b=>1}
+```
+
+Change a value:
+
+```ruby
+h[:b] = 2
+p h
+{:a=>0, :b=>2}
+```
+
+Add a new entry:
+
+```ruby
+h[:c] = 2
+p h
+{:a=>0, :b=>2, :c=>2}
+```
+
+Delete an entry:
+
+```ruby
+h.delete(:a)
+p h
+{:b=>2, :c=>2}
+```
+</pre>
+
+Resulting markdown (rendered):
+
+---
+
+# About Hashes
+
+Create a hash:
+
+```ruby
+h = {}
+p h.class
+Hash
+p h
+{}
+```
+
+Initialize a hash:
+
+```ruby
+h = {:a => 0, :b => 1}
+p h
+{:a=>0, :b=>1}
+```
+
+Change a value:
+
+```ruby
+h[:b] = 2
+p h
+{:a=>0, :b=>2}
+```
+
+Add a new entry:
+
+```ruby
+h[:c] = 2
+p h
+{:a=>0, :b=>2, :c=>2}
+```
+
+Delete an entry:
+
+```ruby
+h.delete(:a)
+p h
+{:b=>2, :c=>2}
+```
+
+---
+
+
+
+
+
+

data/markdown/use_cases/run_irb/run_irb/use_case_template.md

@@ -0,0 +1,33 @@
+### Run Irb
+
+Use the ```run_irb``` feature to execute selected Ruby snippets in the Ruby interactive shell, ```irb```.
+
+This allows you to interleave *any* markdown (usually explanatory text, but actually anything) with the Ruby snippets.
+
+In the example template below, snippets of Ruby are interleaved with other markdown elements.
+
+Each Ruby snippet that's to be executed in ```irb``` is bracketed by pragmas <code>\`\`\`#run_irb</code> and <code>\`\`\`</code>.
+
+In the example, each snippet has some Ruby code that shows values using method ```p```.
+
+@[:pre](template.md)
+
+@[:markdown](../interface.md)
+
+The resulting markdown (raw) shows the output from ```irb``` for each snippet:
+
+@[:pre](markdown.md)
+
+Resulting markdown (rendered):
+
+---
+
+@[:markdown](markdown.md)
+
+---
+
+
+
+
+
+

data/markdown/use_cases/use_cases.md

@@ -1,17 +1,20 @@
 # Use Cases
 
-## Include Files
+## Include
 
-* [Reuse Text](include_files/reuse_text/use_case.md#reuse-text)
-* [Nest Inclusions](include_files/nest_inclusions/use_case.md#nest-inclusions)
-* [Include Markdown](include_files/include_markdown/use_case.md#include-markdown)
-* [Include Code Block](include_files/include_code_block/use_case.md#include-code-block)
-* [Include Highlighted Code](include_files/include_highlighted_code/use_case.md#include-highlighted-code)
-* [Include Page TOC](include_files/include_page_toc/use_case.md#include-page-toc)
-* [Include Text As Details](include_files/include_text_as_details/use_case.md#include-text-as-details)
-* [Include Text As Comment](include_files/include_text_as_comment/use_case.md#include-text-as-comment)
-* [Include Text As Pre](include_files/include_text_as_pre/use_case.md#include-text-as-pre)
-* [Include Generated Text](include_files/include_generated_text/use_case.md#include-generated-text)
-* [Include with Added Comments](include_files/include_with_added_comments/use_case.md#include-with-added-comments)
-* [Diagnose Missing Includee](include_files/diagnose_missing_includee/use_case.md#diagnose-missing-includee)
-* [Diagnose Circular Includes](include_files/diagnose_circular_includes/use_case.md#diagnose-circular-includes)
+* [Reuse Text](include/reuse_text/use_case.md#reuse-text)
+* [Nest Inclusions](include/nest_inclusions/use_case.md#nest-inclusions)
+* [Include Markdown](include/include_markdown/use_case.md#include-markdown)
+* [Include Code Block](include/include_code_block/use_case.md#include-code-block)
+* [Include Highlighted Code](include/include_highlighted_code/use_case.md#include-highlighted-code)
+* [Include Page TOC](include/include_page_toc/use_case.md#include-page-toc)
+* [Include Text As Details](include/include_text_as_details/use_case.md#include-text-as-details)
+* [Include Text As Comment](include/include_text_as_comment/use_case.md#include-text-as-comment)
+* [Include Text As Pre](include/include_text_as_pre/use_case.md#include-text-as-pre)
+* [Include Generated Text](include/include_generated_text/use_case.md#include-generated-text)
+* [Include with Added Comments](include/include_with_added_comments/use_case.md#include-with-added-comments)
+* [Diagnose Missing Includee](include/diagnose_missing_includee/use_case.md#diagnose-missing-includee)
+* [Diagnose Circular Includes](include/diagnose_circular_includes/use_case.md#diagnose-circular-includes)
+## Run Irb
+
+* [Run Irb](run_irb/run_irb/use_case.md#run-irb)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-13 00:00:00.000000000 Z
+date: 2019-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -88,6 +88,7 @@ files:
 - Rakefile
 - _config.yml
 - bin/_include
+- bin/_run_irb
 - bin/console
 - bin/include
 - bin/markdown_helper
@@ -96,6 +97,9 @@ files:
 - images/image.png
 - images/include.png
 - lib/markdown_helper.rb
+- lib/markdown_helper/markdown_helper.rb
+- lib/markdown_helper/markdown_includer.rb
+- lib/markdown_helper/markdown_irb_runner.rb
 - lib/markdown_helper/version.rb
 - lib/string_helper.rb
 - markdown/readme/README.template.md
@@ -108,77 +112,83 @@ files:
 - markdown/readme/resolve.md
 - markdown/readme/verbatim_ruby_template.md
 - markdown/use_cases/Rakefile
-- markdown/use_cases/include_files/diagnose_circular_includes/diagnose_circular_includes.err
-- markdown/use_cases/include_files/diagnose_circular_includes/includer.md
-- markdown/use_cases/include_files/diagnose_circular_includes/includer_0.md
-- markdown/use_cases/include_files/diagnose_circular_includes/includer_1.md
-- markdown/use_cases/include_files/diagnose_circular_includes/includer_2.md
-- markdown/use_cases/include_files/diagnose_circular_includes/use_case.md
-- markdown/use_cases/include_files/diagnose_circular_includes/use_case_template.md
-- markdown/use_cases/include_files/diagnose_missing_includee/diagnose_missing_includee.err
-- markdown/use_cases/include_files/diagnose_missing_includee/includer.md
-- markdown/use_cases/include_files/diagnose_missing_includee/includer_0.md
-- markdown/use_cases/include_files/diagnose_missing_includee/includer_1.md
-- markdown/use_cases/include_files/diagnose_missing_includee/includer_2.md
-- markdown/use_cases/include_files/diagnose_missing_includee/use_case.md
-- markdown/use_cases/include_files/diagnose_missing_includee/use_case_template.md
-- markdown/use_cases/include_files/include.rb
-- markdown/use_cases/include_files/include_code_block/hello.rb
-- markdown/use_cases/include_files/include_code_block/included.md
-- markdown/use_cases/include_files/include_code_block/includer.md
-- markdown/use_cases/include_files/include_code_block/use_case.md
-- markdown/use_cases/include_files/include_code_block/use_case_template.md
-- markdown/use_cases/include_files/include_generated_text/use_case.md
-- markdown/use_cases/include_files/include_generated_text/use_case_template.md
-- markdown/use_cases/include_files/include_highlighted_code/hello.rb
-- markdown/use_cases/include_files/include_highlighted_code/included.md
-- markdown/use_cases/include_files/include_highlighted_code/includer.md
-- markdown/use_cases/include_files/include_highlighted_code/use_case.md
-- markdown/use_cases/include_files/include_highlighted_code/use_case_template.md
-- markdown/use_cases/include_files/include_markdown/included.md
-- markdown/use_cases/include_files/include_markdown/includer.md
-- markdown/use_cases/include_files/include_markdown/markdown.md
-- markdown/use_cases/include_files/include_markdown/use_case.md
-- markdown/use_cases/include_files/include_markdown/use_case_template.md
-- markdown/use_cases/include_files/include_page_toc/included.md
-- markdown/use_cases/include_files/include_page_toc/includer.md
-- markdown/use_cases/include_files/include_page_toc/markdown_0.md
-- markdown/use_cases/include_files/include_page_toc/markdown_1.md
-- markdown/use_cases/include_files/include_page_toc/use_case.md
-- markdown/use_cases/include_files/include_page_toc/use_case_template.md
-- markdown/use_cases/include_files/include_text_as_comment/hello.rb
-- markdown/use_cases/include_files/include_text_as_comment/included.md
-- markdown/use_cases/include_files/include_text_as_comment/includer.md
-- markdown/use_cases/include_files/include_text_as_comment/use_case.md
-- markdown/use_cases/include_files/include_text_as_comment/use_case_template.md
-- markdown/use_cases/include_files/include_text_as_details/details.md
-- markdown/use_cases/include_files/include_text_as_details/included.md
-- markdown/use_cases/include_files/include_text_as_details/includer.md
-- markdown/use_cases/include_files/include_text_as_details/use_case.md
-- markdown/use_cases/include_files/include_text_as_details/use_case_template.md
-- markdown/use_cases/include_files/include_text_as_pre/included.md
-- markdown/use_cases/include_files/include_text_as_pre/includer.md
-- markdown/use_cases/include_files/include_text_as_pre/triple_backtick.md
-- markdown/use_cases/include_files/include_text_as_pre/use_case.md
-- markdown/use_cases/include_files/include_text_as_pre/use_case_template.md
-- markdown/use_cases/include_files/include_with_added_comments/included.md
-- markdown/use_cases/include_files/include_with_added_comments/includee.md
-- markdown/use_cases/include_files/include_with_added_comments/includer.md
-- markdown/use_cases/include_files/include_with_added_comments/use_case.md
-- markdown/use_cases/include_files/include_with_added_comments/use_case_template.md
-- markdown/use_cases/include_files/interface.md
-- markdown/use_cases/include_files/nest_inclusions/included.md
-- markdown/use_cases/include_files/nest_inclusions/includee.md
-- markdown/use_cases/include_files/nest_inclusions/includer.md
-- markdown/use_cases/include_files/nest_inclusions/nested_includee.md
-- markdown/use_cases/include_files/nest_inclusions/use_case.md
-- markdown/use_cases/include_files/nest_inclusions/use_case_template.md
-- markdown/use_cases/include_files/reuse_text/included.md
-- markdown/use_cases/include_files/reuse_text/includee.md
-- markdown/use_cases/include_files/reuse_text/includer.md
-- markdown/use_cases/include_files/reuse_text/use_case.md
-- markdown/use_cases/include_files/reuse_text/use_case_template.md
+- markdown/use_cases/include/diagnose_circular_includes/diagnose_circular_includes.err
+- markdown/use_cases/include/diagnose_circular_includes/includer.md
+- markdown/use_cases/include/diagnose_circular_includes/includer_0.md
+- markdown/use_cases/include/diagnose_circular_includes/includer_1.md
+- markdown/use_cases/include/diagnose_circular_includes/includer_2.md
+- markdown/use_cases/include/diagnose_circular_includes/use_case.md
+- markdown/use_cases/include/diagnose_circular_includes/use_case_template.md
+- markdown/use_cases/include/diagnose_missing_includee/diagnose_missing_includee.err
+- markdown/use_cases/include/diagnose_missing_includee/includer.md
+- markdown/use_cases/include/diagnose_missing_includee/includer_0.md
+- markdown/use_cases/include/diagnose_missing_includee/includer_1.md
+- markdown/use_cases/include/diagnose_missing_includee/includer_2.md
+- markdown/use_cases/include/diagnose_missing_includee/use_case.md
+- markdown/use_cases/include/diagnose_missing_includee/use_case_template.md
+- markdown/use_cases/include/include.rb
+- markdown/use_cases/include/include_code_block/hello.rb
+- markdown/use_cases/include/include_code_block/included.md
+- markdown/use_cases/include/include_code_block/includer.md
+- markdown/use_cases/include/include_code_block/use_case.md
+- markdown/use_cases/include/include_code_block/use_case_template.md
+- markdown/use_cases/include/include_generated_text/use_case.md
+- markdown/use_cases/include/include_generated_text/use_case_template.md
+- markdown/use_cases/include/include_highlighted_code/hello.rb
+- markdown/use_cases/include/include_highlighted_code/included.md
+- markdown/use_cases/include/include_highlighted_code/includer.md
+- markdown/use_cases/include/include_highlighted_code/use_case.md
+- markdown/use_cases/include/include_highlighted_code/use_case_template.md
+- markdown/use_cases/include/include_markdown/included.md
+- markdown/use_cases/include/include_markdown/includer.md
+- markdown/use_cases/include/include_markdown/markdown.md
+- markdown/use_cases/include/include_markdown/use_case.md
+- markdown/use_cases/include/include_markdown/use_case_template.md
+- markdown/use_cases/include/include_page_toc/included.md
+- markdown/use_cases/include/include_page_toc/includer.md
+- markdown/use_cases/include/include_page_toc/markdown_0.md
+- markdown/use_cases/include/include_page_toc/markdown_1.md
+- markdown/use_cases/include/include_page_toc/use_case.md
+- markdown/use_cases/include/include_page_toc/use_case_template.md
+- markdown/use_cases/include/include_text_as_comment/hello.rb
+- markdown/use_cases/include/include_text_as_comment/included.md
+- markdown/use_cases/include/include_text_as_comment/includer.md
+- markdown/use_cases/include/include_text_as_comment/use_case.md
+- markdown/use_cases/include/include_text_as_comment/use_case_template.md
+- markdown/use_cases/include/include_text_as_details/details.md
+- markdown/use_cases/include/include_text_as_details/included.md
+- markdown/use_cases/include/include_text_as_details/includer.md
+- markdown/use_cases/include/include_text_as_details/use_case.md
+- markdown/use_cases/include/include_text_as_details/use_case_template.md
+- markdown/use_cases/include/include_text_as_pre/included.md
+- markdown/use_cases/include/include_text_as_pre/includer.md
+- markdown/use_cases/include/include_text_as_pre/triple_backtick.md
+- markdown/use_cases/include/include_text_as_pre/use_case.md
+- markdown/use_cases/include/include_text_as_pre/use_case_template.md
+- markdown/use_cases/include/include_with_added_comments/included.md
+- markdown/use_cases/include/include_with_added_comments/includee.md
+- markdown/use_cases/include/include_with_added_comments/includer.md
+- markdown/use_cases/include/include_with_added_comments/use_case.md
+- markdown/use_cases/include/include_with_added_comments/use_case_template.md
+- markdown/use_cases/include/interface.md
+- markdown/use_cases/include/nest_inclusions/included.md
+- markdown/use_cases/include/nest_inclusions/includee.md
+- markdown/use_cases/include/nest_inclusions/includer.md
+- markdown/use_cases/include/nest_inclusions/nested_includee.md
+- markdown/use_cases/include/nest_inclusions/use_case.md
+- markdown/use_cases/include/nest_inclusions/use_case_template.md
+- markdown/use_cases/include/reuse_text/included.md
+- markdown/use_cases/include/reuse_text/includee.md
+- markdown/use_cases/include/reuse_text/includer.md
+- markdown/use_cases/include/reuse_text/use_case.md
+- markdown/use_cases/include/reuse_text/use_case_template.md
 - markdown/use_cases/pristine.md
+- markdown/use_cases/run_irb/interface.md
+- markdown/use_cases/run_irb/run_irb.rb
+- markdown/use_cases/run_irb/run_irb/markdown.md
+- markdown/use_cases/run_irb/run_irb/template.md
+- markdown/use_cases/run_irb/run_irb/use_case.md
+- markdown/use_cases/run_irb/run_irb/use_case_template.md
 - markdown/use_cases/structure.md
 - markdown/use_cases/use_case.rb
 - markdown/use_cases/use_cases.md