markdown_helper 1.8.0 → 1.9.0

data/markdown/use_cases/include/include_markdown/included.md

@@ -0,0 +1,13 @@
+This file includes the markdown file.
+
+This fiie, to be included, is markdown.
+
+### This is a level-three title.
+
+Here's a [link](http://yahoo.com).
+
+This is an unordered list:
+* One.
+* Two.
+* Three.
+

data/markdown/use_cases/include/include_markdown/includer.md

@@ -0,0 +1,4 @@
+This file includes the markdown file.
+
+@[:markdown](markdown.md)
+

data/markdown/use_cases/include/include_markdown/markdown.md

@@ -0,0 +1,10 @@
+This fiie, to be included, is markdown.
+
+### This is a level-three title.
+
+Here's a [link](http://yahoo.com).
+
+This is an unordered list:
+* One.
+* Two.
+* Three.

data/markdown/use_cases/include/include_markdown/use_case.md

@@ -0,0 +1,106 @@
+### Include Markdown
+
+Use file inclusion to include markdown.  The whole page, includer and includee, will be rendered when it's pushed to GitHub.
+
+#### File to Be Included
+
+Here's a file containing markdown to be included:
+
+```markdown.md```:
+```markdown
+This fiie, to be included, is markdown.
+
+### This is a level-three title.
+
+Here's a [link](http://yahoo.com).
+
+This is an unordered list:
+* One.
+* Two.
+* Three.
+```
+
+#### Includer File
+
+Here's a template file that includes it:
+
+```includer.md```:
+```markdown
+This file includes the markdown file.
+
+@[:markdown](markdown.md)
+
+```
+
+The treatment token ```:markdown``` specifies that the included text is to be treated as markdown.
+
+#### 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
+This file includes the markdown file.
+
+This fiie, to be included, is markdown.
+
+### This is a level-three title.
+
+Here's a [link](http://yahoo.com).
+
+This is an unordered list:
+* One.
+* Two.
+* Three.
+
+```
+
+And here's the finished markdown, as rendered on this page:
+
+---
+
+This fiie, to be included, is markdown.
+
+### This is a level-three title.
+
+Here's a [link](http://yahoo.com).
+
+This is an unordered list:
+* One.
+* Two.
+* Three.
+
+---

data/markdown/use_cases/include/include_markdown/use_case_template.md

@@ -0,0 +1,33 @@
+### Include Markdown
+
+Use file inclusion to include markdown.  The whole page, includer and includee, will be rendered when it's pushed to GitHub.
+
+#### File to Be Included
+
+Here's a file containing markdown to be included:
+
+@[markdown](markdown.md)
+
+#### Includer File
+
+Here's a template file that includes it:
+
+@[markdown](includer.md)
+
+The treatment token ```:markdown``` specifies that the included text is to be treated as markdown.
+
+@[: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](markdown.md)
+
+---

data/markdown/use_cases/include/include_use_case.rb

@@ -0,0 +1,110 @@
+require_relative '../use_case'
+
+class IncludeUseCase < UseCase
+
+  attr_accessor :use_case_dir_name
+
+  INCLUDE_DIR_PATH = File.dirname(__FILE__)
+
+  INCLUDEE_FILE_NAME = 'includee.md'
+  INCLUDER_FILE_NAME = 'includer.md'
+  INCLUDED_FILE_NAME = 'included.md'
+
+  RUBY_FILE_NAME = 'include.rb'
+  RUBY_COMMAND = "ruby #{RUBY_FILE_NAME}"
+
+  INCLUDE_COMMAND = IncludeUseCase.construct_include_command(INCLUDER_FILE_NAME, INCLUDED_FILE_NAME, pristine = true)
+
+  BUILD_COMMAND = IncludeUseCase.construct_include_command(TEMPLATE_FILE_NAME, USE_CASE_FILE_NAME, pristine = true)
+
+  def initialize(use_case_dir_name)
+
+    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)
+
+    self.use_case_dir_name = use_case_dir_name
+
+
+  end
+
+  def use_case_dir_path
+    File.join(File.absolute_path(File.dirname(__FILE__)), use_case_dir_name)
+  end
+
+  def write_includee_file
+    File.write(
+        INCLUDEE_FILE_NAME,
+        <<EOT
+Text in includee file.
+EOT
+    )
+  end
+
+  def write_includer_file
+    File.write(
+        INCLUDER_FILE_NAME,
+        <<EOT
+Text in includer file.
+
+@[:markdown](#{INCLUDEE_FILE_NAME})
+
+EOT
+    )
+  end
+
+  def write_ruby_file(pristine)
+    args = pristine ? '(:pristine => true)' : ''
+    File.write(
+        RUBY_FILE_NAME,
+        <<EOT
+require 'markdown_helper'
+
+# Option :pristine suppresses comment insertion.
+markdown_helper = MarkdownHelper.new#{args}
+markdown_helper.include('#{INCLUDER_FILE_NAME}', '#{INCLUDED_FILE_NAME}')
+EOT
+    )
+  end
+
+  def self.write_interface_file
+    interface_file_path = File.join(
+        INCLUDE_DIR_PATH,
+        'interface.md',
+    )
+    File.open(interface_file_path, 'w') do |interface_file|
+      interface_file.puts(<<EOT
+#### CLI
+
+You can use the command-line interface to perform the inclusion.
+
+##### Command
+
+```sh
+#{INCLUDE_COMMAND}
+```
+
+@[:markdown](../pristine.md)
+
+#### API
+
+You can use the API to perform the inclusion.
+
+##### Ruby Code
+
+@[ruby](#{RUBY_FILE_NAME})
+
+##### Command
+
+```sh
+#{RUBY_COMMAND}
+```
+EOT
+      )
+    end
+
+  end
+
+end
+

data/markdown/use_cases/include/include_with_added_comments/include_with_added_comments.rb

@@ -1,57 +1,18 @@
-#!/usr/bin/env ruby
-
-use_case_dir_path = File.absolute_path(File.dirname(__FILE__))
-
-includee_file_name = 'includee.md'
-includee_file_path = File.join(
-    use_case_dir_path,
-    includee_file_name,
-)
-
-includer_file_name = 'includer.md'
-includer_file_path = File.join(
-    use_case_dir_path,
-    includer_file_name,
-)
-
-included_file_name = 'included.md'
-
-use_case_file_name = 'include_with_added_comments.md'
-use_case_file_path = File.join(
-    use_case_dir_path,
-    use_case_file_name,
-)
-
-template_file_name = 'template.md'
-template_file_path = File.join(
-    use_case_dir_path,
-    template_file_name,
-)
-
-include_command = "markdown_helper include #{includer_file_name} #{included_file_name}"
-
-File.write(
-    includee_file_path,
-    <<EOT
-Text to be included.
-EOT
-)
+require_relative '../include_use_case'
 
-File.write(
-    includer_file_path,
-    <<EOT
-@[:markdown](#{includee_file_name})
-EOT
-)
+class IncludeWithAddedComments < IncludeUseCase
 
-# Example inclusion.
-Dir.chdir(use_case_dir_path) do
-  system(include_command)
-end
+  def self.build
+
+    use_case_name = File.basename(__FILE__, '.rb')
+    use_case = self.new(use_case_name)
+
+    include_command = IncludeUseCase.construct_include_command(INCLUDER_FILE_NAME, INCLUDED_FILE_NAME, pristine = false)
+    use_case.commands_to_execute.push(include_command)
 
-File.write(
-    template_file_path,
-    <<EOT
+    use_case.files_to_write.store(
+        TEMPLATE_FILE_NAME,
+        <<EOT
 ### Include with Added Comments
 
 By default (that is, without option ```--pristine```) file inclusion adds comments that:
@@ -61,24 +22,46 @@ By default (that is, without option ```--pristine```) file inclusion adds commen
 
 #### Includee File
 
-@[markdown](#{includee_file_name})
+@[markdown](#{INCLUDEE_FILE_NAME})
 
 #### Includer File
 
-@[markdown](#{includer_file_name})
+@[markdown](#{INCLUDER_FILE_NAME})
 
-#### Inclusion Command
+#### CLI
+
+You can use the command-line interface to perform the inclusion.
+
+##### Command
 
 ```sh
