epb_view_models 1.0.5 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69b8f64ca17a4bef69800fe8a0a13388985993a61f4b2fbfae4c6837226bf04b
-  data.tar.gz: 97eb3db6b6d137c83c9604dfddaaa2eca367dcc3175dba154b3840424a8da6a3
+  metadata.gz: 94ef952761872299d77aff99b1c9ac3d82d1df98a63cd74d0520c1628475f319
+  data.tar.gz: 4466ab181f638cd85fc7ef943f6b78709b770a742dcd07529e708f49c3e9669f
 SHA512:
-  metadata.gz: 982f51ee5ebbf8c03132e1254cdef4e4d9df220243c70a28c58d23c6469a527dbc7d970b0d4b6ab8c5089351b2bd48996a4f69c0c44b44d560111d36fcff68aa
-  data.tar.gz: 9dc487fbe31b3a0596f8d1a77c6dc23480d9d5f03847cf5a91f2b2febd163871b9644f6148c5ec7ca83dab7e827bbb6895308d04ff1a62b30383d0404bc1862f
+  metadata.gz: 69ceeb585c7014f6b47c4a71241d8a5120cf9dee08e41bd53f90ea3b9bf1a7b4e5b29c8dabf643060b471acee26778295c04c83a4fb6bd1000be0deff6ccb959
+  data.tar.gz: 3fe39ccc50a2ddff5fa2040d214b95c56554e45b8332fd5ba9aa29ed57648c7c68bdf9a1210143babd0518d777033fd0db9e8778487d4d0e477a34a4d6c0dd75

data/Gemfile

@@ -10,5 +10,6 @@ source "https://rubygems.org" do
   end
 
   gem "nokogiri", "~> 1.11"
+  gem "rexml", "~> 3.2", ">= 3.2.5"
   gem "zeitwerk", "~> 2.4.2"
 end

data/Gemfile.lock

@@ -83,6 +83,7 @@ PLATFORMS
 DEPENDENCIES
   nokogiri (~> 1.11)!
   rake (~> 13.0.6)!
+  rexml (~> 3.2, >= 3.2.5)!
   rspec (~> 3.0)!
   rubocop-govuk (~> 4.0.0)!
   zeitwerk (~> 2.4.2)!

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.setup
 
 module EpbViewModels
-  VERSION = "1.0.5"
+  VERSION = "1.0.9"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/helper/xml_enums_to_output.rb

@@ -97,6 +97,34 @@ module Helper
       "0" => "Not applicable",
       "NR" => "Not recorded",
     }.freeze
