xommelier 0.1.7 → 0.1.8

data/README.md

@@ -173,6 +173,12 @@ will output
 </feed>
 ```
 
+## Built in XML namespaces:
+
+1. {Xommelier::Atom} - http://www.w3.org/2005/Atom
+2. {Xommelier::Atom::Threading} - http://purl.org/syndication/thread/1.0
+3. {Xommelier::Atom::History} - http://purl.org/syndication/history/1.0
+4. {Xommelier::OpenSearch} - http://a9.com/-/spec/opensearch/1.1/
 
 ## TODO
 

data/lib/xommelier/atom/history.rb

@@ -2,6 +2,8 @@ require 'xommelier/atom'
 
 module Xommelier
   module Atom
+    # Implements Feed Paging and Archiving
+    # See RFC 5005 {http://tools.ietf.org/html/rfc5005.html}
     module History
       include Xommelier::Xml
 

data/lib/xommelier/atom/threading.rb

@@ -2,6 +2,8 @@ require 'xommelier/atom'
 
 module Xommelier
   module Atom
+    # Implments Atom Threading Extensions
+    # See RFC 4685 {http://tools.ietf.org/html/rfc4685.html}
     module Threading
       include Xommelier::Xml
 

data/lib/xommelier/atom.rb

@@ -1,6 +1,8 @@
 require 'xommelier/xml'
 
 module Xommelier
+  # Implements The Atom Syndication Format
+  # See RFC 4287 {http://tools.ietf.org/html/rfc4287.html}
   module Atom
     include Xommelier::Xml
 

data/lib/xommelier/open_search.rb

@@ -0,0 +1,103 @@
+require 'xommelier'
+
+module Xommelier
+  # Implements http://www.opensearch.org/Specifications/OpenSearch/1.1#Url_rel_values
+  module OpenSearch
+    MIME_TYPE = 'application/opensearchdescription+xml'
+
+    include Xml
+
+    xmlns 'http://a9.com/-/spec/opensearch/1.1/', as: :opensearch
+
+    class Url < Xml::Element
+      element_name :Url
+
+      attribute :template
+      attribute :type
+
+      may do
+        attribute :rel, default: 'results' # may be results, suggestions, self, collection
+        attribute :index_offset,  type: Integer, default: 1
+        attribute :page_offset,   type: Integer, default: 1
+      end
+    end
+
+    class Image < Xml::Element
+      element_name :Image
+
+      may do
+        attribute :height, type: Integer
+        attribute :width, type: Integer
+        attribute :type
+      end
+
+      text type: Uri
+    end
+
+    class Query < Xml::Element
+      element_name :Query
+
+      element :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'
+      end
+    end
+
+    class Description < Xml::Element
+      element_name :OpenSearchDescription
+
+      element :short_name, as: :ShortName
+      element :description, as: :Description
+
+      many do
+        element :url, type: Url, as: Url.element_name
+      end
+
+      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'
+      end
+
+      any do
+        element :image, type: Image, as: Image.element_name
+      end
+    end
+  end
+
+  if defined?(Atom)
+    module Atom
+      class Feed
+        may do
+          element :totalResults, type: Integer, ns: OpenSearch.xmlns
+          element :startIndex, type: Integer, ns: OpenSearch.xmlns
+          element :itemsPerPage, type: Integer, ns: OpenSearch.xmlns
+        end
+
+        any do
+          element :query, type: OpenSearch::Query, as: OpenSearch::Query.element_name
+        end
+
+        def search_url
+          links.find { |link| link.rel == 'search' && link.type == MIME_TYPE }.try(:href)
+        end
+      end
+    end
+  end
+end

data/lib/xommelier/version.rb

@@ -1,3 +1,3 @@
 module Xommelier
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

data/lib/xommelier/xml/class_methods.rb

@@ -1,4 +1,5 @@
 require 'xommelier/xml'
+require 'xommelier/xml/namespace'
 
 module Xommelier
   module Xml

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

@@ -1,4 +1,5 @@
 require 'xommelier/xml/element'
+require 'active_support/concern'
 require 'active_support/core_ext/module/delegation'
 require 'active_support/core_ext/object/with_options'
 require 'active_support/core_ext/object/try'

data/lib/xommelier/xml/namespace.rb

@@ -1,4 +1,6 @@
 require 'xommelier/xml'
+require 'xommelier/collection'
+require 'xommelier/xml/element'
 require 'active_support/core_ext/array/extract_options'
 
 module Xommelier

data/lib/xommelier/xml.rb

@@ -12,9 +12,6 @@ module Xommelier
       instance_variable_set :@_xmlns, nil
     end
 
-    autoload :Namespace,  'xommelier/xml/namespace'
-    autoload :Element,    'xommelier/xml/element'
-
     extend ClassMethods
     xmlns DEFAULT_NS, as: :xml
 

data/lib/xommelier.rb

@@ -2,8 +2,8 @@ require 'xommelier/version'
 require 'xommelier/core_ext'
 
 module Xommelier
-  autoload :Collection, 'xommelier/collection'
-
-  autoload :Xml,        'xommelier/xml'
   autoload :Atom,       'xommelier/atom'
+  autoload :OpenSearch, 'xommelier/open_search'
 end
+
+require 'xommelier/xml'

data/spec/lib/xommelier_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xommelier
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-10 00:00:00.000000000 Z
+date: 2012-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70339564926600 !ruby/object:Gem::Requirement
+  requirement: &70191338259060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70339564926600
+  version_requirements: *70191338259060
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70339564925760 !ruby/object:Gem::Requirement
+  requirement: &70191338258000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70339564925760
+  version_requirements: *70191338258000
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70339564940960 !ruby/object:Gem::Requirement
+  requirement: &70191338257020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,7 +43,7 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70339564940960
+  version_requirements: *70191338257020
 description: XML-Object Mapper with many built-in XML formats supported
 email:
 - al@semyonov.us
@@ -86,6 +86,7 @@ files:
 - lib/xommelier/core_ext/symbol.rb
 - lib/xommelier/core_ext/time.rb
 - lib/xommelier/core_ext/uri.rb
+- lib/xommelier/open_search.rb
 - lib/xommelier/version.rb
 - lib/xommelier/xml.rb
 - lib/xommelier/xml/class_methods.rb