epb_view_models 1.0.16 → 1.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79ae310938a850d789aa00468e9ccfb69bf5bf0c198b4ba306e83f15b626cf77
-  data.tar.gz: dede5d0236911e00b5d5378e32745c05764e01dbb68e918fa335b83d373a8733
+  metadata.gz: 4c9e0148c91fdfa17b8230647b7f44630d9197877639f5f8da2948d329afb8e6
+  data.tar.gz: db0feff6c2a220fef4810e938bb53d6382df34df65355ff3946443b58ada8950
 SHA512:
-  metadata.gz: 57c32e59da653209820c2284da3b10a75adc13296f42d1dda1ce7766b1c959f9a6557e3421db7958c9caa19c5a60cc9f049c48c0141042893a5be263175191dc
-  data.tar.gz: 804e20015ee1ce0f5fbc53676e9067068913d9a0ba84345e3f1d8104fc2a935583392487a544721e2fac332a000006c58037798e223434fbd66bf86605bf4714
+  metadata.gz: f5e51bceb16b9c4ec62cb2a724ccb58e4daf1d8699b67672a755533278b568c00c7f13ee119f7d78983f913bb13a2cd69b36a1d1372e43a4dc4f62f82b89bb03
+  data.tar.gz: 9813262b24abc17231f36b6d5b4bf0eac81f58a31d103b80172e518b228e1974b15176af4c97f6ffeee7bea8cd8ac47cd74b08286554ff57883f6ec9fb3085e3

data/.buildspec.yml

@@ -3,10 +3,10 @@ version: 0.2
 phases:
   install:
     runtime-versions:
-      ruby: 2.7
+      ruby: 3.1
   pre_build:
     commands:
-      - gem install bundler:2.2.21
+      - gem install bundler:2.3.15
       - make install
   build:
     commands:

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.1.2

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-ruby "~> 2.7"
+ruby ">=2.7", "<3.2"
 
 source "https://rubygems.org"
 

data/Gemfile.lock

@@ -85,4 +85,4 @@ RUBY VERSION
    ruby 2.7.5p203
 
 BUNDLED WITH
-   2.2.32
+   2.3.15

data/api/schemas/xml/SAP-Schema-19.0.0/SAP/UDT/SAP-Domains.xsd

@@ -1360,7 +1360,7 @@
 			</xs:enumeration>
 		</xs:restriction>
 	</xs:simpleType>
-	<xs:simpleType name="SAP-FlatLevelCode">
+		<xs:simpleType name="SAP-FlatLevelCode">
 		<xs:annotation>
 			<xs:documentation>Codes which indicates where a flat is located within a building.</xs:documentation>
 		</xs:annotation>

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.setup
 
 module EpbViewModels
-  VERSION = "1.0.16"
+  VERSION = "1.0.19"
 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/export/domestic.rb

@@ -68,8 +68,8 @@ module Presenter::Export
       view[:lighting_environmental_efficiency_rating] =
         @view_model.lighting_environmental_efficiency_rating.to_i
       view[:low_energy_fixed_lighting_outlets_count] =
-        @view_model.low_energy_fixed_lighting_outlets_count.to_i
-      view[:low_energy_lighting] = @view_model.low_energy_lighting.to_i
+        @view_model.low_energy_fixed_lighting_outlets_count.nil? ? nil : @view_model.low_energy_fixed_lighting_outlets_count.to_i
+      view[:low_energy_lighting] = @view_model.low_energy_lighting.nil? ? nil : @view_model.low_energy_lighting.to_i
       view[:main_fuel_type] = @view_model.main_fuel_type
       view[:main_heating_controls_descriptions] =
         @view_model.all_main_heating_controls_descriptions

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

@@ -259,12 +259,12 @@ module ViewModel
       end
 
       def top_storey
-        flat_level_code = xpath(%w[Level])
+        flat_level_code = xpath(%w[SAP-FlatLevelCode])
         flat_level_code == "3" ? "Y" : "N"
       end
 
       def storey_count
-        nil
+        xpath(%w[Storeys])
       end
 
       def building_part_number
@@ -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
@@ -369,20 +365,51 @@ module ViewModel
         nil
       end
 
-      def low_energy_lighting
-        xpath(%w[Low-Energy-Fixed-Lighting-Outlets-Percentage])
+      def fixed_lighting_outlets_count
+        @xml_doc.search("Fixed-Lights/Fixed-Light/Lighting-Outlets").map(&:content).map(&:to_i).sum
       end
 
-      def fixed_lighting_outlets_count
-        xpath(%w[Fixed-Lighting-Outlets-Count])
+      def format_fixed_light_array
+        @xml_doc
+          .search("Fixed-Lights/Fixed-Light")
+          .map do |part|
+          {
+            lighting_efficacy:
+              xpath(%w[Lighting-Efficacy], part),
+            lighting_outlets:
+              xpath(%w[Lighting-Outlets], part),
+          }
+        end
+      end
+
+      def low_energy_lighting
+        total_energy_outlet_count = []
+        low_energy_outlet_count = []
+
+        format_fixed_light_array.each do |outlet|
+          if outlet[:lighting_efficacy].to_i > 65
+            low_energy_outlet_count << outlet[:lighting_outlets].to_i
+          end
+          total_energy_outlet_count << outlet[:lighting_outlets].to_f
+        end
+
+        (low_energy_outlet_count.sum / total_energy_outlet_count.sum * 100).round
       end
 
       def low_energy_fixed_lighting_outlets_count
-        xpath(%w[Low-Energy-Fixed-Lighting-Outlets-Count])
+        low_energy_outlet_count = []
+
+        format_fixed_light_array.each do |outlet|
+          if outlet[:lighting_efficacy].to_i > 65
+            low_energy_outlet_count << outlet[:lighting_outlets].to_i
+          end
+        end
+
+        low_energy_outlet_count.sum
       end
 
       def open_fireplaces_count
-        xpath(%w[Open-Fireplaces-Count])
+        xpath(%w[Open-Chimneys-Count])
       end
 
       def hot_water_description
@@ -442,7 +469,7 @@ module ViewModel
       end
 
       def wind_turbine_count
-        xpath(%w[Wind-Turbines-Count])
+        @xml_doc.search("Wind-Turbines/Wind-Turbine").map(&:content).count
       end
 
       def unheated_corridor_length

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.16
+  version: 1.0.19
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-07-06 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
@@ -1868,7 +1870,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Library used to parse Energy Performance Certificates (EPC)