openstudio-analysis 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7721505c4383067dbed378a9de67e7ca4d86277d0000fc47c764b7b16e79a191
-  data.tar.gz: 68d711d6ac89e4c879c1fda531e267479afce94b9b10c87b1ef30193e16f96fb
+  metadata.gz: 76642f1d452e8e46218af9c36e388da0033e43469ec2063d6c61f4e4cd9b99fd
+  data.tar.gz: 40b243f4b0375a79e726bf4105913f75fc3ce65d09134aa27e5a927c36984b57
 SHA512:
-  metadata.gz: dc866e59c1c8c5a80c21ddb3614069c7a94b48b422390a7a0f35b1781db71d10830afc7663c187082df7962a69f1d9cf5bbb5cfb9f44d1aabd53f592b6d185a0
-  data.tar.gz: 4e01767d2ea6431b0673b861552dbed0c971c7c58f7e8618814d7cfcb8c9e31774bb5b2c70ecf8f10e9c2f4b6cc264f4e96f434dabe5223a2298e1b2f2ceece9
+  metadata.gz: 5a9bbb7d5567cf1a7ecb6b243490e4eb3c50b0dd28cdad09fec821eaece6803fb45a3cb554ad975cca257e84644b8fe28630a5243ec4c62c4fc371583c01f638
+  data.tar.gz: 5a245e5b8c151fe7f079cc26af188115da571e420fc7a8df0b02a2c859bbd72ca2b91bff0aacac675677e86c7cf0d553463980ecf75ddc78e926221471f3b418

data/CHANGELOG.md

@@ -1,9 +1,16 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 1.0.5
+-------------
+* Upgrade to latest BCL (0.6.1)
+* Remove the need for the measure.json (which has been deprecated in BCL gem). Now parses the measure.xml.
+* Upgrade Faraday (1.0.1)
+* Remove dependency on Nokogiri.
+
 Version 1.0.4
 -------------
-* Update dependency nokogiri
+* Update dependency Nokogiri
 
 Version 1.0.3
 -------------

data/lib/openstudio-analysis.rb

@@ -70,6 +70,7 @@ require 'openstudio/analysis/translator/workflow'
 # helpers / core_ext
 require 'openstudio/helpers/string'
 require 'openstudio/helpers/hash'
+require 'openstudio/helpers/utils'
 
 # weather file parsing
 require 'openstudio/weather/epw'

data/lib/openstudio/analysis/translator/datapoints.rb

@@ -58,7 +58,7 @@ module OpenStudio
         attr_accessor :name
         attr_reader :analysis_name
 
-        require 'nokogiri'
+        require 'rexml/document'
 
         # Pass in the filename to read
         def initialize(csv_filename)
@@ -368,16 +368,16 @@ module OpenStudio
           data = []
           measures.each_with_index do |measure, measure_index|
             data[measure_index] = {}
-            measure_xml, measure_type = find_measure(measure.to_s)
+            measure_parsed = find_measure(measure.to_s)
 
-            raise "Could not find measure #{measure} xml in measure_paths: '#{@measure_paths.join("\n")}'" unless measure_xml
+            raise "Could not find measure #{measure} xml in measure_paths: '#{@measure_paths.join("\n")}'" unless measure_parsed
             measure_data = {}
-            measure_data[:classname] = measure_xml.xpath('/measure/class_name').text
-            measure_data[:name] = measure_xml.xpath('/measure/name').text
-            measure_data[:display_name] = measure_xml.xpath('/measure/display_name').text
-            measure_data[:measure_type] = measure_type
-            measure_data[:uid] = measure_xml.xpath('/measure/uid').text
-            measure_data[:version_id] = measure_xml.xpath('/measure/version_id').text
+            measure_data[:classname] = measure_parsed[:classname]
+            measure_data[:name] = measure_parsed[:name]
+            measure_data[:display_name] = measure_parsed[:display_name]
+            measure_data[:measure_type] = measure_parsed[:measure_type]
+            measure_data[:uid] = measure_parsed[:uid]
+            measure_data[:version_id] = measure_parsed[:version_id]
             data[measure_index][:measure_data] = measure_data
             data[measure_index][:vars] = []
             vars = measure_map[measure]
