render-as-markdown 0.0.4 → 0.0.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTUxZGM5M2UyYzE2NzYwMDdmN2IxNDY3YWFiZTAwODUyNjIxZTQzYg==
+    ZGU0Zjg0ZGRlYjJkOGJiNDg4ZDkwNTM4NmMzOWNiNGRjYTQzYmU4OQ==
   data.tar.gz: !binary |-
-    OGNiM2M0MTQxZmVlOWMwN2Y5MjhmZThkMjlhMTZjYzY0YTM5ZDdhMg==
+    NzEyZTI2OWNmZGE5NmUwYzI3MDk3NGI1NDY2YTVmYWNjMTcyMGU4Mw==
 SHA512:
   metadata.gz: !binary |-
-    Y2RjYzExODFhZDNlYjdhNzgyYzEyZjc1YzllMTg3NWZlMThkYTZhOTE4NmVj
-    M2Y4M2Q3ZTAwZTc3OTg0ZDkzYjE5OWVjZjA0MzQ4MTkyYmRlYTNmNTFhNDg2
-    Y2JkYjhkZTY1ZTgxNDJjZTQwN2Q3YThkOTFiYzg3ZGVlZmEwZmI=
+    MWJjZTM3YjNiOGZlZDg4N2EwMGQ4ZGNhMTg0MjNlZjcyYzc3NjVmMGFkNDgw
+    OTI3NmY3NjgwMGMyNTk3ODU1NDZlZmVmZGVmNTNhZWMzM2Y5NmZkZTY4OTM2
+    ZDVkODM0YTVjMjUwN2I1MDYzOWUxMThlZWRmODEyM2FlOWJjNjc=
   data.tar.gz: !binary |-
-    ODdmYmIxYmE1Y2YyZjAwOWZhNWM1MGI5MmUyYzFiZTFkOTY5YzkyYmM5NjM5
-    ZjcyMjZmZWY4ZTQ5OGYyZDRkMjBmYTVlOGJiN2MxOTVmNTFjNGFlOTk5YThm
-    M2QzN2E5YzI0OGRlNGYyMzIyYjlhZTlmYzkwZjExMDA4NjU1NGY=
+    NTUwYjQzODliZGJkMGEyMzMwMzFiODA0MjdkOTI5OWFkYWZlOGI2YTE0NTMy
+    NzFmNGZhMWE3ZDU3ZjNlMGM5MWE0ZGU5MzQ2ZmFjOTlmODI0OTI3NDRlZGI4
+    MWE5ZTQ4NDFmMGRkYTI0MDEzZDhjNWQwMWU2YmQ1OWU4OWMzOWE=

data/HISTORY.md

@@ -1,9 +1,19 @@
 HISTORY
 =======
 
+[2012-10-16]
+- Readme: what is Markdown?
+- added Link class
+- added Image class
+
+[2012-10-15]
+- added List class
+- added simple Code class with 4 spaces indentation
+
 [2013-10-13]
-- wrote tests (nil, Numbers, etc)
-- wrote classes for H1 and H2
+- wrote tests for Table class and fixed problems (nil, Numbers, etc)
+- wrote classes and tests for H1 and H2 with Markdown underline notation (h1: ===, h2: ----)
+- v0.0.4
 
 [2013-10-06]
 - some bugfixes

data/README.md

@@ -1,12 +1,78 @@
-#RenderAsMarkdown
+RenderAsMarkdown
+================
 
-RenderAsMarkdown is a small Ruby gem featuring simple to use objects to turn data into Markdown.
+RenderAsMarkdown is a small Ruby gem featuring simple to use classes to turn
+data into Markdown.
 
