mark_maker 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6da9b6765231882d2ded111aae9340b1b776a649
-  data.tar.gz: 3af219a0ebd74752af6694b61dc0467b081cbaef
+  metadata.gz: 76f4840b445542d5b47ffbe2c24cbace45b7bee2
+  data.tar.gz: 21963a8d8dbbb87fcdd2fcbf1dc753438dedf243
 SHA512:
-  metadata.gz: 7e291fa3de2f051516db8e72157c95236bc2b5892fcffaab4f29c503a103323896aa60bf155596b47c2052d239c12e39131b638d2734fc8b087425c6f16a3748
-  data.tar.gz: 6a3dfc905d93c90da048c84e19edaf9e1d4614f075c78410558588584bc80412ae607bd423bc38a0b7a5362b8d7cbc564db58428bd1703b710bb8887970376a3
+  metadata.gz: 6215987f2defe491353b4a2fdb7d67b65836f0d93054f9c7d21e71e4fc9eddc5a94bf7770d9cce31d4916fabcb88c3d1324f8352c4114c831560e9ae901d1a3a
+  data.tar.gz: ed59aa1746b2e05038cccfbc361ba386fa09dcd724ef5d13e4c870c85b79655be9bc19dd0fad1663f24e2cfed3ca52fd10439d2869e903a5389fd94ec39d2441

data/.ruby-version

@@ -0,0 +1 @@
+2.2.1

data/README.md

@@ -155,8 +155,8 @@ puts total
       puts header
       puts separator
       puts gen.table_row("First", "A", "$3.99")
-      puts gen.table_row("Second", "B", "$14.00")
-      puts gen.table_row("Third", "C", "$1,034.50")
+      puts gen.table_row("Second", "BC", "$14.00")
+      puts gen.table_row("Third", "DEFGH", "$1,034.50")
 
 Produces this terribly ugly markdown ...
 
@@ -164,17 +164,37 @@ Produces this terribly ugly markdown ...
 |Col One|Col Two|Col Three|
 |-------|-------|---------|
 |First|A|$3.99|
