Class: Circuitdata::CompatibilityChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/circuitdata/compatibility_checker.rb

Instance Method Summary collapse

Constructor Details

#initialize(product_file, check_file, validate_origins) ⇒ CompatibilityChecker

Returns a new instance of CompatibilityChecker.



2
3
4
5
6
7
8
9
10
11
 
# File 'lib/circuitdata/compatibility_checker.rb', line 2

def initialize(product_file, check_file, validate_origins)
  require 'json'
  require 'json-schema'

  @product_file = product_file
  @check_file = check_file
  @validate_origins = validate_origins
  # Final hash
  @fh = {error: false, message: nil, errors: {validation: {}, restricted: {}, enforced: {}, capabilities: {}}}
end

Instance Method Details

#perform_comparison(product_data, check_data, schema, type) ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/circuitdata/compatibility_checker.rb', line 40

def perform_comparison(product_data, check_data, schema, type)
  case type
    when 'restricted'
      check_hash = check_data.dig(:open_trade_transfer_package, :profiles, :restricted, :printed_circuits_fabrication_data)
    when 'enforced'
      check_hash = check_data.dig(:open_trade_transfer_package, :profiles, :enforced, :printed_circuits_fabrication_data)
    when 'capabilities'
      check_hash = check_data.dig(:open_trade_transfer_package, :capabilities, :printed_circuits_fabrication_data)
    else
      check_hash = {}
  end

  common_hash = schema.dig(:properties, :open_trade_transfer_package, :properties, :products, :patternProperties, :'^(?!generic$).*', :properties, :printed_circuits_fabrication_data, :properties)
  check_hash.each do |k, v|
    v.each do |kl1, vl1| # level 1
      common_hash[k.to_sym]||= {:type => 'object', :properties => {}}
      common_hash[:stackup][:properties][:specified][:properties][k.to_sym] ||= {:type => 'object', :properties => {}}

      case vl1.class.name
        when 'String'
          if vl1.match("^(\\d*|\\d*.\\d*)\\.\\.\\.(\\d*|\\d*.\\d*)$") #This is a value range
            from, too = vl1.match("^(\\d*|\\d*.\\d*)\\.\\.\\.(\\d*|\\d*.\\d*)$").captures
            case type
              when 'restricted'
                new_hash = {:not => {:allOf => [{:minimum => from.to_f},{:maximum => too.to_f}]}}
              else
                new_hash = eval("{:minimum => #{from}, :maximum => #{too}}")
            end
          else # This is a normal string - check for commas
            enum = []
            vl1.split(',').each {|enumvalue| enum << enumvalue.strip}
            case type
              when 'restricted'
                new_hash = {:not => {:anyOf => [{ :enum => ''}]}}
                new_hash[:not][:anyOf][0][:enum] = enum
              else
                new_hash = eval("{:enum => #{enum}}")
            end
          end
        when 'Numeric', 'Float' # This is a normal string
          case type
            when 'restricted'
              new_hash = {:not => {:allOf => [{:minimum => vl1.to_f},{:maximum => vl1.to_f}]}}
            else
              new_hash = eval("{:enum => [#{vl1.to_s}]}")
          end
      end
      common_hash[k.to_sym][:properties][kl1.to_sym] = new_hash
      common_hash[:stackup][:properties][:specified][:properties][k.to_sym][:properties][kl1.to_sym] = new_hash
    end if v.is_a? Hash

    common_hash[k.to_sym][:additionalProperties] = false if (v.is_a?(Hash) && type == 'capabilities')
  end

  # perform validations
  begin
    validation_errors = JSON::Validator.fully_validate(schema.to_json, product_data, :errors_as_objects => true)

    if validation_errors.any?
      @fh[:error] = true
      @fh[:message] = 'The product to check did not meet the requirements'

      validation_errors.each do |error|
        error_array = []
        begin
          error_array << error[:message].match("^(The\\sproperty\\s\\'[\\s\\S]*\\'\\s)([\\s\\S]*)(\\sin\\sschema[\\s\\S]*)$").captures[1]
        rescue
          error_array << error[:message]
        end
        @fh[:errors][type.to_sym][error[:fragment]] = error_array
      end
    end
  rescue JSON::Schema::ReadFailed
    @fh[:error] = true
    @fh[:message] = "Could not read the submitted `#{type}` schema" # enforced_schema
  rescue JSON::Schema::SchemaError
    @fh[:error] = true
    @fh[:message] = "Something was wrong with the submitted `#{type}` schema" # enforced_schema
  end
end

#start_check ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/circuitdata/compatibility_checker.rb', line 13

def start_check
  # Initialize & validate
  @fh[:error], @fh[:message], product_data = Circuitdata.read_json(@product_file)
  return @fh if @fh[:error]
  @fh[:error], @fh[:message], @fh[:errors][:validation] = Circuitdata.validate(product_data)
  return @fh if @fh[:error]
  if @check_file.present?
    @fh[:error], @fh[:message], check_data = Circuitdata.read_json(@check_file)
    return @fh if @fh[:error]
    @fh[:error], @fh[:message], @fh[:errors][:validation] = Circuitdata.validate(check_data)
    return @fh if @fh[:error]
    f2_types = Circuitdata.get_data_summary(check_data)[1]

    # read the schema
    schema_path = File.join(File.dirname(__FILE__), 'schema_files/v1/ottp_circuitdata_skeleton_schema.json')
    schema = JSON.parse(File.read(schema_path), symbolize_names: true)
    deref_schema = Circuitdata::Dereferencer.dereference(schema, File.dirname(Circuitdata::SCHEMA_FULL_PATH))
    restricted_schema = enforced_schema = capability_schema = deref_schema
    # Compare the content
    perform_comparison(product_data, check_data, restricted_schema, 'restricted') if f2_types.include? 'profile_restricted'
    perform_comparison(product_data, check_data, enforced_schema, 'enforced') if f2_types.include? 'profile_enforced'
    perform_comparison(product_data, check_data, capability_schema, 'capabilities') if f2_types.include? 'capabilities'
  end

  @fh
end