dcm 0.1.40 → 0.1.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85523d78e04f2eeb5e8bf38d9ee2658398d0e308f4f0ca7e137ea5dbe131714
-  data.tar.gz: 269fc302304ec5501dc6e2e83a19c2584a999e781f44fb2503c7287cc77228cd
+  metadata.gz: 893d24fa86203061555148240254ace73ba85975d36f9449cd74f599c88ee08e
+  data.tar.gz: 89b17bfb7cee34c53740ef746caed7dc04dad53db24cf261b186ce561f0b870c
 SHA512:
-  metadata.gz: 3f0208509522fc67cbeea93a25a722c056d6f5781111ec8f4b931aa52188030f662a95d15710b96f663be8d8c5c591c79b5adbb1913e01ad84ad6a9d342b2442
-  data.tar.gz: 11e4795e958bf596dc3f3bbb9fc459ecc7433bf250ab71bd3e4dbf65bc34ad0bf3900fbb894f348f63996d7562aeaacd0c4da1fc75c37e7319e102cc9d89933c
+  metadata.gz: e0288e78d05b9839d1ba4fc52613122f42b998143e6809ec940755325386c94c877d7347afafaf40f5c3d97fa0a2d7ed28eecfad897ad337093b8f98fef16b4f
+  data.tar.gz: d7d35172ec067a7ec121f4d5412a763f477f2cd5a9723f9daa1b9893b0dbf4748153d014af85dce13dbcf0173db5cda43733e1cca14c6fb8e41727cd4cb9246f

data/lib/codinginfo.rb

@@ -1,51 +1,21 @@
 require_relative "file_cache"
 
 class Codinginfo
-  CVAR_PREFIX_REGEXP = /^CVAR_[A-Za-z0-9_]+_\d+\./
+  CVAR_PREFIX_REGEXP = /\ACVAR_[A-Za-z0-9_]+_\d+\./
   PARAM_ASSIGNMENT_HEADERS = { name: /Parameter/, cvar: /Schalter/, package: /Komponente|Component/ }
 
-  class Cvar
-
-    # The CVAR must have a name and _may_ have a package and value.
-    # The package and value can be merged
-
-    attr_reader :name, :value, :package
-    attr_accessor :assignments
-    def initialize(name:, package: nil, value: nil)
-      @name        = name
-      @package     = package
-      @value       = value
-      @assignments = []
-    end
-
-    def match?(label)
-      # assignments
-      #   .values
-      #   .select { _1.name == name }
-      #   .map { combine(_1) }
-      #   .any? { label.name.match?(_1.label_prefix) }
-      label.name.match?(label_prefix)
-    end
-
-    def label_prefix
-      @label_prefix ||= if package
-        [name, package, value].join("_") + "."
-      else
-        /^#{name}_([A-Za-z0-9]+_)?#{value}\./
-      end
-    end
-
-    def to_s = "#{name}=#{value}"
-    def ==(other) = name == other.name
-
-    def combine(other)
-      fail "Cannot combine #{name} with #{other.name}" unless self == other
-
-      self.class.new \
-        name: name,
-        package: package || other.package,
-        value: value || other.value
-    end
+  # Coded labels carry the CVAR value of their variant in the name:
+  #
+  #   CVAR_Market_FooBar_1.PAR_FooBar_cnt_DeacCyc   with package
+  #   CVAR_Obd_3.Foo_Supported                      without package
+  #   \_______________/ \_______________________/
+  #        prefix               parameter
+  #
+  # The spreadsheet assigns each parameter to a CVAR (and package) and
+  # lists each variant's CVAR values. Together they define the prefix.
+
+  Assignment = Data.define(:cvar, :package) do
+    def prefix(value) = [cvar, package, value].compact.join("_") + "."
   end
 
   class Variant
@@ -53,10 +23,10 @@ class Codinginfo
       @properties = headers.zip(row).to_h
     end
 
-    def cvars
-      @cvars ||= @properties
+    def cvar_values
+      @cvar_values ||= @properties
         .select { |key, _| key.start_with?("CVAR_") }
-        .map { Cvar.new(name: _1, value: _2.to_i) }
+        .transform_values(&:to_i)
     end
 
     def attributes
@@ -66,27 +36,42 @@ class Codinginfo
         .select { |_, val| val == 0 || val == 1 || val == "-" }
     end
 
+    # Is the label coded for one of this variant's CVAR values? The package
+    # is unknown here, so any single-word package is accepted.
     def has_matching_cvar?(label)
-      cvars.any? { _1.match?(label) }
+      matching_prefix.match?(label.name)
+    end
+
+    def prefix_for(assignment)
+      value = cvar_values.fetch(assignment.cvar) do
+        fail "Variant #{description} has no value for #{assignment.cvar}"
+      end
+
+      assignment.prefix(value)
     end
 
     def description = @properties[:swfk_id]
+
+    private
+
+    def matching_prefix
+      @matching_prefix ||= cvar_values
+        .map { |cvar, value| "#{Regexp.escape(cvar)}_(?:[A-Za-z0-9]+_)?#{value}" }
+        .then { /\A(?:#{_1.join("|")})\./ }
+    end
   end
 
   def initialize(filepath, filter, nocache: false)
     @filter      = filter
-    @variants    = []
 
     parsed = nocache ? parse_xlsx(filepath) : FileCache.get(filepath) { parse_xlsx(filepath) }
 
     @headers     = parsed[:headers]
     @assignments = parsed[:assignments]
 
-    parsed[:rows].each do |row|
-      next unless filter.match?(@headers, row)
-
-      @variants << Variant.new(@headers, row)
-    end
+    @variants    = parsed[:rows]
+      .select { filter.match?(@headers, _1) }
+      .map { Variant.new(@headers, _1) }
   end
 
   def variant
@@ -107,21 +92,20 @@ class Codinginfo
   def unflatten_list(list)
     fail "No variants found matching #{@filter}" if @variants.empty?
 
-    Ecu::LabelList.new \
-      list.flat_map { |label|
-        if has_cvar_assignment?(label)
-          @variants.map { label.with(name: add_cvar_prefix(label.name, _1)) }
-        else
-          label
-        end
-      }.uniq,
-      variants_description
+    labels = list.flat_map do |label|
+      next label unless has_cvar_assignment?(label)
+
+      @variants.map { add_cvar_prefix(label, _1) }
+    end
+
+    # Variants sharing a CVAR value yield identical labels
+    Ecu::LabelList.new(labels.uniq(&:name), variants_description)
   end
 
   def flatten_list(list)
     list
       .select { !cvar_coded?(_1) || variant.has_matching_cvar?(_1) }
-      .map_int { _1.with(name: remove_cvar_prefix(_1.name)) }
+      .map_int { remove_cvar_prefix(_1) }
       .with(headers: variants_description)
   end
 
@@ -139,16 +123,16 @@ class Codinginfo
     @assignments.key?(label.name)
   end
 
-  def add_cvar_prefix(name, variant)
-    variant
-      .cvars
-      .find { _1 == @assignments[name] }
-      .then { _1.combine(@assignments[name]) } # this adds the package to the CVar
-      .then { _1.label_prefix + name }
+  def add_cvar_prefix(label, variant)
+    prefix = variant.prefix_for(@assignments.fetch(label.name))
+
+    label.with(name: prefix + label.name)
   end
 
-  def remove_cvar_prefix(name)
-    name.sub(CVAR_PREFIX_REGEXP, "")
+  def remove_cvar_prefix(label)
+    return label unless cvar_coded?(label)
+
+    label.with(name: label.name.sub(CVAR_PREFIX_REGEXP, ""))
   end
 
   private
@@ -176,16 +160,25 @@ class Codinginfo
     doc.sheets
       .find { _1.name == "Parameterdefinition" }
       .tap { fail "Cannot find sheet Parameterdefinition" if _1.nil? }
+      .tap { fail "Cannot find headers for Parameterdefinition" unless param_headers_present?(_1.rows.first) }
       .rows
       .each(headers: PARAM_ASSIGNMENT_HEADERS) do |row|
         next if row[:cvar].nil?
 
-        assignments[row[:name]] = Cvar.new(name: row[:cvar], package: row[:package])
+        assignments[row[:name]] = Assignment.new(row[:cvar], row[:package])
       end
 
     { headers: headers, rows: rows, assignments: assignments }
   end
 
+  # The reader accepts a header row matching at least one header; a misspelt
+  # one would otherwise surface much later as nil values.
+  def param_headers_present?(header_row)
+    return false unless header_row
+
+    PARAM_ASSIGNMENT_HEADERS.values.all? { |regexp| header_row.any? { _1.match?(regexp) } }
+  end
+
   def parse_headers!(headers, row)
     return false unless row[1]&.match?(/SWFK-ID/)
     return false unless row[1]&.match?(/CVAR_BeguData/)

data/lib/file_cache.rb

@@ -25,11 +25,10 @@ class FileCache
   end
 
   def cache!
-    return read_cache if cached?
+    hit = read_cache if cached?
+    return hit unless hit.nil?
 
     yield.tap { write_cache(_1) }
-  rescue
-    yield
   end
 
   def clear!
@@ -50,12 +49,17 @@ class FileCache
     File.mtime(filepath) < File.mtime(cachefilepath)
   end
 
+  # An unreadable cache (e.g. written by an older version) counts as a miss
   def read_cache
-    Marshal.load(File.open(cachefilepath, "rb") { _1.read })
+    Marshal.load(File.binread(cachefilepath))
+  rescue ArgumentError, TypeError, EOFError, SystemCallError
+    nil
   end
 
   def write_cache(obj)
-    File.open(cachefilepath, "wb") { _1.write(Marshal.dump(obj)) }
+    File.binwrite(cachefilepath, Marshal.dump(obj))
+  rescue SystemCallError
+    # A failed write must not fail the command
   end
 
   def cachefilepath

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Dcm
-  VERSION = "0.1.40"
+  VERSION = "0.1.41"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dcm
 version: !ruby/object:Gem::Version
-  version: 0.1.40
+  version: 0.1.41
 platform: ruby
 authors:
 - Jonas Mueller