xommelier 0.0.1 → 0.0.2

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+/doc

data/.rspec

@@ -1 +1,3 @@
 --colour
+-Ilib
+-Ispec

data/Gemfile

@@ -10,6 +10,8 @@ group :development, :test do
   gem 'guard'
   gem 'guard-rspec'
   gem 'guard-bundler'
+  gem 'ruby_gntp'
+  gem 'rb-fsevent'
 end
 
 group :development do
@@ -21,3 +23,7 @@ group :development do
   gem 'ripl-rails',        require: 'ripl/rails'
   gem 'ripl-rocket',       require: 'ripl/rocket'
 end
+
+group :documentation do
+  gem 'yard'
+end

data/README.md

@@ -0,0 +1,19 @@
+# Xommelier is an XML Sommelier
+
+## Overview
+
+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} module for implementation of http://www.w3.org/2005/Atom namespace
+
+Xommelier is work in progress.
+
+## Examples
+
+You can see example code in examples/ folder.
+
+## Future tasks
+
+* Implementation that support more than one namespace in XML class
+* Converting XML Schema, RelaxNG, RelaxNG Compact and DTD into Xommelier Ruby DSL
+* ActiveRecord-like automatic loading of XML Schema, RelaxNG, RelaxNG Compact and DTD without needing to write it down into ruby code

data/Rakefile

@@ -1 +1,21 @@
 require 'bundler/gem_tasks'
+
+begin
+  require 'yard'
+  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"
+  end
+end
+
+begin
+  require 'rspec/core/rake_task'
+  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"
+  end
+end
+
+task default: :spec

data/Termfile

@@ -0,0 +1,38 @@
+# IDE for rails application development
+
+#setup 'bundle'
+
+def title(title)
+  run "echo -e \"\\033];#{title}\\007\""
+end
+
+title 'Editor'
+run 'vim Gemfile'
+
+tab(:bash) do
+  title('Shell')
+end
+#tab(:log) do
+  #title 'Logs'
+  #run 'tail -f log/development.log'
+#end
+tab :guard do
+  title 'Guard'
+  run 'guard'
+end
+tab(:console) do
+  title 'Console'
+  run './console'
+end
+
+#window do
+  #tab "echo 'first tab'", "echo 'of window'"
+  #tab "named tab", :settings => "Ocean" do
+    #run "echo 'named tab'"
+    #run "ls"
+  #end
+#end
+
+#window "autotest" do
+  #tab "echo 'window and tab without options'"
+#end

data/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'xommelier'
+require 'ripl'
+require 'pp'
+
+Ripl.start

data/examples/atom.rb

@@ -1,11 +1,11 @@
 require 'xommelier/atom'
-require 'open-uri'
+require 'active_support/core_ext'
 
 # Reading a feed
-feed = Xommelier::Atom::Feed.parse(open('http://example.com/blog.atom'))
+feed = Xommelier::Atom::Feed.parse(open('spec/fixtures/feed.atom'))
 puts feed.id, feed.title, feed.updated
 
-feed.each(:entry) do |entry|
+feed.entries do |entry|
   puts feed.id, feed.title, feed.published, feed.updated
   puts feed.content || feed.summary
 end
@@ -21,7 +21,7 @@ feed.title = 'Example.com blog'
   entry.title = "Example.com blog entry #{i}"
   entry.updated = (5 - i).days.ago
 
-  feed << entry
+  feed.entries << entry
 end
 
 puts feed.to_xml

data/lib/xommelier/atom/category.rb

@@ -6,7 +6,7 @@ module Xommelier
       attribute :term
 
       may do
-        attribute :scheme, type: URI
+        attribute :scheme, type: Uri
         attribute :label
       end
     end

data/lib/xommelier/atom/entry.rb

@@ -21,7 +21,7 @@ module Xommelier
         element :author,      type: Person
         element :category,    type: Category
         element :contributor, type: Person
-        element :link
+        element :link,        type: Link
       end
     end
   end

data/lib/xommelier/atom/generator.rb

@@ -4,7 +4,7 @@ module Xommelier
   module Atom
     class Generator < Xml::Element
       may do
-        attribute :uri, type: URI
+        attribute :uri, type: Uri
         attribute :version
       end
     end

data/lib/xommelier/atom/link.rb

@@ -3,7 +3,7 @@ require 'xommelier/atom'
 module Xommelier
   module Atom
     class Link < Xml::Element
