epb_view_models 1.0.29 → 1.1.1

data/epb_view_models.gemspec

@@ -5,8 +5,8 @@ require_relative "lib/epb_view_models"
 Gem::Specification.new do |spec|
   spec.name          = "epb_view_models"
   spec.version       = EpbViewModels::VERSION
-  spec.authors       = ["MHCLG Energy Performance of Buildings"]
-  spec.email         = ["mhclg.digital-services@communities.gov.uk"]
+  spec.authors       = ["DLUHC Energy Performance of Buildings"]
+  spec.email         = ["dluhc.digital-services@levellingup.gov.uk"]
   spec.summary       = "Library used to parse Energy Performance Certificates (EPC)"
   spec.homepage      = "https://github.com/communitiesuk/epb-view-models"
   spec.license       = "MIT"

data/lib/accessor/domestic_recommendations_accessor.rb

@@ -0,0 +1,50 @@
+require "singleton"
+
+module Accessor
+  class DomesticRecommendationsAccessor
+    include Singleton
+
+    RecommendationDetails = Struct.new(:summary, :description, keyword_init: true)
+
+    def fetch_details(schema_version:, improvement_number:)
+      unless memoized_schema?(schema_version)
+        assessment_type = schema_version.split("-").first
+        is_ni = schema_version.include? "-NI-"
+        definitions_document = Nokogiri::XML(File.open("api/schemas/xml/#{schema_version}/#{assessment_type}/ExternalDefinitions.xml"))
+        sub_object = {}
+        country_node = definitions_document.at_xpath("//Country[Country-Code[contains(text(), '#{is_ni ? 'NIR' : 'EAW'}')]]")
+        recommendations = country_node.search("Recommendation")
+        recommendations.each do |recommendation|
+          sub_object[recommendation.at_css("Improvement-Number").content] = {
+            summary: recommendation.at_css("Improvement-Summary[language='1']").content,
+            description: recommendation.at_css("Improvement-Description[language='1']").content,
+          }
+        end
+        memoize_schema_hash(schema_version, sub_object)
+      end
+      RecommendationDetails.new(**memoized_schema(schema_version)[improvement_number])
+    end
+
+    def reset!
+      @memo = nil
+    end
+
+  private
+
+    def memo
+      @memo ||= {}
+    end
+
+    def memoized_schema?(schema_version)
+      memo.key?(schema_version)
+    end
+
+    def memoize_schema_hash(schema_version, hash)
+      memo[schema_version] = hash
+    end
+
+    def memoized_schema(schema_version)
+      memo[schema_version]
+    end
+  end
+end

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.setup
 
 module EpbViewModels
-  VERSION = "1.0.29"
+  VERSION = "1.1.1"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/helper/xml_enums_to_output.rb

@@ -372,6 +372,7 @@ module Helper
       ]
 
       schemes_that_use_l = %i[
+        SAP-Schema-19.1.0
         SAP-Schema-19.0.0
         SAP-Schema-18.0.0
         SAP-Schema-17.1
@@ -576,6 +577,7 @@ module Helper
       ]
 
       sap = %i[
+        SAP-Schema-19.1.0
         SAP-Schema-19.0.0
         SAP-Schema-18.0.0
         SAP-Schema-17.1

data/lib/presenter/rd_sap/domestic_digest.rb

@@ -10,8 +10,6 @@ module Presenter
       end
 
       def to_domestic_digest
-
-
         {
           type_of_assessment: TYPE_OF_ASSESSMENT,
           assessment_id: @view_model.assessment_id,

data/lib/presenter/sap/domestic_digest.rb

@@ -35,7 +35,7 @@ module Presenter
           total_floor_area: @view_model.total_floor_area.to_s,
           has_mains_gas: @view_model.mains_gas,
           current_energy_efficiency_rating: @view_model.current_energy_rating,
-          type_of_property:   Helper::XmlEnumsToOutput.property_type(@view_model.property_type),
+          type_of_property: Helper::XmlEnumsToOutput.property_type(@view_model.property_type),
         }
       end
     end

data/lib/view_model/factory.rb

@@ -26,6 +26,7 @@ module ViewModel
       RdSAP-Schema-NI-17.3
     ].freeze
     TYPES_OF_SAP = %i[
+      SAP-Schema-19.1.0
       SAP-Schema-19.0.0
       SAP-Schema-18.0.0
       SAP-Schema-17.1

data/lib/view_model/rd_sap_schema_200/common_schema.rb

@@ -117,15 +117,16 @@ module ViewModel
       end
 
       def recommendations_for_report
+        accessor = Accessor::DomesticRecommendationsAccessor.instance
         @xml_doc
           .search("Suggested-Improvements Improvement")
           .map do |node|
+            improvement_code = xpath(%w[Improvement-Details Improvement-Number], node)
             {
               sequence: xpath(%w[Sequence], node).to_i,
-              improvement_summary: xpath(%w[Improvement-Summary], node),
-              improvement_description: xpath(%w[Improvement-Description], node),
-              improvement_code:
-                xpath(%w[Improvement-Details Improvement-Number], node),
+              improvement_code: xpath(%w[Improvement-Details Improvement-Number], node),
+              improvement_summary: improvement_code ? accessor.fetch_details(schema_version: "RdSAP-Schema-20.0.0", improvement_number: improvement_code).summary : xpath(%w[Improvement-Summary], node),
+              improvement_description: improvement_code ? accessor.fetch_details(schema_version: "RdSAP-Schema-20.0.0", improvement_number: improvement_code).description : xpath(%w[Improvement-Description], node),
               indicative_cost: xpath(%w[Indicative-Cost], node),
             }
           end

data/lib/view_model/sap_schema_1800/common_schema.rb

@@ -112,13 +112,15 @@ module ViewModel
       end
 
       def recommendations_for_report
+        accessor = Accessor::DomesticRecommendationsAccessor.instance
         @xml_doc
           .search("Suggested-Improvements Improvement")
           .map do |node|
+            improvement_code = xpath(%w[Improvement-Details Improvement-Number], node)
             {
               sequence: xpath(%w[Sequence], node).to_i,
-              improvement_summary: xpath(%w[Improvement-Summary], node),
-              improvement_description: xpath(%w[Improvement-Description], node),
+              improvement_summary: improvement_code ? accessor.fetch_details(schema_version: "SAP-Schema-18.0.0", improvement_number: improvement_code).summary : xpath(%w[Improvement-Summary], node),
+              improvement_description: improvement_code ? accessor.fetch_details(schema_version: "SAP-Schema-18.0.0", improvement_number: improvement_code).description : xpath(%w[Improvement-Description], node),
               improvement_code:
                 xpath(%w[Improvement-Details Improvement-Number], node),
               indicative_cost: xpath(%w[Indicative-Cost], node),

data/lib/view_model/sap_schema_1900/common_schema.rb

@@ -114,13 +114,15 @@ module ViewModel
       end
 
       def recommendations_for_report
+        accessor = Accessor::DomesticRecommendationsAccessor.instance
         @xml_doc
           .search("Suggested-Improvements Improvement")
           .map do |node|
+            improvement_code = xpath(%w[Improvement-Details Improvement-Number], node)
             {
               sequence: xpath(%w[Sequence], node).to_i,
-              improvement_summary: xpath(%w[Improvement-Summary], node),
-              improvement_description: xpath(%w[Improvement-Description], node),
+              improvement_summary: improvement_code ? accessor.fetch_details(schema_version: "SAP-Schema-19.0.0", improvement_number: improvement_code).summary : xpath(%w[Improvement-Summary], node),
+              improvement_description: improvement_code ? accessor.fetch_details(schema_version: "SAP-Schema-19.0.0", improvement_number: improvement_code).description : xpath(%w[Improvement-Description], node),
               improvement_code:
                 xpath(%w[Improvement-Details Improvement-Number], node),
               indicative_cost: xpath(%w[Indicative-Cost], node),