html2md 0.1

data/LICENSE.md

@@ -0,0 +1,202 @@
+Apache License  
+  
+Version 2.0, January 2004  
+  
+[http://www.apache.org/licenses/](http://www.apache.org/licenses/) 
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+**1. Definitions**.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the
+copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other
+entities that control, are controlled by, or are under common control with
+that entity. For the purposes of this definition, "control" means (i) the
+power, direct or indirect, to cause the direction or management of such
+entity, whether by contract or otherwise, or (ii) ownership of fifty
+percent (50%) or more of the outstanding shares, or (iii) beneficial
+ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation source,
+and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation
+or translation of a Source form, including but not limited to compiled
+object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that
+is included in or attached to the work (an example is provided in the
+Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form,
+that is based on (or derived from) the Work and for which the editorial
+revisions, annotations, elaborations, or other modifications represent, as
+a whole, an original work of authorship. For the purposes of this License,
+Derivative Works shall not include works that remain separable from, or
+merely link (or bind by name) to the interfaces of, the Work and Derivative
+Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal
+Entity authorized to submit on behalf of the copyright owner. For the
+purposes of this definition, "submitted" means any form of electronic,
+verbal, or written communication sent to the Licensor or its
+representatives, including but not limited to communication on electronic
+mailing lists, source code control systems, and issue tracking systems that
+are managed by, or on behalf of, the Licensor for the purpose of discussing
+and improving the Work, but excluding communication that is conspicuously
+marked or otherwise designated in writing by the copyright owner as "Not a
+Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on
+behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+**2. Grant of Copyright License**. Subject to the
+terms and conditions of this License, each Contributor hereby grants to You
+a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of, publicly
+display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+**3. Grant of Patent License**. Subject to the terms
+and conditions of this License, each Contributor hereby grants to You a
+perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made, use,
+offer to sell, sell, import, and otherwise transfer the Work, where such
+license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by
+combination of their Contribution(s) with the Work to which such
+Contribution(s) was submitted. If You institute patent litigation against
+any entity (including a cross-claim or counterclaim in a lawsuit) alleging
+that the Work or a Contribution incorporated within the Work constitutes
+direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the
+date such litigation is filed.
+
+**4. Redistribution**. You may reproduce and
+distribute copies of the Work or Derivative Works thereof in any medium,
+with or without modifications, and in Source or Object form, provided that
+You meet the following conditions:
+
+
+  1. You must give any other recipients of the Work or Derivative Works a
+copy of this License; and
+
+
+  2. You must cause any modified files to carry prominent notices stating
+that You changed the files; and
+
+
+  3. You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from
+the Source form of the Work, excluding those notices that do not pertain to
+any part of the Derivative Works; and
+
+
+  4. If the Work includes a "NOTICE" text file as part of its distribution,
+then any Derivative Works that You distribute must include a readable copy
+of the attribution notices contained within such NOTICE file, excluding
+those notices that do not pertain to any part of the Derivative Works, in
+at least one of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or documentation,
+if provided along with the Derivative Works; or, within a display generated
+by the Derivative Works, if and wherever such third-party notices normally
+appear. The contents of the NOTICE file are for informational purposes only
+and do not modify the License. You may add Your own attribution notices
+within Derivative Works that You distribute, alongside or as an addendum to
+the NOTICE text from the Work, provided that such additional attribution
+notices cannot be construed as modifying the License.
+You may add Your own copyright statement to Your modifications and may
+provide additional or different license terms and conditions for use,
+reproduction, or distribution of Your modifications, or for any such
+Derivative Works as a whole, provided Your use, reproduction, and
+distribution of the Work otherwise complies with the conditions stated in
+this License.
+
+
+**5. Submission of Contributions**. Unless You
+explicitly state otherwise, any Contribution intentionally submitted for
+inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the
+terms of any separate license agreement you may have executed with Licensor
+regarding such Contributions.
+
+**6. Trademarks**. This License does not grant
+permission to use the trade names, trademarks, service marks, or product
+names of the Licensor, except as required for reasonable and customary use
+in describing the origin of the Work and reproducing the content of the
+NOTICE file.
+
+**7. Disclaimer of Warranty**. Unless required by
+applicable law or agreed to in writing, Licensor provides the Work (and
+each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
+WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including,
+without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You
+are solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise
+of permissions under this License.
+
+**8. Limitation of Liability**. In no event and
+under no legal theory, whether in tort (including negligence), contract, or
+otherwise, unless required by applicable law (such as deliberate and
+grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a result
+of this License or out of the use or inability to use the Work (including
+but not limited to damages for loss of goodwill, work stoppage, computer
+failure or malfunction, or any and all other commercial damages or losses),
+even if such Contributor has been advised of the possibility of such
+damages.
+
+**9. Accepting Warranty or Additional Liability**.
+While redistributing the Work or Derivative Works thereof, You may choose
+to offer, and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this License.
+However, in accepting such obligations, You may act only on Your own behalf
+and on Your sole responsibility, not on behalf of any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor
+harmless for any liability incurred by, or claims asserted against, such
+Contributor by reason of your accepting any such warranty or additional
+liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your workTo apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included
+on the same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+
+```
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+require "cucumber/rake/task"
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'html2md'
+
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--format pretty}
+end
+
+desc "Test"
+task :t, [] => [] do |taks,args| 
+  t = Html2Md.new(File.read('test.html'))
+  puts t.parse
+end

data/features/markdown.feature

@@ -0,0 +1,82 @@
+Feature: Markdown
+  We need to convert basic HTML to markdown
+
+  Scenario: Create a H Rule (HR) element
+    * HTML <hr/>
+    * I say parse
+    * The markdown should be (\n* * * * *\n)
+
+  Scenario: Create a hard break (BR) element
+    * HTML <br/>
+    * I say parse
+    * The markdown should be (  \n)
+
+  Scenario: Paragraph (P) elements should be a single hard return
+    * HTML <p>
+    * I say parse
+    * The markdown should be (\n\n)
+
+  Scenario: Link (a href=) elements should should convert
+    * HTML <a href="/some/link.html"> Link </a>
+    * I say parse
+    * The markdown should be ([ Link ](/some/link.html))
+
+  Scenario: Other ancors should be ignored
+    * HTML <a name="link"> Link </a>
+    * I say parse
+    * The markdown should be ( Link )
+
+  Scenario: Ancors should reset after being used once
+    * HTML <a href="/some/link.html"> Link </a> <a name="link"> Link </a>
+    * I say parse
+    * The markdown should be ([ Link ](/some/link.html)  Link )
+
+  Scenario: Other (a) elements should be ignored
+    * HTML <a> Text </a>
+    * I say parse
+    * The markdown should be ( Text ) 
+
+  Scenario: An order list
+    * HTML <ol><li>First</li><li>Second</li><ol>
+    * I say parse
+    * The markdown should be (\n  1. First\n  2. Second\n\n)
+
+  Scenario: An un-order list
+    * HTML <ul><li>First</li><li>Second</li><ul>
+    * I say parse
+    * The markdown should be (\n  - First\n  - Second\n\n) 
+
+  Scenario: Complex List
+    * HTML <ul><li>First</li><li> <ol><li>First<ul><li>First</li><li>Second</li></ul></li><li>Second</li> </ol>Second</li><ul>
+    * I say parse
+    * The markdown should be (\n  - First\n  - \n    1. First\n      - First\n      - Second\n\n    2. Second\nSecond\n\n)
+
+  Scenario: Emphasis (em) element
+    * HTML <em>Emphasis</em>
+    * I say parse
+    * The markdown should be (_Emphasis_)
+
+  Scenario: Strong (strong) element
+    * HTML <strong>Emphasis</strong>
+    * I say parse
+    * The markdown should be (**Emphasis**)
+
+  Scenario: Pre (pre) element
+    * HTML <pre>This is some preformatted code</pre>
+    * I say parse
+    * The markdown should be (\n```\nThis is some preformatted code\n```\n) 
+
+  Scenario: Other HTML Elements (div) should be ignored
+    * HTML <div>This is in a div</div>
+    * I say parse
+    * The markdown should be (This is in a div)
+
+  Scenario: Other HTML Elements (span) should be ignored  
+    * HTML <span>This is in a span</span>
+    * I say parse
+    * The markdown should be (This is in a span) 
+
+  Scenario: Character data should not have new lines  
+    * HTML This is character data \n
+    * I say parse
+    * The markdown should be (This is character data \n\n)     

data/features/step_definitions/markdown_steps.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'rspec/expectations'
+require 'cucumber/formatter/unicode'
+$:.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'html2md'
+
+Before do
+  @html2md = Html2Md.new
+end
+
+After do
+end
+
+Given /HTML (.*)/ do |n|
+  @html2md.source = n.gsub("\\n", "\n")
+end
+
+When /I say parse/ do
+  @result = @html2md.parse
+end
+
+Then /The markdown should be \((.*)\)/ do |result|
+  @result.should == result.gsub("\\n", "\n")
+end

data/lib/html2md.rb

@@ -0,0 +1,19 @@
+require 'nokogiri'
+require 'html2md/document'
+
+class Html2Md
+  attr_accessor :options, :source
+
+  def initialize(source =nil , options = {})
+    @options = options
+    @source = source
+  end
+
+  def parse()
+    doc = Html2Md::Document.new()
+    doc.relative_url = options[:relative_url]
+    parser = Nokogiri::HTML::SAX::Parser.new(doc)
+    parser.parse(source)
+    parser.document.markdown
+  end
+end

data/lib/html2md/VERSION.rb

@@ -0,0 +1,3 @@
+class Html2Md
+  VERSION = "0.1"
+end

data/lib/html2md/document.rb

@@ -0,0 +1,176 @@
+require 'nokogiri'
+require 'uri'
+
+class Html2Md
+  class Document < Nokogiri::XML::SAX::Document
+    
+    attr_reader :markdown
+    attr_accessor :relative_url
+
+    def start_document
+      @markdown = ''
+      @last_href = nil
+      @allowed_tags = ['tr','td','th','table']
+      @current_list = -1
+      @list_tree = []
+
+    end
+    
+    def start_tag(name,attributes = [])
+      if @allowed_tags.include? name
+        "<#{name}>"
+      else 
+        ''
+      end
+    end
+
+    def end_tag(name,attributes = [])
+      if @allowed_tags.include? name
+       "</#{name}>"
+      else
+        ''  
+      end  
+    end
+
+    def start_element name, attributes = []
+      start_name = "start_#{name}".to_sym
+      both_name = "start_and_end_#{name}".to_sym
+
+      if self.respond_to?(both_name)
+        self.send( both_name, attributes )
+      elsif self.respond_to?(start_name)
+        self.send( start_name, attributes ) 
+      else
+        @markdown << start_tag(name)
+      end
+
+    end
+
+    def end_element name, attributes = []
+      end_name = "end_#{name}".to_sym
+      both_name = "start_and_end_#{name}".to_sym
+
+      if self.respond_to?(both_name)
+        self.send( both_name, attributes )
+      elsif self.respond_to?(end_name)
+        self.send( end_name, attributes ) 
+      else
+        @markdown << end_tag(name)
+      end     
+    end
+
+    def start_hr(attributes)
+      @markdown << "\n* * * * *\n"
+    end
+
+    def end_hr(attributes)
+      
+    end
+
+    def start_and_end_em(attributes)
+      @markdown << '_'
+    end
+
+    def start_and_end_strong(attributes)
+      @markdown << '**'
+    end
+
+    def start_br(attributes)
+      @markdown << "  \n"
+    end
+
+    def end_br(attributes)
+
+    end
+
+    def start_p(attributes)
+      
+    end
+
+    def end_p(attributes)
+      @markdown << "\n\n"
+    end
+
+    def start_a(attributes)
+      attributes.each do | attrib |
+        if attrib[0].downcase.eql? 'href'
+          @markdown << '['
+          @last_href = attrib[1]
+        end
+      end
+    end
+
+    def start_pre(attributes)
+      @markdown << "\n```\n"
+    end
+
+    def end_pre(attributes)
+      @markdown << "\n```\n"
+    end
+
+    def end_a(attributes)
+        if @last_href and not (['http','https'].include? URI(@last_href).scheme)
+            begin 
+              rp = URI(relative_url)
+              rp.path = @last_href
+              @last_href = rp.to_s
+            rescue
+            end
+        end
+
+        @markdown << "](#{@last_href})" if @last_href
+        @last_href = nil if @last_href
+
+    end
+
+    def start_ul(attributes)
+      @list_tree.push( { :type => :ul, :current_element => 0 } )
+      @markdown << "\n"
+    end
+
+    def end_ul(attributes)
+      @list_tree.pop
+    end
+
+    def start_ol(attributes)
+      @list_tree.push( { :type => :ol, :current_element => 0 } )
+      @markdown << "\n"
+    end
+
+    def end_ol(attributes)
+      @list_tree.pop
+    end
+
+    def start_li(attributes)
+      
+      @list_tree.length.times do 
+        @markdown << "  "
+      end
+
+      @list_tree[-1][:current_element] += 1
+
+      case @list_tree[-1][:type]
+      when :ol
+        @markdown << "#{ @list_tree[-1][:current_element] }. "
+      when :ul
+        @markdown << "- "
+      end
+        
+    end
+
+    def end_li(attributes)
+      @markdown << "\n"
+    end
+
+    def characters c
+      if @list_tree[-1]
+        @markdown << c.chomp.lstrip.rstrip
+      else
+        @markdown << c.chomp
+      end
+    end
+
+    
+  end
+end
+

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: html2md
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Paul Morton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-18 00:00:00.000000000 Z
+dependencies: []
+description: ! '  Converts Basic HTML to markdown
+
+'
+email: geeksitk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- LICENSE.md
+- lib/html2md/document.rb
+- lib/html2md/VERSION.rb
+- lib/html2md.rb
+- features/markdown.feature
+- features/step_definitions/markdown_steps.rb
+homepage: http://github.com/pmorton/html2md
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A library for converting basic html to markdown
+test_files: []