openstudio-analysis 1.0.0.rc9 → 1.0.0.rc10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0926ab12d7415a8a23c8c9b6c8345338e3f81dc8
-  data.tar.gz: 37fc5579b3f27dc9ef8f12321ea2fdd2e94f503a
+  metadata.gz: 730a32510cb39282ef25487714f4b5e5c850ef61
+  data.tar.gz: b1b239cc0d42b7679e6587a12e0a645165f376cd
 SHA512:
-  metadata.gz: 160ab740fecfcf67ad579edc96ba90e5d27a33bb731e2257ea1b0f6fe20d1afbbc8890e12e1ade07b034574713d7f18bd71d094a46272db0d7b427628d529492
-  data.tar.gz: a09acd3014f457d158cd553333c12bc994f4fe50f70ea9b04bd5b0419716f4107dba5841f47fa306786a57e0070bfd1d5f4fc270af9b2b9e2c49124dde21ca5f
+  metadata.gz: bceff944862e1563f30f59cf098d8b0d5c4f31464774b094d9684e014e10cad4a62862be075410adf6e774aba0d7d9b3ceb0a9fe44ce9307b15f04329aa2bf2d
+  data.tar.gz: 4ee216a32f6a788ffb57f72f1c61e2b575b50fe1e52485745046ab76d6133eb00b38d4aa74feaf55a441eb348814196fda00d2c42075b399542daaa58b5e4091

data/.rubocop.yml

@@ -17,63 +17,71 @@ Lint/ParenthesesAsGroupedExpression:
 Lint/RequireParentheses:
   Enabled: true
 
-# Offense count: 1
 Lint/UnreachableCode:
   Enabled: false
 
-# Offense count: 51
 Lint/UselessAssignment:
   Enabled: true
 
+Lint/UnusedBlockArgument:
+  Description: 'Checks for unused block arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Description: 'Checks for unused method arguments.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+  Enabled: false
+
+Lint/UselessAssignment:
+  Description: 'Checks for useless assignment to a local variable.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+  Enabled: false
+
+# ==================== Performance ========================
+
+Performance/Casecmp:
+  Enabled: false
+
 # ==================== Styles / Metrics====================
-# Offense count: 4
+
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 18
-# Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 500
 
-# Offense count: 27
 Metrics/CyclomaticComplexity:
-  Max: 48
+  Max: 50
 
-# Offense count: 974
 Metrics/LineLength:
-  Max: 1200
+  Max: 120
 
-# Offense count: 87
-# Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 350
 
-# Offense count: 1
-# Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 8
 
 # ==================== Disabled on Purpose ====================
-# Offense count: 3
-Style/AccessorMethodName:
-  Enabled: true
 
-# Need to allow indented case statements
-# Offense count: 9
+# Allow indented case statements
 # Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
 Style/CaseIndentation:
   Enabled: false
 
-# Offense count: 18
+# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+  Enabled: false
+
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/ClassAndModuleChildren:
   Enabled: false
 
-# Offense count: 2
 Style/ClassVars:
   Enabled: false
 
-# Offense count: 42
 Style/Documentation:
   Enabled: false
 
@@ -81,31 +89,36 @@ Style/Documentation:
 Style/EachWithObject:
   Enabled: false
 
-# Offense count: 2
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 7
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Enabled: true
 
-# Offense count: 17
 # Configuration parameters: MaxLineLength.
 Style/IfUnlessModifier:
   Enabled: false
 
-# Do NOT enable.  For some reason this is catchy any next which I feel are okay.
-# Offense count: 18
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: symmetrical, new_line, same_line
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+# Do NOT enable.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/Next:
   Enabled: false
 
-# Do NOT enable this because it appears $? is different than $CHILD_STATUS.
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
+Style/NumericLiterals:
+  Description: 'Add underscores to large numeric literals to improve readability.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
+  Enabled: false
+
+# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Enabled: false
 
 # More Changes per DLM -- pulled from https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
@@ -114,22 +127,13 @@ Style/RedundantReturn:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-return'
   Enabled: false
 
-Style/NumericLiterals:
-  Description: 'Add underscores to large numeric literals to improve readability.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscores-in-numerics'
+Style/RedundantParentheses:
   Enabled: false
 
