ruby3mf 0.2.6 → 0.2.7

data/lib/ruby3mf/model3mf.rb

@@ -1,117 +1,120 @@
-class Model3mf
-
-  MATERIAL_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/material/2015/02'
-  SLICE_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/slice/2015/07'
-  PRODUCTION_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/production/2015/06'
-
-  VALID_EXTENSIONS = {
-      MATERIAL_EXTENSION => {},
-      SLICE_EXTENSION => {},
-      PRODUCTION_EXTENSION => {}
-  }.freeze
-
-  VALID_CORE_METADATA_NAMES = ['Title', 'Designer', 'Description', 'Copyright', 'LicenseTerms', 'Rating', 'CreationDate', 'ModificationDate'].freeze
-
-  def self.parse(document, zip_entry)
-    model_doc = nil
-
-    Log3mf.context "parsing model" do |l|
-      begin
-        model_doc = XmlVal.validate_parse(zip_entry, SchemaFiles::SchemaTemplate)
-      rescue Nokogiri::XML::SyntaxError => e
-        l.fatal_error :model_invalid_xml, e: e
-      end
-
-      l.context "verifying requiredextensions" do |l|
-        model_doc.css("//model").map{|node| node.attributes["requiredextensions"]}.compact.each do |required_extension|
-          required_extension.value.split(" ").each do |ns|
-            namespace_uri = model_doc.namespaces["xmlns:#{ns}"]
-            if namespace_uri
-              if VALID_EXTENSIONS.has_key? namespace_uri
-                l.info "Found a valid required extension: #{namespace_uri}"
-              else
-                l.error :unknown_required_extension, ext: namespace_uri
-              end
-            else
-              l.error :missing_extension_namespace_uri, ns: ns
-            end
-          end
-        end
-      end
-
-      l.context "verifying 3D payload required resources" do |l|
-        # results = model_doc.css("model resources m:texture2d")
-        required_resources = model_doc.css("//model//resources//*[path]").collect { |n| n["path"] }
-        required_resources += model_doc.css("//model//resources//object[thumbnail]").collect { |n| n["thumbnail"] }
-
-        # for each, ensure that they exist in m.relationships
-        relationship_resources = []
-        rel_file = "#{Pathname(zip_entry.name).dirname.to_s}/_rels/#{File.basename(zip_entry.name)}.rels"
-        relationships = document.relationships[rel_file]
-        unless (relationships.nil?)
-          relationship_resources = relationships.map { |relationship| relationship[:target] }
-        end
-
-        missing_resources = (required_resources - relationship_resources)
-        if missing_resources.empty?
-          l.info "All model required resources are defined in .rels relationship files."
-        else
-          missing_resources.each { |mr|
-            l.error :model_resource_not_in_rels, mr: mr
-          }
-        end
-
-      end
-
-      l.context 'verifying resources' do |l|
-        resources = model_doc.root.css("resources")
-        if resources
-          ids = resources.children.map { |child| child.attributes['id'].to_s if child.attributes['id'] }
-          l.error :resource_id_collision if ids.uniq.size != ids.size
-          pids = resources.children.map { |child| child.attributes['pid'].to_s }
-          missing_pids = pids.select { |pid| !pid.empty? and !ids.include? pid }
-          missing_pids.each do |p|
-            l.error :resource_pid_missing, pid: p
-          end
-        end
-      end
-
-      l.context "verifying build items" do |l|
-
-        l.error :build_with_other_item if model_doc.css('build/item').map { |x| x.attributes["objectid"].value }.map{ |id|  model_doc.search(".//xmlns:object[@id=$id][@type=$type]", nil, { :id => id, :type => 'other' } ) }.flatten.any?
-
-      end
-
-      l.context "checking metadata" do |l|
-        metadata_names = model_doc.root.css("metadata").map { |met| met['name'] }
-        l.error :metadata_elements_with_same_name unless metadata_names.uniq!.nil?
-
-        unless (metadata_names - VALID_CORE_METADATA_NAMES).empty?
-          extra_names = metadata_names - VALID_CORE_METADATA_NAMES
-          ns_names = extra_names.select { |n| n.include? ':' }
-
-          l.error :invalid_metadata_under_defaultns unless (extra_names - ns_names).empty?
-
-          unless ns_names.empty?
-            prefixes = model_doc.root.namespace_definitions.map { |defs| defs.prefix }.reject { |pre| pre.nil? }
-            l.error :invalid_metadata_name unless (ns_names.collect { |i| i.split(':').first } - prefixes).empty?
-          end
-        end
-      end
-
-      includes_material = model_doc.namespaces.values.include?(MATERIAL_EXTENSION)
-      MeshAnalyzer.validate(model_doc, includes_material)
-
-      l.context "verifying triangle normal" do |l|
-        model_doc.css('model/resources/object').select { |object| ['model', 'solidsupport', ''].include?(object.attributes['type'].to_s) }.each do |object|
-          meshes = object.css('mesh')
-          meshes.each do |mesh|
-            processor = MeshNormalAnalyzer.new(mesh)
-            l.error :inward_facing_normal if processor.found_inward_triangle
-          end
-        end
-      end
-    end
-    model_doc
-  end
-end
+class Model3mf
+
+  MATERIAL_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/material/2015/02'
+  SLICE_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/slice/2015/07'
+  PRODUCTION_EXTENSION = 'http://schemas.microsoft.com/3dmanufacturing/production/2015/06'
+
+  KNOWN_EXTENSIONS = {
+      MATERIAL_EXTENSION => {name: '3MF Materials and Properties Extension', supported: false},
+      SLICE_EXTENSION => {name: '3MF Slice Extension', supported: false},
+      PRODUCTION_EXTENSION => {name: '3MF Production Extension', supported: false}
+  }.freeze
+
+  VALID_CORE_METADATA_NAMES = ['Title', 'Designer', 'Description', 'Copyright', 'LicenseTerms', 'Rating', 'CreationDate', 'ModificationDate'].freeze
+
+  def self.parse(document, zip_entry)
+    model_doc = nil
+
+    Log3mf.context "parsing model" do |l|
+      begin
+        model_doc = XmlVal.validate_parse(zip_entry, SchemaFiles::SchemaTemplate)
+      rescue Nokogiri::XML::SyntaxError => e
+        l.fatal_error :model_invalid_xml, e: e
+      end
+
+      l.context "verifying supported extensions" do |l|
+        model_doc.css("//model").first.namespaces.each do |prefix, uri|
+          unless prefix == "xmlns"
+            ext = KNOWN_EXTENSIONS[uri]
+            if ext.nil? || !ext[:supported]
+              l.warning :unsupported_extension, ext: (ext.nil? ? uri : ext[:name])
+            end
+          end
+        end
+      end
+
+      l.context "verifying requiredextensions" do |l|
+        model_doc.css("//model").map{|node| node.attributes["requiredextensions"]}.compact.each do |required_extension|
+          required_extension.value.split(" ").each do |ns|
+            namespace_uri = model_doc.namespaces["xmlns:#{ns}"]
+            l.error :missing_extension_namespace_uri, ns: ns unless namespace_uri
+          end
+        end
+      end
+
+      l.context "verifying 3D payload required resources" do |l|
+        # results = model_doc.css("model resources m:texture2d")
+        required_resources = model_doc.css("//model//resources//*[path]").collect { |n| n["path"] }
+        required_resources += model_doc.css("//model//resources//object[thumbnail]").collect { |n| n["thumbnail"] }
+
+        # for each, ensure that they exist in m.relationships
+        relationship_resources = []
+        rel_file = "#{Pathname(zip_entry.name).dirname.to_s}/_rels/#{File.basename(zip_entry.name)}.rels"
+        relationships = document.relationships[rel_file]
+        unless (relationships.nil?)
+          relationship_resources = relationships.map { |relationship| relationship[:target] }
+        end
+
+        missing_resources = (required_resources - relationship_resources)
+        if missing_resources.empty?
+          l.info "All model required resources are defined in .rels relationship files."
+        else
+          missing_resources.each { |mr|
+            l.error :model_resource_not_in_rels, mr: mr
+          }
+        end
+
+      end
+
+      l.context 'verifying resources' do |l|
+        resources = model_doc.root.css("resources")
+        if resources
+          ids = resources.children.map { |child| child.attributes['id'].to_s if child.attributes['id'] }
+          l.error :resource_id_collision if ids.uniq.size != ids.size
+          pids = resources.children.map { |child| child.attributes['pid'].to_s }
+          missing_pids = pids.select { |pid| !pid.empty? and !ids.include? pid }
+          missing_pids.each do |p|
+            l.error :resource_pid_missing, pid: p
+          end
+        end
+      end
+
+      l.context "verifying build items" do |l|
+
+        l.error :build_with_other_item if model_doc.css('build/item').map { |x| x.attributes["objectid"].value }.map{ |id|  model_doc.search(".//xmlns:object[@id=$id][@type=$type]", nil, { :id => id, :type => 'other' } ) }.flatten.any?
+
+      end
+
+      l.context "checking metadata" do |l|
+        metadata_names = model_doc.root.css("metadata").map { |met| met['name'] }
+        l.error :metadata_elements_with_same_name unless metadata_names.uniq!.nil?
+
+        unless (metadata_names - VALID_CORE_METADATA_NAMES).empty?
+          extra_names = metadata_names - VALID_CORE_METADATA_NAMES
+          ns_names = extra_names.select { |n| n.include? ':' }
+
+          l.error :invalid_metadata_under_defaultns unless (extra_names - ns_names).empty?
+
+          unless ns_names.empty?
+            prefixes = model_doc.root.namespace_definitions.map { |defs| defs.prefix }.reject { |pre| pre.nil? }
+            l.error :invalid_metadata_name unless (ns_names.collect { |i| i.split(':').first } - prefixes).empty?
+          end
+        end
+      end
+
+      includes_material = model_doc.namespaces.values.include?(MATERIAL_EXTENSION)
+      MeshAnalyzer.validate(model_doc, includes_material)
+
+      l.context "verifying triangle normal" do |l|
+        model_doc.css('model/resources/object').select { |object| ['model', 'solidsupport', ''].include?(object.attributes['type'].to_s) }.each do |object|
+          meshes = object.css('mesh')
+          meshes.each do |mesh|
+            processor = MeshNormalAnalyzer.new(mesh)
+            l.error :inward_facing_normal if processor.found_inward_triangle
+          end
+        end
+      end
+    end
+    model_doc
+  end
+end

