senotrusov-ruby-xml-mapper 1.0.2

data/LICENSE

@@ -0,0 +1,204 @@
+
+   Copyright 2008-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,23 @@
+
+Copyright 2008-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+
+Ruby XML mapper
+===============
+
+Sample of RSS mapping:
+
+  http://github.com/senotrusov/ruby-xml-mapper/blob/master/test/rss.rb
+

data/lib/ruby-xml-mapper/basic_containers.rb

@@ -0,0 +1,118 @@
+
+#  Copyright 2008-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+ 
+
+# TODO: Double check .strip - is it needed actually
+
+class String
+  def self.new_from_xml_attr attr
+    new(attr.value.strip.gsub(/\s*[\r\n]\s*/, "\n"))
+  end
+
+  def self.new_from_xml_node node
+    new(node.content.strip.gsub(/\s*[\r\n]\s*/, "\n"))
+  end
+end
+
+class Symbol
+  def self.new_from_xml_attr attr
+    String.new_from_xml_attr(attr).to_sym
+  end
+
+  def self.new_from_xml_node node
+    String.new_from_xml_node(node).to_sym
+  end
+end
+
+class Class
+  def self.new_from_xml_attr attr
+    String.new_from_xml_attr(attr).constantize
+  end
+
+  def self.new_from_xml_node node
+    String.new_from_xml_node(node).constantize
+  end
+end
+
+class Integer
+  def self.new_from_xml_attr attr
+    attr.value.to_i
+  end
+
+  def self.new_from_xml_node node
+    node.content.to_i
+  end
+end
+
+class RubyXmlMapper::Boolean
+  def self.new_from_xml_attr attr
+    (attr.value =~ /\A\s*true\s*\z/i) ? true : false
+  end
+
+  def self.new_from_xml_node node
+    (node.content =~ /\A\s*true\s*\z/i) ? true : false
+  end
+end
+
+class RubyXmlMapper::HashOfStringAndNumeric < Hash
+  def self.new_from_xml_node node
+    created = new
+    created.initialize_from_xml_node node
+    created
+  end
+
+  def initialize_from_xml_node node
+    node.each_element do |child|
+      self[child.name.to_sym] = autocast_value(child.content)
+    end
+    node.each_attr do |attr|
+      self[attr.name.to_sym] = autocast_value(attr.value)
+    end
+  end
+
+  def autocast_value value
+      if value =~ /\A\s*-*\d+\.\d+\s*\z/
+        value.to_f
+
+      elsif value =~ /\A\s*-*\d+\s*\z/
+        value.to_i
+
+      elsif matchdata = value.match(/\A\s*(-*\d+)\s*\.\.\s*(-*\d+)\s*\z/)
+        Range.new(matchdata[1].to_i, matchdata[2].to_i)
+
+      elsif value =~ /\A\s*true\s*\z/i
+        true
+
+      elsif value =~ /\A\s*false\s*\z/i
+        false
+
+      else
+        value.strip.gsub(/\s*[\r\n]\s*/, "\n").gsub(/\n\s*\n/, "\n")
+        
+      end
+  end
+end
+
+require 'time'
+
+class Time
+  def self.new_from_xml_attr attr
+    parse(attr.value)
+  end
+
+  def self.new_from_xml_node node
+    parse(node.content)
+  end
+end

data/lib/ruby-xml-mapper.rb

