pricecut 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--order random

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/README.md

@@ -1,4 +1,4 @@
-# Pricecut
+# Pricecut [![Build Status][build_status_image]][build_status]
 
 Pricecut takes your HTML and marks it down.
 
@@ -18,7 +18,44 @@ Or install it yourself as:
 
 ## Usage
 
-Usage instructions coming soon.
+```ruby
+require "pricecut"
+
+html = <<-HTML
+  <h1>Pricecut is Awesome!</h1>
+
+  <p>
+    Pricecut lets me take my <strong>HTML</strong> and 
+    <em>mark it down</em>.
+  </p>
+
+  <p><img src="awesome.png" alt="Awesome" /></p>
+HTML
+
+Pricecut.parse(html)
+# => # Pricecut is Awesome! #
+#    Pricecut lets me take my **HTML** and _mark it down_.
+#    ![Awesome](awesome.png)
+```
+
+## Supported Platforms
+
+*  Ruby 1.8.7
+*  Ruby 1.9.3
+*  JRuby _(1.8 mode)_
+*  JRuby _(1.9 mode)_
+*  Rubinius _(1.8 mode)_
+*  Rubinius _(1.9 mode)_
+
+## TODO
+
+*  Decouple `MarkdownVisitor` from `Pricecut::Elements`.
+*  Document code.
+*  Add support for Markdown code blocks.
+*  Add indentation support.
+*  Add word-wrap support. _(80 characters)_
+*  Make `Pricecut::Elements` classes configurable.
+   _(e.g. Use your own custom class for `<hr />` if you want.)_
 
 ## Contributing
 
@@ -27,3 +64,11 @@ Usage instructions coming soon.
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Copyright
+Copyright (c) 2012 [Adam Tanner][email]. See [License][license] for details.
+
+[email]: mailto:adam@adamtanner.org
+[license]: https://github.com/adamtanner/pricecut/blob/master/LICENSE.md
+[build_status]: http://travis-ci.org/adamtanner/pricecut
+[build_status_image]: https://secure.travis-ci.org/adamtanner/pricecut.png

data/Rakefile

@@ -1,2 +1,8 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/lib/pricecut.rb

@@ -18,7 +18,8 @@ require "pricecut/elements/a"
 
 module Pricecut
   def self.parse(html)
-    root = Nokogiri::HTML::DocumentFragment.parse(html)
+    root = Nokogiri::HTML::Document.parse(html) {|c| c.noblanks }
+
     MarkdownVisitor.new.visit(root).output
   end
 end

data/lib/pricecut/elements/blockquote.rb

@@ -2,7 +2,7 @@ module Pricecut
   module Elements
     class Blockquote < Element
       def output!
-         p "> "; yield_children
+        p "> "; yield_children
       end
     end
   end

data/lib/pricecut/elements/li.rb

@@ -2,13 +2,17 @@ module Pricecut
   module Elements
     class Li < Element
       def output!
-        case node.parent.name
-        when "ol"
+        if ordered_list?
           p "1.  "; yield_children; eol
-        when "ul"
+        else
           p "-  "; yield_children; eol
         end
       end
+
+      private
+      def ordered_list?
+        node.parent.name == "ol"
+      end
     end
   end
 end

data/lib/pricecut/elements/text.rb

@@ -2,7 +2,30 @@ module Pricecut
   module Elements
     class Text < Element
       def output!
-        p node.text.strip
+        return if whitespace_only?
+
+        output = node.text
+
+        output.tr!("\n", " ")
+        output.squeeze!(" ")
+
+        output.lstrip! unless previous_sibling?
+        output.rstrip! unless next_sibling?
+
+        p output
+      end
+
+      private
+      def whitespace_only?
+        node.blank?
+      end
+
+      def previous_sibling?
+        node.previous_sibling
+      end
+
+      def next_sibling?
+        node.next_sibling
       end
     end
   end

data/lib/pricecut/markdown_visitor.rb

@@ -9,10 +9,10 @@ module Pricecut
     end
 
     def visit(node)