+    CONSTRUCTION_AGE_BAND_NI = {
+      "A" => "Northern Ireland: before 1919",
+      "A-12.0" => "Pre-1900",
+      "B" => "Northern Ireland: 1919-1929",
+      "B-12.0" => "1900-1929",
+      "C" => "Northern Ireland: 1930-1949",
+      "C-12.0" => "1930-1949",
+      "D" => "Northern Ireland: 1950-1973",
+      "D-12.0" => "1950-1966",
+      "E" => "Northern Ireland: 1974-1977",
+      "E-12.0" => "1967-1975",
+      "F" => "Northern Ireland: 1978-1985",
+      "F-12.0" => "1976-1982",
+      "G" => "Northern Ireland: 1986-1991",
+      "G-12.0" => "1983-1990",
+      "H" => "Northern Ireland: 1992-1999",
+      "H-12.0" => "1991-1995",
+      "I" => "Northern Ireland: 2000-2006",
+      "I-12.0" => "1996-2002",
+      "J" => "Northern Ireland: not applicable",
+      "J-12.0" => "2003-2006",
+      "K-RdSAP-NI" => "Northern Ireland: 2007-2013",
+      "K-SAP-NI" => "Northern Ireland: 2007 onwards",
+      "K-12.0" => "Post-2006",
+      "L" => "Northern Ireland: 2014 onwards",
+      "0" => "Not applicable",
+      "NR" => "Not recorded",
+    }.freeze
     PROPERTY_TYPE = {
       "0" => "House",
       "1" => "Bungalow",
@@ -135,7 +163,7 @@ module Helper
       "6" => "mechanical extract, decentralised (MEV dc)",
       "7" => "balanced without heat recovery (MV)",
       "8" => "balanced with heat recovery (MVHR)",
-      "9" => "natural with intermittent extract fans and/or passive vents.  For backwards compatibility only, do not use.",
+      "9" => "natural with intermittent extract fans and/or passive vents. For backwards compatibility only, do not use.",
       "10" => "natural with intermittent extract fans and passive vents",
     }.freeze
     CYLINDER_INSULATION_THICKNESS = {
@@ -278,7 +306,7 @@ module Helper
     end
 
     def self.transaction_type(value, report_type = "2", schema_type = "")
-      types_of_ni = %w[
+      types_of_ni = %i[
         RdSAP-Schema-NI-20.0.0
         RdSAP-Schema-NI-19.0
         RdSAP-Schema-NI-18.0
@@ -303,7 +331,7 @@ module Helper
     end
 
     def self.construction_age_band_lookup(value, schema_type, report_type)
-      types_of_sap_pre17 = %w[
+      types_of_sap_pre17 = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -318,7 +346,7 @@ module Helper
         SAP-Schema-11.0
       ].freeze
 
-      schemes_that_use_not_recorded = %w[
+      schemes_that_use_not_recorded = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -327,14 +355,9 @@ module Helper
         RdSAP-Schema-18.0
         RdSAP-Schema-17.1
         RdSAP-Schema-17.0
-        RdSAP-Schema-NI-20.0.0
-        RdSAP-Schema-NI-19.0
-        RdSAP-Schema-NI-18.0
-        RdSAP-Schema-NI-17.4
-        RdSAP-Schema-NI-17.3
       ]
 
-      schemes_that_use_l = %w[
+      schemes_that_use_l = %i[
         SAP-Schema-18.0.0
         SAP-Schema-17.1
         SAP-Schema-17.0
@@ -343,14 +366,9 @@ module Helper
         RdSAP-Schema-18.0
         RdSAP-Schema-17.1
         RdSAP-Schema-17.0
-        RdSAP-Schema-NI-20.0.0
-        RdSAP-Schema-NI-19.0
-        RdSAP-Schema-NI-18.0
-        RdSAP-Schema-NI-17.4
-        RdSAP-Schema-NI-17.3
       ]
 
-      schemes_that_use_0 = %w[
+      schemes_that_use_0 = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -366,6 +384,25 @@ module Helper
         RdSAP-Schema-18.0
         RdSAP-Schema-17.1
         RdSAP-Schema-17.0
+      ]
+
+      sap_schemas_ni = %i[
+        SAP-Schema-NI-18.0.0
+        SAP-Schema-NI-17.4
+        SAP-Schema-NI-17.3
+        SAP-Schema-NI-17.2
+        SAP-Schema-NI-17.1
+        SAP-Schema-NI-17.0
+        SAP-Schema-NI-16.1
+        SAP-Schema-NI-16.0
+        SAP-Schema-NI-15.0
+        SAP-Schema-NI-14.2
+        SAP-Schema-NI-14.1
+        SAP-Schema-NI-14.0
+        SAP-Schema-NI-13.0
+      ]
+
+      rdsap_schemas_ni = %i[
         RdSAP-Schema-NI-20.0.0
         RdSAP-Schema-NI-19.0
         RdSAP-Schema-NI-18.0
@@ -373,7 +410,29 @@ module Helper
         RdSAP-Schema-NI-17.3
       ]
 
-      if value == "K" && schema_type == "SAP-Schema-12.0" && is_rdsap(report_type)
+      ni_schemas_pre_12 = %i[
+        SAP-Schema-NI-12.0
+        SAP-Schema-NI-11.2
+      ]
+
+      if value == "K" && rdsap_schemas_ni.include?(schema_type)
+        return CONSTRUCTION_AGE_BAND_NI["K-RdSAP-NI"] || value
+      end
+
+      if value == "K" && sap_schemas_ni.include?(schema_type)
+        return CONSTRUCTION_AGE_BAND_NI["K-SAP-NI"] || value
+      end
+
+      if ni_schemas_pre_12.include?(schema_type)
+        key = (value == "0" ? value : "#{value}-12.0")
+        return CONSTRUCTION_AGE_BAND_NI[key] || value
+      end
+
+      if sap_schemas_ni.include?(schema_type) || rdsap_schemas_ni.include?(schema_type)
+        return CONSTRUCTION_AGE_BAND_NI[value] || value
+      end
+
+      if value == "K" && schema_type == :"SAP-Schema-12.0" && is_rdsap(report_type)
         return CONSTRUCTION_AGE_BAND["K-12.0"]
       end
 
@@ -405,14 +464,13 @@ module Helper
     end
 
     def self.mechanical_ventilation(value, schema_type, report_type)
-      types_of_sap_pre12 = %w[
+      types_of_sap_pre12 = %i[
         SAP-Schema-11.2
         SAP-Schema-11.0
         SAP-Schema-10.2
         SAP-Schema-NI-11.2
       ].freeze
-
-      if types_of_sap_pre12.include?(schema_type.to_s) && is_rdsap(report_type)
+      if types_of_sap_pre12.include?(schema_type) && is_rdsap(report_type)
         return MECHANICAL_VENTILATION["#{value}-pre12.0"]
       end
 
@@ -440,7 +498,7 @@ module Helper
     end
 
     def self.ventilation_type(value, schema_type = "")
-      ni_sap = %w[
+      ni_sap = %i[
         SAP-Schema-NI-16.1
         SAP-Schema-NI-16.0
         SAP-Schema-NI-15.0
@@ -539,13 +597,14 @@ module Helper
       if rdsap.include?(schema_type)
         RDSAP_FUEL_TYPE[value]
       elsif sap.include?(schema_type) && is_sap(report_type)
-         SAP_FUEL_TYPE[value]
+        SAP_FUEL_TYPE[value]
       elsif sap.include?(schema_type) && is_rdsap(report_type)
         if includes_rapeseed_oil.include?(schema_type) && value == "36"
           return RDSAP_FUEL_TYPE["#{value}-rapeseed-oil"]
         end
+
         if pre143_sap.include?(schema_type)
-          return RDSAP_FUEL_TYPE_PRE_143["#{value}-pre14.3-sap"] || RDSAP_FUEL_TYPE[value]
+          RDSAP_FUEL_TYPE_PRE_143["#{value}-pre14.3-sap"] || RDSAP_FUEL_TYPE[value]
         else
           RDSAP_FUEL_TYPE[value]
         end

data/lib/presenter/rd_sap/report.rb

@@ -31,7 +31,7 @@ module Presenter
           co2_emissions_potential: @view_model.potential_carbon_emission,
           construction_age_band:
             Helper::XmlEnumsToOutput.construction_age_band_lookup(
-              @view_model.property_age_band,
+              @view_model.main_dwelling_construction_age_band_or_year,
               @schema_type,
               @view_model.report_type,
             ),

data/lib/presenter/xsd.rb

@@ -0,0 +1,76 @@
+module Presenter
+  class Xsd
+    def initialize(assessment_type:, xsd_dir_path: "api/schemas/xml/*/")
+      @assessment_type = assessment_type
+      @xsd_dir_path = xsd_dir_path
+    end
+
+    def get_enums_by_type(simple_type)
+      hash = {}
+      xpath = "//xs:simpleType[@name='#{simple_type}']//xs:enumeration"
+      xsd_files.each do |file_name|
+        doc = REXML::Document.new(File.read(file_name))
+        enums_hash = {}
+        REXML::XPath.each(doc, "#{xpath}/@value") do |e|
+          desc_path = "#{xpath}[@value='#{e.value}']//xs:annotation//xs:documentation"
+          enums_hash.merge!(e.value => REXML::XPath.first(doc, desc_path).children.first)
+        end
+
+        next if enums_hash.empty?
+
+        hash[schema_version(file_name)] = enums_hash
+      end
+      hash
+    end
+
+    def unique_enums(simple_type)
+      uniq_enums = []
+      enums = get_enums_by_type(simple_type).values
+
+      enums.each_with_index do |_hash, i|
+        if i.positive? && (enums[i].to_a != enums[i + 1].to_a)
+          uniq_enums << enums[i]
+        end
+      end
+      uniq_enums
+    end
+
+    def variation_between_schema_versions?(enums_hash)
+      enums_hash.values.flatten.uniq.count != 1
+    end
+
+  private
+
+    def schema_version(file_name)
+      schema_version = file_name.delete_prefix("api/schemas/xml/").split("/").first
+      sap_defnied_in_rdsap_dir?(file_name) ? "#{schema_version}/SAP" : schema_version
+    end
+
+    def xsd_files
+      case @assessment_type
+      when "SAP"
+        sap_xsd_files
+      when "RdSAP"
+        rdsap_xsd_files
+      when "CEPC"
+        cepc_xsd_files
+      end
+    end
+
+    def sap_xsd_files
+      Dir.glob("#{@xsd_dir_path}*-Domains.xsd")
+    end
+
+    def rdsap_xsd_files
+      Dir.glob("#{@xsd_dir_path}SAP-Domains.xsd")
+    end
+
+    def cepc_xsd_files
+      Dir.glob("#{@xsd_dir_path}Reported-Data.xsd")
+    end
+
+    def sap_defnied_in_rdsap_dir?(file_name)
+      @assessment_type == "SAP" && file_name.end_with?("SAP-Domains.xsd")
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.9
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-13 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1661,6 +1661,7 @@ files:
 - lib/presenter/sap/recommendation_report.rb
 - lib/presenter/sap/report.rb
 - lib/presenter/sap/summary.rb
+- lib/presenter/xsd.rb
 - lib/view_model/ac_cert_wrapper.rb
 - lib/view_model/ac_report_wrapper.rb
 - lib/view_model/base_view_model.rb