epb_view_models 2.2.21 → 2.4.0

data/lib/epb_view_models/version.rb

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

data/lib/epb_view_models.rb

@@ -4,9 +4,7 @@ require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.setup
 
-module EpbViewModels
-  VERSION = "2.2.21"
-end
+require "epb_view_models/version"
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast
 # Source: http://jeffgardner.org/2011/08/04/rails-string-to-boolean-method/

data/lib/helper/rrn_helper.rb

@@ -2,9 +2,9 @@ require "digest"
 
 module Helper
   class RrnHelper
-    class RrnNotValid < StandardError
-    end
-    VALID_RRN = "^(\\d{4}-){4}\\d{4}$".freeze
+    class RrnNotValid < StandardError; end
+
+    VALID_RRN = /\A(\d{4}-){4}\d{4}\z/
 
     def self.normalise_rrn_format(rrn)
       # Strip surrounding whitespace
@@ -16,7 +16,7 @@ module Helper
 
       # Add a hyphen every four characters to give desired RRN format
       rrn = rrn.scan(/.{1,4}/).join("-")
-      raise RrnNotValid unless Regexp.new(VALID_RRN).match(rrn)
+      raise RrnNotValid unless VALID_RRN.match?(rrn)
 
       rrn
     end

data/lib/view_model/cs63/common_schema.rb

@@ -157,14 +157,14 @@ module ViewModel
         @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),
-            }
+          {
+            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
 
@@ -172,14 +172,14 @@ module ViewModel
         @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),
-            }
+          {
+            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
 
@@ -200,11 +200,11 @@ module ViewModel
       end
 
       def total_emission_savings
-      xpath(%w[Total-Emission-Savings])
+        xpath(%w[Total-Emission-Savings])
       end
 
       def total_energy_savings
-      xpath(%w[Total-Energy-Savings])
+        xpath(%w[Total-Energy-Savings])
       end
     end
   end

data/lib/view_model/factory.rb

@@ -41,6 +41,8 @@ module ViewModel
       RdSAP-Schema-S-18.0
       RdSAP-Schema-S-17.00
       RdSAP-Schema-S-16.1
+      RdSAP-Schema-S-14.0
+      RdSAP-Schema-S-12.0
     ].freeze
     TYPES_OF_SAP = %i[
       SAP-Schema-19.2.0

data/lib/view_model/rd_sap_schema_s_120/common_schema.rb

@@ -0,0 +1,547 @@
+module ViewModel
+  module RdSapSchemaS120
+    class CommonSchema < ViewModel::DomesticEpcViewModel
+      def assessment_id
+        xpath(%w[RRN])
+      end
+
+      def address_line1
+        xpath(%w[Property Address Address-Line-1])
+      end
+
+      def address_line2
+        xpath(%w[Property Address Address-Line-2]).to_s
+      end
+
+      def address_line3
+        xpath(%w[Property Address Address-Line-3]).to_s
+      end
+
+      def address_line4
+        xpath(%w[Property Address Address-Line-4]).to_s
+      end
+
+      def town
+        xpath(%w[Property Address Post-Town])
+      end
+
+      def postcode
+        xpath(%w[Property Address Postcode])
+      end
+
+      def scheme_assessor_id
+        xpath(%w[Identification-Number Membership-Number]) or xpath(%w[Identification-Number Certificate-Number])
+      end
+
+      def assessor_name
+        "#{xpath(%w[Home-Inspector Name First-Name])} #{xpath(%w[Home-Inspector Name Surname])}"
+      end
+
+      def assessor_email
+        xpath(%w[Home-Inspector E-Mail])
+      end
+
+      def assessor_telephone
+        xpath(%w[Home-Inspector Telephone])
+      end
+
+      def date_of_assessment
+        xpath(%w[Inspection-Date])
+      end
+
+      def date_of_registration
+        xpath(%w[Registration-Date])
+      end
+
+      def date_of_completion
+        xpath(%w[Completion-Date])
+      end
+
+      def address_id
+        "LPRN-#{xpath(%w[UPRN])}"
+      end
+
+      def date_of_expiry
+        expires_at = (Date.parse(date_of_registration) - 1) >> 12 * 10
+
+        expires_at.to_s
+      end
+
+      def property_summary
+        @xml_doc.search("Energy-Assessment Property-Summary").children.select(
+          &:element?
+        ).map { |node|
+          next if xpath(%w[Energy-Efficiency-Rating], node).nil?
+
+          {
+            energy_efficiency_rating:
+              xpath(%w[Energy-Efficiency-Rating], node).to_i,
+            environmental_efficiency_rating:
+              xpath(%w[Environmental-Efficiency-Rating], node).to_i,
+            name: node.name.underscore,
+            description: xpath(%w[Description], node),
+          }
+        }.compact
+      end
+
+      def related_party_disclosure_text
+        nil
+      end
+
+      def related_party_disclosure_number
+        nil
+      end
+
+      def improvements
+        @xml_doc
+          .search("Suggested-Improvements Improvement")
+          .map do |node|
+            {
+              energy_performance_rating_improvement: xpath(%w[Energy-Performance-Rating], node).to_i,
+              environmental_impact_rating_improvement: xpath(%w[Environmental-Impact-Rating], node).to_i,
+              green_deal_category_code: nil,
+              improvement_category: xpath(%w[Improvement-Category], node),
+              improvement_code: nil,
+              improvement_description: xpath(%w[Improvement-Description], node),
+              improvement_title: improvement_title(node),
+              improvement_type: nil,
+              indicative_cost: nil,
+              sequence: xpath(%w[Sequence], node).to_i,
+              typical_saving: xpath(%w[Typical-Saving], node),
+            }
+          end
+      end
+
+      def recommendations_for_report
+        @xml_doc
+          .search("Suggested-Improvements Improvement")
+          .map do |node|
+            {
+              sequence: xpath(%w[Sequence], node).to_i,
+              improvement_summary: xpath(%w[Improvement-Summary], node),
+              improvement_description: xpath(%w[Improvement-Description], node),
+              improvement_code: nil,
+              indicative_cost: nil,
+            }
+          end
+      end
+
+      def hot_water_cost_potential
+        xpath(%w[Hot-Water-Cost-Potential])
+      end
+
+      def heating_cost_potential
+        xpath(%w[Heating-Cost-Potential])
+      end
+
+      def lighting_cost_potential
+        xpath(%w[Lighting-Cost-Potential])
+      end
+
+      def hot_water_cost_current
+        xpath(%w[Hot-Water-Cost-Current])
+      end
+
+      def heating_cost_current
+        xpath(%w[Heating-Cost-Current])
+      end
+
+      def lighting_cost_current
+        xpath(%w[Lighting-Cost-Current])
+      end
+
+      def potential_carbon_emission
+        xpath(%w[CO2-Emissions-Potential])
+      end
+
+      def current_carbon_emission
+        xpath(%w[CO2-Emissions-Current])
+      end
+
+      def potential_energy_rating
+        xpath(%w[Energy-Rating-Potential])&.to_i
+      end
+
+      def current_energy_rating
+        xpath(%w[Energy-Rating-Current])&.to_i
+      end
+
+      def total_floor_area
+        xpath(%w[Total-Floor-Area])
+      end
+
+      def dwelling_type
+        ""
+      end
+
+      def property_age_band
+        xpath(%w[Construction-Age-Band])
+      end
+
+      def tenure
+        nil
+      end
+
+      def transaction_type
+        xpath(%w[Transaction-Type])
+      end
+
+      def current_space_heating_demand
+        nil
+      end
+
+      def current_water_heating_demand
+        nil
+      end
+
+      def impact_of_cavity_insulation
+        nil
+      end
+
+      def impact_of_loft_insulation
+        nil
+      end
+
+      def impact_of_solid_wall_insulation
+        nil
+      end
+
+      def habitable_room_count
+        xpath(%w[Habitable-Room-Count])&.to_i
+      end
+
+      def energy_rating_current
+        xpath(%w[Energy-Rating-Current])&.to_i
+      end
+
+      def energy_rating_potential
+        xpath(%w[Energy-Rating-Potential])&.to_i
+      end
+
+      def environmental_impact_current
+        xpath(%w[Environmental-Impact-Current])&.to_i
+      end
+
+      def environmental_impact_potential
+        xpath(%w[Environmental-Impact-Potential])&.to_i
+      end
+
+      def primary_energy_use
+        xpath(%w[Energy-Consumption-Current])&.to_f
+      end
+
+      def energy_consumption_potential
+        xpath(%w[Energy-Consumption-Potential])&.to_f
+      end
+
+      def all_roof_descriptions
+        @xml_doc.search("Roof/Description").map(&:content)
+      end
+
+      def all_roof_energy_efficiency_rating
+        @xml_doc.search("Roof/Energy-Efficiency-Rating").map(&:content)
+      end
+
+      def all_roof_env_energy_efficiency_rating
+        @xml_doc.search("Roof/Environmental-Efficiency-Rating").map(&:content)
+      end
+
+      def all_window_descriptions
+        @xml_doc.search("Window/Description").map(&:content)
+      end
+
+      def all_main_heating_descriptions
+        @xml_doc.search("Main-Heating/Description").map(&:content)
+      end
+
+      def all_main_heating_controls_descriptions
+        @xml_doc.search("Main-Heating-Controls/Description").map(&:content)
+      end
+
+      def all_main_heating_energy_efficiency
+        @xml_doc.search("Main-Heating/Energy-Efficiency-Rating").map(&:content)
+      end
+
+      def all_main_heating_environmental_efficiency
+        @xml_doc
+          .search("Main-Heating/Environmental-Efficiency-Rating")
+          .map(&:content)
+      end
+
+      def all_hot_water_descriptions
+        @xml_doc.search("Hot-Water/Description").map(&:content)
+      end
+
+      def all_lighting_descriptions
+        @xml_doc.search("Lighting/Description").map(&:content)
+      end
+
+      def all_secondary_heating_descriptions
+        @xml_doc.search("Secondary-Heating/Description").map(&:content)
+      end
+
+      def country_code
+        xpath(%w[Country-Code])
+      end
+
+      def main_fuel_type
+        xpath(%w[Main-Fuel-Type])
+      end
+
+      def secondary_fuel_type
+        xpath(%w[Secondary-Fuel-Type])
+      end
+
+      def water_heating_fuel
+        xpath(%w[Water-Heating-Fuel])
+      end
+
+      def co2_emissions_current_per_floor_area
+        xpath(%w[CO2-Emissions-Current-Per-Floor-Area])&.to_f
+      end
+
+      def mains_gas
+        xpath(%w[Mains-Gas])
+      end
+
+      def level
+        xpath(%w[Level])
+      end
+
+      def top_storey
+        xpath(%w[Top-Storey])
+      end
+
+      def storey_count
+        xpath(%w[Storey-Count])&.to_i
+      end
+
+      def main_heating_controls
+        xpath(%w[Main-Heating-Controls Description])
+      end
+
+      def multiple_glazed_proportion
+        xpath(%w[Multiple-Glazed-Proportion])
+      end
+
+      def glazed_area
+        xpath(%w[Glazed-Area])
+      end
+
+      def heated_room_count
+        xpath(%w[Heated-Room-Count])&.to_i
+      end
+
+      def low_energy_lighting
+        xpath(%w[Low-Energy-Lighting])
+      end
+
+      def fixed_lighting_outlets_count
+        xpath(%w[Fixed-Lighting-Outlets-Count])&.to_i
+      end
+
+      def low_energy_fixed_lighting_outlets_count
+        xpath(%w[Low-Energy-Fixed-Lighting-Outlets-Count])&.to_i
+      end
+
+      def open_fireplaces_count
+        xpath(%w[Open-Fireplaces-Count])&.to_i
+      end
+
+      def hot_water_description
+        xpath(%w[Hot-Water Description])
+      end
+
+      def hot_water_energy_efficiency_rating
+        xpath(%w[Hot-Water Energy-Efficiency-Rating])
+      end
+
+      def hot_water_environmental_efficiency_rating
+        xpath(%w[Hot-Water Environmental-Efficiency-Rating])
+      end
+
+      def wind_turbine_count
+        xpath(%w[Wind-Turbines-Count])&.to_i
+      end
+
+      def heat_loss_corridor
+        xpath(%w[Heat-Loss-Corridor])
+      end
+
+      def unheated_corridor_length
+        xpath(%w[Unheated-Corridor-Length])
+      end
+
+      def window_description
+        xpath(%w[Window Description])
+      end
+
+      def window_energy_efficiency_rating
+        xpath(%w[Window Energy-Efficiency-Rating])
+      end
+
+      def window_environmental_efficiency_rating
+        xpath(%w[Window Environmental-Efficiency-Rating])
+      end
+
+      def secondary_heating_description
+        xpath(%w[Secondary-Heating Description])
+      end
+
+      def secondary_heating_energy_efficiency_rating
+        xpath(%w[Secondary-Heating Energy-Efficiency-Rating])
+      end
+
+      def secondary_heating_environmental_efficiency_rating
+        xpath(%w[Secondary-Heating Environmental-Efficiency-Rating])
+      end
+
+      def lighting_description
+        xpath(%w[Lighting Description])
+      end
+
+      def lighting_energy_efficiency_rating
+        xpath(%w[Lighting Energy-Efficiency-Rating])
+      end
+
+      def lighting_environmental_efficiency_rating
+        xpath(%w[Lighting Environmental-Efficiency-Rating])
+      end
+
+      def photovoltaic_roof_area_percent
+        xpath(%w[Photovoltaic-Supply Percent-Roof-Area])
+      end
+
+      def built_form
+        xpath(%w[Built-Form])
+      end
+
+      def extensions_count
+        xpath(%w[Extensions-Count])&.to_i
+      end
+
+      def report_type
+        xpath(%w[Report-Type])
+      end
+
+      def all_wall_descriptions
+        @xml_doc.search("Wall/Description").map(&:content)
+      end
+
+      def all_wall_energy_efficiency_rating
+        @xml_doc.search("Wall/Energy-Efficiency-Rating").map(&:content)
+      end
+
+      def all_wall_env_energy_efficiency_rating
+        @xml_doc.search("Wall/Environmental-Efficiency-Rating").map(&:content)
+      end
+
+      def meter_type
+        xpath(%w[Meter-Type])
+      end
+
+      def floor_level
+        xpath(%w[Flat-Location])
+      end
+
+      def solar_water_heating_flag
+        xpath(%w[Solar-Water-Heating])
+      end
+
+      def mechanical_ventilation
+        xpath(%w[Mechanical-Ventilation])
+      end
+
+      def floor_height
+        @xml_doc.search("Room-Height").map(&:content)
+      end
+
+      def all_floor_descriptions
+        @xml_doc.search("Property-Summary/Floor/Description").map(&:content)
+      end
+
+      def all_floor_energy_efficiency_rating
+        @xml_doc
+          .search("Property-Summary/Floor/Energy-Efficiency-Rating")
+          .map(&:content)
+      end
+
+      def all_floor_env_energy_efficiency_rating
+        @xml_doc
+          .search("Property-Summary/Floor/Environmental-Efficiency-Rating")
+          .map(&:content)
+      end
+
+      def all_main_heating_controls_energy_efficiency
+        @xml_doc
+          .search("Main-Heating-Controls/Energy-Efficiency-Rating")
+          .map(&:content)
+      end
+
+      def all_main_heating_controls_environmental_efficiency
+        @xml_doc
+          .search("Main-Heating-Controls/Environmental-Efficiency-Rating")
+          .map(&:content)
+      end
+
+      def main_dwelling_construction_age_band_or_year
+        sap_building_parts =
+          @xml_doc.xpath("//SAP-Building-Parts/SAP-Building-Part")
+        sap_building_parts.each do |sap_building_part|
+          building_part_number = sap_building_part.at("Building-Part-Number")
+
+          # Identifies the Main Dwelling
+          if building_part_number&.content == "1"
+            return (
+              sap_building_part.at_xpath(
+                "Construction-Age-Band | Construction-Year",
+              )&.content
+            )
+          end
+        end
+        nil
+      end
+
+      def cylinder_insul_thickness
+        xpath(%w[Cylinder-Insulation-Thickness])
+      end
+
+      def cylinder_insulation_type
+        xpath(%w[Cylinder-Insulation-Type])
+      end
+
+      def cylinder_size
+        xpath(%w[Cylinder-Size])
+      end
+
+      def has_cylinder_thermostat
+        xpath(%w[Cylinder-Thermostat])
+      end
+
+      def party_wall_construction
+        xpath(%w[SAP-Building-Part Party-Wall-Construction])
+      end
+
+      def lzc_energy_sources
+        return nil if xpath(%w[LZC-Energy-Sources]).nil?
+
+        @xml_doc
+          .search("LZC-Energy-Sources/LZC-Energy-Source")
+          .select(&:element?)
+          .map { |n| n.text.to_i }
+      end
+
+      def addendum
+        nil
+      end
+
+      def gas_smart_meter_present
+        nil
+      end
+
+      def electricity_smart_meter_present
+        nil
+      end
+    end
+  end
+end