mort666-pricetag 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source :gemcutter
+
+gem 'nokogiri', "~> 1.4.4"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  nokogiri (~> 1.4.4)
+  rcov
+  shoulda

data/README.md

@@ -0,0 +1,82 @@
+# PriceTag
+## Convert HTML into your favorite lightweight markup language
+
+Who doesn't love themselves some light markup languages? As somebody writing with one _as I type this very sentence_, I am certainly a big fan.
+
+Sure, the whole point of [Markdown][1], [Textile][2], and the like are to generate HTML, but what if you want to go the other way? To undo the horrible mistake of shackling your document in oppressive angled brackets, or perhaps share some love with markup that never knew the sweet embrace of concise, humanist syntax?
+
+With PriceTag, such transformative experiences are just a simple line of code away:
+
+    html = <<-EOF
+            <h1>Lorem Ipsum</h1>
+            <p>Lorem ipsum dolor sit amet.</p>
+           EOF
+           
+    PriceTag.html_to_markdown(html)
+    
+Or if you're of the [Textile][2] persuasion:
+    
+    PriceTag.html_to_textile(html)
+    
+
+## Usage
+  
+You can customize aspects of a document's output by providing optional parameters to the `html\_to\_*` argument:
+
+    PriceTag.html_to_markdown(html, :heading_style => :setext, :link_style => :inline)
+    
+- `link_style` : markup style for `a` tags (default: `reference`)
+  - `reference` -- link URLs are referenced as footnote
+  - `inline` -- link URLs are displayed inline with element
+
+There are language-specific options as well:
+
+### Markdown
+
+- `heading_style` : markup style for `h1`...`h6` tags (default: `atx`)
+  - `atx` -- Octothorps (#) next to heading
+  - `setext` -- Equal signs or dashes (=/-) underneath headings (falls back to atx style for h3 and above)
+  
+### Textile
+
+- `ignore_styles` : Textile allows you to set attributes (`id`, `class`, `lang`, and CSS Styles) for inline elements. When set to `true`, this information will not be included in the output (default: `true`)
+
+## Dependencies
+
+- Nokogiri 1.4+
+
+## Note on Patches/Pull Requests
+
+ 1. Fork the project.
+ 2. Make your feature addition or bug fix.
+ 3. Add tests for it. This is important so I don’t break it in a future version unintentionally.
+ 4. Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ 5. Send me a pull request. Bonus points for topic branches.
+
+## License
+
+PriceTag is licensed under the MIT License:
+
+  Copyright (c) 2010 Mattt Thompson (http://mattt.me/)
+
+  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.
+ 
+ 
+[1]: http://daringfireball.net/projects/markdown/ "Markdown, by John Gruber"
+[2]: http://textile.thresholdstate.com/ "Textile, by Dean Allen"

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "pricetag"
+  gem.homepage = "http://github.com/mattt/pricetag"
+  gem.license = "MIT"
+  gem.summary = "Convert HTML into your favorite lightweight markup language"
+  gem.description = "PriceTag converts HTML documents into light markup languages. Currently supports Markdown and Textile."
+  gem.email = "m@mattt.me"
+  gem.authors = ["Mattt Thompson"]
+  
+  gem.add_development_dependency 'nokogiri', '> 1.4'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "pricetag #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/pricetag.rb

@@ -0,0 +1,9 @@
+require 'nokogiri'
+require 'cgi'
+
+module PriceTag
+end
+
+require 'pricetag/document'
+require 'pricetag/processors'
+require 'pricetag/version'

data/lib/pricetag/document.rb

@@ -0,0 +1,19 @@
+module PriceTag
+  class Document
+    def initialize(html)
+      @xml = Nokogiri::XML("<root>" + html + "</root>") do |config|
+        config.strict.noent
+      end
+
+      @references = []
+      @xml.search("a").each do |a|
+        @references << [a['href'], a['title']]
+        a['data-reference-number'] = @references.length.to_s
+      end
+      
+      @xml.search("li").each do |li|
+        li['data-position'] = (li.parent.search("li").index(li) + 1).to_s
+      end
+    end
+  end
+end

data/lib/pricetag/processors.rb

@@ -0,0 +1,3 @@
+require 'pricetag/processors/base'
+require 'pricetag/processors/markdown'
+require 'pricetag/processors/textile'

data/lib/pricetag/processors/base.rb

@@ -0,0 +1,30 @@
+module PriceTag
+  module Processors
+    module Base
+      def process!(node, options = {})
+        return if node.text?
+      
+        node.children.each do |child|
+          process!(child, options)
+        end
+  
+        text = text_for_node(node, options)
+        node.replace(node.document.create_text_node(text))
+      end
+      
+    private
+    
+      def level_for_heading(node)
+        node.name.match(/[123456]/)[0].to_i rescue 0
+      end
+    
+      def indentation_level_for_list_item(node)        
+        node.ancestors.select{|t| ["ol", "ul"].include?(t.name)}.length
+      end
+      
+      def indentation_level_for_blockquote(node)        
+        node.ancestors.select{|t| t.name == "blockquote"}.length
+      end
+    end
+  end
+end

data/lib/pricetag/processors/markdown.rb

@@ -0,0 +1,124 @@
+module PriceTag
+  module Processors
+    module Markdown
+      extend Processors::Base
+
+      PriceTag.module_eval do
+        class << self
+          def html_to_markdown(html, options = {})
+            Document.new(html).to_markdown(options)
+          end
+        end
+      end
+
+      PriceTag::Document.class_eval do
+        include PriceTag::Processors
+        
+        def to_markdown(options = {})
+          options[:heading_style] ||= :atx
+          options[:link_style] ||= :reference
+          
+          @markdown ||= @xml.dup
+          @markdown.search("root > *").each do |node|
+            Markdown::process!(node, options)
+          end
+
+          output = CGI.unescapeHTML(@markdown.root.inner_html)
+          output += Markdown::text_for_references(@references) if options[:link_style] == :reference
+
+          return output
+        end
+      end
+
+      class << self
+        def text_for_references(references)
+          output = "\n\n"
+          references.each_with_index do |reference, i|
+            href, title = reference
+            output << "[#{i+1}]: #{href}"
+            output << " \"#{title}\"" if title and title != ""
+            output << "\n"
+          end
+          
+          return output
+        end
+        
+      private
+      
+        def text_for_node(node, options = {})
+          case tag = node.name.to_sym
+            when :h1, :h2, :h3, :h4, :h5, :h6
+              style = options[:heading_style]
+              style = :atx unless [:h1, :h2].include?(tag)
+
+              case style
+                when :setext
+                  separator = (tag == :h1 ? "=" : "-")
+                  "#{node.text}\n#{separator * node.text.length}"
+                when :atx
+                  octothorps = "#" * level_for_heading(node)
+                  "#{octothorps} #{node.text}"
+              end
+            when :li
+              indentation = "\t" * (indentation_level_for_list_item(node) - 1)
+              if node.parent.name == "ol"
+                position = node['data-position']
+                "#{indentation}#{position}. #{node.text}"
+              else
+                "#{indentation}* #{node.text}"
+              end
+            when :blockquote
+              nesting = ">" * (indentation_level_for_blockquote(node) + 1)
+              nesting + " " + node.text
+            when :a
+              style = options[:link_style]
+
+              case style
+                when :inline
+                  if node.text == node['href']
+                    "<#{node.text}>"
+                  elsif node['href'].match(/mailto:(.+)/)
+                    "<#{$1}>"
+                  elsif node['title']
+                    "[#{node.text.strip}](#{node['href']} #{node['title']})"
+                  else
+                    "[#{node.text.strip}](#{node['href']})"
+                  end
+                when :reference
+                  "[#{node.text.strip}][#{node['data-reference-number']}]"
+              end
+            when :img
+              if node['title']
+                "![#{node['alt']}](#{node['href']} #{node['title']})"
+              else
+                "![#{node['alt']}](#{node['href']})"
+              end
+            when :em
+              "_#{node.text}_"
+            when :strong
+              "**#{node.text}**"
+            when :pre
+              node.text.match(/^\t/) ? node.text : node.to_s
+            when :code
+              case node.parent.name.to_sym
+                when :pre
+                  node.text.split(/\n/).collect{|line| "\t\t" + line}.join("\n")
+                else
+                  "`#{node.text}`"
+              end
+            when :tt
+              "`#{node.text}`"
+            when :br
+              "  \n"
+            when :hr
+              "- - -"
+            when :p, :span, :ul, :ol
+              node.text
+            else
+             CGI.unescapeHTML(node.to_s)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pricetag/processors/textile.rb

@@ -0,0 +1,124 @@
+module PriceTag
+  module Processors
+    module Textile
+      extend Processors::Base
+
+      PriceTag.module_eval do
+        class << self
+          def html_to_textile(html, options = {})
+            Document.new(html).to_textile(options)
+          end
+        end
+      end
+
+      PriceTag::Document.class_eval do
+        include PriceTag::Processors
+
+        def to_textile(options = {})
+          options[:link_style] ||= :inline
+          options[:ignore_styles] ||= true
+
+          @textile ||= @xml.dup
+          @textile.search("root > *").each do |node|
+            Textile::process!(node, options)
+          end
+
+          output = CGI.unescapeHTML(@textile.root.inner_html)
+          output += Markdown::text_for_references(@references) if options[:link_style] == :reference
+
+          return output
+        end
+      end
+
+      INLINE_TAG_SYMBOLS = {
+        :span   => "%",
+        :em     => "_",
+        :i      => "__",
+        :strong => "*",
+        :b      => "**",
+        :cite   => "??",
+        :del    => "-",
+        :ins    => "+",
+        :sup    => "^",
+        :sub    => "~"
+      }
+
+      class << self
+        def text_for_references(references)
+          output = "\n\n"
+          references.each_with_index do |reference, i|
+            href, title = reference
+            output << "[#{i+1}]#{href}\n"
+          end
+
+          return output
+        end
+
+      private
+
+        def text_for_node(node, options = {})
+          case tag = node.name.to_sym
+            when :h1, :h2, :h3, :h4, :h5, :h6
+              "#{node.name}. #{node.text}"
+            when :li
+              "#{(node.parent.name == "ol" ? "#" : "*") * indentation_level_for_list_item(node)} #{node.text}"
+            when :blockquote
+              "bq. #{node.text}"
+            when :a
+              style = options[:link_style]
+
+              case style
+                when :inline
+                  if node.text.match(/^\!/)
+                   "#{node.text.strip}:#{node['href']}"
+                  else
+                    "\"#{node.text.strip}\":#{node['href']}"
+                  end
+              end
+            when :img
+              if node['title']
+                "!#{node['href']}(#{node['title']})!"
+              else
+                "!#{node['href']}!"
+              end
+            when :span, :em, :i, :strong, :b, :cite, :del, :ins, :sup, :sub
+              attributes = inline_attributes_for_node(node, options)
+              symbol = INLINE_TAG_SYMBOLS[tag]
+              "#{symbol}#{attributes}#{node.text}#{symbol}"
+            when :acronym
+              "#{node.text}(#{node['title']})"
+            when :code
+              node.parent.name.to_sym == :pre ? node.to_s : "@#{node.text}@"
+            when :tt
+              "@#{node.text}@"
+            when :p, :ul, :ol
+              node.text
+            else
+             CGI.unescapeHTML(node.to_s)
+          end
+        end
+
+      private
+
+        def inline_attributes_for_node(node, options = {})
+          return nil if node.attributes.empty?
+
+          attributes = ""
+
+          if node.attributes["id"] and node.attributes["class"]
+            attributes << "(#{node.attributes["class"]}##{node.attributes["id"]})"
+          elsif attributes["id"]
+            attributes << "(##{node.attributes["id"]})"
+          elsif attributes["class"]
+            attributes << "(#{node.attributes["class"]})"
+          end
+
+          attributes << "[#{node.attributes["lang"]}]" if node.attributes["lang"]
+          attributes << "{#{node.attributes["style"]}}" if node.attributes["style"]
+
+          return attributes
+        end
+      end
+    end
+  end
+end

data/lib/pricetag/version.rb

@@ -0,0 +1,3 @@
+module PriceTag
+  Version = VERSION = '0.1.0'
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'pricetag'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification 
+name: mort666-pricetag
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mattt Thompson
+- Stephen Kapp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-29 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
+  type: :development
+  version_requirements: *id005
+description: PriceTag converts HTML documents into light markup languages. Currently supports Markdown and Textile.
+email: m@mattt.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- VERSION
+- lib/pricetag.rb
+- lib/pricetag/document.rb
+- lib/pricetag/processors.rb
+- lib/pricetag/processors/base.rb
+- lib/pricetag/processors/markdown.rb
+- lib/pricetag/processors/textile.rb
+- lib/pricetag/version.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/mort666/pricetag
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Convert HTML into your favorite lightweight markup language
+test_files: 
+- test/helper.rb