mark_maker 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69e37903d222999dbd87778a55fb41e841054995
-  data.tar.gz: 5899b79c8427151ed0bb4979546d679a8191e1dc
+  metadata.gz: 1ec41b346051f4ed6f008e0a86402a5174edcb1c
+  data.tar.gz: 0831f0feeebeaea95093c34096f573f300dbfd0e
 SHA512:
-  metadata.gz: 560761348ac0f5da4fd4442f070eb57ceed38906b5911a35aaa016c85a572d7abcfbfbefa47bc64ec9fb903b6f7d924916941c1ad498f7c4ad13d90b1db91d1f
-  data.tar.gz: aff10b5f78ba18af4f401506445027bbab02ab3c704ad5096a417c32488c959ffa679b93d98bf5f440170873d61f22275d3ab479492c3b71f87eb65e2f1c375e
+  metadata.gz: 76a8c2ded0d68a56c51b0ffd4aa766b4bad4c617fcbe52f2e01ff13baab17eed6edc78566ef1e2ceecbef71bf0aaa530dce7f2cff1ae73ab5e422a109e34a7a5
+  data.tar.gz: 727d53292772a0a0ad187480b744965d44117b6e1072136df0b4006f97e76f74c28c9a219ac29844143c429f13ef047a8317170ad6a8e17ea1289c5a12bd24dc

data/README.md

@@ -42,17 +42,82 @@ Produces
 
 Produces
 
- - gold
- - silver
- - bronze
+     - gold
+     - silver
+     - bronze
 
 Or a numbered list with...
 
     gen.numbers(*list_content)
 
- 1. gold
- 2. silver
- 3. bronze
+Produces
+
+     1. gold
+     2. silver
+     3. bronze
+
+### Code Examples
+
+Standard markdown code blocks and embedding are supported, as well as github
+flavored markdown fenced code blocks.
+
+    some_code = [ "# add it up",
+                  "total = [1, 2, 3, 4].inject do |sum, i|",
+                  "  sum += i",
+                  "end",
+                  "",
+                  "puts total" ]
+    gen.code_block(*some_code)
+
+Produces
+
+        # add it up
+        total = [1, 2, 3, 4].inject do |sum, i|
+          sum += i
+        end
+        
+        puts total
+
+You can also generate a github flavored markdown fenced code version.
+
+    gen.fenced_code_block(*some_code)
+
+Produces
+
+    ```
+    # add it up
+    total = [1, 2, 3, 4].inject do |sum, i|
+      sum += i
+    end
+    
+    puts total
+    ```
+
+You can also include a language in a fenced code block.
+
+    gen.fenced_code_language('ruby', *some_code)
+
+Produces
+
+    ```ruby
+    # add it up
+    total = [1, 2, 3, 4].inject do |sum, i|
+      sum += i
+    end
+    
+    puts total
+    ```
+
+Rendering beautifully highlighted code like so, if you are viewing this on github.
+
+```ruby
+# add it up
+total = [1, 2, 3, 4].inject do |sum, i|
+  sum += i
+end
+
+puts total
+```
 
 Contributing
 ------------

data/bin/generate_readme.rb

@@ -24,13 +24,7 @@ doc << gen.header2("Installation")
 doc << ""
 doc << "Add this line to your application's Gemfile:"
 doc << ""
-
-# ```ruby
-
 doc << gen.code("gem 'mark_maker'")
-
-# ```
-
 doc << ""
 doc << "And then execute:"
 doc << ""
@@ -60,14 +54,57 @@ doc << ""
 doc << gen.code("list_content = ['gold', 'silver', 'bronze']")
 doc << gen.code("gen.bullets(*list_content)")
 doc << "\nProduces\n\n"
-doc << gen.bullets(*list_content)
+doc << gen.code_block(*gen.bullets(*list_content))
 doc << ""
 doc << "Or a numbered list with..."
 doc << ""
 numbered_code = "gen.numbers(*list_content)"
 doc << gen.code(numbered_code)
 doc << ""
