extreml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2176ef101bb8536701a8e2c98d674fc57ebb014cdc22dda621ede9cbbc896605
+  data.tar.gz: f282d659eb2c3a53235e856c4ca1675d02a4d2c442bc94a86a43792f3a56f830
+SHA512:
+  metadata.gz: d709f51ba09daf3e226cacd62cb4283da4153f748b7a18e28a2af57d65ed8455eb60b1a77daf7b3c7f5e4ea4af3568f504cb3bfa4ccdcff1ec31f019e18461e2
+  data.tar.gz: d8264e22eb185f33ceb7ae8d294dcaf6cee6c1207e7608feb1d29dd5a52821aec2042a7d5235923020cb9d0470a4aa35bd5b0a11ea6508bc1aa213d7bb2bd9c4

data/lib/extreml/type_element.rb

@@ -0,0 +1,141 @@
+# MIT License
+#
+# Copyright (c) 2020 Fabio Boccacini - fboccacini@gmail.com
+#
+# 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.
+
+require 'pp'
+
+class TypeElement
+
+  def initialize document
+
+    # document model:
+    #
+    # {
+    #   name: 'string',
+    #   namespace: 'string'|nil,
+    #   attributes: [attributes_array]|nil,
+    #   content: [mixed_array]|nil
+    # }
+    #
+    # attributes model:
+    #
+    # {
+    #   property: 'string',
+    #   namespace: 'string'|nil,
+    #   value: 'string'
+    # }
+    #
+    # Initialize properties
+    @name = document[:name]
+    @namespace = document[:namespace]
+    @attributes = document[:attributes]
+    @content = document[:content]
+    @types = Array.new
+
+    # Add a type for every element in content
+    unless @content.nil?
+      @content.each do |v|
+        if v.class == Hash
+          __add_type v[:name], v
+        end
+      end
+    end
+
+  end
+
+  # Getters
+  def name
+    @name
+  end
+  alias __name name
+
+  def attributes
+    @attributes
+  end
+  alias __attributes attributes
+
+  def namespace
+    @namespace
+  end
+  alias __namespace namespace
+
+  def content
+    if @content.nil? || @content.length >  1
+      return @content
+    else
+      return @content[0]
+    end
+  end
+  alias __content content
+
+  def types
+    # return self.methods - TypeElement.instance_methods
+    return @types
+  end
+  alias __types types
+
+  # Add a type method, that returns an array if there are more elements with the same tag,
+  # a Type object if it's just one, or the content if it's the last level
+  def add_type name, content
+
+    # If method exists, override it and return an array including all previous elements
+    # Else create a method that returns a new object of the content
+    if self.__types.any? name.to_sym
+      array = self.send name.to_sym
+      define_singleton_method name.to_sym do
+        return [array].flatten + [(content.class == Hash ? (TypeElement.new content) : content)]
+      end
+    else
+      define_singleton_method name.to_sym do
+        if content.class == Hash
+          return TypeElement.new content
+        else
+          return content
+        end
+      end
+      @types << name.to_sym
+    end
+
+  end
+  alias __add_type add_type
+
+  # Override to_s to use in strings (useful for the last nesting level)
+  def to_s
+    return self.__content
+  end
+  alias __to_s to_s
+
+  # This method is for debug purposes only, it prints a tree of the document
+  def tree level: 0, attributes: false
+
+    pre = level > 0 ? "#{'    ' * level}|#{'-->'}" : ""
+    puts "#{pre}#{self.__namespace}:#{self.__name} #{self.__types.inspect}" + (attributes ? " #{self.__attributes}" : "")
+    level += 1
+    self.__types.each do |m|
+      next_type = self.send(m)
+      [next_type].flatten.each do |nt|
+        (nt.__tree level: level, attributes: attributes) unless next_type.nil?
+      end
+    end
+  end
+  alias __tree tree
+
+end

data/lib/extreml.rb

