vcdom 0.2.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-01-16
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,34 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/vcdom.rb
+lib/vcdom/minidom.rb
+lib/vcdom/minidom/attr.rb
+lib/vcdom/minidom/attr_ns.rb
+lib/vcdom/minidom/cdata_section.rb
+lib/vcdom/minidom/character_data.rb
+lib/vcdom/minidom/comment.rb
+lib/vcdom/minidom/document.rb
+lib/vcdom/minidom/dom_exception.rb
+lib/vcdom/minidom/dom_implementation.rb
+lib/vcdom/minidom/element.rb
+lib/vcdom/minidom/element_ns.rb
+lib/vcdom/minidom/mini_parser.rb
+lib/vcdom/minidom/mini_serializer.rb
+lib/vcdom/minidom/minidom_standard_error.rb
+lib/vcdom/minidom/mod_child_node.rb
+lib/vcdom/minidom/mod_parent_node.rb
+lib/vcdom/minidom/mod_elements_getter.rb
+lib/vcdom/minidom/mod_namespaceuri_manageable.rb
+lib/vcdom/minidom/named_node_map_attr.rb
+lib/vcdom/minidom/node_list.rb
+lib/vcdom/minidom/node.rb
+lib/vcdom/minidom/text.rb
+lib/vcdom/minidom/xml_reg_exp.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_vcdom.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on vcdom, see http://vcdom.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,51 @@
+= vcdom
+
+* http://vcdom.rubyforge.org/
+
+== DESCRIPTION:
+
+This library provides DOM implementation(s).
+
+== FEATURES/PROBLEMS:
+
+* list of features or problems
+
+== SYNOPSIS:
+
+impl = VCDOM::MiniDOM.get_dom_implementation()
+doc = impl.create_document( nil, "test", nil )
+doc.document_element.text_content = "This is an XML for test."
+$stdout << impl.mini_serializer.write_to_string( doc ) << "\n"
+
+== REQUIREMENTS:
+
+* list of requirements
+
+== INSTALL:
+
+* sudo gem install vcdom
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Y. NOBUOKA
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/vcdom'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'vcdom' do
+  self.developer 'Y. NOBUOKA', 'nobuoka@r-definition.com'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = 'vcdom' # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/vcdom/minidom/attr.rb

@@ -0,0 +1,139 @@
+# -*- coding: utf-8 -*-
+
+require "vcdom/minidom/node"
+require "vcdom/minidom/mod_parent_node"
+
+module VCDOM
+  module MiniDOM
+    class Attr < Node
+      
+      module OwnerElementManageable
+        protected
+        def owner_element=( element )
+          @owner_element = element
+        end
+      end
+      
+      include ModParentNode
+      include OwnerElementManageable
+      
+      def node_type
+        return Node::ATTRIBUTE_NODE
+      end
+      
+      # ===== Attributes =====
+      
+      # name of type DOMString, readonly
+      #   Returns the name of this attribute. 
+      #   If Node.localName is different from null, this attribute is a qualified name.
+      def name
+        return @name
+      end
+      alias :node_name :name
+      
+      # value of type DOMString
+      #   On retrieval, the value of the attribute is returned as a string. 
+      #   Character and general entity references are replaced with their values. 
+      #   See also the method getAttribute on the Element interface.
+      #   On setting, this creates a Text node with the unparsed contents of the string, 
+      #   i.e. any characters that an XML processor would recognize as markup are instead 
+      #   treated as literal text. 
+      #   See also the method Element.setAttribute().
+      #   Some specialized implementations, such as some [SVG 1.1] implementations, 
+      #   may do normalization automatically, even after mutation; in such case, the 
+      #   value on retrieval may differ from the value on setting.
+      #   
+      #   Exceptions on setting
+      #     DOMException
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
+      def value
+        return self.text_content
+      end
+      def value=( value )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        if ! value.instance_of? String then
+          raise TypeError.new( "The argument must be String object." )
+        end
+        self.text_content = value
+      end
+      
+      # nodeValue of type DOMString
+      #   The value of this node, depending on its type; see the table above. 
+      #   When it is defined to be null, setting it has no effect, including if the node is read-only.
+      #   
+      #    Interface             nodeValue
+      #    ------------------------------------------------------------------------------------------------
+      #    Attr                  same as Attr.value
+      #   
+      #   Exceptions on setting
+      #     DOMException
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and 
+      #                 if it is not defined to be null.
+      #   Exceptions on retrieval
+      #     DOMException
+      #       DOMSTRING_SIZE_ERR: Raised when it would return more characters than 
+      #                 fit in a DOMString variable on the implementation platform.
+      #   
+      # Attr, PI, CharacterData ( = CDATASection, Comment, Text ) でオーバーロード
+      alias :node_value :value
+      alias :node_value= :value=
+      
+      # ownerElement of type Element, readonly, introduced in DOM Level 2
+      #   The Element node this attribute is attached to or null if this attribute is not in use.
+      def owner_element; return @owner_element end
+      
+      # specified of type boolean, readonly
+      #   True if this attribute was explicitly given a value in the instance document, 
+      #   false otherwise. 
+      #     #=> この属性 (specified ではなく Attr ノード) が, 文書中で明示的に値を与えられている場合は 
+      #         true, さもなければ false である.
+      #   If the application changed the value of this attribute node (even if it ends 
+      #   up having the same value as the default value) then it is set to true.
+      #     #=> もし, アプリケーションがこの Attr ノードの値を変化させた場合 (たとえ結果的にデフォルト値と同じ
+      #         値であったとしても), true になる. 
+      #   The implementation may handle attributes with default values from other schemas 
+      #   similarly but applications should use Document.normalizeDocument() to guarantee 
+      #   this information is up-to-date.
+      #     #=> ...
+      def specified
+        return true
+      end
+      
+      # ===== コンストラクタ =====
+      #   Exceptions
+      #     DOMException
+      #       INVALID_CHARACTER_ERR: Raised if the specified name is not an XML name according to 
+      #                 the XML version in use specified in the Document.xmlVersion attribute.
+      def initialize( owner_document, name )
+        if XMLRegExp::NAME !~ name then
+          # the specified qualified name is not an XML name
+          raise DOMException.new( DOMException::INVALID_CHARACTER_ERR, 
+                  'The specified name "' + name + '" is not an XML name.' )
+        end
+        super( owner_document )
+        init_mod_parent_node()
+        @name = name
+      end
+      
+      protected
+      def name=( name )
+        @name = name
+      end
+      def check_hierarchy( new_child )
+        # Text, EntityReference
+        super( new_child, true )
+        case new_child.node_type
+          when Node::TEXT_NODE, Node::ENTITY_REFERENCE_NODE then
+            return true
+          else
+            raise DOMException.new( DOMException::HIERARCHY_REQUEST_ERR, 
+                    'This node is of a type that does not allow children of the type of the newChild node.' )
+        end
+      end
+      
+    end
+  end
+end

