treat 0.2.5 → 1.0.0

data/lib/treat/formatters/unserializers/xml.rb

@@ -1,112 +1,107 @@
-module Treat
-  module Formatters
-    module Unserializers
-      # Recreates the entity tree corresponding to
-      # a serialized XML file.
-      class XML
-        require 'nokogiri'
-        # Unserialize an entity stored in XML format.
-        #
-        # Options: none.
-        def self.unserialize(document, options = {})
-          # Read in the XML file.
-          xml = File.read(document.file)
-          xml.gsub!('<treat>', '')
-          xml.gsub!('</treat>', '')
-          xml_reader = Nokogiri::XML::Reader.from_memory(xml)
-          current_element = nil
-          previous_depth = 0
+# Recreates the entity tree corresponding to
+# a serialized XML file.
+module Treat::Formatters::Unserializers::XML
 
-          # Read the XML file entity by entity.
-          while xml_reader.read
-            # The depth in the XML tree.
-            current_depth = xml_reader.depth
-            # If we are at the end of the children stack, pop up.
-            if previous_depth > current_depth && current_depth != 0
-              current_element = current_element.parent
-            end
-            # If an end element has been reached,
-            # change the depth and pop up on next
-            # iteration.
-            if xml_reader.node_type ==
-              Nokogiri::XML::Reader::TYPE_END_ELEMENT
-              previous_depth = current_depth
-              next
-            end
+  require 'nokogiri'
+  
+  # Unserialize an entity stored in XML format.
+  #
+  # Options: none.
+  def self.unserialize(document, options = {})
+    # Read in the XML file.
+    xml = File.read(document.file)
+    xml.gsub!('<treat>', '')
+    xml.gsub!('</treat>', '')
+    xml_reader = Nokogiri::XML::Reader.from_memory(xml)
+    current_element = nil
+    previous_depth = 0
 
-            id = nil; value = ''
-            attributes = {}
-            dependencies = []
-            unless xml_reader.attributes.size == 0
-              xml_reader.attributes.each_pair do |k,v|
-                if k == 'id'
-                  id = v.to_i
-                elsif k == 'dependencies'
-                  a = v.split('--')
-                  a.each do |b|
-                    c = b.split(';')
-                    c.each do |dep|
-                      vals = []
-                      dep.split(',').each do |name_val|
-                        name_val = name_val[0..-2] if name_val[-1] == '}'
-                        d =  name_val.split(':')[1]
-                        vals << d.strip if d
-                      end
-                      
-                      target, type, directed, direction = *vals
-                      dependencies << [
-                          target.to_i, 
-                          type,
-                          (directed == 'true' ? true : false),
-                          direction.to_i
-                      ]
-                    end
-                  end
-                elsif k == 'value'
-                  value = v
-                else
-                  attributes[k.intern] = v
-                end
-              end
-            end
+    # Read the XML file entity by entity.
+    while xml_reader.read
+      # The depth in the XML tree.
+      current_depth = xml_reader.depth
+      # If we are at the end of the children stack, pop up.
+      if previous_depth > current_depth && current_depth != 0
+        current_element = current_element.parent
+      end
+      # If an end element has been reached,
+      # change the depth and pop up on next
+      # iteration.
+      if xml_reader.node_type ==
+        Nokogiri::XML::Reader::TYPE_END_ELEMENT
+        previous_depth = current_depth
+        next
+      end
 
-            current_value = ''
-            type = xml_reader.name.intern
+      id = nil; value = ''
+      attributes = {}
+      dependencies = []
+      unless xml_reader.attributes.size == 0
+        xml_reader.attributes.each_pair do |k,v|
+          if k == 'id'
+            id = v.to_i
+          elsif k == 'dependencies'
+            a = v.split('--')
+            a.each do |b|
+              c = b.split(';')
+              c.each do |dep|
+                vals = []
+                dep.split(',').each do |name_val|
+                  name_val = name_val[0..-2] if name_val[-1] == '}'
+                  d =  name_val.split(':')[1]
+                  vals << d.strip if d
+                end
 
