markdown_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f73122af24017cc7c6cbd5bb2b7a920d28bc03f
+  data.tar.gz: 73415a069fa49e73e08d95128a885a0adf6a9b65
+SHA512:
+  metadata.gz: 7bb0b0d35c6bb7a0677848d016c53bfcfcba4b8cbb5bf94917de2a8ac2edf1f3e625508c547dac954b605725f8824432e9ad7da9506c03cfd785cda54d0b4929
+  data.tar.gz: 64625aa4899d6db4cffeac7ba22a14b38f557ec3c7e5413ecda9a858c7988c922e44cc2008b8bffe499e3105e3fb67c35b82fc5a79ec58ec573f8e4926338e2a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.idea/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.6
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at BurdetteLamar@Yahoo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in markdown_helper.gemspec
+gemspec
+
+gem 'diff-lcs', '1.3'

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    markdown_helper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  diff-lcs (= 1.3)
+  markdown_helper!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Burdette Lamar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 burdettelamar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# MarkdownHelper
+
+## File Inclusion  <img src="/images/include.png" width="50">
+
+This markdown helper enables file inclusion in GitHub markdown.
+
+(Actually this README file is built using the file inclusion.)
+
+You can use it to merge external files into a markdown (```.md```) file.
+
+The merged text can be highlighted in a code block:
+
+<code>include.rb</code>
+```ruby
+class RubyCode
+  def initialize
+    raise RuntimeError.new('I am only an example!')
+  end
+end
+```
+
+or plain in a code block:
+
+<code>include.rb</code>
+```
+class RubyCode
+  def initialize
+    raise RuntimeError.new('I am only an example!')
+  end
+end
+```
+
+or verbatim (which GitHub renders however it likes).
+
+## Usage
+
+### Including Files in Markdown
+
+<code>include.md</code>
+```verbatim
+@[ruby](include.rb)
+
+@[:code_block](include.rb)
+
+@[:verbatim](include.rb)
+```
+
+Each inclusion line has:
+
+* A leading ```@``` character.
+* A *treatment* in square brackets, one of:
+  * Highlighting mode such as ```[ruby]```, to include a highlighted code block.  This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
+  * ```[:code_block]```, to include a plain code block.
+  * ```[:verbatim]```, to include text verbatim (to be rendered as markdown).
+* A relative file path in parentheses, pointing to the file to be included.
+
+### Including the Files
+
+<code>usage.rb</code>
+```ruby
+require 'markdown_helper'
+
+markdown_helper = MarkdownHelper.new
+template_file_path = 'highlight_ruby_template.md'
+markdown_file_path = 'highlighted_ruby.rb'
+markdown_helper.include(template_file_path, markdown_file_path)
+```

data/Rakefile

@@ -0,0 +1,22 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+namespace :build do
+
+  desc 'Build README.md file from README.template.md'
+  task :readme do
+    require_relative 'lib/markdown_helper'
+    markdown_helper = MarkdownHelper.new
+    markdown_helper.include('readme/highlight_ruby_template.md', 'readme/highlighted_ruby.md')
+    markdown_helper.include('readme/README.template.md', 'README.md')
+  end
+
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'markdown_helper'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/markdown_helper.rb

@@ -0,0 +1,94 @@
+require 'markdown_helper/version'
+
+class MarkdownHelper
+
+  INCLUDE_REGEXP = /^@\[(:code_block|:verbatim|\w+)\]/
+
+  attr_accessor :tag_as_generated
+
+    DEFAULT_TREATMENT_FOR_FILE_EXT = {
+      :md => :verbatim,
+      :rb => 'ruby',
+      :xml => 'xml',
+      }
+
+  def initialize
+    @treatment_for_file_ext = DEFAULT_TREATMENT_FOR_FILE_EXT
+    @treatment_for_file_ext.default = :code_block
+    self.tag_as_generated = false
+  end
+
+  def get_treatment(file_type)
+    @treatment_for_file_ext[file_type]
+  end
+
+  def set_treatment(file_type, treatment)
+    treatment_symbols = [:verbatim, :code_block]
+    if treatment_symbols.include?(treatment) || treatment.kind_of?(String)
+      @treatment_for_file_ext[file_type] = treatment
+    else
+      message = "treatment must be a single word or must be in #{treatment_symbols.inspect}, not #{treatment.inspect}"
+      raise ArgumentError.new(message)
+    end
+  end
+
+  def include(template_file_path, markdown_file_path)
+    output_lines = []
+    File.open(template_file_path, 'r') do |template_file|
+      if tag_as_generated
+        output_lines.push("<!--- GENERATED FILE, DO NOT EDIT --->\n")
+      end
+      template_file.each_line do |input_line|
+        match_data = input_line.match(INCLUDE_REGEXP)
+        unless match_data
+          output_lines.push(input_line)
+          next
+        end
+        treatment = case match_data[1]
+                      when ':code_block'
+                        :code_block
+                      when ':verbatim'
+                        :verbatim
+                      else
+                        match_data[1]
+                    end
+        file_path_in_parens =  input_line.sub(INCLUDE_REGEXP, '')
+        unless file_path_in_parens.start_with?('(') && file_path_in_parens.end_with?(")\n")
+          raise RuntimeError.new(file_path_in_parens.inspect)
+        end
+        relative_file_path = file_path_in_parens.sub('(', '').sub(")\n", '')
+        include_file_path = File.join(
+            File.dirname(template_file_path),
+            relative_file_path,
+        )
+        included_text = File.read(include_file_path)
+        unless included_text.match("\n")
+          message = "Warning:  Included file has no trailing newline: #{include_file_path}"
+          warn(message)
+        end
+        extname = File.extname(include_file_path)
+        file_ext_key = extname.sub('.', '').to_sym
+        treatment ||= @treatment_for_file_ext[file_ext_key]
+        if treatment == :verbatim
+          # Pass through unadorned.
+          output_lines.push(included_text)
+        else
+          # Use the file name as a label.
+          file_name_line = format("<code>%s</code>\n", File.basename(include_file_path))
+          output_lines.push(file_name_line)
+          # Put into code block.
+          language = treatment == :code_block ? '' : treatment
+          output_lines.push("```#{language}\n")
+          output_lines.push(included_text)
+          output_lines.push("```\n")
+        end
+      end
+    end
+    output = output_lines.join('')
+    File.open(markdown_file_path, 'w') do |md_file|
+      md_file.write(output)
+    end
+    output
+  end
+
+end

