epb_view_models 1.0.9 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94ef952761872299d77aff99b1c9ac3d82d1df98a63cd74d0520c1628475f319
-  data.tar.gz: 4466ab181f638cd85fc7ef943f6b78709b770a742dcd07529e708f49c3e9669f
+  metadata.gz: 8d6b7baac28f53821c21ca4a9e6517bb3f3f0b8abf990aa3899bc8a61ef3c982
+  data.tar.gz: 9e1a9e515367fca063c6be4b06dc4a7a23ee3563f87fe5ae0d8a40a649d6d5ea
 SHA512:
-  metadata.gz: 69ceeb585c7014f6b47c4a71241d8a5120cf9dee08e41bd53f90ea3b9bf1a7b4e5b29c8dabf643060b471acee26778295c04c83a4fb6bd1000be0deff6ccb959
-  data.tar.gz: 3fe39ccc50a2ddff5fa2040d214b95c56554e45b8332fd5ba9aa29ed57648c7c68bdf9a1210143babd0518d777033fd0db9e8778487d4d0e477a34a4d6c0dd75
+  metadata.gz: 43c9884e01d2242b4d89d9cb0f0274a6721aecd484944f523a7aac399d5b890472728384fe35d2892bff273f396e82bf03ca1e5a2e68fc72d430b23509109394
+  data.tar.gz: dbcdc6c7fac809075b206c908df02ee82affc3a4b13e8115b9e4dccc51ea673d11655a79de7374dd0d3fe54f83e43afbf91dbc3e3d8fa3625b201cb5ad927134

data/lib/epb_view_models.rb

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

data/lib/presenter/xsd.rb

@@ -1,31 +1,32 @@
 module Presenter
   class Xsd
-    def initialize(assessment_type:, xsd_dir_path: "api/schemas/xml/*/")
-      @assessment_type = assessment_type
-      @xsd_dir_path = xsd_dir_path
-    end
+    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
 
-    def get_enums_by_type(simple_type)
       hash = {}
-      xpath = "//xs:simpleType[@name='#{simple_type}']//xs:enumeration"
-      xsd_files.each do |file_name|
-        doc = REXML::Document.new(File.read(file_name))
-        enums_hash = {}
-        REXML::XPath.each(doc, "#{xpath}/@value") do |e|
-          desc_path = "#{xpath}[@value='#{e.value}']//xs:annotation//xs:documentation"
-          enums_hash.merge!(e.value => REXML::XPath.first(doc, desc_path).children.first)
-        end
+
+      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[schema_version(file_name)] = enums_hash
+        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(simple_type)
+    def unique_enums(domain_arguments)
       uniq_enums = []
-      enums = get_enums_by_type(simple_type).values
+      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)
@@ -41,36 +42,26 @@ module Presenter
 
   private
 
-    def schema_version(file_name)
-      schema_version = file_name.delete_prefix("api/schemas/xml/").split("/").first
-      sap_defnied_in_rdsap_dir?(file_name) ? "#{schema_version}/SAP" : schema_version
-    end
-
-    def xsd_files
-      case @assessment_type
-      when "SAP"
-        sap_xsd_files
-      when "RdSAP"
-        rdsap_xsd_files
-      when "CEPC"
-        cepc_xsd_files
+    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 sap_xsd_files
-      Dir.glob("#{@xsd_dir_path}*-Domains.xsd")
-    end
-
-    def rdsap_xsd_files
-      Dir.glob("#{@xsd_dir_path}SAP-Domains.xsd")
-    end
+    def read_xml(file_name, node_name, node_hash)
+      doc = Nokogiri.XML(File.read(file_name))
+      enums_hash = {}
 
-    def cepc_xsd_files
-      Dir.glob("#{@xsd_dir_path}Reported-Data.xsd")
-    end
+      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
 
-    def sap_defnied_in_rdsap_dir?(file_name)
-      @assessment_type == "SAP" && file_name.end_with?("SAP-Domains.xsd")
+      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,62 @@
+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_defined_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
+                @glob_path = "#{@dir_path}#{@xsd_dir_path}"
+                Dir.glob(@glob_path)
+              end
+
+      raise ViewModelBoundary::XsdFilesNotFound, "No xsd files were found in #{@glob_path} directory" if files.nil? || files.empty?
+
+      files
+    end
+
+  private
+
+    def sap_defined_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.9
+  version: 1.0.13
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1821,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