data/lib/ruby3mf/relationships.rb

@@ -1,50 +1,50 @@
-class Relationships
-
-  def self.parse(zip_entry)
-    relationships = []
-    Log3mf.context "parsing relationships" do |l|
-      begin
-        # Parse Relationships XML
-        doc = XmlVal.validate_parse(zip_entry)
-
-        # Verify <Relationships><Relationship/></Relationships>
-        root_element = doc.children[0]
-        if root_element.name == "Relationships"
-          relationship_elements = root_element.children
-          if relationship_elements.size > 0
-            relationship_elements.each do |node|
-              if node.is_a?(Nokogiri::XML::Element) && node.name == "Relationship"
-                l.error :multiple_relationships if (relationships.select { |r| r[:target] == node['Target'] && r[:type] == node['Type'] }.size > 0)
-                l.error :non_unique_rel_id, :file => zip_entry.name, :id => node['Id'] if (relationships.select { |r| r[:id] == node['Id'] }.size > 0)
-                relationships << {target: node['Target'], type: node['Type'], id: node['Id']}
-                l.info "adding relationship: #{relationships.last.inspect}"
-              else
-                unless node.is_a? Nokogiri::XML::Text
-                  l.info "found non-Relationship node: #{node.name}"
-                end
-              end
-            end
-
-            if zip_entry.name=="_rels/.rels"
-              l.context "Verifying StartPart" do |l|
-                start_part_type = Document::MODEL_TYPE
-                start_part_count = relationships.select { |r| r[:type] == start_part_type }.size
-                if start_part_count != 1
-                  l.error :invalid_startpart_type
-                end
-              end
-            end
-          else
-            l.error :dot_rels_file_no_relationship_element
-          end
-        else
-          l.error :dot_rels_file_missing_relationships_element
-        end
-
-      rescue Nokogiri::XML::SyntaxError => e
-        l.error :dot_rels_file_has_invalid_xml, e: "#{e.message}"
-      end
-    end
-    relationships
-  end
-end
+class Relationships
+
+  def self.parse(zip_entry)
+    relationships = []
+    Log3mf.context "parsing relationships" do |l|
+      begin
+        # Parse Relationships XML
+        doc = XmlVal.validate_parse(zip_entry)
+
+        # Verify <Relationships><Relationship/></Relationships>
+        root_element = doc.children[0]
+        if root_element.name == "Relationships"
+          relationship_elements = root_element.children
+          if relationship_elements.size > 0
+            relationship_elements.each do |node|
+              if node.is_a?(Nokogiri::XML::Element) && node.name == "Relationship"
+                l.error :multiple_relationships if (relationships.select { |r| r[:target] == node['Target'] && r[:type] == node['Type'] }.size > 0)
+                l.error :non_unique_rel_id, :file => zip_entry.name, :id => node['Id'] if (relationships.select { |r| r[:id] == node['Id'] }.size > 0)
+                relationships << {target: node['Target'], type: node['Type'], id: node['Id']}
+                l.info "adding relationship: #{relationships.last.inspect}"
+              else
+                unless node.is_a? Nokogiri::XML::Text
+                  l.info "found non-Relationship node: #{node.name}"
+                end
+              end
+            end
+
+            if zip_entry.name=="_rels/.rels"
+              l.context "Verifying StartPart" do |l|
+                start_part_type = Document::MODEL_TYPE
+                start_part_count = relationships.select { |r| r[:type] == start_part_type }.size
+                if start_part_count != 1
+                  l.error :invalid_startpart_type
+                end
+              end
+            end
+          else
+            l.error :dot_rels_file_no_relationship_element
+          end
+        else
+          l.error :dot_rels_file_missing_relationships_element
+        end
+
+      rescue Nokogiri::XML::SyntaxError => e
+        l.error :dot_rels_file_has_invalid_xml, e: "#{e.message}"
+      end
+    end
+    relationships
+  end
+end