-      attribute :href, type: URI
+      attribute :href, type: Uri
 
       may do
         attribute :rel#, type: Enum(:alternate, :related, :self, :enclosure, :via)

data/lib/xommelier/atom/person.rb

@@ -7,7 +7,7 @@ module Xommelier
 
       may do
         element :email
-        element :uri, type: URI
+        element :uri, type: Uri
       end
     end
   end

data/lib/xommelier/atom/thread.rb

@@ -0,0 +1,38 @@
+require 'xommelier/atom'
+
+module Xommelier
+  module Atom
+    module Thread
+      include Xommelier::Xml
+
+      xmlns 'http://purl.org/syndication/thread/1.0', as: :thr
+
+      class InReplyTo < Xml::Element
+        element_name 'in-reply-to'
+        #method_name :in_reply_to
+
+        attribute :href
+
+        may do
+          attribute :href, type: Uri
+          attribute :type, type: String
+          attribute :source
+        end
+      end
+    end
+
+    # Extends Atom elements
+    class Entry
+      may do
+        element :in_reply_to, ns: Thread.xmlns
+        element :total, type: Integer, ns: Thread.xmlns
+      end
+    end
+
+    class Link
+      may do
+        attribute :count, type: Integer, ns: Thread.xmlns
+      end
+    end
+  end
+end

data/lib/xommelier/atom.rb

@@ -5,7 +5,9 @@ module Xommelier
     include Xommelier::Xml
 
     xmlns 'http://www.w3.org/2005/Atom', as: :atom
+    #roots :Feed, :Entry
 
+    # Elements
     autoload :Link,      'xommelier/atom/link'
     autoload :Person,    'xommelier/atom/person'
     autoload :Category,  'xommelier/atom/category'
@@ -14,25 +16,7 @@ module Xommelier
     autoload :Feed,      'xommelier/atom/feed'
     autoload :Entry,     'xommelier/atom/entry'
 
-    #namespace 'http://purl.org/syndication/thread/1.0', as: :thr do
-      #element :in_reply_to, as: 'in-reply-to' do
-        #attribute :ref
-
-        #may do
-          #attribute :href, type: Uri
-          #attribute :type, type: String
-          #attribute :source
-        #end
-      #end
-
-      #ns.atom.element :entry do
-        #element :in_reply_to, ns: ns.thr
-        #element :total, type: Integer, ns: ns.thr
-      #end
-
-      #ns.atom.element :link, values: [:replies] do
-        #ns.thr.attribute :count, type: Integer
-      #end
-    #end
+    # Extensions
+    autoload :Thread,    'xommelier/atom/thread'
   end
 end

data/lib/xommelier/core_ext/{integer.rb → numeric.rb}

@@ -1,4 +1,4 @@
-class Integer
+class Numeric
   def self.from_xommelier(value)
     return nil if value.blank?
     begin

data/lib/xommelier/core_ext/symbol.rb

@@ -0,0 +1,9 @@
+class Symbol
+  def self.from_xommelier(value)
+    value.to_sym
+  end
+
+  def to_xommelier
+    to_s
+  end
+end

data/lib/xommelier/core_ext/uri.rb

@@ -1,12 +1,18 @@
+require 'xommelier/core_ext/string'
 require 'uri'
 
 class URI::Generic
-  def self.from_xommelier(value)
-    URI.parse value
-  end
-
   def to_xommelier
     to_s
   end
 end
-Uri = String
+
+class Uri < String
+  def self.from_xommelier(value)
+    if value.is_a?(URI::Generic)
+      value
+    else
+      URI.parse(value)
+    end
+  end
+end

data/lib/xommelier/core_ext.rb

@@ -3,7 +3,8 @@ require 'xommelier'
 require 'xommelier/core_ext/boolean'
 require 'xommelier/core_ext/date'
 require 'xommelier/core_ext/float'
-require 'xommelier/core_ext/integer'
+require 'xommelier/core_ext/numeric'
 require 'xommelier/core_ext/string'
+require 'xommelier/core_ext/symbol'
 require 'xommelier/core_ext/time'
 require 'xommelier/core_ext/uri'

data/lib/xommelier/version.rb

@@ -1,3 +1,3 @@
 module Xommelier
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/xommelier/xml/class_methods.rb

@@ -10,6 +10,7 @@ module Xommelier
       # Defines namespace used in formats
       def xmlns(uri = nil, options = {}, &block)
         if uri
