Atom feed export

bin/prism

@@ -13,6 +13,7 @@
 ## If no SOURCE is given, prism will read from the Standard Input.
 ##
 ## Microformats:
+##    --atom,  --atom           hAtom => atom feed
 ##    --vcard, --hcard          hCard => vCard converter
 ##    --xfn                     Get XFN URLs
 ##
@@ -59,6 +60,7 @@ end
 options = {}
 ARGV.options do |option|
   option.banner = "Hi."
+  option.on('--atom','--atom') { options[:atom] = true }
   option.on('--hcard','--vcard') { options[:vcard] = true }
   option.on('--xfn') { options[:xfn] = true }
   option.on_tail('-h','--help') { puts usage ; exit }
@@ -73,11 +75,12 @@ end
 
 def uformat_counts(group)
   uf_count = Prism::Microformat.microformats.values.collect do |uformat|
-    name = "#{uformat::FRIENDLY_NAME}"
-    found = group.select {|format| format.is_a?(uformat) }.count
+    klass = Prism::Microformat.format_to_class(uformat)
+    name = "#{klass::FRIENDLY_NAME}"
+    found = group.select {|format| format.is_a?(klass) }.count
     if found > 0
       name += "s" if found > 1
-      "Found #{found} #{name} in the document. Read more at: #{uformat::WIKI_URL}"
+      "Found #{found} #{name} in the document. Read more at: #{klass::WIKI_URL}"
     end
   end.compact
   if !uf_count.empty?
@@ -107,7 +110,9 @@ end
 if options.empty?
   uformat_counts(Prism.find(input)).each {|count| puts count }
 else
-  if options[:vcard]
+  if options[:atom]
+    parse_microformats(input, :hatom) {|hatom| puts hatom.to_atom }
+  elsif options[:vcard]
     parse_microformats(input, :hcard) {|hcard| puts hcard.to_vcard }
   elsif options[:xfn]
     parse_microformats(input, :xfn) {|xfn| puts xfn.url }

lib/prism.rb

@@ -137,3 +137,4 @@ def parse_first(document)
 require 'prism/pattern'
 require 'prism/posh'
 require 'prism/microformat'
+require 'prism/builder'

lib/prism/builder.rb

@@ -0,0 +1 @@
+require 'prism/builder/atom_builder'

lib/prism/builder/atom_builder.rb

@@ -0,0 +1,109 @@
+require 'forwardable'
+
+module Prism
+  module Builder
+    class AtomBuilder
+      public
+
+      def add_hatom(hatom)
+        self.hatom = hatom
+      end
+
+     def build
+        self.builder = Nokogiri::XML::Builder.new(:encoding => 'utf-8') do |xml|
+          xml.feed('xmlns' => 'http://www.w3.org/2005/Atom') do
+            entries.each do |hentry|
+              build_entry xml, hentry
+            end
+          end
+        end
+        self
+      end
+
+     def to_s
+        builder.to_xml
+      end
+
+      private
+
+      attr_accessor :builder, :hatom
+
+      def entries
+        if hatom
+          hatom.hentry || []
+        else
+          []
+        end
+      end
+
+      class EntryDelgator
+        extend Forwardable
+
+        attr_reader :hentry
+
+        def_delegator :hentry, :entry_title, :title
+        def_delegator :hentry, :entry_summary, :summary
+
+        def initialize(hentry)
+          @hentry = hentry
+        end
+
+        def fields
+          [:title, :updated, :published, :summary]
+        end
+
+        def updated
+          hentry.updated.iso8601 if hentry.updated
+        end
+
+        def published
+          hentry.published.iso8601 if hentry.published
+        end
+      end
+
+      class AuthorDelegator
+        extend Forwardable
+
+        attr_reader :author
+
+        def_delegator :author, :fn, :name
+        def_delegator :author, :email
+
+        def initialize(author)
+          @author = author
+        end
+
+        def fields
+          [:name, :uri, :email]
+        end
+
+        def uri
+          author.url.first if author.url
+        end
+      end
+
+      def build_entry(xml, hentry)
+        entry = EntryDelgator.new(hentry)
+        xml.entry do
+          entry.fields.each do |field|
+            xml.send(field, entry.send(field)) if entry.send(field)
+          end
+          if hentry.entry_content
+            xml.content(:type => "html") do
+              xml.text hentry.entry_content
+            end
+          end
+          if hentry.author
+            author = AuthorDelegator.new(hentry.author)
+            xml.author do
+              author.fields.each do |field|
+                xml.send(field, author.send(field)) if author.send(field)
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

lib/prism/microformat/hatom.rb

@@ -27,7 +27,16 @@ class HAtom < POSH
       end
 
       has_many :hentry do
-        has_one :entry_title, :entry_summary
+        has_one :entry_title do
+          search do |node|
+            entry_title = node.css(".entry-title")
+            if entry_title.empty?
+              entry_title = node.css("h1,h2,h3,h4,h5,h6")
+            end
+            entry_title
+          end
+        end
+        has_one :entry_summary
 
         has_one :updated, :published do
           extract :typevalue