data/lib/ruby3mf/schema_files.rb

@@ -1,26 +1,26 @@
-require 'erb'
-
-class SchemaFiles
-
-  SchemaTemplate  = File.join(File.dirname(__FILE__), "3MFcoreSpec_1.1.xsd.template")
-  SchemaLocation  = File.join(File.dirname(__FILE__), "xml.xsd")
-
-  class << self
-
-    def open(file)
-      @@template ||= File.open(file, "r") do |file|
-        file.read
-      end
-
-      yield(SchemaFiles.render)
-
-    end
-
-    def render
-       @@xsd_content ||= ERB.new(@@template).result( binding )
-    end
-
-  end
-
-
-end
+require 'erb'
+
+class SchemaFiles
+
+  SchemaTemplate  = File.join(File.dirname(__FILE__), "3MFcoreSpec_1.1.xsd.template")
+  SchemaLocation  = File.join(File.dirname(__FILE__), "xml.xsd")
+
+  class << self
+
+    def open(file)
+      @@template ||= File.open(file, "r") do |file|
+        file.read
+      end
+
+      yield(SchemaFiles.render)
+
+    end
+
+    def render
+       @@xsd_content ||= ERB.new(@@template).result( binding )
+    end
+
+  end
+
+
+end

data/lib/ruby3mf/texture3mf.rb