data/lib/markdown_helper/version.rb

@@ -0,0 +1,3 @@
+class MarkdownHelper
+  VERSION = '0.1.0'
+end

data/markdown_helper.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdown_helper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'markdown_helper'
+  spec.version       = MarkdownHelper::VERSION
+  spec.authors       = ['burdettelamar']
+  spec.email         = ['BurdetteLamar@Yahoo.com']
+
+  spec.summary       = 'Module to help with GitHub markdown.'
+  spec.description   = 'Module to help with GitHub markdown.  So far:  file inclusion.'
+  spec.homepage      = 'https://rubygems.org/gems/markdown_helper'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  #   spec.metadata['allowed_push_host'] = "http://rubygems.org"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'diff-lcs', '~> 1.3'
+end

data/readme/README.template.md

@@ -0,0 +1,38 @@
+# MarkdownHelper
+
+## File Inclusion  <img src="/images/include.png" width="50">
+
+This markdown helper enables file inclusion in GitHub markdown.
+
+(Actually this README file is built using the file inclusion.)
+
+You can use it to merge external files into a markdown (```.md```) file.
+
+The merged text can be highlighted in a code block:
+
+@[ruby](include.rb)
+
+or plain in a code block:
+
+@[:code_block](include.rb)
+
+or verbatim (which GitHub renders however it likes).
+
+## Usage
+
+### Including Files in Markdown
+
+@[verbatim](include.md)
+
+Each inclusion line has:
+
+* A leading ```@``` character.
+* A *treatment* in square brackets, one of:
+  * Highlighting mode such as ```[ruby]```, to include a highlighted code block.  This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
+  * ```[:code_block]```, to include a plain code block.
+  * ```[:verbatim]```, to include text verbatim (to be rendered as markdown).
+* A relative file path in parentheses, pointing to the file to be included.
+
+### Including the Files
+
+@[ruby](usage.rb)

data/readme/code_block_ruby_template.md

@@ -0,0 +1 @@
+@[:code_block](include.rb)

data/readme/highlight_ruby_template.md

@@ -0,0 +1 @@
+@[ruby](include.rb)

data/readme/highlighted_ruby.md

@@ -0,0 +1,8 @@
+<code>include.rb</code>
+```ruby
+class RubyCode
+  def initialize
+    raise RuntimeError.new('I am only an example!')
+  end
+end
+```

data/readme/include.md

@@ -0,0 +1,5 @@
+@[ruby](include.rb)
+
+@[:code_block](include.rb)
+
+@[:verbatim](include.rb)

data/readme/include.rb

@@ -0,0 +1,5 @@
+class RubyCode
+  def initialize
+    raise RuntimeError.new('I am only an example!')
+  end
+end

data/readme/usage.rb

@@ -0,0 +1,6 @@
+require 'markdown_helper'
+
+markdown_helper = MarkdownHelper.new
+template_file_path = 'highlight_ruby_template.md'
+markdown_file_path = 'highlighted_ruby.rb'
+markdown_helper.include(template_file_path, markdown_file_path)

data/readme/verbatim_ruby_template.md

@@ -0,0 +1 @@
+@[:verbatim](include.rb)

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: markdown_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- burdettelamar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 'Module to help with GitHub markdown.  So far:  file inclusion.'
+email:
+- BurdetteLamar@Yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- images/include.png
+- lib/markdown_helper.rb
+- lib/markdown_helper/version.rb
+- markdown_helper.gemspec
+- readme/README.template.md
+- readme/code_block_ruby_template.md
+- readme/highlight_ruby_template.md
+- readme/highlighted_ruby.md
+- readme/include.md
+- readme/include.rb
+- readme/usage.rb
+- readme/verbatim_ruby_template.md
+homepage: https://rubygems.org/gems/markdown_helper
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.2
+signing_key: 
+specification_version: 4
+summary: Module to help with GitHub markdown.
+test_files: []