-Currently implemented is a table in GitHub-flavoured Markdown. It's not fully featured yet.
+This project started when [rmetzler](//github.com/rmetzler) tried to render
+data into a Markdown table. While this was easy to achive with templating, a
+dedicated helper gem was more reuseable and produced output that was also
+easier to scan in ASCII.
 
-## Table
+Ultimately this helper should turn into something like a DSL to create and
+scaffold Markdown documents. In particular it should be very useful to create
+project documentation files like README.md, TODO.md, LICENSE.md, etc. with it.
+Github is able to render Markdown as HTML so automatically generated project
+documentation could be displayed on http://github.com
 
-It's really easy to render a table in (GHf)MD, but the simplest approach doesn't look that nice in raw mode. That's why there is this simple class, tables work in the terminal AND on Github.
+See [Implementation](#implementation) for what's implemented yet.
+
+
+What is Markdown?
+-----------------
+
+Markdown is a (supposed to be) simple markup language that can be written and
+converted into HTML easily.
+
+It was [created by John Gruber in December 2004](http://daringfireball.net/projects/markdown/)
+and has grown in popularity since. Developers started to adapt Markdown and
+several different Markdown dialects emerged:
+
+- [Original Markdown Syntax](http://daringfireball.net/projects/markdown/syntax)
+- [Github created Github flavored Markdown](http://github.github.com/github-flavored-markdown/)
+- [MultiMarkdown adds features for multiple files](http://fletcherpenney.net/multimarkdown/)
+- [iA Writer uses a slightly different dialect](http://support.iawriter.com/help/kb/general-questions/markdown-syntax-reference-guide)
+
+
+Implementation
+--------------
+
+### Headers
+
+Headers in Markdown can be written in two different notations. the #-Notation
+where you just prepend # for H1, ## for H2, ### for H3 ... up to H5.
+You get the concept.
+
+And there is the underline Notation for H1 (===) and H2 (---). This notation
+is easier to scan in ASCII files, but its not as simple to implement in
+Markdown templates as the #-notation is. So I wrote two little helpers classes.
+
+
+### Link
+
+Links in Markdown have a URL, text (optional) and hint (optional).
+
+### Image
+
+Images in Markdown have a URL, an alt text and a hint (optional).
+
+
+### List
+
+Lists in Markdown start with a dash and a space in every line.
+
+
+### Code
+
+There are different notations for Code in Markdown.
+Currently the implementation just indent every line by 4 spaces.
+
+
+### Table
+
+It's really easy to render a table in (GHf)MD, but the simplest approach
+doesn't look that nice in raw mode. That's why there is this simple class,
+tables work in the terminal AND on Github.
 
 ```Ruby
     t = RenderMarkdown::Table.new %w{eins zwei superkalifrageristric}
@@ -19,11 +85,11 @@ renders the following table
 ```
     eins              |zwei|superkalifrageristric
     ------------------|----|---------------------
-    hoch-soll-er-leben|3   |mal-hoch             
+    hoch-soll-er-leben|3   |mal-hoch
 ```
 
 Thanks to Github, this is also rendered in HTML. Nice!
 
 eins              |zwei|superkalifrageristric
 ------------------|----|---------------------
-hoch-soll-er-leben|3   |mal-hoch             
+hoch-soll-er-leben|3   |mal-hoch

data/TODO.md

@@ -1,7 +1,6 @@
 # TODO
 
-- create a Link class Link.new(url, text, hint="")
-- create a Image class Image.new(src, alt="" )
-- create H1 and H2 classes that use Markdown underline notation (h1: ====, h2: ----)
-- create List class
+- rename files (markdown-heder.rb -> header.rb)
 - create DSL methods like table(titles) instead of Table.new
+- Readme: better examples
+- create example folder

data/lib/render-as-markdown/image.rb

@@ -0,0 +1,18 @@
+module RenderAsMarkdown
+  class Image
+
+    attr_accessor :alt_text, :url, :title
+
+    def initialize alt_text, url, title=nil
+      @alt_text, @url, @title = alt_text.to_s, url.to_s, title.to_s
+    end
+
+    def render
+      title = " \"#{@title}\"" unless @title.empty?
+      "![#{@alt_text}](#{@url}#{title})"
+    end
+
+    alias_method :to_s, :render
+
+  end
+end

data/lib/render-as-markdown/link.rb

@@ -0,0 +1,21 @@
+module RenderAsMarkdown
+  class Link
+
+    # TODO: look up Github in-document link reference and implement it (e.g. "[A Header](#a-header)" )
+
+    attr_accessor :url, :text, :hint
+
+    def initialize url, text=nil, hint=nil
+      @url, @text, @hint = url.to_s, text.to_s, hint.to_s
+    end
+
+    def render
+      text = @text.empty? ? @url : @text
+      hint = " \"#{@hint}\"" unless @hint.empty?
+      "[#{text}](#{@url}#{hint})"
+    end
+
+    alias_method :to_s, :render
+
+  end
+end

data/lib/render-as-markdown/markdown-code.rb

@@ -0,0 +1,21 @@
+module RenderAsMarkdown
+  class Code
+
+    attr_accessor :code
+
+    def initialize code
+      # list_items will be an array
+      @code = code.to_s
+    end
+
+    def render
+      md = ''
+      @code.lines.each {|l| md << "    " << l }
+      md
+    end
+
+    alias_method :to_s, :render
+
+  end
+
+end

data/lib/render-as-markdown/markdown-list.rb

@@ -0,0 +1,32 @@
+module RenderAsMarkdown
+  class List
+
+    attr_accessor :list_items
+
+    def initialize list_items
+      # list_items will be an array
+      @list_items = [*list_items]
+    end
+
+    def add_list_item list_item
+      # concat arrays
+      list_items.concat [*list_item]
+    end
+
+    alias_method  '<<', :add_list_item
+
+    def render
+      md = ''
+
+      @list_items.each do |item|
+        md << "- #{item.to_s}\n"
+      end
+
+      md
+    end
+
+    alias_method :to_s, :render
+
+  end
+
+end

data/lib/render-as-markdown/version.rb

@@ -1,6 +1,6 @@
 module RenderAsMarkdown
   GEM     = 'render-as-markdown'
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end
 
 #puts "This is version #{RenderAsMarkdown::VERSION} of gem #{RenderAsMarkdown::GEM}"

data/lib/render-as-markdown.rb

@@ -1,2 +1,6 @@
-require File.expand_path('../render-as-markdown/markdown-table', __FILE__)
-require File.expand_path('../render-as-markdown/markdown-header', __FILE__)
+require File.expand_path '../render-as-markdown/markdown-table',  __FILE__
+require File.expand_path '../render-as-markdown/markdown-header', __FILE__
+require File.expand_path '../render-as-markdown/markdown-list',   __FILE__
+require File.expand_path '../render-as-markdown/markdown-code',   __FILE__
+require File.expand_path '../render-as-markdown/link',            __FILE__
+require File.expand_path '../render-as-markdown/image',           __FILE__

data/test/code_test.rb

@@ -0,0 +1,21 @@
+require 'minitest_helper'
+
+module RenderAsMarkdown
+  class CodeTest < MiniTest::Unit::TestCase
+
+    def test_simple_list
+      l = RenderAsMarkdown::Code.new <<-eos
+a
+b
+c
+d
+eos
+      assert_equal l.render, \
+        "    a\n"+
+        "    b\n"+
+        "    c\n"+
+        "    d\n"
+    end
+
+  end
+end

data/test/image_test.rb

@@ -0,0 +1,20 @@
+require 'minitest_helper'
+
+module RenderAsMarkdown
+  class ImageTest < MiniTest::Unit::TestCase
+
+    def test_image
+      l = RenderAsMarkdown::Image.new "Alt Text", "http://whatismarkdown.com/workspace/img/logo.gif"
+      assert_equal "![Alt Text](http://whatismarkdown.com/workspace/img/logo.gif)", l.to_s
+    end
+
+    def test_image_with_title
+      l = RenderAsMarkdown::Image.new "Alt Text", "http://whatismarkdown.com/workspace/img/logo.gif", "Markdown Logo"
+      assert_equal "![Alt Text](http://whatismarkdown.com/workspace/img/logo.gif \"Markdown Logo\")", l.to_s
+    end
+
+  end
+end
+
+
+

data/test/link_test.rb

@@ -0,0 +1,22 @@
+require 'minitest_helper'
+
+module RenderAsMarkdown
+  class ListTest < MiniTest::Unit::TestCase
+
+    def test_link_url_only
+      l = RenderAsMarkdown::Link.new "https://google.com/"
+      assert_equal "[https://google.com/](https://google.com/)", l.to_s
+    end
+
+    def test_link_text_url
+      l = RenderAsMarkdown::Link.new "https://google.com/", "google it"
+      assert_equal "[google it](https://google.com/)", l.to_s
+    end
+
+    def test_link_text_url_hint
+      l = RenderAsMarkdown::Link.new "https://google.com/", "google it", "Google Search"
+      assert_equal '[google it](https://google.com/ "Google Search")', l.to_s
+    end
+
+  end
+end

data/test/list_test.rb

@@ -0,0 +1,17 @@
+require 'minitest_helper'
+
+module RenderAsMarkdown
+  class ListTest < MiniTest::Unit::TestCase
+
+    def test_simple_list
+      l = RenderAsMarkdown::List.new ['first entry', 'second entry']
+      l << 'third entry'
+
+      assert_equal l.render, \
+        "- first entry\n"+
+        "- second entry\n"+
+        "- third entry\n"
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render-as-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Richard Metzler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,13 +83,20 @@ files:
 - TODO.md
 - lib/render-as-markdown.rb
 - lib/render-as-markdown/dsl.rb
+- lib/render-as-markdown/image.rb
+- lib/render-as-markdown/link.rb
+- lib/render-as-markdown/markdown-code.rb
 - lib/render-as-markdown/markdown-header.rb
+- lib/render-as-markdown/markdown-list.rb
 - lib/render-as-markdown/markdown-table.rb
 - lib/render-as-markdown/md-link.rb
 - lib/render-as-markdown/version.rb
-- render-as-markdown-0.0.2.gem
 - render-as-markdown.gemspec
+- test/code_test.rb
 - test/header_test.rb
+- test/image_test.rb
+- test/link_test.rb
+- test/list_test.rb
 - test/minitest_helper.rb
 - test/table_test.rb
 homepage: https://github.com/rmetzler/render-as-markdown
@@ -118,6 +125,10 @@ specification_version: 4
 summary: Currently implemented is a table in GitHub-flavoured Markdown. It works perfectly
   fine, but is not fully featured yet.
 test_files:
+- test/code_test.rb
 - test/header_test.rb
+- test/image_test.rb
+- test/link_test.rb
+- test/list_test.rb
 - test/minitest_helper.rb
 - test/table_test.rb