ruby3mf 0.1.13 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cf0043b4bcebef905de98f2137ad6db1b36fc4
-  data.tar.gz: 3a970b15e198109bf6638f7206569e0b90bc51fc
+  metadata.gz: 49c3ed54c8588a2979b63822dbab8f3e339b5207
+  data.tar.gz: 50e088646a7159cf293fb896ce6ce7a5284b1131
 SHA512:
-  metadata.gz: 91a20f9e6da5bf9f89b582509764e0ef3cf0a320c798c0020fd5fc4fd6e9e1a931193005549c0777e30b19292fcb33b7b044fee6ff70ba6ec8b36fcd0411e7e7
-  data.tar.gz: a2203b11cb4f4ecdd9ec342ae73ae5fa2b59e46d58474671ff2123e7dd88c3438c85d7cfe54bfb3c59ac024f501dfd8ed6a818a43647dc02d9bb3866ca137095
+  metadata.gz: 9ecf6eaf61cbb478408212ef0741133b8c1d88d6891eaa6b330dc3102c752572da8b13f664f35067d5a167fbc25bc0333d07885a8dfb94ea29c6421a0f06e085
+  data.tar.gz: f220c8fc02162b03dbfbb2fa66b4e380f19e7a684ca0d59a5ab8cba6342333b00c35060802b9a2758f7109ff823792f62847e9b61ac6f606049ccd5c222db9fc

data/lib/ruby3mf.rb

@@ -1,4 +1,5 @@
 require_relative "ruby3mf/version"
+require_relative "ruby3mf/interpolation"
 require_relative "ruby3mf/log3mf"
 require_relative "ruby3mf/document"
 require_relative "ruby3mf/content_types"

data/lib/ruby3mf/document.rb

@@ -8,11 +8,18 @@ class Document
   attr_accessor :objects
   attr_accessor :zip_filename
 
+  # Relationship schemas
+  MODEL_TYPE = 'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel'
+  THUMBNAIL_TYPE = 'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail'
+  TEXTURE_TYPE = 'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dtexture'
+  PRINT_TICKET_TYPE = 'http://schemas.microsoft.com/3dmanufacturing/2013/01/printticket'
+
   # Relationship Type => Class validating relationship type
   RELATIONSHIP_TYPES = {
-    'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel' => {klass: 'Model3mf', collection: :models},
-    'http://schemas.openxmlformats.org/package/2006/relationships/metadata/thumbnail' => {klass: 'Thumbnail3mf', collection: :thumbnails},
-    'http://schemas.microsoft.com/3dmanufacturing/2013/01/3dtexture' => {klass: 'Texture3mf', collection: :textures}
+    MODEL_TYPE => {klass: 'Model3mf', collection: :models},
+    THUMBNAIL_TYPE => {klass: 'Thumbnail3mf', collection: :thumbnails},
+    TEXTURE_TYPE => {klass: 'Texture3mf', collection: :textures},
+    PRINT_TICKET_TYPE => {}
   }
 
   def initialize(zip_filename)
@@ -85,6 +92,11 @@ class Document
               end
             end
 
+            l.context "print tickets" do |l|
+              print_ticket_types = m.relationships.select { |rel| rel[:type] == PRINT_TICKET_TYPE }
+              l.error :multiple_print_tickets if print_ticket_types.size > 1
+            end
+
             l.context "relationship elements" do |l|
               # 3. Validate all relationships
               m.relationships.each do |rel|
@@ -107,13 +119,15 @@ class Document
                   if relationship_file
                     relationship_type = RELATIONSHIP_TYPES[rel[:type]]
                     if relationship_type.nil?
-                      l.warning "Relationship file defines a type that is not used in a normal 3mf file: #{rel[:type]}. Ignoring relationship."
+                      l.error :invalid_relationship_type, type: rel[:type]
                     else
-                      m.send(relationship_type[:collection]) << {
-                        rel_id: rel[:id],
-                        target: rel[:target],
-                        object: Object.const_get(relationship_type[:klass]).parse(m, relationship_file)
-                      }
+                      unless relationship_type[:klass].nil?
+                        m.send(relationship_type[:collection]) << {
+                            rel_id: rel[:id],
+                            target: rel[:target],
+                            object: Object.const_get(relationship_type[:klass]).parse(m, relationship_file)
+                        }
+                      end
                     end
                   else
                     l.error "Relationship Target file #{rel[:target]} not found", page: 11

data/lib/ruby3mf/errors.yml