data/lib/vcdom/minidom/attr_ns.rb

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+
+require "vcdom/minidom/node"
+require "vcdom/minidom/mod_parent_node"
+require "vcdom/minidom/mod_namespaceuri_manageable"
+
+module VCDOM
+  module MiniDOM
+    class AttrNS < Attr
+      
+      include ModNamespaceURIManageable
+      
+      #     DOMException
+      #       INVALID_CHARACTER_ERR: Raised if the specified qualifiedName is not an XML name according 
+      #                 to the XML version in use specified in the Document.xmlVersion attribute.
+      #       NAMESPACE_ERR: Raised if the qualifiedName is a malformed qualified name, 
+      #                 if the qualifiedName has a prefix and the namespaceURI is null, 
+      #                 if the qualifiedName has a prefix that is "xml" and the namespaceURI is different 
+      #                 from "http://www.w3.org/XML/1998/namespace", if the qualifiedName or its prefix is 
+      #                 "xmlns" and the namespaceURI is different from "http://www.w3.org/2000/xmlns/", 
+      #                 or if the namespaceURI is "http://www.w3.org/2000/xmlns/" and 
+      #                 neither the qualifiedName nor its prefix is "xmlns".
+      #         #=> QName が奇形の場合, QName が接頭辞を持ちながら名前空間 URI が null の場合, 
+      #             QName の接頭辞が "xml" なのに名前空間 URI が 
+      #             "http://www.w3.org/XML/1998/namespace" ではない場合, QName の接頭辞が 
+      #             "xmlns" にもかかわらず名前空間 URI が "http://www.w3.org/2000/xmlns/"
+      #             ではないとき, そして名前空間 URI が "http://www.w3.org/2000/xmlns/" なのに, 
+      #             QName または接頭辞が "xmlns" ではないとき例外発生.
+      #       NOT_SUPPORTED_ERR: Always thrown if the current document does not support the "XML" feature, 
+      #                 since namespaces were defined by XML.
+      def initialize( owner_document, namespace_uri, qualified_name )
+        begin
+          super( owner_document, qualified_name )
+        rescue DOMException => err
+          if err.code == DOMException::INVALID_CHARACTER_ERR then
+            raise DOMException.new( DOMException::INVALID_CHARACTER_ERR, 
+                    'The specified qualified name "' + qualified_name + '" is not an XML name.' )
+          else
+            raise err
+          end
+        end
+        init_mod_namespaceuri_manageable( namespace_uri, qualified_name )
+      end
+      
+    end
+  end
+end

