reverse_markdown 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d29227386b5418e906da5a4cb42ce616a2d3872b
-  data.tar.gz: 0f433297212a99d783573daac3fd3723e7d9f6a0
+  metadata.gz: 2cd83465e91f441918e2b09ff1a9aca35b029e74
+  data.tar.gz: b605fad98b1666375bc80a1d16db02388a6aa43a
 SHA512:
-  metadata.gz: 23ff8eb3e7a76e197b5526fcdf6c14d899e1ec600f1b40046d5584e2c40d62a9f22734656b5843f38ec5fa53dcf3a31f7b9baa7c2962e993eb07e5d4486f3afa
-  data.tar.gz: 2e46ce50817a0e735329dd2e73a9d47943e284a7cfb440362c8f8b6b1cbbb4d9945a6c492bafe8bd34843b7987fe1556410d29d4f6b34ce1d7936c570759f5dc
+  metadata.gz: aad0b3de89e84616aa8c1de8af86949a3ae6559c90ed1361aac5e747f163b5e419fdebaab60288dfe0da3153890a5320fb80f0ee575800dcf3c7e49be5b0cc3d
+  data.tar.gz: dfde7c437ca43d2a87ed4d009b4870766b27e81e75a708092777b709eeac4795fd441c2e9652f2db91e59d02ec1131bf7016d0d6513e597d7618c93589c6b26c

data/.travis.yml

@@ -1,4 +1,5 @@
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.1.1

data/README.md

