xommelier 0.1.19 → 0.1.20

data/Rakefile

@@ -5,7 +5,7 @@ begin
   YARD::Rake::YardocTask.new(:doc)
 rescue LoadError
   task :doc do
-    abort "YARD is not available. In order to run yardoc, you must: gem install yard"
+    abort 'YARD is not available. In order to run yardoc, you must: gem install yard'
   end
 end
 
@@ -14,7 +14,7 @@ begin
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
   task :spec do
-    abort "RSpec is not available. In order to run specs, you must: gem install rspec"
+    abort 'RSpec is not available. In order to run specs, you must: gem install rspec'
   end
 end
 

data/examples/atom.rb

@@ -7,8 +7,8 @@ feed = Xommelier::Atom::Feed.parse(open('spec/fixtures/feed.atom.xml'))
 puts feed.id, feed.title, feed.updated
 
 feed.entries do |entry|
-  puts feed.id, feed.title, feed.published, feed.updated
-  puts feed.content || feed.summary
+  puts entry.id, entry.title, entry.published, entry.updated
+  puts entry.content || entry.summary
 end
 
 # Building a feed
@@ -19,7 +19,7 @@ feed.complete = Xommelier::Atom::History::Complete.new
 
 entry = feed.entry = Xommelier::Atom::Entry.new(
   id: 'http://example.com/blog/2012/03/05',
-  title: "Happy Xommelier's day!",
+  title: 'Happy Xommelier\'s day!',
   updated: 5.days.ago
 ).tap do |entry|
   entry.link = Xommelier::Atom::Link.new(href: entry.id, rel: 'alternate', type: 'text/html')

data/lib/xommelier.rb

@@ -4,6 +4,8 @@ require 'xommelier/core_ext'
 module Xommelier
   autoload :Atom,       'xommelier/atom'
   autoload :OpenSearch, 'xommelier/open_search'
+  autoload :OPML, 'xommelier/opml'
+  autoload :RSS, 'xommelier/rss'
 
   # Standard Xommelier Error
   class Error < ::StandardError
@@ -15,6 +17,13 @@ module Xommelier
       super("Cannot validate #{object} because no schema provided for validation.")
     end
   end
+
+  # Typecasting error
+  class TypeError < Error
+    def initialize(object, type)
+      super("Cannot typecast #{object.inspect} to #{type}")
+    end
+  end
 end
 
 require 'xommelier/xml'

data/lib/xommelier/atom/links_extension.rb

@@ -4,11 +4,21 @@ module Xommelier
   module Atom
     module LinksExtension
       def feed_url
-        links.find { |link| link.rel == 'self' && link.type == 'application/atom+xml' }.try(:href)
+        detect_linked_href(rel: 'self', type: 'application/atom+xml')
       end
 
       def html_url
-        links.find { |link| link.rel == 'alternate' && link.type == 'text/html' }.try(:href)
+        detect_linked_href(rel: 'alternate', type: 'text/html')
+      end
+
+      protected
+
+      def detect_linked_href(attributes = {})
+        links.detect do |link|
+          attributes.inject(true) do |result, (attr, value)|
+            result && link.send(attr) == value
+          end
+        end.try(:href)
       end
     end
   end

data/lib/xommelier/atom/source.rb

@@ -4,10 +4,20 @@ module Xommelier
   module Atom
     class Source < Xml::Element
       may do
-        element :generator, :icon, :id, :logo, :rights, :subtitle, :title, :updated
+        element :generator
+        element :icon
+        element :id
+        element :logo
+        element :rights
+        element :subtitle
+        element :title
+        element :updated
       end
       any do
-        element :author, :category, :contributor, :link
+        element :author
+        element :category
+        element :contributor
+        element :link
       end
     end
   end

data/lib/xommelier/core_ext/boolean.rb

@@ -1,6 +1,7 @@
 require 'xommelier'
 
 class Boolean