@@ -1,29 +1,29 @@
-class Texture3mf
-  attr_accessor :name
-
-  def initialize(document)
-    @doc = document
-  end
-
-  def self.parse(document, relationship_file)
-    t = new(document)
-    t.name = relationship_file.name
-    stream = relationship_file.get_input_stream
-    img_type = MimeMagic.by_magic(stream)
-    Log3mf.context "Texture3mf" do |l|
-      l.fatal_error :zero_size_texture unless img_type
-      l.debug "texture is of type: #{img_type}"
-      l.error(:invalid_texture_file_type, type: img_type) unless ['image/png', 'image/jpeg'].include? img_type.type
-    end
-    t
-  end
-
-  def update(bytes)
-    @doc.objects[name]=bytes
-  end
-
-  def contents
-    @doc.objects[name] || @doc.contents_for(name)
-  end
-
-end
+class Texture3mf
+  attr_accessor :name
+
+  def initialize(document)
+    @doc = document
+  end
+
+  def self.parse(document, relationship_file)
+    t = new(document)
+    t.name = relationship_file.name
+    stream = relationship_file.get_input_stream
+    img_type = MimeMagic.by_magic(stream)
+    Log3mf.context "Texture3mf" do |l|
+      l.fatal_error :zero_size_texture unless img_type
+      l.debug "texture is of type: #{img_type}"
+      l.error(:invalid_texture_file_type, type: img_type) unless ['image/png', 'image/jpeg'].include? img_type.type
+    end
+    t
+  end
+
+  def update(bytes)
+    @doc.objects[name]=bytes
+  end
+
+  def contents
+    @doc.objects[name] || @doc.contents_for(name)
+  end
+
+end