-doc << eval(numbered_code)
+doc << "Produces"
+doc << ""
+doc << gen.code_block(*eval(numbered_code))
+doc << ""
+doc << gen.header3("Code Examples")
+doc << ""
+doc << "Standard markdown code blocks and embedding are supported, as well as github"
+doc << "flavored markdown fenced code blocks."
+doc << ""
+sample_block = <<-EOT.split("\n")
+some_code = [ "# add it up",
+              "total = [1, 2, 3, 4].inject do |sum, i|",
+              "  sum += i",
+              "end",
+              "",
+              "puts total" ]
+EOT
+execution_block = "gen.code_block(*some_code)"
+doc << gen.code_block(*sample_block, execution_block)
+doc << ""
+doc << "Produces\n\n"
+doc << gen.code_block(*gen.code_block(*eval(sample_block.join)))
+doc << ""
+doc << "You can also generate a github flavored markdown fenced code version."
+fenced_code = "gen.fenced_code_block(*some_code)"
+doc << ""
+doc << gen.code(fenced_code)
+doc << ""
+doc << "Produces"
+doc << ""
+doc << gen.code_block(*eval("#{sample_block.join}\n#{fenced_code}\n"))
+doc << ""
+doc << "You can also include a language in a fenced code block."
+doc << ""
+fenced_code_language = "gen.fenced_code_language('ruby', *some_code)"
+doc << gen.code(fenced_code_language)
+doc << ""
+doc << "Produces"
+doc << ""
+doc << gen.code_block(*eval("#{sample_block.join}\n#{fenced_code_language}"))
+doc << ""
+doc << "Rendering beautifully highlighted code like so, if you are viewing this on github."
+doc << ""
+doc << eval("#{sample_block.join}\n#{fenced_code_language}")
 doc << ""
 doc << gen.header2("Contributing")
 doc << ""

data/lib/mark_maker/generator.rb

@@ -46,5 +46,29 @@ module MarkMaker
     def code(content)
       "    #{content}"
     end
+
+    def code_block(*content)
+      block = []
+      content.each { |c| block << code(c) }
+      block
+    end
+
+    # creates a github flavored markdown fenced code block
+    def fenced_code_block(*content)
+      block = []
+      block << MarkMaker::FENCE
+      content.each { |c| block << c }
+      block << MarkMaker::FENCE
+      block
+    end
+
+    # creates a github flavored markdown fenced code block that
+    # specifies the language for syntax highlighting purposes
+    def fenced_code_language(lang, *content)
+      block = []
+      block << MarkMaker::FENCE + lang
+      content.each { |c| block << c }
+      block << MarkMaker::FENCE
+    end
   end
 end

data/lib/mark_maker/version.rb

@@ -1,3 +1,3 @@
 module MarkMaker
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/mark_maker.rb

@@ -12,4 +12,5 @@ end
 # format and generating markdown documents from that source in
 # a line by line method.
 module MarkMaker
+  FENCE = "```"
 end

data/test/test_mark_maker.rb

@@ -77,4 +77,35 @@ class TestMarkMaker < Minitest::Test
     markup = gen.code(content)
     assert_match(/\s{4}var = code\(\)$/, markup)
   end
+
+  def test_code_block_generation
+    content = ["a = 1", "b = 2", "c = 3"]
+    gen = MarkMaker::Generator.new
+    markup = gen.code_block(*content)
+    assert(markup.length == content.length, "The number of lines of content and markup is not equal.")
+    content.zip(markup).each do |c, m|
+      assert_match(/^\s{4}#{c}$/, m)
+    end
+  end
+
+  def test_fenced_code_block_generation
+    content = ["a = 1", "b = 2", "c = 3"]
+    gen = MarkMaker::Generator.new
+    markup = gen.fenced_code_block(*content)
+    assert(markup.length == content.length + 2, "Length of markup should equal the content plus the two fences.")
+    assert(markup.slice(1, content.length) == content, "The code body of the markup should match the original content exactly.")
+    assert(markup.first == MarkMaker::FENCE, "Markup should start with the code fence.")
+    assert(markup.last == MarkMaker::FENCE, "Markup should end with the code fence.")
+  end
+
+  def test_fenced_code_language_generation
+    content = ["a = 1", "b = 2", "c = 3"]
+    lang = "ruby"
+    gen = MarkMaker::Generator.new
+    markup = gen.fenced_code_language(lang, *content)
+    assert(markup.length == content.length + 2, "Length of markup should equal the content plus the two fences.")
+    assert(markup.slice(1, content.length) == content, "The code body of the markup should match the original content exactly.")
+    assert(markup.first == MarkMaker::FENCE + lang, "Markup should start with the code fence and the language.")
+    assert(markup.last == MarkMaker::FENCE, "Markup should end with the code fence.")
+  end
 end

metadata

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