+  #noinspection RubyStringKeysInHashInspection,RubyDuplicatedKeysInHashInspection
   BOOLEAN_MAP = {
     true => true, 'true' => true, 'TRUE' => true, '1' => true, '1.0' => true, 1 => true, 1.0 => true,
     false => false, 'false' => false, 'FALSE' => false, '0' => false, '0.0' => false, 0 => false, 0.0 => false, nil => false, '' => false

data/lib/xommelier/core_ext/float.rb

@@ -3,7 +3,7 @@ class Float
     return nil if value.blank?
     begin
       Float(value)
-    rescue ArgumentError => e
+    rescue ArgumentError
       value
     end
   end

data/lib/xommelier/core_ext/numeric.rb

@@ -3,7 +3,7 @@ class Numeric
     return nil if value.blank?
     begin
       value =~ /\./ ? Float(value) : Integer(value)
-    rescue ArgumentError => e
+    rescue ArgumentError
       value
     end
   end

data/lib/xommelier/core_ext/time.rb

@@ -2,7 +2,15 @@ require 'time'
 
 class Time
   def self.from_xommelier(value)
-    Time.xmlschema value
+    return if value == nil
+    case value
+    when String
+      Time.xmlschema(value)
+    when Time
+      value
+    else
+      raise Xommelier::TypeError.new(value, Time)
+    end
   end
 
   def to_xommelier

data/lib/xommelier/core_ext/uri.rb

@@ -9,10 +9,14 @@ end
 
 class Uri < String
   def self.from_xommelier(value)
-    if value.is_a?(URI::Generic)
+    return if value == nil
+    case value
+    when URI::Generic
       value
-    else
+    when String
       URI.parse(value)
+    else
+      raise Xommelier::TypeError.new(value, Uri)
     end
   end
 end

data/lib/xommelier/open_search.rb

@@ -8,10 +8,28 @@ module Xommelier
     include Xml
 
     xmlns 'http://a9.com/-/spec/opensearch/1.1/', as: :opensearch
+    schema
 
-    class Url < Xml::Element
-      element_name :Url
+    # @abstract
+    class Element < Xml::Element
+      def self.attribute(name, options = {})
+        options[:as] ||= name.to_s.camelcase(:lower)
+        super
+      end
+
+      def self.element(name, options = {})
+        options[:as] ||= name.to_s.camelcase(:upper)
+        super
+      end
 
+      class << self
+        def find_element_name
+          name.demodulize
+        end
+      end
+    end
+
+    class Url < Element
       attribute :template
       attribute :type
 
@@ -22,9 +40,7 @@ module Xommelier
       end
     end
 
-    class Image < Xml::Element
-      element_name :Image
-
+    class Image < Element
       may do
         attribute :height, type: Integer
         attribute :width, type: Integer
@@ -34,49 +50,46 @@ module Xommelier
       text type: Uri
     end
 
-    class Query < Xml::Element
-      element_name :Query
-
-      element :role#, type: Enum[:request, :example, :related, :correction, :subset, :superset]
+    class Query < Element
+      attribute :role#, type: Enum[:request, :example, :related, :correction, :subset, :superset]
 
       may do
-        element :title
-        element :total_results, type: Integer, as: 'totalResults'
-        element :search_terms, as: 'searchTerms', default: 'Xommelier'
-        element :count, type: Integer
-        element :start_index, type: Boolean, as: 'startIndex'
-        element :start_page, type: Boolean, as: 'startPage'
-        element :language
-        element :input_encoding, as: 'inputEncoding'
-        element :output_encoding, as: 'outputEncoding'
+        attribute :title
+        attribute :total_results, type: Integer
+        attribute :search_terms, default: 'Xommelier'
+        attribute :count, type: Integer
+        attribute :start_index, type: Boolean
+        attribute :start_page, type: Boolean
+        attribute :language
+        attribute :input_encoding
+        attribute :output_encoding
       end
     end
 
-    class Description < Xml::Element
-      element_name :OpenSearchDescription
+    class Description < Element
+      element_name 'OpenSearchDescription'
 
-      element :short_name, as: :ShortName
-      element :description, as: :Description
+      element :short_name
+      element :description
 
-      many do
-        element :url, type: Url, as: Url.element_name
-      end
+      element :url, type: Url, count: :many
+      element :query, type: Query, count: :any
 
       may do
-        element :tags,        as: :Tags
-        element :contacts,    as: :Contacts
-        element :long_name,   as: :LongName
-        element :developer,   as: :Developer
-        element :attribution, as: :Attribution
-        element :syndication_right, type: Symbol, as: :SyndicatioeRight, default: :open #, type: Enum[:open, :limited, :private, :closed]
-        element :adult_content, type: Boolean, as: :AdultContent
-        element :language, as: :Language, default: '*'
-        element :input_encoding, as: :InputEncoding, default: 'UTF-8'
-        element :output_encoding, as: :OutputEncoding, default: 'UTF-8'
+        element :tags
+        element :contact
+        element :long_name
+        element :developer
+        element :attribution
+        element :syndication_right, type: String, default: 'open' #, type: Enum[:open, :limited, :private, :closed]
+        element :adult_content, type: Boolean
+        element :language, default: '*'
+        element :input_encoding, default: 'UTF-8'
+        element :output_encoding, default: 'UTF-8'
       end
 
       any do
-        element :image, type: Image, as: Image.element_name
+        element :image, type: Image
       end
     end
   end
@@ -84,10 +97,12 @@ module Xommelier
   if defined?(Atom)
     module Atom
       class Feed
+        include LinksExtension
+
         may do
-          element :totalResults, type: Integer, ns: OpenSearch.xmlns
-          element :startIndex, type: Integer, ns: OpenSearch.xmlns
-          element :itemsPerPage, type: Integer, ns: OpenSearch.xmlns
+          element :total_results, type: Integer, ns: OpenSearch.xmlns, as: 'totalResults'
+          element :start_index, type: Integer, ns: OpenSearch.xmlns, as: 'startIndex'
+          element :items_per_page, type: Integer, ns: OpenSearch.xmlns, as: 'itemsPerPage'
         end
 
         any do
@@ -95,7 +110,7 @@ module Xommelier
         end
 
         def search_url
-          links.find { |link| link.rel == 'search' && link.type == MIME_TYPE }.try(:href)
+          detect_linked_href(rel: 'search', type: MIME_TYPE)
         end
       end
     end

data/lib/xommelier/rss.rb

@@ -6,9 +6,54 @@ module Xommelier
   module RSS
     include Xommelier::Xml
 
-    # TODO RSS Email simple type if needed
-    # class EmailAddress < String
-    # end
+    # The RECOMMENDED format for e-mail addresses in RSS elements is: username@hostname.tld (Real Name)
+    # http://www.rssboard.org/rss-profile#data-types-email
+    class EmailAddress < String
+      def self.from_xommelier(string)
+        email = new(string)
+        email.name?
+        email
+      end
+
+      def name?
+        @has_name ||= begin
+          address, name = strip.split(/\s+/, 2)
+
+          if name.present? && name =~ /\(([\w ]+)\)\s?/
+            replace(address)
+            @name = $1.to_s
+            true
+          else
+            false
+          end
+        end
+      end
+
+      def address
+        to_s
+      end
+
+      def address=(address)
+        replace(address)
+      end
+
+      def name
+        @name if name?
+      end
+
+      def name=(name)
+        @has_name = name.present?
+        @name = name
+      end
+
+      def to_xommelier
+        if name?
+          "#{address} (#{name})"
+        else
+          address
+        end
+      end
+    end
 
     class Element < Xml::Element
       def self.element(name, options = {})
@@ -125,7 +170,7 @@ module Xommelier
       element :link, type: Uri
 
       # Email address of the author of the item.
-      element :author#, type: EmailAddress
+      element :author, type: EmailAddress
 
       # Includes the item in one or more categories.
       element :category, type: Category, count: :any
@@ -164,10 +209,10 @@ module Xommelier
         element :copyright
 
         # Email address for person responsible for editorial content.
-        element :managing_editor#, type: EmailAddress
+        element :managing_editor, type: EmailAddress
 
         # Email address for person responsible for technical issues relating to channel.
-        element :web_master#, type: EmailAddress
+        element :web_master, type: EmailAddress
 
         # The publication date for the content in the channel.
         # All date-times in RSS conform to the Date and Time Specification of RFC 822, with the exception

data/lib/xommelier/rss/atomic.rb

@@ -0,0 +1,21 @@
+require 'xommelier/rss'
+require 'xommelier/atom'
+require 'xommelier/atom/history'
+
+module Xommelier
+  module RSS
+    class Channel
+      may do
+        element :id, ns: Atom.xmlns
+        element :complete, type: Atom::History::Complete
+        element :archive, type: Atom::History::Archive
+      end
+      element :atom_link, type: Atom::Link, count: :any
+    end
+
+    class Item
+      element :id, ns: Atom.xmlns, count: :may
+      element :atom_link, type: Atom::Link, count: :any
+    end
+  end
+end

data/lib/xommelier/schemas/dublincore/dc.xsd

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns="http://purl.org/dc/elements/1.1/"
+           targetNamespace="http://purl.org/dc/elements/1.1/"
+           elementFormDefault="qualified"
+           attributeFormDefault="unqualified">
+
+  <xs:annotation>
+    <xs:documentation xml:lang="en">
+      DCMES 1.1 XML Schema
+      XML Schema for http://purl.org/dc/elements/1.1/ namespace
+
+      Created 2008-02-11
+
+      Created by 
+
+      Tim Cole (t-cole3@uiuc.edu)
+      Tom Habing (thabing@uiuc.edu)
+      Jane Hunter (jane@dstc.edu.au)
+      Pete Johnston (p.johnston@ukoln.ac.uk),
+      Carl Lagoze (lagoze@cs.cornell.edu)
+
+      This schema declares XML elements for the 15 DC elements from the
+      http://purl.org/dc/elements/1.1/ namespace.
+
+      It defines a complexType SimpleLiteral which permits mixed content 
+      and makes the xml:lang attribute available. It disallows child elements by
+      use of minOcccurs/maxOccurs.
+
+      However, this complexType does permit the derivation of other complexTypes
+      which would permit child elements.
+
+      All elements are declared as substitutable for the abstract element any, 
+      which means that the default type for all elements is dc:SimpleLiteral.
+
+    </xs:documentation>
+
+  </xs:annotation>
+
+
+  <xs:import namespace="http://www.w3.org/XML/1998/namespace"
+             schemaLocation="http://www.w3.org/2001/03/xml.xsd">
+  </xs:import>
+
+  <xs:complexType name="SimpleLiteral">
+        <xs:annotation>
+        <xs:documentation xml:lang="en">
+            This is the default type for all of the DC elements.
+            It permits text content only with optional
+            xml:lang attribute.
+            Text is allowed because mixed="true", but sub-elements
+            are disallowed because minOccurs="0" and maxOccurs="0" 
+            are on the xs:any tag.
+
+    	    This complexType allows for restriction or extension permitting
+            child elements.
+    	</xs:documentation>
+  	</xs:annotation>
+
+   <xs:complexContent mixed="true">
+    <xs:restriction base="xs:anyType">
+     <xs:sequence>
+      <xs:any processContents="lax" minOccurs="0" maxOccurs="0"/>
+     </xs:sequence>
+     <xs:attribute ref="xml:lang" use="optional"/>
+    </xs:restriction>
+   </xs:complexContent>
+  </xs:complexType>
+
+  <xs:element name="any" type="SimpleLiteral" abstract="true"/>
+
+  <xs:element name="title" substitutionGroup="any"/>
+  <xs:element name="creator" substitutionGroup="any"/>
+  <xs:element name="subject" substitutionGroup="any"/>
+  <xs:element name="description" substitutionGroup="any"/>
+  <xs:element name="publisher" substitutionGroup="any"/>
+  <xs:element name="contributor" substitutionGroup="any"/>
+  <xs:element name="date" substitutionGroup="any"/>
+  <xs:element name="type" substitutionGroup="any"/>
+  <xs:element name="format" substitutionGroup="any"/>
+  <xs:element name="identifier" substitutionGroup="any"/>
+  <xs:element name="source" substitutionGroup="any"/>
+  <xs:element name="language" substitutionGroup="any"/>
+  <xs:element name="relation" substitutionGroup="any"/>
+  <xs:element name="coverage" substitutionGroup="any"/>
+  <xs:element name="rights" substitutionGroup="any"/>
+
+  <xs:group name="elementsGroup">
+  	<xs:annotation>
+    	<xs:documentation xml:lang="en">
+    	    This group is included as a convenience for schema authors
+            who need to refer to all the elements in the 
+            http://purl.org/dc/elements/1.1/ namespace.
+    	</xs:documentation>
+  	</xs:annotation>
+
+  <xs:sequence>
+    <xs:choice minOccurs="0" maxOccurs="unbounded">
+      <xs:element ref="any"/>
+    </xs:choice>
+    </xs:sequence>
+  </xs:group>
+
+  <xs:complexType name="elementContainer">
+  	<xs:annotation>
+    	<xs:documentation xml:lang="en">
+    		This complexType is included as a convenience for schema authors who need to define a root
+    		or container element for all of the DC elements.
+    	</xs:documentation>
+  	</xs:annotation>
+
+    <xs:choice>
+      <xs:group ref="elementsGroup"/>
+    </xs:choice>
+  </xs:complexType>
+
+
+</xs:schema>