-Lint/UnusedBlockArgument:
-  Description: 'Checks for unused block arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+# Do NOT enable this because it appears $? is different than $CHILD_STATUS.
+Style/SpecialGlobalVars:
   Enabled: false
 
-Lint/UnusedMethodArgument:
-  Description: 'Checks for unused method arguments.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
+Style/ZeroLengthPredicate:
   Enabled: false
 
-Lint/UselessAssignment:
-  Description: 'Checks for useless assignment to a local variable.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#underscore-unused-vars'
-  Enabled: false

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
+Version 1.0.0.rc10
+------------------
+* Fix boolean data type in datapoints translator
+* Allow __skip__ variable in datapoints translator
+
 Version 1.0.0.rc9
 -----------------
 * Fix bug in batch datapoints to look for outputs_json, not outputs when importing the definition of the outputs JSON file.

data/lib/openstudio/analysis/formulation.rb

@@ -190,7 +190,7 @@ module OpenStudio
 
           h
         else
-          fail "Version #{version} not defined for #{self.class} and #{__method__}"
+          raise "Version #{version} not defined for #{self.class} and #{__method__}"
         end
       end
 
@@ -218,7 +218,7 @@ module OpenStudio
             o.seed_model = h[:analysis][:seed][:path]
           end
         else
-          fail "Version #{version} not defined for #{self.class} and #{__method__}"
+          raise "Version #{version} not defined for #{self.class} and #{__method__}"
         end
 
         o
@@ -293,7 +293,7 @@ module OpenStudio
       def save_analysis_zip(filename)
         def add_directory_to_zip(zipfile, local_directory, relative_zip_directory)
           # puts "Add Directory #{local_directory}"
-          Dir[File.join("#{local_directory}", '**', '**')].each do |file|
+          Dir[File.join(local_directory.to_s, '**', '**')].each do |file|
             # puts "Adding File #{file}"
             zipfile.add(file.sub(local_directory, relative_zip_directory), file)
           end
@@ -331,7 +331,7 @@ module OpenStudio
 
           puts 'Adding Support Files: Libraries'
           @libraries.each do |lib|
-            fail "Libraries must specify their 'library_name' as metadata which becomes the directory upon zip" unless lib[:metadata][:library_name]
+            raise "Libraries must specify their 'library_name' as metadata which becomes the directory upon zip" unless lib[:metadata][:library_name]
 
             if File.directory? lib[:file]
               Dir[File.join(lib[:file], '**', '**')].each do |file|

data/lib/openstudio/analysis/server_api.rb

@@ -6,16 +6,16 @@ module OpenStudio
       attr_reader :hostname
 
       # Define set of anlaysis methods require batch_run to be queued after them
-      BATCH_RUN_METHODS = %w(lhs preflight single_run repeat_run doe diag baseline_perturbation batch_datapoints)
+      BATCH_RUN_METHODS = %w(lhs preflight single_run repeat_run doe diag baseline_perturbation batch_datapoints).freeze
 
       def initialize(options = {})
-        defaults = {hostname: 'http://localhost:8080'}
+        defaults = { hostname: 'http://localhost:8080' }
         options = defaults.merge(options)
         @logger = ::Logger.new('faraday.log')
 
         @hostname = options[:hostname]
 
-        fail 'no host defined for server api class' if @hostname.nil?
+        raise 'no host defined for server api class' if @hostname.nil?
 
         # TODO: add support for the proxy
 
@@ -44,7 +44,7 @@ module OpenStudio
         if response.status == 200
           projects_json = JSON.parse(response.body, symbolize_names: true, max_nesting: false)
         else
-          fail 'did not receive a 200 in get_projects'
+          raise 'did not receive a 200 in get_projects'
         end
 
         projects_json
@@ -82,12 +82,12 @@ module OpenStudio
       end
 
       def new_project(options = {})
-        defaults = {project_name: "Project #{::Time.now.strftime('%Y-%m-%d %H:%M:%S')}"}
+        defaults = { project_name: "Project #{::Time.now.strftime('%Y-%m-%d %H:%M:%S')}" }
         options = defaults.merge(options)
         project_id = nil
 
         # TODO: make this a display name and a machine name
-        project_hash = {project: {name: "#{options[:project_name]}"}}
+        project_hash = { project: { name: (options[:project_name]).to_s } }
 
         response = @conn.post do |req|
           req.url '/projects.json'
