mark_maker 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd856055ec57459656c6963b82423f55febfe440
-  data.tar.gz: 355e6e14d071a9d53a9f2fd4333896ab1e0253b7
+  metadata.gz: 2a7bac7fc41d83b17b78b5a283583184300401c6
+  data.tar.gz: 62d762c6bb495e6e5a33959b7c5690e50fcdd4ef
 SHA512:
-  metadata.gz: 95a31758ca8963bebd1080210c333c0ffc7d29767ffeaed3151a7cf92c5cd8bbacaa7788ad359c73efb9db943c735d5e8564eb7ddb2a2cbf47c1d6986203b075
-  data.tar.gz: 351deb838b05b55f91f1a40991de02e297ed08bbc795a7ffb73cf7d9dad0c74648f26337fb88dcf9cd8a012aa860be5402be3e2906331ae1b136f7053f73f383
+  metadata.gz: 38cc8d20ce8e44d3dc5870e0916142046492d8c487e501fe9395c977b202b98d74bf3a36113f821281fbdaaa1e422704cfa328aed355d2f20efdcf2e33f34799
+  data.tar.gz: f1677746325c615dafc7bd39352d2a5f7fe63c5c18a608865e8c53d410d9c2883ed19c8f68c6798be453f9bc8c26722a91dd78cc80ac9315986ab067520757c7

data/README.md

@@ -56,14 +56,16 @@ bullets, *emphasis*, **strong**, code
 and basic 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'')
+    'Let It Begin'.header1
 
 Produces
 
-    Let It Begin
-    ============
 
 ### Bulleted List Example
 

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,11 +25,11 @@ ensure
 end
 
 gen = MarkMaker::Generator.new
-puts gen.header1("MarkMaker")
+puts "MarkMaker".header1
 puts ""
 puts "Programatically generate markdown documents."
 puts ""
-puts gen.header2("Intended Use")
+puts "Intended Use".header2
 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"
@@ -37,7 +37,7 @@ 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 "I mean by basic is that you provide a 'chunk' of content and the mark_maker #{ 'Generator'.code_span }"
 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"
@@ -51,61 +51,65 @@ puts "extended capabilities from expanded syntaxes like GitHub flavored markdown
 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 "envisioned that will add a #{ 'Document'.code_span } 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 "bullets, #{'emphasis'.emphasis}, #{'strong'.strong}, code"
 puts "and basic 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")
+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
 example_header = "Let It Begin"
-puts gen.code("gen = MarkMaker::Generator.new")
-puts gen.code("gen.header1('#{example_header}'')")
+puts "'#{example_header}'.header1".code
 puts "\nProduces\n\n"
-gen.header1(example_header).lines.map { |l| puts gen.code(l) }
+example_header.header1.lines.map(&: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
@@ -125,7 +129,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 +138,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 +148,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")
@@ -185,7 +189,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 +212,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 +220,14 @@ 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")} ;)"

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,20 @@ 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}"
-    end
-
     def code_block(*content)
-      content.map { |c| code(c) }
+      content.map(&:code)
     end
 
     # creates a github flavored markdown fenced code block
@@ -102,14 +62,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 +152,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 = "0.6.0"
 end

data/lib/mark_maker_string.rb

@@ -0,0 +1,44 @@
+require 'mark_maker'
+
+# 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 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/test/minitest_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'mark_maker'
+require 'mark_maker_string'
 require 'active_support/core_ext/string'
 require 'minitest/autorun'
 require 'minitest/reporters'

data/test/test_mark_maker.rb

@@ -8,38 +8,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 +17,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,19 +36,6 @@ class TestMarkMaker < Minitest::Test
     assert_match(/^\[#{label}\]\(#{url}\)$/, markup)
   end
 
-  def test_code_generation
-    content = "var = code()"
-    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)
-  end
-
   def test_code_block_generation
     content = ["a = 1", "b = 2", "c = 3"]
     gen = MarkMaker::Generator.new
@@ -118,20 +67,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

data/test/test_mark_maker_string.rb

@@ -0,0 +1,63 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest_helper'
+
+class TestMarkMakerString < 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_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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Brad Schneider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-21 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,9 +129,11 @@ 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_mark_maker.rb
+- test/test_mark_maker_string.rb
 homepage: ''
 licenses:
 - MIT
@@ -159,3 +161,4 @@ summary: Markdown generator.
 test_files:
 - test/minitest_helper.rb
 - test/test_mark_maker.rb
+- test/test_mark_maker_string.rb