epb_view_models 1.0.10 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70fe31a8b4317370e678562b7ce01baa5db0b8e48b8b185197c88285731a476b
-  data.tar.gz: 73542839d5a7ac83b87698248308e46faa5397f94c8a63758ebdfd4a93f42a22
+  metadata.gz: ee84c9018a99e7ecc114cd9e16da64303f337d6d53ecd4f243510fdcdeeace59
+  data.tar.gz: f2a5ecdb96d373dfc64317ab94a626b9fab1c91b9957de9d765927fdca73f5b2
 SHA512:
-  metadata.gz: 27154cc9e7eb4e48f595042cf2e100093647307e62fd6552f57d9e782d5926232fa67d0cb07c0f8767582fe6e123ec165db33efe62b7ca2fd73e237af87e9107
-  data.tar.gz: 2d05b80c15f37828f1da3ac56857843e21fc33b138c9bfd8109e7a74f9defb64042155a3a84fc6343e99ffea5353cc157f5d8ef6337ac2be30de29036e1c4b94
+  metadata.gz: bf9fc7e313914c1b34ba94c7ea3dd9f83c6a1ae47b80669e53f01b75b1721f57fb57b356e52eeac54d58d24ba3d03e561ff6e5725f4980a42b02b74d5e971345
+  data.tar.gz: cc89d10482409d65e7fadc02fb7db449e2d54bab4f2d7fa8bf45dcc293883201e81d618fbfa36f24eed6c980bd1e65651f89cdda616aa3bc3a75c2d81d40b602

data/lib/epb_view_models.rb

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

data/lib/presenter/export/statistics.rb

@@ -0,0 +1,29 @@
+module Presenter::Export
+  class Statistics
+    def initialize(wrapper)
+      @wrapper = wrapper
+      @view_model = wrapper.view_model
+    end
+
+    def build
+      {
+        current_energy_rating: current_energy_rating,
+        transaction_type: @view_model.transaction_type,
+      }
+    rescue NoMethodError
+      nil
+    end
+
+  private
+
+    def current_energy_rating
+      view_model_type = @view_model.class.to_s.split("::")[1].downcase
+
+      if view_model_type.include?("sapschema")
+        @view_model.current_energy_rating
+      elsif view_model_type.include?("cepc")
+        @view_model.energy_efficiency_rating
+      end
+    end
+  end
+end

data/lib/presenter/rd_sap/export_configuration.rb

@@ -0,0 +1 @@
+

data/lib/presenter/to_warehouse/base_configuration.rb

@@ -0,0 +1,23 @@
+module Presenter
+  module ToWarehouse
+    class BaseConfiguration
+      def to_args
+        self.class.args
+      end
+
+      class << self
+        KEYS = %i[excludes includes bases preferred_keys list_nodes rootless_list_nodes].freeze
+
+        KEYS.each do |key|
+          define_method key do |arg|
+            args[key] = arg
+          end
+        end
+
+        def args
+          @args ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/presenter/xml/parser.rb

