epb_view_models 2.2.0 → 2.2.1

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

data/lib/presenter/cepc/certificate_summary.rb

@@ -0,0 +1,148 @@
+module Presenter
+  module Cepc
+    class CertificateSummary
+      TYPE_OF_ASSESSMENT = "CEPC".freeze
+
+      def initialize(view_model)
+        @view_model = view_model
+      end
+
+      def to_certificate_summary
+        {
+          type_of_assessment: TYPE_OF_ASSESSMENT,
+          assessment_id: @view_model.assessment_id,
+          date_of_expiry: @view_model.date_of_expiry,
+          report_type: @view_model.report_type,
+          date_of_assessment: @view_model.date_of_assessment,
+          date_of_registration: @view_model.date_of_registration,
+          address: {
+            address_line1: @view_model.address_line1,
+            address_line2: @view_model.address_line2,
+            address_line3: @view_model.address_line3,
+            address_line4: @view_model.address_line4,
+            town: @view_model.town,
+            postcode: @view_model.postcode,
+          },
+          assessor: {
+            scheme_assessor_id: @view_model.scheme_assessor_id,
+            name: @view_model.assessor_name,
+            contact_details: {
+              email: @view_model.assessor_email,
+              telephone: @view_model.assessor_telephone,
+            },
+          },
+          technical_information: {
+            main_heating_fuel: @view_model.main_heating_fuel,
+            building_environment: @view_model.building_environment,
+            floor_area: @view_model.floor_area,
+            building_level: @view_model.building_level,
+          },
+          building_emission_rate: @view_model.respond_to?(:building_emission_rate) ? @view_model.building_emission_rate : nil,
+          primary_energy_use: @view_model.respond_to?(:primary_energy_use) ? @view_model.primary_energy_use : nil,
+          related_rrn: @view_model.related_rrn,
+          new_build_rating: @view_model.new_build_rating,
+          new_build_band: Helper::EnergyBandCalculator.commercial(@view_model.new_build_rating),
+          existing_build_rating: @view_model.existing_build_rating,
+          existing_build_band: Helper::EnergyBandCalculator.commercial(@view_model.existing_build_rating),
+          current_energy_efficiency_rating: @view_model.energy_efficiency_rating,
+          energy_efficiency_rating: @view_model.energy_efficiency_rating,
+          related_party_disclosure: @view_model.epc_related_party_disclosure,
+          current_energy_efficiency_band: Helper::EnergyBandCalculator.commercial(@view_model.energy_efficiency_rating),
+          property_type: @view_model.property_type,
+          building_complexity: @view_model.building_level,
+        }
+      end
+
+      def to_certificate_summary_scotland
+        {
+          type_of_assessment: TYPE_OF_ASSESSMENT,
+          assessment_id: @view_model.assessment_id,
+          date_of_expiry: @view_model.date_of_expiry,
+          report_type: @view_model.report_type,
+          date_of_assessment: @view_model.date_of_assessment,
+          date_of_registration: @view_model.date_of_registration,
+          address: {
+            address_line1: @view_model.address_line1,
+            address_line2: @view_model.address_line2,
+            address_line3: @view_model.address_line3,
+            address_line4: @view_model.address_line4,
+            town: @view_model.town,
+            postcode: @view_model.postcode,
+          },
+          assessor: {
+            scheme_assessor_id: @view_model.scheme_assessor_id,
+            name: @view_model.assessor_name,
+            contact_details: {
+              email: @view_model.assessor_email,
+              telephone: @view_model.assessor_telephone,
+              trading_address: @view_model.trading_address,
+            },
+            company_name: @view_model.company_name,
+            insurer: @view_model.insurer,
+            policy_no: @view_model.policy_no,
+            insurer_effective_date: @view_model.insurer_effective_date,
+            insurer_expiry_date: @view_model.insurer_expiry_date,
+            insurer_pi_limit: @view_model.insurer_pi_limit,
+          },
+          technical_information: {
+            main_heating_fuel: @view_model.main_heating_fuel,
+            building_environment: @view_model.building_environment,
+            floor_area: @view_model.floor_area,
+          },
+          current_energy_efficiency_rating: @view_model.energy_efficiency_rating,
+          potential_energy_rating: @view_model.potential_energy_rating,
+          current_energy_efficiency_band: @view_model.current_energy_efficiency_band,
+          potential_energy_band: @view_model.potential_energy_band,
+          new_build_benchmark_rating: @view_model.new_build_benchmark_rating,
+          new_build_benchmark_band: @view_model.new_build_benchmark_band,
+          comparative_asset_rating: @view_model.comparative_asset_rating,
+          epc_rating_ber: @view_model.epc_rating_ber,
+          approximate_energy_use: @view_model.approximate_energy_use,
+          property_type: @view_model.property_type,
+          property_short_description: @view_model.property_short_description,
+          compliant_2002: @view_model.compliant_2002,
+          renewable_energy_sources: @view_model.renewable_energy_sources,
+          electricity_sources: @view_model.electricity_sources,
+          primary_energy_indicator: @view_model.primary_energy_indicator,
+          calculation_tool: @view_model.calculation_tool,
+          ter_2002: @view_model.ter_2002,
+          ter: @view_model.ter,
+          recommendations: [
+            @view_model.short_payback_recommendations.map do |recommendation|
+              {
+                payback_type: "short",
+                recommendation_code: recommendation[:code],
+                recommendation: recommendation[:text],
+                cO2_Impact: recommendation[:cO2Impact],
+              }
+            end,
+            @view_model.medium_payback_recommendations.map do |recommendation|
+              {
+                payback_type: "medium",
+                recommendation_code: recommendation[:code],
+                recommendation: recommendation[:text],
+                cO2_Impact: recommendation[:cO2Impact],
+              }
+            end,
+            @view_model.long_payback_recommendations.map do |recommendation|
+              {
+                payback_type: "long",
+                recommendation_code: recommendation[:code],
+                recommendation: recommendation[:text],
+                cO2_Impact: recommendation[:cO2Impact],
+              }
+            end,
+            @view_model.other_recommendations.map do |recommendation|
+              {
+                payback_type: "other",
+                recommendation_code: recommendation[:code],
+                recommendation: recommendation[:text],
+                cO2_Impact: recommendation[:cO2Impact],
+              }
+            end,
+          ].flatten,
+        }
+      end
+    end
+  end
+end

data/lib/view_model/base_view_model.rb

@@ -1,3 +1,5 @@
+require "date"
+
 module ViewModel
   class BaseViewModel
     def initialize(xml_doc)

data/lib/view_model/cepc_s_71/cepc.rb

@@ -7,48 +7,48 @@ module ViewModel
         expires_at.to_s
       end
 
-      def ac_inspection_commissioned
-        xpath(%w[AC-Inspection-Commissioned])
+      def building_environment
+        xpath(%w[Building-Environment])
       end
 
-      def ac_kw_rating
-        xpath(%w[AC-kW-Rating])&.to_i
+      def energy_efficiency_rating
+        xpath(%w[Asset-Rating])&.to_i
       end
 
-      def ac_present
-        xpath(%w[AC-Present])
+      def current_energy_efficiency_band
+        xpath(%w[Energy-Band])
       end
 
-      def ac_rated_output
-        xpath(%w[AC-Rated-Output])
+      def potential_energy_rating
+        xpath(%w[Potential-Rating])
       end
 
-      def building_emission_rate
-        xpath(%w[BER])
+      def potential_energy_band
+        xpath(%w[Potential-Band])
       end
 
-      def building_environment
-        xpath(%w[Building-Environment])
+      def new_build_benchmark_rating
+        xpath(%w[New-Build-Benchmark])
       end
 
-      def building_level
-        xpath(%w[Building-Level])&.to_i
+      def new_build_benchmark_band
+        xpath(%w[New-Build-Benchmark-Band])
       end
 
-      def energy_efficiency_rating
-        xpath(%w[Asset-Rating])&.to_i
+      def comparative_asset_rating
+        xpath(%w[Comparative-Asset-Rating])
       end
 
-      def epc_related_party_disclosure
-        xpath(%w[EPC-Related-Party-Disclosure])
+      def comparative_asset_band
+        xpath(%w[Comparative-Energy-Band])
       end
 
-      def estimated_ac_kw_rating
-        xpath(%w[AC-Estimated-Output])&.to_i
+      def epc_rating_ber
+        xpath(%w[BER])
       end
 
-      def existing_build_rating
-        xpath(%w[Existing-Stock-Benchmark])&.to_i
+      def approximate_energy_use
+        xpath(%w[Approximate-Energy-Use])
       end
 
       def floor_area
@@ -59,48 +59,121 @@ module ViewModel
         xpath(%w[Main-Heating-Fuel])
       end
 
-      def new_build_rating
-        xpath(%w[New-Build-Benchmark])&.to_i
+      def property_type
+        xpath(%w[Property-Type])
       end
 
-      def other_fuel_description
-        xpath(%w[Other-Fuel-Description])
+      def property_short_description
+        xpath(%w[Property-Type Short-Description])
       end
 
-      def primary_energy_use
-        xpath(%w[Energy-Consumption-Current])
+      def compliant_2002
+        xpath(%w[Compliant-2002])
       end
 
-      def property_type
-        xpath(%w[Property-Type])
+      def renewable_energy_sources
+        @xml_doc.search("Renewable-Energy-Sources").map(&:content)
+      end
+
+      def electricity_sources
+        @xml_doc.search("Electricity-Sources").map(&:content)
+      end
+
+      def primary_energy_indicator
+        xpath(%w[Primary-Energy-Indicator])
+      end
+
+      def calculation_tool
+        xpath(%w[Calculation-Tool])
+      end
+
+      def ter_2002
+        xpath(%w[TER-2002])
+      end
+
+      def ter
+        xpath(%w[TER])
+      end
+
+      def renewable_sources
+        xpath(%w[Renewable-Sources])
+      end
+
+      def recommendations(payback = "")
+        if payback.empty?
+          # return an enumerable of all nodes
+          @xml_doc.xpath "Recommendations-Report RR-Recommendations"
+        else
+          @xml_doc
+            .search("Recommendations-Report RR-Recommendations/#{payback}")
+            .map do |node|
+            {
+              code: node.at("Recommendation-Code").content,
+              text: node.at("Recommendation").content,
+              cO2Impact: node.at("CO2-Impact").content,
+            }
+          end
+        end
+      end
+
+      def short_payback_recommendations
+        recommendations("Short-Payback")
+      end
+
+      def medium_payback_recommendations
+        recommendations("Medium-Payback")
+      end
+
+      def long_payback_recommendations
+        recommendations("Long-Payback")
+      end
+
+      def other_recommendations
+        recommendations("Other-Payback")
       end
 
       def related_rrn
         xpath(%w[Related-RRN])
       end
 
-      def special_energy_uses
-        xpath(%w[Special-Energy-Uses])
+      def new_build_rating
+        xpath(%w[New-Build-Benchmark])&.to_i
       end
 
-      def standard_emissions
-        xpath(%w[SER])
+      def existing_build_rating
+        xpath(%w[Existing-Stock-Benchmark])&.to_i
       end
 
-      def target_emissions
-        xpath(%w[TER])
+      def epc_related_party_disclosure
+        xpath(%w[EPC-Related-Party-Disclosure])
       end
 
-      def transaction_type
-        xpath(%w[Transaction-Type])
+      def trading_address
+        xpath(%w[Trading-Address])
       end
 
-      def typical_emissions
-        xpath(%w[TYR])
+      def company_name
+        xpath(%w[Company-Name])
       end
 
-      def renewable_sources
-        xpath(%w[Renewable-Sources])
+      def insurer
+        xpath(%w[Insurer])
+      end
+
+      def policy_no
+        xpath(%w[Policy-No])
+      end
+
+      def insurer_effective_date
+        xpath(%w[Effective-Date])
+      end
+
+      def insurer_expiry_date
+        xpath(%w[Expiry-Date])
+      end
+
+      def insurer_pi_limit
+        xpath(%w[PI-Limit])
       end
     end
   end

data/lib/view_model/cepc_wrapper.rb

@@ -6,6 +6,7 @@ module ViewModel
       @view_model = build_view_model(xml_doc, schema_type)
       @summary = Presenter::Cepc::Summary.new(view_model)
       @report = Presenter::Cepc::Report.new(view_model, additional_data)
+      @certificate_summary = Presenter::Cepc::CertificateSummary.new(view_model)
     end
 
     def type
@@ -22,6 +23,14 @@ module ViewModel
       @report.to_hash
     end
 
+    def to_certificate_summary
+      @certificate_summary.to_certificate_summary
+    end
+
+    def to_certificate_summary_scotland
+      @certificate_summary.to_certificate_summary_scotland
+    end
+
     def get_report_type
       view_model.report_type
     end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-01-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -38,7 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-description:
 email:
 - mhclg.digital-services@levellingup.gov.uk
 executables: []
@@ -1572,6 +1570,7 @@ files:
 - lib/presenter/ac_cert/summary.rb
 - lib/presenter/ac_report/export_configuration.rb
 - lib/presenter/ac_report/summary.rb
+- lib/presenter/cepc/certificate_summary.rb
 - lib/presenter/cepc/export_configuration.rb
 - lib/presenter/cepc/report.rb
 - lib/presenter/cepc/summary.rb
@@ -1782,7 +1781,6 @@ homepage: https://github.com/communitiesuk/epb-view-models
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1797,8 +1795,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Library used to parse Energy Performance Certificates (EPC)
 test_files: []