extreml 0.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf78f69900728ade56258357b59d0c265e3899cd75d815583013b6358eac773
-  data.tar.gz: 21efcdaeb00a7779b87fb7b6583f4d5c887b2c84cd4bc2139c7100cad0906062
+  metadata.gz: e8ce77cbbe37518250fd8c88a7ac26541804fd4d6d01fdd647e7d9b839638966
+  data.tar.gz: 3fd36d023fd14a44ed7010e23c2335ee1eb3c3fe5109feb5f381d0c89af57f98
 SHA512:
-  metadata.gz: 90e4897a9ff69e52450e55d00ed6b5938ccc4a045358e40c485d23f8f0b357d20bba9ce21058760b82005f9ae9a283d6fb721c08c264bd13f31b1d14eb37d2ed
-  data.tar.gz: 9b1ace372adfe41199c644762fed6dc736c040116038d177fad79322ca46f4411280e8023f4ade3c874fc478bd5ac9c7f5073d023ce08c11487d764249442f29
+  metadata.gz: 191d4e328f54409ab5a0562cfab9b9f10180af318b8495bcc9e1e706bcf5fe85b8f50892e25be5fed24bb44c690e0ac858e8d3f5d8d7ff82f9e55b5da629d12f
+  data.tar.gz: 29982ef3e554190b4fc0cd1b48840740ab2264fda7130306704f4e1a9faab98dd212d7fedda9ba8bba018b62260b777c2d2519600f48b5985cdab09d7c2c12d0

data/lib/extreml.rb

@@ -20,10 +20,6 @@
 # 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
 
@@ -31,60 +27,108 @@ class Extreml
 
     # Warnings flag
     @warnings = warnings
-    @header = xml_header
+    @header = XmlHeader.new 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."
+      @document = Array.new
     else
+      if !File.file? xml_file
+        raise "Error: file #{xml_file} not found."
+      else
 
-      # Read file
-      xml = File.read xml_file
+        # Read file
+        xml = File.read xml_file
 
-      @body = Hash.new
+        @body = Hash.new
 
-      # Get xml header informations
-      header = xml[/^\<\?xml (.*)\?\>/]
+        # 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
+        if header.nil?
+          puts "Warning: #{xml_file}: xml header missing." if @warnings
+          define_singleton_method :header do
+            return nil
           end
-        end
+        else
+          h = header.scan /([\w\?\<]*)=["|']([^'"]*)["|']/
 
-        define_singleton_method :header do
-          return @xml_header
+          @xml_header = XmlHeader.new header
+
+          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
 
-    # Read document
-    doc = xml.match /(?:\<\?xml .*?(?: ?\?\>))?[\t\n\r\f ]*(.*)/m
-    @document = unpack doc[1]
+  end
+
+  # Returns the document in an Hash form
+  def to_hash
+    return self.document.to_hash
+  end
 
+  def to_json
+    return self.document.to_json
+  end
+
+  # Retrurns the document in XML format
+  def to_xml
+    if @xml_header.nil?
+      xml = ''
+    else
+      xml = @xml_header.to_xml + "\n"
+    end
+    self.document.__types.each do |t|
+      xml += self.document.send(t).to_xml
+    end
+    return xml
   end
 
   # Expose the entire document
   def document
-    return TypeElement.new({name: 'document', content: @document})
+    return TypeElement.new({name: 'document', content: @document}, main_element: self)
+  end
+
+  # update content from a subsequent element
+  def update_content key, content
+    # byebug
+    # @document = content.to_hash
+    # upd = false
+    # @document.each do |e|
+    #   byebug
+    #   if e[:name] == key
+    #     upd = true
+    #     content.each do |k,v|
+    #       e[k] = v
+    #     end
+    #     break
+    #   end
+    # end
+    #
+    # unless upd
+    #   @document << content
+    # end
+    # if @document[key].nil?
+    #   @document[key] = content
+    # else
+    #   unless @document[key].class = Array
+    #     @document[key] = [@document[key]]
+    #   end
+    #   @document[key] << content.to_hash
+    # end
+
   end
 
   # Print the entire document tree. For debug purposes
   def tree attributes: false
-    self.document.__tree attributes
+    self.document.__tree attributes: attributes
   end
 
   private
@@ -105,7 +149,8 @@ class Extreml
         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 = 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],
@@ -127,7 +172,7 @@ class Extreml
         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 = 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],
@@ -151,3 +196,7 @@ class Extreml
   end
 
 end
+
+
+require 'extreml/type_element'
+require 'extreml/xml_header'

data/lib/extreml/type_element.rb

@@ -21,10 +21,11 @@
 # SOFTWARE.
 
 require 'pp'
+require 'json'
 
-class TypeElement
+class Extreml::TypeElement
 
-  def initialize document
+  def initialize document = nil, main_element: nil
 
     # document model:
     #
@@ -49,6 +50,7 @@ class TypeElement
     @attributes = document[:attributes]
     @content = document[:content]
     @types = Array.new
+    @main_element = main_element
 
     # Add a type for every element in content
     unless @content.nil?
@@ -101,14 +103,33 @@ class TypeElement
     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)]
