mark_maker 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd856055ec57459656c6963b82423f55febfe440
-  data.tar.gz: 355e6e14d071a9d53a9f2fd4333896ab1e0253b7
+SHA256:
+  metadata.gz: bd5c7e729e819e15b9796cd57242afd832bd913f1545184cda35cee9e1c07db1
+  data.tar.gz: 43156be3f04d2bba8789bd9c80452bc8c468b30074a26acc5335468fc9af1c6b
 SHA512:
-  metadata.gz: 95a31758ca8963bebd1080210c333c0ffc7d29767ffeaed3151a7cf92c5cd8bbacaa7788ad359c73efb9db943c735d5e8564eb7ddb2a2cbf47c1d6986203b075
-  data.tar.gz: 351deb838b05b55f91f1a40991de02e297ed08bbc795a7ffb73cf7d9dad0c74648f26337fb88dcf9cd8a012aa860be5402be3e2906331ae1b136f7053f73f383
+  metadata.gz: 797cf2e44e772f2e6501efe9d8bcb4a32ef349862c3b67e19f173ac3ecf34d477b50737fd9fec40d0e1db6384ca2c6800d1b384aad9c5404e372066093124303
+  data.tar.gz: e7872ccacd0ed4b3c06975522899c92adde7c9c3142bf2e0d140fbd4082702290a81ab37ac312620de402a66ece8d13b009d1b44879df8c88679731e1d9927db

data/.ruby-version

@@ -1 +1,2 @@
-2.2.1
+2.6
+

data/.travis.yml

@@ -1,3 +1,12 @@
+before_install:
+  - gem install bundler
+
 language: ruby
+
+bundler_args: --without dev_tooling
+
 rvm:
-  - 2.2.0
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.3

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+1.0.0
+-----
+
+ - just tidied up the README
+ - clarified the supported ruby versions (all now 2.x variations)
+
+0.9.0
+-----
+
+ - addressing security vulnerability associated with rake
+ - dropping support for ruby 1.x versions
+ - now calls for bundler 2
+
+0.8.0
+-----
+ - added header 4 thru 6 support
+ - fixed a bug in the image generation when using a title
+ - noted supported ruby versions in the readme, per travis config
+
+0.7.0
+-----
+ - added support for images
+ - now support ruby 1.9.3, 2.2.4 and 2.3.0
+
 0.3.0
 -----
 

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mark_maker.gemspec
 gemspec
+
+group :dev_tooling do
+    gem 'rubocop'
+end

data/README.md