@@ -406,17 +406,17 @@ module OpenStudio
 
       def new_analysis(project_id, options)
         defaults = {
-            analysis_name: nil,
-            reset_uuids: false,
-            push_to_dencity: false
+          analysis_name: nil,
+          reset_uuids: false,
+          push_to_dencity: false
         }
         options = defaults.merge(options)
 
-        fail 'No project id passed' if project_id.nil?
+        raise 'No project id passed' if project_id.nil?
 
         formulation_json = nil
         if options[:formulation_file]
-          fail "No formulation exists #{options[:formulation_file]}" unless File.exist?(options[:formulation_file])
+          raise "No formulation exists #{options[:formulation_file]}" unless File.exist?(options[:formulation_file])
           formulation_json = JSON.parse(File.read(options[:formulation_file]), symbolize_names: true)
         end
 
@@ -446,16 +446,16 @@ module OpenStudio
           end
 
           # set the analysis name
-          formulation_json[:analysis][:name] = "#{options[:analysis_name]}" unless options[:analysis_name].nil?
+          formulation_json[:analysis][:name] = (options[:analysis_name]).to_s unless options[:analysis_name].nil?
         else
           formulation_json = {
-              analysis: options
+            analysis: options
           }
           puts formulation_json
           analysis_id = SecureRandom.uuid
           formulation_json[:analysis][:uuid] = analysis_id
         end
-        fail "No analysis id defined in analysis.json #{options[:formulation_file]}" if analysis_id.nil?
+        raise "No analysis id defined in analysis.json #{options[:formulation_file]}" if analysis_id.nil?
 
         # save out this file to compare
         # File.open('formulation_merge.json', 'w') { |f| f << JSON.pretty_generate(formulation_json) }
@@ -475,14 +475,14 @@ module OpenStudio
           upload_to_dencity(analysis_id, formulation_json) if options[:push_to_dencity]
           puts "new analysis created with ID: #{analysis_id}"
         else
-          fail 'Could not create new analysis'
+          raise 'Could not create new analysis'
         end
 
         # check if we need to upload the analysis zip file
         if options[:upload_file]
-          fail "upload file does not exist #{options[:upload_file]}" unless File.exist?(options[:upload_file])
+          raise "upload file does not exist #{options[:upload_file]}" unless File.exist?(options[:upload_file])
 
-          payload = {file: Faraday::UploadIO.new(options[:upload_file], 'application/zip')}
+          payload = { file: Faraday::UploadIO.new(options[:upload_file], 'application/zip') }
           response = @conn_multipart.post "analyses/#{analysis_id}/upload.json", payload do |req|
             req.options[:timeout] = 1800 # seconds
           end
@@ -490,7 +490,7 @@ module OpenStudio
           if response.status == 201
             puts 'Successfully uploaded ZIP file'
           else
-            fail response.inspect
+            raise response.inspect
           end
         end
 
@@ -501,13 +501,13 @@ module OpenStudio
         require 'dencity'
         puts "Attempting to connect to DEnCity server using settings at '~/.dencity/config.yml'"
         conn = Dencity.connect
-        fail "Could not connect to DEnCity server at #{hostname}." unless conn.connected?
+        raise "Could not connect to DEnCity server at #{hostname}." unless conn.connected?
         begin
           r = conn.login
         rescue Faraday::ParsingError => user_id_failure
-          fail "Error in user_id field: #{user_id_failure.message}"
+          raise "Error in user_id field: #{user_id_failure.message}"
         rescue MultiJson::ParseError => authentication_failure
-          fail "Error in attempted authentication: #{authentication_failure.message}"
+          raise "Error in attempted authentication: #{authentication_failure.message}"
         end
         user_uuid = r.id
 
@@ -528,7 +528,7 @@ module OpenStudio
             break
           end
         end
-        fail "Analysis with user_defined_id of #{analysis_uuid} found on DEnCity." if found_analysis_uuid
+        raise "Analysis with user_defined_id of #{analysis_uuid} found on DEnCity." if found_analysis_uuid
         dencity_hash = OpenStudio::Analysis.to_dencity_analysis(analysis, analysis_uuid)
 
         # Write the analysis DEnCity hash to dencity_analysis.json
