xommelier 0.1.2 → 0.1.3

data/README.md

@@ -4,15 +4,14 @@
 
 Xommelier is an XML Object Mapper. You could describe some namespace (e.g. Atom) in ruby DSL and use it for parsing XML to Ruby objects or for building XML from Ruby objects.
 
-Look into {Xommelier::Atom} and {Xommelier::Atom::Thread} module for implementation of http://www.w3.org/2005/Atom namespace and Atom Threading extension
+Look into {Xommelier::Atom}, {Xommelier::Atom::Threading}, and {Xommelier::Atom::History} module for implementation of http://www.w3.org/2005/Atom namespace, Atom Threading, and Feed Paging and Archiving extensions
 
 Xommelier is work in progress: [![Build Status](https://secure.travis-ci.org/alsemyonov/xommelier.png?branch=master)](http://travis-ci.org/alsemyonov/xommelier)
 
 ## Examples with Atom
 
 ```ruby
-require 'xommelier/atom'
-require 'xommelier/atom/thread'
+require 'xommelier/atom/full'
 ```
 
 ### Reading a feed
@@ -33,6 +32,7 @@ end
 feed = Xommelier::Atom::Feed.new
 feed.id = 'http://example.com/blog'
 feed.title = 'Example.com blog'
+feed.complete = Xommelier::Atom::History::Complete.new
 
 entry = feed.entry = Xommelier::Atom::Entry.new(
   id: 'http://example.com/blog/2012/03/05',
@@ -59,7 +59,7 @@ end
     title: ('Hooray! ' * (i + 1)).strip,
     updated: (5 - i).days.ago
   ).tap do |comment|
-    comment.in_reply_to = Xommelier::Atom::Thread::InReplyTo.new(
+    comment.in_reply_to = Xommelier::Atom::Threading::InReplyTo.new(
       ref: entry.id,
       href: entry.link.href
     )
@@ -73,9 +73,10 @@ will output:
 
 ```xml
 <?xml version="1.0" encoding="utf-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0">
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0" xmlns:fh="http://purl.org/syndication/history/1.0">
   <id>http://example.com/blog</id>
   <title>Example.com blog</title>
+  <fh:complete/>
   <entry>
     <id>http://example.com/blog/2012/03/05</id>
     <title>Happy Xommelier's day!</title>

data/examples/atom.rb

@@ -1,5 +1,5 @@
 require 'xommelier/atom'
-require 'xommelier/atom/thread'
+require 'xommelier/atom/threading'
 require 'active_support/core_ext'
 
 # Reading a feed
@@ -15,6 +15,7 @@ end
 feed = Xommelier::Atom::Feed.new
 feed.id = 'http://example.com/blog'
 feed.title = 'Example.com blog'
+feed.complete = Xommelier::Atom::History::Complete.new
 
 entry = feed.entry = Xommelier::Atom::Entry.new(
   id: 'http://example.com/blog/2012/03/05',
@@ -32,7 +33,7 @@ end
     title: ('Hooray! ' * (i + 1)).strip,
     updated: (5 - i).days.ago
   ).tap do |comment|
-    comment.in_reply_to = Xommelier::Atom::Thread::InReplyTo.new(ref: entry.id, href: entry.link.href)
+    comment.in_reply_to = Xommelier::Atom::Threading::InReplyTo.new(ref: entry.id, href: entry.link.href)
   end
 end
 

data/lib/xommelier/atom/entry.rb

@@ -3,6 +3,8 @@ require 'xommelier/atom'
 module Xommelier
   module Atom
     class Entry < Xml::Element
+      include LinksExtension
+
       root
 
       element :id, unique: true

data/lib/xommelier/atom/feed.rb

@@ -3,6 +3,8 @@ require 'xommelier/atom'
 module Xommelier
   module Atom
     class Feed < Xml::Element
+      include LinksExtension
+
       root
 
       element :id, unique: true

data/lib/xommelier/atom/full.rb

@@ -0,0 +1,3 @@
+require 'xommelier/atom'
+require 'xommelier/atom/threading'
+require 'xommelier/atom/history'

data/lib/xommelier/atom/history.rb

@@ -0,0 +1,31 @@
+require 'xommelier/atom'
+
+module Xommelier
+  module Atom
+    module History
+      include Xommelier::Xml
+
+      xmlns 'http://purl.org/syndication/history/1.0', as: :fh
+
+      class Complete < Xml::Element; end
+      class Archive < Xml::Element; end
+    end
+
+    class Feed
+      may do
+        element :complete, type: History::Complete
+        element :archive, type: History::Archive
+      end
+
+      alias complete? complete
+      alias archive? archive
+
+      %w(first last previous next
+         prev-archive next-archive current).each do |rel|
+        define_method(:"#{rel.underscore}_feed_url") do
+          links.find { |link| link.rel == rel && link.type == 'application/atom+xml' }.try(:href)
+        end
+      end
+    end
+  end
+end

data/lib/xommelier/atom/links_extension.rb

@@ -0,0 +1,15 @@
+require 'xommelier/atom'
+
+module Xommelier
+  module Atom
+    module LinksExtension
+      def feed_url
+        links.find { |link| link.rel == 'self' && link.type == 'application/atom+xml' }.try(:href)
+      end
+
+      def html_url
+        links.find { |link| link.rel == 'alternate' && link.type == 'text/html' }.try(:href)
+      end
+    end
+  end
+end

data/lib/xommelier/atom/{thread.rb → threading.rb}

@@ -2,7 +2,7 @@ require 'xommelier/atom'
 
 module Xommelier
   module Atom
-    module Thread
+    module Threading
       include Xommelier::Xml
 
       xmlns 'http://purl.org/syndication/thread/1.0', as: :thr
@@ -23,15 +23,19 @@ module Xommelier
     # Extends Atom elements
     class Entry
       may do
-        element :in_reply_to, type: Thread::InReplyTo, as: Thread::InReplyTo.element_name
-        element :total, type: Integer, ns: Thread.xmlns
+        element :in_reply_to, type: Threading::InReplyTo, as: Threading::InReplyTo.element_name
+        element :total, type: Integer, ns: Threading.xmlns
+      end
+
+      def replies_feed_url
+        links.find { |link| link.rel == 'replies' && link.type == 'application/atom+xml' }.try(:href)
       end
     end
 
     class Link
       may do
-        attribute :count, type: Integer, ns: Thread.xmlns
-        attribute :updated, type: Time, ns: Thread.xmlns
+        attribute :count,   type: Integer, ns: Threading.xmlns
+        attribute :updated, type: Time,    ns: Threading.xmlns
       end
     end
   end

data/lib/xommelier/atom.rb

@@ -16,7 +16,11 @@ module Xommelier
     autoload :Feed,      'xommelier/atom/feed'
     autoload :Entry,     'xommelier/atom/entry'
 
+    # Common extensions
+    autoload :LinksExtension, 'xommelier/atom/links_extension'
+
     # Extensions
-    autoload :Thread,    'xommelier/atom/thread'
+    autoload :Threading, 'xommelier/atom/threading'
+    autoload :History,   'xommelier/atom/history'
   end
 end

data/lib/xommelier/version.rb

@@ -1,3 +1,3 @@
 module Xommelier
-  VERSION = '0.1.2'
+  VERSION = '0.1.3'
 end

data/spec/fixtures/feed.atom.xml

@@ -1,11 +1,13 @@
 <?xml version="1.0" encoding="utf-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0">
+<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0" xmlns:fh="http://purl.org/syndication/history/1.0">
   <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
   <title type="text">Example Feed</title>
   <updated>2003-12-13T18:30:20Z</updated>
   <subtitle type="html">A &lt;em&gt;lot&lt;/em&gt; of effort went into making this effortless</subtitle>
   <link rel="alternate" type="text/html" href="http://example.ru/" />
   <link rel="self" type="application/atom+xml" href="http://example.ru/feed.atom" />
+  <link rel="next" type="application/atom+xml" href="http://example.ru/feed.atom?page=2" />
+  <fh:archive />
   <rights>© Mark Pilgrim, 2003</rights>
   <generator uri="http://example.com/" version="1.0">Example Toolkit</generator>
   <author>

data/spec/functional/atom_feed_parsing_spec.rb

@@ -1,7 +1,8 @@
 # coding: utf-8
 require 'spec_helper'
 require 'active_support/core_ext/numeric/time'
-require 'xommelier/atom/thread'
+require 'xommelier/atom/threading'
+require 'xommelier/atom/history'
 
 describe 'Atom feed' do
   describe 'parsing' do
@@ -11,13 +12,15 @@ describe 'Atom feed' do
     subject { feed }
 
     it { should be_kind_of(Xommelier::Atom::Feed) }
+    it { should respond_to(:complete?) }
+    it { should respond_to(:archive?) }
 
     its(:id)        { should == 'urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6' }
     its(:title)     { should == 'Example Feed' }
     its(:updated)   { should == Time.utc(2003, 12, 13, 18, 30, 20) }
     its(:subtitle)  { should == 'A <em>lot</em> of effort went into making this effortless' }
 
-    it { should have(2).links }
+    it { should have(3).links }
     its(:link) { should be_instance_of(Xommelier::Atom::Link) }
     it { feed.links[0].href.should == URI.parse('http://example.ru/') }
     it { feed.links[0].rel.should == 'alternate' }
@@ -25,7 +28,12 @@ describe 'Atom feed' do
     it { feed.links[1].href.should == URI.parse('http://example.ru/feed.atom') }
     it { feed.links[1].rel.should == 'self' }
     it { feed.links[1].type.should == 'application/atom+xml' }
+    its(:feed_url) { should == URI.parse('http://example.ru/feed.atom') }
+    its(:html_url) { should == URI.parse('http://example.ru/') }
+    its(:next_feed_url) { should == URI.parse('http://example.ru/feed.atom?page=2') }
 
+    its(:archive) { should be_true }
+    its(:complete) { should be_false }
     its(:rights) { should == '© Mark Pilgrim, 2003' }
     describe 'Generator' do
       subject { feed.generator }
@@ -65,6 +73,8 @@ describe 'Atom feed' do
       it { entry.links[2].type.should == 'application/atom+xml' }
       it { entry.links[2].count.should == 1 }
       it { entry.links[2].updated.should == Time.utc(2003, 12, 13, 18, 30, 20) }
+      its(:html_url) { should == URI.parse('http://example.ru/2003/12/13/atom03') }
+      its(:replies_feed_url) { should == URI.parse('http://example.ru/2003/12/13/atom03/comments.atom') }
 
       it { should have(1).authors }
 

data/spec/functional/atom_feed_thread_building_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'xommelier/atom/thread'
+require 'xommelier/atom/threading'
 
 describe 'Atom feed building' do
   let(:feed) do
@@ -23,7 +23,7 @@ describe 'Atom feed building' do
         title: 'Comment',
         updated: Time.utc(2003, 12, 13, 18, 30, 02)
       ).tap do |entry|
-        entry.in_reply_to = Xommelier::Atom::Thread::InReplyTo.new(ref: 'urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a')
+        entry.in_reply_to = Xommelier::Atom::Threading::InReplyTo.new(ref: 'urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a')
       end
     end
   end

data/spec/lib/xommelier_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
 
 describe Xommelier do
-  it { Xommelier::VERSION.should == '0.1.2' }
+  it { Xommelier::VERSION.should == '0.1.3' }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xommelier
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70220266503160 !ruby/object:Gem::Requirement
+  requirement: &70163686772120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220266503160
+  version_requirements: *70163686772120
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70220266502660 !ruby/object:Gem::Requirement
+  requirement: &70163686771620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220266502660
+  version_requirements: *70163686771620
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70220266502200 !ruby/object:Gem::Requirement
+  requirement: &70163686771160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70220266502200
+  version_requirements: *70163686771160
 description: XML-Object Mapper with many built-in XML formats supported
 email:
 - al@semyonov.us
@@ -68,11 +68,14 @@ files:
 - lib/xommelier/atom/category.rb
 - lib/xommelier/atom/entry.rb
 - lib/xommelier/atom/feed.rb
+- lib/xommelier/atom/full.rb
 - lib/xommelier/atom/generator.rb
+- lib/xommelier/atom/history.rb
 - lib/xommelier/atom/link.rb
+- lib/xommelier/atom/links_extension.rb
 - lib/xommelier/atom/person.rb
 - lib/xommelier/atom/source.rb
-- lib/xommelier/atom/thread.rb
+- lib/xommelier/atom/threading.rb
 - lib/xommelier/collection.rb
 - lib/xommelier/core_ext.rb
 - lib/xommelier/core_ext/boolean.rb