ruby3mf 0.2.6 → 0.2.7

data/lib/ruby3mf/log3mf.rb

@@ -1,135 +1,135 @@
-require 'singleton'
-require 'yaml'
-
-# Example usage:
-
-# Log3mf.context "box.3mf" do |l|
-#   --do some stuff here
-
-#   l.context "[Content-Types].xml" do |l|
-#     -- try to parse file. if fail...
-#     l.log(:fatal_error, "couldn't parse XML") <<<--- THIS WILL GENERATE FATAL ERROR EXCEPTION
-#   end
-
-#   l.context "examing Relations" do |l|
-#     l.log(:error, "a non-fatal error")
-#     l.log(:warning, "a warning")
-#     l.log(:info, "it is warm today")
-#   end
-# end
-#
-# Log3mf.to_json
-
-
-class Log3mf
-  include Singleton
-  include Interpolation
-
-  LOG_LEVELS = [:fatal_error, :error, :warning, :info, :debug]
-
-  SPEC_LINKS = {
-    core: 'http://3mf.io/wp-content/uploads/2016/03/3MFcoreSpec_1.1.pdf',
-    material: 'http://3mf.io/wp-content/uploads/2015/04/3MFmaterialsSpec_1.0.1.pdf',
-    production: 'http://3mf.io/wp-content/uploads/2016/07/3MFproductionSpec.pdf',
-    slice: 'http://3mf.io/wp-content/uploads/2016/07/3MFsliceSpec.pdf',
-    #opc: 'http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-376,%20Fourth%20Edition,%20Part%202%20-%20Open%20Packaging%20Conventions.zip'
-    opc: 'http://3mf.io/wp-content/uploads/2016/03/3MFcoreSpec_1.1.pdf'
-  }.freeze
-
-  # Allows us to throw FatalErrors if we ever get errors of severity :fatal_error
-  class FatalError < RuntimeError
-  end
-
-  def initialize
-    @log_list = []
-    @context_stack = []
-    @ledger = []
-    errormap_path = File.join(File.dirname(__FILE__), "errors.yml")
-    @errormap = YAML.load_file(errormap_path)
-  end
-
-  def reset_log
-    @log_list = []
-    @context_stack = []
-  end
-
-  def self.reset_log
-    Log3mf.instance.reset_log
-  end
-
-  def context (context_description, &block)
-    @context_stack.push(context_description)
-    retval = block.call(Log3mf.instance)
-    @context_stack.pop
-    retval
-  end
-
-  def self.context(context_description, &block)
-    Log3mf.instance.context(context_description, &block)
-  end
-
-  def method_missing(name, *args, &block)
-    if LOG_LEVELS.include? name.to_sym
-      if [:fatal_error, :error, :debug].include? name.to_sym
-        linenumber = caller_locations[0].to_s.split('/')[-1].split(':')[-2].to_s
-        filename = caller_locations[0].to_s.split('/')[-1].split(':')[0].to_s
-        options = {linenumber: linenumber, filename: filename}
-        # Mike: do not call error or fatal_error without an entry in errors.yml
-        raise "{fatal_}error called WITHOUT using error symbol from: #{filename}:#{linenumber}" if ( !(args[0].is_a? Symbol) && (name.to_sym != :debug) )
-
-        puts "***** Log3mf.#{name} called from #{filename}:#{linenumber} *****" if $DEBUG
-
-        options = options.merge(args[1]) if args[1]
-        log(name.to_sym, args[0], options)
-      else
-        log(name.to_sym, *args)
-      end
-    else
-      super
-    end
-  end
-
-  def log(severity, message, options = {})
-    error = @errormap.fetch(message.to_s) { {"msg" => message.to_s, "page" => nil} }
-    options[:page] = error["page"] unless options[:page]
-    options[:spec] = error["spec"] unless options[:spec]
-    entry = {id: message,
-             context: "#{@context_stack.join("/")}",
-             severity: severity,
-             message: interpolate(error["msg"], options)}
-    entry[:spec_ref] = spec_link(options[:spec], options[:page]) if (options && options[:page])
-    entry[:caller] = "#{options[:filename]}:#{options[:linenumber]}" if (options && options[:filename] && options[:linenumber])
-    @log_list << entry
-    raise FatalError if severity == :fatal_error
-  end
-
-  def count_entries(*levels)
-    entries(*levels).count
-  end
-
-  def self.count_entries(*l)
-    Log3mf.instance.count_entries(*l)
-  end
-
-  def entries(*levels)
-    return @log_list if levels.size == 0
-    @log_list.select { |i| levels.include? i[:severity] }
-  end
-
-  def self.entries(*l)
-    Log3mf.instance.entries(*l)
-  end
-
-  def spec_link(spec, page)
-    spec = :core unless spec
-    "#{SPEC_LINKS[spec]}#page=#{page}"
-  end
-
-  def to_json
-    @log_list.to_json
-  end
-
-  def self.to_json
-    Log3mf.instance.to_json
-  end
-end
+require 'singleton'
+require 'yaml'
+
+# Example usage:
+
+# Log3mf.context "box.3mf" do |l|
+#   --do some stuff here
+
+#   l.context "[Content-Types].xml" do |l|
+#     -- try to parse file. if fail...
+#     l.log(:fatal_error, "couldn't parse XML") <<<--- THIS WILL GENERATE FATAL ERROR EXCEPTION
+#   end
+
+#   l.context "examing Relations" do |l|
+#     l.log(:error, "a non-fatal error")
+#     l.log(:warning, "a warning")
+#     l.log(:info, "it is warm today")
+#   end
+# end
+#
+# Log3mf.to_json
+
+
+class Log3mf
+  include Singleton
+  include Interpolation
+
+  LOG_LEVELS = [:fatal_error, :error, :warning, :info, :debug]
+
+  SPEC_LINKS = {
+    core: 'http://3mf.io/wp-content/uploads/2016/03/3MFcoreSpec_1.1.pdf',
+    material: 'http://3mf.io/wp-content/uploads/2015/04/3MFmaterialsSpec_1.0.1.pdf',
+    production: 'http://3mf.io/wp-content/uploads/2016/07/3MFproductionSpec.pdf',
+    slice: 'http://3mf.io/wp-content/uploads/2016/07/3MFsliceSpec.pdf',
+    #opc: 'http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-376,%20Fourth%20Edition,%20Part%202%20-%20Open%20Packaging%20Conventions.zip'
+    opc: 'http://3mf.io/wp-content/uploads/2016/03/3MFcoreSpec_1.1.pdf'
+  }.freeze
+
+  # Allows us to throw FatalErrors if we ever get errors of severity :fatal_error
+  class FatalError < RuntimeError
+  end
+
+  def initialize
+    @log_list = []
+    @context_stack = []
+    @ledger = []
+    errormap_path = File.join(File.dirname(__FILE__), "errors.yml")
+    @errormap = YAML.load_file(errormap_path)
+  end
+
+  def reset_log
+    @log_list = []
+    @context_stack = []
+  end
+
+  def self.reset_log
+    Log3mf.instance.reset_log
+  end
+
+  def context (context_description, &block)
+    @context_stack.push(context_description)
+    retval = block.call(Log3mf.instance)
+    @context_stack.pop
+    retval
+  end
+
+  def self.context(context_description, &block)
+    Log3mf.instance.context(context_description, &block)
+  end
+
+  def method_missing(name, *args, &block)
+    if LOG_LEVELS.include? name.to_sym
+      if [:fatal_error, :error, :debug].include? name.to_sym
+        linenumber = caller_locations[0].to_s.split('/')[-1].split(':')[-2].to_s
+        filename = caller_locations[0].to_s.split('/')[-1].split(':')[0].to_s
+        options = {linenumber: linenumber, filename: filename}
+        # Mike: do not call error or fatal_error without an entry in errors.yml
+        raise "{fatal_}error called WITHOUT using error symbol from: #{filename}:#{linenumber}" if ( !(args[0].is_a? Symbol) && (name.to_sym != :debug) )
+
+        puts "***** Log3mf.#{name} called from #{filename}:#{linenumber} *****" if $DEBUG
+
+        options = options.merge(args[1]) if args[1]
+        log(name.to_sym, args[0], options)
+      else
+        log(name.to_sym, *args)
+      end
+    else
+      super
+    end
+  end
+
+  def log(severity, message, options = {})
+    error = @errormap.fetch(message.to_s) { {"msg" => message.to_s, "page" => nil} }
+    options[:page] = error["page"] unless options[:page]
+    options[:spec] = error["spec"] unless options[:spec]
+    entry = {id: message,
+             context: "#{@context_stack.join("/")}",
+             severity: severity,
+             message: interpolate(error["msg"], options)}
+    entry[:spec_ref] = spec_link(options[:spec], options[:page]) if (options && options[:page])
+    entry[:caller] = "#{options[:filename]}:#{options[:linenumber]}" if (options && options[:filename] && options[:linenumber])
+    @log_list << entry
+    raise FatalError if severity == :fatal_error
+  end
+
+  def count_entries(*levels)
+    entries(*levels).count
+  end
+
+  def self.count_entries(*l)
+    Log3mf.instance.count_entries(*l)
+  end
+
+  def entries(*levels)
+    return @log_list if levels.size == 0
+    @log_list.select { |i| levels.include? i[:severity] }
+  end
+
+  def self.entries(*l)
+    Log3mf.instance.entries(*l)
+  end
+
+  def spec_link(spec, page)
+    spec = :core unless spec
+    "#{SPEC_LINKS[spec]}#page=#{page}"
+  end
+
+  def to_json
+    @log_list.to_json
+  end
+
+  def self.to_json
+    Log3mf.instance.to_json
+  end
+end

