circuitdata 0.6.3 → 0.6.4

data/lib/circuitdata/schema_files/v1/ottp_circuitdata_skeleton_schema.json

@@ -47,8 +47,48 @@
               }
             }
           }
+        },
+        "custom": {
+          "properties": {
+            "colors": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {}
+              }
+            }            ,
+            "materials": {
+              "properties": {
+                "printed_circuits_fabrication_data": {
+                  "properties": {
+                    "dielectrics": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {}
+                      }
+                    },
+                    "soldermasks": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {}
+                      }
+                    },
+                    "stiffeners": {
+                      "type": "array",
+                      "items": {
+                        "type": "object",
+                        "properties": {}
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
         }
       }
     }
   }
-}
+}

data/lib/circuitdata/tools.rb

@@ -7,6 +7,12 @@ class Circuitdata::Tools
   end
 
   def update_ra(type, key, value)
+    if key == :materials
+      update_ra(type, :dielectric, value[:properties][:printed_circuits_fabrication_data][:properties][:dielectrics])
+      update_ra(type, :soldermask, value[:properties][:printed_circuits_fabrication_data][:properties][:soldermasks])
+      update_ra(type, :stiffener, value[:properties][:printed_circuits_fabrication_data][:properties][:stiffeners])
+      return
+    end
     parsed_elements = Circuitdata.read_json(@definitions_path)[2]
     unless @ra[:structured][:elements].has_key? key
       @ra[:structured][:elements][key] = {
@@ -36,10 +42,12 @@ class Circuitdata::Tools
             :in_profile_default => false,
             :in_profile_enforced => false,
             :in_profile_restricted => false,
+            :in_custom => false,
             :in_capabilities => false,
             :type => nil,
             :arrayitems => nil,
             :enum => nil,
+            :enum_description => nil,
             :description => nil,
             :uom => nil,
             :minimum => nil,
@@ -47,10 +55,12 @@ class Circuitdata::Tools
           }
           if svalue.has_key? :$ref
             elements = svalue[:$ref].split('/')
-            if elements.length < 5
+            if elements.length == 4
               element = parsed_elements[elements[1].to_sym][elements[2].to_sym][elements[3].to_sym]
-            else
+            elsif elements.length == 5
               element = parsed_elements[elements[1].to_sym][elements[2].to_sym][elements[3].to_sym][elements[4].to_sym]
+            else
+              element = parsed_elements[elements[1].to_sym][elements[2].to_sym][elements[3].to_sym][elements[4].to_sym][elements[5].to_sym]
             end
           else
             element = nil
@@ -68,7 +78,10 @@ class Circuitdata::Tools
                 end
               end
             end
-            @ra[:structured][:elements][key][:elements][skey][:enum] = element[:enum] if element.has_key? :enum
+            if element.has_key? :enum
+              @ra[:structured][:elements][key][:elements][skey][:enum] = element[:enum]
+              @ra[:structured][:elements][key][:elements][skey][:enum_description] = element[:enum_description] if element.has_key? :enum_description
+            end
             @ra[:structured][:elements][key][:elements][skey][:description] = element[:description] if element.has_key? :description
             @ra[:structured][:elements][key][:elements][skey][:uom] = element[:uom] if element.has_key? :uom
             @ra[:structured][:elements][key][:elements][skey][:minimum] = element[:minimum] if element.has_key? :minimum
@@ -76,18 +89,25 @@ class Circuitdata::Tools
           end
         else
           if [:in_profile_restricted, :in_capabilities].include? type
+            if @ra[:structured][:elements][key][:elements][skey][:type].nil?
+              @ra[:structured][:elements][key][:elements][skey][:type] = svalue[:type] unless ['array', 'object'].include? svalue[:type]
+            end
             case @ra[:structured][:elements][key][:elements][skey][:type]
             when *["number", "integer", "boolean", "string"]
               @ra[:structured][:elements][key][:elements][skey][:type] = "number" if @ra[:structured][:elements][key][:elements][skey][:type] == "integer"
               unless ( svalue.has_key? :type and svalue[:type] == "array" ) and ( svalue.has_key? :items and svalue[:items].has_key? :type and svalue[:items][:type] == @ra[:structured][:elements][key][:elements][skey][:type])
                 (@ra[:errors][type][key] ||= {})[skey] = "Type is #{@ra[:structured][:elements][key][:elements][skey][:type]}, wrong check"
               end
