markdown_helper 2.0.0 → 2.1.0

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

@@ -0,0 +1,16 @@
+# Page Title
+
+@[:page_toc](## Page Contents)
+
+## Includer level-two title.
+
+### Includer level-three title.
+
+### Another includer level-three title.
+
+## Another includer level-two title.
+
+@[:markdown](markdown_0.md)
+
+@[:markdown](markdown_1.md)
+

data/markdown/use_cases/include_files/include_page_toc/markdown_0.md

@@ -0,0 +1,8 @@
+        
+## Includee 0 level-two title.
+
+### Includee 0 level-three title.
+
+### Another includee 0 level-three title.
+
+## Another includee 0 level-two title.

data/markdown/use_cases/include_files/include_page_toc/markdown_1.md

@@ -0,0 +1,8 @@
+        
+## Includee 1 level-two title.
+
+### Includee 1 level-three title.
+
+### Another includee 1 level-three title.
+
+## Another includee 1 level-two title.

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

@@ -0,0 +1,212 @@
+### Include Page TOC
+
+Use file inclusion to include a page table of contents (page TOC).
+
+The page TOC is a tree of links:
+
+- Each link goes to a corresponding markdown title.
+- The tree structure reflects the relative depths of the linked headers.
+
+Below are files to be included and an includer file that will generate the page TOC.
+
+Note that all file inclusion (even nested inclusions) will be performed before the page TOC is built, so the page TOC covers all the included material.
+
+#### Files to Be Included
+
+Here's a file containing markdown to be included:
+
+```markdown_0.md```:
+```markdown
+        
+## Includee 0 level-two title.
+
+### Includee 0 level-three title.
+
+### Another includee 0 level-three title.
+
+## Another includee 0 level-two title.
+```
+
+Here's another:
+
+```markdown_1.md```:
+```markdown
+        
+## Includee 1 level-two title.
+
+### Includee 1 level-three title.
+
+### Another includee 1 level-three title.
+
+## Another includee 1 level-two title.
+```
+
+#### Includer File
+
+Here's a template file that includes them:
+
+```includer.md```:
+```markdown
+# Page Title
+
+@[:page_toc](## Page Contents)
+
+## Includer level-two title.
+
+### Includer level-three title.
+
+### Another includer level-three title.
+
+## Another includer level-two title.
+
+@[:markdown](markdown_0.md)
+
+@[:markdown](markdown_1.md)
+
+```
+
+The treatment token ```:page_toc``` specifies where the page TOC is to be inserted.
+
+#### 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 inclusion:
+
+```included.md```:
+```markdown
+<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
+# Page Title
+
+## Page Contents
+- [Includer level-two title.](#includer-level-two-title)
+  - [Includer level-three title.](#includer-level-three-title)
+  - [Another includer level-three title.](#another-includer-level-three-title)
+- [Another includer level-two title.](#another-includer-level-two-title)
+- [Includee 0 level-two title.](#includee-0-level-two-title)
+  - [Includee 0 level-three title.](#includee-0-level-three-title)
+  - [Another includee 0 level-three title.](#another-includee-0-level-three-title)
+- [Another includee 0 level-two title.](#another-includee-0-level-two-title)
+- [Includee 1 level-two title.](#includee-1-level-two-title)
+  - [Includee 1 level-three title.](#includee-1-level-three-title)
+  - [Another includee 1 level-three title.](#another-includee-1-level-three-title)
+- [Another includee 1 level-two title.](#another-includee-1-level-two-title)
+
+## Includer level-two title.
+
+### Includer level-three title.
+
+### Another includer level-three title.
+
+## Another includer level-two title.
+
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
+        
+## Includee 0 level-two title.
+
+### Includee 0 level-three title.
+
+### Another includee 0 level-three title.
+
+## Another includee 0 level-two title.
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
+
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
+        
+## Includee 1 level-two title.
+
+### Includee 1 level-three title.
+
+### Another includee 1 level-three title.
+
+## Another includee 1 level-two title.
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
+
+<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
+```
+
+And here's the finished markdown, as rendered on this page:
+
+---
+
+<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
+# Page Title
+
+## Page Contents
+- [Includer level-two title.](#includer-level-two-title)
+  - [Includer level-three title.](#includer-level-three-title)
+  - [Another includer level-three title.](#another-includer-level-three-title)
+- [Another includer level-two title.](#another-includer-level-two-title)
+- [Includee 0 level-two title.](#includee-0-level-two-title)
+  - [Includee 0 level-three title.](#includee-0-level-three-title)
+  - [Another includee 0 level-three title.](#another-includee-0-level-three-title)
+- [Another includee 0 level-two title.](#another-includee-0-level-two-title)
+- [Includee 1 level-two title.](#includee-1-level-two-title)
+  - [Includee 1 level-three title.](#includee-1-level-three-title)
+  - [Another includee 1 level-three title.](#another-includee-1-level-three-title)
+- [Another includee 1 level-two title.](#another-includee-1-level-two-title)
+
+## Includer level-two title.
+
+### Includer level-three title.
+
+### Another includer level-three title.
+
+## Another includer level-two title.
+
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
+        
+## Includee 0 level-two title.
+
+### Includee 0 level-three title.
+
+### Another includee 0 level-three title.
+
+## Another includee 0 level-two title.
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_0.md -->
+
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
+        
+## Includee 1 level-two title.
+
+### Includee 1 level-three title.
+
+### Another includee 1 level-three title.
+
+## Another includee 1 level-two title.
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include_files/include_page_toc/markdown_1.md -->
+
+<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
+
+---

data/markdown/use_cases/include_files/include_page_toc/use_case_builder.rb

@@ -0,0 +1,121 @@
+require_relative '../include_use_case'
+
+class IncludePageToc < IncludeUseCase
+
+  def self.build
+
+    use_case = self.new
+
+    include_command = IncludeUseCase.construct_include_command(INCLUDER_FILE_NAME, INCLUDED_FILE_NAME, pristine = false)
+    use_case.commands_to_execute.unshift(include_command)
+
+    includee_0_file_name = 'markdown_0.md'
+    includee_1_file_name = 'markdown_1.md'
+
+    use_case.files_to_write.store(
+        includee_0_file_name,
+        <<EOT
+        
+## Includee 0 level-two title.
+
+### Includee 0 level-three title.
+
+### Another includee 0 level-three title.
+
+## Another includee 0 level-two title.
+EOT
+    )
+
+    use_case.files_to_write.store(
+        includee_1_file_name,
+        <<EOT
+        
+## Includee 1 level-two title.
+
+### Includee 1 level-three title.
+
+### Another includee 1 level-three title.
+
+## Another includee 1 level-two title.
+EOT
+    )
+
+    use_case.files_to_write.store(
+        INCLUDER_FILE_NAME,
+        <<EOT
+# Page Title
+
+@[:page_toc](## Page Contents)
+
+## Includer level-two title.
+
+### Includer level-three title.
+
+### Another includer level-three title.
+
+## Another includer level-two title.
+
+@[:markdown](#{includee_0_file_name})
+
+@[:markdown](#{includee_1_file_name})
+
+EOT
+    )
+
+    use_case.files_to_write.store(
+        TEMPLATE_FILE_NAME,
+        <<EOT
+### Include Page TOC
+
+Use file inclusion to include a page table of contents (page TOC).
+
+The page TOC is a tree of links:
+
+- Each link goes to a corresponding markdown title.
+- The tree structure reflects the relative depths of the linked headers.
+
+Below are files to be included and an includer file that will generate the page TOC.
+
+Note that all file inclusion (even nested inclusions) will be performed before the page TOC is built, so the page TOC covers all the included material.
+
+#### Files to Be Included
+
+Here's a file containing markdown to be included:
+
+@[markdown](#{includee_0_file_name})
+
+Here's another:
+
+@[markdown](#{includee_1_file_name})
+
+#### Includer File
+
+Here's a template file that includes them:
+
+@[markdown](#{INCLUDER_FILE_NAME})
+
+The treatment token ```:page_toc``` specifies where the page TOC is to be inserted.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the inclusion:
+
+@[markdown](#{INCLUDED_FILE_NAME})
+
+And here's the finished markdown, as rendered on this page:
+
+---
+
+@[:markdown](#{INCLUDED_FILE_NAME})
+
+---
+EOT
+    )
+
+    use_case.build
+
+  end
+
+end

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

@@ -0,0 +1,46 @@
+### Include Page TOC
+
+Use file inclusion to include a page table of contents (page TOC).
+
+The page TOC is a tree of links:
+
+- Each link goes to a corresponding markdown title.
+- The tree structure reflects the relative depths of the linked headers.
+
+Below are files to be included and an includer file that will generate the page TOC.
+
+Note that all file inclusion (even nested inclusions) will be performed before the page TOC is built, so the page TOC covers all the included material.
+
+#### Files to Be Included
+
+Here's a file containing markdown to be included:
+
+@[markdown](markdown_0.md)
+
+Here's another:
+
+@[markdown](markdown_1.md)
+
+#### Includer File
+
+Here's a template file that includes them:
+
+@[markdown](includer.md)
+
+The treatment token ```:page_toc``` specifies where the page TOC is to be inserted.
+
+@[:markdown](../interface.md)
+
+#### File with Inclusion
+
+Here's the finished file with the inclusion:
+
+@[markdown](included.md)
+
+And here's the finished markdown, as rendered on this page:
+
+---
+
+@[:markdown](included.md)
+
+---

data/markdown/use_cases/include_files/include_text_as_comment/{include_text_as_comment.rb → use_case_builder.rb}

@@ -4,8 +4,7 @@ class IncludeTextAsComment < IncludeUseCase
 
   def self.build
 
-    use_case_name = File.basename(__FILE__, '.rb')
-    use_case = self.new(use_case_name)
+    use_case = self.new
 
     includee_file_name = 'hello.rb'
 

data/markdown/use_cases/include_files/include_text_as_pre/{include_text_as_pre.rb → use_case_builder.rb}

@@ -4,8 +4,7 @@ class IncludeTextAsPre < IncludeUseCase
 
   def self.build
 
-    use_case_name = File.basename(__FILE__, '.rb')
-    use_case = self.new(use_case_name)
+    use_case = self.new
 
     includee_file_name = 'triple_backtick.md'
 

data/markdown/use_cases/include_files/include_use_case.rb

@@ -17,16 +17,10 @@ class IncludeUseCase < UseCase
 
   BUILD_COMMAND = UseCase.construct_include_command(TEMPLATE_FILE_NAME, USE_CASE_FILE_NAME, pristine = true)
 
-  def initialize(use_case_dir_name)
-
+  def initialize
     super
-
-    commands_to_execute.push(RUBY_COMMAND) if File.exist?(RUBY_FILE_NAME)
-    commands_to_execute.push(BUILD_COMMAND) if File.exist?(TEMPLATE_FILE_NAME)
-
+    commands_to_execute.push(BUILD_COMMAND)
     self.use_case_dir_name = use_case_dir_name
-
-
   end
 
   def use_case_dir_path