epb_view_models 1.0.8 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59d79d9f281a39f02dbee9c2951c691175b3dfc89f0bf3e3f907aa3210e07e8a
-  data.tar.gz: 648c87f4d9ad0b4f23eaf859969665ec413b4a62fd7fc621d764cd2211231eb2
+  metadata.gz: 1aa9014f126ebe6df35a45f9be7898fe71ebf4253739d537c62ab133f976480a
+  data.tar.gz: 9de075f8be11ba4626d771128e75f72917edfb3797eeee2f4bac4c6252df32d7
 SHA512:
-  metadata.gz: 40c679fd072c9fea3087edcfc7e04d289f1bf4c653c60cb2f1c25fb114aa3cbf9d4ef1d4a3ac9c17220bd6b3f876d133b29e8d58bda62acf642e6fa16eef9977
-  data.tar.gz: a754bf7fe7e9a8fb144ae351fa1e7af1591ee572370d384a23fb857f254133c5087a313951dd77757dea1b38baaffb45c973de651a971a0f2bb941f1027ac4c3
+  metadata.gz: 3ea8139966fc1c55555be100e3ecb63a19364eb6e027c631aa1865a753af2577abee1c00ab53edb78436754fdd89db0aa331a42518cdf1bea5b03b242be48023
+  data.tar.gz: cefc2119116d4aab5c1299dd71f609df481e4ca2327a17a8bca256d83a92eeefed2e17127650e3d24d86fdd39445306d8456439947c55db20119168414ce50c7

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.8"
+  VERSION = "1.0.12"
 end
 
 # Monkey patching to avoid using ActiveRecord::Type::Boolean.new.cast

data/lib/presenter/xsd.rb

@@ -0,0 +1,67 @@
+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 = {}
+
+      xsd_files.each do |file|
+        enums_hash = File.extname(file).downcase == ".xsd" ? read_xsd(file, domain_arguments.simple_type) : read_xml(file, domain_arguments.simple_type, domain_arguments.node_hash)
+
+        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 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
+
+  private
+
+    def read_xsd(file_name, simple_type)
+      xpath = "//xs:simpleType[@name='#{simple_type}']//xs:enumeration"
+      doc = REXML::Document.new(File.read(file_name))
+      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
+      enums_hash
+    end
+
+    def read_xml(file_name, node_name, node_hash)
+      doc = Nokogiri.XML(File.read(file_name))
+      enums_hash = {}
+
+      doc.xpath(node_name).each do |node|
+        enums_hash.merge!(node.xpath(node_hash.keys[0].to_s).children.text => node.xpath(node_hash.values[0]).children.text)
+      end
+
+      enums_hash
+    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,13 @@
+module ViewModelDomain
+  class XsdArguments
+    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :gem_path, :node_hash
+
+    def initialize(simple_type:, assessment_type:, xsd_dir_path: "", gem_path: "", node_hash: nil)
+      @simple_type = simple_type
+      @assessment_type = assessment_type
+      @xsd_dir_path = xsd_dir_path
+      @gem_path = gem_path
+      @node_hash = node_hash
+    end
+  end
+end

data/lib/view_model_gateway/xsd_files_gateway.rb

@@ -0,0 +1,61 @@
+module ViewModelGateway
+  class XsdFilesGateway
+    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :glob_path
+
+    API_PATH = "api/schemas/xml/".freeze
+    XSD_DEFAULT_PATH = "/api/schemas/xml/**/".freeze
+
+    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_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 = if @xsd_dir_path.nil? || @xsd_dir_path.empty?
+                case @assessment_type.downcase
+                when "sap"
+                  sap_xsd_files
+                when "rdsap"
+                  rdsap_xsd_files
+                when "cepc"
+                  cepc_xsd_files
+                end
+              else
+                Dir.glob("#{@dir_path}#{@xsd_dir_path}")
+              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_DEFAULT_PATH}*-Domains.xsd"
+      Dir.glob(@glob_path)
+    end
+
+    def rdsap_xsd_files
+      @glob_path = "#{@dir_path + XSD_DEFAULT_PATH}*-Domains.xsd"
+      Dir.glob(@glob_path)
+    end
+
+    def cepc_xsd_files
+      @glob_path = "#{@dir_path + XSD_DEFAULT_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.8
+  version: 1.0.12
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-10-18 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