@@ -4,20 +4,29 @@ Transform html into markdown. Useful for example if you want to import html into
 
 [![Build Status](https://secure.travis-ci.org/xijo/reverse_markdown.png?branch=master)](https://travis-ci.org/xijo/reverse_markdown) [![Gem Version](https://badge.fury.io/rb/reverse_markdown.png)](http://badge.fury.io/rb/reverse_markdown) [![Code Climate](https://codeclimate.com/github/xijo/reverse_markdown.png)](https://codeclimate.com/github/xijo/reverse_markdown) [![Code Climate](https://codeclimate.com/github/xijo/reverse_markdown/coverage.png)](https://codeclimate.com/github/xijo/reverse_markdown)
 
-## Migrate to 0.5.0
+## Changelog
+
+### 0.5.1 - April 2014
+
+1. Adds support for ruby versions 1.9.3 back in
+2. More options for handling of unknown tags
+3. Bugfixes in `li` indentation behavior
+
+### 0.5.0 - March 2014
 
 There were some breaking changes, please make sure you don't miss them:
 
-1. Only ruby versions 2.0.0 or a above are supported
+1. Only ruby versions 2.0.0 or above are supported
 2. There is no `Mapper` class any more. Just use `ReverseMarkdown.convert(input, options)`
 3. Config option `github_style_code_blocks` changed its name to `github_flavored`
 
 Please open an issue and let me know about it if you have any trouble with the new version.
 
+
 ## Requirements
 
 1. [Nokogiri](http://nokogiri.org/)
-2. Ruby 2.0.0 or higher
+2. Ruby 1.9.3 or higher
 
 ## Installation
 
@@ -67,15 +76,19 @@ $ cat file.html | reverse_markdown > file.md
 
 The following options are available:
 
- - `ignore_unknown_tags` (default `true`) - bypass unknown tags instead of raising an `ReverseMarkdown::UnknownTagError`
- - `github_flavored` (default `false`) - use [github flavored markdown](https://help.github.com/articles/github-flavored-markdown) (yet only code blocks are supported)
+- `unknown_tags` (default `pass_through`) - how to handle unknown tags. Valid options are:
+  - `pass_through` - Include the unknown tag completely into the result
+  - `drop` - Drop the unknown tag and its content
+  - `bypass` - Ignore the unknown tag but try to convert its content
+  - `raise` - Raise an error to let you know
+- `github_flavored` (default `false`) - use [github flavored markdown](https://help.github.com/articles/github-flavored-markdown) (yet only code blocks are supported)
 
 ### As options
 
 Just pass your chosen configuration options in after the input
 
 ```ruby
-ReverseMarkdown.convert(input, ignore_unknown_tags: false, github_flavored: true)
+ReverseMarkdown.convert(input, unknown_tags: :raise, github_flavored: true)
 ```
 
 ### Preconfigure
@@ -92,6 +105,7 @@ end
 
 # Related stuff
 
+- [Write custom converters](https://github.com/xijo/reverse_markdown/wiki/Write-your-own-converter) - Wiki entry about how to write your own converter
 - [html_massage](https://github.com/harlantwood/html_massage) - A gem by Harlan T. Wood to convert regular sites into markdown using reverse_markdown
 - [word-to-markdown](https://github.com/benbalter/word-to-markdown) - Convert word docs into markdown while using reverse_markdown, by Ben Balter
 - [markdown syntax](http://daringfireball.net/projects/markdown) - The markdown syntax specification

data/lib/reverse_markdown.rb

@@ -9,9 +9,11 @@ require 'reverse_markdown/converters/base'
 require 'reverse_markdown/converters/a'
 require 'reverse_markdown/converters/blockquote'
 require 'reverse_markdown/converters/br'
+require 'reverse_markdown/converters/bypass'
 require 'reverse_markdown/converters/code'
+require 'reverse_markdown/converters/del'
 require 'reverse_markdown/converters/div'
-require 'reverse_markdown/converters/dump'
+require 'reverse_markdown/converters/drop'
 require 'reverse_markdown/converters/em'
 require 'reverse_markdown/converters/h'
 require 'reverse_markdown/converters/hr'
@@ -24,8 +26,8 @@ require 'reverse_markdown/converters/pre'
 require 'reverse_markdown/converters/strong'
 require 'reverse_markdown/converters/table'
 require 'reverse_markdown/converters/td'
-require 'reverse_markdown/converters/tr'
 require 'reverse_markdown/converters/text'
+require 'reverse_markdown/converters/tr'
 
 module ReverseMarkdown
 

data/lib/reverse_markdown/cleaner.rb

@@ -38,6 +38,12 @@ module ReverseMarkdown
         end
       end
 
+      result = result.gsub /\s?~{2,}.*?~{2,}\s?/ do |match|
+        preserve_border_whitespaces(match, default_border: ' ') do
+          match.strip.sub('~~ ', '~~').sub(' ~~', '~~')
+        end
+      end
+
       result.gsub /\s?\[.*?\]\s?/ do |match|
         preserve_border_whitespaces(match) do
           match.strip.sub('[ ', '[').sub(' ]', ']')
@@ -47,10 +53,11 @@ module ReverseMarkdown
 
     private
 
-    def preserve_border_whitespaces(string, default_border: '', &block)
-      string_start = present_or_default(string[/\A\s*/], default_border)
-      string_end   = present_or_default(string[/\s*\Z/], default_border)
-      result       = yield
+    def preserve_border_whitespaces(string, options = {}, &block)
+      default_border = options.fetch(:default_border, '')
+      string_start   = present_or_default(string[/\A\s*/], default_border)
+      string_end     = present_or_default(string[/\s*\Z/], default_border)
+      result         = yield
       string_start + result + string_end
     end
 

data/lib/reverse_markdown/config.rb

@@ -1,6 +1,6 @@
 module ReverseMarkdown
   class Config
-    attr_accessor :ignore_unknown_tags, :github_flavored
+    attr_accessor :unknown_tags, :github_flavored
 
     def initialize
       reset
@@ -13,8 +13,8 @@ module ReverseMarkdown
     end
 
     def reset
-      @ignore_unknown_tags = true
-      @github_flavored     = false
+      @unknown_tags    = :pass_through
+      @github_flavored = false
     end
   end
 end

data/lib/reverse_markdown/converters.rb

@@ -12,10 +12,17 @@ module ReverseMarkdown
     private
 
     def self.default_converter(tag_name)
-      if ReverseMarkdown.config.ignore_unknown_tags
-        ReverseMarkdown::Converters::Dump.new
-      else
+      case ReverseMarkdown.config.unknown_tags.to_sym
+      when :pass_through
+        ReverseMarkdown::Converters::PassThrough.new
+      when :drop
+        ReverseMarkdown::Converters::Drop.new
+      when :bypass
+        ReverseMarkdown::Converters::Bypass.new
+      when :raise
         raise UnknownTagError, "unknown tag: #{tag_name}"
+      else
+        raise InvalidConfigurationError, "unknown value #{ReverseMarkdown.config.unknown_tags.inspect} for ReverseMarkdown.config.unknown_tags"
       end
     end
   end

data/lib/reverse_markdown/converters/blockquote.rb

@@ -4,7 +4,7 @@ module ReverseMarkdown
       def convert(node)
         content = treat_children(node).strip
         content = ReverseMarkdown.cleaner.remove_newlines(content)
-        '> ' << content.lines.join('> ')
+        '> ' << content.lines.to_a.join('> ')
       end
     end
 

data/lib/reverse_markdown/converters/bypass.rb

@@ -0,0 +1,14 @@
+module ReverseMarkdown
+  module Converters
+    class Bypass < Base
+      def convert(node)
+        treat_children(node)
+      end
+    end
+
+    register :document, Bypass.new
+    register :html,     Bypass.new
+    register :body,     Bypass.new
+    register :span,     Bypass.new
+  end
+end

data/lib/reverse_markdown/converters/del.rb

@@ -0,0 +1,29 @@
+module ReverseMarkdown
+  module Converters
+    class Del < Base
+      def convert(node)
+        content = treat_children(node)
+        if disabled? || content.strip.empty? || already_crossed_out?(node)
+          content
+        else
+          "~~#{content}~~"
+        end
+      end
+
+      def enabled?
+        ReverseMarkdown.config.github_flavored
+      end
+
+      def disabled?
+        !enabled?
+      end
+
+      def already_crossed_out?(node)
+        node.ancestors('del').size > 0 || node.ancestors('strike').size > 0
+      end
+    end
+
+    register :strike, Del.new
+    register :del,    Del.new
+  end
+end

data/lib/reverse_markdown/converters/{dump.rb → drop.rb}

@@ -1,8 +1,8 @@
 module ReverseMarkdown
   module Converters
-    class Dump < Base
+    class Drop < Base
       def convert(node)
-        node.to_s
+        ''
       end
     end
   end

data/lib/reverse_markdown/converters/li.rb

@@ -19,7 +19,7 @@ module ReverseMarkdown
 
       def indentation_for(node)
         length = node.ancestors('ol').size + node.ancestors('ul').size
-        '  ' * (length - 1)
+        '  ' * [length - 1, 0].max
       end
     end
 

data/lib/reverse_markdown/converters/pass_through.rb

@@ -2,13 +2,8 @@ module ReverseMarkdown
   module Converters
     class PassThrough < Base
       def convert(node)
-        treat_children(node)
+        node.to_s
       end
     end
-
-    register :document, PassThrough.new
-    register :html,     PassThrough.new
-    register :body,     PassThrough.new
-    register :span,     PassThrough.new
   end
 end

data/lib/reverse_markdown/converters/pre.rb

@@ -7,7 +7,7 @@ module ReverseMarkdown
         if ReverseMarkdown.config.github_flavored
           "```\n" << node.text.strip << "\n```\n"
         else
-          "\n\n    " << node.text.strip.lines.join("    ") << "\n\n"
+          "\n\n    " << node.text.strip.lines.to_a.join("    ") << "\n\n"
         end
       end
     end

data/lib/reverse_markdown/errors.rb

@@ -4,4 +4,7 @@ module ReverseMarkdown
 
   class UnknownTagError < Error
   end
+
+  class InvalidConfigurationError < Error
+  end
 end

data/lib/reverse_markdown/version.rb

@@ -1,3 +1,3 @@
 module ReverseMarkdown
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/reverse_markdown.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'redcarpet'
-  s.add_development_dependency 'byebug'
+  # s.add_development_dependency 'byebug'
   s.add_development_dependency 'codeclimate-test-reporter'
 end

data/spec/components/unknown_tags_spec.rb

@@ -6,16 +6,34 @@ describe ReverseMarkdown do
   let(:document) { Nokogiri::HTML(input) }
   let(:result)   { ReverseMarkdown.convert(input) }
 
-  context 'with ignore_unknown_tags enabled' do
-    before { ReverseMarkdown.config.ignore_unknown_tags = true }
+  context 'with unknown_tags = :pass_through' do
+    before { ReverseMarkdown.config.unknown_tags = :pass_through }
 
     it { result.should include "<foo><bar>Foo with bar</bar></foo>" }
   end
 
-  context 'with ignore_unknown_tags disabled' do
-    before { ReverseMarkdown.config.ignore_unknown_tags = false }
+  context 'with unknown_tags = :raise' do
+    before { ReverseMarkdown.config.unknown_tags = :raise }
 
     it { expect { result }.to raise_error(ReverseMarkdown::UnknownTagError) }
   end
+
+  context 'with unknown_tags = :drop' do
+    before { ReverseMarkdown.config.unknown_tags = :drop }
+
+    it { result.should eq '' }
+  end
+
+  context 'with unknown_tags = :bypass' do
+    before { ReverseMarkdown.config.unknown_tags = :bypass }
+
+    it { result.should eq "Foo with bar\n\n" }
+  end
+
+  context 'with unknown_tags = :something_wrong' do
+    before { ReverseMarkdown.config.unknown_tags = :something_wrong }
+
+    it { expect { result }.to raise_error(ReverseMarkdown::InvalidConfigurationError) }
+  end
 end
 

data/spec/lib/reverse_markdown/cleaner_spec.rb

@@ -71,6 +71,12 @@ describe ReverseMarkdown::Cleaner do
       result = cleaner.clean_tag_borders(input)
       result.should eq "1 __italic__ 2 __italic__ 3 __italic__ 4"
     end
+
+    it 'cleans strikethrough stuff as well' do
+      input = "1 ~~italic ~~ 2 ~~ italic~~ 3~~italic ~~4"
+      result = cleaner.clean_tag_borders(input)
+      result.should eq "1 ~~italic~~ 2 ~~italic~~ 3 ~~italic~~ 4"
+    end
   end
 
 end

data/spec/lib/reverse_markdown/converters/del_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe ReverseMarkdown::Converters::Del do
+  let(:converter) { ReverseMarkdown::Converters::Del.new }
+
+  context 'with github_flavored = true' do
+    before { ReverseMarkdown.config.github_flavored = true }
+
+    it 'converts the input as expected' do
+      input = Nokogiri::XML.parse('<del>deldeldel</del>').root
+      converter.convert(input).should eq '~~deldeldel~~'
+    end
+
+    it 'skips empty tags' do
+      input = Nokogiri::XML.parse('<del></del>').root
+      converter.convert(input).should eq ''
+    end
+
+    it 'knows about its enabled/disabled state' do
+      converter.should be_enabled
+      converter.should_not be_disabled
+    end
+  end
+
+  context 'with github_flavored = false' do
+    before { ReverseMarkdown.config.github_flavored = false }
+
+    it 'does not convert anything' do
+      input = Nokogiri::XML.parse('<del>deldeldel</del>').root
+      converter.convert(input).should eq 'deldeldel'
+    end
+
+    it 'knows about its enabled/disabled state' do
+      converter.should_not be_enabled
+      converter.should be_disabled
+    end
+  end
+end

data/spec/lib/reverse_markdown/converters/li_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe ReverseMarkdown::Converters::Li do
+
+  let(:converter) { ReverseMarkdown::Converters::Li.new }
+
+  it 'does not fail without a valid parent context' do
+    input = Nokogiri::XML.parse("<li>foo</li>").root
+    result = converter.convert(input)
+    result.should eq "- foo\n"
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 
 require 'simplecov'
-require 'byebug'
+# require 'byebug'
 
 SimpleCov.adapters.define 'gem' do
   add_filter '/spec/'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reverse_markdown
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Johannes Opper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !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
@@ -132,9 +118,11 @@ files:
 - lib/reverse_markdown/converters/base.rb
 - lib/reverse_markdown/converters/blockquote.rb
 - lib/reverse_markdown/converters/br.rb
+- lib/reverse_markdown/converters/bypass.rb
 - lib/reverse_markdown/converters/code.rb
+- lib/reverse_markdown/converters/del.rb
 - lib/reverse_markdown/converters/div.rb
-- lib/reverse_markdown/converters/dump.rb
+- lib/reverse_markdown/converters/drop.rb
 - lib/reverse_markdown/converters/em.rb
 - lib/reverse_markdown/converters/h.rb
 - lib/reverse_markdown/converters/hr.rb
@@ -180,6 +168,8 @@ files:
 - 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/converters/del_spec.rb
+- spec/lib/reverse_markdown/converters/li_spec.rb
 - spec/lib/reverse_markdown_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/xijo/reverse_markdown
@@ -234,5 +224,7 @@ test_files:
 - 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/converters/del_spec.rb
+- spec/lib/reverse_markdown/converters/li_spec.rb
 - spec/lib/reverse_markdown_spec.rb
 - spec/spec_helper.rb