@@ -65,6 +74,10 @@ class HAtom < POSH
         required!
       end
 
+      def to_atom
+        Prism::Builder::AtomBuilder.new(self).build.to_s
+      end
+
     end
   end
 end

test/builder/atom_builder_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(File.absolute_path(__FILE__)),'..','test_helper')
+
+class AtomBuilderTest < Test::Unit::TestCase
+  @@klass = Prism::Builder::AtomBuilder
+
+  setup do
+    @atom = @@klass.new
+    @doc = test_fixture('hatom/example1.html')
+    @hatom = Prism::Microformat::HAtom.parse(@doc)
+  end
+
+  def parse_atom
+    @atom.build
+    @xml_doc = Nokogiri::XML(@atom.to_s){ |config| config.strict }
+  end
+
+  should "create an empty atom feed" do
+    parse_atom
+    assert_not_equal "", @xml_doc.xpath('/xmlns:feed').to_s
+  end
+
+  should "create a feed" do
+    @atom.add_hatom(@hatom)
+    parse_atom
+    assert_equal "Wiki Attack", @xml_doc.xpath('/xmlns:feed/xmlns:entry[1]/xmlns:title').text
+    assert_equal "2005-10-10T21:07:00+00:00", @xml_doc.xpath('/xmlns:feed/xmlns:entry[1]/xmlns:published').text
+    assert_equal "We had a bit of trouble with ...", @xml_doc.xpath('/xmlns:feed/xmlns:entry[1]/xmlns:summary').text
+    assert_equal "Ryan King", @xml_doc.xpath('/xmlns:feed/xmlns:entry[1]/xmlns:author/xmlns:name').text
+    assert_equal "http://theryanking.com/", @xml_doc.xpath('/xmlns:feed/xmlns:entry[1]/xmlns:author/xmlns:uri').text
+  end
+
+end
+

test/fixtures/test-fixture/hatom/example1.atom.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<feed xmlns="http://www.w3.org/2005/Atom">
+  <entry>
+    <title>Wiki Attack</title>
+    <published>2005-10-10T14:07:00-07:00</published>
+    <summary>We had a bit of trouble with ...</summary>
+    <content type="html">&lt;p class="entry-summary"&gt;We had a bit of trouble with ...&lt;/p&gt;
+     &lt;p&gt;We've restored the wiki and ...&lt;/p&gt;
+     &lt;p&gt;If anyone is working to combat said spammers ...&lt;/p&gt;</content>
+    <author>
+      <name>Ryan King</name>
+      <uri>http://theryanking.com/</uri>
+    </author>
+  </entry>
+  <entry/>
+</feed>

test/fixtures/test-fixture/hatom/example1.html

@@ -7,7 +7,7 @@ <h3 class="entry-title">
      <a href="http://www.microformats.org/blog/..." rel="bookmark" title="...">Wiki Attack</a>
     </h3>
     <div class="entry-content">
-     <p>We had a bit of trouble with ...</p>
+     <p class="entry-summary">We had a bit of trouble with ...</p>
      <p>We've restored the wiki and ...</p>
      <p>If anyone is working to combat said spammers ...</p>
     </div>
@@ -34,6 +34,7 @@ <h4 class="tags">Technorati Tags:</h4>
    </div>
 
    <div class="hentry entry" id="post-59">
+     <h3>Another title</h3>
    </div>
   </div>
  </div>

test/microformat/hatom_test.rb

@@ -18,16 +18,26 @@ def self.before_all
       assert_equal "Wiki Attack", hentry[0].entry_title
     end
 
+    test 'The title will fall back to h# tag' do
+      hentry = @hatom.hentry
+      assert_equal "Another title", hentry[1].entry_title
+    end
+
     test 'The content contains html' do
       hentry = @hatom.hentry
       content = <<-EOS
-     <p>We had a bit of trouble with ...</p>
+     <p class="entry-summary">We had a bit of trouble with ...</p>
      <p>We've restored the wiki and ...</p>
      <p>If anyone is working to combat said spammers ...</p>
       EOS
       assert_equal content.strip, hentry[0].entry_content
     end
 
+    test 'The summary is a singular value' do
+      hentry = @hatom.hentry
+      assert_equal 'We had a bit of trouble with ...', hentry[0].entry_summary
+    end
+
     test 'The published is a time' do
       hentry = @hatom.hentry
       assert_equal Time.parse('2005-10-10 14:07:00 -0700'), hentry[0].published

test/test_helper.rb

@@ -36,3 +36,5 @@ def test_fixture(filename)
   html = get_fixture('test-fixture/' + filename)
   doc = Nokogiri::HTML.parse(html).css('#uf').first
 end
+
+ENV['TZ'] = 'UTC' # set UTC as timezone for tests