render-as-markdown 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZGU0Zjg0ZGRlYjJkOGJiNDg4ZDkwNTM4NmMzOWNiNGRjYTQzYmU4OQ==
-  data.tar.gz: !binary |-
-    NzEyZTI2OWNmZGE5NmUwYzI3MDk3NGI1NDY2YTVmYWNjMTcyMGU4Mw==
+SHA1:
+  metadata.gz: 369136336c55adb924638c56b5be83edd38d899f
+  data.tar.gz: f260b72482f1eb9196aae8d30e8544f00e890922
 SHA512:
-  metadata.gz: !binary |-
-    MWJjZTM3YjNiOGZlZDg4N2EwMGQ4ZGNhMTg0MjNlZjcyYzc3NjVmMGFkNDgw
-    OTI3NmY3NjgwMGMyNTk3ODU1NDZlZmVmZGVmNTNhZWMzM2Y5NmZkZTY4OTM2
-    ZDVkODM0YTVjMjUwN2I1MDYzOWUxMThlZWRmODEyM2FlOWJjNjc=
-  data.tar.gz: !binary |-
-    NTUwYjQzODliZGJkMGEyMzMwMzFiODA0MjdkOTI5OWFkYWZlOGI2YTE0NTMy
-    NzFmNGZhMWE3ZDU3ZjNlMGM5MWE0ZGU5MzQ2ZmFjOTlmODI0OTI3NDRlZGI4
-    MWE5ZTQ4NDFmMGRkYTI0MDEzZDhjNWQwMWU2YmQ1OWU4OWMzOWE=
+  metadata.gz: b0754af7eeaf6480acfbc133126555a05a542675074c7e34f4cc0b784ebfb05c3527c4403a7266fcaf8fdd485febdd173f33e11ce2ab1eda71ab677cf1987bce
+  data.tar.gz: 817ec7d1d91b8cd414f7d10a8dff2a78251b7c7122c9ab23e1d0239aa755f35bbf5f18dac652a5db19ed386e17cf3453be87ab6447a8fd905b5ba591235a118d

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 1.9.3
+- 2.0.0

data/Gemfile

@@ -1,4 +1,6 @@
 # A sample Gemfile
 source "https://rubygems.org"
 
-gemspec
+gemspec
+
+gem 'coveralls', require: false

data/HISTORY.md

@@ -1,22 +1,27 @@
 HISTORY
 =======
 
-[2012-10-16]
+__[2012-10-19]__
+- refactor table.rb
+
+__[2012-10-16]__
 - Readme: what is Markdown?
 - added Link class
 - added Image class
