md_parser 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ddcbf3017028ff39e00ee5cca22d76f13766b27f
+  data.tar.gz: 319845c9492d37aa62902d972628f4431b12a64a
+SHA512:
+  metadata.gz: 5457de4265b7b762318783a7fce14c5a1e15aa260b3c7699a8ee3d9aa78e9d0f41301b3dd570087495f205b50b3735c3958e722a42973b81383c49a6c0004dd5
+  data.tar.gz: 7707c317220e6d0aecb840297c156cda3ddf497ca7a224d0a80f52f07bf1cabbe406560a7c18e7d777ca547fc134aed8aa52d7097d953a45e5ce2c3daee9e515

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in md_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nigel Thorne
+
+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/README.md

@@ -0,0 +1,33 @@
+# MdParser
+
+A WIP markdown table parser. -- may never be finished.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'md_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install md_parser
+
+## Usage
+
+  beautify_table("|some | text|\n |in a md |table| \n")  # => same table but pretty
+
+  table_to_hash("|some | text|\n |in a md |table| \n") # => hash of the table content.
+  
+## Contributing
+
+1. Fork it ( https://github.com/nigelthorne/md_parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/md_parser/hash_table_visitor.rb

@@ -0,0 +1,13 @@
+module MdParser
+
+  class HashTableVisitor
+    def table_to_h(titles, rows)
+      rows.map{|row| row.each.with_index.each_with_object({}){|(cell, index), h| h[titles[index]] = cell}} 
+    end
+    
+    def visit_table(titles, rows)
+      table_to_h(titles, rows)
+    end
+  end
+
+end

data/lib/md_parser/table_parser.rb

@@ -0,0 +1,41 @@
+
+module MdParser
+  class TableParser < Parslet::Parser
+      rule(:table)         { (( row.as(:table_titles)>>  separator_row ).maybe >>  
+                             ( separator_row.absent? >> row ).repeat(1).as(:table_rows)).as(:table_table) }
+
+      rule(:row)           { cell.repeat(1).as(:table_row) >> space? >> eol}
+      rule(:separator_row) { str("|").maybe >> (str("-").repeat(3) >> str("|")).repeat(1) >> str("-").repeat(3).maybe >> eol}
+
+      rule(:cell)          { str("|").maybe >> space? >> cell_body? >> space? >> str("|") }
+      
+      rule(:cell_body?)    { string.as(:table_value) | 
+                             str('"').absent? >> ( 
+                               str("|").absent? >> (
+                                 (space >> str("|").absent?)|
+                                 (space.absent? >> str("\n").absent? >> any)
+                               )
+                             ).repeat(0).as(:table_value) 
+                           }
+                           
+      rule(:string)        { str('"') >> ( ( str('\\') >> any ) | ( str('"').absent? >> any ) ).repeat(0) >> str('"') }
+
+      rule(:space)         { (str("\n").absent? >> match('\s')).repeat(1) }
+      rule(:space?)        { space.maybe }
+                             
+      rule(:eof)           { any.absent? }                    
+      rule(:eol)           { str("\n") | eof }   
+      
+      root :table
+  end
+  
+  class TableTransformer < Parslet::Transform
+    rule(:table_value  => [])                     { "" }
+    rule(:table_value  => simple(:val))           { val.to_s }
+    rule(:table_row    => sequence(:vals))        { vals }
+    rule(:table_titles => sequence(:titles), 
+         :table_rows   => subtree(:rows))         { visitor.visit_table(titles, rows) }
+  end
+  
+
+end

data/lib/md_parser/text_table_visitor.rb

@@ -0,0 +1,34 @@
+module MdParser
+
+  class TextTableVisitor
+
+    def cell_widths(titles, rows)
+      c = cols(titles, rows);
+      c.map{|x| x.map{|y| y ? y.length : 0}.max}
+    end
+    
+    def cols(titles, rows)
+      titles.each.with_index.map{|t,i| [t] + rows.map{|r| r[i]} }
+    end
+    
+    def pad_row(values, widths)
+      "| "+ widths.zip(values).map{|w,v| v + ( " " * (w-v.length)) }.join(" | ") + " |"
+    end
+
+    def separator_row(widths)
+      "|-"+ widths.map{|w| "-" * w }.join("-|-") + "-|"
+    end
+    
+    def to_table(titles, rows)
+      w = cell_widths(titles, rows)
+
+      ( [ pad_row(titles, w), separator_row(w) ] + 
+        rows.map{|r| pad_row(r, w)} ).join("\n")
+    end
+
+    def visit_table(titles, rows)
+      to_table(titles, rows)
+    end
+  end
+
+end

data/lib/md_parser/version.rb

@@ -0,0 +1,3 @@
+module MdParser
+  VERSION = "0.0.2"
+end

data/lib/md_parser.rb

@@ -0,0 +1,25 @@
+require 'parslet'
+require "md_parser/version"
+require "md_parser/table_parser"
+require "md_parser/hash_table_visitor"
+require "md_parser/text_table_visitor"
+
+
+module MdParser
+
+  # MdParser.beautify_table("|A|B|\n|---|---|\n|1|2|")
+  def beautify_table(table_text)
+    TableTransformer.new.apply( 
+      TableParser.new.parse( table_text ), 
+        :visitor => TextTableVisitor.new)[:table_table]
+  end
+  module_function :beautify_table
+    
+  # MdParser.table_to_hash("|A|B|\n|---|---|\n|1|2|") 
+  def table_to_hash(table_text)
+    TableTransformer.new.apply( 
+      TableParser.new.parse( table_text ), 
+        :visitor => HashTableVisitor.new)[:table_table]
+  end
+  module_function :table_to_hash
+end

data/md_parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'md_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "md_parser"
+  spec.version       = MdParser::VERSION
+  spec.authors       = ["Nigel Thorne"]
+  spec.email         = ["gems@nigelthorne.com"]
+  spec.summary       = %q{WIP: Parser for MD5 tables. }
+  spec.description   = %q{Not production ready. Do not use}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_dependency "parslet", "~> 1.6"
+end

data/specs/md_parser_specs.rb

@@ -0,0 +1,58 @@
+require 'rspec'
+require 'parslet/rig/rspec'
+require "./parser"
+
+
+describe TableParser  do
+  let(:parser) { TableParser.new }
+  
+  context "#string" do
+    it "should consume 'strings'" do
+      expect( parser.string.parse('""') ) 
+      expect( parser.string.parse('"test"') ) 
+      expect( parser.string.parse('"multiple words"') ) 
+      expect( parser.string.parse('" leading white space is fine "') ) 
+      expect( parser.string.parse(%/" so is escaped \\" quotes "/) ) 
+    end 
+  end
+  
+  context "#cell" do
+    it "should consume a cell" do
+      expect( parser.cell.parse('||')[:table_value] ).to be_empty 
+      expect( parser.cell.parse('|   |')[:table_value] ).to be_empty  
+      expect( parser.cell.parse('| test  |')[:table_value] ).to eq "test"  
+      expect( parser.cell.parse(' no leading pipe  |')[:table_value] ).to eq "no leading pipe"   
+      expect( parser.cell.parse(' "can hold a string"  |')[:table_value] ).to eq "\"can hold a string\""  
+      expect( parser.cell.parse(' "can hold a string containsing a |"  |')[:table_value] ).to eq "\"can hold a string containsing a |\"" 
+      expect{ parser.cell.parse(' has to end in |  ') }.to raise_error 
+    end
+  end
+  
+  context "#separator_row" do
+    it "should consume a separator_row" do
+      expect( parser.separator_row.parse('|---|') )
+      expect( parser.separator_row.parse('|---|---|') )
+      expect( parser.separator_row.parse('---|---|') )
+      expect( parser.separator_row.parse('---|---|---') )
+      expect( parser.separator_row.parse('------|-----|-------') )
+    end
+  end
+  
+  context "#table" do
+    it "should consume a table" do
+      expect( parser.parse("|ID | Dependencies |\n|---|---|\n|1 | 2 |") )  
+    end
+  end
+  
+  context "#row" do
+    it "should consume a row" do
+      expect( parser.row.parse('| once cell |') )
+      expect( parser.row.parse('| multiple | cells |') )
+      expect( parser.row.parse(' multiple | cells      |') )
+      expect( parser.row.parse(' multiple   | cells  |  ')[:table_row].map{|x| x[:table_value]} ).to eq ["multiple", "cells"]
+      expect( parser.row.parse(' " this \" works"   | cells  |  ')[:table_row].map{|x| x[:table_value]} ).to eq ["\" this \\\" works\"", "cells"]
+    end
+  end
+end
+
+RSpec::Core::Runner.run([])

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: md_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Nigel Thorne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-24 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Not production ready. Do not use
+email:
+- gems@nigelthorne.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/md_parser.rb
+- lib/md_parser/hash_table_visitor.rb
+- lib/md_parser/table_parser.rb
+- lib/md_parser/text_table_visitor.rb
+- lib/md_parser/version.rb
+- md_parser.gemspec
+- specs/md_parser_specs.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: 'WIP: Parser for MD5 tables.'
+test_files: []