openstudio-analysis 1.0.0 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06d3c96c3060a4b3c38b3a71ce868bdd77e81de8
-  data.tar.gz: ac9f3cb8d26c95d533be4f3bffe3fddc58d5f0fd
+SHA256:
+  metadata.gz: 76642f1d452e8e46218af9c36e388da0033e43469ec2063d6c61f4e4cd9b99fd
+  data.tar.gz: 40b243f4b0375a79e726bf4105913f75fc3ce65d09134aa27e5a927c36984b57
 SHA512:
-  metadata.gz: b7e98970c92beb469d3b4e3d6198cb79bc2ce63e20c7d13c1541a5afa78cb2ee1873fb43d5776703fa43be8f9ec6f763c2c82b2a5b67575b0ba6f6f2ccc412ed
-  data.tar.gz: 074efcb873df6e3233dd80129260d5b0007c871732e983bf780e2b35e6ef66e4cac8969f55cb742512ba6b440b0c3c59483d98299339ac55ed515d41ddbc4200
+  metadata.gz: 5a9bbb7d5567cf1a7ecb6b243490e4eb3c50b0dd28cdad09fec821eaece6803fb45a3cb554ad975cca257e84644b8fe28630a5243ec4c62c4fc371583c01f638
+  data.tar.gz: 5a245e5b8c151fe7f079cc26af188115da571e420fc7a8df0b02a2c859bbd72ca2b91bff0aacac675677e86c7cf0d553463980ecf75ddc78e926221471f3b418

data/.gitignore

@@ -5,7 +5,7 @@
 *.swp
 *.gem
 ~$*
