epb_view_models 2.2.18 → 2.2.19

data/api/schemas/xml/RdSAP-Schema-S-16.1/RdSAP/UDT/TypeDefinitions.xsd

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-HIP" xmlns:HIP="http://www.est.org.uk/epc/estcrV1/DCLG-HIP" xmlns:pfdt="http://www.est.org.uk/epc/estcrV1/DCLG-HIP/BaseDataTypes" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-HIP" elementFormDefault="qualified" version="LIG-16.1">
+	<xs:annotation>
+		<xs:documentation>© Department of Communities and Local Government. © Crown copyright, 2007. The Home Condition Report logo and associated wording is a registered trade mark - any unlicensed use is not permitted. Copyright in the typographical arrangement of this document rests with the Crown. This publication, excluding logos, may be reproduced free of charge in any format or medium for research, private study, for internal circulation within an organisation or by registered scheme users. This is subject to it being reproduced accurately and not used in a misleading context. 
+
+Type Definitions (TypeDefinitions.xsd) are constrained variants of a primitive datatype whose allowed values must meet some predefined rules 
+
+Exactly what is a type definition is a bit subjective because it is generally up to the data modeller to make the decision between what is a Value-Type and what is an Entity-Type. 
+
+For example in some contexts an Address (House Number, Street, Town, Postcode) may be declared as a composite datatype where the value of each Address is recorded against the Addressable Entity but in another context the Address (where there are details to be gathered about the Address itself) it could be a defined referenced Business Entity instead.
+
+However, even allowing for some fuzziness at the boundary, a general rule of thumb is that a Type Definition is a data-item that is generally defined outside of the domain and it is not within the domains authority to extend or redefine. There is also only ever one definition in force at any time.
+</xs:documentation>
+	</xs:annotation>
+	<xs:element name="UValue" type="UValue"/>
+	<xs:complexType name="UValue">
+		<xs:sequence/>
+	</xs:complexType>
+</xs:schema>

data/api/schemas/xml/RdSAP-Schema-S-17.00/RdSAP/Templates/RdSAP-Report.xsd

