mark_maker 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a641fadb4fb218a1e037fcdcbbad94ea9c1f57cae4b983c80ffc2d761f311ee7
-  data.tar.gz: 17d05f4b5604756d270d5dd3cc17fff8253ad613432beaf387871fa6082177b5
+  metadata.gz: bd5c7e729e819e15b9796cd57242afd832bd913f1545184cda35cee9e1c07db1
+  data.tar.gz: 43156be3f04d2bba8789bd9c80452bc8c468b30074a26acc5335468fc9af1c6b
 SHA512:
-  metadata.gz: fbc4f27993d6ec1fb2fd40fe24fb8df2bf25e1d46aec133bd578d6aabbec4437540d043740edabd1d503691398ea7e349f9ac24582ed7d3899bda6b3a083c698
-  data.tar.gz: 7bc3cfd8aab4061b8465494733e4eba269a0f4537a718062f124cdff6235910f7aa045be27370241b2139a4c09113e1aa4574661a63d19bf6cc2a41fa1818bf5
+  metadata.gz: 797cf2e44e772f2e6501efe9d8bcb4a32ef349862c3b67e19f173ac3ecf34d477b50737fd9fec40d0e1db6384ca2c6800d1b384aad9c5404e372066093124303
+  data.tar.gz: e7872ccacd0ed4b3c06975522899c92adde7c9c3142bf2e0d140fbd4082702290a81ab37ac312620de402a66ece8d13b009d1b44879df8c88679731e1d9927db

data/.travis.yml

@@ -1,6 +1,12 @@
+before_install:
+  - gem install bundler
+
 language: ruby
+
 bundler_args: --without dev_tooling
+
 rvm:
   - ruby-head
-  - 2.6.3
-  - 2.3.0
+  - 2.7
+  - 2.6
+  - 2.3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+1.0.0
+-----
+
+ - just tidied up the README
+ - clarified the supported ruby versions (all now 2.x variations)
+
 0.9.0
 -----
 

data/README.md

@@ -5,35 +5,6 @@ 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
 ------------
 
@@ -53,9 +24,9 @@ Usage
 -----
 
 MarkMaker provides line oriented conversion of content to markdown elements. It
-currently supports first, second and third level headings, links, bullets, numbered
+currently supports headings, links, bullets, numbered
 bullets, *emphasis*, **strong**, code
-and basic table markdown. See bin/generate_readme.rb for the code used to generate this
+and 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,
@@ -284,12 +255,12 @@ 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)
+The following ruby versions are explicitly supported and exercised via TravisCI (see .travis.yml)
 
- - 2.3.0
- - 2.2.4
- - 1.9.3
  - ruby-head
+ - 2.7
+ - 2.6
+ - 2.3
 
 Release Process
 ---------------

data/bin/generate_readme.rb

@@ -31,34 +31,6 @@ puts "MarkMaker".header1
 puts ""
 puts "Programatically generate markdown documents."
 puts ""
-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"
-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 #{ '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"
-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 #{ '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 "Installation".header2
 puts ""
 puts "Add this line to your application's Gemfile:"
@@ -76,9 +48,9 @@ puts ""
 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 "currently supports headings, links, bullets, numbered"
 puts "bullets, #{'emphasis'.emphasis}, #{'strong'.strong}, code"
-puts "and basic table markdown. See #{__FILE__} for the code used to generate this"
+puts "and 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 "Simple markdown generation is handled by extensions to the ruby String class. Headers,"
@@ -253,9 +225,9 @@ puts "It's kind of like #{gen.link("Inception", "http://en.wikipedia.org/wiki/In
 puts ""
 puts "Supported Ruby Versions".header2
 puts ""
-puts "The following ruby versions are explicitly supported (see .travis.yml)"
+puts "The following ruby versions are explicitly supported and exercised via TravisCI (see .travis.yml)"
 puts ""
-puts gen.bullets("2.3.0", "2.2.4", "1.9.3", "ruby-head")
+puts gen.bullets("ruby-head", "2.7", "2.6", "2.3")
 puts ""
 puts "Release Process".header2
 puts ""

data/lib/mark_maker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mark_maker
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Brad Schneider
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,7 +145,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Markdown generator.
 test_files: