mark_maker 0.7.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6adee78ed7b10132a947e311ed62ca3825570ab
-  data.tar.gz: 36c3619719c0eacd7be2805aaf9e8ecbb482eda9
+SHA256:
+  metadata.gz: a641fadb4fb218a1e037fcdcbbad94ea9c1f57cae4b983c80ffc2d761f311ee7
+  data.tar.gz: 17d05f4b5604756d270d5dd3cc17fff8253ad613432beaf387871fa6082177b5
 SHA512:
-  metadata.gz: e8ebc98cce19ffda4fb67c84545e4e0c3f848bc1bd2ee2d8927e15e75ed18a8d9544b102e26e8adc2085b73b2341a6e600eea614cee98ab43875c02410d214ea
-  data.tar.gz: ad1cd1d85dd0c5356d613d3ba0c7da1b6ba4925ad6c5c16469755b7421c838a84bcb8ef65ccb908ca9a0b6f0db301f8ad121e48bd1442c7ec9aed0b6e360179f
+  metadata.gz: fbc4f27993d6ec1fb2fd40fe24fb8df2bf25e1d46aec133bd578d6aabbec4437540d043740edabd1d503691398ea7e349f9ac24582ed7d3899bda6b3a083c698
+  data.tar.gz: 7bc3cfd8aab4061b8465494733e4eba269a0f4537a718062f124cdff6235910f7aa045be27370241b2139a4c09113e1aa4574661a63d19bf6cc2a41fa1818bf5

data/.ruby-version

@@ -1 +1,2 @@
-2.2
+2.6
+

data/.travis.yml

@@ -2,6 +2,5 @@ language: ruby
 bundler_args: --without dev_tooling
 rvm:
   - ruby-head
-  - 2.2.4
+  - 2.6.3
   - 2.3.0
-  - 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+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

data/README.md

@@ -1,4 +1,4 @@
-![MarkMaker build status](https://travis-ci.org/sn1de/mark_maker.svg?branch=master Build Status)
+![MarkMaker build status](https://travis-ci.org/sn1de/mark_maker.svg?branch=master "Build Status")
 
 MarkMaker
 =========
@@ -64,12 +64,42 @@ code, emphasis, and strong are all handled by String methods.
 Multi line and more complex conversions are handled by a Generator class.
 
 ### Header Example
-    'Let It Begin'.header1
 
-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
 
@@ -157,14 +187,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|
@@ -248,3 +280,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 (see .travis.yml)
+
+ - 2.3.0
+ - 2.2.4
+ - 1.9.3
+ - ruby-head
+
+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/bin/generate_readme.rb

@@ -87,10 +87,27 @@ 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 "'#{example_header}'.header1".code
-puts "\nProduces\n\n"
-example_header.header1.lines.map { |l| puts l.code }
+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 "Bulleted List Example".header3
 list_content = ['gold', 'silver', 'bronze']
@@ -160,9 +177,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)
@@ -233,3 +250,23 @@ 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 (see .travis.yml)"
+puts ""
+puts gen.bullets("2.3.0", "2.2.4", "1.9.3", "ruby-head")
+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

@@ -44,7 +44,7 @@ module MarkMaker
     end
 
     def image(alt, path, title = "")
-      "![#{alt}](#{path} #{title})"
+      %Q(![#{alt}](#{path} "#{title}"))
     end
 
     def code_block(*content)

data/lib/mark_maker/version.rb

@@ -1,4 +1,4 @@
 # version management
 module MarkMaker
-  VERSION = "0.7.0"
+  VERSION = "0.9.1"
 end

data/lib/mark_maker_string.rb

@@ -1,4 +1,3 @@
-require 'mark_maker'
 
 # adds several basic string to markdown conversion methods
 class String
@@ -18,6 +17,18 @@ class String
     "### #{self}"
   end
 
+  def header4
+    "#### #{self}"
+  end
+
+  def header5
+    "##### #{self}"
+  end
+
+  def header6
+    "###### #{self}"
+  end
+
   def bullet
     " - #{self}"
   end

data/mark_maker.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   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 "unindent"

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

@@ -43,7 +43,7 @@ class TestMarkMaker < Minitest::Test
     title = "Build Status"
     gen = MarkMaker::Generator.new
     markup = gen.image(alt, path, title)
-    assert_match(/^!\[#{Regexp.quote(alt)}\]\(#{Regexp.quote(path)}\s#{Regexp.quote(title)}\)/, markup)
+    assert_match(/^!\[#{Regexp.quote(alt)}\]\(#{Regexp.quote(path)}\s"#{Regexp.quote(title)}"\)/, markup)
   end
 
   def test_code_block_generation

data/test/test_mark_maker_string.rb

@@ -4,28 +4,6 @@ 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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Brad Schneider
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2020-07-15 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
@@ -138,6 +138,7 @@ files:
 - 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: ''
@@ -159,12 +160,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+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