xommelier 0.1.16 → 0.1.18

data/lib/xommelier/xml/element/structure/property.rb

@@ -0,0 +1,136 @@
+module Xommelier
+  module Xml
+    class Element
+      module Structure
+        class Property
+          def initialize(name, options)
+            @name = name
+            @options = self.class.const_get(:DEFAULTS).merge(options)
+          end
+
+          attr_reader :name, :options
+
+          def writer
+            @writer ||= "#{name}="
+          end
+
+          # @return [Xommelier::Xml::Namespace]
+          def ns
+            options[:ns]
+          end
+
+          def default
+            options[:default]
+          end
+
+          # @return [Class]
+          def type
+            options[:type]
+          end
+
+          # @return [true, false] has default value?
+          def default?
+            options.key?(:default) && required?
+          end
+
+          def inspect
+            "#<Xommelier::X::E::S::#{self.class.name.demodulize}:0x#{object_id.to_s(16)} #{instance_variables.map { |ivar| "#{ivar}=#{instance_variable_get(ivar).inspect}"}.join(' ')}>"
+          end
+
+          protected
+
+          def overrides
+            @overrides ||= {}
+          end
+        end
+
+        class Element < Property
+          DEFAULTS = {
+            type: String,
+            count: :one
+          }
+
+          def node_type
+            :element
+          end
+
+          def element_name
+            @element_name ||= options.delete(:as) { name }.to_s
+          end
+
+          def serializable_element_name
+            @serializable_element_name ||= if %w(class id text).include?(element_name)
+                                             element_name + '_'
+                                           else
+                                             element_name
+                                           end
+          end
+
+          def required?
+            options[:count] == :one || options[:count] == :many
+          end
+
+          def multiple?
+            return overrides[:multiple] if overrides.key?(:multiple)
+            options[:count] == :many || options[:count] == :any
+          end
+
+          def plural
+            @plural ||= name.to_s.pluralize.to_sym
+          end
+
+          def plural_writer
+            @plural_writer ||= "#{plural}="
+          end
+
+          def numbers_equal?
+            plural == name
+          end
+
+          def overridden_xmlns
+            overrides[:xmlns]
+          end
+
+          def override(overrides)
+            @overrides = overrides
+            yield
+            @overrides = {}
+          end
+        end
+
+        class Attribute < Property
+          DEFAULTS = {
+            type: String,
+            required: false
+          }
+
+          def node_type
+            :attribute
+          end
+
+          def required?
+            options[:required]
+          end
+
+          def attribute_name
+            @attribute_name ||= options.delete(:as) { name }.to_s
+          end
+        end
+
+        class Text < Property
+          DEFAULTS = {
+            type: String
+          }
+
+          def node_type
+            :text
+          end
+
+          def required?
+            options[:required]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/xommelier/xml/namespace.rb

@@ -81,8 +81,12 @@ module Xommelier
         {as.to_s => uri.to_s}
       end
 
+      def attribute_name
+        default? ? 'xmlns' : "xmlns:#{as}"
+      end
+
       def inspect