-            if Treat::Entities.list.include?(type)
-              if !current_element
-                current_element = self.revive(type, current_value, id)
-              else
-                current_element = current_element <<
-                self.revive(type, current_value, id)
-              end
-              current_element.features = attributes
-              current_element.features = attributes
-              dependencies.each do |dependency|
-                target, type, directed, direction = *dependency
-                current_element.link(target, type, directed, direction)
-              end
-            else
-              current_value = xml_reader.value ?
-              xml_reader.value.strip : ''
-              if current_value && current_value != ''
-                current_element.value = current_value
-                current_element.register_token(current_element)
+                target, type, directed, direction = *vals
+                dependencies << [
+                  target.to_i,
+                  type,
+                  (directed == 'true' ? true : false),
+                  direction.to_i
+                ]
               end
             end
-
-            previous_depth = current_depth
+          elsif k == 'value'
+            value = v
+          else
+            attributes[k.intern] = v
           end
-          document << current_element
-          document
         end
+      end
 
-        def self.revive(type, value, id)
-          klass = Treat::Entities.const_get(cc(type))
-          klass.new(value, id)
-        end
+      current_value = ''
+      type = xml_reader.name.intern
 
+      if Treat::Entities.list.include?(type)
+        if !current_element
+          current_element = self.revive(type, current_value, id)
+        else
+          current_element = current_element <<
+          self.revive(type, current_value, id)
+        end
+        current_element.features = attributes
+        current_element.features = attributes
+        dependencies.each do |dependency|
+          target, type, directed, direction = *dependency
+          current_element.link(target, type, directed, direction)
+        end
+      else
+        current_value = xml_reader.value ?
+        xml_reader.value.strip : ''
+        if current_value && current_value != ''
+          current_element.value = current_value
+        end
       end
+
+      previous_depth = current_depth
     end
+    document << current_element
+    document
   end
-end
+
+  def self.revive(type, value, id)
+    klass = Treat::Entities.const_get(cc(type))
+    klass.new(value, id)
+  end
+
+end

data/lib/treat/formatters/unserializers/yaml.rb

@@ -1,21 +1,22 @@
-module Treat
-  module Formatters
-    module Unserializers
-      # This class is a wrapper for the Psych YAML
-      # parser; it unserializes YAML files.
-      class YAML
-        # Require the Psych YAML parser.
-        require 'psych'
-        # Require date to revive DateTime.
-        require 'date'
-        # Unserialize a YAML file.
-        # 
-        # Options: none.
-        def self.unserialize(document, options = {})
-          document << ::Psych.load(File.read(document.file))
-          document
-        end
-      end
-    end
+# This class is a wrapper for the Psych YAML
+# parser; it unserializes YAML files.
+class Treat::Formatters::Unserializers::YAML
+
+  silence_warnings do
+    # Require the Psych YAML parser.
+    require 'psych'
   end
+  
+  # Require date to revive DateTime.
+  require 'date'
+
+  # Unserialize a YAML file.
+  #
+  # Options: none.
+  def self.unserialize(document, options = {})
+    document << ::Psych.load(
+    File.read(document.file))
+    document
+  end
+
 end

data/lib/treat/formatters/visualizers/dot.rb