+              if type == :in_profile_restricted and not @ra[:structured][:elements][key][:elements][skey][:enum].nil? and svalue.has_key? :minItems
+                puts
+                (@ra[:errors][type][key] ||= {})[skey] = "Error in profile restricted where enum is not considered"
+              end
             when "array"
               unless svalue.has_key? :type and svalue[:type] == "array"
                 (@ra[:errors][type][key] ||= {})[skey] = "Type is #{@ra[:structured][:elements][key][:elements][skey][:type]}, wrong check"
               end
             else
-              puts "unknown type #{@ra[:structured][:elements][key][:elements][skey][:type]} in #{key}, #{skey} when doing #{type}"
+              (@ra[:errors][type][key] ||= {})[skey] = "Unknown type #{@ra[:structured][:elements][key][:elements][skey][:type]} in #{key}, #{skey} when doing #{type}"
             end
           end
         end
@@ -100,9 +120,11 @@ class Circuitdata::Tools
     @ra[:structured] = {:elements => {}, :custom => {}}
     @ra[:errors] = {:in_profile_restricted => {}, :in_capabilities => {}}
     parsed_schema = Circuitdata.read_json(@schema_path)[2]
+    # Go through all products
     parsed_schema[:properties][:open_trade_transfer_package][:properties][:products][:patternProperties]["^(?!generic$).*".to_sym][:properties][:printed_circuits_fabrication_data][:properties].each do |key, value|
       self.update_ra(:in_product_generic, key, value)
     end
+    # Go through all profiles
     ["defaults", "restricted", "enforced"].each do |sym|
       parsed_schema[:properties][:open_trade_transfer_package][:properties][:profiles][:properties][sym.to_sym][:properties][:printed_circuits_fabrication_data][:properties].each do |key, value|
         case sym
@@ -116,17 +138,23 @@ class Circuitdata::Tools
         self.update_ra(t, key, value)
       end
     end
+    # Go through all capabilities
     parsed_schema[:properties][:open_trade_transfer_package][:properties][:capabilities][:properties][:printed_circuits_fabrication_data][:properties].each do |key, value|
       self.update_ra(:in_capabilities, key, value)
     end
+    # Go through all custom
+    parsed_schema[:properties][:open_trade_transfer_package][:properties][:custom][:properties].each do |key, value|
+      self.update_ra(:in_custom, key, value)
+    end
+
     @ra[:structured][:elements].sort.to_h
     @ra[:structured][:elements].delete(:version)
-
+    @ra[:structured][:elements][:stackup].delete(:specified)
     return @ra
   end
 
   def create_documentation(ra)
-    ra[:documentation] = "## Elements and tags\n====================\n\n"
+    ra[:documentation] = "## Elements and tags\n"
     ra[:structured][:elements].each do |element_key, element_value|
       ra[:documentation] += "### #{element_key} [link](##{element_key.to_s.downcase.tr(" ", "-")})\n"
       element_value[:elements].each do |e_key, e_value|
@@ -141,7 +169,7 @@ class Circuitdata::Tools
       ra[:documentation] += "#{element_value[:description]}\n" unless element_value[:description].nil?
       ra[:documentation] += "\n"
       if element_value[:type] == "array"
-        ra[:documentation] += "**You must specify this as en array when used in a generic product description or a stackup, but as a single object when used in any of the other parts.**\n\n"
+        ra[:documentation] += "**You must specify this as en array when used in a generic product description or a stackup, but as a object when used in any of the other parts. Read more [here](#elements-that-are-both-arrays-and-objects)**\n\n"
       end
       element_value[:elements].each do |e_key, e_value|
         ra[:documentation] += "#### #{e_key}\n"
@@ -151,19 +179,24 @@ class Circuitdata::Tools
         if e_value.has_key? :enum and not e_value[:enum].nil?
           ra[:documentation] += "Use one of these values:\n"
           e_value[:enum].each do |ev|
-            ra[:documentation] += "* #{ev}\n"
+            ra[:documentation] += "* #{ev}"
+            if e_value.has_key? :enum_description and not e_value[:enum_description].nil? and e_value[:enum_description].has_key? ev.to_sym and not e_value[:enum_description][ev.to_sym].nil?
+              ra[:documentation] += " (#{e_value[:enum_description][ev.to_sym]})\n"
+            else
+              ra[:documentation] += "\n"
+            end
           end
           ra[:documentation] += "\n"
         end