@@ -0,0 +1,239 @@
+
+#  Copyright 2008-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+ 
+
+# TODO Эта библиотека требует рефакторинга. Стоит выделить маппинг в отдельные объекты, а не держать всё размазанным по исходному классу. Опять же, это сделает проще обратный маппинг - из объектов в XML
+
+require 'libxml'
+
+module RubyXmlMapper
+  def self.included model
+    model.extend RubyXmlMapper::RubyXmlMapperClassMethods
+    
+    model.class_inheritable_accessor :xml_name
+    model.class_inheritable_accessor :source_dir_path
+    
+    model.class_inheritable_accessor :xml_self_mapping
+    model.class_inheritable_accessor :xml_content_mapping
+    model.class_inheritable_hash :xml_attr_mappings
+    model.class_inheritable_hash :xml_child_mappings
+    
+    model.xml_attr_mappings = {}
+    model.xml_child_mappings = {}
+  end
+
+  # Source loading is ugly
+  def initialize_from_xml node, load_source = true
+    initialize_from_xml_attr_mapping(node) if xml_attr_mappings.length
+
+    # TODO must not be a magic attribute
+    if @source && load_source
+      unless source_dir_path
+        raise "source_dir_path not defined in #{self.class.inspect}"
+      end
+
+      initialize_from_xml(self.class.parse_xml_file(File.expand_path_restricted(@source, source_dir_path)), false)
+    else
+      initialize_from_xml_child_mapping(node) if xml_child_mappings.length
+      initialize_from_xml_self_mapping(node) if xml_self_mapping
+      initialize_from_xml_content_mapping(node) if xml_content_mapping
+    end
+  end
+  
+  private
+  
+  def initialize_from_xml_attr_mapping node
+    node.each_attr do |attr|
+      if (mapping = xml_attr_mappings[attr.name])
+        self.__send__(mapping[:writer_method], mapping[:type].new_from_xml_attr(attr))
+      end
+    end
+
+    # Applying default values
+    xml_attr_mappings.each do |key, mapping|
+      if mapping[:default] && self.__send__(mapping[:reader_method]).nil?
+        self.__send__(mapping[:writer_method], mapping[:default])
+      end
+    end
+  end
+
+
+  def initialize_from_xml_child_mapping node
+    node.each_element do |child|
+      if (mapping = xml_child_mappings[child.name])
+        map_xml_node child, mapping
+      end
+    end
+    
+    # Applying default values
+    xml_child_mappings.each do |key, mapping|
+      if mapping[:types] && !self.__send__(mapping[:reader_method]) # TODO: handle as default (below)
+        self.__send__(mapping[:writer_method], Array.new)
+      end
+
+      if mapping[:default] && self.__send__(mapping[:reader_method]).nil?
+        self.__send__(mapping[:writer_method], mapping[:default])
+      end
+    end
+  end
+  
+  def map_xml_node node, mapping
+    if (types = mapping[:types]) || mapping[:multiple]
+      unless (array = self.__send__(mapping[:reader_method]))
+        array = self.__send__(mapping[:writer_method], Array.new)
+      end
+
+      if mapping[:multiple]
+        array.push(mapping[:type].new_from_xml_node(node))
+      else
+        node.each_element do |child|
+          if(type = types[child.name])
+            array.push(type.new_from_xml_node(child))
+          end
+        end
+      end
+    else
+      self.__send__(mapping[:writer_method], mapping[:type].new_from_xml_node(node))
+    end
+  end
+
+
+  def initialize_from_xml_self_mapping node
+    if xml_self_mapping[:type].kind_of?(Array)
+      types = xml_self_mapping[:types]
+
+      node.each_element do |child|
+        if(type = types[child.name])
+          self.push(type.new_from_xml_node(child))
+        end
+      end
+    elsif xml_self_mapping[:type] == :self
+      self.initialize_from_xml_node node
+    end
+  end
+  
+  def initialize_from_xml_content_mapping node
+    self.__send__(xml_content_mapping[:writer_method], xml_content_mapping[:type].new_from_xml_node(node))
+  end
+  
+  
+  
+  module RubyXmlMapperClassMethods
+    def parse_xml_file(file_name)
+      check_file file_name
+
+      # NOTE: Don't know how to use XML::Document.file correctly.
+      # As in libxml-ruby-1.1.3 it does not close file descriptor, so you end up with "Error: Too many open files."
+      
+      doc = LibXML::XML::Document.string(File.read(file_name))
+
+      # NOTE: If document does not created from file, it leads to "Segmentation fault"
+      # doc.xinclude
+
+      doc.root
+    end
+
+
+    def check_file file_name
+      unless File.file?(file_name)
+        raise "Unable to find file #{file_name.inspect}"
+      end
+
+      unless File.readable?(file_name)
+        raise "File is not readable #{file_name.inspect}"
+      end
+    end
+    
+    def new_from_xml_file file_name
+      new_from_xml_node(parse_xml_file(file_name))
+    end
+
+    def new_from_xml_node node
+      allocated = allocate
+      allocated.initialize_from_xml node
+      allocated
+    end
+
+    def xml args
+      register_method = args.keys.detect {|key| self.respond_to?("register_#{key}_mapping", true)} || "self"
+      
+      self.__send__("register_#{register_method}_mapping", args)
+    end
+    
+    
+    private
+    
+    def register_attr_mapping args
+      args[:reader_method] = args[:attr]
+      args[:writer_method] = "#{args[:attr]}="
+      args[:tag_name] ||= args[:attr].to_s
+      
+      attr_accessor args[:reader_method].to_sym
+      
+      xml_attr_mappings[args[:tag_name]] = args
+    end
+    
+    
+    def register_child_mapping args
+      args[:tag_name] ||= args[:child].to_s
+
+      if args[:multiple]
+        args[:reader_method] = args[:multiple]
+        args[:writer_method] = "#{args[:multiple]}="
+      else
+        args[:reader_method] = args[:child]
+        args[:writer_method] = "#{args[:child]}="
+      end
+
+      register_type_array(args) if args[:type].kind_of?(Array)
+      
+      attr_accessor args[:reader_method].to_sym
+      xml_child_mappings[args[:tag_name]] = args
+    end
+    
+    
+    def register_self_mapping args
+      if args[:type].kind_of?(Array)
+        register_type_array(args)
+      elsif args[:type] == :self && self < RubyXmlMapper::HashOfStringAndNumeric
+         
+      else
+        raise(":type must be kind_of Array or :self with the following supported types: RubyXmlMapper::HashOfStringAndNumeric )")
+      end
+
+      self.xml_self_mapping = args
+    end
+    
+
+    def register_content_mapping args
+      args[:reader_method] = args[:content]
+      args[:writer_method] = "#{args[:content]}="
+      
+      attr_accessor args[:reader_method].to_sym
+      
+      self.xml_content_mapping = args
+    end
+
+    def register_type_array args
+      args[:types] = {}
+      args[:type].each do |klass|
+        args[:types][klass.respond_to?(:xml_name) && klass.xml_name || klass.to_s.split('::').last.underscore] = klass
+      end
+    end
+  end
+end
+
+require 'ruby-xml-mapper/basic_containers'
+