-.rubocop-https*
+.rubocop-http*
 tmp/*
 .yardoc
 doc/
@@ -18,3 +18,4 @@ Gemfile.lock
 spec/files/measures/ActualMeasureNoJson/measure.json
 rubocop-results.xml
 coverage
+/gems

data/.rubocop.yml

@@ -5,4 +5,4 @@ AllCops:
     - 'spec/files/worker_init/*'
 
 inherit_from:
-  - https://raw.githubusercontent.com/NREL/OpenStudio-resources/develop/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.2.4
-  - 2.4.2
+  - 2.5.1
+before_install: gem install bundler -v 2.1

data/CHANGELOG.md

@@ -1,10 +1,37 @@
 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
+
+Version 1.0.3
+-------------
+* Update dependencies roo and rubyzip
+
+Version 1.0.2
+-------------
+* Updates required for OpenStudio 3x
+* Require Ruby ~> 2.5.1
+* Update to Nokogiri ~> 1.8.2 (required for Ruby 2.5 on Windows)
+
+Version 1.0.1
+-------------
+* Add support for Ruby 2.5.1 (keeping support for 2.2)
+* Lock version of Roo to older version 
+* Updated copyright dates and remove old LGPL license. License is not LGPL but a BSD-style license.
+
 Version 1.0.0
 -------------
 This is the first official release in quite some time. This includes many changes which unfortunately have not been 
-catelogued. The changes from 0.4.5 include:
+cataloged. The changes from 0.4.5 include:
 
 * Requires ruby > 2.1.
 * Default path to ServerApi logfile to ~/os_server_api.log. This can be overridden by setting the log_path options key in the initializer.

data/Gemfile

@@ -3,8 +3,7 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'colored', '~> 1.2'
-gem 'dencity'
-gem 'openstudio-aws', '0.4.2'
+gem 'openstudio-aws', '~> 0.4.2'
 
 group :test do
   # Don't install coveralls on window because requires devkit for json
@@ -12,7 +11,4 @@ group :test do
     gem 'coveralls', require: false
   end
   gem 'ci_reporter_rspec'
-  gem 'rspec', '~> 3.4'
-  gem 'rubocop'
-  gem 'rubocop-checkstyle_formatter'
 end

data/LICENSE.md

@@ -0,0 +1,28 @@
+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 HOLDER(S) AND ANY 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(S), ANY CONTRIBUTORS, THE UNITED 
+STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF THEIR EMPLOYEES, 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.

data/README.md

@@ -30,7 +30,7 @@ There are two ways to create an OpenStudio Analysis description:
     
     # add measures to the workflow
     wf = analysis.workflow
-    def add_measure_from_path(instance_name, instance_display_name, local_path_to_measure)
+    # def add_measure_from_path(instance_name, instance_display_name, local_path_to_measure)
     wf.add_measure_from_path('instance_name', 'Display name', 'path_to_measure')
     wf.add_measure_from_path('instance_name_2', 'Display name two', 'path_to_measure_2')
     

data/Rakefile

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio-analysis.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -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.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -130,35 +130,31 @@ module OpenStudio
             new_wfi[:description] = wf[:description] if wf[:description]
             new_wfi[:arguments] = []
 
-            if wf[:arguments]
-              wf[:arguments].each do |arg|
-                wfi_arg = {}
-                wfi_arg[:display_name] = arg[:display_name] if arg[:display_name]
-                wfi_arg[:display_name_short] = arg[:display_name_short] if arg[:display_name_short]
-                wfi_arg[:name] = arg[:name] if arg[:name]
-                wfi_arg[:data_type] = arg[:value_type] if arg[:value_type]
-                wfi_arg[:default_value] = nil
-                wfi_arg[:description] = ''
-                wfi_arg[:display_units] = '' # should be haystack compatible unit strings
-                wfi_arg[:units] = '' # should be haystack compatible unit strings
+            wf[:arguments]&.each do |arg|
+              wfi_arg = {}
+              wfi_arg[:display_name] = arg[:display_name] if arg[:display_name]
+              wfi_arg[:display_name_short] = arg[:display_name_short] if arg[:display_name_short]
+              wfi_arg[:name] = arg[:name] if arg[:name]
+              wfi_arg[:data_type] = arg[:value_type] if arg[:value_type]
+              wfi_arg[:default_value] = nil
+              wfi_arg[:description] = ''
+              wfi_arg[:display_units] = '' # should be haystack compatible unit strings
+              wfi_arg[:units] = '' # should be haystack compatible unit strings
 
-                new_wfi[:arguments] << wfi_arg
-              end
+              new_wfi[:arguments] << wfi_arg
             end
 
-            if wf[:variables]
-              wf[:variables].each do |arg|
-                wfi_var = {}
-                wfi_var[:display_name] = arg[:argument][:display_name] if arg[:argument][:display_name]
-                wfi_var[:display_name_short] = arg[:argument][:display_name_short] if arg[:argument][:display_name_short]
-                wfi_var[:name] = arg[:argument][:name] if arg[:argument][:name]
-                wfi_var[:default_value] = nil
-                wfi_var[:data_type] = arg[:argument][:value_type] if arg[:argument][:value_type]
-                wfi_var[:description] = ''
-                wfi_var[:display_units] = arg[:units] if arg[:units]
-                wfi_var[:units] = '' # should be haystack compatible unit strings
-                new_wfi[:arguments] << wfi_var
-              end
+            wf[:variables]&.each do |arg|
+              wfi_var = {}
+              wfi_var[:display_name] = arg[:argument][:display_name] if arg[:argument][:display_name]
+              wfi_var[:display_name_short] = arg[:argument][:display_name_short] if arg[:argument][:display_name_short]
+              wfi_var[:name] = arg[:argument][:name] if arg[:argument][:name]
+              wfi_var[:default_value] = nil
+              wfi_var[:data_type] = arg[:argument][:value_type] if arg[:argument][:value_type]
+              wfi_var[:description] = ''
+              wfi_var[:display_units] = arg[:units] if arg[:units]
+              wfi_var[:units] = '' # should be haystack compatible unit strings
+              new_wfi[:arguments] << wfi_var
             end
 
             measure_metadata << new_wfi

data/lib/openstudio/analysis/algorithm_attributes.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio/analysis/formulation.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:

data/lib/openstudio/analysis/server_api.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -152,10 +152,8 @@ module OpenStudio
         response = @conn.get "/projects/#{project_id}.json"
         if response.status == 200
           analyses = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
-          if analyses[:analyses]
-            analyses[:analyses].each do |analysis|
-              analysis_ids << analysis[:_id]
-            end
+          analyses[:analyses]&.each do |analysis|
+            analysis_ids << analysis[:_id]
           end
         end
 
@@ -467,16 +465,12 @@ module OpenStudio
 
             formulation_json[:analysis][:problem][:workflow].each do |wf|
               wf[:uuid] = SecureRandom.uuid
-              if wf[:arguments]
-                wf[:arguments].each do |arg|
-                  arg[:uuid] = SecureRandom.uuid
-                end
+              wf[:arguments]&.each do |arg|
+                arg[:uuid] = SecureRandom.uuid
               end
-              if wf[:variables]
-                wf[:variables].each do |var|
-                  var[:uuid] = SecureRandom.uuid
-                  var[:argument][:uuid] = SecureRandom.uuid if var[:argument]
-                end
+              wf[:variables]&.each do |var|
+                var[:uuid] = SecureRandom.uuid
+                var[:argument][:uuid] = SecureRandom.uuid if var[:argument]
               end
             end
           else

data/lib/openstudio/analysis/support_files.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:

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

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -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/excel.rb

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -536,7 +536,7 @@ module OpenStudio
                 tmp_m_name = SecureRandom.uuid
               end
               # Only add models if the row is flagged
-              if row[0] && row[0].casecmp('model').zero?
+              if row[0]&.casecmp('model')&.zero?
                 model_path = row[3]
                 unless (Pathname.new model_path).absolute?
                   model_path = File.expand_path(File.join(@root_path, model_path))

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

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2018, Alliance for Sustainable Energy, LLC.
+# 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:
@@ -80,11 +80,9 @@ module OpenStudio
             step_hash[:measure_dir_name] = File.basename(step[:measure_definition_directory])
             step_hash[:arguments] = {}
             # Measures can have no arguments -- make sure to catch it
-            if @osa[:problem][:workflow][i][:arguments]
-              @osa[:problem][:workflow][i][:arguments].each do |arg|
-                next if arg[:value].nil?
-                step_hash[:arguments][arg[:name].to_sym] = arg[:value]
-              end
+            @osa[:problem][:workflow][i][:arguments]&.each do |arg|
+              next if arg[:value].nil?
+              step_hash[:arguments][arg[:name].to_sym] = arg[:value]
             end
             step_hash[:name] = step[:name] if step[:name]
             step_hash[:description] = step[:description] if step[:description]
@@ -98,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
@@ -160,12 +158,10 @@ module OpenStudio
         def process_datapoints(osd_filename_array)
           r = []
           osd_filename_array.each do |osd_file|
-            begin
-              r << process_datapoint(osd_file)
-            rescue StandardError => e
-              r << nil
-              puts "Warning: Failed to process datapoint #{osd_file} with error #{e.message} in #{e.backtrace.join('\n')}"
-            end
+            r << process_datapoint(osd_file)
+          rescue StandardError => e
+            r << nil
+            puts "Warning: Failed to process datapoint #{osd_file} with error #{e.message} in #{e.backtrace.join('\n')}"
           end
 
           r