@@ -0,0 +1,153 @@
+# MIT License
+#
+# Copyright (c) 2020 Fabio Boccacini - fboccacini@gmail.com
+#
+# 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.
+
+require 'extreml/type_element'
+
+class XmlHeader
+end
+
+class Extreml
+
+  def initialize xml_file = nil, warnings: true, xml_header: nil
+
+    # Warnings flag
+    @warnings = warnings
+    @header = xml_header
+
+    if xml_file.nil?
+      raise 'Error: please specify an xml file. Nil was given.'
+    elsif !File.file? xml_file
+      raise "Error: file #{xml_file} not found."
+    else
+
+      # Read file
+      xml = File.read xml_file
+
+      @body = Hash.new
+
+      # Get xml header informations
+      header = xml[/^\<\?xml (.*)\?\>/]
+
+      if header.nil?
+        puts "Warning: #{xml_file}: xml header missing." if @warnings
+        define_singleton_method :header do
+          return nil
+        end
+      else
+        h = header.scan /([\w\?\<]*)=["|']([^'"]*)["|']/
+
+        @xml_header = XmlHeader.new
+        h.each do |param|
+          @xml_header.instance_eval do
+            define_singleton_method param[0].to_sym do
+              return param[1]
+            end
+          end
+        end
+
+        define_singleton_method :header do
+          return @xml_header
+        end
+      end
+
+    end
+
+    # Read document
+    doc = xml.match /(?:\<\?xml .*?(?: ?\?\>))?[\t\n\r\f ]*(.*)/m
+    @document = unpack doc[1]
+
+  end
+
+  # Expose the entire document
+  def document
+    return TypeElement.new({name: 'document', content: @document})
+  end
+
+  # Print the entire document tree. For debug purposes
+  def tree attributes: false
+    self.document.__tree attributes
+  end
+
+  private
+
+  def unpack string
+
+    # Remove comments
+    string = string.gsub(/\<\!--[^>]*--\>/,'').strip
+
+    # Match a tag pair at a time, recurse for nested content
+    string = string.strip
+    tags = string.match /(?<prerest>.*?)?\<(?:(?<namespace>\w*):)?(?<name>[^\/]\w*)(?:[\t]*(?<attributes>[^>]*)?)\>(?<content>.*?)[\t\n\r\f]*\<\/\k<namespace>?:?\k<name>\>(?<rest>.*)/m
+
+    if tags.nil?
+      parts = string.match /(?<prerest>.*?)?\<(?:(?<namespace>\w*):)?(?<name>[^\/]\w*)(?:[\t]*(?<attributes>[^>]*)?)[\t\n\r\f]*\/\>(?<rest>.*)/m
+
+      if parts.nil?
+        return string
+      else
+        attributes = Array.new
+        a = parts[:attributes].scan /[\t\n\r\f ]*(?:(?<namespace>[^:\n\r\f\t]*):)?(?<property>[^=\n\r\f\t ]*)[\t ]*=[\t ]*"(?<value>[^"]*)"[\t\n\r\f]*/m
+        a.each do |p|
+          attributes << {
+            :namespace => p[0],
+            :property => p[1],
+            :value => p[2]
+          }
+        end
+
+        pack = Hash[
+          :name => parts[:name],
+          :namespace => parts[:namespace],
+          :attributes => attributes
+        ]
+        return [unpack(parts[:prerest].strip), pack, unpack(parts[:rest].strip)].reject{ |p| p == ""}
+      end
+    else
+
+      if tags[:attributes].strip! == ""
+        attributes = nil
+      else
+        attributes = Array.new
+        a = tags[:attributes].scan /[\t\n\r\f ]*(?:(?<namespace>[^:\n\r\f\t]*):)?(?<property>[^=\n\r\f\t ]*)[\t ]*=[\t ]*"(?<value>[^"]*)"[\t\n\r\f]*/m
+        a.each do |p|
+          attributes << {
+            :namespace => p[0],
+            :property => p[1],
+            :value => p[2]
+          }
+        end
+      end
+      if pack.nil?
+        pack = Hash[
+          :name => tags[:name].strip,
+          :namespace => tags[:namespace].nil? ? nil : tags[:namespace].strip,
+          :attributes => attributes,
+          :content => Array.new
+        ]
+      end
+      pack[:content] += [unpack(tags[:content].strip)].flatten
+    end
+    return [unpack(tags[:prerest].strip), pack, unpack(tags[:rest].strip)].reject{ |p| p == ""}
+
+  end
+
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: extreml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Boccacini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-09 00:00:00.000000000 Z
+dependencies: []
+description: |
+  # Extreml
+  ### Ruby XML manipulation gem
+
+  A powerful ruby gem to easily manipulate XML documents, that gives acces to the elements through dynamic methods.
+
+  This library contains another class, TypeElement, which exposes dynamic methods named after its nested tags.
+
+  The document method in of Extreml returns aTypeElement object with a method named after the root tag which returns the first level of nesting represented as TypeElement objects.
+
+  Any subsequent object has methods that reflect its structure, that return recursively an object that has the nested elements as methods.
+
+  If there are more than one element with the same tag, that method will return an array containing all subsequent objects.
+
+  All basic methods of TypeElement have aliases, in order to prevent method overriding in case the document contains tags with similar names, which are called with two leading underscores (es. __types).
+
+
+  Usage:
+  ------
+
+  ### Basic methods:
+
+
+
+  **Extreml:**
+
+  document: returns the representation of the entire document as a TypeElement object.
+
+  tree: prints the entire structure of the document for debugging purposes.
+
+
+
+  **TypeElement:**
+
+  name: returns the name of the element (= tag name).
+
+  namespace: returns the namespace of the tag.
+
+  attributes: returns an hash with the property names as key and the values as value.
+
+  types: returns an array containing the names of the dynamic methods referring to the nested elements.
+
+  to_s: returns the content (overrides
+  tree: prints the structure referred part of the document for debugging purposes.
+
+  All these methods have aliases (eg. __name, __namespace, etc.)
+
+
+
+  **File example:**
+  funny_people.xml
+
+      <?xml version="1.0" encoding="UTF-8"?>
+      <ns0:funnyPeople>
+        <ns1:businessCard>
+          <name>
+            <firstName>Guybrush</firstName>
+            <lastName>Threepwood</lastName>
+          </name>
+          <jobs:occupation name="pirate" description="Terror of threeheaded monkeys"/>
+          <address>
+            <island>Scabb Island</island>
+            <city>Pirate's city</city>
+            <street>Voodoo Blvd.</street>
+            <number>3</number>
+          </address>
+        </ns1:businessCard>
+        <ns1:businessCard>
+          <name>
+            <firstName>Senbei</firstName>
+            <lastName>Norimaki</lastName>
+          </name>
+          <jobs:occupation name="inventor" description="A great genius"/>
+          <address>
+            <city>Penguin Village</city>
+            <street>Tanuki doro</street>
+            <number>1</number>
+          </address>
+        </ns1:businessCard>
+        <types>
+          <type name="main character"/>
+          <type name="villain"/>
+          <otherTypes/>
+        </types>
+      </ns0:funnyPeople>
+
+  ## Code example:
+
+      xml = Extreml.new './funny_people.xml'
+
+      xml.header.version                                           # => "1.0"
+      xml.header.encoding                                          # => "UTF-8"
+
+      xml.document.funnyPeople.businessCard[0].name.firstName.to_s # => Guybrush
+      xml.document.funnyPeople.businessCard[0].__name              # => "businessCard"
+
+      xml.document.funnyPeople.types                               # => #<TypeElement:0x0000557373082fc8>
+      xml.document.funnyPeople.__types                             # => [:businessCard, :types]
+email: fboccacini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/extreml.rb
+- lib/extreml/type_element.rb
+homepage: https://github.com/fboccacini/extreml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem to easily mamipulate XML documents.
+test_files: []