@@ -389,8 +389,8 @@ module OpenStudio
               next if var.to_s == 'None'
               var_hash = {}
               found_arg = nil
-              measure_xml.xpath('/measure/arguments/argument').each do |arg|
-                if var.to_s == '__SKIP__' || arg.xpath('name').text == var.to_s
+              measure_parsed[:arguments].each do |arg|
+                if var.to_s == '__SKIP__' || arg[:name] == var.to_s
                   found_arg = arg
                   break
                 end
@@ -404,8 +404,8 @@ module OpenStudio
                 var_type = 'boolean'
                 var_units = ''
               else
-                var_type = found_arg.xpath('type').text.downcase
-                var_units = found_arg.xpath('units')
+                var_type = found_arg[:variable_type].downcase
+                var_units = found_arg[:units]
               end
 
               var_hash[:name] = var.to_s
@@ -437,7 +437,8 @@ module OpenStudio
               var_hash[:distribution][:type] = 'discrete'
               var_hash[:distribution][:units] = var_hash[:units]
               if var_hash[:type] == 'choice'
-                var_hash[:distribution][:enumerations] = found_arg.xpath('choices/choice').map { |s| s.xpath('value').text }
+                # var_hash[:distribution][:enumerations] = found_arg.xpath('choices/choice').map { |s| s.xpath('value').text }
+                # This would need to be updated if we want to do this again... sorry.
               elsif var_hash[:type] == 'bool'
                 var_hash[:distribution][:enumerations] = []
                 var_hash[:distribution][:enumerations] << true
@@ -447,13 +448,13 @@ module OpenStudio
             end
             data[measure_index][:args] = []
 
-            measure_xml.xpath('/measure/arguments/argument').each do |arg_xml|
+            measure_parsed[:arguments].each do |arg_xml|
               arg = {}
-              arg[:value_type] = arg_xml.xpath('type').text.downcase
-              arg[:name] = arg_xml.xpath('name').text.downcase
-              arg[:display_name] = arg_xml.xpath('display_name').text.downcase
+              arg[:value_type] = arg_xml[:variable_type]
+              arg[:name] = arg_xml[:name]
+              arg[:display_name] = arg_xml[:display_name].downcase
               arg[:display_name_short] = arg[:display_name]
-              arg[:default_value] = arg_xml.xpath('default_value').text.downcase
+              arg[:default_value] = arg_xml[:default_value].downcase
               arg[:value] = arg[:default_value]
               data[measure_index][:args] << arg
             end
@@ -470,27 +471,12 @@ module OpenStudio
             measure_xml = File.join(mp, measure_name, 'measure.xml')
             measure_rb = File.join(mp, measure_name, 'measure.rb')
             if File.exist?(measure_xml) && File.exist?(measure_rb)
-              return Nokogiri::XML File.read(measure_xml), parse_measure_type(measure_rb)
+              measure_parsed = parse_measure_xml(measure_xml)
+              return measure_parsed
             end
           end
 
-          return nil, nil
-        end
-
-        def parse_measure_type(measure_filename)
-          measure_string = File.read(measure_filename)
-
-          if measure_string =~ /OpenStudio::Ruleset::WorkspaceUserScript/
-            return 'EnergyPlusMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::ModelUserScript/
-            return 'RubyMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::ReportingUserScript/
-            return 'ReportingMeasure'
-          elsif measure_string =~ /OpenStudio::Ruleset::UtilityUserScript/
-            return 'UtilityUserScript'
-          else
-            raise "measure type is unknown with an inherited class in #{measure_filename}"
-          end
+          return nil
         end
       end
     end

data/lib/openstudio/analysis/translator/workflow.rb

@@ -96,7 +96,7 @@ module OpenStudio
             step_hash[:modeler_description] = step[:modeler_description] if step[:modeler_description]
             step_hash[:taxonomy] = step[:taxonomy] if step[:taxonomy]
             step_hash[:measure_type] = step[:measure_type]
-            step_hash[:measure_type] = 'ModelMeasure' if step_hash[:measure_type] == 'RubyMeasure'
+            step_hash[:measure_type] = 'ModelMeasure'
             @steps << step_hash
           end
         end

data/lib/openstudio/analysis/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Analysis
-    VERSION = '1.0.4'.freeze
+    VERSION = '1.0.5'.freeze
   end
 end