-        ra[:documentation] += "|  | Generic product | Stackup | Profile defaults | Profile enforced | Profile restricted | Capabilities |\n"
-        ra[:documentation] += "|-:|:---------------:|:-------:|:----------------:|:----------------:|:------------------:|:------------:|\n| **Use in:** | "
-        [e_value[:in_product_generic], e_value[:in_product_stackup], e_value[:in_profile_default], e_value[:in_profile_enforced], e_value[:in_profile_restricted], e_value[:in_capabilities]].each do |part|
-          part.nil? ? ra[:documentation] += "Disallowed | " : ra[:documentation] += "Allowed | "
+        ra[:documentation] += "|  | Generic product | Stackup | Profile defaults | Profile enforced | Profile restricted | Capabilities | Custom |\n"
+        ra[:documentation] += "|-:|:---------------:|:-------:|:----------------:|:----------------:|:------------------:|:------------:|:------:|\n| **Use in:** | "
+        [:in_product_generic, :in_product_stackup, :in_profile_default, :in_profile_enforced, :in_profile_restricted, :in_capabilities, :in_custom].each do |part|
+          e_value[part] ? ra[:documentation] += "Allowed | " : ra[:documentation] += "Disallowed | "
         end
-        ra[:documentation] += "\n|**Format:** | #{e_value[:type]} | #{e_value[:type]} | #{e_value[:type]} | #{e_value[:type]} | Array of #{e_value[:type]}s | Array of #{e_value[:type]}s |\n"
+        ra[:documentation] += "\n|**Format:** | #{e_value[:type]} | #{e_value[:type]} | #{e_value[:type]} | #{e_value[:type]} | Array of #{e_value[:type]}s | Array of #{e_value[:type]}s | Array of #{e_value[:type]}s |\n"
         if e_value[:enum].nil? and e_value[:type] == "number"
-          ra[:documentation] += "|**Min value:** | #{e_value[:minimum]} | #{e_value[:minimum]} | #{e_value[:minimum]} | #{e_value[:minimum]} | Each item: #{e_value[:minimum]} | Each item: #{e_value[:minimum]} |\n" unless e_value[:minimum].nil?
-          ra[:documentation] += "|**Max value:** | #{e_value[:maximum]} | #{e_value[:maximum]} | #{e_value[:maximum]} | #{e_value[:maximum]} | Each item  : #{e_value[:maximum]} | Each item: #{e_value[:maximum]} |\n" unless e_value[:maximum].nil?
+          ra[:documentation] += "|**Min value:** | #{e_value[:minimum]} | #{e_value[:minimum]} | #{e_value[:minimum]} | #{e_value[:minimum]} | Each item: #{e_value[:minimum]} | Each item: #{e_value[:minimum]} | Each item: #{e_value[:minimum]} |\n" unless e_value[:minimum].nil?
+          ra[:documentation] += "|**Max value:** | #{e_value[:maximum]} | #{e_value[:maximum]} | #{e_value[:maximum]} | #{e_value[:maximum]} | Each item  : #{e_value[:maximum]} | Each item: #{e_value[:maximum]} | Each item: #{e_value[:maximum]} |\n" unless e_value[:maximum].nil?
         end
         ra[:documentation] += "\n"
       end

data/lib/circuitdata/version.rb

@@ -1,3 +1,3 @@
 module Circuitdata
-  VERSION = '0.6.3'
+  VERSION = '0.6.4'
 end

metadata

@@ -1,14 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: circuitdata
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Andreas Lydersen
+- Maximilian Brosnahan
+- Benjamin Mwendwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -66,8 +68,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-description: This gem allows you to do basic test and comparison of JSON files agains
-  the CircuitData JSON schema
+description: This gem provides you with functions to work with the CricuitData language.
+  Run files against the schema, check their compatibility agains each other compare
+  multiple files to find conflicts.
 email:
 - andreas.lydersen@ntty.com
 executables: []
@@ -112,6 +115,6 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: This gem allows you to do basic test and comparison of JSON files agains
-  the CircuitData JSON schema
+summary: Basic test and comparison of JSON files agains the CircuitData JSON schema
+  and each other
 test_files: []