Class: Circuitdata::FileComparer

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

Instance Method Summary collapse

Constructor Details

#initialize(file_hash, validate_origins) ⇒ FileComparer

Returns a new instance of FileComparer.



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

def initialize(file_hash, validate_origins)
  @file_hash = file_hash
  @validate_origins = validate_origins
  @rows = {}
  @nh = {} # a new_hash to combine all the data
  @columns = []
  @default_column = nil
  @master_column = nil
  # Final hash
  @fh = {error: false, message: nil, conflict: false, product_name: nil, columns: nil, rows: nil}
end

Instance Method Details

#compare ⇒ Object 



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
39
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
 
# File 'lib/circuitdata/file_comparer.rb', line 14

def compare
  # Initial check
  unless @file_hash.is_a? Hash
    @fh[:error] = true
    @fh[:message] = 'You have to feed this function with a hash of names and hashes'
    return @fh
  end

  # Process the hashes
  products_array = []
  @file_hash.each do |k, v|
    # read content
    @fh[:error], @fh[:message], file_content = Circuitdata.read_json(v)
    return @fh if @fh[:error]
    products, types = Circuitdata.get_data_summary(file_content)
    products_array.push(*products) # add products to tracking array
    # populate the new_hash to be used later
    @nh[k] = {types: types, products: products, data: file_content}
  end

  # check if the files content meet the requirements
  if valid_product?(products_array)
    @fh[:product_name] = products_array.first.to_s
    @columns = @nh.keys
    # get all data with products in it
    product_hashes = @nh.select{|k, v| v[:products].any?}
    product_columns = product_hashes.keys

    # Add conflicts into the new_hash
    product_hashes.each do |column_k, column_v|
      master_json = column_v.dig(:data)
      @nh.each do |file_k, file_v|
        products, data = file_v[:products], file_v[:data]
        check_results = Circuitdata.compatibility_checker(master_json, data, false)
        # format the conflicts correctly here
        file_v[:conflicts] ||= {}
        file_v[:conflicts][column_k] = get_validation_summary(check_results, file_k)
        # initialize the rows format - for all the product items
        product_hash = data.dig(:open_trade_transfer_package, :products, @fh[:product_name].to_sym, :printed_circuits_fabrication_data)
        if products.any?
          init_row_format(product_hash)
        end
      end
      # Initialize the rows format - for all default profile items
      @default_column, file_v = @nh.select{|k, v| v[:types].include?("profile_defaults")}.first # this should only be a single file
      if @default_column.present?
        data = file_v[:data]
        product_hash = data.dig(:open_trade_transfer_package, :profiles, :defaults, :printed_circuits_fabrication_data)
        init_row_format(product_hash)
      end
    end

    # populate the @rows
    product_columns.each do |column|
      @master_column = column
      process_row_hash('populate')
    end
    # populate the @rows summary
    product_columns.each do |column|
      @master_column = column
      process_row_hash('get_summary')
    end
    process_row_hash('populate_defaults')
  end

  @fh[:columns] = @columns.unshift(:summary)
  @fh[:rows] = @rows
  @fh
end

#customize_conflict_message(type, col, conflicting_col) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/circuitdata/file_comparer.rb', line 180

def customize_conflict_message(type, col, conflicting_col)
  case type
    when :product
      "#{col.to_s} value conflicts with value from #{conflicting_col.to_s}"
    when :restricted
      "#{col.to_s} value is restricted in #{conflicting_col.to_s}"
    when :enforced
      "#{col.to_s} value conflicts with the enforced value from #{conflicting_col.to_s}"
    when :capability
      "#{col.to_s} value is outside the capabilities of #{conflicting_col.to_s}"
    else
      "There were some value conflicts"
  end
end

#get_column_type(types) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/circuitdata/file_comparer.rb', line 195

def get_column_type(types)
  types ||= []
  if types.include? "product"
    :product
  elsif types.include? "profile_restricted"
    :restricted
  elsif types.include? "profile_enforced"
    :enforced
  elsif types.include? "capabilities"
    :capability
  end
end

#get_l1_hash(columns) ⇒ Object 



257
258
259
260
261
 
# File 'lib/circuitdata/file_comparer.rb', line 257

def get_l1_hash(columns)
  l1_hash = {}
  columns.each{|c| l1_hash[c]={} }
  l1_hash
end

#get_other_conflicts(hash, v, level) ⇒ Object 



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/circuitdata/file_comparer.rb', line 235

def get_other_conflicts(hash, v, level)
  hash[:not_allowed] ||= []
  hash[:messages] ||= []
  not_allowed, messages = [], []
  if v.is_a? Array
    # get items that are not allowed
    msg = v.select{|e| e.include?('contains additional properties [')}.first
    not_allowed = eval(msg[/properties(.*?)outside/m, 1]) rescue []
    messages << "#{not_allowed.to_sentence} are not allowed" if not_allowed.any?
    # get other conflicts
    messages = messages + v.select{|e| !e.include?('contains additional properties [')}
  end
  if not_allowed.any? && level == 'l2'
    not_allowed.each do |spec|
      hash[spec.to_sym] ||= []
      hash[spec.to_sym] = hash[spec.to_sym] << "#{spec} is not a allowed element"
    end
  end
  hash[:not_allowed] = (hash[:not_allowed] + not_allowed).uniq
  hash[:messages] = (hash[:messages] + messages).uniq
end

#get_validation_summary(validation, column) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/circuitdata/file_comparer.rb', line 208