data/lib/openstudio/analysis/workflow.rb

@@ -53,8 +53,7 @@ module OpenStudio
         @items.clear
       end
 
-      # Add a measure to the workflow from a path. Inside the path it is expecting to have a measure.json file
-      # if not, the BCL gem is used to create the measure.json file.
+      # Add a measure to the workflow from a path. This will parse the measure.xml which must exist.
       #
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with uni que names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
@@ -69,19 +68,11 @@ module OpenStudio
         end
 
         if Dir.exist?(local_path_to_measure) && File.directory?(local_path_to_measure)
-          # Watch out for namespace conflicts (use ::BCL)
-          b = ::BCL::ComponentMethods.new
           measure_hash = nil
-          unless File.exist?(File.join(local_path_to_measure, 'measure.json'))
-            measure_hash = b.parse_measure_file(nil, File.join(local_path_to_measure, measure_filename))
-            File.open(File.join(local_path_to_measure, 'measure.json'), 'w') { |f| f << JSON.pretty_generate(measure_hash) }
-            warn("measure.json not found in #{local_path_to_measure}, will parse measure file using BCL gem")
-          end
-
-          if measure_hash.nil? && File.exist?(File.join(local_path_to_measure, 'measure.json'))
-            measure_hash = JSON.parse(File.read(File.join(local_path_to_measure, 'measure.json')), symbolize_names: true)
-          elsif measure_hash.nil?
-            raise 'measure.json was not found and was not automatically created'
+          if File.exist?(File.join(local_path_to_measure, 'measure.xml'))
+            measure_hash = parse_measure_xml(File.join(local_path_to_measure, 'measure.xml'))
+          else
+            raise "Could not find measure.xml"
           end
 
           add_measure(instance_name, instance_display_name, local_path_to_measure, measure_hash)
@@ -92,12 +83,12 @@ module OpenStudio
         @items.last
       end
 
-      # Add a measure from the custom hash format without reading the measure.rb or measure.json file
+      # Add a measure from the custom hash format without reading the measure.rb or measure.xml file
       #
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @param local_path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
-      # @param measure_metadata [Hash] Format of the measure.json
+      # @param measure_metadata [Hash] Format of the measure.xml in JSON format
       # @return [Object] Returns the measure that was added as an OpenStudio::AnalysisWorkflowStep object
       def add_measure(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
         @items << OpenStudio::Analysis::WorkflowStep.from_measure_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
@@ -110,7 +101,7 @@ module OpenStudio
       # @params instance_name [String] The name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @params instance_display_name [String] The display name of the instance. This allows for multiple measures to be added to the workflow with unique names
       # @param local_path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
-      # @param measure_metadata [Hash] Format of the measure.json
+      # @param measure_metadata [Hash] Format of the measure.xml in JSON format
       # @return [Object] Returns the measure that was added as an OpenStudio::AnalysisWorkflowStep object
       def add_measure_from_analysis_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)
         @items << OpenStudio::Analysis::WorkflowStep.from_analysis_hash(instance_name, instance_display_name, local_path_to_measure, measure_metadata)

data/lib/openstudio/analysis/workflow_step.rb

@@ -60,7 +60,7 @@ module OpenStudio
         @name = ''
         @display_name = ''
 
-        # The type of item being added (RubyMeasure, EnergyPlusMeasure, ...)
+        # The type of item being added (ModelMeasure, EnergyPlusMeasure, ...)
         @type = nil
 
         @measure_definition_class_name = nil
@@ -267,15 +267,12 @@ module OpenStudio
       #
       # @param instance_name [String] Machine name of the instance
       # @param instance_display_name [String] Display name of the instance
-      # @param path_to_measure [String] This is the local path to the measure directroy, relative or absolute. It is used when zipping up all the measures.
-      # @param hash [Hash] Measure hash in the format of the measure.json (from the Analysis Spreadsheet project)
+      # @param path_to_measure [String] This is the local path to the measure directory, relative or absolute. It is used when zipping up all the measures.
+      # @param hash [Hash] Measure hash in the format of a converted measure.xml hash (from the Analysis Spreadsheet project)
       # @param options [Hash] Optional arguments
       # @option options [Boolean] :ignore_not_found Do not raise an exception if the measure could not be found on the machine
       # @return [Object] Returns the OpenStudio::Analysis::WorkflowStep
       def self.from_measure_hash(instance_name, instance_display_name, path_to_measure, hash, options = {})