data/lib/ruby3mf/thumbnail3mf.rb

@@ -1,21 +1,21 @@
-require 'mini_magick'
-
-class Thumbnail3mf
-
-  def self.parse(doc, relationship_file)
-    Log3mf.context "Thumbnail3mf" do |l|
-
-      img_type = MimeMagic.by_magic(relationship_file.get_input_stream)
-      l.fatal_error :invalid_thumbnail_file unless img_type
-      l.error(:invalid_thumbnail_file_type, type: img_type) unless ['image/png', 'image/jpeg'].include? img_type.type
-
-      img_colorspace = MiniMagick::Image.read(relationship_file.get_input_stream).colorspace
-      l.fatal_error :invalid_thumbnail_colorspace if img_colorspace.include? "CMYK"
-
-      if relationship_file.respond_to?(:name)
-        decl_type = doc.types.get_type(relationship_file.name)
-        l.error :thumbnail_image_type_mismatch if decl_type != img_type.to_s
-      end
-    end
-  end
-end
+require 'mini_magick'
+
+class Thumbnail3mf
+
+  def self.parse(doc, relationship_file)
+    Log3mf.context "Thumbnail3mf" do |l|
+
+      img_type = MimeMagic.by_magic(relationship_file.get_input_stream)
+      l.fatal_error :invalid_thumbnail_file unless img_type
+      l.error(:invalid_thumbnail_file_type, type: img_type) unless ['image/png', 'image/jpeg'].include? img_type.type
+
+      img_colorspace = MiniMagick::Image.read(relationship_file.get_input_stream).colorspace
+      l.fatal_error :invalid_thumbnail_colorspace if img_colorspace.include? "CMYK"
+
+      if relationship_file.respond_to?(:name)
+        decl_type = doc.types.get_type(relationship_file.name)
+        l.error :thumbnail_image_type_mismatch if decl_type != img_type.to_s
+      end
+    end
+  end
+end

data/lib/ruby3mf/version.rb

@@ -1,3 +1,3 @@
-module Ruby3mf
-  VERSION = "0.2.6"
-end
+module Ruby3mf
+  VERSION = "0.2.7"
+end