render-as-markdown 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTA4MzNmZDYwZGY0ZTRhMTA5MWRjOTFhNmRkY2Q4NzA3M2YyZWY4OA==
+    NTUxZGM5M2UyYzE2NzYwMDdmN2IxNDY3YWFiZTAwODUyNjIxZTQzYg==
   data.tar.gz: !binary |-
-    MWYyMTQ4OGJhNjZmNDk5ZTZhM2MxZTlhMDZkMTAyZGY5MWM2ZTkwNA==
+    OGNiM2M0MTQxZmVlOWMwN2Y5MjhmZThkMjlhMTZjYzY0YTM5ZDdhMg==
 SHA512:
   metadata.gz: !binary |-
-    NTM5NDk3NmEzMDU4ODQ5MmZkZDIxMGE4ZmYxMDIwNTVmMTBmOGRiNThkYWIy
-    OTU0MzY4YzU4MWU0MmM5NWE1ODdmZWM0MGMyZDE4MTE4ZTBmNDcyY2JiZDkx
-    MTI0ZmQ3Y2IxZDAwODAzMWRkNGZiMTUwZTcyOTM1ZDRiNWExYjI=
+    Y2RjYzExODFhZDNlYjdhNzgyYzEyZjc1YzllMTg3NWZlMThkYTZhOTE4NmVj
+    M2Y4M2Q3ZTAwZTc3OTg0ZDkzYjE5OWVjZjA0MzQ4MTkyYmRlYTNmNTFhNDg2
+    Y2JkYjhkZTY1ZTgxNDJjZTQwN2Q3YThkOTFiYzg3ZGVlZmEwZmI=
   data.tar.gz: !binary |-
-    OTNlMWYxODY2NDQyODRkNjBmZWY5OGVmYTIxYTM5OWJmYTk0OGJjYTllNmI5
-    NjM4YmQyYWZmNGEwOWYxNzg5NGRjMjlhNmU2MTdhNWNhYzlkZTBhOGE0NGE2
-    ZWUzNzNiMTQ5NzY3YTQ4M2QxZmMxOWY1Nzc2ODlmYmE1MjM4N2I=
+    ODdmYmIxYmE1Y2YyZjAwOWZhNWM1MGI5MmUyYzFiZTFkOTY5YzkyYmM5NjM5
+    ZjcyMjZmZWY4ZTQ5OGYyZDRkMjBmYTVlOGJiN2MxOTVmNTFjNGFlOTk5YThm
+    M2QzN2E5YzI0OGRlNGYyMzIyYjlhZTlmYzkwZjExMDA4NjU1NGY=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+Gemfile.lock

data/HISTORY.md

@@ -0,0 +1,12 @@
+HISTORY
+=======
+
+[2013-10-13]
+- wrote tests (nil, Numbers, etc)
+- wrote classes for H1 and H2
+
+[2013-10-06]
+- some bugfixes
+
+[2013-10-06]
+- created gem render-as-markdown, because I wanted a better Table for GitHub and GitHub renders Markdown pretty well

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Richard Metzler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,7 @@
+# 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
+- create DSL methods like table(titles) instead of Table.new

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

@@ -0,0 +1,15 @@
+module RenderAsMarkdown
+  class MD
+
+    def table
+
+    end
+
+    def h1
+    end
+
+    def h2
+    end
+
+  end
+end

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

@@ -0,0 +1,32 @@
+module RenderAsMarkdown
+  class Header
+
+    def initialize title, char
+      @title = [title.to_s.strip, " "].max
+      @char  = char.to_s
+    end
+
+    def render
+      length = [@title.length, 1].max
+      @title << "\n" << @char*length << "\n"*2
+    end
+
+    alias_method :to_s, :render
+  end
+
+  class H1 < Header
+
+    def initialize title
+      super title, "="
+    end
+
+  end
+
+  class H2 < Header
+
+    def initialize title
+      super title, "-"
+    end
+
+  end
+end

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

@@ -3,19 +3,23 @@ module RenderAsMarkdown
 
     attr_accessor :columns, :rows
 
-    def initialize column_titles = []
-      @columns = column_titles.map{|title| Column.new title}
+    def initialize column_titles
+      # column_titles will be an array
+      @columns = [*column_titles].map{|title| Column.new title}
       @rows = []
     end
 
     def add_row row
       # TODO: ensure element count of row is == element count of columns
 
-      # add row to rows
+      # make row an array
+      row = [*row]
+
+      # add row to rows, use an array
       @rows << row
 
       # iterate through columns and row, add each row to their column
-      @columns.zip(row).each {|col, string| col.add_row string}
+      @columns.zip(row).each {|col, val| col.add_row val.to_s}
     end
 
     alias_method  '<<', :add_row
@@ -35,6 +39,9 @@ module RenderAsMarkdown
       # return table
       table
     end
