markdown_helper 2.2.0 → 2.3.0

data/markdown/use_cases/include_files/include_use_case.rb

@@ -1,104 +0,0 @@
-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 = UseCase.construct_include_command(TEMPLATE_FILE_NAME, USE_CASE_FILE_NAME, pristine = true)
-
-  def initialize
-    super
-    commands_to_execute.push(BUILD_COMMAND)
-    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_files/include_with_added_comments/use_case_builder.rb

@@ -1,66 +0,0 @@
-require_relative '../include_use_case'
-
-class IncludeWithAddedComments < 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)
-
-    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:
-
-* Identify the includer file.
-* Identify each includee file.
-
-#### Includee File
-
-@[markdown](#{INCLUDEE_FILE_NAME})
-
-#### Includer File
-
-@[markdown](#{INCLUDER_FILE_NAME})
-
-#### CLI
-
-You can use the command-line interface to perform the inclusion.
-
-##### Command
-
-```sh
-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})
-
-The file path for the included file is relative to the .git directory.
-EOT
-
-    )
-
-    use_case.build
-
-  end
-
-end

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

@@ -1,60 +0,0 @@
-require_relative '../include_use_case'
-
-class NestInclusions < IncludeUseCase
-
-  def self.build
-
-    use_case = self.new
-
-    nested_includee_file_name = 'nested_includee.md'
-
-    use_case.files_to_write.store(
-        nested_includee_file_name,
-        <<EOT
-Text for nested inclusion.
-EOT
-    )
-
-    use_case.files_to_write.store(
-        INCLUDER_FILE_NAME,
-        <<EOT
-File to do nested inclusion.
-
-@[:markdown](#{INCLUDEE_FILE_NAME})
-EOT
-    )
-
-    use_case.files_to_write.store(
-        TEMPLATE_FILE_NAME,
-        <<EOT
-### Nest Inclusions
-
-An included markdown file can itself include more files.
-
-#### File To Be Included
-
-@[markdown](#{INCLUDEE_FILE_NAME})
-
-#### File For Nested Inclusion
-
-@[markdown](#{nested_includee_file_name})
-
-#### Includer File
-
-@[markdown](#{INCLUDER_FILE_NAME})
-
-@[:markdown](../interface.md)
-
-#### File with Inclusion
-
-Here's the finished file with the inclusion and nested inclusion:
-
-@[markdown](#{INCLUDED_FILE_NAME})
-EOT
-    )
-
-    use_case.build
-
-  end
-
-end

data/markdown/use_cases/include_files/reuse_text/include.rb

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

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

@@ -1,48 +0,0 @@
-require_relative '../include_use_case'
-
-class ReuseText < IncludeUseCase
-
-  def self.build
-
-    use_case = self.new
-
-    use_case.write_includee_file
-    use_case.write_includer_file
-    use_case.write_ruby_file(pristine = true)
-
-    use_case.commands_to_execute.push('ruby include.rb')
-
-    File.write(
-        TEMPLATE_FILE_NAME,
-        <<EOT
-### Reuse Text
-
-Use file inclusion to stay DRY (Don't Repeat Yourself).
-
-Maintain reusable text in a separate file, then include it wherever it's needed.
-
-#### File To Be Included
-
-@[markdown](#{INCLUDEE_FILE_NAME})
-
-#### Includer File
-
-@[markdown](#{INCLUDER_FILE_NAME})
-
-The treatment token ```:markdown``` specifies that the included text is to be treated as more markdown.
-
-@[:markdown](../interface.md)
-
-#### File with Inclusion
-
-Here's the output file, after inclusion.
-
-@[markdown](#{INCLUDED_FILE_NAME})
-EOT
-    )
-
-    use_case.build
-
-  end
-
-end