def get_validation_summary(validation, column)
  summary = {}
  if validation[:error]
    summary[:master_conflicts] ||= []
    summary[:master_conflicts] << column
    summary[:conflicts], summary[:rows] = true, {}
    validation[:errors].each do |type, errors| # validation, restricted, enforced, capabilities
      errors.each do |k, v|
        folders_stack = k.split('/')
        folder, spec = folders_stack[5], folders_stack[6]
        if folder.nil?
          get_other_conflicts(summary[:rows], v, 'l1')
        else
          summary[:rows][folder.to_sym] ||= {}
          if spec.nil?
            get_other_conflicts(summary[:rows][folder.to_sym], v, 'l2')
          else
            summary[:rows][folder.to_sym][spec.to_sym] ||= []
            summary[:rows][folder.to_sym][spec.to_sym] = summary[:rows][folder.to_sym][spec.to_sym] + v
          end
        end
      end if errors.any?
    end
  end
  summary
end

#init_row_format(product_hash) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/circuitdata/file_comparer.rb', line 84

def init_row_format(product_hash)
  product_hash.each do |k, v|
    if v.is_a?(Hash)
      @rows[k] ||= {}
      v.each do |kl1, vl1|
        @rows[k][kl1] ||= get_l1_hash(@columns)
      end
    else
      @rows[k] ||= []
      # if array functionality eg Holes
    end if ['Hash', 'Array'].include?(v.class.name)
  end
end

#process_row_hash(action) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/circuitdata/file_comparer.rb', line 98

def process_row_hash(action)
  @rows.each do |k, v| # product elements level

    if v.is_a?(Hash)
      v.each do |kl1, vl1| # specification level
        value, conflict, conflicts_with, conflict_message = [], false, [], []
        vl1.each do |kl2, vl2| # the specification column level - call the function from here
          conflicts = @nh.dig(kl2, :conflicts, @master_column)
          case action
            when 'populate'
              conflict = conflicts.dig(:rows, k, kl1)
              check = conflicts.any? && conflict.present?
              vl2[:value] = @nh.dig(kl2, :data, :open_trade_transfer_package, :products, @fh[:product_name].to_sym, :printed_circuits_fabrication_data, k, kl1)
              vl2[:conflict] = check unless vl2[:conflict] # update only when the status is false
              vl2[:conflicts_with] = check ? ((vl2[:conflicts_with] || []) << @master_column).uniq : vl2[:conflicts_with] || []
              vl2[:conflict_message] = check ? ((vl2[:conflict_message] || []) + conflict).uniq : vl2[:conflict_message] || []
              # update master_column conflicts with
              if check
                master_row = @rows.dig(k, kl1, @master_column)
                master_row[:conflicts_with] = (master_row[:conflicts_with] + conflicts.dig(:master_conflicts)).uniq
                master_row[:conflict] = true
                master_row[:conflict_message] = (master_row[:conflict_message] + vl2[:conflict_message]).uniq
              end
            when 'get_summary'
              # get the summary items
              if kl2 != :summary
                items_v = vl2[:value]
                master_value = vl1.dig(@master_column, :value)
                # dont test if the @master_column value is also nil
                if value.empty? || !value.include?(items_v)
                  value << items_v
                  conflicts_with << kl2
                  # jump the default column
                  if kl2 != @master_column # Add errors to the specific rows items
                    # get the item type
                    col_type = get_column_type(@nh.dig(kl2, :types))
                    vl2[:conflict] = true
                    vl2[:conflicts_with] = (vl2[:conflicts_with] << @master_column).uniq
                    vl2[:conflict_message] = (vl2[:conflict_message] << customize_conflict_message(col_type, kl2, @master_column)).uniq
                    # update the master row
                    master_row = @rows.dig(k, kl1, @master_column)
                    master_row[:conflicts_with] = master_row[:conflicts_with] << kl2
                    master_row[:conflict] = true
                    # get a customized error message here
                    master_row[:conflict_message] = (master_row[:conflict_message] << customize_conflict_message(col_type, @master_column, kl2)).uniq
                  end
                end unless items_v.nil? || master_value.nil?
                conflict = true if vl2[:conflict]
                conflicts_with = conflicts_with + vl2[:conflicts_with]
                conflict_message = conflict_message + vl2[:conflict_message]
              end
            when 'populate_defaults'
              if kl2 == @default_column
                vl2[:value] = @nh.dig(kl2, :data, :open_trade_transfer_package, :profiles, :defaults, :printed_circuits_fabrication_data, k, kl1)
                vl2[:conflict] = false
                vl2[:conflicts_with] = []
                vl2[:conflict_message] = []
              end
          end
        end
        case action
          when 'get_summary'
            if value.count > 1
              conflict = true
            else
              value = value.first
            end
            vl1[:summary] = {value: value, conflict: conflict, conflicts_with: conflicts_with.uniq, conflict_message: conflict_message.uniq}
          when 'populate_defaults'
            # if all the values are blank, use the default value
            vl1[:summary][:value] ||= vl1.dig(@default_column, :value)
        end
        if action == 'get_summary'
        end
        @fh[:conflict] = true if conflict
      end
    else
      # if array functionality eg Holes
    end
  end
end

#valid_product?(products_array) ⇒ Boolean

Returns:

  • (Boolean) 


263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/circuitdata/file_comparer.rb', line 263

def valid_product?(products_array)
  if products_array.uniq.count > 1
    @fh[:error] = true
    @fh[:message] = 'Your files contains several different product names'
    return false # validation fails because of different product names
  end
  if products_array.empty?
    @fh[:error] = true
    @fh[:message] = 'None of the files contains a product'
    return false # c=validation fails because there are no products
  end
  true
end