openstudio-analysis 1.0.0.rc19 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9c20421f78a32d9fbfb9709c2640a57f5e012cc
-  data.tar.gz: a87f714e74143979dde36b3f4710551ba866f91c
+  metadata.gz: 06d3c96c3060a4b3c38b3a71ce868bdd77e81de8
+  data.tar.gz: ac9f3cb8d26c95d533be4f3bffe3fddc58d5f0fd
 SHA512:
-  metadata.gz: 794269c64d78465a8a741dd566e5be506168cdd3a6a5625891cb6ec1da9e9b1c14dce43be4f8fe9c7b2b092058fc02d3f3cd4b3609707f31cfba055e51fb8669
-  data.tar.gz: b123ae96f3b587a8ab726234596122b396eb353fb2f542042bbfe74fe98539da1685b3e0476d79c736b04338f9de3b8139706f8439f0c529a5807391ba48742d
+  metadata.gz: b7e98970c92beb469d3b4e3d6198cb79bc2ce63e20c7d13c1541a5afa78cb2ee1873fb43d5776703fa43be8f9ec6f763c2c82b2a5b67575b0ba6f6f2ccc412ed
+  data.tar.gz: 074efcb873df6e3233dd80129260d5b0007c871732e983bf780e2b35e6ef66e4cac8969f55cb742512ba6b440b0c3c59483d98299339ac55ed515d41ddbc4200

data/.gitignore

@@ -5,6 +5,7 @@
 *.swp
 *.gem
 ~$*
+.rubocop-https*
 tmp/*
 .yardoc
 doc/

data/.gitlab-ci.yml

@@ -0,0 +1,20 @@
+test:windows:
+  stage: test
+  tags:
+    - windows
+  script:
+    - bundle exec rake
+
+test:mac:
+  stage: test
+  tags:
+    - mac
+  script:
+    - bundle exec rake
+
+test:ubuntu:
+  stage: test
+  tags:
+    - ubuntu
+  script:
+    - bundle exec rake

data/.rubocop.yml

@@ -4,136 +4,5 @@ AllCops:
     - 'spec/files/measures_second_path/**/*'
     - 'spec/files/worker_init/*'
 
-# ==================== Linters ====================
-Lint/AmbiguousOperator:
-  Enabled: true
-
-Lint/BlockAlignment:
-  Enabled: true
-
-Lint/ParenthesesAsGroupedExpression:
-  Enabled: true
-
-Lint/RequireParentheses:
-  Enabled: true
-
-Lint/UnreachableCode:
-  Enabled: false
-
-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====================
-
-Metrics/BlockNesting:
-  Max: 4
-
-Metrics/ClassLength:
-  Max: 500
-
-Metrics/CyclomaticComplexity:
-  Max: 50
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/MethodLength:
-  Max: 350
-
-Metrics/ParameterLists:
-  Max: 8
-
-# ==================== Disabled on Purpose ====================
-
-# Allow indented case statements
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles, SingleLineConditionsOnly.
-# SupportedStyles: assign_to_condition, assign_inside_condition
-Style/ConditionalAssignment:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/ClassVars:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-Style/EachWithObject:
-  Enabled: false
-
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Enabled: false
-
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: true
-
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# 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
-
-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
-Style/RedundantReturn:
-  Description: 'Do not use return where it is not required.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-explicit-return'
-  Enabled: false
-
-Style/RedundantParentheses:
-  Enabled: false
-
-# Do NOT enable this because it appears $? is different than $CHILD_STATUS.
-Style/SpecialGlobalVars:
-  Enabled: false
-
-Style/ZeroLengthPredicate:
-  Enabled: false
-
+inherit_from:
+  - https://raw.githubusercontent.com/NREL/OpenStudio-resources/develop/styles/rubocop.yml

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
-  - 2.0.0-p451
-  - 2.0.0-p648
+  - 2.2.4
+  - 2.4.2

data/CHANGELOG.md

@@ -1,47 +1,24 @@
 OpenStudio Analysis Gem Change Log
 ==================================
 
-Version 1.0.0.rc11 (Unreleased)
-------------------
+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:
+
+* 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.
 * Fix get_datapoint_status for new version of API where data_points are under analysis
-
-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.
-
-Version 1.0.0.rc8
------------------
 * Allow "None" as an argument in batch datapoints. This will allow the measure to be added without setting any of the arguments. Useful for adding Reporting Measures to the workflow.
-
-Version 1.0.0.rc7
------------------
 * Use more recent version of BCL gem for underscoring strings
-
-Version 1.0.0.pre.rc6
----------------------
 * When creating OSWs from batch datapoints, set the default run_directory to ./run
-
-Version 1.0.0.pre.rc5
----------------------
 * fix get_datapoint method. show_full is no longer a valid endpoint in the new server code 
-
-Version 1.0.0.pre.rc4
----------------------
 * Change seed_model to seed_file in OSWs generated from the translator
 * Add more unit tests
-
-Version 1.0.0.pre.rc3
----------------------
 * Catch null arguments when translating from OSA/OSD to OSW
-
-Version 1.0.0.pre.rc2
---------------------------------
 * Note that pre.rc1 was yanked from Rubygems.
 * Remove allow_multiple_jobs and server_as_worker options. These are by defaulted to true now.
 * Remove uncertain strings from end of uncertainty distributions