+        content = [array].flatten + [(content.class == Hash ? (Extreml::TypeElement.new content, main_element: self) : content)]
+        case content.length
+        when 0
+          return nil
+        when 1
+          return content[0]
+        else
+          return content
+        end
       end
     else
       define_singleton_method name.to_sym do
         if content.class == Hash
-          return TypeElement.new content
+          return Extreml::TypeElement.new content, main_element: self
         else
-          return content
+          if content.class == Array
+            case content.length
+            when 0
+              return nil
+            when 1
+              return content[0]
+            else
+              return content
+            end
+          else
+            return content
+          end
         end
       end
       @types << name.to_sym
@@ -117,12 +138,102 @@ class TypeElement
   end
   alias __add_type add_type
 
+  def add_new_type name, content
+
+    self.__add_type name, {name: name, namespace: nil, attributes: [], content: [content].flatten}
+    self.__update_content name, content
+    
+  end
+  alias __add_new_type add_new_type
+
+  # update content from a subsequent element
+  # recursively call update on main_element
+  def update_content name, content
+
+    @content << {name: name, namespace: nil, attributes: [], content: [content].flatten}
+
+    unless @main_element.nil?
+      @main_element.update_content @name, self
+    end
+
+  end
+  alias __update_content update_content
+
   # 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
 
+  # Returns the document in XML format
+  def to_xml level = 0
+    xml = ''
+    xml += "#{' ' * level}<#{@namespace.nil? ? '' : "#{@namespace}:"}#{@name}"
+    unless @attributes.nil?
+      @attributes.each do |a|
+        xml += " #{a[:namespace].nil? ? '' : "#{a[:namespace]}:"}#{a[:property]}=\"#{a[:value]}\""
+      end
+    end
+    if @content.nil?
+      xml += "/>"
+    else
+      xml += ">"
+      if @types.empty?
+        xml += "#{@content.join}"
+      else
+        @types.each do |t|
+          content = self.send(t)
+          if content.class == Array
+            content.each do |c|
+              xml += "\n#{c.to_xml (level + 1)}"
+            end
+          else
+            xml += "\n#{content.to_xml (level + 1)}"
+          end
+        end
+      end
+      xml += "#{@types.empty? ? '' : "\n#{' ' * level}"}</#{@namespace.nil? ? '' : "#{@namespace}:"}#{@name}>"
+    end
+    return xml
+  end
+  alias __to_xml to_xml
+
+  # Returns the document in JSON format
+  def to_json
+    return self.to_hash.to_json
+  end
+  alias __to_json to_json
+
+  # Returns a hash of the document
+  def to_hash
+    hash = Hash.new
+    hash = {
+      namespace: @namespace,
+      attributes: @attributes
+    }
+    if @types.empty?
+      hash[:content] = @content
+    else
+      @types.each do |t|
+        obj = self.send(t)
+        if obj.class == Array
+          hash[t] = Array.new
+          obj.each do |o|
+            hash[t] << o.to_hash
+          end
+        else
+          if obj.class == Extreml::TypeElement
+            hash[t] = obj.to_hash
+          else
+            hash[t] = obj
+          end
+        end
+      end
+    end
+    return hash
+  end
+  alias __to_hash to_hash
+
   # This method is for debug purposes only, it prints a tree of the document
   def tree level: 0, attributes: false
 

data/lib/extreml/xml_header.rb

@@ -0,0 +1,65 @@
+# 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.
+
+# Exposes the xml header properties as methods
+class Extreml::XmlHeader
+
+  # Initialize
+  #
+  # @param header [Hash|String] the header.
+  # @return [XmlHeader] the object.
+  def initialize header = nil
+    if header.nil?
+      h = [
+        ["version",1.0],
+        ["encoding","UTF-8"]
+      ]
+    else
+      h = header.scan /([\w\?\<]*)=["|']([^'"]*)["|']/
+    end
+    if h.empty?
+      @attributes = nil
+    else
+      @attributes = Array.new
+      h.each do |param|
+        @attributes << param[0].to_sym
+        define_singleton_method param[0].to_sym do
+          return param[1]
+        end
+      end
+    end
+  end
+
+  def to_xml
+    if @attributes.nil?
+      header = ''
+    else
+      header = '<?xml'
+      @attributes.each do |a|
+        header += " #{a.to_s}=\"#{self.send(a)}\""
+      end
+      header += '?>'
+    end
+
+    return header
+  end
+end

metadata

@@ -1,18 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: extreml
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Fabio Boccacini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-09 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies: []
 description: |-
-  This gem allows to read an XML file and access its elements using methods named after the tags./
-      See <a href="https://github.com/fboccacini/extreml">https://github.com/fboccacini/extreml</a> for reference and usage.
+  This gem allows to read an XML/Json file or string and access its elements using methods named after the tags.
+      Also there are methods to return the object as an Hash or XML/Json string.
+      See https://github.com/fboccacini/extreml for reference and usage.
 email: fboccacini@gmail.com
 executables: []
 extensions: []
@@ -20,6 +21,7 @@ extra_rdoc_files: []
 files:
 - lib/extreml.rb
 - lib/extreml/type_element.rb
+- lib/extreml/xml_header.rb
 homepage: https://github.com/fboccacini/extreml
 licenses:
 - MIT