circuitdata 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bda8756e4d8d9145a33cfd33d1834fad9354e12
-  data.tar.gz: 812ecd65a520f13541b812d398686a3ed4293779
+  metadata.gz: 611504e3b618906c3034b1d9eea7c4e863a6e48b
+  data.tar.gz: 333947547beab6d85a82d1fe6ea38bbacff79915
 SHA512:
-  metadata.gz: d80ce0e432010118d65cc2ccfe5849780fa5dc97323d20421ace594d51dc25dd3309cf712492c5e79a706293073928e94902cae029ea18d88791a000225b49c3
-  data.tar.gz: 5f31206e9508f4cea850cd2aa371d668e1d8de53dd619d2ed6a496c23a381eb4a8e22360cec68e868b2bd6a864d8785f1a7f4add5db8302a0915f31307edfee1
+  metadata.gz: f1c44352aa96d8180a1d8edfe6d5357ce440be331c981866b7ec53d8d5fdd2ec07fc33301338d34c0c554c60eedfeda79c1c22018506b32f2925395390b0121b
+  data.tar.gz: 1d7ba1fa15a0d14f24ff9fb4e120b8f794127c0b5bdfdfc789b881ba60be08f32db73b2c19d0ec1c70724345cf6051c98f4ccbf8c940b13b3ee8a986f52011d6

data/lib/circuitdata.rb

@@ -113,6 +113,7 @@ module Circuitdata
   def self.create_documentation()
     docu = Tools.new()
     ra = docu.create_structure
+    #File.write('utils_README.md', docu.create_documentation(ra))
     docu.create_documentation(ra)
   end
 

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

@@ -566,7 +566,7 @@
                         "required": ["name"],
                         "properties": {
                           "name": {
-                            "type": "string"
+                            "$ref": "ottp_circuitdata_schema_definitions.json#/definitions/elements/dielectric/name"
                           }
                         },
                         "aliases": "Laminate",

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

@@ -41,7 +41,7 @@
           }
         },
         "aliases": "",
-        "name": "Soldermasks",
+        "descriptive_name": "Soldermasks",
         "description": "Materials used as soldermask"
       },
       "dielectrics": {
@@ -146,7 +146,7 @@
           }
         },
         "aliases": "",
-        "name": "Dielectrics",
+        "descriptive_name": "Dielectrics",
         "description": "Materials used as dielectrics/laminates"
       },
       "stiffeners": {
@@ -154,7 +154,7 @@
         "additionalProperties": false,
         "required": ["name"],
         "properties": {
-          "name": {
+          "descriptive_name": {
             "type": "string",
             "uom": null,
             "description": "The name of the Soldermask. Use the official name or some name as close to it as possible"
@@ -171,7 +171,7 @@
           }
         },
         "aliases": "",
-        "name": "Stiffener",
+        "descriptive_name": "Stiffener",
         "uom": null,
         "description": "The materials to be used as stiffener"
       }
@@ -275,6 +275,106 @@
           "description": "The average copper coverage of the board"
         }
       },
+      "dielectric": {
+        "name": {
+          "type": "string",
+          "uom": null,
+          "description": "The name of the Laminate. Use the official name or some name as close to it as possible."
+        },
+        "manufacturer": {
+          "type": "string",
+          "uom": null,
+          "description": "The name of the manufacturer"
+        },
+        "ipc_4101_sheet": {
+          "type": "integer",
+          "uom": null,
+          "description": "The reference sheet number of the IPC 4101 Standard."
+        },
+        "ipc_4103_sheet": {
+          "type": "integer",
+          "uom": null,
+          "description": "The reference sheet number of the IPC 4103 Standard."
+        },
+        "ipc_4204_sheet": {
+          "type": "integer",
+          "uom": null,
+          "description": "The reference sheet number of the IPC 4204 Standard."
+        },
+        "tg_min": {
+          "type": "integer",
+          "uom": null,
+          "description": "The minimum Glass Transition Temperature (Tg) required."
+        },
+        "tg_range_from": {
+          "type": "integer",
+          "uom": null,
+          "description": "The Glass Transition Temperature (Tg) range starts at."
+        },
+        "tg_range_to": {
+          "type": "integer",
+          "uom": null,
+          "description": "The Glass Transition Temperature (Tg) range ands at."
+        },
+        "td_min": {
+          "type": "integer",
+          "uom": null,
+          "description": "The minimum required temperature at which a base laminate material experiences an established percentage of weight loss using Thermograv imetric Analysis (TGA)."
+        },
+        "td_range_from": {
+          "type": "integer",
+          "uom": null,
+          "description": "The Td range starts at."
+        },
+        "td_range_to": {
+          "type": "integer",
+          "uom": null,
+          "description": "The Td range stops at."
+        },
+        "halogen_free": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Indicates the material is material free or is required to be"
+        },
+        "rw_en45545_2_2013": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Railway Europe EN45545-2:2013 compatible"
+        },
+        "rw_nf_f_16_101": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Railway France NF F 16-101 compatible"
+        },
+        "rw_uni_cei_11170_3": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Railway Italy UNI CEI 11170-3 compatible."
+        },
+        "rw_nfpa_130": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Railway USA NFPA 130 compatible."
+        },
+        "ul": {
+          "type": "boolean",
+          "uom": null,
+          "description": "UL compatible."
+        },
+        "link": {
+          "type": "string",
+          "uom": null,
+          "description": "The link to some url that gives more information or a reference to the product."
+        },
+        "accept_equivalent": {
+          "type": "boolean",
+          "uom": null,
+          "description": "Equivalent material to the one specified is OK to use as a replacement if true."
+        },
+        "aliases": "",
+        "descriptive_name": "Dielectrics",
+        "description": "Materials used as dielectrics/laminates"
+      },
       "final_finish": {
         "finish": {
           "type": "string",

data/lib/circuitdata/tools.rb

@@ -8,24 +8,29 @@ class Circuitdata::Tools
 
   def update_ra(type, key, value)
     parsed_elements = Circuitdata.read_json(@definitions_path)[2]
-    unless @ra[:structured].has_key? key
-      @ra[:structured][key] = {
+    unless @ra[:structured][:elements].has_key? key
+      @ra[:structured][:elements][key] = {
         :type => value[:type],
         :elements => {},
         :name => nil,
         :description => nil,
         :aliases => nil
       }
-      @ra[:structured][key][:name] = value[:name] if value.has_key? :name
-      @ra[:structured][key][:description] = value[:decription] if value.has_key? :decription
+      @ra[:structured][:elements][key][:name] = value[:descriptive_name] if value.has_key? :descriptive_name
+      @ra[:structured][:elements][key][:description] = value[:description] if value.has_key? :description
       if value.has_key? :aliases
-        @ra[:structured][key][:aliases] = value[:aliases] unless value[:aliases] == ""
+        @ra[:structured][:elements][key][:aliases] = value[:aliases] unless value[:aliases] == ""
       end
     end
-    if value.has_key? :properties
-      value[:properties].each do |skey, svalue|
-        unless @ra[:structured][key][:elements].has_key? skey
-          @ra[:structured][key][:elements][skey] = {
+    if value[:type] == "array"
+      subelement = value[:items]
+    else
+      subelement = value
+    end
+    if subelement.has_key? :properties
+      subelement[:properties].each do |skey, svalue|
+        unless @ra[:structured][:elements][key][:elements].has_key? skey
+          @ra[:structured][:elements][key][:elements][skey] = {
             :in_product_generic => false,
             :in_product_stackup => false,
             :in_profile_default => false,
@@ -38,9 +43,7 @@ class Circuitdata::Tools
             :description => nil,
             :uom => nil,
             :minimum => nil,
-            :maximum => nil,
-            :in_profile_restricted_regex => nil,
-            :in_capabilities_regex => nil
+            :maximum => nil
           }
           if svalue.has_key? :$ref
             elements = svalue[:$ref].split('/')
@@ -58,43 +61,43 @@ class Circuitdata::Tools
           end
           unless element.nil?
             if element.has_key? :type
-              @ra[:structured][key][:elements][skey][:type] = element[:type]
+              @ra[:structured][:elements][key][:elements][skey][:type] = element[:type]
               if element[:type] == "array"
                 if element.has_key? :items and element[:items].has_key? :type
-                  @ra[:structured][key][:elements][skey][:arrayitems] == element[:items][:type]
+                  @ra[:structured][:elements][key][:elements][skey][:arrayitems] == element[:items][:type]
                 end
               end
             end
-            @ra[:structured][key][:elements][skey][:enum] = element[:enum] if element.has_key? :enum
-            @ra[:structured][key][:elements][skey][:description] = element[:description] if element.has_key? :description
-            @ra[:structured][key][:elements][skey][:uom] = element[:uom] if element.has_key? :uom
-            @ra[:structured][key][:elements][skey][:minimum] = element[:minimum] if element.has_key? :minimum
-            @ra[:structured][key][:elements][skey][:maximum] = element[:maximum] if element.has_key? :maximum
+            @ra[:structured][:elements][key][:elements][skey][:enum] = element[:enum] if element.has_key? :enum
+            @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
+            @ra[:structured][:elements][key][:elements][skey][:maximum] = element[:maximum] if element.has_key? :maximum
           end
         else
           if [:in_profile_restricted, :in_capabilities].include? type
-            case @ra[:structured][key][:elements][skey][:type]
+            case @ra[:structured][:elements][key][:elements][skey][:type]
             when *["number", "integer", "boolean", "string"]
-              @ra[:structured][key][:elements][skey][:type] = "number" if @ra[:structured][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][key][:elements][skey][:type])
-                (@ra[:errors][type][key] ||= {})[skey] = "Type is #{@ra[:structured][key][:elements][skey][:type]}, wrong check"
+              @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
             when "array"
               unless svalue.has_key? :type and svalue[:type] == "array"
-                (@ra[:errors][type][key] ||= {})[skey] = "Type is #{@ra[:structured][key][:elements][skey][:type]}, wrong check"
+                (@ra[:errors][type][key] ||= {})[skey] = "Type is #{@ra[:structured][:elements][key][:elements][skey][:type]}, wrong check"
               end
             else
-              puts "unknown type #{@ra[:structured][key][:elements][skey][:type]} in #{key}, #{skey}"
+              puts "unknown type #{@ra[:structured][:elements][key][:elements][skey][:type]} in #{key}, #{skey} when doing #{type}"
             end
           end
         end
-        @ra[:structured][key][:elements][skey][type] = true
+        @ra[:structured][:elements][key][:elements][skey][type] = true
       end
     end
   end
 
   def create_structure
-    @ra[:structured] = {}
+    @ra[:structured] = {:elements => {}, :custom => {}}
     @ra[:errors] = {:in_profile_restricted => {}, :in_capabilities => {}}
     parsed_schema = Circuitdata.read_json(@schema_path)[2]
     parsed_schema[:properties][:open_trade_transfer_package][:properties][:products][:patternProperties]["^(?!generic$).*".to_sym][:properties][:printed_circuits_fabrication_data][:properties].each do |key, value|
@@ -116,57 +119,52 @@ class Circuitdata::Tools
     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
-    @ra[:structured].sort.to_h
-    @ra[:structured].delete(:version)
+    @ra[:structured][:elements].sort.to_h
+    @ra[:structured][:elements].delete(:version)
+
     return @ra
   end
 
   def create_documentation(ra)
-    ra[:documentation] = "## Elements and tags\n"
-    ra[:structured].each do |element_key, element_value|
-      ra[:documentation] += "[#{element_key}](##{element_key.to_s.downcase.tr(" ", "-")})\n"
+    ra[:documentation] = "## Elements and tags\n====================\n\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|
         ra[:documentation] += "* #{e_key}\n"
       end
       ra[:documentation] += "\n"
     end
-    ra[:structured].each do |element_key, element_value|
+    ra[:structured][:elements].each do |element_key, element_value|
       ra[:documentation] += "### #{element_key}\n"
-      ra[:documentation] += "Name: #{element_value[:name]}\n" unless element_value[:name].nil?
-      ra[:documentation] += "Aliases: #{element_value[:aliases]}\n" unless element_value[:aliases].nil?
+      ra[:documentation] += "Name: #{element_value[:descriptive_name]}\n\n" unless element_value[:descriptive_name].nil?
+      ra[:documentation] += "Aliases: #{element_value[:aliases]}\n\n" unless element_value[:aliases].nil?
       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"
+      end
       element_value[:elements].each do |e_key, e_value|
         ra[:documentation] += "#### #{e_key}\n"
-        ra[:documentation] += "Aliases: #{e_value[:aliases]}\n" unless e_value[:aliases].nil?
-        ra[:documentation] += "#{e_value[:description]}\n" unless e_value[:description].nil?
-        ra[:documentation] += "Unit of Measure: #{e_value[:uom][0]}\n" unless e_value[:uom].nil?
-        unless e_value[:type].nil?
-          if e_value[:type] == "array"
-            if e_value[:arrayitems].nil?
-              ra[:documentation] += "Type: #{e_value[:type].capitalize} of unknown type\n"
-            else
-              ra[:documentation] += "Type: #{e_value[:type].capitalize} of #{e_value[:arrayitems].capitalize}\n"
-            end
-          else
-            ra[:documentation] += "Type: #{e_value[:type].capitalize}\n"
-          end
-        end
+        ra[:documentation] += "Aliases: #{e_value[:aliases]}\n\n" unless e_value[:aliases].nil?
+        ra[:documentation] += "#{e_value[:description]}\n\n" unless e_value[:description].nil?
+        ra[:documentation] += "Unit of Measure: #{e_value[:uom][0]}\n\n" unless e_value[:uom].nil?
         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"
           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 | "
+        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"
+        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?
         end
-        ra[:documentation] += "Use in:\n"
-        e_value[:in_product_generic] ? ra[:documentation] += "* *Generic product section: Allowed*\n" :  ra[:documentation] += "* *Generic product section: Disallowed*\n"
-        e_value[:in_product_stackup] ? ra[:documentation] += "* *Stackup product section: Allowed*\n" :  ra[:documentation] += "* *Gtackup product section: Disallowed*\n"
-        e_value[:in_profile_default] ? ra[:documentation] += "* *Profile defaults section: Allowed*\n" :  ra[:documentation] += "* *Profile defaults section: Disallowed*\n"
-        e_value[:in_profile_enforced] ? ra[:documentation] += "* *Profile enforced section: Allowed*\n" :  ra[:documentation] += "* *Profile enforced section: Disallowed*\n"
-        e_value[:in_profile_restricted] ? ra[:documentation] += "* *Profile restricted section: Allowed*\n" :  ra[:documentation] += "* *Profile restricted section: Disallowed*\n"
-        ra[:documentation] += "*  - Value in restricted section must match regex #{e_value[:in_profile_restricted_regex]}\n" unless e_value[:in_profile_restricted_regex].nil?
-        e_value[:in_capabilities] ? ra[:documentation] += "* *Capabilites section: Allowed*\n" :  ra[:documentation] += "* *Capabilities section: Disallowed*\n"
-        ra[:documentation] += "*  - Value in capabilites section must match regex #{e_value[:in_capabilities_regex]}\n" unless e_value[:in_capabilities_regex].nil?
         ra[:documentation] += "\n"
       end
     end

data/lib/circuitdata/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuitdata
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Andreas Lydersen