-#{include_command}
+markdown_helper include #{INCLUDER_FILE_NAME} #{INCLUDED_FILE_NAME}
+```
+
+#### API
+
+You can use the API to perform the inclusion.
+
+##### Ruby Code
+
+```ruby
+require 'markdown_helper'
+
+markdown_helper = MarkdownHelper.new
+markdown_helper.include(#{INCLUDER_FILE_NAME}, #{INCLUDED_FILE_NAME})
 ```
 
 #### File with Inclusion and Added Comments
 
-@[markdown](#{included_file_name})
+@[markdown](#{INCLUDED_FILE_NAME})
+
+The file path for the included file is relative to the .git directory.
 EOT
-)
 
-# Build use case.
-build_command = "markdown_helper include --pristine #{template_file_path} #{use_case_file_path}"
-system(build_command)
+    )
+
+    use_case.build
+
+  end
+
+end

data/markdown/use_cases/include/include_with_added_comments/included.md

@@ -1,5 +1,5 @@
 <!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
-<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE ./includee.md -->
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include/include_with_added_comments/includee.md -->
 Text to be included.
-<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE ./includee.md -->
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include/include_with_added_comments/includee.md -->
 <!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->

data/markdown/use_cases/include/include_with_added_comments/use_case.md

@@ -0,0 +1,56 @@
+### Include with Added Comments
+
+By default (that is, without option ```--pristine```) file inclusion adds comments that:
+
+* Identify the includer file.
+* Identify each includee file.
+
+#### Includee File
+
+```includee.md```:
+```markdown
+Text to be included.
+```
+
+#### Includer File
+
+```includer.md```:
+```markdown
+@[:markdown](includee.md)
+```
+
+#### CLI
+
+You can use the command-line interface to perform the inclusion.
+
+##### Command
+
+```sh
+markdown_helper include includer.md included.md
+```
+
+#### API
+
+You can use the API to perform the inclusion.
+
+##### Ruby Code
+
+```ruby
+require 'markdown_helper'
+
+markdown_helper = MarkdownHelper.new
+markdown_helper.include(includer.md, included.md)
+```
+
+#### File with Inclusion and Added Comments
+
+```included.md```:
+```markdown
+<!-- >>>>>> BEGIN GENERATED FILE (include): SOURCE includer.md -->
+<!-- >>>>>> BEGIN INCLUDED FILE (markdown): SOURCE markdown/use_cases/include/include_with_added_comments/includee.md -->
+Text to be included.
+<!-- <<<<<< END INCLUDED FILE (markdown): SOURCE markdown/use_cases/include/include_with_added_comments/includee.md -->
+<!-- <<<<<< END GENERATED FILE (include): SOURCE includer.md -->
+```
+
+The file path for the included file is relative to the .git directory.