+- [v0.0.5](https://github.com/rmetzler/render-as-markdown/tree/v0.0.5)
+- renamed files
 
-[2012-10-15]
+__[2012-10-15]__
 - added List class
 - added simple Code class with 4 spaces indentation
 
-[2013-10-13]
+__[2013-10-13]__
 - 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
+- [v0.0.4](https://github.com/rmetzler/render-as-markdown/tree/v0.0.4)
 
-[2013-10-06]
+__[2013-10-06]__
 - some bugfixes
 
-[2013-10-06]
+__[2013-10-06]__
 - created gem render-as-markdown, because I wanted a better Table for GitHub and GitHub renders Markdown pretty well

data/README.md

@@ -1,9 +1,16 @@
 RenderAsMarkdown
 ================
 
+
 RenderAsMarkdown is a small Ruby gem featuring simple to use classes to turn
 data into Markdown.
 
+[![Gem Version](https://badge.fury.io/rb/render-as-markdown.png)](http://badge.fury.io/rb/render-as-markdown)
+[![Build Status](https://travis-ci.org/rmetzler/render-as-markdown.png?branch=master)](https://travis-ci.org/rmetzler/render-as-markdown)
+[![Code Climate](https://codeclimate.com/github/rmetzler/render-as-markdown.png)](https://codeclimate.com/github/rmetzler/render-as-markdown)
+[![Coverage Status](https://coveralls.io/repos/rmetzler/render-as-markdown/badge.png)](https://coveralls.io/r/rmetzler/render-as-markdown)
+[![Dependency Status](https://gemnasium.com/rmetzler/render-as-markdown.png)](https://gemnasium.com/rmetzler/render-as-markdown)
+
 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

data/Rakefile

@@ -1,3 +1,4 @@
+require "json"
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,3 +8,17 @@ Rake::TestTask.new do |t|
 end
 
 task :default => :test
+
+desc "copy README.md into gh-page content"
+task :readme_to_ghpage do
+  File.open "params.json", "w" do |file|
+    params = {
+      name:     "RenderAsMarkdown",
+      tagline:  "This gem is a Markdown helper that renders well formatted Markdown for bigger Markdown elements like tables",
+      body:     File.read('README.md'),
+      google:   "UA-44998391-1",
+      note:     "Don't delete this file! It's used internally to help with page regeneration."
+    }
+    file.write params.to_json
+  end
+end

data/TODO.md

@@ -1,6 +1,51 @@
-# TODO
+TODO
+====
 
-- rename files (markdown-heder.rb -> header.rb)
+- create image link (img_url, href)
+- create [Tasklists](https://help.github.com/articles/github-flavored-markdown#task-lists)
+- create TOC (table of contents) structur (see github anchor links)
+- create link references
+- create document from hash (Document)
 - create DSL methods like table(titles) instead of Table.new
 - Readme: better examples
 - create example folder
+- include files (code, multimarkdown, version number, etc)
+- show typical Github project signs of life like travis build image, code climate, versioneye
+- auto-numbering of headers (h2, h3, h4) so TOC works with numbers (Document walker)
+- create InvoiceTable class for invoices (currency, items description, time, rate, item total, total, tax(Umsatzsteuer Germany), total+tax)
+- create changelog like https://raw.github.com/mitchellh/vagrant/master/CHANGELOG.md
+
+Option Hash
+-----------
+
+- an option hash could be a good thing to implement http://blog.rlmflores.me/blog/2012/07/16/method-with-options/
+- also splats may be useful http://www.paperplanes.de/2012/2/16/fun-with-ruby-block-parameters.html
+
+
+Ideas for DSL
+-------------
+
+```ruby
+"<url>".link   # => create link
+"<url>".img    # => create image
+"<url>".ref    # => create reference
+"markdown".tag # => create tag #markdown, should work with arrays too
+```
+
+```ruby
+DSL.markdown do |md|
+
+  md.options :link_urls => :as_references, :link_images => true, :toc => true, :auto_numbering => [:h2. :h3]
+  md.meta # date, author (name, email for multiple authors)
+
+  md.h1 "This is the main title"
+  md.chapter "title for chapter 1" do |c1| # put this title in h2, add numbering, add it to TOC
+    c1.paragraph "paragraph1"
+    c1.img "http://...jpeg"
+    c1.list ["item 1", "item2", "item3"]
+    c1.table #...
+    c1.ref text, "<url>"
+    c1.code :ruby, File.open "examples/example-dsl.rb"
+  end
+end # => renders title, toc, references etc
+```

data/lib/render-as-markdown.rb

@@ -1,6 +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-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__
+require File.expand_path '../render-as-markdown/table',  __FILE__
+require File.expand_path '../render-as-markdown/header', __FILE__
+require File.expand_path '../render-as-markdown/list',   __FILE__
+require File.expand_path '../render-as-markdown/code',   __FILE__
+require File.expand_path '../render-as-markdown/link',   __FILE__
+require File.expand_path '../render-as-markdown/image',  __FILE__

data/lib/render-as-markdown/{markdown-code.rb → code.rb}

@@ -1,10 +1,12 @@
 module RenderAsMarkdown
   class Code
 
+    # TODO: render language for code block if provided as Symbol
+    # TODO: add file support
+
     attr_accessor :code
 
     def initialize code
-      # list_items will be an array
       @code = code.to_s
     end
 

data/lib/render-as-markdown/{markdown-table.rb → table.rb}

@@ -24,23 +24,35 @@ module RenderAsMarkdown
 
     alias_method  '<<', :add_row
 
+
     def render
+      render_head << render_seperator << render_body
+    end
+
+    alias_method :to_s, :render
+
+    def render_head
       # join all column headers
-      table = @columns.map(&:render_title).join( '|' ) << "\n"
+      @columns.map(&:render_title).join( '|' ) << "\n"
+    end
 
+    def render_seperator
       # join all column lines
-      table << @columns.map(&:render_line).join( '|' ) << "\n"
+      @columns.map(&:render_line).join( '|' ) << "\n"
+    end
 
+    def render_body
       # join all columns for all rows
+      body =''
       @rows.each_with_index do |row, i|
-        table << @columns.map {|col| col.render_row i}.join( '|' ) << "\n"
+        body << render_row( i )
       end
+      body
+    end
 
-      # return table
-      table
+    def render_row row
+      @columns.map {|col| col.render_row row}.join( '|' ) << "\n"
     end
-    
-    alias_method :to_s, :render
 
   end
 

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

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

data/scripts/gh-pages

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+git checkout gh-pages
+git pull origin gh-pages
+git checkout master README.md
+rake readme_to_ghpage
+git commit -am"update gh-pages with README.md"
+git push origin gh-pages
+git checkout master

data/test/minitest_helper.rb

@@ -3,4 +3,9 @@ require "minitest/autorun"
 require "minitest/reporters"
 Minitest::Reporters.use!
 
+require 'json'
+require 'coveralls'
+Coveralls.wear!
+
+
 require_relative '../lib/render-as-markdown'

metadata

@@ -1,80 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: render-as-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Richard Metzler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   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: rake
   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: minitest
   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: minitest-reporters
   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: ! "\n    RenderAsMarkdown is a small Ruby gem featuring simple to use
-  objects to turn data into Markdown.\n    "
+description: "\n    RenderAsMarkdown is a small Ruby gem featuring simple to use objects
+  to turn data into Markdown.\n    "
 email:
 - richard@launchco.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .coveralls.yml
 - .gitignore
+- .travis.yml
 - Gemfile
 - HISTORY.md
 - LICENSE.txt
@@ -82,16 +84,16 @@ files:
 - Rakefile
 - TODO.md
 - lib/render-as-markdown.rb
+- lib/render-as-markdown/code.rb
 - lib/render-as-markdown/dsl.rb
+- lib/render-as-markdown/header.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/list.rb
+- lib/render-as-markdown/table.rb
 - lib/render-as-markdown/version.rb
 - render-as-markdown.gemspec
+- scripts/gh-pages
 - test/code_test.rb
 - test/header_test.rb
 - test/image_test.rb
@@ -109,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Currently implemented is a table in GitHub-flavoured Markdown. It works perfectly

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

@@ -1,11 +0,0 @@
-module RenderAsMarkdown
-  class Link
-
-    attr_accessor :columns, :rows
-
-    def initialize url, text, hint=''
-    end
-
-
-end
-