data/test/rss.rb

@@ -0,0 +1,49 @@
+
+#  Copyright 2008-2009 Stanislav Senotrusov <senotrusov@gmail.com>
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+=begin
+$KCODE ="UTF8"
+require 'rubygems'
+require 'ruby-xml-mapper'
+
+rss = RSS::RSS.new_from_xml_file('http://www.reddit.com/r/programming/.rss')
+rss.channel.items.each {|item| puts item.title}; nil
+=end
+
+module RSS
+  class Item
+    include RubyXmlMapper
+    xml :child => :title, :type => String
+    xml :child => :link, :type => String
+    xml :child => :description, :type => String
+    xml :child => :category, :type => String
+    xml :child => :guid, :type => String
+  end
+
+  class Channel
+    include RubyXmlMapper
+    xml :child => :title, :type => String
+    xml :child => :link, :type => String
+    xml :child => :description, :type => String
+    xml :child => :ttl, :type => Integer
+
+    xml :child => :item, :multiple => :items, :type => RSS::Item
+  end
+
+  class RSS
+    include RubyXmlMapper
+    xml :child => :channel, :type => ::RSS::Channel
+  end
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: senotrusov-ruby-xml-mapper
+version: !ruby/object:Gem::Version 
+  version: 1.0.2
+platform: ruby
+authors: 
+- Stanislav Senotrusov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+description: 
+email: senotrusov@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- README
+- LICENSE
+- lib/ruby-xml-mapper
+- lib/ruby-xml-mapper/basic_containers.rb
+- lib/ruby-xml-mapper.rb
+- test/rss.rb
+has_rdoc: false
+homepage: http://github.com/senotrusov
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Mapping XML to Ruby in handy declarative manner using LibXML
+test_files: []
+