@@ -0,0 +1,220 @@
+module Presenter
+  module Xml
+    class Parser
+      def initialize(excludes: [], includes: [], bases: [], preferred_keys: {}, list_nodes: [], rootless_list_nodes: {})
+        @excludes = excludes
+        @includes = includes
+        @bases = bases
+        @preferred_keys = preferred_keys
+        @list_nodes = list_nodes
+        @rootless_list_nodes = rootless_list_nodes
+      end
+
+      def parse(xml)
+        sax_parser.parse xml
+        last_output
+      end
+
+      def sax_parser
+        @assessment_document ||= AssessmentDocument.new excludes: @excludes,
+                                                        includes: @includes,
+                                                        bases: @bases,
+                                                        preferred_keys: @preferred_keys,
+                                                        list_nodes: @list_nodes,
+                                                        rootless_list_nodes: @rootless_list_nodes
+        @sax_parser ||= Nokogiri::XML::SAX::Parser.new @assessment_document
+      end
+
+    private
+
+      def last_output
+        @assessment_document.output
+      end
+    end
+
+    class AssessmentDocument < Nokogiri::XML::SAX::Document
+      def initialize(excludes: [], includes: [], bases: [], preferred_keys: {}, list_nodes: [], rootless_list_nodes: {})
+        @excludes = excludes
+        @includes = includes
+        @bases = bases
+        @preferred_keys = preferred_keys
+        @list_nodes = list_nodes
+        @rootless_list_nodes = rootless_list_nodes
+        super()
+      end
+
+      def start_document
+        init!
+        @output = {}
+      end
+
+      def end_document
+        init!
+      end
+
+      def start_element_namespace(name, attrs = nil, _prefix = nil, _uri = nil, _namespace = nil)
+        @source_position << name
+        @output_position << root_key_for_list if at_rootless_list_node_item?
+        @output_position << as_key(name) unless is_base?(name)
+        @is_excluding = true if @excludes.include?(name)
+        @is_including = true if @includes.include?(name)
+        super
+        if encountered_position? || at_list_node_item?
+          set_up_list
+        end
+        write_encounter
+      end
+
+      def start_element(_name, attrs = nil)
+        @attrs = attrs
+      end
+
+      def end_element_namespace(name, _prefix = nil, _uri = nil)
+        @output_position.pop unless is_base?(name)
+        @output_position.pop if at_rootless_list_node_item?
+        @source_position.pop
+        @is_excluding = false if @excludes.include?(name)
+        @is_including = false if @includes.include?(name)
+      end
+
+      def characters(string)
+        if @is_excluding && !@is_including
+          return
+        end
+
+        stripped = string.strip
+        if stripped.length.zero?
+          return
+        end
+
+        value = try_as_number stripped
+
+        if @attrs.length.positive?
+          value = @attrs.to_h.merge({ "value" => value })
+        end
+
+        set_value value
+      end
+
+      attr_reader :output
+
+    private
+
+      def init!
+        @source_position = []
+        @output_position = []
+        @is_excluding = false
+        @is_including = false
+        @attrs = []
+        @encountered = []
+      end
+
+      def as_key(name)
+        if @preferred_keys.key?(name)
+          return @preferred_keys[name]
+        end
+
+        name.downcase.gsub("-", "_")
+      end
+
+      def set_value(value)
+        set_value_with_keys(value, @output_position)
+      end
+
+      def set_value_with_keys(value, keys)
+        prepare_hash keys
+        *key, last = keys
+        key.inject(@output, :fetch)[last] = value
+      end
+
+      def value_at(keys)
+        keys.inject(@output, :fetch)
+      rescue IndexError
+        nil
+      end
+
+      def prepare_hash(keys)
+        cursor = @output
+        keys[..-2].each do |key|
+          cursor[key] = {} unless cursor[key] && cursor[key] != ""
+          cursor = cursor[key]
+        end
+      end
+
+      def is_base?(name)
+        @bases.concat(@excludes).include?(name) || name == @source_position[0]
+      end
+
+      def is_numeric?(string)
+        true if Float(string)
+      rescue StandardError
+        false
+      end
+
+      def try_as_number(string)
+        return string unless is_numeric?(string)
+
+        if string.include?(".")
+          string.to_f
+        else
+          string.to_i
+        end
+      end
+
+      def write_encounter
+        @encountered << source_position_string
+      end
+
+      def encountered_position?
+        @encountered.include? source_position_string
+      end
+
+      def source_position_string
+        @source_position.join(">")
+      end
+
+      def set_up_list
+        return if @output_position.any? { |x| x.is_a? Integer } && !at_list_node_item?
+
+        candidate_list = value_at @output_position[..-2]
+
+        case candidate_list
+        when Array
+          list_index = candidate_list.length
+        when nil
+          set_value_with_keys([], @output_position[..-2])
+          list_index = 0
+        else
+          set_value_with_keys([candidate_list.values[0]], @output_position[..-2])
+          list_index = 1
+        end
+
+        @output_position[-1] = list_index
+      end
+
+      def at_list_node_item?
+        @list_nodes.include?(@source_position[-2]) || at_rootless_list_node_item?
+      end
+
+      def at_rootless_list_node_item?
+        return unless @rootless_list_nodes.key?(@source_position[-1])
+
+        case value = @rootless_list_nodes[@source_position[-1]]
+        when String
+          true
+        else
+          value[:parents].all? { |val| @source_position.include? val }
+        end
+      end
+
+      def root_key_for_list
+        case value = @rootless_list_nodes[@source_position[-1]]
+        when String
+          value
+        else
+          value[:key]
+        end
+      end
+    end
+  end
+end

data/lib/presenter/xsd.rb

@@ -10,22 +10,16 @@ module Presenter
       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
+        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 xsd files in #{domain_arguments.xsd_dir_path} directory" if hash.empty?
+      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
@@ -45,5 +39,29 @@ module Presenter
     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_domain/xsd_arguments.rb

@@ -1,12 +1,13 @@
 module ViewModelDomain
   class XsdArguments
-    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :gem_path
+    attr_reader :simple_type, :assessment_type, :xsd_dir_path, :gem_path, :node_hash
 
-    def initialize(simple_type:, assessment_type:, xsd_dir_path: "/api/schemas/xml/**/", gem_path: "")
+    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

@@ -2,6 +2,9 @@ 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
@@ -10,20 +13,24 @@ module ViewModelGateway
     end
 
     def schema_version(file)
-      api_path = "api/schemas/xml/"
-      api_path_start = file.index(api_path) + api_path.length
+      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
+      sap_defined_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
+      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?
@@ -33,22 +40,22 @@ module ViewModelGateway
 
   private
 
-    def sap_defnied_in_rdsap_dir?(file)
+    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_dir_path}*-Domains.xsd"
+      @glob_path = "#{@dir_path + XSD_DEFAULT_PATH}*-Domains.xsd"
       Dir.glob(@glob_path)
     end
 
     def rdsap_xsd_files
-      @glob_path = "#{@dir_path + xsd_dir_path}*-Domains.xsd"
+      @glob_path = "#{@dir_path + XSD_DEFAULT_PATH}*-Domains.xsd"
       Dir.glob(@glob_path)
     end
 
     def cepc_xsd_files
-      @glob_path = "#{@dir_path + xsd_dir_path}Reported-Data.xsd"
+      @glob_path = "#{@dir_path + XSD_DEFAULT_PATH}Reported-Data.xsd"
       Dir.glob(@glob_path)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epb_view_models
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.14
 platform: ruby
 authors:
 - MHCLG Energy Performance of Buildings
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -1655,12 +1655,16 @@ files:
 - lib/presenter/export/base.rb
 - lib/presenter/export/commercial.rb
 - lib/presenter/export/domestic.rb
+- lib/presenter/export/statistics.rb
+- lib/presenter/rd_sap/export_configuration.rb
 - lib/presenter/rd_sap/recommendation_report.rb
 - lib/presenter/rd_sap/report.rb
 - lib/presenter/rd_sap/summary.rb
 - lib/presenter/sap/recommendation_report.rb
 - lib/presenter/sap/report.rb
 - lib/presenter/sap/summary.rb
+- lib/presenter/to_warehouse/base_configuration.rb
+- lib/presenter/xml/parser.rb
 - lib/presenter/xsd.rb
 - lib/view_model/ac_cert_wrapper.rb
 - lib/view_model/ac_report_wrapper.rb