@@ -52,9 +29,6 @@ Version 1.0.0.pre.rc2
 * Add zip extension to formulation zip upon save if none exists
 * In upload_datapoint, allows set the analysis_id in the file to the one passed.
 * Remove reading JSON from custom_csv method.
-
-Version 1.0.0-pat2
-------------------------------
 * Fixed bug in workflow translator which caused errors in server models
 * Updated gem versions to converge across the OpenStudio Analysis Framework platforms
 

data/Gemfile

@@ -2,14 +2,17 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'openstudio-aws', '0.4.2'
-gem 'dencity'
 gem 'colored', '~> 1.2'
+gem 'dencity'
+gem 'openstudio-aws', '0.4.2'
 
 group :test do
-  gem 'coveralls', require: false
-  gem 'rspec', '~> 3.4'
+  # Don't install coveralls on window because requires devkit for json
+  unless Gem.win_platform?
+    gem 'coveralls', require: false
+  end
   gem 'ci_reporter_rspec'
-  gem 'rubocop', '~> 0.31'
-  gem 'rubocop-checkstyle_formatter', '~> 0.2'
+  gem 'rspec', '~> 3.4'
+  gem 'rubocop'
+  gem 'rubocop-checkstyle_formatter'
 end

data/README.md

@@ -1,6 +1,8 @@
 # OpenStudio Analysis Gem
 
-[![Build Status](https://travis-ci.org/NREL/OpenStudio-analysis-gem.svg?branch=develop)](https://travis-ci.org/NREL/OpenStudio-analysis-gem) [![Dependency Status](https://www.versioneye.com/user/projects/540a2fe5ccc023dd23000002/badge.svg?style=flat)](https://www.versioneye.com/user/projects/540a2fe5ccc023dd23000002) [![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-analysis-gem/badge.svg?branch=develop)](https://coveralls.io/r/NREL/OpenStudio-analysis-gem?branch=develop)
+[![Build Status](https://travis-ci.org/NREL/OpenStudio-analysis-gem.svg?branch=develop)](https://travis-ci.org/NREL/OpenStudio-analysis-gem)
+[![Coverage Status](https://coveralls.io/repos/NREL/OpenStudio-analysis-gem/badge.svg?branch=develop)](https://coveralls.io/r/NREL/OpenStudio-analysis-gem?branch=develop)
+[![Gem Version](https://badge.fury.io/rb/openstudio-analysis.svg)](https://badge.fury.io/rb/openstudio-analysis)
 
 The OpenStudio Analysis Gem is used to communicate files to the OpenStudio Distributed Analysis.
 
@@ -66,15 +68,21 @@ There are two ways to create an OpenStudio Analysis description:
     
 * Server API
 
-    ```
-    
-    
-    ```
+## Testing
 
+This gem used RSpec for testing.  To test simply run `bundle exec rspec` at the command line.
 
-## Testing
+# Releasing
+
+Follow the steps below when releasing a new version:
 
-This gem used RSpec for testing.  To test simply run `rspec` at the command line.
+1. Update /lib/openstudio/analysis/version.rb to the next version. Make sure to follow semantic versioning.
+2. Add changes to the CHANGELOG.md.
+3. Run rubocop and make sure code meets coding standards.
+4. Push release candidate on a branch.
+5. Create a pull request to develop. Once the tests pass, merge into develop. 
+6. Create a pull request to master. Once tests pass, then merge into master.
+7. Checkout master and run `rake release`
 
 # Todos
 

data/Rakefile

@@ -1,3 +1,38 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2018, 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 'bundler'
 Bundler.setup
 
@@ -10,12 +45,12 @@ require 'ci/reporter/rake/rspec'
 require 'bundler/gem_tasks'
 
 RSpec::Core::RakeTask.new('spec:unit') do |spec|
-  spec.rspec_opts = %w(--format progress)
+  spec.rspec_opts = ['--format', 'progress']
   spec.pattern = FileList['spec/openstudio/**/*_spec.rb']
 end
 
 RSpec::Core::RakeTask.new('spec:integration') do |spec|
-  spec.rspec_opts = %w(--format progress)
+  spec.rspec_opts = ['--format', 'progress']
   spec.pattern = FileList['spec/integration/**/*_spec.rb']
 end
 
@@ -27,7 +62,7 @@ task default: 'spec:unit'
 require 'rubocop/rake_task'
 desc 'Run RuboCop on the lib directory'
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.options = ['--no-color', '--out=rubocop-results.xml']
+  task.options = ['--no-color', '--out=rubocop-results.xml', '--format', 'simple']
   task.formatters = ['RuboCop::Formatter::CheckstyleFormatter']
   task.requires = ['rubocop/formatter/checkstyle_formatter']
   # don't abort rake on failure

data/lib/openstudio-analysis.rb

@@ -1,3 +1,38 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2018, 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.
+# *******************************************************************************
+
 # Ruby libraries to include
 require 'json'
 require 'securerandom'

data/lib/openstudio/analysis.rb

@@ -1,3 +1,38 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2018, 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.
+# *******************************************************************************
+
 # OpenStudio::Analysis Module instantiates versions of formulations
 module OpenStudio
   module Analysis