epb_view_models 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb1400b5f7e348d8faa00a740a05fda91b63508dc54848597150190091497f94
-  data.tar.gz: 8227ef648550ae4bb20ebae33ad5699ff8f35130e8541856343afd1b445c751a
+  metadata.gz: bbfe61f3dd422c63e6304d3db50ca8763c08ff397aa9beacd7bcde040b19d3b1
+  data.tar.gz: b3e90e80af3d5d0de7ec5946c88db890a68a4d07fce88329147d2f52fbe85314
 SHA512:
-  metadata.gz: 7cbbf2d87318be4ad27d66f050d6d5ff8a3ef28148a6cc143242796aab3e607d3ecc435df445451ddd31a776a39021b750a948c9bd7a3f06ab6a195ee95a29ea
-  data.tar.gz: 42174b098a15ba44281c3172b6bc6e438c30f06513372af3b591f1b06664b6d29593b6b0a8ba9cdc44397d797386b5edd1f29fb2ce919887e21beee89c774c62
+  metadata.gz: c4ab329d35fd03b1ef595b453c68fb85c34401000eef9bb9d2ad58af7a6fa68d9b4eb850102370e524190321e54cf0b127cb611c8f0a107e9e758bdaa1a1bbd3
+  data.tar.gz: 6205e6087b08acaeb89f181282af4f735d0cb6a0d42d0b769d9d08984fc8c6222b636606860fb76a0bdf9b356dff26b67baa1511201e9c9fa306af20ba61e0b6

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.1.0"
+  VERSION = "1.1.2"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

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,
@@ -40,7 +38,15 @@ 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,
+          potential_energy_efficiency_rating: @view_model.potential_energy_rating,
           type_of_property: Helper::XmlEnumsToOutput.property_type(@view_model.property_type),
+          recommended_improvements: @view_model.improvements.map do |improvement|
+            improvement[:energy_performance_band_improvement] =
+              Helper::EnergyBandCalculator.domestic(
+                improvement[:energy_performance_rating_improvement],
+              )
+            improvement
+          end,
         }
       end
     end

data/lib/presenter/sap/domestic_digest.rb

@@ -35,7 +35,15 @@ 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),
+          potential_energy_efficiency_rating: @view_model.potential_energy_rating,
+          type_of_property: Helper::XmlEnumsToOutput.property_type(@view_model.property_type),
+          recommended_improvements: @view_model.improvements.map do |improvement|
+            improvement[:energy_performance_band_improvement] =
+              Helper::EnergyBandCalculator.domestic(
+                improvement[:energy_performance_rating_improvement],
+              )
+            improvement
+          end,
         }
       end
     end

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),

data/lib/view_model/sap_schema_1910/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.1.0", improvement_number: improvement_code).summary : xpath(%w[Improvement-Summary], node),
+              improvement_description: improvement_code ? accessor.fetch_details(schema_version: "SAP-Schema-19.1.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),

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - DLUHC Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2023-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1658,6 +1658,7 @@ files:
 - api/schemas/xml/examples/SAP-18.0.0.xml
 - api/schemas/xml/examples/SAP-NI-18.0.0.xml
 - epb_view_models.gemspec
+- lib/accessor/domestic_recommendations_accessor.rb
 - lib/epb_view_models.rb
 - lib/helper/ac_report_extraction.rb
 - lib/helper/energy_band_calculator.rb
@@ -1883,7 +1884,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Library used to parse Energy Performance Certificates (EPC)