@@ -1,141 +1,141 @@
-module Treat
-  module Formatters
-    module Visualizers
-      class Dot
-        require 'date'
-        DefaultOptions = {
-          :colors => {}, 
-          :features => :all, 
-          :file => nil,
-          :remove_types => [],
-          :remove_features => [],
-          :colors => nil,
-          :first => true # For internal purposes only.
-        }
-        # Create the top-most graph structure
-        # and delegate the creation of the graph
-        # nodes to to_dot.
-        def self.visualize(entity, options = {})
-          options = DefaultOptions.merge(options)
-          string = "graph {"
-          string << self.to_dot(entity, options)
-          string << "\n}"
-          if options[:file]
-            File.open(options[:file], 'w') { |f| f.write(string) }
-          end
-          string
-        end
-        # dot -Tpdf test4.dot > test4.pdf
-        def self.to_dot(entity, options)
-          # Filter out specified types.
-          match_types = lambda do |t1, t2s|
-            f = false
-            t2s.each { |t2| f = true if Treat::Entities.match_types[t1][t2] }
-            f
-          end
-          return '' if match_types.call(entity.type, options[:remove_types])
-          # Id
-          string = ''
-          label = ''
-          sv = entity.short_value.inspect[1..-2]
-          string = "\n#{entity.id} ["
-          label = "#{entity.type.to_s.capitalize}\\n\\\"#{sv}\\\""
-          label.gsub!(' [...]', " [...] \\n")
-          # Features
-          if entity.has_features?
-            unless options[:features] == :none
-              label << "\\n"
-              entity.features.each do |feature, value|
-                next if options[:remove_features].include?(feature)
-                if options[:features] == :all ||
-                  options[:features].include?(feature)
-                  if value.is_a?(Treat::Entities::Entity)
-                    label << "\\n#{feature}:  \\\"*#{value.id}\\\""
-                  elsif value.is_a?(Struct)
-                    label << "\\n#{feature}: \\n\{ "
-                    value.members.each do |member|
-                      v = value.send(member)
-                      v = v.to_s if v.is_a?(DateTime)
-                      v = "*#{v.id}" if v.is_a?(Treat::Entities::Entity)
-                      v = v ? v.inspect : ' -- '
-                      v.gsub!('[', '\[')
-                      v.gsub!('{', '\}')
-                      v.gsub!(']', '\]')
-                      v.gsub!('}', '\}')
-                      v.gsub!('"', '\"')
-                      label <<  "#{member}: #{v},\\n"
-                    end
-                     label = label[0..-4] unless label[-2] == '{'
-                     label << "\},"
-                  elsif value.is_a?(Hash)
-                    label << "\\n#{feature}: \\n\{ "
-                    value.each do |k,v|
-                      v = v ? v.inspect : ' -- '
-                      v.gsub!('[', '\[')
-                      v.gsub!('{', '\}')
-                      v.gsub!(']', '\]')
-                      v.gsub!('}', '\}')
-                      v.gsub!('"', '\"')
-                      label <<  "#{k}: #{v},\\n"
-                    end
-                    label = label[0..-4] unless label[-2] == '{'
-                    label << "\},"
-                  elsif value.is_a?(Array)
-                    label << "\\n#{feature}: \\n\[ "
-                    value.each do |e|
-                      e = "*#{e.id}" if e.is_a?(Treat::Entities::Entity)
-                      label << "#{e},\\n"
-                    end
-                    label = label[0..-4] unless label[-2] == '['
-                    label << " \]"
-                  else
-                    label << "\\n#{feature}:  \\\"#{value}\\\""
-                  end
-                end
+class Treat::Formatters::Visualizers::DOT
+
+  require 'date'
+  DefaultOptions = {
+    :colors => {},
+    :features => :all,
+    :file => nil,
+    :remove_types => [],
+    :remove_features => [],
+    :colors => nil,
+    :first => true # For internal purposes only.
+  }
+  # Create the top-most graph structure
+  # and delegate the creation of the graph
+  # nodes to to_dot.
+  def self.visualize(entity, options = {})
+    options = DefaultOptions.merge(options)
+    string = "graph {"
+    string << self.to_dot(entity, options)
+    string << "\n}"
+    if options[:file]
+      File.open(options[:file], 'w') { |f| f.write(string) }
+    end
+    string
+  end
+  # dot -Tpdf test4.dot > test4.pdf
+  def self.to_dot(entity, options)
+    # Filter out specified types.
+    match_types = lambda do |t1, t2s|
+      f = false
+      t2s.each { |t2| f = true if Treat::Entities.match_types[t1][t2] }
+      f
+    end
+    return '' if match_types.call(entity.type, options[:remove_types])
+    # Id
+    string = ''
+    label = ''
+    sv = entity.short_value.inspect[1..-2]
+    string = "\n#{entity.id} ["
+    label = "#{entity.type.to_s.capitalize}\\n\\\"#{sv}\\\""
+    label.gsub!(' [...]', " [...] \\n")
+    # Features
+    if entity.has_features?
+      unless options[:features] == :none
+        label << "\\n"
+        entity.features.each do |feature, value|
+          next if options[:remove_features].include?(feature)
+          if options[:features] == :all ||
+            options[:features].include?(feature)
+            if value.is_a?(Treat::Entities::Entity)
+              label << "\\n#{feature}:  \\\"*#{value.id}\\\""
+            elsif value.is_a?(Struct)
+              label << "\\n#{feature}: \\n\{ "
+              value.members.each do |member|
+                v = value.send(member)
+                v = v.to_s if v.is_a?(DateTime)
+                v = "*#{v.id}" if v.is_a?(Treat::Entities::Entity)
+                v = v ? v.inspect : ' -- '
+                v = escape(v)
+                label <<  "#{member}: #{v},\\n"
               end