-|Second|B|$14.00|
-|Third|C|$1,034.50|
+|Second|BC|$14.00|
+|Third|DEFGH|$1,034.50|
 ```
 
+Or, you can pass all the rows in at once like so ...
+
+```ruby
+  table_data = [
+    ["Col One", "Col Two", "Col Three"],
+    [":-", ":-:", "-:"],
+    ["First", "A", "$3.99"],
+    ["Second", "BC", "$14.00"],
+    ["Third", "DEFGH", "$1,034.50"]
+  ]
+  puts gen.table(*table_data)
+```
+And get nicely justified markdown like this ...
+```
+|Col One|Col Two|Col Three|
+|:------|:-----:|--------:|
+|First  |   A   |    $3.99|
+|Second |  BC   |   $14.00|
+|Third  | DEFGH |$1,034.50|
+```
 Which gives you this stunning HTML table ...
 
 |Col One|Col Two|Col Three|
-|-------|-------|---------|
-|First|A|$3.99|
-|Second|B|$14.00|
-|Third|C|$1,034.50|
+|:------|:-----:|--------:|
+|First  |   A   |    $3.99|
+|Second |  BC   |   $14.00|
+|Third  | DEFGH |$1,034.50|
 
 
 ### Block Quotes Example

data/bin/generate_readme.rb

@@ -151,8 +151,8 @@ table_code = <<-EOT
   puts header
   puts separator
   puts gen.table_row("First", "A", "$3.99")
-  puts gen.table_row("Second", "B", "$14.00")
-  puts gen.table_row("Third", "C", "$1,034.50")
+  puts gen.table_row("Second", "BC", "$14.00")
+  puts gen.table_row("Third", "DEFGH", "$1,034.50")
 EOT
 puts gen.code_block(*table_code.split("\n"))
 puts ""
@@ -163,9 +163,27 @@ table_markdown = capture_stdout do
 end
 puts gen.fenced_code_block(*table_markdown.string.split("\n"))
 puts ""
+puts "Or, you can pass all the rows in at once like so ..."
+puts ""
+pretty_table_code = <<-EOT
+  table_data = [
+    ["Col One", "Col Two", "Col Three"],
+    [":-", ":-:", "-:"],
+    ["First", "A", "$3.99"],
+    ["Second", "BC", "$14.00"],
+    ["Third", "DEFGH", "$1,034.50"]
+  ]
+  puts gen.table(*table_data)
+EOT
+puts gen.fenced_code_language('ruby', *pretty_table_code.split("\n"))
+puts "And get nicely justified markdown like this ..."
+pretty_table_markdown = capture_stdout do
+  eval(pretty_table_code)
+end
+puts gen.fenced_code_block(*pretty_table_markdown.string.split("\n"))
 puts "Which gives you this stunning HTML table ..."
 puts ""
-puts eval(table_code)
+puts eval(pretty_table_code)
 puts ""
 puts gen.header3("Block Quotes Example")
 puts ""

data/lib/mark_maker/generator.rb

@@ -6,6 +6,42 @@ module MarkMaker
       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
+    # example :-:, must have the colon directly adjacent to the left | and the
+    # right | in order to take effect, like so |:-:|. Any whitespace on either
+    # side will cause the center justification to be ignored and default to
+    # left justification. So the following *will not* work, |:-:   | or | :-: |.
+    # In fact the following, |   :-:|, will result in right justification. This
+    # means we must fill out justification indicators, not just pad them out
+    # with spaces, in order for justification markers to look good in our
+    # native markdown output (an important consideration in itself) as well
+    # as being honored and generating the intended HTML (both being equally
+    # important in the MarkDown philosophy).
+
+    # detect if the given table cell content is a justification indicator
+    def justification?(cell)
+      cell =~ MarkMaker::RIGHT_JUSTIFY ||
+        cell =~ MarkMaker::LEFT_JUSTIFY ||
+        cell =~ MarkMaker::CENTER_JUSTIFY
+    end
+
+    # Inspect the cell contents and return a justification indicator
+    # as the fill element if the cell is a justification directive.
+    def justified_fill(c, fill)
+      justification?(c) ? '-' : fill
+    end
+
     def header1(title)
       "#{title}\n#{line_for('=', title)}"
     end
@@ -85,8 +121,97 @@ module MarkMaker
       content.inject("|") { |a, e| a << e << "|" }
     end
 
+    # Table will treat the first line of content as the table header. It
+    # will also assess each 'column' and derive the width from the largest
+    # cell value, including the header. Justification can be passed in
+    # optionally.
+
+    def table(*content)
+      columns = content.transpose
+      justified = columns.map { |c| justify(*c) }
+      content = justified.transpose
+      table = []
+      # if content.size >= 1
+      #   header, separator = table_header(*content[0])
+      #   table << header << separator
+      # end
+      content[0, content.size].each { |c| table << table_row(*c) }
+      table.map { |t| t + "\n" }
+    end
+
     def block_quote(*content)
-      content.map { |c| "#{BLOCK_QUOTE} #{c}"}
+      content.map { |c| "#{BLOCK_QUOTE} #{c}" }
+    end
+
+    def justify(*content)
+      # check for a justification marker in the second row
+      case content[1]
+      when MarkMaker::RIGHT_JUSTIFY
+        right_justify(' ', *content)
+      when MarkMaker::LEFT_JUSTIFY
+        left_justify(' ', *content)
+      when MarkMaker::CENTER_JUSTIFY
+        center_justify(' ', *content)
+      else
+        # no justification indicator was found, use a default
+        left_justify(' ', *content)
+      end
+    end
+
+    def left_justify(fill, *content)
+      width = column_width(*content)
+
+      content.map { |c| c + justified_fill(c, fill) * (width - c.length) }
+    end
+
+    def right_justify(fill, *content)
+      width = column_width(*content)
+
+      content.map { |c| justified_fill(c, fill) * (width - c.length) + c }
+    end
+
+    def center_justify(fill, *content)
+      width = column_width(*content)
+
+      content.map do |c|
+        if justification?(c)
+          # special case here, as justification must be filled from
+          # the middle out in order to meet the markdown spec requirements
+          # that will trigger proper justification
+          f = []
+          f << c
+          f << 'a' * width
+          fill_justify(justified_fill(c, fill), *f)[0]
+        else
+          left, right = centered_margins(width, c)
+          justified_fill(c, fill) * left + c + justified_fill(c, fill) * right
+        end
+      end
+    end
+
+    def fill_justify(fill, *content)
+      width = column_width(*content)
+      content.map do |c|
+        # split the cell in two and then add the fill character
+        # to the end of the first half of the cell to reach the
+        # justified width
+        c.insert(c.length / 2, fill * (width - c.length))
+      end
+    end
+
+    def column_width(*content)
+      longest = content.reduce { |a, e| a.length > e.length ? a : e }
+      longest.length
+    end
+
+    def centered_margins(width, content)
+      space = width - content.length
+      base_margin = space / 2
+      remainder_margin = width - content.length - base_margin * 2
+      [
+        base_margin,
+        base_margin + remainder_margin
+      ]
     end
   end
 end

data/lib/mark_maker/version.rb

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

data/lib/mark_maker.rb

@@ -18,4 +18,7 @@ module MarkMaker
   FENCE = CODE_TIC * 3
   EMPHASIS = "*"
   BLOCK_QUOTE = ">"
+  LEFT_JUSTIFY = /^:-+$/
+  RIGHT_JUSTIFY = /^-+:$/
+  CENTER_JUSTIFY = /^:-*:$/
 end

data/mark_maker.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "activesupport"
+  spec.add_development_dependency "simplecov"
 end

data/test/minitest_helper.rb

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

data/test/test_mark_maker.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'minitest_helper'
 
 class TestMarkMaker < Minitest::Test
@@ -152,5 +155,181 @@ class TestMarkMaker < Minitest::Test
       assert_match(/^> #{Regexp.quote(c)}$/, m)
     end
   end
+
+  # This test should always pass. It is here simple to validate the proper
+  # usage of a heredoc as a test method
+
+  def test_heredoc_method
+    desired_output = <<-EOS.strip_heredoc
+      This should contain no intents.
+
+      It should be 3 lines long.
+    EOS
+    test_output = "This should contain no intents.\n\nIt should be 3 lines long.\n"
+    assert_equal(desired_output, test_output, "Output must exactly match.")
+  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
+      |Col One|Col Two|Col Three|
+      |:------|:-----:|--------:|
+      |First  |   A   |    $3.99|
+      |Second |  BC   |   $14.00|
+      |Third  | DEFGH |$1,034.50|
+    EOS
+    table_data = [
+      ["Col One", "Col Two", "Col Three"],
+      [":-", ":-:", "-:"],
+      ["First", "A", "$3.99"],
+      ["Second", "BC", "$14.00"],
+      ["Third", "DEFGH", "$1,034.50"]
+    ]
+  gen = MarkMaker::Generator.new
+    markup = gen.table(*table_data)
+    assert_equal(pretty_table, markup.join)
+  end
+
+  def test_left_justify
+    test_justified = ["a   ", "bbb ", "cc  ", "d  d"]
+    gen = MarkMaker::Generator.new
+    justified = gen.left_justify(' ', "a", "bbb", "cc", "d  d")
+    assert_equal(test_justified, justified)
+  end
+
+  def test_right_justify
+    test_justified = ["  a", "bbb", " cc"]
+    gen = MarkMaker::Generator.new
+    gen_justified = gen.right_justify(' ', "a", "bbb", "cc")
+    assert_equal(test_justified, gen_justified)
+  end
+
+  def test_center_justify
+    test_justified = ["  a  ", "bbbbb", " ccc ", " dd  ", "e ee "]
+    gen = MarkMaker::Generator.new
+    gen_justified = gen.center_justify(' ', "a", "bbbbb", "ccc", "dd", "e ee")
+    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")
+    assert_equal(1, left)
+    assert_equal(2, right)
+  end
+
+  def test_justify_detection
+    gen = MarkMaker::Generator.new
+    
+    assert(gen.justification?(":-"))
+    assert(gen.justification?(":-:"))
+    assert(gen.justification?("-:"))
+    assert(gen.justification?(":------"))
+    assert(gen.justification?(":------:"))
+    assert(gen.justification?(":-:"))
+    assert(gen.justification?("------:"))
+    refute(gen.justification?("stuff"))
+    refute(gen.justification?("stuff:it"))
+    refute(gen.justification?(":bad news"))
+    refute(gen.justification?("bad news:"))
+    refute(gen.justification?("---"))
+    refute(gen.justification?("-"))
+  end
+
+  def test_left_justification_indicators
+    assert_match(MarkMaker::LEFT_JUSTIFY, ":-")
+    assert_match(MarkMaker::LEFT_JUSTIFY, ":---------")
+    refute_match(MarkMaker::LEFT_JUSTIFY, "-")
+    refute_match(MarkMaker::LEFT_JUSTIFY, "-:")
+    refute_match(MarkMaker::LEFT_JUSTIFY, ":--:")
+    refute_match(MarkMaker::LEFT_JUSTIFY, "-----")
+    refute_match(MarkMaker::LEFT_JUSTIFY, "")
+    refute_match(MarkMaker::LEFT_JUSTIFY, ":")
+    refute_match(MarkMaker::LEFT_JUSTIFY, "::")
+  end
+
+  def test_right_justification_indicators
+    assert_match(MarkMaker::RIGHT_JUSTIFY, "-:")
+    assert_match(MarkMaker::RIGHT_JUSTIFY, "---------:")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, "-")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, ":---")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, ":--:")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, "-----")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, "")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, ":")
+    refute_match(MarkMaker::RIGHT_JUSTIFY, "::")
+  end
+
+  def test_center_justification_indicators
+    assert_match(MarkMaker::CENTER_JUSTIFY, ":-:")
+    assert_match(MarkMaker::CENTER_JUSTIFY, ":---------:")
+    assert_match(MarkMaker::CENTER_JUSTIFY, "::")
+    refute_match(MarkMaker::CENTER_JUSTIFY, "-")
+    refute_match(MarkMaker::CENTER_JUSTIFY, "-:")
+    refute_match(MarkMaker::CENTER_JUSTIFY, ":--")
+    refute_match(MarkMaker::CENTER_JUSTIFY, "-----")
+    refute_match(MarkMaker::CENTER_JUSTIFY, "")
+    refute_match(MarkMaker::CENTER_JUSTIFY, ":")
+  end
+
+  def test_fill_justify
+    gen = MarkMaker::Generator.new
+    filled = gen.fill_justify('-', 'header', ":-:", "more", "stuff")
+    assert_equal(":----:", filled[1])
+  end
+
+  # def test_determine_justification
+  #   justifiers = ["-:", ":-", ":--:", "---:", ":---", "::", "---", "zzz"]
+  #   justifiers.each do |j|
+  #     case j
+  #     when MarkMaker::RIGHT_JUSTIFY
+  #       puts "#{j} will be right justified"
+  #     when MarkMaker::LEFT_JUSTIFY
+  #       puts "#{j} will be left justified"
+  #     when MarkMaker::CENTER_JUSTIFY
+  #       puts "#{j} will be center justified"
+  #     else
+  #       puts "#{j} is an invalid justification indicator"
+  #     end
+  #   end
+  # end
+
+  # def test_right_justify_table_column
+  #   right_justified = <<-EOS.strip_heredoc
+  #     |  Justified|
+  #     |----------:|
+  #     |          a|
+  #     |bbbbbbbbbbb|
+  #     |        ccc|
+  #   EOS
+  #   gen = MarkMaker::Generator.new
+  #   markdown = gen.table("Justified", ?????)
+  #   assert_equal(right_justified, markup, "Column content should be right justified.")
+  # end
+
+
+  # def test_pretty_table_justified_generation
+  #   pretty_table = <<-EOS.strip_heredoc
+  #     |Col One|Col Two|Col Three |Data Sized   |
+  #     |-------|-------|----------|-------------|
+  #     |First  |   A   |     $3.99|xxxxxxxxxxxxx|
+  #     |Second |   BC  |    $14.00|y            |
+  #     |Third  |  DEF  | $1,034.50|z            |
+  #     |Fourth |GHIJKLM|$10,123.45|a            |
+  #   EOS
+
+  #   markup = 'nada'
+  #   assert_equal(pretty_table, markup)
+  # end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Brad Schneider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-19 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Programatically generate markdown documents.
 email:
 - brad.schneider@me.com
@@ -90,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -123,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Markdown generator.