@@ -1,5 +1,5 @@
 resource_contentype_invalid:
-  msg: "resource in model has invalid contenttype %{bt}"
+  msg: "Resource in model has invalid contenttype %{bt}"
   page: 10
 err_uri_empty_segment:
   msg: 'No segment of a 3MF part name path may be empty'
@@ -49,6 +49,9 @@ invalid_content_type:
 invalid_startpart_type:
   msg: "rels/.rels Relationship file has an invalid attribute type for the root 3D Model (StartPart). The required type is \"http://schemas.microsoft.com/3dmanufacturing/2013/01/3dmodel\""
   page: 10
+invalid_relationship_type:
+  msg: "Invalid relationship type '%{type}' specified in .rels relationship file. Parts in the 3D payload MUST use one of the appropriate relationship types to establish that relationship between two parts in the payload."
+  page: 10
 invalid_thumbnail_colorspace:
   msg: "CMYK JPEG images must not be used for the thumbnail"
   page: 36
@@ -79,18 +82,39 @@ not_a_zip:
 zero_size_texture:
   msg: "Texture file must be valid image file"
   page: 16
-resource_contentype_invalid:
-  msg: "resource in model has invalid contenttype image/ping"
-  page: 10
 has_xml_space_attribute:
-  msg: "found an xml:space attribute when it is not allowed"
+  msg: "xml:space attribute is not allowed"
   page: 16
+invalid_model_unit:
+  msg: "Invalid unit value of '%{unit}' specified in model file."
+  page: 17
 wrong_encoding:
-  msg: "found XML content that was not UTF8 encoded"
+  msg: "XML content must be UTF8 encoded"
   page: 15
 missing_object_pid:
-  msg: "object with triangle color override missing object level pid"
+  msg: "Object with triangle color override missing object level pid"
   page: 26
 missing_model_children:
-  msg: "model element must include resources and build as child elements"
+  msg: "Model element must include resources and build as child elements"
   page: 20
+object_with_components_and_pid:
+  msg: "object with components and pid or pindex"
+  page: 26
+build_with_other_item:
+  msg: "build item with object of type other"
+  page: 27
+resource_id_collision:
+  msg: "resources must be unique within the model"
+  page: 22
+metadata_elements_with_same_name:
+  msg: "metadata elements must not share the same name"
+  page: 22
+multiple_print_tickets:
+  msg: "Only one print ticket allowed for any given model"
+  page: 13
+unknown_required_extension:
+  msg: "Required extension not supported: %{ext}"
+  page: 14
+missing_extension_namespace_uri:
+  msg: "Required extension '%{ns}' MUST refer to namespace with URI"
+  page: 14

data/lib/ruby3mf/interpolation.rb

@@ -0,0 +1,43 @@
+module Interpolation
+
+  INTERPOLATION_PATTERN = Regexp.union(
+    /%%/,
+    /%\{(\w+)\}/,                               # matches placeholders like "%{foo}"
+    /%<(\w+)>(.*?\d*\.?\d*[bBdiouxXeEfgGcps])/  # matches placeholders like "%<foo>.d"
+  )
+
+  def interpolate(string, values = {})
+    if values.keys == 0
+      string
+    else
+      string.gsub(INTERPOLATION_PATTERN) do |match|
+        if match == '%%'
+          '%'
+        else
+          key = ($1 || $2 || match.tr("%{}", "")).to_sym
+          value = values[key]
+          value = value.call(values) if value.respond_to?(:call)
+          $3 ? sprintf("%#{$3}", value) : value
+        end
+      end
+    end
+  end
+
+  def symbolize_recursive(hash)
+     {}.tap do |h|
+       hash.each { |key, value| h[key.to_sym] = map_value(value) }
+     end
+   end
+
+   def map_value(thing)
+     case thing
+     when Hash
+       symbolize_recursive(thing)
+     when Array
+       thing.map { |v| map_value(v) }
+     else
+       thing
+     end
+   end
+
+end

data/lib/ruby3mf/log3mf.rb

@@ -23,6 +23,7 @@ require 'yaml'
 
 class Log3mf
   include Singleton
+  include Interpolation
 
   LOG_LEVELS = [:fatal_error, :error, :warning, :info, :debug]
 
@@ -63,28 +64,20 @@ class Log3mf
 
   def method_missing(name, *args, &block)
     if LOG_LEVELS.include? name.to_sym
