mark_maker 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66fe5512a41c6c304d4156591bec7a359a3a34e3
-  data.tar.gz: 3a13cb0564c0331161658693bc0c4a3ec89eb810
+  metadata.gz: 6da9b6765231882d2ded111aae9340b1b776a649
+  data.tar.gz: 3af219a0ebd74752af6694b61dc0467b081cbaef
 SHA512:
-  metadata.gz: e1bd86c66b71d0cd3b232ea17d9dda5d39207fd64519dfac3878f119d63d9752e8141d2b98369898c5bb57377dc3bd523a9851552638d62d6629dbad05637756
-  data.tar.gz: 074857f7001aad4fb85e73f5a3aa5bf6a069bfdcc4aeaac0b5ee6617e0a541cd966847bb130d9664774ef91ebec64b2709354d3a36dee74bd62653683f2d5c03
+  metadata.gz: 7e291fa3de2f051516db8e72157c95236bc2b5892fcffaab4f29c503a103323896aa60bf155596b47c2052d239c12e39131b638d2734fc8b087425c6f16a3748
+  data.tar.gz: 6a3dfc905d93c90da048c84e19edaf9e1d4614f075c78410558588584bc80412ae607bd423bc38a0b7a5362b8d7cbc564db58428bd1703b710bb8887970376a3

data/README.md

@@ -3,6 +3,35 @@ 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
 ------------
 
@@ -59,7 +88,7 @@ Produces
 
 ### Code Examples
 
-Standard markdown code blocks and embedding are supported, as well as github
+Standard markdown code blocks and `code span` are supported, as well as github
 flavored markdown fenced code blocks.
 
     some_code = [ "# add it up",
@@ -148,6 +177,31 @@ Which gives you this stunning HTML table ...
 |Third|C|$1,034.50|
 
 
+### Block Quotes Example
+
+```
+content = <<-QUOTE
+If you want to quote, you'll get a quote.
+Warning, it will just quote line by line, not break it up nicely.
+QUOTE
+puts gen.block_quote(*content.split("
+"))
+```
+
+Produces the markdown ...
+
+```
+> If you want to quote, you'll get a quote.
+> Warning, it will just quote line by line, not break it up nicely.
+```
+
+
+Which looks like this when viewed as HTML...
+
+> If you want to quote, you'll get a quote.
+> Warning, it will just quote line by line, not break it up nicely.
+
+
 Contributing
 ------------
 

data/bin/generate_readme.rb

@@ -29,6 +29,34 @@ puts gen.header1("MarkMaker")
 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 ""
 puts "Add this line to your application's Gemfile:"
@@ -77,7 +105,7 @@ puts gen.code_block(*eval(numbered_code))
 puts ""
 puts gen.header3("Code Examples")
 puts ""
-puts "Standard markdown code blocks and embedding are supported, as well as github"
+puts "Standard markdown code blocks and #{gen.code_span('code span')} are supported, as well as github"
 puts "flavored markdown fenced code blocks."
 puts ""
 sample_block = <<-EOT.split("\n")
@@ -139,6 +167,29 @@ puts "Which gives you this stunning HTML table ..."
 puts ""
 puts eval(table_code)
 puts ""
+puts gen.header3("Block Quotes Example")
+puts ""
+block_quote_code = <<-EOT
+content = <<-QUOTE
+If you want to quote, you'll get a quote.
+Warning, it will just quote line by line, not break it up nicely.
+QUOTE
+puts gen.block_quote(*content.split("\n"))
+EOT
+puts gen.fenced_code_block(*block_quote_code.split("\n"))
+puts ""
+puts "Produces the markdown ..."
+puts ""
+block_quote_markdown = capture_stdout do
+  eval(block_quote_code)
+end
+puts gen.fenced_code_block(*block_quote_markdown.string.split("\n"))
+puts ""
+puts ""
+puts "Which looks like this when viewed as HTML..."
+puts ""
+puts eval(block_quote_code)
+puts ""
 puts gen.header2("Contributing")
 puts ""
 puts gen.numbers(gen.link("Fork it", "https://github.com/sn1de/mark_maker/fork"),

data/lib/mark_maker/generator.rb

@@ -43,6 +43,10 @@ module MarkMaker
       "    #{content}"
     end
 
+    def code_span(content)
+      "#{CODE_TIC}#{content}#{CODE_TIC}"
+    end
+
     def code_block(*content)
       content.map { |c| code(c) }
     end
@@ -80,5 +84,9 @@ module MarkMaker
     def table_row(*content)
       content.inject("|") { |a, e| a << e << "|" }
     end
+
+    def block_quote(*content)
+      content.map { |c| "#{BLOCK_QUOTE} #{c}"}
+    end
   end
 end

data/lib/mark_maker/version.rb

@@ -1,4 +1,4 @@
 # version management
 module MarkMaker
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/mark_maker.rb

@@ -14,6 +14,8 @@ end
 # format and generating markdown documents from that source in
 # a line by line method.
 module MarkMaker
-  FENCE = "```"
+  CODE_TIC = "`"
+  FENCE = CODE_TIC * 3
   EMPHASIS = "*"
+  BLOCK_QUOTE = ">"
 end

data/test/test_mark_maker.rb

@@ -78,6 +78,12 @@ class TestMarkMaker < Minitest::Test
     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
@@ -137,5 +143,14 @@ class TestMarkMaker < Minitest::Test
     row = gen.table_row(*content)
     assert_match(/^\|#{Regexp.quote(content[0])}\|#{Regexp.quote(content[1])}\|#{Regexp.quote(content[2])}\|$/, row)
   end
+
+  def test_block_quote_generation
+    content = ["Line 1", "Line 2", "Line 3"]
+    gen = MarkMaker::Generator.new
+    markup = gen.block_quote(*content)
+    content.zip(markup).each do |c, m| 
+      assert_match(/^> #{Regexp.quote(c)}$/, m)
+    end
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Brad Schneider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler