epb_view_models 1.0.15 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44ac3c497106cfad05b3f659f0f67c680bec0d68bf129dba9ee85f4b84c92ea1
-  data.tar.gz: f4a5b74aa6b3fe31dd79d3b6b0e3895c33c6652faccfd59fe7ef580a077599a8
+  metadata.gz: 21ae4bba2efbc28d42200e7a331a4111b76071399e0a1f901313c2d57035196a
+  data.tar.gz: 0e244cf4dec75c6213a3c3e8bac4aa2fea2c02f44c9958419d5bf9b9bb2f4f38
 SHA512:
-  metadata.gz: e991f69ff3f8990512da92df7aaeb1b2a2c0b0014e925d8da0ffbbc4560e09b39446e1731a76a8b0aa87dbdd48d101ae79dda7746cba426c53b9e8146d8c5a32
-  data.tar.gz: 36600d67398158417c478bb42366d7d7dea759ea75a746d5864ba4b1e24c7c55e3b4d164fdd949018e8b0c0954ddc73c606112e5d7ba70c5dca2bf33c2878648
+  metadata.gz: a2e9785b8c3141d8eaf2b1bf5c1cd647efe67022417b5922e94e44af3b57ce157dab168f4499d4a1b1bce1a6092d8aa87ef954a8ab09cc03335b5bc0a1417571
+  data.tar.gz: dcf95783220f96004c33f270bd844dd22de531f57136d7f9d230e7244a42b880c310088ca070b60aaedaf78dfb2f766f7f783098603302ca5cb2085b1afbc03f

data/api/schemas/xml/SAP-Schema-19.0.0/SAP/Templates/Property.xsd

@@ -18,7 +18,7 @@ As such the broad description of a Property can be regarded as a framework, cont
 					<xs:documentation>Address for the property.</xs:documentation>
 				</xs:annotation>
 			</xs:element>
-			<xs:element name="UPRN" type="UPRNType">
+			<xs:element name="UPRN" type="UPRNType" minOccurs="0">
 				<xs:annotation>
 					<xs:documentation>Unique Property Reference Number</xs:documentation>
 				</xs:annotation>
@@ -43,7 +43,7 @@ As such the broad description of a Property can be regarded as a framework, cont
 </xs:documentation>
 		</xs:annotation>
 		<xs:sequence>
-			<xs:element name="Address-Line-1" type="xs:string" minOccurs="0"/>
+			<xs:element name="Address-Line-1" type="xs:string"/>
 			<xs:element name="Address-Line-2" type="xs:string" minOccurs="0"/>
 			<xs:element name="Address-Line-3" type="xs:string" minOccurs="0"/>
 			<xs:element name="Post-Town" type="xs:string"/>
@@ -57,10 +57,10 @@ As such the broad description of a Property can be regarded as a framework, cont
 	</xs:complexType>
 	<xs:simpleType name="UPRNType">
 		<xs:annotation>
-			<xs:documentation>Unique Property Reference Number - a 10-digit numeric string unmiquely identifuying each Property that may have a HCR registered against it.</xs:documentation>
+			<xs:documentation>Unique Property Reference Number</xs:documentation>
 		</xs:annotation>
 		<xs:restriction base="xs:string">
-			<xs:pattern value="[0-9]{10}"/>
+			<xs:pattern value="UPRN-[0-9]{10,12}|RRN-[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}-[0-9]{4}"/>
 		</xs:restriction>
 	</xs:simpleType>
 	<xs:simpleType name="PostcodeType">

data/api/schemas/xml/SAP-Schema-19.0.0/SAP/Templates/SAP-Report.xsd

@@ -54,7 +54,15 @@
 			<xs:element name="Report-Header" type="Report-Header"/>
 			<xs:element name="Energy-Assessment" type="Energy-Assessment"/>
 			<xs:element name="SAP10-Data" type="SAP10-Data"/>
-			<xs:element name="PDF" type="xs:base64Binary" minOccurs="0"/>
+			<xs:element name="PDF" type="xs:base64Binary" minOccurs="0">
+				<xs:annotation>
+					<xs:documentation>
+						DEPRECATED - DO NOT USE
+						This element is allowed for backwards-compatibility but any data sent here will
+						not be read, processed or stored by the register.
+					</xs:documentation>
+				</xs:annotation>
+			</xs:element>
 			<xs:element name="Insurance-Details" type="Insurance-Details" minOccurs="0"/>
 			<xs:element name="ExternalDefinitions-Revision-Number" type="xs:string">
 				<xs:annotation>

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.setup
 
 module EpbViewModels
-  VERSION = "1.0.15"
+  VERSION = "1.0.18"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/helper/xml_enums_to_output.rb

@@ -274,6 +274,20 @@ module Helper
       "76" => "bioethanol from any biomass source",
       "99" => "Community heating schemes: special fuel",
     }.freeze
+    MAIN_HEATING_CATEGORY = {
+      "1" => "none",
+      "2" => "boiler with radiators or underfloor heating",
+      "3" => "micro-cogeneration",
+      "4" => "heat pump with radiators or underfloor heating",
+      "5" => "heat pump with warm air distribution",
+      "6" => "community heating system",
+      "7" => "electric storage heaters",
+      "8" => "electric underfloor heating",
+      "9" => "warm air system (not heat pump)",
+      "10" => "room heaters",
+      "11" => "other system",
+      "12" => "not recorded",
+    }.freeze
 
     def self.built_form_string(number)
       BUILT_FORM[number]
@@ -358,6 +372,7 @@ module Helper
       ]
 
       schemes_that_use_l = %i[
+        SAP-Schema-19.0.0
         SAP-Schema-18.0.0
         SAP-Schema-17.1
         SAP-Schema-17.0
@@ -561,6 +576,7 @@ module Helper
       ]
 
       sap = %i[
+        SAP-Schema-19.0.0
         SAP-Schema-18.0.0
         SAP-Schema-17.1
         SAP-Schema-17.0
@@ -611,6 +627,10 @@ module Helper
       end
     end
 
+    def self.main_heating_category(value:)
+      MAIN_HEATING_CATEGORY[value] || value
+    end
+
     private_class_method :is_rdsap, :is_sap
   end
 end

data/lib/presenter/rd_sap/hera.rb

@@ -0,0 +1,42 @@
+module Presenter
+  module RdSap
+    class Hera
+      TYPE_OF_ASSESSMENT = "RdSAP".freeze
+      private_constant :TYPE_OF_ASSESSMENT
+
+      def initialize(view_model, schema_type)
+        @view_model = view_model
+        @schema_type = schema_type
+      end
+
+      def to_hera_hash
+        {
+          type_of_assessment: TYPE_OF_ASSESSMENT,
+          assessment_id: @view_model.assessment_id,
+          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,
+          },
+          dwelling_type: @view_model.dwelling_type,
+          built_form: Helper::XmlEnumsToOutput.built_form_string(@view_model.built_form),
+          main_dwelling_construction_age_band_or_year: Helper::XmlEnumsToOutput.construction_age_band_lookup(
+            @view_model.main_dwelling_construction_age_band_or_year,
+            @schema_type,
+            @view_model.report_type,
+          ),
+          property_summary: @view_model.property_summary,
+          main_heating_category: Helper::XmlEnumsToOutput.main_heating_category(value: @view_model.main_heating_category),
+          main_fuel_type: Helper::XmlEnumsToOutput.fuel_type(@view_model.main_fuel_type,
+                                                             @schema_type,
+                                                             @view_model.report_type),
+          has_hot_water_cylinder: @view_model.has_hot_water_cylinder,
+        }
+      end
+    end
+  end
+end

data/lib/presenter/sap/hera.rb

@@ -0,0 +1,39 @@
+module Presenter
+  module Sap
+    class Hera
+      def initialize(view_model, schema_type)
+        @view_model = view_model
+        @schema_type = schema_type
+      end
+
+      def to_hera_hash
+        {
+          type_of_assessment: @view_model.type_of_assessment,
+          assessment_id: @view_model.assessment_id,
+          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: nil,
+            town: @view_model.town,
+            postcode: @view_model.postcode,
+          },
+          dwelling_type: @view_model.dwelling_type,
+          built_form: Helper::XmlEnumsToOutput.built_form_string(@view_model.built_form),
+          main_dwelling_construction_age_band_or_year: Helper::XmlEnumsToOutput.construction_age_band_lookup(
+            @view_model.main_dwelling_construction_age_band_or_year,
+            @schema_type,
+            @view_model.report_type,
+          ),
+          property_summary: @view_model.property_summary,
+          main_heating_category: Helper::XmlEnumsToOutput.main_heating_category(value: @view_model.main_heating_category),
+          main_fuel_type: Helper::XmlEnumsToOutput.fuel_type(@view_model.main_fuel_type,
+                                                             @schema_type,
+                                                             @view_model.report_type),
+          has_hot_water_cylinder: @view_model.has_hot_water_cylinder,
+        }
+      end
+    end
+  end
+end

data/lib/view_model/domestic_epc_view_model.rb

@@ -54,6 +54,16 @@ module ViewModel
       xpath(%w[Water-Heating-Code])
     end
 
+    def has_hot_water_cylinder
+      return "false" if xpath(%w[Has-Hot-Water-Cylinder]).nil?
+
+      xpath(%w[Has-Hot-Water-Cylinder])
+    end
+
+    def main_heating_category
+      xpath(%w[Main-Heating-Category])
+    end
+
   private
 
     def fetch_addendum_numbers

data/lib/view_model/rd_sap_schema_200/common_schema.rb

@@ -350,10 +350,6 @@ module ViewModel
         xpath(%w[Immersion-Heating-Type])
       end
 
-      def main_heating_category
-        xpath(%w[Main-Heating-Category])
-      end
-
       def main_fuel_type
         xpath(%w[Main-Fuel-Type])
       end

data/lib/view_model/rd_sap_schema_ni_200/common_schema.rb

@@ -337,10 +337,6 @@ module ViewModel
         xpath(%w[Immersion-Heating-Type])
       end
 
-      def main_heating_category
-        xpath(%w[Main-Heating-Category])
-      end
-
       def main_fuel_type
         xpath(%w[Main-Fuel-Type])
       end

data/lib/view_model/rd_sap_wrapper.rb

@@ -8,6 +8,7 @@ module ViewModel
       @summary = Presenter::RdSap::Summary.new(view_model)
       @report = Presenter::RdSap::Report.new(view_model, schema_type, additional_data)
       @recommendation_report = Presenter::RdSap::RecommendationReport.new(view_model)
+      @hera = Presenter::RdSap::Hera.new(view_model, schema_type)
     end
 
     def type
@@ -30,6 +31,10 @@ module ViewModel
       @recommendation_report.to_hash
     end
 
+    def to_hera_hash
+      @hera.to_hera_hash
+    end
+
     def get_view_model
       view_model
     end

data/lib/view_model/sap_schema_1800/common_schema.rb

@@ -301,10 +301,6 @@ module ViewModel
         xpath(%w[Immersion-Heating-Type])
       end
 
-      def main_heating_category
-        xpath(%w[Main-Heating-Category])
-      end
-
       def main_fuel_type
         xpath(%w[Main-Fuel-Type])
       end

data/lib/view_model/sap_schema_1900/common_schema.rb

@@ -301,10 +301,6 @@ module ViewModel
         xpath(%w[Immersion-Heating-Type])
       end
 
-      def main_heating_category
-        xpath(%w[Main-Heating-Category])
-      end
-
       def main_fuel_type
         xpath(%w[Main-Fuel-Type])
       end

data/lib/view_model/sap_schema_ni_1800/common_schema.rb

@@ -271,10 +271,6 @@ module ViewModel
         xpath(%w[Immersion-Heating-Type])
       end
 
-      def main_heating_category
-        xpath(%w[Main-Heating-Category])
-      end
-
       def main_fuel_type
         xpath(%w[Main-Fuel-Type])
       end

data/lib/view_model/sap_wrapper.rb

@@ -8,6 +8,7 @@ module ViewModel
       @summary = Presenter::Sap::Summary.new(view_model)
       @report = Presenter::Sap::Report.new(view_model, schema_type, additional_data)
       @recommendation_report = Presenter::Sap::RecommendationReport.new(view_model)
+      @hera = Presenter::Sap::Hera.new(view_model, schema_type)
     end
 
     def type
@@ -30,6 +31,10 @@ module ViewModel
       @recommendation_report.to_hash
     end
 
+    def to_hera_hash
+      @hera.to_hera_hash
+    end
+
     def get_view_model
       view_model
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 1.0.15
+  version: 1.0.18
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1675,10 +1675,12 @@ files:
 - lib/presenter/export/domestic.rb
 - lib/presenter/export/statistics.rb
 - lib/presenter/rd_sap/export_configuration.rb
+- lib/presenter/rd_sap/hera.rb
 - lib/presenter/rd_sap/recommendation_report.rb
 - lib/presenter/rd_sap/report.rb
 - lib/presenter/rd_sap/summary.rb
 - lib/presenter/sap/export_configuration.rb
+- lib/presenter/sap/hera.rb
 - lib/presenter/sap/recommendation_report.rb
 - lib/presenter/sap/report.rb
 - lib/presenter/sap/summary.rb