-      #puts "***** #{name} called from #{caller[0]}"
       log(name.to_sym, *args)
     else
       super
     end
   end
 
-  def log(severity, message, options={})
-    if message.is_a?(Symbol)
-      new_log(severity, message, options)
-    else
-      @log_list << ["#{@context_stack.join("/")}", severity, message, options] unless severity==:debug && ENV['LOGDEBUG'].nil?
-      # puts "[#{@context_stack.join("/")}] #{severity.to_s.upcase} #{message}"
-    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]
+    message = interpolate(error["msg"], options)
+    @log_list << ["#{@context_stack.join("/")}", severity, message, options] unless severity==:debug && ENV['LOGDEBUG'].nil?
     raise FatalError if severity == :fatal_error
   end
 
-  def new_log(severity, message, options={})
-    error_info = @errormap.fetch(message.to_s)
-    @log_list << ["#{@context_stack.join("/")}", severity, error_info["msg"], page: error_info["page"]] unless severity==:debug && ENV['LOGDEBUG'].nil?
-  end
-
   def count_entries(*levels)
     entries(*levels).count
   end

data/lib/ruby3mf/mesh_analyzer.rb

@@ -15,6 +15,12 @@ end
 class MeshAnalyzer
 
   def self.validate_object(object)
+    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
 

data/lib/ruby3mf/model3mf.rb

@@ -2,6 +2,13 @@ require_relative 'mesh_analyzer'
 
 class Model3mf
 
+  VALID_UNITS = [ 'micron', 'millimeter', 'centimeter', 'meter', 'inch', 'foot' ].freeze
+  VALID_EXTENSIONS = {
+    'http://schemas.microsoft.com/3dmanufacturing/slice/2015/07' => {},
+    'http://schemas.microsoft.com/3dmanufacturing/material/2015/02' => {},
+    'http://schemas.microsoft.com/3dmanufacturing/production/2015/06' => {},
+  }.freeze
+
   def self.parse(document, zip_entry)
     model_doc = nil
 
@@ -12,6 +19,24 @@ class Model3mf
         l.fatal_error "Model file invalid XML. Exception #{e}"
       end
 
+      l.context "verifying requiredextensions" do |l|
+        required_extensions = model_doc.css("//model")[0]["requiredextensions"]
+        if required_extensions
+          required_extensions.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"] }
@@ -46,14 +71,45 @@ class Model3mf
 
       end
 
+      l.context "verifying resources" do |l|
+        resources = find_child(model_doc.root, "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
+        end
+      end
+
       l.context "verifying model structure" do |l|
         root = model_doc.root
         l.error :root_3dmodel_element_not_model if root.name != "model"
 
+        l.error(:invalid_model_unit, unit: root.attr('unit')) unless VALID_UNITS.include?(root.attr('unit'))
+
         children = model_doc.root.children.map { |child| child.name }
         l.error :missing_model_children unless children.include?("resources") && children.include?("build")
       end
 
+      l.context "verifying build items" do |l|
+        build = find_child(model_doc.root, "build")
+        if build
+          items = build.children.map { |child| child.attributes["objectid"].to_s() if child.name == "item" }
+
+          resources = find_child(model_doc.root, "resources")
+          resources.children.each do |resource|
+            if resource.name == "object"
+              object_id = resource.attributes["id"].to_s()
+              l.error :build_with_other_item if resource.attributes["type"].to_s() == "other" and items.include?(object_id)
+            end
+          end
+        end
+      end
+
+      l.context "checking metadata" do |l|
+        metadata = model_doc.root.css("metadata")
+        metadata_names = metadata.map { |met| met['name'] }
+        l.error :metadata_elements_with_same_name unless metadata_names.uniq!.nil?
+      end
+
       MeshAnalyzer.validate(model_doc)
     end
     model_doc

data/lib/ruby3mf/version.rb

@@ -1,3 +1,3 @@
 module Ruby3mf
-  VERSION = "0.1.13"
+  VERSION = "0.1.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby3mf
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.15
 platform: ruby
 authors:
 - Mike Whitmarsh, Jeff Porter, and William Hertling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-07 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,7 @@ files:
 - lib/ruby3mf/edge_list.rb
 - lib/ruby3mf/errors.yml
 - lib/ruby3mf/global_xml_validations.rb
+- lib/ruby3mf/interpolation.rb
 - lib/ruby3mf/log3mf.rb
 - lib/ruby3mf/mesh_analyzer.rb
 - lib/ruby3mf/model3mf.rb