@@ -544,14 +544,14 @@ module OpenStudio
           runner.registerError("Upload failure: #{e.message} in #{e.backtrace.join('/n')}")
         else
           if NoMethodError == upload_response.class
-            fail "ERROR: Server responded with a NoMethodError: #{upload_response}"
+            raise "ERROR: Server responded with a NoMethodError: #{upload_response}"
           end
           if upload_response.status.to_s[0] == '2'
             puts 'Successfully uploaded processed analysis json file to the DEnCity server.'
           else
             puts 'ERROR: Server returned a non-20x status. Response below.'
             puts upload_response
-            fail
+            raise
           end
         end
       end
@@ -562,12 +562,12 @@ module OpenStudio
       # @option options [String] :datapoint_file Path to datapoint JSON to upload
       # @option options [Boolean] :reset_uuids Flag on whether or not to reset the UUID in the datapoint JSON to a new random value.
       def upload_datapoint(analysis_id, options)
-        defaults = {reset_uuids: false}
+        defaults = { reset_uuids: false }
         options = defaults.merge(options)
 
-        fail 'No analysis id passed' if analysis_id.nil?
-        fail 'No datapoints file passed to new_analysis' unless options[:datapoint_file]
-        fail "No datapoints_file exists #{options[:datapoint_file]}" unless File.exist?(options[:datapoint_file])
+        raise 'No analysis id passed' if analysis_id.nil?
+        raise 'No datapoints file passed to new_analysis' unless options[:datapoint_file]
+        raise "No datapoints_file exists #{options[:datapoint_file]}" unless File.exist?(options[:datapoint_file])
 
         dp_hash = JSON.parse(File.open(options[:datapoint_file]).read, symbolize_names: true)
 
@@ -591,7 +591,7 @@ module OpenStudio
           puts "new datapoints created for analysis #{analysis_id}"
           return JSON.parse(response.body, symbolize_names: true)
         else
-          fail "could not create new datapoints #{response.body}"
+          raise "could not create new datapoints #{response.body}"
         end
       end
 
@@ -601,9 +601,9 @@ module OpenStudio
         defaults = {}
         options = defaults.merge(options)
 
-        fail 'No analysis id passed' if analysis_id.nil?
-        fail 'No datapoints file passed to new_analysis' unless options[:datapoints_file]
-        fail "No datapoints_file exists #{options[:datapoints_file]}" unless File.exist?(options[:datapoints_file])
+        raise 'No analysis id passed' if analysis_id.nil?
+        raise 'No datapoints file passed to new_analysis' unless options[:datapoints_file]
+        raise "No datapoints_file exists #{options[:datapoints_file]}" unless File.exist?(options[:datapoints_file])
 
         dp_hash = JSON.parse(File.open(options[:datapoints_file]).read, symbolize_names: true)
 
@@ -617,12 +617,12 @@ module OpenStudio
         if response.status == 201
           puts "new datapoints created for analysis #{analysis_id}"
         else
-          fail "could not create new datapoints #{response.body}"
+          raise "could not create new datapoints #{response.body}"
         end
       end
 
       def start_analysis(analysis_id, options)
-        defaults = {analysis_action: 'start', without_delay: false}
+        defaults = { analysis_action: 'start', without_delay: false }
         options = defaults.merge(options)
 
         puts "Run analysis is configured with #{options.to_json}"
@@ -636,14 +636,14 @@ module OpenStudio
         if response.status == 200
           puts "Received request to run analysis #{analysis_id}"
         else
-          fail 'Could not start the analysis'
+          raise 'Could not start the analysis'
         end
       end
 
       # Kill the analysis
       # @param analysis [String] Analysis ID to stop
       def kill_analysis(analysis_id)
-        analysis_action = {analysis_action: 'stop'}
+        analysis_action = { analysis_action: 'stop' }
 
         response = @conn.post do |req|
           req.url "analyses/#{analysis_id}/action.json"
@@ -750,9 +750,9 @@ module OpenStudio
       def run(formulation_filename, analysis_zip_filename, analysis_type,
               options = {})
         defaults = {
-            run_data_point_filename: 'run_openstudio_workflow_monthly.rb',
-            push_to_dencity: false,
-            batch_run_method: 'batch_run'
+          run_data_point_filename: 'run_openstudio_workflow_monthly.rb',
+          push_to_dencity: false,
+          batch_run_method: 'batch_run'
         }
         options = defaults.merge(options)
 
