epb_view_models 1.0.6 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 414c0a2f9029d52009e6e7f1b87bbee49bdaef8748412508a50e8a7a08eddbaf
-  data.tar.gz: bd9c946f41a6ddfd2f67700634f3ff6b4f5231c9c7227da63cc3118dfd73a458
+  metadata.gz: 70fe31a8b4317370e678562b7ce01baa5db0b8e48b8b185197c88285731a476b
+  data.tar.gz: 73542839d5a7ac83b87698248308e46faa5397f94c8a63758ebdfd4a93f42a22
 SHA512:
-  metadata.gz: 34da0ef4ee834f38767b57544eddbdb9918b56addedb69ebf5f76604ea17f1d5dee3e0f9cf8cfec41ec298de1c6293fbbafeaa4155a5269e8305e82074574313
-  data.tar.gz: 57d61f7ad89951e09f272fdbc8d9c58a6cdaebabc5ab038bcdde0ea3c7b568773f6f3c3695d4456735a7646d0c32678548b25007a4ed963e02a16a6ad254ccdb
+  metadata.gz: 27154cc9e7eb4e48f595042cf2e100093647307e62fd6552f57d9e782d5926232fa67d0cb07c0f8767582fe6e123ec165db33efe62b7ca2fd73e237af87e9107
+  data.tar.gz: 2d05b80c15f37828f1da3ac56857843e21fc33b138c9bfd8109e7a74f9defb64042155a3a84fc6343e99ffea5353cc157f5d8ef6337ac2be30de29036e1c4b94

data/Gemfile

@@ -10,5 +10,6 @@ source "https://rubygems.org" do
   end
 
   gem "nokogiri", "~> 1.11"
+  gem "rexml", "~> 3.2", ">= 3.2.5"
   gem "zeitwerk", "~> 2.4.2"
 end

data/Gemfile.lock

@@ -83,6 +83,7 @@ PLATFORMS
 DEPENDENCIES
   nokogiri (~> 1.11)!
   rake (~> 13.0.6)!
+  rexml (~> 3.2, >= 3.2.5)!
   rspec (~> 3.0)!
   rubocop-govuk (~> 4.0.0)!
   zeitwerk (~> 2.4.2)!

data/lib/epb_view_models.rb

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

data/lib/helper/xml_enums_to_output.rb

@@ -163,7 +163,7 @@ module Helper
       "6" => "mechanical extract, decentralised (MEV dc)",
       "7" => "balanced without heat recovery (MV)",
       "8" => "balanced with heat recovery (MVHR)",
-      "9" => "natural with intermittent extract fans and/or passive vents.  For backwards compatibility only, do not use.",
+      "9" => "natural with intermittent extract fans and/or passive vents. For backwards compatibility only, do not use.",
       "10" => "natural with intermittent extract fans and passive vents",
     }.freeze
     CYLINDER_INSULATION_THICKNESS = {
@@ -306,7 +306,7 @@ module Helper
     end
 
     def self.transaction_type(value, report_type = "2", schema_type = "")
-      types_of_ni = %w[
+      types_of_ni = %i[
         RdSAP-Schema-NI-20.0.0
         RdSAP-Schema-NI-19.0
         RdSAP-Schema-NI-18.0
@@ -331,7 +331,7 @@ module Helper
     end
 
     def self.construction_age_band_lookup(value, schema_type, report_type)
-      types_of_sap_pre17 = %w[
+      types_of_sap_pre17 = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -346,7 +346,7 @@ module Helper
         SAP-Schema-11.0
       ].freeze
 
-      schemes_that_use_not_recorded = %w[
+      schemes_that_use_not_recorded = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -357,7 +357,7 @@ module Helper
         RdSAP-Schema-17.0
       ]
 
-      schemes_that_use_l = %w[
+      schemes_that_use_l = %i[
         SAP-Schema-18.0.0
         SAP-Schema-17.1
         SAP-Schema-17.0
@@ -368,7 +368,7 @@ module Helper
         RdSAP-Schema-17.0
       ]
 
-      schemes_that_use_0 = %w[
+      schemes_that_use_0 = %i[
         SAP-Schema-16.3
         SAP-Schema-16.2
         SAP-Schema-16.1
@@ -386,7 +386,7 @@ module Helper
         RdSAP-Schema-17.0
       ]
 
-      sap_schemas_ni = %w[
+      sap_schemas_ni = %i[
         SAP-Schema-NI-18.0.0
         SAP-Schema-NI-17.4
         SAP-Schema-NI-17.3
@@ -402,7 +402,7 @@ module Helper
         SAP-Schema-NI-13.0
       ]
 
-      rdsap_schemas_ni = %w[
+      rdsap_schemas_ni = %i[
         RdSAP-Schema-NI-20.0.0
         RdSAP-Schema-NI-19.0
         RdSAP-Schema-NI-18.0
@@ -410,29 +410,29 @@ module Helper
         RdSAP-Schema-NI-17.3
       ]
 
-      ni_schemas_pre_12 = %w[
+      ni_schemas_pre_12 = %i[
         SAP-Schema-NI-12.0
         SAP-Schema-NI-11.2
       ]
 
       if value == "K" && rdsap_schemas_ni.include?(schema_type)
-        return CONSTRUCTION_AGE_BAND_NI["K-RdSAP-NI"]
+        return CONSTRUCTION_AGE_BAND_NI["K-RdSAP-NI"] || value
       end
 
       if value == "K" && sap_schemas_ni.include?(schema_type)
-        return CONSTRUCTION_AGE_BAND_NI["K-SAP-NI"]
+        return CONSTRUCTION_AGE_BAND_NI["K-SAP-NI"] || value
       end
 
       if ni_schemas_pre_12.include?(schema_type)
         key = (value == "0" ? value : "#{value}-12.0")
-        return CONSTRUCTION_AGE_BAND_NI[key]
+        return CONSTRUCTION_AGE_BAND_NI[key] || value
       end
 
       if sap_schemas_ni.include?(schema_type) || rdsap_schemas_ni.include?(schema_type)
-        return CONSTRUCTION_AGE_BAND_NI[value]
+        return CONSTRUCTION_AGE_BAND_NI[value] || value
       end
 
-      if value == "K" && schema_type == "SAP-Schema-12.0" && is_rdsap(report_type)
+      if value == "K" && schema_type == :"SAP-Schema-12.0" && is_rdsap(report_type)
         return CONSTRUCTION_AGE_BAND["K-12.0"]
       end
 
@@ -464,14 +464,13 @@ module Helper
     end
 
     def self.mechanical_ventilation(value, schema_type, report_type)
-      types_of_sap_pre12 = %w[
+      types_of_sap_pre12 = %i[
         SAP-Schema-11.2
         SAP-Schema-11.0
         SAP-Schema-10.2
         SAP-Schema-NI-11.2
       ].freeze
-
-      if types_of_sap_pre12.include?(schema_type.to_s) && is_rdsap(report_type)
+      if types_of_sap_pre12.include?(schema_type) && is_rdsap(report_type)
         return MECHANICAL_VENTILATION["#{value}-pre12.0"]
       end
 
@@ -499,7 +498,7 @@ module Helper
     end
 
     def self.ventilation_type(value, schema_type = "")
-      ni_sap = %w[
+      ni_sap = %i[
         SAP-Schema-NI-16.1
         SAP-Schema-NI-16.0
         SAP-Schema-NI-15.0

data/lib/presenter/rd_sap/report.rb

@@ -31,7 +31,7 @@ module Presenter
           co2_emissions_potential: @view_model.potential_carbon_emission,
           construction_age_band:
             Helper::XmlEnumsToOutput.construction_age_band_lookup(
-              @view_model.property_age_band,
+              @view_model.main_dwelling_construction_age_band_or_year,
               @schema_type,
               @view_model.report_type,
             ),

data/lib/presenter/xsd.rb

@@ -0,0 +1,49 @@
+module Presenter
+  class Xsd
+    def get_enums_by_type(domain_arguments)
+      xsd_files_gateway = ViewModelGateway::XsdFilesGateway.new(domain_arguments)
+
+      begin
+        xsd_files = xsd_files_gateway.xsd_files
+      rescue ViewModelBoundary::XsdFilesNotFound => e
+        raise ViewModelBoundary::XsdFilesNotFound, e.message.to_s
+      end
+
+      hash = {}
+      xpath = "//xs:simpleType[@name='#{domain_arguments.simple_type}']//xs:enumeration"
+
+      xsd_files.each do |file|
+        doc = REXML::Document.new(File.read(file))
+        enums_hash = {}
+        REXML::XPath.each(doc, "#{xpath}/@value") do |node|
+          desc_path = "#{xpath}[@value='#{node.value}']//xs:annotation//xs:documentation"
+          enums_hash.merge!(node.value => REXML::XPath.first(doc, desc_path).children.first)
+        end
+
+        next if enums_hash.empty?
+
+        hash[xsd_files_gateway.schema_version(file)] = enums_hash
+      end
+
+      raise ViewModelBoundary::NodeNotFound, "Node #{domain_arguments.simple_type} was not found in any of the xsd files in #{domain_arguments.xsd_dir_path} directory" if hash.empty?
+
+      hash
+    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
+    end
+
+    def variation_between_schema_versions?(enums_hash)
+      enums_hash.values.flatten.uniq.count != 1
+    end
+  end
+end

data/lib/view_model_boundary/node_not_found.rb

@@ -0,0 +1,3 @@
+module ViewModelBoundary
+  class NodeNotFound < StandardError; end
+end

data/lib/view_model_boundary/xsd_files_not_found.rb

@@ -0,0 +1,3 @@
+module ViewModelBoundary
+  class XsdFilesNotFound < StandardError; end
+end

data/lib/view_model_domain/xsd_arguments.rb

@@ -0,0 +1,12 @@
+module ViewModelDomain
+  class XsdArguments
+    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :gem_path
+
+    def initialize(simple_type:, assessment_type:, xsd_dir_path: "/api/schemas/xml/**/", gem_path: "")
+      @simple_type = simple_type
+      @assessment_type = assessment_type
+      @xsd_dir_path = xsd_dir_path
+      @gem_path = gem_path
+    end
+  end
+end

data/lib/view_model_gateway/xsd_files_gateway.rb

@@ -0,0 +1,55 @@
+module ViewModelGateway
+  class XsdFilesGateway
+    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :glob_path
+
+    def initialize(domain_arguments)
+      @simple_type = domain_arguments.simple_type
+      @assessment_type = domain_arguments.assessment_type
+      @xsd_dir_path = domain_arguments.xsd_dir_path
+      @dir_path = Dir.pwd if domain_arguments.gem_path.nil? || domain_arguments.gem_path.empty?
+    end
+
+    def schema_version(file)
+      api_path = "api/schemas/xml/"
+      api_path_start = file.index(api_path) + api_path.length
+      schema_version = file[api_path_start..].split("/").first
+      sap_defnied_in_rdsap_dir?(file) ? "#{schema_version}/SAP" : schema_version
+    end
+
+    def xsd_files
+      files = case @assessment_type.downcase
+              when "sap"
+                sap_xsd_files
+              when "rdsap"
+                rdsap_xsd_files
+              when "cepc"
+                cepc_xsd_files
+              end
+
+      raise ViewModelBoundary::XsdFilesNotFound, "No xsd files were found in #{@glob_path} directory" if files.nil? || files.empty?
+
+      files
+    end
+
+  private
+
+    def sap_defnied_in_rdsap_dir?(file)
+      assessment_type == "SAP" && file.end_with?("SAP-Domains.xsd")
+    end
+
+    def sap_xsd_files
+      @glob_path = "#{@dir_path + xsd_dir_path}*-Domains.xsd"
+      Dir.glob(@glob_path)
+    end
+
+    def rdsap_xsd_files
+      @glob_path = "#{@dir_path + xsd_dir_path}*-Domains.xsd"
+      Dir.glob(@glob_path)
+    end
+
+    def cepc_xsd_files
+      @glob_path = "#{@dir_path + xsd_dir_path}Reported-Data.xsd"
+      Dir.glob(@glob_path)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.10
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
+date: 2021-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1661,6 +1661,7 @@ files:
 - lib/presenter/sap/recommendation_report.rb
 - lib/presenter/sap/report.rb
 - lib/presenter/sap/summary.rb
+- lib/presenter/xsd.rb
 - lib/view_model/ac_cert_wrapper.rb
 - lib/view_model/ac_report_wrapper.rb
 - lib/view_model/base_view_model.rb
@@ -1820,6 +1821,10 @@ files:
 - lib/view_model/sap_schema_ni_174/common_schema.rb
 - lib/view_model/sap_schema_ni_1800/common_schema.rb
 - lib/view_model/sap_wrapper.rb
+- lib/view_model_boundary/node_not_found.rb
+- lib/view_model_boundary/xsd_files_not_found.rb
+- lib/view_model_domain/xsd_arguments.rb
+- lib/view_model_gateway/xsd_files_gateway.rb
 homepage: https://github.com/communitiesuk/epb-view-models
 licenses:
 - MIT