data/lib/ruby3mf/mesh_analyzer.rb

@@ -1,80 +1,80 @@
-class MeshAnalyzer
-
-  def self.validate_object(object, includes_material)
-    Log3mf.context "verifying object" do |l|
-      children = object.children.map { |child| child.name }
-      have_override = object.attributes["pid"] or object.attributes["pindex"]
-      l.error :object_with_components_and_pid if have_override && children.include?("components")
-    end
-
-    Log3mf.context "validating geometry" do |l|
-      list = EdgeList.new
-
-      # if a triangle has a pid, then the object needs a pid
-      has_triangle_pid = false
-
-      meshs = object.css('mesh')
-      meshs.each do |mesh|
-
-        num_vertices = mesh.css("vertex").count
-        triangles = mesh.css("triangle")
-        l.error :not_enough_triangles if triangles.count < 4
-
-        if triangles
-          triangles.each do |triangle|
-
-            v1 = triangle.attributes["v1"].to_s.to_i
-            v2 = triangle.attributes["v2"].to_s.to_i
-            v3 = triangle.attributes["v3"].to_s.to_i
-
-            l.error :invalid_vertex_index if [v1, v2, v3].select{|vertex| vertex >= num_vertices}.count > 0
-
-            unless includes_material
-              l.context "validating property overrides" do |l|
-                property_overrides = []
-                property_overrides << triangle.attributes['p1'].to_s.to_i if triangle.attributes['p1']
-                property_overrides << triangle.attributes['p2'].to_s.to_i if triangle.attributes['p2']
-                property_overrides << triangle.attributes['p3'].to_s.to_i if triangle.attributes['p3']
-
-                property_overrides.reject! { |prop| prop.nil? }
-                l.error :has_base_materials_gradient unless property_overrides.uniq.size <= 1
-              end
-            end
-
-            if v1 == v2 || v2 == v3 || v3 == v1
-              l.error :non_distinct_indices
-            end
-
-            list.add_edge(v1, v2)
-            list.add_edge(v2, v3)
-            list.add_edge(v3, v1)
-            unless has_triangle_pid
-              has_triangle_pid = triangle.attributes["pid"] != nil
-            end
-          end
-
-          if has_triangle_pid && !(object.attributes["pindex"] && object.attributes["pid"])
-            l.error :missing_object_pid
-          end
-
-          result = list.verify_edges
-          if result == :bad_orientation
-            l.error :resource_3dmodel_orientation
-          elsif result == :hole
-            l.error :resource_3dmodel_hole
-          elsif result == :nonmanifold
-            l.error :resource_3dmodel_nonmanifold
-          end
-
-        end
-      end
-    end
-  end
-
-  def self.validate(model_doc, includes_material)
-    model_doc.css('model/resources/object').select { |object| ['model', 'solidsupport', ''].include?(object.attributes['type'].to_s) }.each do |object|
-      validate_object(object, includes_material)
-    end
-  end
-
-end
+class MeshAnalyzer
+
+  def self.validate_object(object, includes_material)
+    Log3mf.context "verifying object" do |l|
+      children = object.children.map { |child| child.name }
+      have_override = object.attributes["pid"] or object.attributes["pindex"]
+      l.error :object_with_components_and_pid if have_override && children.include?("components")
+    end
+
+    Log3mf.context "validating geometry" do |l|
+      list = EdgeList.new
+
+      # if a triangle has a pid, then the object needs a pid
+      has_triangle_pid = false
+
+      meshs = object.css('mesh')
+      meshs.each do |mesh|
+
+        num_vertices = mesh.css("vertex").count
+        triangles = mesh.css("triangle")
+        l.error :not_enough_triangles if triangles.count < 4
+
+        if triangles
+          triangles.each do |triangle|
+
+            v1 = triangle.attributes["v1"].to_s.to_i
+            v2 = triangle.attributes["v2"].to_s.to_i
+            v3 = triangle.attributes["v3"].to_s.to_i
+
+            l.error :invalid_vertex_index if [v1, v2, v3].select{|vertex| vertex >= num_vertices}.count > 0
+
+            unless includes_material
+              l.context "validating property overrides" do |l|
+                property_overrides = []
+                property_overrides << triangle.attributes['p1'].to_s.to_i if triangle.attributes['p1']
+                property_overrides << triangle.attributes['p2'].to_s.to_i if triangle.attributes['p2']
+                property_overrides << triangle.attributes['p3'].to_s.to_i if triangle.attributes['p3']
+
+                property_overrides.reject! { |prop| prop.nil? }
+                l.error :has_base_materials_gradient unless property_overrides.uniq.size <= 1
+              end
+            end
+
+            if v1 == v2 || v2 == v3 || v3 == v1
+              l.error :non_distinct_indices
+            end
+
+            list.add_edge(v1, v2)
+            list.add_edge(v2, v3)
+            list.add_edge(v3, v1)
+            unless has_triangle_pid
+              has_triangle_pid = triangle.attributes["pid"] != nil
+            end
+          end
+
+          if has_triangle_pid && !(object.attributes["pindex"] && object.attributes["pid"])
+            l.error :missing_object_pid
+          end
+
+          result = list.verify_edges
+          if result == :bad_orientation
+            l.error :resource_3dmodel_orientation
+          elsif result == :hole
+            l.error :resource_3dmodel_hole
+          elsif result == :nonmanifold
+            l.error :resource_3dmodel_nonmanifold
+          end
+
+        end
+      end
+    end
+  end
+
+  def self.validate(model_doc, includes_material)
+    model_doc.css('model/resources/object').select { |object| ['model', 'solidsupport', ''].include?(object.attributes['type'].to_s) }.each do |object|
+      validate_object(object, includes_material)
+    end
+  end
+
+end