Merge pull request #24 from NREL/develop

Prep Release 0.2.0

.gitignore

@@ -16,11 +16,21 @@
 /lib/measures/*/test_results
 /lib/measures/*/tests/output
 /lib/measures/*/.rubocop.yml
-
+/output
+create_baseline.log
 .rubocop*s3*
+.rubocop.yml
+
 
 # rspec failure tracking
 .rspec_status
 
 # Ignore IDE files
 /.idea
+
+# Ignore mac specific files
+.DS_Store
+
+# Ignore measure tester gem local test results
+test_results/
+/lib/measures/create_baseline_building/output/

.rubocop.yml

@@ -1,10 +1,6 @@
 AllCops:
   Exclude:
-    - gems/**/*
-    - measures/**/*
-    - spec/files/**/measures/**/*
-
+    - 'spec/test_measures/**/*'
 
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
-
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml

CHANGELOG.md

@@ -1,5 +1,24 @@
 # OpenStudio Model Articulation Gems
-
-## Version 0.1.0 
+
+## Version 0.2.0
+
+* Support for OpenStudio 3.0
+    * Upgrade Bundler to 2.1.x
+    * Restrict to Ruby ~> 2.5.0   
+    * Removed simplecov forked dependency 
+* Upgraded openstudio-extension to 0.2.3
+    * Updated measure tester to 0.2.0 (removes need for github gem in downstream projects)
+* Upgraded openstudio-standards to 0.2.11
+* Exclude measure tests from being released with the gem (reduces the size of the installed gem significantly)
+* Removed dependency on openstudio-common-measures gem
+
+## Version 0.1.1
+
+* Update to OpenStudio Common Gem 0.1.2 (and extension gem 0.1.6)
+* Merge in OpenStudio articulation measures from OpenStudio-measures
+* Code cleanup on the measures
+* Update copyrights and licenses 
+
+## Version 0.1.0
 
 * Initial release of the articulation measures that are used for generating OpenStudio models.

Gemfile

@@ -11,19 +11,9 @@ gemspec
 # checkout the latest version (develop) from github.
 allow_local = ENV['FAVOR_LOCAL_GEMS']
 
-# Only uncomment if you need to test a different version of the extension gem that is not
-# included in the openstudio-common-measures
+# Only uncomment if you need to test a different version of the extension gem
 # if allow_local && File.exist?('../OpenStudio-extension-gem')
 #   gem 'openstudio-extension', path: '../OpenStudio-extension-gem'
 # elsif allow_local
 #   gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'
 # end
-
-if allow_local && File.exist?('../openstudio-common-measures-gem')
-  gem 'openstudio-common-measures', path: '../openstudio-common-measures-gem'
-elsif allow_local
-  gem 'openstudio-common-measures', github: 'NREL/openstudio-common-measures-gem', branch: 'develop'
-end
-
-# simplecov has an unnecessary dependency on native json gem, use fork that does not require this
-gem 'simplecov', github: 'NREL/simplecov'

Jenkinsfile

@@ -1,4 +1,4 @@
-//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/tijcolem/nrel_cbci_jenkins_libs 
+//Jenkins pipelines are stored in shared libaries. Please see: https://github.com/NREL/cbci_jenkins_libs
 
 @Library('cbci_shared_libs') _
 

LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC. All rights reserved.
+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:

README.md

@@ -18,9 +18,34 @@ Or install it yourself as:
 
     $ gem install 'openstudio-model-articulation'
 
-## Usage
+## Tests
 
-To be filled out later. 
+To run the tests similar to how Jenkins run:
+
+```
+bundle install
+
+bundle exec rake
+bundle exec rake openstudio:list_measures
+bundle exec rake openstudio:update_measures
+bundle exec rake openstudio:test_with_openstudio
+```
+
+To run the tests the same way Jenkins run:
+
+```
+docker run -it -v $(pwd):/var/simdata/openstudio -u root -e "LANG=en_US.UTF-8" nrel/openstudio:3.0.0-beta-ruby-slim bash
+
+# inside the container
+gem install bundler -v '~> 2.1'
+bundle update
+
+# Run all the tests
+bundle exec rake openstudio:test_with_openstudio
+
+# or a sinlge measure's test, e.g.,
+/usr/local/openstudio-3.0.0-beta/bin/openstudio-3.0.0-beta --verbose --bundle '/var/simdata/openstudio/Gemfile' --bundle_path '/var/simdata/openstudio/.bundle/install/' measure -r '/var/simdata/openstudio/lib/measures/radiance_measure/'
+```
 
 ## TODO
 
@@ -30,8 +55,9 @@ To be filled out later.
 
 # Releasing
 
-* Update change log
-* Update version in `/lib/openstudio/model-articulation/version.rb`
-* Merge down to master
-* Release via github
-* run `rake release` from master
+* Update CHANGELOG.md
+* Run `rake rubocop:auto_correct`
+* Update version in `/lib/openstudio/model_articulation/version.rb`
+* Create PR to master, after tests and reviews complete, then merge
+* Locally - from the master branch, run `rake release`
+* On GitHub, go to the releases page and update the latest release tag. Name it “Version x.y.z” and copy the CHANGELOG entry into the description box.

Rakefile

@@ -38,13 +38,13 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
-
 # Load in the rake tasks from the base extension gem
 require 'openstudio/extension/rake_task'
 require 'openstudio/model_articulation'
 rake_task = OpenStudio::Extension::RakeTask.new
 rake_task.set_extension_class(OpenStudio::ModelArticulation::Extension)
 
+require 'openstudio_measure_tester/rake_task'
+OpenStudioMeasureTester::RakeTask.new
+
 task default: :spec

doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC. All rights reserved.
+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:

doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *******************************************************************************
-  # OpenStudio(R), Copyright (c) 2008-2019, 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:

doc_templates/copyright_js.txt

@@ -1,4 +1,4 @@
 /* @preserve
- * OpenStudio(R), Copyright (c) 2008-2019, Alliance for Sustainable Energy, LLC. All rights reserved.
+ * OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
  * Use of this source code is governed by a BSD-style license that can be found at openstudio.net/license.
 */

doc_templates/copyright_ruby.txt

@@ -1,5 +1,5 @@
 # *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, 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: