reverse_markdown 0.4.7 → 0.5.0

metadata

@@ -1,83 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: reverse_markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.0
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-01 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   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: simplecov
   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: redcarpet
   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: byebug
+  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: codeclimate-test-reporter
+  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: Map simple html back into markdown, e.g. if you want to import existing
@@ -89,16 +117,39 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
-- License-MIT
+- LICENSE
 - README.md
 - Rakefile
 - bin/reverse_markdown
 - lib/reverse_markdown.rb
+- lib/reverse_markdown/cleaner.rb
+- lib/reverse_markdown/config.rb
+- lib/reverse_markdown/converters.rb
+- lib/reverse_markdown/converters/a.rb
+- lib/reverse_markdown/converters/base.rb
+- lib/reverse_markdown/converters/blockquote.rb
+- lib/reverse_markdown/converters/br.rb
+- lib/reverse_markdown/converters/code.rb
+- lib/reverse_markdown/converters/div.rb
+- lib/reverse_markdown/converters/dump.rb
+- lib/reverse_markdown/converters/em.rb
+- lib/reverse_markdown/converters/h.rb
+- lib/reverse_markdown/converters/hr.rb
+- lib/reverse_markdown/converters/img.rb
+- lib/reverse_markdown/converters/li.rb
+- lib/reverse_markdown/converters/ol.rb
+- lib/reverse_markdown/converters/p.rb
+- lib/reverse_markdown/converters/pass_through.rb
+- lib/reverse_markdown/converters/pre.rb
+- lib/reverse_markdown/converters/strong.rb
+- lib/reverse_markdown/converters/table.rb
+- lib/reverse_markdown/converters/td.rb
+- lib/reverse_markdown/converters/text.rb
+- lib/reverse_markdown/converters/tr.rb
 - lib/reverse_markdown/errors.rb
-- lib/reverse_markdown/mapper.rb
 - lib/reverse_markdown/version.rb
 - reverse_markdown.gemspec
 - spec/assets/anchors.html
@@ -113,6 +164,7 @@ files:
 - spec/assets/paragraphs.html
 - spec/assets/quotation.html
 - spec/assets/tables.html
+- spec/assets/unknown_tags.html
 - spec/components/anchors_spec.rb
 - spec/components/basic_spec.rb
 - spec/components/code_spec.rb
@@ -123,9 +175,12 @@ files:
 - spec/components/paragraphs_spec.rb
 - spec/components/quotation_spec.rb
 - spec/components/tables_spec.rb
+- spec/components/unknown_tags_spec.rb
 - spec/html_to_markdown_to_html_spec.rb
-- spec/mapper_spec.rb
-- spec/reverse_markdown_spec.rb
+- spec/lib/reverse_markdown/cleaner_spec.rb
+- spec/lib/reverse_markdown/converters/blockquote_spec.rb
+- spec/lib/reverse_markdown/converters/br_spec.rb
+- spec/lib/reverse_markdown_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/xijo/reverse_markdown
 licenses: []
@@ -136,20 +191,20 @@ 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: reverse_markdown
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Transform html code into markdown.
+summary: Convert html code into markdown.
 test_files:
 - spec/assets/anchors.html
 - spec/assets/basic.html
@@ -163,6 +218,7 @@ test_files:
 - spec/assets/paragraphs.html
 - spec/assets/quotation.html
 - spec/assets/tables.html
+- spec/assets/unknown_tags.html
 - spec/components/anchors_spec.rb
 - spec/components/basic_spec.rb
 - spec/components/code_spec.rb
@@ -173,7 +229,10 @@ test_files:
 - spec/components/paragraphs_spec.rb
 - spec/components/quotation_spec.rb
 - spec/components/tables_spec.rb
+- spec/components/unknown_tags_spec.rb
 - spec/html_to_markdown_to_html_spec.rb
-- spec/mapper_spec.rb
-- spec/reverse_markdown_spec.rb
+- spec/lib/reverse_markdown/cleaner_spec.rb
+- spec/lib/reverse_markdown/converters/blockquote_spec.rb
+- spec/lib/reverse_markdown/converters/br_spec.rb
+- spec/lib/reverse_markdown_spec.rb
 - spec/spec_helper.rb

data/License-MIT

@@ -1,7 +0,0 @@
-Copyright (c) 2012 Johannes Opper
-
-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/lib/reverse_markdown/mapper.rb

@@ -1,241 +0,0 @@
-module ReverseMarkdown
-  class Mapper
-    attr_accessor :raise_errors
-    attr_accessor :log_enabled, :log_level
-    attr_accessor :li_counter
-    attr_accessor :github_style_code_blocks
-
-    def initialize(opts={})
-      self.log_level   = opts.fetch(:log_level) { :info }
-      self.log_enabled = opts.fetch(:log_enabled) { true }
-      self.li_counter  = 0
-      self.github_style_code_blocks = opts[:github_style_code_blocks] || false
-    end
-
-    def process_root(element)
-      return '' if element.nil?
-
-      markdown = process_element(element)  # recursively process all elements to get full markdown
-
-      # Extract github style code blocks
-      extractions = {}
-      markdown.gsub!(%r{```.*?```}m) do |match|
-        md5 = Digest::MD5.hexdigest(match)
-        extractions[md5] = match
-        "{code-block-extraction-#{md5}}"
-      end
-
-      markdown = markdown.split("\n").map do |line|
-        if line.match(/^( {4}|\t)/)
-          line
-        else
-          "#{ '  ' if line.match(/^ {2,3}/) }" +
-          normalize_whitespace(line).strip +
-          "#{ '  ' if line.match(/ {2}$/) }"
-        end
-      end.join("\n")
-
-      markdown.gsub!(/\n{3,}/, "\n\n")
-
-      # Insert pre block extractions
-      markdown.gsub!(/\{code-block-extraction-([0-9a-f]{32})\}/){ extractions[$1] }
-
-      markdown
-    end
-
-    def process_element(element)
-      output = ''
-      if element.text?
-        text = process_text(element)
-        if output.end_with?(' ') && text.start_with?(' ')
-          output << text.lstrip
-        else
-          output << text
-        end
-      else
-        output << opening(element).to_s
-
-        markdown_chunks = element.children.map { |child| process_element(child) }
-        remove_adjacent_whitespace!(markdown_chunks)
-        output << markdown_chunks.join
-
-        output << ending(element).to_s
-      end
-      output
-    end
-
-    private
-
-    # removes whitespace-only chunk if the previous chunk ends with whitespace
-    def remove_adjacent_whitespace!(chunks)
-      (chunks.size - 1).downto(1).each do |i|
-        chunk = chunks[i]
-        previous_chunk = chunks[i-1]
-        chunks.delete_at(i) if chunk == ' ' && previous_chunk.end_with?(' ')
-      end
-    end
-
-    def opening(element)
-      parent = element.parent ? element.parent.name.to_sym : nil
-      case element.name.to_sym
-        when :html, :body
-          ""
-        when :li
-          indent = '  ' * [(element.ancestors('ol').count + element.ancestors('ul').count - 1), 0].max
-          if parent == :ol
-            "#{indent}#{self.li_counter += 1}. "
-          else
-            "#{indent}- "
-          end
-        when :pre
-          "\n"
-        when :ol
-          self.li_counter = 0
-          "\n"
-        when :ul, :root#, :p
-          "\n"
-        when :div
-          "\n"
-        when :p
-          if element.ancestors.map(&:name).include?('blockquote')
-            "\n\n> "
-          elsif [nil, :body].include? parent
-            is_first = true
-            previous = element.previous
-            while is_first == true and previous do
-              is_first = false unless previous.content.strip == "" || previous.text?
-              previous = previous.previous
-            end
-            is_first ? "" : "\n\n"
-          else
-            "\n\n"
-          end
-        when :h1, :h2, :h3, :h4, :h5, :h6 # /h(\d)/ for 1.9
-          element.name =~ /h(\d)/
-          "\n" + ('#' * $1.to_i) + ' '
-        when :em, :i
-          element.text.strip.empty? ? '' : '_' if (element.ancestors('em') + element.ancestors('i')).empty?
-        when :strong, :b
-          element.text.strip.empty? ? '' : '**' if (element.ancestors('strong') + element.ancestors('b')).empty?
-        when :blockquote
-          "> "
-        when :code
-          if parent == :pre
-            self.github_style_code_blocks ? "\n```\n" : "\n    "
-          else
-            " `"
-          end
-        when :a
-          if (!element.text.strip.empty? || element.children.map(&:name).include?('img')) && element['href'] && !element['href'].start_with?('#')
-            " ["
-          else
-            " "
-          end
-        when :img
-          " !["
-        when :hr
-          "\n* * *\n"
-        when :br
-          "  \n"
-        when :table
-          "\n\n"
-        when :tr
-          "|"
-        when :th, :td
-          if element == element.parent.first_element_child
-            " "
-          else
-            "| "
-          end
-        else
-          handle_error "unknown start tag: #{element.name.to_s}"
-          ""
-      end
-    end
-
-    def ending(element)
-      parent = element.parent ? element.parent.name.to_sym : nil
-      case element.name.to_sym
-        when :html, :body, :pre, :hr
-          ""
-        when :p
-          "\n\n"
-        when :div
-          "\n"
-        when :h1, :h2, :h3, :h4, :h5, :h6 # /h(\d)/ for 1.9
-          "\n"
-        when :em, :i
-          element.text.strip.empty? ? '' : '_' if (element.ancestors('em') + element.ancestors('i')).empty?
-        when :strong, :b
-          element.text.strip.empty? ? '' : '**' if (element.ancestors('strong') + element.ancestors('b')).empty?
-        when :li, :blockquote, :root, :ol, :ul
-          "\n"
-        when :code
-          if parent == :pre
-            self.github_style_code_blocks ? "\n```" : "\n"
-          else
-           '` '
-          end
-        when :a
-          if (!element.text.strip.empty? || element.children.map(&:name).include?('img')) && element['href'] && !element['href'].start_with?('#')
-            "](#{element['href']}#{title_markdown(element)})"
-          else
-            ""
-          end
-        when :img
-          "#{element['alt']}](#{element['src']}#{title_markdown(element)}) "
-        when :table
-          "\n"
-        when :tr
-          "|\n" + \
-            if element.element_children.all? {|child| child.name.to_sym == :th}
-              "| " + (['---'] * element.element_children.size).join(' | ') + " |\n"
-            else
-              ""
-            end
-        when :th, :td
-          " "
-        else
-          handle_error "unknown end tag: #{element.name}"
-          ""
-      end
-    end
-
-    def title_markdown(element)
-      title = element['title']
-      title ? %[ "#{title}"] : ''
-    end
-
-    def process_text(element)
-      parent = element.parent ? element.parent.name.to_sym : nil
-      case
-        when parent == :code
-          if self.github_style_code_blocks
-            element.text
-          else
-            element.text.strip.gsub(/\n/,"\n    ")
-          end
-        else
-          normalize_whitespace(escape_text(element.text))
-      end
-    end
-
-    def normalize_whitespace(text)
-      text.tr("\n\t", ' ').squeeze(' ')
-    end
-
-    def escape_text(text)
-      text.
-        gsub('*', '\*').
-        gsub('_', '\_')
-    end
-
-    def handle_error(message)
-      if raise_errors
-        raise ReverseMarkdown::ParserError, message
-      elsif log_enabled && defined?(Rails)
-        Rails.logger.__send__(log_level, message)
-      end
-    end
-  end
-end

data/spec/mapper_spec.rb

@@ -1,63 +0,0 @@
-require 'spec_helper'
-
-describe ReverseMarkdown::Mapper do
-  let(:input)    { File.read('spec/assets/minimum.html') }
-  let(:document) { Nokogiri::HTML(input) }
-  let(:mapper)   { ReverseMarkdown::Mapper.new }
-
-  it "behaves in a sane way when root element is nil" do
-    mapper.process_root(nil).should == ''
-  end
-
-  describe "logging options" do
-    it "has a default log level info" do
-      mapper.log_level.should eq :info
-    end
-
-    it "overwrites log level if option is given" do
-      mapper = ReverseMarkdown::Mapper.new(log_level: :error)
-      mapper.log_level.should eq :error
-    end
-
-    it "enables logging by default" do
-      mapper.log_enabled.should be_true
-    end
-
-    it "disables logging if told to" do
-      mapper = ReverseMarkdown::Mapper.new(log_enabled: false)
-      mapper.log_enabled.should be_false
-    end
-  end
-
-  context "error handling" do
-
-    let(:unknown_element) { Nokogiri::XML::Node.new('foo', document) }
-
-    it "raises error if told so" do
-      mapper.raise_errors = true
-      expect {
-        mapper.__send__(:opening, unknown_element)
-      }.to raise_error(ReverseMarkdown::ParserError)
-    end
-
-    it "supresses errors if told so" do
-      mapper.raise_errors = false
-      expect {
-        mapper.__send__(:opening, unknown_element)
-      }.not_to raise_error
-    end
-
-    context "with Rails present" do
-
-      module Rails # Fake Rails for specs
-        def self.logger; @@logger ||= Logger.new; end
-        class Logger; def info(message); end; end
-      end
-
-      it "logs with Rails.logger if present" do
-        Rails.logger.should_receive(:info)
-        mapper.__send__(:ending, unknown_element)
-      end
-    end
-  end
-end

data/spec/reverse_markdown_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe ReverseMarkdown do
-  let(:input)    { File.read('spec/assets/minimum.html') }
-  let(:document) { Nokogiri::HTML(input) }
-
-  it "parses nokogiri documents" do
-    lambda { ReverseMarkdown.parse_element(document) }.should_not raise_error
-  end
-
-  it "parses nokogiri elements" do
-    lambda { ReverseMarkdown.parse_element(document.root) }.should_not raise_error
-  end
-
-  it "parses string input" do
-    lambda { ReverseMarkdown.parse_string(input) }.should_not raise_error
-  end
-end