@@ -1,6 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- edited with XMLSpy v2006 rel. 3 U (http://www.altova.com) by Jim Bowery (Landmark Information Group Ltd.) -->
-<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.epcregister.com/xsd/rdsap" targetNamespace="http://www.epcregister.com/xsd/rdsap" elementFormDefault="qualified" attributeFormDefault="unqualified" version="LIG-17.00">
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+		   xmlns="http://www.epcregister.com/xsd/rdsap"
+		   targetNamespace="http://www.epcregister.com/xsd/rdsap"
+		   elementFormDefault="qualified"
+		   attributeFormDefault="unqualified"
+		   version="LIG-17.00">
 	<xs:annotation>
 		<xs:documentation>© Department of Communities and Local Government. © Crown copyright, 2007. The Home Condition Report logo and associated wording is a registered trade mark - any unlicensed use is not permitted. Copyright in the typographical arrangement of this document rests with the Crown. This publication, excluding logos, may be reproduced free of charge in any format or medium for research, private study, for internal circulation within an organisation or by registered scheme users. This is subject to it being reproduced accurately and not used in a misleading context.</xs:documentation>
 	</xs:annotation>

data/lib/epb_view_models.rb

@@ -5,7 +5,7 @@ loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.setup
 
 module EpbViewModels
-  VERSION = "2.2.18"
+  VERSION = "2.2.19"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/presenter/xsd.rb

@@ -25,15 +25,8 @@ module Presenter
     end
 
     def unique_enums(domain_arguments)
-      uniq_enums = []
       enums = get_enums_by_type(domain_arguments).values
-
-      enums.each_with_index do |_hash, i|
-        if i.positive? && (enums[i].to_a != enums[i + 1].to_a)
-          uniq_enums << enums[i]
-        end
-      end
-      uniq_enums
+      enums.group_by(&:inspect).values.map(&:first)
     end
 
     def variation_between_schema_versions?(enums_hash)

data/lib/view_model/factory.rb

@@ -40,6 +40,7 @@ module ViewModel
       RdSAP-Schema-S-21.0
       RdSAP-Schema-S-18.0
       RdSAP-Schema-S-17.00
+      RdSAP-Schema-S-16.1
     ].freeze
     TYPES_OF_SAP = %i[
       SAP-Schema-19.2.0

data/lib/view_model/rd_sap_schema_s_161/common_schema.rb

@@ -0,0 +1,556 @@
+module ViewModel
+  module RdSapSchemaS161
+    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
+        xpath(%w[Related-Party-Disclosure-Text])
+      end
+
+      def related_party_disclosure_number
+        disclosure_number = xpath(%w[Related-Party-Disclosure-Number])
+        disclosure_number.nil? ? nil : disclosure_number.to_i
+      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: xpath(%w[Green-Deal-Category], node),
+              improvement_category: xpath(%w[Improvement-Category], node),
+              improvement_code:
+                xpath(%w[Improvement-Details Improvement-Number], node),
+              improvement_description: xpath(%w[Improvement-Description], node),
+              improvement_title: improvement_title(node),
+              improvement_type: xpath(%w[Improvement-Type], node),
+              indicative_cost: xpath(%w[Indicative-Cost], node),
+              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:
+                xpath(%w[Improvement-Details Improvement-Number], node),
+              indicative_cost: xpath(%w[Indicative-Cost], node),
+            }
+          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 estimated_energy_cost; end
+
+      def total_floor_area
+        xpath(%w[Property-Summary Total-Floor-Area])
+      end
+
+      def dwelling_type
+        xpath(%w[Dwelling-Type])
+      end
+
+      def potential_energy_saving; end
+
+      def property_age_band
+        xpath(%w[Construction-Age-Band])
+      end
+
+      def tenure
+        xpath(%w[Tenure])
+      end
+
+      def transaction_type
+        xpath(%w[Transaction-Type])
+      end
+
+      def current_space_heating_demand
+        xpath(%w[Space-Heating-Existing-Dwelling])
+      end
+
+      def current_water_heating_demand
+        xpath(%w[Water-Heating])
+      end
+
+      def impact_of_cavity_insulation
+        if xpath(%w[Impact-Of-Cavity-Insulation])
+          xpath(%w[Impact-Of-Cavity-Insulation])&.to_i
+        end
+      end
+
+      def impact_of_loft_insulation
+        if xpath(%w[Impact-Of-Loft-Insulation])
+          xpath(%w[Impact-Of-Loft-Insulation])&.to_i
+        end
+      end
+
+      def impact_of_solid_wall_insulation
+        if xpath(%w[Impact-Of-Solid-Wall-Insulation])
+          xpath(%w[Impact-Of-Solid-Wall-Insulation])&.to_i
+        end
+      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
+        return nil if xpath(%w[Addendum]).nil?
+
+        fetch_addendum_numbers.merge(fetch_addendum_boolean_nodes)
+      end
+    end
+  end
+end

data/lib/view_model/rd_sap_schema_s_1700/common_schema.rb

@@ -536,6 +536,21 @@ module ViewModel
       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
+        return nil if xpath(%w[Addendum]).nil?
+
+        fetch_addendum_numbers.merge(fetch_addendum_boolean_nodes)
+      end
     end
   end
 end

data/lib/view_model/rd_sap_schema_s_180/common_schema.rb

@@ -536,6 +536,21 @@ module ViewModel
       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
+        return nil if xpath(%w[Addendum]).nil?
+
+        fetch_addendum_numbers.merge(fetch_addendum_boolean_nodes)
+      end
     end
   end
 end

data/lib/view_model/rd_sap_schema_s_190/common_schema.rb

@@ -656,6 +656,21 @@ module ViewModel
           water_heating_code: xpath(%w[Water-Heating-Code]),
         }
       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
+        return nil if xpath(%w[Addendum]).nil?
+
+        fetch_addendum_numbers.merge(fetch_addendum_boolean_nodes)
+      end
     end
   end
 end