epb_view_models 2.7.1 → 2.8.0

data/lib/epb_view_models/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EpbViewModels
-  VERSION = "2.7.1"
+  VERSION = "2.8.0"
 end

data/lib/view_model/cepc800/common_schema.rb

@@ -14,31 +14,31 @@ module ViewModel
       end
 
       def address_line1
-        xpath(%w[Property-Address Address-Line-1])
+        xpath(%w[Property-Address Address-Line-1]) or xpath(%w[Property Address-Line-1])
       end
 
       def address_line2
-        xpath(%w[Property-Address Address-Line-2])
+        xpath(%w[Property-Address Address-Line-2]) or xpath(%w[Property Address-Line-2])
       end
 
       def address_line3
-        xpath(%w[Property-Address Address-Line-3])
+        xpath(%w[Property-Address Address-Line-3]) or xpath(%w[Property Address-Line-3])
       end
 
       def address_line4
-        xpath(%w[Property-Address Address-Line-4])
+        xpath(%w[Property-Address Address-Line-4]) or xpath(%w[Property Address-Line-4])
       end
 
       def town
-        xpath(%w[Property-Address Post-Town])
+        xpath(%w[Property-Address Post-Town]) or xpath(%w[Property Post-Town])
       end
 
       def postcode
-        xpath(%w[Property-Address Postcode])
+        xpath(%w[Property-Address Postcode]) or xpath(%w[Property Postcode])
       end
 
       def scheme_assessor_id
-        xpath(%w[Certificate-Number])
+        xpath(%w[Certificate-Number]) or xpath(%w[Membership-Number])
       end
 
       def assessor_name

data/lib/view_model/cepc_s_800/cepc.rb

@@ -0,0 +1,184 @@
+module ViewModel
+  module CepcS800
+    class Cepc < ViewModel::Cepc800::CommonSchema
+      def date_of_expiry
+        expires_at = (Date.parse(date_of_registration) - 1) >> 12 * 10
+
+        expires_at.to_s
+      end
+
+      def building_environment
+        xpath(%w[Building-Environment])
+      end
+
+      def energy_efficiency_rating
+        xpath(%w[Asset-Rating])&.to_i
+      end
+
+      def current_energy_efficiency_band
+        xpath(%w[Energy-Band])
+      end
+
+      def potential_energy_rating
+        xpath(%w[Potential-Rating])&.to_i
+      end
+
+      def potential_energy_band
+        xpath(%w[Potential-Band])
+      end
+
+      def new_build_benchmark_band
+        xpath(%w[New-Build-Benchmark-Band])
+      end
+
+      def comparative_asset_rating
+        xpath(%w[Comparative-Asset-Rating])&.to_i
+      end
+
+      def comparative_asset_band
+        xpath(%w[Comparative-Energy-Band])
+      end
+
+      def epc_rating_ber
+        xpath(%w[BER])&.to_f
+      end
+
+      def approximate_energy_use
+        xpath(%w[Approximate-Energy-Use])&.to_i
+      end
+
+      def floor_area
+        xpath(%w[Technical-Information Floor-Area])&.to_i
+      end
+
+      def main_heating_fuel
+        xpath(%w[Main-Heating-Fuel])
+      end
+
+      def property_type
+        xpath(%w[Property-Type Long-Description])
+      end
+
+      def property_long_description
+        xpath(%w[Property-Type Long-Description])
+      end
+
+      def property_short_description
+        xpath(%w[Property-Type Short-Description])
+      end
+
+      def compliant_2002
+        xpath(%w[Compliant-2002])
+      end
+
+      def renewable_energy_sources
+        @xml_doc.search("Renewable-Energy-Sources").children.search("Renewable-Energy-Source").map(&:content)
+      end
+
+      def electricity_sources
+        @xml_doc.search("Electricity-Sources").children.search("Electricity-Source").map(&:content)
+      end
+
+      def primary_energy_indicator
+        xpath(%w[Primary-Energy-Indicator])&.to_i
+      end
+
+      def calculation_tool
+        xpath(%w[Calculation-Tool])
+      end
+
+      def ter_2002
+        xpath(%w[TER-2002])&.to_f
+      end
+
+      def ter
+        xpath(%w[TER])&.to_f
+      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_payback_recommendations
+        recommendations("Other-Payback")
+      end
+
+      def related_rrn
+        xpath(%w[Related-RRN])
+      end
+
+      def new_build_rating
+        xpath(%w[New-Build-Benchmark])&.to_i
+      end
+
+      def existing_build_rating
+        xpath(%w[Existing-Stock-Benchmark])&.to_i
+      end
+
+      def epc_related_party_disclosure
+        xpath(%w[EPC-Related-Party-Disclosure])
+      end
+
+      def trading_address
+        xpath(%w[Trading-Address])
+      end
+
+      def company_name
+        xpath(%w[Company-Name])
+      end
+
+      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
+
+      def inspection_date
+        xpath(%w[Inspection-Date])
+      end
+
+      def completion_date
+        xpath(%w[Completion-Date])
+      end
+    end
+  end
+end

data/lib/view_model/cepc_wrapper.rb

@@ -65,6 +65,8 @@ module ViewModel
         ViewModel::CepcS70::Cepc.new xml_doc
       when :"CEPC-S-7.1"
         ViewModel::CepcS71::Cepc.new xml_doc
+      when :"CEPC-S-8.0.0"
+        ViewModel::CepcS800::Cepc.new xml_doc
       else
         raise ArgumentError, "Unsupported schema type"
       end

data/lib/view_model/{cs63 → cs63_70}/common_schema.rb

@@ -1,7 +1,7 @@
 require "date"
 
 module ViewModel
-  module Cs63
+  module Cs6370
     class CommonSchema < ViewModel::DomesticEpcViewModel
       THRESHOLD_LOW_ENERGY_LIGHTING_EFFICACY = 65
 

data/lib/view_model/cs63_800/common_schema.rb

@@ -0,0 +1,211 @@
+require "date"
+
+module ViewModel
+  module Cs63800
+    class CommonSchema < ViewModel::DomesticEpcViewModel
+      THRESHOLD_LOW_ENERGY_LIGHTING_EFFICACY = 65
+
+      def assessment_id
+        xpath(%w[Report-Header RRN])
+      end
+
+      def epc_assessment_id
+        xpath(%w[Report-Header EPC-RRN])
+      end
+
+      def sale_lease_date
+        xpath(%w[Report-Header Sale-Lease-Date])
+      end
+
+      def assessment_date
+        xpath(%w[Report-Header Assessment-Date])
+      end
+
+      def plan_report_date
+        xpath(%w[Report-Header Plan-Report-Date])
+      end
+
+      def delegated_protocol_date
+        xpath(%w[Delegated-Protocol-Date])
+      end
+
+      def delegated_protocol_set_up
+        xpath(%w[Delegated-Protocol-Set-Up])
+      end
+
+      def report_type
+        xpath(%w[Report-Header Report-Type])
+      end
+
+      def address_line1
+        xpath(%w[Report-Header Property Address Address-Line-1])
+      end
+
+      def address_line2
+        xpath(%w[Report-Header Property Address Address-Line-2])
+      end
+
+      def address_line3
+        xpath(%w[Report-Header Property Address Address-Line-3])
+      end
+
+      def address_line4
+        xpath(%w[Report-Header Property Address Address-Line-4])
+      end
+
+      def town
+        xpath(%w[Report-Header Property Address Post-Town])
+      end
+
+      def postcode
+        xpath(%w[Report-Header Property Address Postcode])
+      end
+
+      def scheme_assessor_id
+        xpath(%w[Energy-Assessor Membership-Number]) or xpath(%w[Energy-Assessor Certificate-Number])
+      end
+
+      def assessor_name
+        xpath(%w[Energy-Assessor Name])
+      end
+
+      # def approved_organisation_name
+      #   xpath(%w[Energy-Assessor Approved-Organisation-Name])
+      # end
+      #
+      # def approved_organisation_web_address
+      #   xpath(%w[Energy-Assessor Approved-Organisation-Name])
+      # end
+
+      def trading_address
+        xpath(%w[Energy-Assessor Trading-Address])
+      end
+
+      def company_name
+        xpath(%w[Energy-Assessor Company-Name])
+      end
+
+      def status
+        xpath(%w[Energy-Assessor Status])
+      end
+
+      def assessor_email
+        xpath(%w[Energy-Assessor/E-Mail])
+      end
+
+      def assessor_telephone
+        xpath(%w[Energy-Assessor/Telephone-Number])
+      end
+
+      def address_id
+        xpath(%w[UPRN])
+      end
+
+      # def type_of_assessment
+      #   "CS63"
+      # end
+
+      def owner_commission_report
+        xpath(%w[Owner-Commission-Report])
+      end
+
+      def delegated_person_commission_report
+        xpath(%w[Delegated-Person-Commission-Report])
+      end
+
+      def property_type_short_description
+        xpath(%w[Property-Type Short-Description])
+      end
+
+      def property_type_long_description
+        xpath(%w[Property-Type Long-Description])
+      end
+
+      def building_improvements
+        xpath(%w[Improvement-Type Building-Improvements])
+      end
+
+      def operational_ratings
+        xpath(%w[Improvement-Type Operational-Rating])
+      end
+
+      def dec
+        xpath(%w[Operational-Rating-System Display-Energy-Certificate])
+      end
+
+      def planned_completion_date
+        xpath(%w[Improvements-Completion Planned-Completion-Date])
+      end
+
+      def actual_completion_date
+        xpath(%w[Improvements-Completion Actual-Completion-Date])
+      end
+
+      def target_emission_savings
+        xpath(%w[Target-Savings Target-Emission-Savings])&.to_f
+      end
+
+      def target_energy_savings
+        xpath(%w[Target-Savings Target-Energy-Savings])&.to_f
+      end
+
+      def accept_prescriptive_improvements
+        xpath(%w[Prescriptive-Improvements Accept-Prescriptive-Improvements])
+      end
+
+      def prescriptive_improvements
+        @xml_doc
+          .search("Prescriptive-Improvements Prescriptive-Scenario")
+          .map do |node|
+          {
+            measure_description_short:
+              xpath(%w[Measure-Description-Short], node),
+            measure_description_long:
+              xpath(%w[Measure-Description-Long], node),
+            measure_valid: xpath(%w[Measure-Valid], node),
+            measure_type: xpath(%w[Measure-Type], node),
+          }
+        end
+      end
+
+      def alternative_improvements
+        @xml_doc
+          .search("Alternative-Improvements Alternative-Scenario")
+          .map do |node|
+          {
+            measure_description_short:
+              xpath(%w[Measure-Description-Short], node),
+            measure_description_long:
+              xpath(%w[Measure-Description-Long], node),
+            measure_valid: xpath(%w[Measure-Valid], node),
+            measure_type: xpath(%w[Measure-Type], node),
+          }
+        end
+      end
+
+      def date_of_registration
+        xpath(%w[Report-Header Plan-Report-Date])
+      end
+
+      def date_of_expiry
+        Date.parse(date_of_registration).next_month(42).to_s
+      end
+
+      def date_of_assessment
+        xpath(%w[Report-Header Assessment-Date])
+      end
+
+      def related_rrn
+        nil
+      end
+
+      def total_emission_savings
+        xpath(%w[Total-Emission-Savings])
+      end
+
+      def total_energy_savings
+        xpath(%w[Total-Energy-Savings])
+      end
+    end
+  end
+end

data/lib/view_model/cs63_wrapper.rb

@@ -2,9 +2,8 @@ module ViewModel
   class Cs63Wrapper
     attr_reader :view_model
 
-    def initialize(xml_doc, _schema_type, _additional_data = {})
-      @view_model = ViewModel::Cs63::CommonSchema.new xml_doc
-      # @view_model = build_view_model(xml_doc, schema_type)
+    def initialize(xml_doc, schema_type, _additional_data = {})
+      @view_model = build_view_model(xml_doc, schema_type)
       @summary = Presenter::Cs63::Summary.new(view_model)
       @certificate_summary = Presenter::Cs63::CertificateSummary.new(view_model)
     end
@@ -24,5 +23,18 @@ module ViewModel
     def get_view_model
       view_model
     end
+
+  private
+
+    def build_view_model(xml_doc, schema_type)
+      case schema_type
+      when :"CS63-S-7.0"
+        ViewModel::Cs6370::CommonSchema.new xml_doc
+      when :"CS63-S-8.0.0"
+        ViewModel::Cs63800::CommonSchema.new xml_doc
+      else
+        raise ArgumentError, "Unsupported schema type"
+      end
+    end
   end
 end

data/lib/view_model/dec_rr_wrapper.rb

@@ -34,6 +34,8 @@ module ViewModel
 
     def build_view_model(xml_doc, schema_type)
       case schema_type
+      when :"DECAR-S-8.0.0"
+        ViewModel::DecarS800::DecRr.new xml_doc
       when :"DECAR-S-7.0"
         ViewModel::DecarS70::DecRr.new xml_doc
       when :"CEPC-8.0.0"

data/lib/view_model/dec_summary_wrapper.rb

@@ -29,6 +29,8 @@ module ViewModel
 
     def build_view_model(xml_doc, schema_type)
       case schema_type
+      when :"DECAR-S-8.0.0"
+        ViewModel::DecarS800::Dec.new xml_doc
       when :"DECAR-S-7.0"
         ViewModel::DecarS70::Dec.new xml_doc
       when :"CEPC-8.0.0"

data/lib/view_model/dec_wrapper.rb

@@ -35,6 +35,8 @@ module ViewModel
 
     def build_view_model(xml_doc, schema_type)
       case schema_type
+      when :"DECAR-S-8.0.0"
+        ViewModel::DecarS800::Dec.new xml_doc
       when :"DECAR-S-7.0"
         ViewModel::DecarS70::Dec.new xml_doc
       when :"CEPC-8.0.0"

data/lib/view_model/decar_s_800/common_schema.rb

@@ -0,0 +1,109 @@
+module ViewModel
+  module DecarS800
+    class CommonSchema < ViewModel::BaseViewModel
+      def assessment_id
+        xpath(%w[RRN])
+      end
+
+      def date_of_expiry
+        xpath(%w[Valid-Until])
+      end
+
+      def report_type
+        xpath(%w[Report-Type])
+      end
+
+      def address_line1
+        xpath(%w[Property-Address Address-Line-1])
+      end
+
+      def address_line2
+        xpath(%w[Property-Address Address-Line-2])
+      end
+
+      def address_line3
+        xpath(%w[Property-Address Address-Line-3])
+      end
+
+      def address_line4
+        xpath(%w[Property-Address Address-Line-4])
+      end
+
+      def town
+        xpath(%w[Property-Address Post-Town])
+      end
+
+      def postcode
+        xpath(%w[Property-Address Postcode])
+      end
+
+      def scheme_assessor_id
+        xpath(%w[Certificate-Number])
+      end
+
+      def assessor_name
+        xpath(%w[Energy-Assessor Name])
+      end
+
+      def assessor_email
+        xpath(%w[Energy-Assessor E-Mail])
+      end
+
+      def assessor_telephone
+        xpath(%w[Energy-Assessor Telephone-Number])
+      end
+
+      def company_name
+        xpath(%w[Energy-Assessor Company-Name])
+      end
+
+      def company_address
+        xpath(%w[Energy-Assessor Trading-Address])
+      end
+
+      def date_of_assessment
+        xpath(%w[Inspection-Date])
+      end
+
+      def date_of_registration
+        xpath(%w[Registration-Date])
+      end
+
+      def date_of_issue
+        xpath(%w[Issue-Date])
+      end
+
+      def address_id
+        xpath(%w[UPRN])
+      end
+
+      def all_start_dates
+        @xml_doc.search("Start-Date").map(&:content)
+      end
+
+      def all_energy_types
+        @xml_doc.search("Energy-Type").map(&:content)
+      end
+
+      def all_reason_types
+        @xml_doc.search("Reason-Type").map(&:content)
+      end
+
+      def or_assessment_end_date
+        xpath(%w[OR-Operational-Rating OR-Assessment-End-Date])
+      end
+
+      def calculation_tool
+        xpath(%w[Calculation-Details Calculation-Tool])
+      end
+
+      def inspection_type
+        xpath(%w[Calculation-Details Inspection-Type])
+      end
+
+      def building_level
+        xpath(%w[Building-Level])&.to_i
+      end
+    end
+  end
+end