markdown_helper 1.9.9 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e0a04d76854ae8481b445cf585ec71fd0758f13
-  data.tar.gz: 3f42eb714596c71add632f5cc7b131af9a343e36
+  metadata.gz: bd8b799693304f32aad8780f7d4ce734ae46614d
+  data.tar.gz: 703df7ba48954272c6bfe0e794b9150564f4d3cd
 SHA512:
-  metadata.gz: 860d4c5fdb2c862dbfcab19ac8bc397e286b838e2531e9457f1662d610b685e2ccc286cbc85a796a04e7bb51619978ed6be2dfd2f66fbe110ed46bcb268ec502
-  data.tar.gz: 32fbf0ed5a7dd3f0f0c3f6ab8c2d6d88d5e9a25f582a163d1a8dbde47d95d088fdfa4e146b39c04f4cba20ceb51f6480b191d653677aec50e332e0b4d5dbec4e
+  metadata.gz: efc921a959dd8f3c0cd39d0da08e13dcb6c51f7b82ab405d37e1faf6f4ff81218ae6264e8963e8aa8de67ebad4521145e9bd044c5b7eb4ced8e9003a6461919a
+  data.tar.gz: a91f66a74094c2bab6e87bbf98403ed168df5d817a4155f7440b9c7cca8c181171c02bea25d6fc6b882794bc617519f127e3a0da15b576ea3cb6e411bada3194

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    markdown_helper (1.9.9)
+    markdown_helper (2.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -10,11 +10,12 @@
 
 ## What's New?
 
-Page TOC:
+Treatments for included file:
 
-- Support is added for creating the table of contents for a markdown page.
-- The TOC is a tree of links to the headers on the page, suitable for inclusion with the page itself.
-- See the [use case](markdown/use_cases/tables_of_contents/create_and_include_page_toc/use_case.md#create-and-include-page-toc).
+- Support is added for including a file as a comment.  See the [use case](markdown/use_cases/include_files/include_text_as_comment/use_case.md#include-text-as-comment).
+- Support is added for including a file as pre-formatted.  See the [use case](markdown/use_cases/include_files/include_text_as_pre/use_case.md#include-text-as-pre).
+
+(The new version, 2.0.0, is not a major increment over version 1.9.9.  Numbers just ran out.)
 
 ## What's a Markdown Helper?
 

data/lib/markdown_helper/version.rb

@@ -1,3 +1,3 @@
 class MarkdownHelper
-  VERSION = '1.9.9'
+  VERSION = '2.0.0'
 end

data/markdown/readme/README.template.md

@@ -9,11 +9,12 @@
 
 ## What's New?
 
-Page TOC:
+Treatments for included file:
 
-- Support is added for creating the table of contents for a markdown page.
-- The TOC is a tree of links to the headers on the page, suitable for inclusion with the page itself.
-- See the [use case](markdown/use_cases/tables_of_contents/create_and_include_page_toc/use_case.md#create-and-include-page-toc).
+- Support is added for including a file as a comment.  See the [use case](markdown/use_cases/include_files/include_text_as_comment/use_case.md#include-text-as-comment).
+- Support is added for including a file as pre-formatted.  See the [use case](markdown/use_cases/include_files/include_text_as_pre/use_case.md#include-text-as-pre).
+
+(The new version, 2.0.0, is not a major increment over version 1.9.9.  Numbers just ran out.)
 
 ## What's a Markdown Helper?
 

data/markdown/use_cases/Rakefile

@@ -27,6 +27,8 @@ EOT
                 include_markdown
                 include_code_block
                 include_highlighted_code
+                include_text_as_comment
+                include_text_as_pre
                 include_generated_text
                 diagnose_missing_includee
                 diagnose_circular_includes
@@ -70,7 +72,6 @@ EOT
                   ensure
                   end
                 else
-                  p command
                   system(command)
                 end
               end

data/markdown/use_cases/include_files/include_text_as_comment/hello.rb

@@ -0,0 +1,8 @@
+class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello !"
+   end
+end

data/markdown/use_cases/include_files/include_text_as_comment/include_text_as_comment.rb

@@ -0,0 +1,72 @@
+require_relative '../include_use_case'
+
+class IncludeTextAsComment < IncludeUseCase
+
+  def self.build
+
+    use_case_name = File.basename(__FILE__, '.rb')
+    use_case = self.new(use_case_name)
+
+    includee_file_name = 'hello.rb'
+
+    use_case.files_to_write.store(
+        includee_file_name,
+        <<EOT
+class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello #{@name}!"
+   end
+end
+EOT
+    )
+
+    use_case.files_to_write.store(
+        INCLUDER_FILE_NAME,
+        <<EOT
+This file includes the code as a comment.
+
+@[:comment](#{includee_file_name})
+
+EOT
+    )
+
+    use_case.files_to_write.store(
+        TEMPLATE_FILE_NAME,
+        <<EOT
+### Include Text As Comment
+
+Use file inclusion to include text (or even code) as a comment.
+
+#### File to Be Included
+
+Here's a file containing code to be included:
+
+@[markdown](#{includee_file_name})
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](#{INCLUDER_FILE_NAME})
+
+The treatment token ```:comment``` specifies that the included text is to be treated as a comment.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the included comment:
+
+@[markdown](#{INCLUDED_FILE_NAME})
+
+EOT
+    )
+
+    use_case.build
+
+  end
+
+end

data/markdown/use_cases/include_files/include_text_as_comment/included.md

@@ -0,0 +1,12 @@
+This file includes the code as a comment.
+
+<!--class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello !"
+   end
+end
+-->
+

data/markdown/use_cases/include_files/include_text_as_comment/includer.md

@@ -0,0 +1,4 @@
+This file includes the code as a comment.
+
+@[:comment](hello.rb)
+

data/markdown/use_cases/include_files/include_text_as_comment/use_case.md

@@ -0,0 +1,87 @@
+### Include Text As Comment
+
+Use file inclusion to include text (or even code) as a comment.
+
+#### File to Be Included
+
+Here's a file containing code to be included:
+
+```hello.rb```:
+```markdown
+class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello !"
+   end
+end
+```
+
+#### Includer File
+
+Here's a template file that includes it:
+
+```includer.md```:
+```markdown
+This file includes the code as a comment.
+
+@[:comment](hello.rb)
+
+```
+
+The treatment token ```:comment``` specifies that the included text is to be treated as a comment.
+
+#### CLI
+
+You can use the command-line interface to perform the inclusion.
+
+##### Command
+
+```sh
+markdown_helper include --pristine includer.md included.md
+```
+
+(Option ```--pristine``` suppresses comment insertion.)
+
+#### API
+
+You can use the API to perform the inclusion.
+
+##### Ruby Code
+
+```include.rb```:
+```ruby
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new(:pristine => true)
+markdown_helper.include('includer.md', 'included.md')
+```
+
+##### Command
+
+```sh
+ruby include.rb
+```
+
+#### File with Inclusion
+
+Here's the finished file with the included comment:
+
+```included.md```:
+```markdown
+This file includes the code as a comment.
+
+<!--class HelloWorld
+   def initialize(name)
+      @name = name.capitalize
+   end
+   def sayHi
+      puts "Hello !"
+   end
+end
+-->
+
+```
+

data/markdown/use_cases/include_files/include_text_as_comment/use_case_template.md

@@ -0,0 +1,26 @@
+### Include Text As Comment
+
+Use file inclusion to include text (or even code) as a comment.
+
+#### File to Be Included
+
+Here's a file containing code to be included:
+
+@[markdown](hello.rb)
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](includer.md)
+
+The treatment token ```:comment``` specifies that the included text is to be treated as a comment.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the included comment:
+
+@[markdown](included.md)
+

data/markdown/use_cases/include_files/include_text_as_pre/include_text_as_pre.rb

@@ -0,0 +1,69 @@
+require_relative '../include_use_case'
+
+class IncludeTextAsPre < IncludeUseCase
+
+  def self.build
+
+    use_case_name = File.basename(__FILE__, '.rb')
+    use_case = self.new(use_case_name)
+
+    includee_file_name = 'triple_backtick.md'
+
+    use_case.files_to_write.store(
+        includee_file_name,
+        <<EOT
+This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
+EOT
+    )
+
+    use_case.files_to_write.store(
+        INCLUDER_FILE_NAME,
+        <<EOT
+This file includes the backticked content as pre(formatted).
+
+@[:pre](#{includee_file_name})
+
+EOT
+    )
+
+    use_case.files_to_write.store(
+        TEMPLATE_FILE_NAME,
+        <<EOT
+### Include Text As Pre
+
+Use file inclusion to include text as pre-formatted (rather than as a code block).
+
+You might need to do this if you have text to include that has triple-backticks.
+
+#### File to Be Included
+
+Here's a file containing text to be included; the text has triple-backticks.:
+
+@[markdown](#{includee_file_name})
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](#{INCLUDER_FILE_NAME})
+
+The treatment token ```:pre``` specifies that the included text is to be treated as pre-formatted.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the included preformatted text:
+
+@[markdown](#{INCLUDED_FILE_NAME})
+
+EOT
+    )
+
+    system(INCLUDE_COMMAND)
+
+    use_case.build
+
+  end
+
+end

data/markdown/use_cases/include_files/include_text_as_pre/included.md

@@ -0,0 +1,6 @@
+This file includes the backticked content as pre(formatted).
+
+<pre>
+This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
+</pre>
+

data/markdown/use_cases/include_files/include_text_as_pre/includer.md

@@ -0,0 +1,4 @@
+This file includes the backticked content as pre(formatted).
+
+@[:pre](triple_backtick.md)
+

data/markdown/use_cases/include_files/include_text_as_pre/triple_backtick.md

@@ -0,0 +1 @@
+This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.

data/markdown/use_cases/include_files/include_text_as_pre/use_case.md

@@ -0,0 +1,76 @@
+### Include Text As Pre
+
+Use file inclusion to include text as pre-formatted (rather than as a code block).
+
+You might need to do this if you have text to include that has triple-backticks.
+
+#### File to Be Included
+
+Here's a file containing text to be included; the text has triple-backticks.:
+
+```triple_backtick.md```:
+```markdown
+This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
+```
+
+#### Includer File
+
+Here's a template file that includes it:
+
+```includer.md```:
+```markdown
+This file includes the backticked content as pre(formatted).
+
+@[:pre](triple_backtick.md)
+
+```
+
+The treatment token ```:pre``` specifies that the included text is to be treated as pre-formatted.
+
+#### CLI
+
+You can use the command-line interface to perform the inclusion.
+
+##### Command
+
+```sh
+markdown_helper include --pristine includer.md included.md
+```
+
+(Option ```--pristine``` suppresses comment insertion.)
+
+#### API
+
+You can use the API to perform the inclusion.
+
+##### Ruby Code
+
+```include.rb```:
+```ruby
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new(:pristine => true)
+markdown_helper.include('includer.md', 'included.md')
+```
+
+##### Command
+
+```sh
+ruby include.rb
+```
+
+#### File with Inclusion
+
+Here's the finished file with the included preformatted text:
+
+```included.md```:
+```markdown
+This file includes the backticked content as pre(formatted).
+
+<pre>
+This file uses triple-backtick to format a ```symbol```, which means that it cannot be included as a code block.
+</pre>
+
+```
+

data/markdown/use_cases/include_files/include_text_as_pre/use_case_template.md

@@ -0,0 +1,28 @@
+### Include Text As Pre
+
+Use file inclusion to include text as pre-formatted (rather than as a code block).
+
+You might need to do this if you have text to include that has triple-backticks.
+
+#### File to Be Included
+
+Here's a file containing text to be included; the text has triple-backticks.:
+
+@[markdown](triple_backtick.md)
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](includer.md)
+
+The treatment token ```:pre``` specifies that the included text is to be treated as pre-formatted.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the included preformatted text:
+
+@[markdown](included.md)
+

data/markdown/use_cases/use_cases.md

@@ -8,6 +8,8 @@
 * [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 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)
 * [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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_helper
 version: !ruby/object:Gem::Version
-  version: 1.9.9
+  version: 2.0.0
 platform: ruby
 authors:
 - burdettelamar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-04 00:00:00.000000000 Z
+date: 2018-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,6 +159,18 @@ files:
 - 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_text_as_comment/hello.rb
+- markdown/use_cases/include_files/include_text_as_comment/include_text_as_comment.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_pre/include_text_as_pre.rb
+- 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_use_case.rb
 - markdown/use_cases/include_files/include_with_added_comments/include_with_added_comments.rb
 - markdown/use_cases/include_files/include_with_added_comments/included.md