@@ -760,20 +760,20 @@ module OpenStudio
         project_id = new_project(project_options)
 
         analysis_options = {
-            formulation_file: formulation_filename,
-            upload_file: analysis_zip_filename,
-            reset_uuids: true,
-            push_to_dencity: options[:push_to_dencity]
+          formulation_file: formulation_filename,
+          upload_file: analysis_zip_filename,
+          reset_uuids: true,
+          push_to_dencity: options[:push_to_dencity]
         }
 
         analysis_id = new_analysis(project_id, analysis_options)
 
         run_options = {
-            analysis_action: 'start',
-            without_delay: false,
-            analysis_type: analysis_type,
-            simulate_data_point_filename: 'simulate_data_point.rb', # TODO: remove these from server?
-            run_data_point_filename: options[:run_data_point_filename]
+          analysis_action: 'start',
+          without_delay: false,
+          analysis_type: analysis_type,
+          simulate_data_point_filename: 'simulate_data_point.rb', # TODO: remove these from server?
+          run_data_point_filename: options[:run_data_point_filename]
         }
         start_analysis(analysis_id, run_options)
 
@@ -781,11 +781,11 @@ module OpenStudio
         # because there is no explicit way to tell the system to do it
         if BATCH_RUN_METHODS.include? analysis_type
           run_options = {
-              analysis_action: 'start',
-              without_delay: false,
-              analysis_type: options[:batch_run_method],
-              simulate_data_point_filename: 'simulate_data_point.rb',
-              run_data_point_filename: options[:run_data_point_filename]
+            analysis_action: 'start',
+            without_delay: false,
+            analysis_type: options[:batch_run_method],
+            simulate_data_point_filename: 'simulate_data_point.rb',
+            run_data_point_filename: options[:run_data_point_filename]
           }
           start_analysis(analysis_id, run_options)
         end
@@ -799,18 +799,18 @@ module OpenStudio
         project_id = new_project(project_options)
 
         analysis_options = {
-            formulation_file: formulation_filename,
-            upload_file: analysis_zip_filename,
-            reset_uuids: true
+          formulation_file: formulation_filename,
+          upload_file: analysis_zip_filename,
+          reset_uuids: true
         }
         analysis_id = new_analysis(project_id, analysis_options)
 
         run_options = {
-            analysis_action: 'start',
-            without_delay: false,
-            analysis_type: analysis_type,
-            simulate_data_point_filename: 'simulate_data_point.rb',
-            run_data_point_filename: run_data_point_filename
+          analysis_action: 'start',
+          without_delay: false,
+          analysis_type: analysis_type,
+          simulate_data_point_filename: 'simulate_data_point.rb',
+          run_data_point_filename: run_data_point_filename
         }
         start_analysis(analysis_id, run_options)
 
@@ -822,18 +822,18 @@ module OpenStudio
         project_id = new_project(project_options)
 
         analysis_options = {
-            formulation_file: nil,
-            upload_file: nil,
-            reset_uuids: true,
+          formulation_file: nil,
+          upload_file: nil,
+          reset_uuids: true
         }
         analysis_id = new_analysis(project_id, analysis_options)
 
         run_options = {
-            analysis_action: 'start',
-            without_delay: false,
-            analysis_type: 'batch_run_analyses',
-            simulate_data_point_filename: 'simulate_data_point.rb',
-            run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
+          analysis_action: 'start',
+          without_delay: false,
+          analysis_type: 'batch_run_analyses',
+          simulate_data_point_filename: 'simulate_data_point.rb',
+          run_data_point_filename: 'run_openstudio_workflow_monthly.rb'
         }
         start_analysis(analysis_id, run_options)
 

data/lib/openstudio/analysis/support_files.rb

@@ -18,7 +18,7 @@ module OpenStudio
       # @return [Boolean] Returns false if the file does not exist
       def add(path_or_filename, metadata = {})
         if !File.exist?(path_or_filename) && !Dir.exist?(path_or_filename)
-          fail "Path or file does not exist and cannot be added: #{path_or_filename}"
+          raise "Path or file does not exist and cannot be added: #{path_or_filename}"
         end
 
         # only add if it isn't allready in the list