epb_view_models 1.0.17 → 1.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dd0d9d3d0906689a919d76f7df73fddbccd8cc0eeaf97edee21ddead0b790b3
-  data.tar.gz: 6ded2596cf0adebfae41916318e561798d2aed7fd0c54a248d1751940865b54d
+  metadata.gz: aa9d8934087e8309c6b8c03395fbbbb93e9b7353964126b93438d52feb6ad7b6
+  data.tar.gz: 27c06482c14b7b0dec995f24e69b4fa0b2d595632b2fa998e2030269ebe96b94
 SHA512:
-  metadata.gz: 434eac8a26a57b6658b6948d5fde772cf6cb4af70927bd736b96e8317d4f7046d3c32176f6b605f47ce2b3c7149494899182c8e2b67acfdd1656ba0519b76403
-  data.tar.gz: 4dc074660c6a3693440d653375b49a993b6eca0813ca574a5f68285de34d8f03f39471e00ac430d77a39101cc75f0b748a5cd3aa0db8d73a8e37532f3ebc60f6
+  metadata.gz: d274a8af83d9a7d9b98a0aed40aa07ab22c795196d1110e309ba947cdb0e33b29782aa0f3d76be73e4353e61f1eefa1a982e3831be7631ad9fb423120573920f
+  data.tar.gz: 030110e0f77c01c48a4b695d086e6e00d337520eb40fdd3fab2f9074ba4c47d134210b00c187922650da323a0f05f332f435496e4dfd09d1b876491c1c0bf6fa

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,13 +1,13 @@
 # frozen_string_literal: true
 
-ruby "~> 2.7"
+ruby ">=2.7", "<3.2"
 
 source "https://rubygems.org"
 
 group :test do
   gem "rake", "~> 13.0.6"
   gem "rspec", "~> 3.0"
-  gem "rubocop-govuk", "~> 4.0.0", require: false
+  gem "rubocop-govuk", "~> 4.7.0", require: false
 end
 
 gem "nokogiri", "~> 1.11"

data/Gemfile.lock

@@ -1,29 +1,30 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.3)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.2)
     mini_portile2 (2.8.0)
-    minitest (5.15.0)
-    nokogiri (1.13.3)
+    minitest (5.16.3)
+    nokogiri (1.13.8)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.21.0)
-    parser (3.1.1.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
     racc (1.6.0)
-    rack (2.2.3)
+    rack (2.2.4)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -34,40 +35,40 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.15.0)
+    rubocop (1.35.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.5.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.6.0)
-      parser (>= 3.0.1.1)
-    rubocop-govuk (4.0.0)
-      rubocop (~> 1.15.0)
-      rubocop-ast (~> 1.6.0)
-      rubocop-rails (~> 2.10.0)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (~> 2.3.0)
-    rubocop-rails (2.10.1)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-govuk (4.7.0)
+      rubocop (= 1.35.0)
+      rubocop-ast (= 1.21.0)
+      rubocop-rails (= 2.15.2)
+      rubocop-rake (= 0.6.0)
+      rubocop-rspec (= 2.12.1)
+    rubocop-rails (2.15.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
       rubocop (>= 1.7.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.3.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+    rubocop-rspec (2.12.1)
+      rubocop (~> 1.31)
     ruby-progressbar (1.11.0)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
     zeitwerk (2.4.2)
 
 PLATFORMS
@@ -78,11 +79,11 @@ DEPENDENCIES
   rake (~> 13.0.6)
   rexml (~> 3.2, >= 3.2.5)
   rspec (~> 3.0)
-  rubocop-govuk (~> 4.0.0)
+  rubocop-govuk (~> 4.7.0)
   zeitwerk (~> 2.4.2)
 
 RUBY VERSION
    ruby 2.7.5p203
 
 BUNDLED WITH
-   2.2.32
+   2.3.15

data/Makefile

@@ -14,4 +14,4 @@ test: ## Run all tests
 	@bundle exec rake spec
 
 format: ## Runs Rubocop with the GOV.UK rules
-	@bundle exec rake rubocop:auto_correct
+	@bundle exec rake rubocop:autocorrect

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/epb_view_models.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.summary       = "Library used to parse Energy Performance Certificates (EPC)"
   spec.homepage      = "https://github.com/communitiesuk/epb-view-models"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.1"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem
 loader.setup
 
 module EpbViewModels
-  VERSION = "1.0.17"
+  VERSION = "1.0.20"
 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 → domestic_digest.rb}

@@ -1,14 +1,15 @@
 module Presenter
   module RdSap
-    class Hera
+    class DomesticDigest
       TYPE_OF_ASSESSMENT = "RdSAP".freeze
       private_constant :TYPE_OF_ASSESSMENT
 
-      def initialize(view_model)
+      def initialize(view_model, schema_type)
         @view_model = view_model
+        @schema_type = schema_type
       end
 
-      def to_hera_hash
+      def to_domestic_digest
         {
           type_of_assessment: TYPE_OF_ASSESSMENT,
           assessment_id: @view_model.assessment_id,
@@ -22,11 +23,17 @@ module Presenter
             postcode: @view_model.postcode,
           },
           dwelling_type: @view_model.dwelling_type,
-          built_form: @view_model.built_form,
-          main_dwelling_construction_age_band_or_year: @view_model.main_dwelling_construction_age_band_or_year,
+          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: @view_model.main_heating_category,
-          main_fuel_type: @view_model.main_fuel_type,
+          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

data/lib/presenter/rd_sap/summary.rb

@@ -54,7 +54,7 @@ module Presenter
             ),
           current_energy_efficiency_rating: @view_model.current_energy_rating,
           dwelling_type: @view_model.dwelling_type,
-          estimated_energy_cost: estimated_energy_cost,
+          estimated_energy_cost:,
           main_fuel_type: @view_model.main_fuel_type,
           heat_demand: {
             current_space_heating_demand:

data/lib/presenter/sap/domestic_digest.rb

@@ -0,0 +1,39 @@
+module Presenter
+  module Sap
+    class DomesticDigest
+      def initialize(view_model, schema_type)
+        @view_model = view_model
+        @schema_type = schema_type
+      end
+
+      def to_domestic_digest
+        {
+          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/presenter/sap/summary.rb

@@ -51,7 +51,7 @@ module Presenter
             ),
           current_energy_efficiency_rating: @view_model.current_energy_rating,
           dwelling_type: @view_model.dwelling_type,
-          estimated_energy_cost: estimated_energy_cost,
+          estimated_energy_cost:,
           main_fuel_type: @view_model.main_fuel_type,
           heat_demand: {
             current_space_heating_demand:

data/lib/view_model/rd_sap_wrapper.rb

@@ -8,7 +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)
+      @domestic_digest = Presenter::RdSap::DomesticDigest.new(view_model, schema_type)
     end
 
     def type
@@ -31,10 +31,17 @@ module ViewModel
       @recommendation_report.to_hash
     end
 
+    def to_domestic_digest
+      @domestic_digest.to_domestic_digest
+    end
+
     def to_hera_hash
-      @hera.to_hera_hash
+      to_domestic_digest
     end
 
+    extend Gem::Deprecate
+    deprecate :to_hera_hash, :to_domestic_digest, 2022, 9
+
     def get_view_model
       view_model
     end

data/lib/view_model/sap_schema_1900/common_schema.rb

@@ -1,6 +1,8 @@
 module ViewModel
   module SapSchema1900
     class CommonSchema < ViewModel::DomesticEpcViewModel
+      THRESHOLD_LOW_ENERGY_LIGHTING_EFFICACY = 65
+
       def assessment_id
         xpath(%w[Report-Header RRN])
       end
@@ -259,12 +261,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
@@ -365,20 +367,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 > THRESHOLD_LOW_ENERGY_LIGHTING_EFFICACY
+            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 > THRESHOLD_LOW_ENERGY_LIGHTING_EFFICACY
+            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
@@ -438,7 +471,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_wrapper.rb

@@ -8,7 +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)
+      @domestic_digest = Presenter::Sap::DomesticDigest.new(view_model, schema_type)
     end
 
     def type
@@ -31,10 +31,17 @@ module ViewModel
       @recommendation_report.to_hash
     end
 
+    def to_domestic_digest
+      @domestic_digest.to_domestic_digest
+    end
+
     def to_hera_hash
-      @hera.to_hera_hash
+      to_domestic_digest
     end
 
+    extend Gem::Deprecate
+    deprecate :to_hera_hash, :to_domestic_digest, 2022, 9
+
     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.17
+  version: 1.0.20
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-25 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1674,13 +1674,13 @@ files:
 - lib/presenter/export/commercial.rb
 - lib/presenter/export/domestic.rb
 - lib/presenter/export/statistics.rb
+- lib/presenter/rd_sap/domestic_digest.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/domestic_digest.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
@@ -1863,14 +1863,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !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)

data/lib/presenter/sap/hera.rb

@@ -1,32 +0,0 @@
-module Presenter
-  module Sap
-    class Hera
-      def initialize(view_model)
-        @view_model = view_model
-      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: @view_model.built_form,
-          main_dwelling_construction_age_band_or_year: @view_model.main_dwelling_construction_age_band_or_year,
-          property_summary: @view_model.property_summary,
-          main_heating_category: @view_model.main_heating_category,
-          main_fuel_type: @view_model.main_fuel_type,
-          has_hot_water_cylinder: @view_model.has_hot_water_cylinder,
-        }
-      end
-    end
-  end
-end