+    
+    alias_method :to_s, :render
+
   end
 
 
@@ -44,8 +51,8 @@ module RenderAsMarkdown
 
     def initialize title
       @rows = []
-      @title = title
-      @width = title.to_s.length
+      @title = title.to_s
+      @width = [@title.length, 1].max
     end
 
     def render_title

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

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

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

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

data/lib/render-as-markdown.rb

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

data/render-as-markdown.gemspec

@@ -18,7 +18,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = RenderAsMarkdown::VERSION
 
+  gem.add_development_dependency 'bundler'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-reporters'
+  # gem.add_development_dependency 'sandi_meter'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")

data/test/header_test.rb

@@ -0,0 +1,36 @@
+require 'minitest_helper'
+
+module RenderAsMarkdown
+  class TableTest < MiniTest::Unit::TestCase
+
+    def test_h1
+      h1 = RenderAsMarkdown::H1.new 'header 1'
+      assert_equal h1.to_s, <<-eos
+header 1
+========
+
+eos
+    end
+
+    def test_h2
+      h2 = RenderAsMarkdown::H2.new 'header 2'
+      assert_equal h2.to_s, <<-eos
+header 2
+--------
+
+eos
+    end
+
+
+    def test_strip_spaces
+      # we have to make sure, not to underline spaces
+      h1 = RenderAsMarkdown::H1.new '      <!-- spaces -->       '
+      assert_equal h1.render, <<-eos
+<!-- spaces -->
+===============
+
+eos
+
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,6 @@
+require "minitest/autorun"
+
+require "minitest/reporters"
+Minitest::Reporters.use!
+
+require_relative '../lib/render-as-markdown'

data/test/table_test.rb

@@ -0,0 +1,80 @@
+require 'minitest_helper'
+
+# I'm sorry, I concat Ruby strings
+# the reason is: the table ends with spaces
+# and whenever I hit cmd+s, a textmate plugin
+# deletes all trailing spaces in my file
+
+module RenderAsMarkdown
+  class TableTest < MiniTest::Unit::TestCase
+
+    def test_simple_table
+      t = RenderAsMarkdown::Table.new %w{eins zwei superkalifrageristric}
+      t << %w{hoch-soll-er-leben 3 mal-hoch}
+
+      assert_equal t.render, \
+        "eins              |zwei|superkalifrageristric\n"+
+        "------------------|----|---------------------\n"+
+        "hoch-soll-er-leben|3   |mal-hoch             \n"
+
+    end
+
+    def test_header_with_numbers
+      header = [1,2,3]
+      t = RenderAsMarkdown::Table.new header
+      t << [3,2,1]
+      t << [4,5,6]
+
+      assert_equal t.render, \
+        "1|2|3\n"+
+        "-|-|-\n"+
+        "3|2|1\n"+
+        "4|5|6\n"
+
+    end
+
+    def test_numbers
+      header = [1,2,3]
+      t = RenderAsMarkdown::Table.new header
+      t << [3,2,1]
+      t << [4,5,6]
+
+      assert_equal t.render, \
+        "1|2|3\n"+
+        "-|-|-\n"+
+        "3|2|1\n"+
+        "4|5|6\n"
+
+    end
+
+    def test_nil
+      header = [nil, "eins", "zwei"]
+      t = RenderAsMarkdown::Table.new header
+      t << [nil, 1, 2]
+
+      assert_equal t.render, \
+        " |eins|zwei\n"+
+        "-|----|----\n"+
+        " |1   |2   \n"
+    end
+
+
+    def test_single_column
+      t = RenderAsMarkdown::Table.new "nr"
+      t << 1
+      t << 2
+      t << 3
+      t << 4
+
+      assert_equal t.render,
+        "nr\n"+
+        "--\n"+
+        "1 \n"+
+        "2 \n"+
+        "3 \n"+
+        "4 \n"
+    end
+
+
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: render-as-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Richard Metzler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-13 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
@@ -24,6 +38,34 @@ dependencies:
     - - ! '>='
       - !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    "
 email:
@@ -32,14 +74,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - Gemfile
+- HISTORY.md
+- LICENSE.txt
 - README.md
+- Rakefile
+- TODO.md
 - lib/render-as-markdown.rb
+- lib/render-as-markdown/dsl.rb
+- lib/render-as-markdown/markdown-header.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.1.gem
 - render-as-markdown-0.0.2.gem
 - render-as-markdown.gemspec
+- test/header_test.rb
+- test/minitest_helper.rb
+- test/table_test.rb
 homepage: https://github.com/rmetzler/render-as-markdown
 licenses:
 - MIT
@@ -65,5 +117,7 @@ signing_key:
 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: []
-has_rdoc: 
+test_files:
+- test/header_test.rb
+- test/minitest_helper.rb
+- test/table_test.rb