-        %(xmlns:#{as}="#{uri}")
+        %(#{attribute_name}="#{uri}")
       end
     end
   end

data/spec/fixtures/feed.rss2.0.xml

@@ -0,0 +1,41 @@
+<?xml version="1.0"?>
+<rss version="2.0">
+   <channel>
+      <title>Liftoff News</title>
+      <link>http://liftoff.msfc.nasa.gov/</link>
+      <description>Liftoff to Space Exploration.</description>
+      <language>en-us</language>
+      <pubDate>Tue, 10 Jun 2003 04:00:00 GMT</pubDate>
+      <lastBuildDate>Tue, 10 Jun 2003 09:41:01 GMT</lastBuildDate>
+      <docs>http://blogs.law.harvard.edu/tech/rss</docs>
+      <generator>Weblog Editor 2.0</generator>
+      <managingEditor>editor@example.com</managingEditor>
+      <webMaster>webmaster@example.com</webMaster>
+      <item>
+         <title>Star City</title>
+         <link>http://liftoff.msfc.nasa.gov/news/2003/news-starcity.asp</link>
+         <description>How do Americans get ready to work with Russians aboard the International Space Station? They take a crash course in culture, language and protocol at Russia's &lt;a href="http://howe.iki.rssi.ru/GCTC/gctc_e.htm"&gt;Star City&lt;/a&gt;.</description>
+         <pubDate>Tue, 03 Jun 2003 09:39:21 GMT</pubDate>
+         <guid>http://liftoff.msfc.nasa.gov/2003/06/03.html#item573</guid>
+      </item>
+      <item>
+         <description>Sky watchers in Europe, Asia, and parts of Alaska and Canada will experience a &lt;a href="http://science.nasa.gov/headlines/y2003/30may_solareclipse.htm"&gt;partial eclipse of the Sun&lt;/a&gt; on Saturday, May 31st.</description>
+         <pubDate>Fri, 30 May 2003 11:06:42 GMT</pubDate>
+         <guid>http://liftoff.msfc.nasa.gov/2003/05/30.html#item572</guid>
+      </item>
+      <item>
+         <title>The Engine That Does More</title>
+         <link>http://liftoff.msfc.nasa.gov/news/2003/news-VASIMR.asp</link>
+         <description>Before man travels to Mars, NASA hopes to design new engines that will let us fly through the Solar System more quickly.  The proposed VASIMR engine would do that.</description>
+         <pubDate>Tue, 27 May 2003 08:37:32 GMT</pubDate>
+         <guid>http://liftoff.msfc.nasa.gov/2003/05/27.html#item571</guid>
+      </item>
+      <item>
+         <title>Astronauts' Dirty Laundry</title>
+         <link>http://liftoff.msfc.nasa.gov/news/2003/news-laundry.asp</link>
+         <description>Compared to earlier spacecraft, the International Space Station has many luxuries, but laundry facilities are not one of them.  Instead, astronauts have other options.</description>
+         <pubDate>Tue, 20 May 2003 08:56:02 GMT</pubDate>
+         <guid>http://liftoff.msfc.nasa.gov/2003/05/20.html#item570</guid>
+      </item>
+   </channel>
+</rss>

data/spec/fixtures/rss-2.0-namespace.xml

@@ -0,0 +1,78 @@
+<rss version="2.0"
+  xmlns:creativeCommons="http://backend.userland.com/creativeCommonsRssModule"
+  xmlns:trackback="http://madskills.com/public/xml/rss/module/trackback/">
+  <channel>
+    <creativeCommons:license>http://www.creativecommons.org/licenses/by-nd/1.0</creativeCommons:license>
+    <description>Current headlines from the Dallas Times-Herald newspaper</description>
+    <link>http://dallas.example.com</link>
+    <title>Dallas Times-Herald</title>
+    <category>Media</category>
+    <category domain="Newspapers/Regional/United_States">Texas</category>
+    <cloud domain="server.example.com" path="/rpc" port="80" protocol="xml-rpc" registerProcedure="cloud.notify" />
+    <copyright>Copyright 2006 Dallas Times-Herald</copyright>
+    <docs>http://www.rssboard.org/rss-specification</docs>
+    <generator>Radio UserLand v8.2.1</generator>
+    <image>
+      <link>http://dallas.example.com</link>
+      <title>Dallas Times-Herald</title>
+      <url>http://dallas.example.com/masthead.gif</url>
+      <description>Read the Dallas Times-Herald</description>
+      <height>32</height>
+      <width>96</width>
+    </image>
+    <language>epo</language>
+    <lastBuildDate>Sun, 29 Jan 2006 17:17:44 GMT</lastBuildDate>
+    <managingEditor>jlehrer@dallas.example.com (Jim Lehrer)</managingEditor>
+    <pubDate>Sun, 29 Jan 2006 05:00:00 GMT</pubDate>
+    <rating>(PICS-1.1 "http://www.rsac.org/ratingsv01.html" l by "webmaster@example.com" on "2006.01.29T10:09-0800" r (n 0 s 0 v 0 l 0))</rating>
+    <skipDays>
+      <day>Saturday</day>
+      <day>Sunday</day>
+    </skipDays>
+    <skipHours>
+      <hour>0</hour>
+      <hour>1</hour>
+      <hour>2</hour>
+      <hour>22</hour>
+      <hour>23</hour>
+    </skipHours>
+    <textInput>
+      <description>Your aggregator supports the textInput element. What software are you using?</description>
+      <link>http://www.cadenhead.org/textinput.php</link>
+      <name>query</name>
+      <title>TextInput Inquiry</title>
+    </textInput>
+    <ttl>60</ttl>
+    <webMaster>helpdesk@dallas.example.com</webMaster>
+    <item>
+      <trackback:ping>http://dallas.example.com/trackback/tb.php?id=1991/05/02/nolan.htm</trackback:ping>
+      <title>Seventh Heaven! Ryan Hurls Another No Hitter</title>
+      <link>http://dallas.example.com/1991/05/02/nolan.htm</link>
+      <description>Texas Rangers pitcher Nolan Ryan hurled the seventh no-hitter of his legendary career on Arlington Appreciation Night, defeating the Toronto Blue Jays 3-0. The 44-year-old struck out 16 batters before a crowd of 33,439.</description>
+      <guid>http://dallas.example.com/1991/05/02/nolan.htm</guid>
+    </item>
+    <item>
+      <trackback:ping>http://dallas.example.com/trackback/tb.php?id=1983/06/joebob.htm</trackback:ping>
+      <author>jbb@dallas.example.com (Joe Bob Briggs)</author>
+      <category>rec.arts.movies.reviews</category>
+      <comments>http://dallas.example.com/feedback/1983/06/joebob.htm</comments>
+      <description>I'm headed for France. I wasn't gonna go this year, but then last week "Valley Girl" came out and I said to myself, Joe Bob, you gotta get out of the country for a while.</description>
+      <enclosure length="24986239" type="audio/mpeg" url="http://dallas.example.com/joebob_050689.mp3" />
+      <guid>http://dallas.example.com/1983/05/06/joebob.htm</guid>
+      <link>http://dallas.example.com/1983/05/06/joebob.htm</link>
+      <pubDate>Fri, 06 May 1983 09:00:00 CST</pubDate>
+      <source url="http://la.example.com/rss.xml">Los Angeles Herald-Examiner</source>
+      <title>Joe Bob Goes to the Drive-In</title>
+    </item>
+    <item>
+      <trackback:ping>http://dallas.example.com/trackback/tb.php?id=1983/06/joebob2.htm</trackback:ping>
+      <trackback:about>http://www.imdb.com/title/tt0086525/</trackback:about>
+      <description>I'm headed for France. I wasn't gonna go this year, but then last week &lt;a href="http://www.imdb.com/title/tt0086525/"&gt;Valley Girl&lt;/a&gt; came out and I said to myself, Joe Bob, you gotta get out of the country for a while.</description>
+      <guid isPermaLink="false">tag:dallas.example.com,4131:news</guid>
+    </item>
+    <item>
+      <description><![CDATA[I'm headed for France. I wasn't gonna go this year, but then last week <a href="http://www.imdb.com/title/tt0086525/">Valley Girl</a> came out and I said to myself, Joe Bob, you gotta get out of the country for a while.]]></description>
+      <guid isPermaLink="false">1983-05-06+lifestyle+joebob+2</guid>
+    </item>    
+  </channel>
+</rss>

data/spec/fixtures/simple_feed.rss.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<rss version="2.0">
+  <channel>
+    <title>Example Feed</title>
+    <link>http://example.com</link>
+    <managingEditor>john.doe@example.com</managingEditor>
+    <pubDate>Tue, 10 Jun 2003 04:00:00 -0000</pubDate>
+    <lastBuildDate>Sat, 13 Dec 2003 18:30:02 -0000</lastBuildDate>
+    <item>
+      <guid>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</guid>
+      <title>RSS-Powered Robots Run Amok</title>
+      <description>Some text.</description>
+      <link>http://example.org/2003/12/13/atom03</link>
+      <pubDate>Sat, 13 Dec 2003 18:30:02 -0000</pubDate>
+    </item>
+  </channel>
+</rss>

data/spec/functional/atom_feed_building_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'Atom feed building' do
-  let(:feed) do
+  subject(:feed) do
     Xommelier::Atom::Feed.new.tap do |feed|
       feed.id = 'urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6'
       feed.title = 'Example Feed'
@@ -19,21 +19,13 @@ describe 'Atom feed building' do
     end
   end
 
-  let(:built_xml)  { feed.to_xml }
-  let(:parsed_xml) { Nokogiri::XML(built_xml) }
+  let(:parsed_xml) { Nokogiri::XML(feed.to_xml) }
   let(:rng)        { Nokogiri::XML::RelaxNG(load_xml_file('atom.rng')) }
-  let(:xsd)        { Nokogiri::XML::Schema(load_xml_file('atom.xsd')) }
+  let(:xsd)        { Xommelier::Atom.schema }
 
-  subject { built_xml }
+  it { should be_valid }
 
-  it { feed.should be_valid }
-
-  it { should == load_xml_file('simple_feed.atom').read }
-  it do
-    rng.validate(parsed_xml).each do |error|
-      pp error
-    end
-  end
+  its(:to_xml) { should == load_xml_file('simple_feed.atom') }
   it('should conform to RelaxNG schema') { rng.valid?(parsed_xml).should == true }
   it('should conform to XML Schema') { xsd.valid?(parsed_xml).should == true }
 end

data/spec/functional/atom_feed_thread_building_spec.rb

@@ -35,6 +35,6 @@ describe 'Atom feed building' do
 
   subject { built_xml }
 
-  it { should == load_xml_file('multi_namespace_feed.atom').read }
+  it { should == load_xml_file('multi_namespace_feed.atom') }
   it('should conform to RelaxNG schema') { rng.valid?(parsed_xml).should == true }
 end

data/spec/functional/build_nested_document_from_hash_spec.rb

@@ -26,7 +26,7 @@ describe 'Build document from nested hash' do
 
   subject { doc }
 
-  its(:to_xml) { should == load_xml_file('nested_atom').read }
+  its(:to_xml) { should == load_xml_file('nested_atom') }
   it { should have(1).authors }
   it { should have(3).contributors }
   it { should have(3).entries }

data/spec/functional/rss_feed_building_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'RSS feed building' do
+  subject(:rss) do
+    Xommelier::RSS::Rss.new(
+      channel: {
+        title: 'Example Feed',
+        link: 'http://example.com',
+        pub_date: Time.utc(2003, 6, 10, 04),
+        last_build_date: Time.utc(2003, 12, 13, 18, 30, 02),
+        managing_editor: 'john.doe@example.com',
+        items: [{
+          title: 'RSS-Powered Robots Run Amok',
+          guid: 'urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a',
+          pub_date: Time.utc(2003, 12, 13, 18, 30, 02),
+          description: 'Some text.',
+          link: 'http://example.org/2003/12/13/atom03'
+        }]
+      }
+    )
+  end
+
+  it { should be_valid }
+  its(:to_xml) { should == load_xml_file('simple_feed.rss') }
+end

data/spec/functional/rss_feed_parsing_spec.rb

@@ -0,0 +1,41 @@
+# coding: utf-8
+require 'spec_helper'
+require 'active_support/core_ext/numeric/time'
+require 'xommelier/rss'
+
+describe 'RSS feed' do
+  describe 'parsing' do
+    let(:rss_xml) { load_xml_file('feed.rss2.0') }
+    let(:feed) { Xommelier::RSS::Rss.parse(rss_xml) }
+
+    subject { feed }
+
+    it { should be_kind_of(Xommelier::RSS::Rss) }
+
+    its(:title) { should == 'Liftoff News' }
+    its(:last_build_date) { should == Time.utc(2003, 6, 10, 9, 41, 01) }
+    its(:pub_date) { should == Time.utc(2003, 6, 10, 04) }
+    its(:description) { should == 'Liftoff to Space Exploration.' }
+    its(:link) { should == URI.parse('http://liftoff.msfc.nasa.gov/') }
+    its(:docs) { should == 'http://blogs.law.harvard.edu/tech/rss' }
+    its(:description) { should == 'Liftoff to Space Exploration.' }
+    its(:generator) { should == 'Weblog Editor 2.0' }
+    its(:managing_editor) { should == 'editor@example.com' }
+    its(:web_master) { should == 'webmaster@example.com' }
+
+    it { feed.should have(4).items }
+    describe 'Item' do
+      let(:item) { feed.items[0] }
+      subject { item }
+
+      its(:guid) { should be_an Xommelier::RSS::Guid }
+      its('guid.text') { should == 'http://liftoff.msfc.nasa.gov/2003/06/03.html#item573' }
+      its('guid.to_s') { should == 'http://liftoff.msfc.nasa.gov/2003/06/03.html#item573' }
+      its(:guid) { should == 'http://liftoff.msfc.nasa.gov/2003/06/03.html#item573' }
+      its(:title) { should == 'Star City' }
+      its(:pub_date) { should == Time.utc(2003, 6, 3, 9, 39, 21) }
+      its(:description) { should == 'How do Americans get ready to work with Russians aboard the International Space Station? They take a crash course in culture, language and protocol at Russia\'s <a href="http://howe.iki.rssi.ru/GCTC/gctc_e.htm">Star City</a>.' }
+      its(:link) { should == URI.parse('http://liftoff.msfc.nasa.gov/news/2003/news-starcity.asp') }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ Dir[File.join(SPEC_ROOT, 'spec/support/**/*.rb')].each {|f| require f}
 
 ATOM_XMLNS = 'http://www.w3.org/2005/Atom'
 
+#noinspection RubyResolve
 RSpec.configure do |config|
   config.mock_with :rspec
   config.order = 'random'

data/spec/support/fixtures.rb

@@ -1,3 +1,3 @@
 def load_xml_file(file_name)
-  open(File.join(SPEC_ROOT, 'spec', 'fixtures', "#{file_name}.xml"))
+  open(File.join(SPEC_ROOT, 'spec', 'fixtures', "#{file_name}.xml")).read
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xommelier
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.18
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-08 00:00:00.000000000 Z
+date: 2013-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -93,6 +93,7 @@ files:
 - lib/xommelier/atom/source.rb
 - lib/xommelier/atom/threading.rb
 - lib/xommelier/collection.rb
+- lib/xommelier/common.rb
 - lib/xommelier/core_ext.rb
 - lib/xommelier/core_ext/boolean.rb
 - lib/xommelier/core_ext/date.rb
@@ -103,23 +104,31 @@ files:
 - lib/xommelier/core_ext/time.rb
 - lib/xommelier/core_ext/uri.rb
 - lib/xommelier/open_search.rb
+- lib/xommelier/opml.rb
+- lib/xommelier/rss.rb
 - lib/xommelier/schemas/atom.xsd
+- lib/xommelier/schemas/rss.xsd
 - lib/xommelier/version.rb
 - lib/xommelier/xml.rb
 - lib/xommelier/xml/element.rb
 - lib/xommelier/xml/element/serialization.rb
 - lib/xommelier/xml/element/structure.rb
+- lib/xommelier/xml/element/structure/property.rb
 - lib/xommelier/xml/namespace.rb
 - spec/fixtures/atom.rng.xml
-- spec/fixtures/atom.xsd.xml
 - spec/fixtures/feed.atom.xml
+- spec/fixtures/feed.rss2.0.xml
 - spec/fixtures/multi_namespace_feed.atom.xml
 - spec/fixtures/nested_atom.xml
+- spec/fixtures/rss-2.0-namespace.xml
 - spec/fixtures/simple_feed.atom.xml
+- spec/fixtures/simple_feed.rss.xml
 - spec/functional/atom_feed_building_spec.rb
 - spec/functional/atom_feed_parsing_spec.rb
 - spec/functional/atom_feed_thread_building_spec.rb
 - spec/functional/build_nested_document_from_hash_spec.rb
+- spec/functional/rss_feed_building_spec.rb
+- spec/functional/rss_feed_parsing_spec.rb
 - spec/lib/xommelier/atom/entry_spec.rb
 - spec/lib/xommelier/xml/element/serialization_spec.rb
 - spec/lib/xommelier/xml/element/structure_spec.rb
@@ -156,15 +165,19 @@ specification_version: 3
 summary: Xommelier is an XML Sommelier
 test_files:
 - spec/fixtures/atom.rng.xml
-- spec/fixtures/atom.xsd.xml
 - spec/fixtures/feed.atom.xml
+- spec/fixtures/feed.rss2.0.xml
 - spec/fixtures/multi_namespace_feed.atom.xml
 - spec/fixtures/nested_atom.xml
+- spec/fixtures/rss-2.0-namespace.xml
 - spec/fixtures/simple_feed.atom.xml
+- spec/fixtures/simple_feed.rss.xml
 - spec/functional/atom_feed_building_spec.rb
 - spec/functional/atom_feed_parsing_spec.rb
 - spec/functional/atom_feed_thread_building_spec.rb
 - spec/functional/build_nested_document_from_hash_spec.rb
+- spec/functional/rss_feed_building_spec.rb
+- spec/functional/rss_feed_parsing_spec.rb
 - spec/lib/xommelier/atom/entry_spec.rb
 - spec/lib/xommelier/xml/element/serialization_spec.rb
 - spec/lib/xommelier/xml/element/structure_spec.rb