-            end
-          end
-          color = nil
-          if options[:colors]
-            options[:colors].each do |col, lambda|
-              color = col.to_s if lambda.call(entity)
-              break if color
-            end
-          end
-          label = label[0..-2] if label[-1] == ','
-          string << "label=\"#{label}\",color=\"#{color.to_s}\"]"
-          string.gsub!('\\\\""]', '\\""]')
-          string.gsub('\"\""]', '\""]')
-          # Parent-child relationships.
-          if entity.has_parent?
-            unless options[:first] == true
-              string << "\n#{entity.parent.id} -- #{entity.id};" 
-            end
-          end
-          # Dependencies.
-          if entity.has_dependencies?
-            entity.dependencies.each do |dependency|
-              dir = ''
-              if dependency.directed == true
-                dir = dependency.direction == 1 ? 'forward' : 'back'
-                dir = ",dir=#{dir}"
-              else
-                dir = ",dir=both"
+              label = label[0..-4] unless label[-2] == '{'
+              label << "\},"
+            elsif value.is_a?(Hash)
+              label << "\\n#{feature}: \\n\{ "
+              value.each do |k,v|
+                v = v ? v.inspect : ' -- '
+                v = escape(v)
+                label <<  "#{k}: #{v},\\n"
               end
-              string << "\n#{entity.id} -- #{dependency.target}"
-              string << "[label=#{dependency.type}#{dir}]"
-            end
-          end
-          # Recurse.
-          options[:first] = false
-          if entity.has_children?
-            entity.each do |child|
-              string << self.to_dot(child, options)
+              label = label[0..-4] unless label[-2] == '{'
+              label << "\},"
+            elsif value.is_a?(Array)
+              label << "\\n#{feature}: \\n\[ "
+              value.each do |e|
+                if e.is_a?(Treat::Entities::Entity)
+                  v = escape("*#{e.id}")
+                else
+                  v = escape(e.inspect)
+                end
+                label << "#{v},\\n"
+              end
+              label = label[0..-4] unless label[-2] == '['
+              label << " \]"
+            else
+              label << "\\n#{feature}:  \\\"#{value}\\\""
             end
           end
-          string
         end
       end
     end
+    color = nil
+    if options[:colors]
+      options[:colors].each do |col, lambda|
+        color = col.to_s if lambda.call(entity)
+        break if color
+      end
+    end
+    label = label[0..-2] if label[-1] == ','
+    string << "label=\"#{label}\",color=\"#{color.to_s}\"]"
+    string.gsub!('\\\\""]', '\\""]')
+    string.gsub('\"\""]', '\""]')
+    # Parent-child relationships.
+    if entity.has_parent?
+      unless options[:first] == true
+        string << "\n#{entity.parent.id} -- #{entity.id};"
+      end
+    end
+    # Dependencies.
+    if entity.has_dependencies?
+      entity.dependencies.each do |dependency|
+        dir = ''
+        if dependency.directed == true
+          dir = dependency.direction == 1 ? 'forward' : 'back'
+          dir = ",dir=#{dir}"
+        else
+          dir = ",dir=both"
+        end
+        string << "\n#{entity.id} -- #{dependency.target}"
+        string << "[label=#{dependency.type}#{dir}]"
+      end
+    end
+    # Recurse.
+    options[:first] = false
+    if entity.has_children?
+      entity.each do |child|
+        string << self.to_dot(child, options)
+      end
+    end
+    string
+  end
+
+  def self.escape(v)
+    v.gsub('[', '\[')
+    .gsub('{', '\}')
+    .gsub(']', '\]')
+    .gsub('}', '\}')
+    .gsub('"', '\"')
   end
+  
 end