data/lib/vcdom/minidom/cdata_section.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+require "vcdom/minidom/node"
+require "vcdom/minidom/character_data"
+require "vcdom/minidom/mod_child_node"
+require "vcdom/minidom/dom_exception"
+
+module VCDOM
+  module MiniDOM
+    class CDATASection < CharacterData
+      
+      # nodeType of type unsigned short, readonly
+      #   A code representing the type of the underlying object, as defined above.
+      def node_type
+        return Node::CDATA_SECTION_NODE
+      end
+      
+      # nodeName of type DOMString, readonly
+      #   The name of this node, depending on its type; see the table above.
+      #   
+      #    Interface             nodeName              
+      #    ------------------------------------------------------------
+      #    CDATASection          "#cdata-section"      
+      def node_name
+        return "#cdata-section"
+      end
+      
+      def initialize( owner_document, value )
+        super( owner_document, value )
+      end
+      
+    end
+  end
+end

data/lib/vcdom/minidom/character_data.rb

@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+
+require "vcdom/minidom/node"
+require "vcdom/minidom/mod_child_node"
+require "vcdom/minidom/dom_exception"
+
+module VCDOM
+  module MiniDOM
+    class CharacterData < Node
+      
+      include ModChildNode
+      
+      # data of type DOMString
+      #   
+      #   The character data of the node that implements this interface. 
+      #   The DOM implementation may not put arbitrary limits on the amount of 
+      #   data that may be stored in a CharacterData node. 
+      #   However, implementation limits may mean that the entirety of a node's 
+      #   data may not fit into a single DOMString. 
+      #   In such cases, the user may call substringData to retrieve the data in 
+      #   appropriately sized pieces.
+      #
+      #   Exceptions on setting
+      #     DOMException NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
+      #   Exceptions on retrieval
+      #     DOMException DOMSTRING_SIZE_ERR: Raised when it would return more characters than fit in a DOMString variable on the implementation platform.
+      def data
+        return @data
+      end
+      def data=( value )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        @data = value
+      end
+      
+      # nodeValue of type DOMString
+      #   The value of this node, depending on its type; see the table above. 
+      #   When it is defined to be null, setting it has no effect, including if the node is read-only.
+      #   
+      #    Interface             nodeValue
+      #    ------------------------------------------------------------------------------------------------
+      #    Text                  same as CharacterData.data, the content of the text node
+      #   
+      #   Exceptions on setting
+      #     DOMException
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly and 
+      #                 if it is not defined to be null.
+      #   Exceptions on retrieval
+      #     DOMException
+      #       DOMSTRING_SIZE_ERR: Raised when it would return more characters than 
+      #                 fit in a DOMString variable on the implementation platform.
+      #   
+      # Attr, PI, CharacterData ( = CDATASection, Comment, Text ) でオーバーロード
+      alias :node_value :data
+      alias :node_value= :data=
+      
+      
+      # ===== Attributes =====
+      
+      # length of type unsigned long, readonly
+      # 
+      #   The number of 16-bit units that are available through data and the substringData method below. 
+      #   This may have the value zero, i.e., CharacterData nodes may be empty.
+      def length
+        count = 0
+        while /\A.{#{count}}/mu =~ @data do
+          count += 1
+        end
+        count -= 1
+        return count
+      end
+      
+      # ===== Methods =====
+      
+      # appendData
+      #   
+      #   Append the string to the end of the character data of the node. 
+      #   Upon success, data provides access to the concatenation of data and the DOMString specified.
+      #   
+      #   Parameters
+      #     arg of type DOMString
+      #       The DOMString to append.
+      #   Exceptions
+      #     DOMException
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
+      #   No Return Value
+      def append_data( arg )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        @data = @data + arg
+        return nil
+      end
+      
+      # deleteData
+      #   Remove a range of 16-bit units from the node. Upon success, data and length 
+      #   reflect the change.
+      #   
+      #   Parameters
+      #     offset of type unsigned long
+      #       The offset from which to start removing.
+      #     count of type unsigned long
+      #       The number of 16-bit units to delete. If the sum of offset and count 
+      #       exceeds length then all 16-bit units from offset to the end of the data 
+      #       are deleted.
+      #   Exceptions
+      #     DOMException
+      #       INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 
+      #               than the number of 16-bit units in data, or if the specified 
+      #               count is negative.
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
+      #   No Return Value
+      def delete_data( offset, count )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        begin
+          substrs = split( offset, count )
+        rescue DOMException => err
+          raise DOMException.new( err )
+        end
+        @data = substrs[0] + substrs[2]
+        return nil
+      end
+      
+      # insertData
+      #   
+      #   Insert a string at the specified 16-bit unit offset.
+      #   
+      #   Parameters
+      #     offset of type unsigned long
+      #       The character offset at which to insert.
+      #     arg of type DOMString
+      #       The DOMString to insert.
+      #   Exceptions
+      #     DOMException
+      #       INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 
+      #               than the number of 16-bit units in data.
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
+      #   No Return Value
+      def insert_data( offset, arg )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        begin
+          substrs = split( offset )
+        rescue DOMException => err
+          raise DOMException.new( err )
+        end
+        @data = substrs[0] + arg + substrs[1]
+        return nil
+      end
+      
+      # replaceData
+      #   
+      #   Replace the characters starting at the specified 16-bit unit offset with 
+      #   the specified string.
+      #   
+      #   Parameters
+      #     offset of type unsigned long
+      #       The offset from which to start replacing.
+      #     count of type unsigned long
+      #       The number of 16-bit units to replace. If the sum of offset and count 
+      #       exceeds length, then all 16-bit units to the end of the data are replaced; 
+      #       (i.e., the effect is the same as a remove method call with the same range, 
+      #       followed by an append method invocation).
+      #     arg of type DOMString
+      #       The DOMString with which the range must be replaced.
+      #   Exceptions
+      #     DOMException
+      #       INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 
+      #               than the number of 16-bit units in data, or if the specified count 
+      #               is negative.
+      #       NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
+      #   No Return Value
+      def replace_data( offset, count, arg )
+        if self.is_readonly then
+          raise DOMException.new( DOMException::NO_MODIFICATION_ALLOWED_ERR, 
+                  'This node is readonly.' )
+        end
+        begin
+          substrs = split( offset, count )
+        rescue DOMException => err
+          raise DOMException.new( err )
+        end
+        @data = substrs[0] + arg + substrs[2]
+        return nil
+      end
+      
+      # substringData
+      #   
+      #   Extracts a range of data from the node.
+      #   
+      #   Parameters
+      #     offset of type unsigned long
+      #       Start offset of substring to extract.
+      #     count of type unsigned long
+      #       The number of 16-bit units to extract.
+      #   Return Value
+      #     DOMString
+      #       The specified substring. If the sum of offset and count exceeds the length, 
+      #       then all 16-bit units to the end of the data are returned.
+      #   Exceptions
+      #     DOMException
+      #       INDEX_SIZE_ERR: Raised if the specified offset is negative or greater than 
+      #               the number of 16-bit units in data, or if the specified count is 
+      #               negative.
+      #       DOMSTRING_SIZE_ERR: Raised if the specified range of text does not fit 
+      #               into a DOMString.
+      def substring_data( offset, count )
+        begin
+          substrs = split( offset, count )
+        rescue DOMException => err
+          raise DOMException.new( err )
+        end
+        return substrs[1]
+      end
+      
+      
+      def initialize( owner_document, value )
+        super( owner_document )
+        init_mod_child_node()
+        @data = value
+      end
+      
+      private
+      def split( offset, count = nil )
+        if offset < 0 then
+          raise DOMException.new( DOMException::INDEX_SIZE_ERR, 
+                  'The specified offset is negative.' )
+        end
+        if /\A(.{#{offset}})(.*)\Z/mu =~ @data then
+          substr1 = ( $1 or '' )
+          substr2 = ( $2 or '' )
+        else
+          raise DOMException.new( DOMException::INDEX_SIZE_ERR, 
+                  'The specified offset is greater than the number of Character data.' )
+        end
+        if count.nil? then
+          return [substr1, substr2]
+        else
+          if count < 0 then
+            raise DOMException.new( DOMException::INDEX_SIZE_ERR, 
+                    'The specified count is negative.' )
+          end
+          if /\A(.{#{count}})(.*)\Z/mu =~ substr2 then
+            substr2 = ( $1 or '' )
+            substr3 = ( $2 or '' )
+          else
+            substr3 = ''
+          end
+          return [substr1, substr2, substr3]
+        end
+      end
+      
+    end
+  end
+end

data/lib/vcdom/minidom/comment.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+require "vcdom/minidom/node"
+require "vcdom/minidom/character_data"
+require "vcdom/minidom/mod_child_node"
+require "vcdom/minidom/dom_exception"
+
+module VCDOM
+  module MiniDOM
+    class Comment < CharacterData
+      
+      # nodeType of type unsigned short, readonly
+      #   A code representing the type of the underlying object, as defined above.
+      def node_type
+        return Node::COMMENT_NODE
+      end
+      
+      # nodeName of type DOMString, readonly
+      #   The name of this node, depending on its type; see the table above.
+      #   
+      #    Interface             nodeName              
+      #    ------------------------------------------------------------
+      #    Comment               "#comment"     
+      def node_name
+        return "#comment"
+      end
+      
+      def initialize( owner_document, value )
+        super( owner_document, value )
+      end
+      
+    end
+  end
+end