+          options[:module] ||= self
           instance_variable_set :@_xmlns, Xommelier::Xml::Namespace.new(uri, options, &block)
         end
         instance_variable_get :@_xmlns

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

@@ -0,0 +1,148 @@
+require 'xommelier/xml/element'
+require 'active_support/concern'
+require 'nokogiri'
+
+module Xommelier
+  module Xml
+    class Element
+      module Serialization
+        extend ActiveSupport::Concern
+
+        SERIALIZATION_OPTIONS = {
+          encoding: 'utf-8'
+        }
+
+        module ClassMethods
+          def from_xml(xml, options = {})
+            new.tap do |doc|
+              doc.options = options
+              doc.from_xml(xml, options)
+            end
+          end
+          alias_method :parse, :from_xml
+          alias_method :from_xommelier, :from_xml
+
+          def element_xpath(xmldoc = nil, name = nil)
+            "#{xmlns_xpath(xmldoc)}:#{name || element_name}"
+          end
+
+          def xmlns_xpath(xml_document = nil)
+            if xml_document
+              xml_document.namespaces.key(xmlns.uri)
+            else
+              xmlns.as
+            end
+          end
+        end
+
+        def from_xml(xml, options = {})
+          case xml
+          when IO, String
+            xml = Nokogiri::XML(xml)
+          end
+          @_xml_node = options.delete(:node) { xml.at_xpath(element_xpath(xml.document, element_name)) }
+
+          if text? && @_xml_node.text?
+            self.text = @_xml_node.text
+          end
+
+          self.class.attributes.each do |name, options|
+            send(name, @_xml_node[name])
+          end
+
+          self.class.elements.each do |name, options|
+            deserialize_element(name, options)
+          end
+        end
+        alias_method :from_xommelier, :from_xml
+
+        def to_xml(options = {})
+          options = SERIALIZATION_OPTIONS.merge(options)
+          element_name = options.delete(:element_name) { self.element_name }
+          if options[:builder] # Non-root element
+            builder = options.delete(:builder)
+            attribute_values = {}
+          else # Root element
+            builder = Nokogiri::XML::Builder.new(options)
+            attribute_values = {xmlns: xmlns.to_s}
+          end
+          attributes.each do |name, value|
+            serialize_attribute(name, value, attribute_values)
+          end
+          builder.send(element_name, attribute_values) do |xml|
+            elements.each do |name, value|
+              serialize_element(name, value, xml)
+            end
+            if respond_to?(:text)
+              xml.text @text
+            end
+          end
+          builder.to_xml
+        end
+        alias_method :to_xommelier, :to_xml
+
+        protected
+
+        def element_xpath(xmldoc = self.xml_document, name = nil)
+          self.class.element_xpath(xmldoc, name)
+        end
+
+        def xml_document
+          @_xml_node.document
+        end
+
+        def xmlns_xpath(xml_document = self.xml_document)
+          self.class.xmlns_xpath(xml_document)
+        end
+
+        def serialize_attribute(name, value, attributes)
+          attributes[name] = value.to_xommelier
+        end
+
+        def deserialize_element(name, options = nil)
+          options ||= self.element_options(name)
+          type = options[:type]
+          xpath = if type < Xommelier::Xml::Element
+                    type.element_xpath(xml_document, name)
+                  else
+                    element_xpath(xml_document, name)
+                  end
+          nodes = @_xml_node.xpath("./#{xpath}")
+          if nodes.any?
+            case options[:count]
+            when :any, :many
+              children = nodes.map { |node| typecast_element(type, node, options) }
+              send options[:plural], children
+            else
+              send(name, typecast_element(type, nodes[0], options))
+            end
+          end
+        end
+
+        def typecast_element(type, node, options)
+          if type < Xommelier::Xml::Element
+            type.from_xommelier(xml_document, options.merge(node: node))
+          else
+            type.from_xommelier(node.text)
+          end
+        end
+
+        def serialize_element(name, value, xml, options = nil)
+          options ||= self.element_options(name)
+          case options[:count]
+          when :any, :many
+            single_element = options.merge(count: :one)
+            value.each { |item| serialize_element(name, item, xml, single_element) }
+          else
+            case value
+            when Xommelier::Xml::Element
+              value.to_xommelier(builder: xml, element_name: name)
+            else
+              xml.send(name) { xml.text value.to_xommelier }
+            end
+          end
+        end
+      end
+    end
+  end
+end