xml-smart 0.3.0

data/lib/xml/XSDtoRNG.xsl

@@ -0,0 +1,448 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright or © or Copr. Nicolas Debeissat
+
+nicolas.debeissat@gmail.com (http://debeissat.nicolas.free.fr/)
+
+This software is a computer program whose purpose is to convert a
+XSD schema into a RelaxNG schema.
+
+This software is governed by the CeCILL license under French law and
+abiding by the rules of distribution of free software.  You can  use, 
+modify and/ or redistribute the software under the terms of the CeCILL
+license as circulated by CEA, CNRS and INRIA at the following URL
+"http://www.cecill.info". 
+
+As a counterpart to the access to the source code and  rights to copy,
+modify and redistribute granted by the license, users are provided only
+with a limited warranty  and the software's author,  the holder of the
+economic rights,  and the successive licensors  have only  limited
+liability. 
+
+In this respect, the user's attention is drawn to the risks associated
+with loading,  using,  modifying and/or developing or reproducing the
+software by the user in light of its specific status of free software,
+that may mean  that it is complicated to manipulate,  and  that  also
+therefore means  that it is reserved for developers  and  experienced
+professionals having in-depth computer knowledge. Users are therefore
+encouraged to load and test the software's suitability as regards their
+requirements in conditions enabling the security of their systems and/or 
+data to be ensured and,  more generally, to use and operate it in the 
+same conditions as regards security. 
+
+The fact that you are presently reading this means that you have had
+knowledge of the CeCILL license and that you accept its terms.
+
+-->
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:rng="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" exclude-result-prefixes="xs" version="1.0">
+	
+	<xsl:output indent="yes" method="xml"/>
+	
+	<xsl:preserve-space elements="*"/>
+	
+	<xsl:template match="/xs:schema">
+		<rng:grammar>
+			<xsl:for-each select="namespace::*">
+				<xsl:if test="local-name() != 'xs'">
+					<xsl:copy/>
+				</xsl:if>
+			</xsl:for-each>
+			<xsl:attribute name="ns"><xsl:value-of select="@targetNamespace"/></xsl:attribute>
+			<xsl:attribute name="datatypeLibrary">http://www.w3.org/2001/XMLSchema-datatypes</xsl:attribute>
+			<xsl:apply-templates/>
+		</rng:grammar>
+	</xsl:template>
+	
+	<!-- in order to manage occurrences (and defaut) attributes goes there
+		 before going to mode="content" templates -->
+	<xsl:template match="xs:*">
+		<xsl:call-template name="occurrences"/>
+	</xsl:template>
+	
+	<xsl:template match="comment()">
+		<xsl:copy/>
+	</xsl:template>
+	
+	<!-- unique and key are not supported in RelaxNG, must be done in schematron -->
+	<xsl:template match="xs:unique|xs:key"/>
+	
+	<xsl:template match="xs:annotation">
+		<a:documentation>
+			<xsl:apply-templates/>
+		</a:documentation>
+	</xsl:template>
+	
+	<xsl:template match="xs:documentation">
+		<xsl:copy-of select="child::node()"/>
+	</xsl:template>
+	
+	<xsl:template match="xs:appinfo">
+		<xsl:copy-of select="child::node()"/>
+	</xsl:template>
+	
+	<xsl:template match="xs:union">
+		<rng:choice>
+			<xsl:apply-templates select="@memberTypes"/>
+			<xsl:apply-templates/>
+		</rng:choice>
+	</xsl:template>
+	
+	<xsl:template match="@memberTypes">
+		<xsl:call-template name="declareMemberTypes">
+			<xsl:with-param name="memberTypes" select="."/>
+		</xsl:call-template>
+	</xsl:template>
+	
+	<xsl:template match="xs:list">
+		<rng:list>
+			<xsl:apply-templates select="@itemType"/>
+			<xsl:apply-templates/>
+		</rng:list>
+	</xsl:template>
+	
+	<xsl:template match="@itemType">
+		<xsl:call-template name="type">
+			<xsl:with-param name="type" select="."/>
+		</xsl:call-template>
+	</xsl:template>
+	
+	<xsl:template match="xs:complexType[@name]|xs:simpleType[@name]|xs:group[@name]|xs:attributeGroup[@name]">
+		<!-- the schemas may be included several times, so it needs a combine attribute
+                                     (the attributes are inversed :-) at the transformation) -->
+		<rng:define name="{@name}">
+			<!-- work-around for empty issue -->
+			<xsl:choose>
+				<xsl:when test="not(*[local-name() != 'annotation'])">
+					<rng:empty/>
+					<xsl:apply-templates/>
+				</xsl:when>
+				<xsl:otherwise>
+					<xsl:apply-templates/>
+				</xsl:otherwise>
+			</xsl:choose>
+		</rng:define>
+	</xsl:template>
+	
+	<!-- when finds a ref attribute replace it by its type call (ref name="" or type) -->	
+	<xsl:template match="xs:*[@ref]" mode="content">
+		<!-- when finds a attribute declaraction with a ref attribute replace it by
+		its type call prefixed by attr_ -->
+		<xsl:choose>
+			<xsl:when test="local-name() = 'attribute'">
+				<xsl:variable name="type">
+					<xsl:choose>
+						<xsl:when test="contains(@ref, ':')">
+							<xsl:value-of select="concat('attr_', substring-after(@ref, ':'))"/>
+						</xsl:when>
+						<xsl:otherwise>
+							<xsl:value-of select="concat('attr_', @ref)"/>
+						</xsl:otherwise>
+					</xsl:choose>
+				</xsl:variable>
+				<xsl:call-template name="type">
+					<xsl:with-param name="type" select="$type"/>
+				</xsl:call-template>
+			</xsl:when>
+			<xsl:otherwise>
+				<xsl:call-template name="type">
+					<xsl:with-param name="type" select="@ref"/>
+				</xsl:call-template>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+	
+    <!-- the <xs:simpleType> and <xs:complexType without name attribute are ignored -->
+	<xsl:template match="xs:sequence|xs:simpleContent|xs:complexContent|xs:simpleType|xs:complexType">
+		<xsl:apply-templates/>
+	</xsl:template>
+	
+	<xsl:template match="xs:extension[@base]">
+		<xsl:call-template name="type">
+			<xsl:with-param name="type" select="@base"/>
+		</xsl:call-template>
+	</xsl:template>
+    
+	<xsl:template match="xs:element[@name]">
+		<!-- case of root element -->
+		<xsl:choose>
+			<xsl:when test="parent::xs:schema">
+				<rng:start combine="choice">
+					<!-- must introduce prefix in order not to override a complextype of the same name -->
+					<rng:ref name="starting_{@name}"/>
+				</rng:start>
+				<rng:define name="starting_{@name}">
+					<xsl:apply-templates select="current()" mode="content"/>
+				</rng:define>
+			</xsl:when>
+			<xsl:otherwise>
+				<xsl:call-template name="occurrences"/>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+    
+	<xsl:template match="xs:restriction[@base]">
+		<xsl:choose>
+			<xsl:when test="xs:enumeration[@value]">
+				<rng:choice>
+					<xsl:apply-templates/>
+				</rng:choice>
+			</xsl:when>
+			<xsl:otherwise>
+				<xsl:call-template name="type">
+					<xsl:with-param name="type" select="@base"/>
+				</xsl:call-template>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+	
+	<xsl:template match="xs:enumeration[@value]">
+		<rng:value>
+			<xsl:value-of select="@value"/>
+		</rng:value>
+		<xsl:apply-templates/>
+	</xsl:template>
+	
+    <!--
+ support for fractionDigits, length, maxExclusive, maxInclusive, maxLength, minExclusive, minInclusive, minLength, pattern, totalDigits, whiteSpace
+explicit removal of enumeration as not all the XSLT processor respect templates priority
+ -->
+	<xsl:template match="xs:*[not(self::xs:enumeration)][@value]">
+		<rng:param name="{local-name()}">
+			<xsl:value-of select="@value"/>
+		</rng:param>
+	</xsl:template>
+	
+	<xsl:template match="xs:all">
+		<rng:interleave>
+			<xsl:for-each select="child::text()[normalize-space(.) != ''] | child::*">
+				<rng:optional>
+					<xsl:apply-templates select="current()"/>
+				</rng:optional>
+			</xsl:for-each>
+		</rng:interleave>
+	</xsl:template>
+	
+	<xsl:template match="xs:import|xs:include|xs:redefine">
+		<rng:include>
+			<xsl:if test="@schemaLocation">
+				<xsl:attribute name="href"><xsl:value-of select="concat(substring-before(@schemaLocation, '.xsd'),'.rng')"/></xsl:attribute>
+			</xsl:if>
+			<xsl:if test="@namespace">
+				<xsl:attribute name="ns"><xsl:value-of select="@namespace"/></xsl:attribute>
+			</xsl:if>
+			<xsl:apply-templates/>
+		</rng:include>
+	</xsl:template>
+    
+	<xsl:template match="@default">
+		<a:documentation>
+            default value is : <xsl:value-of select="."/>
+		</a:documentation>
+	</xsl:template>
+    
+    <xsl:template match="xs:attribute[@name]">
+    	<xsl:choose>
+    		<!-- attributes specified at schema level -->
+    		<xsl:when test="parent::xs:schema">
+	    		<rng:define name="attr_{@name}">
+					<xsl:apply-templates select="current()" mode="occurrences"/>
+				</rng:define>
+    		</xsl:when>
+    		<xsl:otherwise>
+    			<xsl:apply-templates select="current()" mode="occurrences"/>
+    		</xsl:otherwise>
+    	</xsl:choose>
+    </xsl:template>
+	
+	<xsl:template match="xs:attribute[@name]" mode="occurrences">
+		<xsl:choose>
+			<xsl:when test="@use and @use='prohibited'"/>
+			<xsl:when test="@use and @use='required'">
+				<xsl:apply-templates select="current()" mode="content"/>
+			</xsl:when>
+			<!-- by default, attributes are optional -->
+			<xsl:otherwise>
+				<rng:optional>
+					<xsl:apply-templates select="current()" mode="content"/>
+				</rng:optional>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+    
+	<xsl:template match="xs:attribute[@name]" mode="content">
+		<rng:attribute name="{@name}">
+			<xsl:apply-templates select="@default" mode="attributeDefaultValue"/>
+			<!-- there can be no type attribute to <xs:attribute>, in this case, the type is defined in 
+                                    a <xs:simpleType> or a <xs:complexType> inside -->
+			<xsl:choose>
+				<xsl:when test="@type">
+					<xsl:call-template name="type">
+						<xsl:with-param name="type" select="@type"/>
+					</xsl:call-template>
+				</xsl:when>
+				<xsl:otherwise>
+					<xsl:apply-templates/>
+				</xsl:otherwise>
+			</xsl:choose>
+		</rng:attribute>
+	</xsl:template>
+	
+	<xsl:template match="@default" mode="attributeDefaultValue">
+    	<xsl:attribute name="defaultValue" namespace="http://relaxng.org/ns/compatibility/annotations/1.0">
+    		<xsl:value-of select="."/>
+    	</xsl:attribute>
+	</xsl:template>
+	
+	<xsl:template match="xs:any" mode="content">
+		<rng:element>
+			<rng:anyName/>
+			<rng:text/>
+		</rng:element>
+	</xsl:template>
+	
+	<xsl:template match="xs:anyAttribute" mode="content">
+		<rng:attribute>
+			<rng:anyName/>
+			<rng:text/>
+		</rng:attribute>
+	</xsl:template>
+	
+	<xsl:template match="xs:choice" mode="content">
+		<rng:choice>
+			<xsl:apply-templates/>
+		</rng:choice>
+	</xsl:template>
+	
+	<xsl:template match="xs:element" mode="content">
+		<rng:element name="{@name}">
+			<xsl:choose>
+				<xsl:when test="@type">
+					<xsl:call-template name="type">
+						<xsl:with-param name="type" select="@type"/>
+					</xsl:call-template>
+				</xsl:when>
+				<!-- work-around for empty issue -->
+				<xsl:when test="not(*[local-name() != 'annotation']) and not(@type)">
+					<rng:empty/>
+					<xsl:apply-templates/>
+				</xsl:when>
+				<xsl:otherwise>
+					<xsl:apply-templates/>
+				</xsl:otherwise>
+			</xsl:choose>
+		</rng:element>
+	</xsl:template>
+	
+	<xsl:template name="occurrences">
+		<xsl:apply-templates select="@default"/>
+		<xsl:choose>
+			<xsl:when test="@maxOccurs and @maxOccurs='unbounded'">
+				<xsl:choose>
+					<xsl:when test="@minOccurs and @minOccurs='0'">
+						<rng:zeroOrMore>
+							<xsl:apply-templates select="current()" mode="content"/>
+						</rng:zeroOrMore>
+					</xsl:when>
+					<xsl:otherwise>
+						<rng:oneOrMore>
+							<xsl:apply-templates select="current()" mode="content"/>
+						</rng:oneOrMore>
+					</xsl:otherwise>
+				</xsl:choose>
+			</xsl:when>
+			<xsl:when test="@minOccurs and @minOccurs='0'">
+				<rng:optional>
+					<xsl:apply-templates select="current()" mode="content"/>
+				</rng:optional>
+			</xsl:when>
+			<!-- here minOccurs is present but not = 0 -->
+			<xsl:when test="@minOccurs">
+				<xsl:call-template name="loopUntilZero">
+					<xsl:with-param name="nbLoops" select="@minOccurs"/>
+				</xsl:call-template>
+			</xsl:when>
+			<xsl:otherwise>
+				<xsl:apply-templates select="current()" mode="content"/>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+
+	<xsl:template name="loopUntilZero">
+		<xsl:param name="nbLoops"/>
+		<xsl:if test="$nbLoops > 0">
+			<xsl:apply-templates select="current()" mode="content"/>
+			<xsl:call-template name="loopUntilZero">
+				<xsl:with-param name="nbLoops" select="$nbLoops - 1"/>
+			</xsl:call-template>
+		</xsl:if>
+	</xsl:template>
+
+	<xsl:template name="type">
+		<xsl:param name="type"/>
+		<xsl:choose>
+			<xsl:when test="contains($type, 'anyType')">
+				<rng:data type="string">
+					<xsl:apply-templates/>
+				</rng:data>
+			</xsl:when>
+			<!-- have to improve the prefix detection -->
+			<xsl:when test="starts-with($type, 'xs:') or starts-with($type, 'xsd:')">
+				<rng:data type="{substring-after($type, ':')}">
+					<!-- xsltproc tries to apply templates on current attributes -->
+					<xsl:apply-templates select="*"/>
+				</rng:data>
+			</xsl:when>
+			<xsl:when test="starts-with($type, 'xml:')">
+				<xsl:variable name="localName" select="substring-after($type, ':')"/>
+				<rng:attribute name="{$localName}" ns="http://www.w3.org/XML/1998/namespace">
+					<xsl:choose>
+						<xsl:when test="$localName='lang'">
+							<rng:value type="language"/>
+						</xsl:when>
+						<xsl:when test="$localName='space'">
+							<rng:choice>
+						        <rng:value>default</rng:value>
+						        <rng:value>preserve</rng:value>
+					      	</rng:choice>
+						</xsl:when>
+						<xsl:otherwise>
+							<rng:text/>
+						</xsl:otherwise>
+					</xsl:choose>
+			  	</rng:attribute>
+			</xsl:when>
+			<xsl:otherwise>
+				<xsl:choose>
+					<xsl:when test="contains($type, ':')">
+						<rng:ref name="{substring-after($type, ':')}"/>
+						<xsl:apply-templates/>
+					</xsl:when>
+					<xsl:otherwise>
+						<rng:ref name="{$type}"/>
+						<xsl:apply-templates/>
+					</xsl:otherwise>
+				</xsl:choose>
+			</xsl:otherwise>
+		</xsl:choose>
+	</xsl:template>
+    
+	<xsl:template name="declareMemberTypes">
+		<xsl:param name="memberTypes"/>
+		<xsl:choose>
+            <xsl:when test="contains($memberTypes, ' ')">
+				<xsl:call-template name="type">
+					<xsl:with-param name="type" select="substring-before($memberTypes, ' ')"/>
+				</xsl:call-template>
+                <xsl:call-template name="declareMemberTypes">
+                    <xsl:with-param name="memberTypes" select="substring-after($memberTypes, ' ')"/>
+                </xsl:call-template>
+            </xsl:when>
+            <xsl:otherwise>
+				<xsl:call-template name="type">
+					<xsl:with-param name="type" select="$memberTypes"/>
+				</xsl:call-template>
+            </xsl:otherwise>
+        </xsl:choose>
+	</xsl:template>
+    
+</xsl:stylesheet>