-      begin
+      if Pricecut::Elements.const_defined?(node.name.capitalize)
         element = Pricecut::Elements.const_get(node.name.capitalize)
         element.new(self, node).output!
-      rescue NameError
+      else
         # Unsupported element, continue visiting children.
         visit_children(node)
       end

data/lib/pricecut/version.rb

@@ -1,3 +1,3 @@
 module Pricecut
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/pricecut.gemspec

@@ -17,5 +17,6 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency "nokogiri"
 
+  gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
 end

data/spec/pricecut/elements/a_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::A do
 
   describe "#output!" do
     it "appends a Markdown link to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("[Example](http://example.com)")
+      visitor.output.should eq("[Example](http://example.com)")
     end
   end
 end

data/spec/pricecut/elements/blockquote_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::Blockquote do
 
   describe "#output!" do
     it "appends a Markdown blockquote to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("> Blockquote")
+      visitor.output.should eq("> Blockquote")
     end
   end
 end

data/spec/pricecut/elements/em_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::Em do
 
   describe "#output!" do
     it "appends a Markdown emphasis to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("_Emphasized._")
+      visitor.output.should eq("_Emphasized._")
     end
   end
 end

data/spec/pricecut/elements/h1_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H1 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("# Heading #\n")
+      visitor.output.should eq("# Heading #\n")
     end
   end
 end

data/spec/pricecut/elements/h2_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H2 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("## Heading ##\n")
+      visitor.output.should eq("## Heading ##\n")
     end
   end
 end

data/spec/pricecut/elements/h3_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H3 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("### Heading ###\n")
+      visitor.output.should eq("### Heading ###\n")
     end
   end
 end

data/spec/pricecut/elements/h4_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H4 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("#### Heading ####\n")
+      visitor.output.should eq("#### Heading ####\n")
     end
   end
 end

data/spec/pricecut/elements/h5_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H5 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("##### Heading #####\n")
+      visitor.output.should eq("##### Heading #####\n")
     end
   end
 end

data/spec/pricecut/elements/h6_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::H6 do
 
   describe "#output!" do
     it "appends a Markdown header with newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("###### Heading ######\n")
+      visitor.output.should eq("###### Heading ######\n")
     end
   end
 end

data/spec/pricecut/elements/img_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::Img do
 
   describe "#output!" do
     it "appends a Markdown image to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("![Image](image.png)")
+      visitor.output.should eq("![Image](image.png)")
     end
   end
 end

data/spec/pricecut/elements/li_spec.rb

@@ -4,32 +4,27 @@ require "pricecut"
 describe Pricecut::Elements::Li do
   describe "#output" do
     let(:visitor) { Pricecut::MarkdownVisitor.new }
+    let(:root) { parse(%<<li>List item<li>>) }
 
     subject { described_class.new(visitor, root) }
 
     describe "when in an ordered list" do
-      let(:root) do
-        # We need to grab the first child to grab the <li>.
-        parse(%<<ol><li>Ordered List<li></ol>>).children.first
-      end
+      before { subject.stub(:ordered_list?) { true } }
 
       it "appends a Markdown ordered list item with newline to the output" do
         subject.output!
 
-        visitor.output.should eq("1.  Ordered List\n")
+        visitor.output.should eq("1.  List item\n")
       end
     end
 
     describe "when in an unordered list" do
-      let(:root) do
-        # We need to grab the first child to grab the <li>.
-        parse(%<<ul><li>Unordered List<li></ul>>).children.first
-      end
+      before { subject.stub(:ordered_list?) { false } }
 
-      it "appends a Markdown ordered list item with newline to the output" do
+      it "appends a Markdown unordered list item with newline to the output" do
         subject.output!
 
-        visitor.output.should eq("-  Unordered List\n")
+        visitor.output.should eq("-  List item\n")
       end
     end
   end

data/spec/pricecut/elements/ol_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::Ol do
 
   describe "#output!" do
     it "appends a newline wrapped list to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("\nOrdered List.\n")
+      visitor.output.should eq("\nOrdered List.\n")
     end
   end
 end

data/spec/pricecut/elements/p_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::P do
 
   describe "#output!" do
     it "appends the text and a newline to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("Paragraph.\n")
+      visitor.output.should eq("Paragraph.\n")
     end
   end
 end

data/spec/pricecut/elements/strong_spec.rb

@@ -12,9 +12,9 @@ describe Pricecut::Elements::Strong do
 
   describe "#output!" do
     it "appends a Markdown strong to the output" do
-       subject.output!
+      subject.output!
 
-       visitor.output.should eq("**Strong.**")
+      visitor.output.should eq("**Strong.**")
     end
   end
 end

data/spec/pricecut/elements/text_spec.rb

@@ -3,18 +3,71 @@ require "pricecut"
 
 describe Pricecut::Elements::Text do
   let(:visitor) { Pricecut::MarkdownVisitor.new }
-
-  let(:root) do
-    parse %<\n\nText.\n\n>
-  end
+  let(:root) { parse %<\n  This is  \n  text.\n  > }
 
   subject { described_class.new(visitor, root) }
 
   describe "#output!" do
-    it "appends the whitespace-stripped text to the output" do
-       subject.output!
+    describe "with only whitespace" do
+      before { subject.stub(:whitespace_only?) { true } }
+
+      it "does not append anything to the output" do
+        subject.output!
+
+        visitor.output.should be_empty
+      end
+    end
+
+    describe "with ample whitespace" do
+      before do
+        subject.stub(:previous_sibling?) { false }
+        subject.stub(:next_sibling?) { false }
+      end
+
+      it "removes insignificant whitespace and appends to the output" do
+        subject.output!
+
+        visitor.output.should eq("This is text.")
+      end
+    end
+
+    describe "preceded by an HTML tag" do
+      before do
+        subject.stub(:previous_sibling?) { true }
+        subject.stub(:next_sibling?) { false }
+      end
+
+      it "removes the subsequent whitespace and appends to the output" do
+        subject.output!
+
+        visitor.output.should eq(" This is text.")
+      end
+    end
+
+    describe "succeeded by an HTML tag" do
+      before do
+        subject.stub(:previous_sibling?) { false }
+        subject.stub(:next_sibling?) { true }
+      end
+
+      it "removes the preceding whitespace and appends to the output" do
+        subject.output!
+
+        visitor.output.should eq("This is text. ")
+      end
+    end
+
+    describe "succeeded and preceded by an HTML tag" do
+      before do
+        subject.stub(:previous_sibling?) { true }
+        subject.stub(:next_sibling?) { true }
+      end
+
+      it "leaves all whitespace and appends to the output" do
+        subject.output!
 
-       visitor.output.should eq("Text.")
+        visitor.output.should eq(" This is text. ")
+      end
     end
   end
 end

data/spec/pricecut/markdown_visitor_spec.rb

@@ -27,6 +27,11 @@ describe Pricecut::MarkdownVisitor do
         end
       end
 
+      after do
+        # Remove Test from the supported elements
+        Pricecut::Elements.send(:remove_const, "Test")
+      end
+
       it "writes the output of the element to output" do
         subject.visit(node)
 
@@ -35,10 +40,6 @@ describe Pricecut::MarkdownVisitor do
     end
 
     describe "with unsupported element" do
-      before do
-        # Remove Test from the supported elements
-        Pricecut::Elements.send(:remove_const, "Test")
-      end
       it "skips the unsupported element" do
         subject.visit(node)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pricecut
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-11 00:00:00.000000000 Z
+date: 2012-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70324877374400 !ruby/object:Gem::Requirement
+  requirement: &70333794231480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70324877374400
+  version_requirements: *70333794231480
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70333794231060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70333794231060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70324877373980 !ruby/object:Gem::Requirement
+  requirement: &70333794230640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70324877373980
+  version_requirements: *70333794230640
 description: Pricecut takes your HTML and marks it down.
 email:
 - adam@adamtanner.org
@@ -41,6 +52,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
@@ -98,7 +111,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2120063507989546998
+      hash: -1590595780056887565
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -107,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2120063507989546998
+      hash: -1590595780056887565
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.7