-        # TODO: Validate the hash
-        # TODO: validate that the measure exists?
-
         if File.directory? path_to_measure
           path_to_measure = File.join(path_to_measure, 'measure.rb')
         end
@@ -352,7 +349,7 @@ module OpenStudio
       # @param instance_name [String] Machine name of the instance
       # @param instance_display_name [String] Display name of the instance
       # @param path_to_measure [String] This is the local path to the measure directroy, relative or absolute. It is used when zipping up all the measures.
-      # @param hash [Hash] Measure hash in the format of the measure.json (from the Analysis Spreadsheet project)
+      # @param hash [Hash] Measure hash in the format of the measure.xml converted to JSON (from the Analysis Spreadsheet project)
       # @param options [Hash] Optional arguments
       # @option options [Boolean] :ignore_not_found Do not raise an exception if the measure could not be found on the machine
       # @return [Object] Returns the OpenStudio::Analysis::WorkflowStep

data/lib/openstudio/helpers/utils.rb

@@ -0,0 +1,67 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
+# All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# (4) Other than as required in clauses (1) and (2), distributions in any form
+# of modifications or other derivative works may not use the "OpenStudio"
+# trademark, "OS", "os", or any other confusingly similar designation without
+# specific prior written permission from Alliance for Sustainable Energy, LLC.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER, THE UNITED STATES
+# GOVERNMENT, OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+# EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'rexml/document'
+
+def parse_measure_xml(measure_xml_filename)
+  measure_hash = {}
+  xml_to_parse = File.open(measure_xml_filename)
+  xml_root = REXML::Document.new(xml_to_parse).root
+
+  # pull out some information
+  measure_hash[:classname] = xml_root.elements['//measure/class_name'].text
+  measure_hash[:name] = xml_root.elements['//measure/name'].text
+  measure_hash[:display_name] = xml_root.elements['//measure/display_name'].text
+  measure_hash[:display_name_titleized] = measure_hash[:name].titleize
+  measure_hash[:measure_type] = xml_root.elements['//measure/attributes/attribute[name="Measure Type"]/value'].text
+  measure_hash[:description] = xml_root.elements['//measure/description'].text
+  measure_hash[:modeler_description] = xml_root.elements['//measure/modeler_description'].text
+  measure_hash[:uid] = xml_root.elements['//measure/uid'].text
+  measure_hash[:version_id] = xml_root.elements['//measure/version_id'].text
+  measure_hash[:arguments] = []
+
+  REXML::XPath.each(xml_root, '//measure/arguments/argument' ) do |arg|
+
+    measure_hash[:arguments] << {
+        name: arg.elements['name'].text,
+        display_name: arg.elements['display_name'].text,
+        variable_type: arg.elements['type'].text.downcase,
+        default_value: arg.elements['default_value'].text,
+        units: arg.elements['units'] ? arg.elements['units'].text : ''
+    }
+  end
+
+  measure_hash
+end

data/openstudio-analysis.gemspec

@@ -23,10 +23,9 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '~> 2.5.0'
 
-  s.add_dependency 'bcl', '= 0.5.8'
+  s.add_dependency 'bcl', '~> 0.6.1'
   s.add_dependency 'dencity', '~> 0.1.0'
-  s.add_dependency 'faraday', '~> 0.14'
-  s.add_dependency 'nokogiri', '~> 1.10.8'
+  s.add_dependency 'faraday', '~> 1.0.1'
   s.add_dependency 'roo', '~> 2.8.3'
   s.add_dependency 'rubyzip', '~> 2.3.0'
   s.add_dependency 'semantic', '~> 1.4'

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-analysis
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Nicholas Long
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.8
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: dencity
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.8
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: roo
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +180,7 @@ files:
 - lib/openstudio/analysis/workflow_step.rb
 - lib/openstudio/helpers/hash.rb
 - lib/openstudio/helpers/string.rb
+- lib/openstudio/helpers/utils.rb
 - lib/openstudio/weather/epw.rb
 - openstudio-analysis.gemspec
 - update_license.rb