data/lib/xml/smart.rb

@@ -0,0 +1,177 @@
+require 'rubygems'
+require 'nokogiri'
+require 'lockfile'
+
+require File.expand_path(File.dirname(__FILE__) + '/smart_qname')
+require File.expand_path(File.dirname(__FILE__) + '/smart_dom')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domelement')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domnodeset')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domtext')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domother')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domattributeset')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domattribute')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domnamespaceset')
+require File.expand_path(File.dirname(__FILE__) + '/smart_domnamespace')
+
+module Nokogiri
+  module XML
+    class Document
+      def ns_counter
+        @ns_counter ||= 1
+      end
+      def ns_update
+        @ns_counter ||= 1
+        @ns_counter += 1
+        self
+      end
+
+      def custom_namespace_prefixes_update
+        result = {}
+
+        diffs = []
+        ns = self.xpath('//namespace::*').to_a.delete_if do |n| 
+          if diffs.include? n.href
+            true
+          else  
+            diffs.push(n.href).uniq!
+            false
+          end  
+        end 
+
+        de = ns.find_all{|n| n.prefix.nil?}
+        if de.length == 1
+          result['xmlns'] = de[0].href
+        end
+        if de.length > 1
+          i = 0
+          de.each do |n|
+            unless result.has_value? n.href
+              result["xmlns#{i}"] = n.href
+              i += 1
+            end  
+          end
+        end
+
+        ns.find_all{|n| !n.prefix.nil? && !(n.prefix == 'xml')}.each do |n|
+          result[n.prefix] = n.href
+        end
+        @custom_namespace_prefixes = result
+      end
+      def custom_namespace_prefixes
+        @custom_namespace_prefixes || custom_namespace_prefixes_update
+      end
+      def user_custom_namespace_prefixes
+        @user_custom_namespace_prefixes ||= {}
+      end
+      def user_custom_namespace_prefixes=(h)
+        @user_custom_namespace_prefixes = h
+      end
+    end
+
+    class Node
+      def xpath_plain(path)
+        XPathContext.new(self).evaluate(path)
+      end
+      def xpath_fast(path)
+        return xpath(path,self.document.custom_namespace_prefixes.merge(self.document.user_custom_namespace_prefixes))
+        return NodeSet.new(document) unless document
+        @nsc ||= 0
+        if @nsc != self.document.ns_counter
+          @ctx = XPathContext.new(self)
+          @ctx.register_namespaces(self.document.custom_namespace_prefixes.merge(self.document.user_custom_namespace_prefixes))
+          @nsc = self.document.ns_counter
+        end
+        path = path.gsub(/xmlns:/, ' :') unless Nokogiri.uses_libxml?
+        @ctx.evaluate(path)
+      end
+    end
+  end
+end
+
+module XML
+  VERSION        = '0.3.0'
+  LIBXML_VERSION = Nokogiri::VERSION_INFO['libxml']['loaded']
+  LOCKFILE = {
+    :min_sleep => 0.25,
+    :max_sleep => 5,
+    :sleep_inc => 0.25,
+    :max_age => 5
+  }
+
+  module Smart
+    COPY = 0
+    MOVE = 1
+
+    def initialize(name,default=nil); open(name,default); end
+
+    def self::modify(name,default=nil,&block)
+      raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO)
+      raise Error, 'a block is mandatory' unless block_given?
+      lfname = name.is_a?(String) ? name : name.fileno.to_s
+      lockfile = Lockfile.new(lfname + '.lock',LOCKFILE)
+      begin
+        lockfile.lock
+        so = Smart::open_unprotected(name,default)
+        block.call(so)
+        so.save_as(name)
+      ensure
+        lockfile.unlock
+      end
+      nil
+    end
+
+    def self::open(name,default=nil)
+      raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO)
+      raise Error, 'second parameter has to be an xml string' unless default.is_a?(String) || default.nil?
+      lfname = name.is_a?(String) ? name : name.fileno.to_s
+      lockfile = Lockfile.new(lfname + '.lock',LOCKFILE)
+      dom = nil
+      begin
+        lockfile.lock
+        dom = Smart::open_unprotected(name,default)
+      ensure  
+        lockfile.unlock
+      end
+      if dom && block_given?
+        yield dom
+        nil
+      else  
+        dom
+      end
+    end
+
+    def self::open_unprotected(name,default=nil)
+      raise Error, 'first parameter has to be a filename or filehandle' unless name.is_a?(String) || name.is_a?(IO)
+      raise Error, 'second parameter has to be an xml string' unless default.is_a?(String) || default.nil?
+      dom = begin
+        io =  name.is_a?(String) ? ::Kernel::open(name) : name
+        Dom.new Nokogiri::XML::parse(io){|config| config.noblanks.noent.nsclean.strict }
+      rescue
+        if default.nil?
+          raise Error, "could not open #{name}"
+        else
+          Smart::string(default)
+        end
+      end
+      if block_given?
+        yield dom
+        nil
+      else  
+        dom
+      end
+    end
+
+    def self::string(str)
+      raise Error, 'first parameter has to be stringable (:to_s)' unless str.is_a?(String)
+      dom = Dom.new Nokogiri::XML::parse(str.to_s){|config| config.noblanks.noent.nsclean.strict }
+      if block_given?
+        yield dom
+        nil
+      else  
+        dom
+      end
+    end
+
+    class Error < RuntimeError; end
+  end
+end