@@ -1,37 +1,10 @@
+![MarkMaker build status](https://travis-ci.org/sn1de/mark_maker.svg?branch=master "Build Status")
+
 MarkMaker
 =========
 
 Programatically generate markdown documents.
 
-Intended Use
-------------
-
-The mark_maker gem provides a set of methods that take text content and
-convert it to various markdown elements. The primary use case is simple
-conversion of something like a JSON document into a markdown document.
-
-The initial development goal is to provide
-support for all of the markdown supported operations, at least in their basic form. What
-I mean by basic is that you provide a 'chunk' of content and the mark_maker `Generator`
-will return that content in the corresponding markdown format. For grouped content, variable
-parameters will be provided on the method call to allow for things like correctly numbered
-bullet lists. Each call to the generator is treated as a separate
-markdown operation. So things like link definitions aren't going to be supported,
-at least not in 1.0
-
-Speaking of versioning, I'll use semantic versioning to indicate when new markdown
-capabilities are added. I'll release 1.0 when I feel like it supports set
-of markdown capabilites that fulfill the intended use. This will also include some
-extended capabilities from expanded syntaxes like GitHub flavored markdown. Methods
-generating non-core markdown will be noted in the documentation for that method.
-
-If all goes well, and it appears anyone is using this gem, then a 2.0 release is
-envisioned that will add a `Document` class that will provide a
-more holistic layer of capabilities. For example, the aformentioned reference style
-links would be nice. As would the ability to have an arbitrarily long string broken
-down into nicely formatted hard break paragraphs. Same goes for nicely indented multi-line
-bullets, etc.
-
 Installation
 ------------
 
@@ -51,19 +24,53 @@ Usage
 -----
 
 MarkMaker provides line oriented conversion of content to markdown elements. It
-currently supports first, second and third level headings, links, bullets, numbered
+currently supports headings, links, bullets, numbered
 bullets, *emphasis*, **strong**, code
-and basic table markdown. See bin/generate_readme.rb for the code used to generate this
+and table markdown. See bin/generate_readme.rb for the code used to generate this
 document and a sample of all these markdown generators in action.
 
+Simple markdown generation is handled by extensions to the ruby String class. Headers,
+code, emphasis, and strong are all handled by String methods.
+
+Multi line and more complex conversions are handled by a Generator class.
+
 ### Header Example
-    gen = MarkMaker::Generator.new
-    gen.header1('Let It Begin'')
 
-Produces
+The following ruby code ...
+
+```ruby
+  h = "Let It Begin"
+  puts h.header1
+  puts h.header2
+  puts h.header3
+  puts h.header4
+  puts h.header5
+  puts h.header6
+```
+
+Results in this generated markdown ...
+```
+Let It Begin
+============
+Let It Begin
+------------
+### Let It Begin
+#### Let It Begin
+##### Let It Begin
+###### Let It Begin
+```
+
+Ultimately looking something like this (if your are viewing this on github or through some other markdown viewing method) ...
+
+Let It Begin
+============
+Let It Begin
+------------
+### Let It Begin
+#### Let It Begin
+##### Let It Begin
+###### Let It Begin
 
-    Let It Begin
-    ============
 
 ### Bulleted List Example
 
@@ -151,14 +158,16 @@ puts total
 
 ### Table Example
 
-      header, separator = gen.table_header("Col One", "Col Two", "Col Three")
-      puts header
-      puts separator
-      puts gen.table_row("First", "A", "$3.99")
-      puts gen.table_row("Second", "BC", "$14.00")
-      puts gen.table_row("Third", "DEFGH", "$1,034.50")
+```ruby
+  header, separator = gen.table_header("Col One", "Col Two", "Col Three")
+  puts header
+  puts separator
+  puts gen.table_row("First", "A", "$3.99")
+  puts gen.table_row("Second", "BC", "$14.00")
+  puts gen.table_row("Third", "DEFGH", "$1,034.50")
+```
 
-Produces this terribly ugly markdown ...
+Produces this terribly ugly markdown (but standby, there is a better way below) ...
 
 ```
 |Col One|Col Two|Col Three|
@@ -242,3 +251,27 @@ existing README.md
 
 I'm calling this Extreme [Readme Driven Development](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html).
 It's kind of like [Inception](http://en.wikipedia.org/wiki/Inception) ;)
+
+Supported Ruby Versions
+-----------------------
+
+The following ruby versions are explicitly supported and exercised via TravisCI (see .travis.yml)
+
+ - ruby-head
+ - 2.7
+ - 2.6
+ - 2.3
+
+Release Process
+---------------
+
+Document release changes in `CHANGELOG.md`
+
+Increment the VERSION number in `lib/mark_maker/version.rb`
+
+Run `rake release` which will:
+
+ - build the gem into the `pkg/` director
+ - create a git tag for the version
+ - push to github
+ - push the packaged gem to rubygems

data/Rakefile

@@ -1,6 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
-require 'rubocop/rake_task'
+require 'rubocop/rake_task' unless ENV['CI'] == 'true'
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -13,12 +13,13 @@ task :console do
   exec "irb -r mark_maker -I ./lib"
 end
 
-RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb']
+if ENV['CI'] != 'true'
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb']
+  end
 end
 
 desc "generate the readme file for the project programatically using MarkMaker"
 task :readme do
   exec "ruby -Ilib bin/generate_readme.rb > README.md"
 end
-

data/bin/generate_readme.rb

@@ -11,7 +11,7 @@
 # would be a good way to eat my own dogfood and provide
 # a solid example.
 # 
-# examples. So here goes ... extreme readme driven development!
+# So here goes ... extreme readme driven development!
 
 require 'mark_maker'
 
@@ -25,90 +25,85 @@ ensure
 end
 
 gen = MarkMaker::Generator.new
-puts gen.header1("MarkMaker")
+puts gen.image("MarkMaker build status", "https://travis-ci.org/sn1de/mark_maker.svg?branch=master", "Build Status")
+puts ""
+puts "MarkMaker".header1
 puts ""
 puts "Programatically generate markdown documents."
 puts ""
-puts gen.header2("Intended Use")
-puts ""
-puts "The mark_maker gem provides a set of methods that take text content and"
-puts "convert it to various markdown elements. The primary use case is simple"
-puts "conversion of something like a JSON document into a markdown document."
-puts "" 
-puts "The initial development goal is to provide"
-puts "support for all of the markdown supported operations, at least in their basic form. What"
-puts "I mean by basic is that you provide a 'chunk' of content and the mark_maker #{ gen.code_span('Generator') }"
-puts "will return that content in the corresponding markdown format. For grouped content, variable"
-puts "parameters will be provided on the method call to allow for things like correctly numbered"
-puts "bullet lists. Each call to the generator is treated as a separate"
-puts "markdown operation. So things like link definitions aren't going to be supported,"
-puts "at least not in 1.0"
-puts ""
-puts "Speaking of versioning, I'll use semantic versioning to indicate when new markdown"
-puts "capabilities are added. I'll release 1.0 when I feel like it supports set"
-puts "of markdown capabilites that fulfill the intended use. This will also include some"
-puts "extended capabilities from expanded syntaxes like GitHub flavored markdown. Methods"
-puts "generating non-core markdown will be noted in the documentation for that method."
-puts ""
-puts "If all goes well, and it appears anyone is using this gem, then a 2.0 release is"
-puts "envisioned that will add a #{ gen.code_span('Document') } class that will provide a"
-puts "more holistic layer of capabilities. For example, the aformentioned reference style"
-puts "links would be nice. As would the ability to have an arbitrarily long string broken"
-puts "down into nicely formatted hard break paragraphs. Same goes for nicely indented multi-line"
-puts "bullets, etc."
-puts ""
-puts gen.header2("Installation")
+puts "Installation".header2
 puts ""
 puts "Add this line to your application's Gemfile:"
 puts ""
-puts gen.code("gem 'mark_maker'")
+puts "gem 'mark_maker'".code
 puts ""
 puts "And then execute:"
 puts ""
-puts gen.code("$ bundle")
+puts "$ bundle".code
 puts ""
 puts "Or install it yourself as:"
 puts ""
-puts gen.code("$ gem install mark_maker")
+puts "$ gem install mark_maker".code
 puts ""
-puts gen.header2("Usage")
+puts "Usage".header2
 puts ""
 puts "MarkMaker provides line oriented conversion of content to markdown elements. It"
-puts "currently supports first, second and third level headings, links, bullets, numbered"
-puts "bullets, #{gen.emphasis('emphasis')}, #{gen.strong('strong')}, code"
-puts "and basic table markdown. See #{__FILE__} for the code used to generate this"
+puts "currently supports headings, links, bullets, numbered"
+puts "bullets, #{'emphasis'.emphasis}, #{'strong'.strong}, code"
+puts "and table markdown. See #{__FILE__} for the code used to generate this"
 puts "document and a sample of all these markdown generators in action."
 puts ""
-puts gen.header3("Header Example")
-example_header = "Let It Begin"
-puts gen.code("gen = MarkMaker::Generator.new")
-puts gen.code("gen.header1('#{example_header}'')")
-puts "\nProduces\n\n"
-gen.header1(example_header).lines.map { |l| puts gen.code(l) }
+puts "Simple markdown generation is handled by extensions to the ruby String class. Headers,"
+puts "code, emphasis, and strong are all handled by String methods."
+puts ""
+puts "Multi line and more complex conversions are handled by a Generator class."
+puts ""
+puts "Header Example".header3
+puts ""
+puts "The following ruby code ..."
+puts ""
+header_code = <<-EOT
+  h = "Let It Begin"
+  puts h.header1
+  puts h.header2
+  puts h.header3
+  puts h.header4
+  puts h.header5
+  puts h.header6
+EOT
+puts gen.fenced_code_language('ruby', *header_code.lines)
+puts ""
+puts "Results in this generated markdown ..."
+header_markdown = capture_stdout do
+  eval(header_code)
+end
+puts gen.fenced_code_block(*header_markdown.string.lines)
+puts "\nUltimately looking something like this (if your are viewing this on github or through some other markdown viewing method) ...\n\n"
+puts eval(header_code)
 puts ""
-puts gen.header3("Bulleted List Example")
+puts "Bulleted List Example".header3
 list_content = ['gold', 'silver', 'bronze']
 puts ""
-puts gen.code("list_content = ['gold', 'silver', 'bronze']")
-puts gen.code("gen.bullets(*list_content)")
+puts "list_content = ['gold', 'silver', 'bronze']".code
+puts "gen.bullets(*list_content)".code
 puts "\nProduces\n\n"
 puts gen.code_block(*gen.bullets(*list_content))
 puts ""
 puts "Or a numbered list with..."
 puts ""
 numbered_code = "gen.numbers(*list_content)"
-puts gen.code(numbered_code)
+puts numbered_code.code
 puts ""
 puts "Produces"
 puts ""
 puts gen.code_block(*eval(numbered_code))
 puts ""
-puts gen.header3("Code Examples")
+puts "Code Examples".header3
 puts ""
-puts "Standard markdown code blocks and #{gen.code_span('code span')} are supported, as well as github"
+puts "Standard markdown code blocks and #{'code span'.code_span} are supported, as well as github"
 puts "flavored markdown fenced code blocks."
 puts ""
-sample_block = <<-EOT.lines
+sample_block = <<-EOT.lines.to_a
 some_code = [ "# add it up",
               "total = [1, 2, 3, 4].inject do |sum, i|",
               "  sum += i",
@@ -125,7 +120,7 @@ puts ""
 puts "You can also generate a github flavored markdown fenced code version."
 fenced_code = "gen.fenced_code_block(*some_code)"
 puts ""
-puts gen.code(fenced_code)
+puts fenced_code.code
 puts ""
 puts "Produces"
 puts ""
@@ -134,7 +129,7 @@ puts ""
 puts "You can also include a language in a fenced code block."
 puts ""
 fenced_code_language = "gen.fenced_code_language('ruby', *some_code)"
-puts gen.code(fenced_code_language)
+puts fenced_code_language.code
 puts ""
 puts "Produces"
 puts ""
@@ -144,7 +139,7 @@ puts "Rendering beautifully highlighted code like so, if you are viewing this on
 puts ""
 puts eval("#{sample_block.join}\n#{fenced_code_language}")
 puts ""
-puts gen.header3("Table Example")
+puts "Table Example".header3
 puts ""
 table_code = <<-EOT
   header, separator = gen.table_header("Col One", "Col Two", "Col Three")
@@ -154,9 +149,9 @@ table_code = <<-EOT
   puts gen.table_row("Second", "BC", "$14.00")
   puts gen.table_row("Third", "DEFGH", "$1,034.50")
 EOT
-puts gen.code_block(*table_code.lines)
+puts gen.fenced_code_language('ruby', *table_code.lines)
 puts ""
-puts "Produces this terribly ugly markdown ..."
+puts "Produces this terribly ugly markdown (but standby, there is a better way below) ..."
 puts ""
 table_markdown = capture_stdout do 
   eval(table_code)
@@ -185,7 +180,7 @@ puts "Which gives you this stunning HTML table ..."
 puts ""
 puts eval(pretty_table_code)
 puts ""
-puts gen.header3("Block Quotes Example")
+puts "Block Quotes Example".header3
 puts ""
 block_quote_code = <<-EOT
 content = <<-QUOTE
@@ -208,7 +203,7 @@ puts "Which looks like this when viewed as HTML..."
 puts ""
 puts eval(block_quote_code)
 puts ""
-puts gen.header2("Contributing")
+puts "Contributing".header2
 puts ""
 puts gen.numbers(gen.link("Fork it", "https://github.com/sn1de/mark_maker/fork"),
                    "Create your feature branch (`git checkout -b my-new-feature`)",
@@ -216,14 +211,34 @@ puts gen.numbers(gen.link("Fork it", "https://github.com/sn1de/mark_maker/fork")
                    "Push to the branch (`git push origin my-new-feature`)",
                    "Create a new Pull Request")
 puts ""
-puts gen.header2("About This README")
+puts "About This README".header2
 puts ""
 puts "This readme document is created using MarkMaker. To modify it, edit the code"
 puts "in #{__FILE__} and then run the 'readme' rake task to generate and overwrite the"
 puts "existing README.md"
 puts ""
-puts gen.code("vi #{__FILE__}")
-puts gen.code("rake readme")
+puts "vi #{__FILE__}".code
+puts "rake readme".code
 puts ""
 puts "I'm calling this Extreme #{gen.link("Readme Driven Development", "http://tom.preston-werner.com/2010/08/23/readme-driven-development.html")}."
 puts "It's kind of like #{gen.link("Inception", "http://en.wikipedia.org/wiki/Inception")} ;)"
+puts ""
+puts "Supported Ruby Versions".header2
+puts ""
+puts "The following ruby versions are explicitly supported and exercised via TravisCI (see .travis.yml)"
+puts ""
+puts gen.bullets("ruby-head", "2.7", "2.6", "2.3")
+puts ""
+puts "Release Process".header2
+puts ""
+puts "Document release changes in `CHANGELOG.md`"
+puts ""
+puts "Increment the VERSION number in `lib/mark_maker/version.rb`"
+puts ""
+puts "Run `rake release` which will:"
+puts ""
+puts gen.bullets("build the gem into the `pkg/` director",
+                 "create a git tag for the version",
+                 "push to github",
+                 "push the packaged gem to rubygems")
+

data/lib/mark_maker/generator.rb

@@ -1,20 +1,9 @@
+require 'mark_maker_string'
+
 module MarkMaker
   # Generator is the workhorse of the MarkMaker utility. It provides
   # line by line generation of markdown output.
   class Generator
-    def line_for(underscore, content)
-      underscore * content.size
-    end
-
-    def line_for_left
-    end
-
-    def line_for_right
-    end
-
-    def line_for_center
-    end
-
     # Justification indicators are a bit of a special case, because the way
     # they actually work is the colon's proximity to the vertical | bars marking
     # the table cells. This means that the center justification indicator, for
@@ -42,49 +31,24 @@ module MarkMaker
       justification?(c) ? '-' : fill
     end
 
-    def header1(title)
-      "#{title}\n#{line_for('=', title)}"
-    end
-
-    def header2(title)
-      "#{title}\n#{line_for('-', title)}"
-    end
-
-    def header3(title)
-      "### #{title}"
-    end
-
-    def bullet(content)
-      " - #{content}"
-    end
-
     def bullets(*content)
-      content.map { |li| bullet(li) }
-    end
-
-    def number(content, number = 1)
-      " #{number}. #{content}"
+      content.map(&:bullet)
     end
 
     def numbers(*content)
-      current_number = 0
-      content.map { |li| number(li, current_number += 1) }
+      content.each.with_index(1).map { |l, i| l.number(i) }
     end
 
     def link(label, url)
       "[#{label}](#{url})"
     end
 
-    def code(content)
-      "    #{content}"
-    end
-
-    def code_span(content)
-      "#{CODE_TIC}#{content}#{CODE_TIC}"
+    def image(alt, path, title = "")
+      %Q(![#{alt}](#{path} "#{title}"))
     end
 
     def code_block(*content)
-      content.map { |c| code(c) }
+      content.map(&:code)
     end
 
     # creates a github flavored markdown fenced code block
@@ -102,14 +66,6 @@ module MarkMaker
       block << FENCE
     end
 
-    def emphasis(content)
-      "#{EMPHASIS}#{content}#{EMPHASIS}"
-    end
-
-    def strong(content)
-      EMPHASIS * 2 + content + EMPHASIS * 2
-    end
-
     def table_header(*content)
       [
         content.inject("|") { |a, e| a + "#{e}|" },
@@ -200,8 +156,7 @@ module MarkMaker
     end
 
     def column_width(*content)
-      longest = content.reduce { |a, e| a.length > e.length ? a : e }
-      longest.length
+      content.reduce { |a, e| a.length > e.length ? a : e } .length
     end
 
     def centered_margins(width, content)

data/lib/mark_maker/version.rb

@@ -1,4 +1,4 @@
 # version management
 module MarkMaker
-  VERSION = "0.5.1"
+  VERSION = "1.0.0"
 end

data/lib/mark_maker_string.rb

@@ -0,0 +1,55 @@
+
+# adds several basic string to markdown conversion methods
+class String
+  def line_for(underscore)
+    underscore * size
+  end
+
+  def header1
+    "#{self}\n#{line_for('=')}"
+  end
+
+  def header2
+    "#{self}\n#{line_for('-')}"
+  end
+
+  def header3
+    "### #{self}"
+  end
+
+  def header4
+    "#### #{self}"
+  end
+
+  def header5
+    "##### #{self}"
+  end
+
+  def header6
+    "###### #{self}"
+  end
+
+  def bullet
+    " - #{self}"
+  end
+
+  def number(number = 1)
+    " #{number}. #{self}"
+  end
+
+  def code
+    "    #{self}"
+  end
+
+  def code_span
+    "#{MarkMaker::CODE_TIC}#{self}#{MarkMaker::CODE_TIC}"
+  end
+
+  def emphasis
+    "#{MarkMaker::EMPHASIS}#{self}#{MarkMaker::EMPHASIS}"
+  end
+
+  def strong
+    MarkMaker::EMPHASIS * 2 + self + MarkMaker::EMPHASIS * 2
+  end
+end

data/mark_maker.gemspec

@@ -12,17 +12,18 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Programatically generate markdown documents.}
   spec.homepage      = ""
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9.3'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 2"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "unindent"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "minitest-reporters", '~> 1.1', '>= 1.1.8'
 end

data/test/minitest_helper.rb

@@ -1,6 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'mark_maker'
-require 'active_support/core_ext/string'
+require 'mark_maker_string'
 require 'minitest/autorun'
 require 'minitest/reporters'
 Minitest::Reporters.use! Minitest::Reporters::DefaultReporter.new

data/test/test_headers.rb

@@ -0,0 +1,47 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest_helper'
+
+class TestHeaders < Minitest::Test
+  def test_header1_generation
+    title = "abc123"
+    markup = title.header1
+    assert_match(/^={#{title.size}}$/, markup)
+    assert_match(/^#{title}$/, markup)
+    assert_match(/^#{title}\n={#{title.size}}$/, markup)
+  end
+
+  def test_header2_generation
+    title = "abc123"
+    markup = title.header2
+    assert_match(/^-{#{title.size}}$/, markup)
+    assert_match(/^#{title}$/, markup)
+    assert_match(/^#{title}\n-{#{title.size}}$/, markup)
+  end
+
+  def test_header3_generation
+    title = "abc123"
+    markup = title.header3
+    assert_match(/###\s#{title}/, markup)
+  end
+
+  def test_header4_generation
+    title = "abc123"
+    markup = title.header4
+    assert_match(/####\s#{title}/, markup)
+  end
+
+  def test_header5_generation
+    title = "abc123"
+    markup = title.header5
+    assert_match(/#####\s#{title}/, markup)
+  end
+
+  def test_header6_generation
+    title = "abc123"
+    markup = title.header6
+    assert_match(/######\s#{title}/, markup)
+  end
+
+end

data/test/test_mark_maker.rb

@@ -1,3 +1,4 @@
+require 'unindent'
 require 'simplecov'
 SimpleCov.start
 
@@ -8,38 +9,6 @@ class TestMarkMaker < Minitest::Test
     refute_nil ::MarkMaker::VERSION
   end
 
-  def test_header1_generation
-    title = "abc123"
-    gen = MarkMaker::Generator.new
-    markup = gen.header1(title)
-    assert_match(/^={#{title.size}}$/, markup)
-    assert_match(/^#{title}$/, markup)
-    assert_match(/^#{title}\n={#{title.size}}$/, markup)
-  end
-
-  def test_header2_generation
-    title = "abc123"
-    gen = MarkMaker::Generator.new
-    markup = gen.header2(title)
-    assert_match(/^-{#{title.size}}$/, markup)
-    assert_match(/^#{title}$/, markup)
-    assert_match(/^#{title}\n-{#{title.size}}$/, markup)
-  end
-
-  def test_header3_generation
-    title = "abc123"
-    gen = MarkMaker::Generator.new
-    markup = gen.header3(title)
-    assert_match(/###\s#{title}/, markup)
-  end
-
-  def test_bullet_generation
-    content = "This is a bullet"
-    gen = MarkMaker::Generator.new
-    markup = gen.bullet(content)
-    assert_match(/^ - #{content}$/, markup)
-  end
-
   def test_bulleted_list_generation
     content = ["gold", "silver", "bronze"]
     gen = MarkMaker::Generator.new
@@ -49,12 +18,6 @@ class TestMarkMaker < Minitest::Test
       assert_match(/^\s-\s#{c}$/, m)
     end
   end
-  def test_number_generation
-    content = "Number this line"
-    gen = MarkMaker::Generator.new
-    markup = gen.number(content)
-    assert_match(/^\s\d\.\s#{content}$/, markup)
-  end
 
   def test_numbered_list_generation
     content = ["1", "2", "3"]
@@ -74,17 +37,13 @@ class TestMarkMaker < Minitest::Test
     assert_match(/^\[#{label}\]\(#{url}\)$/, markup)
   end
 
-  def test_code_generation
-    content = "var = code()"
+  def test_image_generation
+    path = "https://travis-ci.org/sn1de/mark_maker.svg?branch=master"
+    alt = "Mark Maker build status from Travis continuous integration"
+    title = "Build Status"
     gen = MarkMaker::Generator.new
-    markup = gen.code(content)
-    assert_match(/\s{4}var = code\(\)$/, markup)
-  end
-
-  def test_code_span_generation
-    gen = MarkMaker::Generator.new
-    markup = "Some #{gen.code_span('a = b + c')} here."
-    assert_match(/^Some #{MarkMaker::CODE_TIC}a = b \+ c#{MarkMaker::CODE_TIC} here.$/, markup)
+    markup = gen.image(alt, path, title)
+    assert_match(/^!\[#{Regexp.quote(alt)}\]\(#{Regexp.quote(path)}\s"#{Regexp.quote(title)}"\)/, markup)
   end
 
   def test_code_block_generation
@@ -118,20 +77,6 @@ class TestMarkMaker < Minitest::Test
     assert(markup.last == MarkMaker::FENCE, "Markup should end with the code fence.")
   end
 
-  def test_emphasis_generation
-    content = "emphasize this"
-    gen = MarkMaker::Generator.new
-    markup = gen.emphasis(content)
-    assert_match(/^#{Regexp.quote(MarkMaker::EMPHASIS)}#{content}#{Regexp.quote(MarkMaker::EMPHASIS)}$/, markup)
-  end
-
-  def test_strong_generation
-    content = "strong stuff"
-    gen = MarkMaker::Generator.new
-    markup = gen.strong(content)
-    assert_match(/^#{Regexp.quote(MarkMaker::EMPHASIS * 2)}#{content}#{Regexp.quote(MarkMaker::EMPHASIS * 2)}$/, markup)
-  end
-
   def test_table_header_generation
     content = ["Col One", "Col Two", "Col 3"]
     gen  = MarkMaker::Generator.new
@@ -160,22 +105,26 @@ class TestMarkMaker < Minitest::Test
   # usage of a heredoc as a test method
 
   def test_heredoc_method
-    desired_output = <<-EOS.strip_heredoc
-      This should contain no intents.
+    desired_output = <<-EOS.unindent
+      This should contain no indents.
 
       It should be 3 lines long.
     EOS
-    test_output = "This should contain no intents.\n\nIt should be 3 lines long.\n"
+    test_output = "This should contain no indents.\n\nIt should be 3 lines long.\n"
     assert_equal(desired_output, test_output, "Output must exactly match.")
   end
 
+  def test_join
+    assert_equal("abc", ["a", "b", "c"].join)
+  end
+
   def test_column_width
     gen = MarkMaker::Generator.new
     assert_equal(5, gen.column_width("One", "Two", "12345", "Four"))
   end
 
   def test_pretty_table_generation
-    pretty_table = <<-EOS.strip_heredoc
+    pretty_table = <<-EOS.unindent
       |Col One|Col Two|Col Three|
       |:------|:-----:|--------:|
       |First  |   A   |    $3.99|
@@ -215,12 +164,6 @@ class TestMarkMaker < Minitest::Test
     assert_equal(test_justified, gen_justified)
   end
 
-  def test_column_width
-    gen = MarkMaker::Generator.new
-    width = gen.column_width("a", "bbb", "ccccc", "dd")
-    assert_equal(5, width)
-  end
-
   def test_centered_margins
     gen = MarkMaker::Generator.new
     left, right = gen.centered_margins(5, "cc")
@@ -305,7 +248,7 @@ class TestMarkMaker < Minitest::Test
   # end
 
   # def test_right_justify_table_column
-  #   right_justified = <<-EOS.strip_heredoc
+  #   right_justified = <<-EOS.unindent
   #     |  Justified|
   #     |----------:|
   #     |          a|
@@ -319,7 +262,7 @@ class TestMarkMaker < Minitest::Test
 
 
   # def test_pretty_table_justified_generation
-  #   pretty_table = <<-EOS.strip_heredoc
+  #   pretty_table = <<-EOS.unindent
   #     |Col One|Col Two|Col Three |Data Sized   |
   #     |-------|-------|----------|-------------|
   #     |First  |   A   |     $3.99|xxxxxxxxxxxxx|

data/test/test_mark_maker_string.rb

@@ -0,0 +1,41 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest_helper'
+
+class TestMarkMakerString < Minitest::Test
+  def test_bullet_generation
+    content = "This is a bullet"
+    markup = content.bullet
+    assert_match(/^ - #{content}$/, markup)
+  end
+
+  def test_number_generation
+    content = "Number this line"
+    markup = content.number
+    assert_match(/^\s\d\.\s#{content}$/, markup)
+  end
+
+  def test_code_generation
+    content = "var = code()"
+    markup = content.code
+    assert_match(/\s{4}var = code\(\)$/, markup)
+  end
+
+  def test_code_span_generation
+    markup = "Some #{'a = b + c'.code_span} here."
+    assert_match(/^Some #{MarkMaker::CODE_TIC}a = b \+ c#{MarkMaker::CODE_TIC} here.$/, markup)
+  end
+
+  def test_emphasis_generation
+    content = "emphasize this"
+    markup = content.emphasis
+    assert_match(/^#{Regexp.quote(MarkMaker::EMPHASIS)}#{content}#{Regexp.quote(MarkMaker::EMPHASIS)}$/, markup)
+  end
+
+  def test_strong_generation
+    content = "strong stuff"
+    markup = content.strong
+    assert_match(/^#{Regexp.quote(MarkMaker::EMPHASIS * 2)}#{content}#{Regexp.quote(MarkMaker::EMPHASIS * 2)}$/, markup)
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Schneider
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: unindent
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,19 +95,25 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.8
 description: Programatically generate markdown documents.
 email:
 - brad.schneider@me.com
@@ -129,14 +135,17 @@ files:
 - lib/mark_maker.rb
 - lib/mark_maker/generator.rb
 - lib/mark_maker/version.rb
+- lib/mark_maker_string.rb
 - mark_maker.gemspec
 - test/minitest_helper.rb
+- test/test_headers.rb
 - test/test_mark_maker.rb
+- test/test_mark_maker_string.rb
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,18 +153,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Markdown generator.
 test_files:
 - test/minitest_helper.rb
+- test/test_headers.rb
 - test/test_mark_maker.rb
+- test/test_mark_maker_string.rb