openstudio-extension 0.1.6 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3faa07577e5a2980e7cacc747e5fb9f3ceb5cdb7
-  data.tar.gz: b4e220c8aca2e0227e65866ded3d1af1b7b19958
+SHA256:
+  metadata.gz: 6c5468ce39e3e858462a84b10da6eaf36ef110c8d6722256619eee95c4f0032c
+  data.tar.gz: d536d3216133d81b115ef61eab4ebc04c31d5842a23463674f038d1c65f92501
 SHA512:
-  metadata.gz: 23ec9c229a5618bc27932844884998bb41fac6f57c5753d2d79f2c2702652e37e7836d42e75e9f3c78a2e0321729284fec4a012e80995dee89359f3b7a7fa440
-  data.tar.gz: da121f8ec77b913ec6d61c528ffb78841ec645dcd0fb7b126df4668f87f3df74e56f7ef8bf9068d6b81b4e02ae4aa17922a9d33abba4fc94a52dc509cae28ff3
+  metadata.gz: f9305edc0f0a8fa54ba0ec4e0a4243f219a8d701018ec4dea4a2fb9662d1fe61f88923dce2abbe5c42e0f2f58a7dfc0eb3de3c632e7de3f3f160e728f032ea1e
+  data.tar.gz: 77b9a0cdba958bda77d308847c92478ba4ee2a8d20884af8498cc1982782b16a8f5fa38f5c9e59ed9a2badaa55527dbacd77e549d123533315500776c52e8c50

data/.gitignore

@@ -13,6 +13,8 @@
 /test/
 /lib/measures/test_results
 /lib/measures/.rubocop*
+/lib/measures/staged
+/lib/measures/staged/*
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -6,5 +6,5 @@ AllCops:
     - lib/openstudio/extension/core/**/*
 
 inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop.yml
+  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v3.yml
 

data/CHANGELOG.md

@@ -1,5 +1,39 @@
 # OpenStudio Extension Gem
 
+## Version 0.2.4
+
+* Fixed upload of measures to BCL using rake tasks.
+* Support economizer modeling when create_typical measure is split into two parts
+
+Closed Issues: 1
+- Fixed [#64]( https://github.com/NREL/openstudio-extension-gem/issues/64 ), README updates
+
+## Version 0.2.3
+
+* Use new version of rubocop style from S3
+* Remove frozen string literals in comments
+
+## Version 0.2.2
+
+* Exclude measure tests from being released with the gem (reduces the size of the installed gem significantly)
+* Add BCL commands to upload measures
+* Update GitHub changelog gem to use Octokit compared to github_api (which was last released 3 years ago)
+* Promote GitHub changelog creation to a rake task to be inherited by all downstream extension gems
+
+## Version 0.2.1
+
+* Changes from 0.1.5 (runner.conf bug)
+* Changes from 0.1.6 (update core library)
+* Update measure tester to 0.2.2 (with Rubocop 0.54)
+
+## Version 0.2.0
+
+* Upgrade Bundler to 2.1.x
+* Restrict to Ruby ~> 2.5.0
+* Remove json_pure gem
+* Update measure tester to 0.2.0 (removes need for github checkout)
+* Note that this version does not include the changes from Version 0.1.5
+
 ## Version 0.1.6
 
 * Update core library methods with what was in OpenStudio-measures
@@ -26,4 +60,4 @@
 
 ## Version 0.1.1
 
-* Initial release
+* Initial release

data/Gemfile

@@ -2,5 +2,3 @@ source 'http://rubygems.org'
 
 # Specify your gem's dependencies in openstudio-extension.gemspec
 gemspec
-
-gem 'simplecov', github: 'NREL/simplecov'

data/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') _
 

data/README.md

@@ -31,27 +31,27 @@ Each OpenStudio extension gem should define its own module name to ensure that t
 
 ## Installation
 
-To use this and other extension gems, you will need Ruby 2.2.4 and OpenStudio 2.7.1 or greater.  
+To use this and other extension gems, you will need Ruby 2.5.x and OpenStudio 3.0.0 or greater.  
 
 ### Windows Installation
-Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.2.4 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.2.4-x64.exe).
+Install Ruby using the [RubyInstaller](https://rubyinstaller.org/downloads/archives/) for [Ruby 2.5.5 (x64)](https://dl.bintray.com/oneclick/rubyinstaller/rubyinstaller-2.5.5-x64.exe).
 
 Install Devkit using the [mingw64](https://dl.bintray.com/oneclick/rubyinstaller/DevKit-mingw64-64-4.7.2-20130224-1432-sfx.exe) installer.
 
-Check the ruby installation returns the correct Ruby version (2.2.4):
+Check the ruby installation returns the correct Ruby version (2.5.x):
 ```
 ruby -v
 ```
 
 Install bundler from the command line
 ```
-gem install bundler -v 1.17
+gem install bundler -v 2.1
 ```
 
-Install OpenStudio.  Create a file ```C:\ruby-2.2.4-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
+Install OpenStudio.  Create a file ```C:\ruby-2.5.5-x64-mingw32\lib\ruby\site_ruby\openstudio.rb``` and point it to your OpenStudio installation by editing the contents.  E.g.:
 
 ```ruby
-require 'C:\openstudio-2.7.1\Ruby\openstudio.rb'
+require 'C:\openstudio-3.0.0\Ruby\openstudio.rb'
 ```
 
 Verify your OpenStudio and Ruby configuration:
@@ -65,19 +65,20 @@ rbenv can be installed via [Homebrew](https://brew.sh/):
 ```
 brew install rbenv
 rbenv init
-rbenv install 2.2.4
+rbenv install 2.5.5
 ```
 
 Also install bundler
 ```
-gem install bundler -v 1.17
+gem install bundler -v 2.1
 ```
 
 Install [OpenStudio](https://www.openstudio.net/downloads).
 
-Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within the OpenStudio Application you just downloaded (replace 2.7.2 with the version you are using):
+Add the RUBYLIB environment variable to your `bash_profile` (or similar) file. It should point to the Ruby folder within
+the OpenStudio Application you just downloaded (replace 3.0.0 with the version you are using):
 ```
-export RUBYLIB=/Applications/OpenStudio-2.7.2/Ruby
+export RUBYLIB=/Applications/OpenStudio-3.0.0/Ruby
 ```
 
 
@@ -145,14 +146,17 @@ Common Rake Tasks that are available to derivative extension gems include:
 
 | Rake Task | Description |
 | --------- | ----------- |
+| openstudio:bcl:test_login            | Test BCL login |
+| openstudio:bcl:search_measures       | Search BCL |
+| openstudio:bcl:stage[reset]          | Copy the measures/components to a staging location |
+| openstudio:bcl:push                  | Upload measures from the staging location |
+| openstudio:change_log[start_date,end_date,apikey] | Print the change log from GitHub. Specify dates in yyyy-mm-dd format |
 | openstudio:list_measures             | List all measures in the calling gem |
 | openstudio:measures:add_license      | Add License File to measures in the calling gem |
 | openstudio:measures:add_readme       | Add README.md.erb file if it and the README markdown file do not already exist for a measure |
 | openstudio:measures:copy_resources   | Copy the resources files to individual measures in the calling gem |
 | openstudio:measures:update_copyright | Update copyright on measure files in the calling gem |
 | openstudio`:runner:`init             | Create a runner.conf file running simulations |
-| openstudio:stage_bcl                 | Copy the measures to a location that can be uploaded to BCL |
-| openstudio:push_bcl                  | Upload measures from the specified location to the BCL |
 | openstudio:test_with_docker          | Use openstudio docker image to run tests |
 | openstudio:test_with_openstudio      | Use openstudio system ruby to run tests |
 | openstudio:update_measures           | Run the CLI task to check for measure updates and update the measure xml files |
@@ -175,8 +179,12 @@ The following table contains all current extension gems.
 | OpenStudio Common Measures Gem  | openstudio-common-measures | https://github.com/NREL/openstudio-common-measures-gem |
 | OpenStudio Model Articulation Gem   | openstudio-model-articulation | https://github.com/NREL/openstudio-model-articulation-gem |
 | OpenStudio AEDG Gem | openstudio-aedg | https://github.com/NREL/openstudio-aedg-gem | 
+| OpenStudio Calibration Gem | openstudio-calibration | https://github.com/NREL/openstudio-calibration-gem |
+| OpenStudio EE Gem | openstudio-ee | https://github.com/NREL/openstudio-ee-gem | 
 | OpenStudio District Systems Gem | openstudio-district-systems | https://github.com/NREL/openstudio-district-systems-gem | 
-| UrbanOpt GeoJSON Gem | urbanopt-geojson | https://github.com/urbanopt/urbanopt-geojson-gem | 
+| URBANopt Core Gem | urbanopt-core | https://github.com/urbanopt/urbanopt-core-gem |
+| URBANopt GeoJSON Gem | urbanopt-geojson | https://github.com/urbanopt/urbanopt-geojson-gem | 
+| URBANopt Scenario Gem | urbanopt-scenario | https://github.com/urbanopt/urbanopt-scenario-gem |
 | BuildingSync Gem | buildingsync | https://github.com/BuildingSync/BuildingSync-gem | 
 
 ### Initializing a new Extension Gem
@@ -235,11 +243,8 @@ Or install it yourself as:
 
 # TODO
 
-- [ ] Rake task ```stage_bcl``` _DLM: BCL gem should be a development dependency only until we can reduce its dependencies and remove native dependencies? should probably put it into a special group so we can bundle without it in openstudio-gems._
-- [ ] Rake task ```push_bcl``` _DLM: how do we want to test this?
 - [ ] Capture useful output from Travis (measure dashboard results, log files, zip of build products, etc) and put it somewhere (s3?  naming convention?)
 - [ ] ```Extension::files_dir``` _DLM: I think this can have a default implementation, right?_
 - [ ] ```Extension::minimum_openstudio_version``` _DLM: should we rename? should people overwrite this in their class?_
-- [ ] Run rubocop on all of the core files and remove exclusion from .rubocop.yml file.
 - [ ] Cleanup task after running tests (may need to be in the OpenStudio Measure Tester)
 - [ ] Add tests to the extension/core

data/Rakefile

@@ -34,7 +34,7 @@ RSpec::Core::RakeTask.new(:spec)
 require 'openstudio/extension/rake_task'
 require 'openstudio/extension'
 rake_task = OpenStudio::Extension::RakeTask.new
-rake_task.set_extension_class(OpenStudio::Extension::Extension)
+rake_task.set_extension_class(OpenStudio::Extension::Extension, 'nrel/openstudio-extension-gem')
 
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new

data/lib/change_log.rb

@@ -0,0 +1,157 @@
+# *******************************************************************************
+# 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.
+# *******************************************************************************
+
+require 'octokit'
+require 'date'
+require 'optparse'
+require 'optparse/date'
+
+class ChangeLog
+  def initialize(user_and_repo, start_date = Date.today - 90, end_date = Date.today, apikey = nil)
+    @user_and_repo = user_and_repo
+    @apikey = apikey
+    @start_date = start_date
+    @end_date = end_date
+
+    # Convert dates to time objects
+    @start_date = Time.parse(@start_date.to_s) if start_date.is_a? String
+    @end_date = Time.parse(@end_date.to_s) if end_date.is_a? String
+    # GitHub API uses Time and not the Date class, so ensure that we have Time
+    @start_date = Time.parse(@start_date.to_s)
+    @end_date = Time.parse(@end_date.to_s)
+
+    @total_open_issues = []
+    @total_open_pull_requests = []
+    @new_issues = []
+    @closed_issues = []
+    @accepted_pull_requests = []
+
+    begin
+      @github = Octokit::Client.new
+      if apikey
+        @github = Octokit::Client.new(access_token: apikey)
+      end
+      @github.auto_paginate = true
+    rescue StandardError => e
+      puts e.message
+      # write out the help message
+      ChangeLog.help
+      exit(1)
+    end
+  end
+
+  # Class method to show how to use the API through Rake.
+  def self.help
+    puts 'Usage: bundle exec rake openstudio:change_log[<start_date>,<end_date>,<apikey>]'
+    puts '       <start_date> = [Optional] Start of data (e.g., 2020-09-06), defaults to 90 days before today'
+    puts '       <end_date> = [Optional] End of data (e.g., 2020-10-06), default to today'
+    puts '       <apikey> = [Optional] GitHub API Key (used for private repos)'
+    puts
+    puts '  Ensure that the GitHub user/repo is set in your Rakefile, for example, '
+    puts "    rake_task.set_extension_class(OpenStudio::Extension::Extension, 'nrel/openstudio-extension-gem')"
+    puts
+    puts '  Example usages:'
+    puts '    bundle exec rake openstudio:change_log[2020-01-01]'
+    puts '    bundle exec rake openstudio:change_log[2020-01-01,2020-06-30]'
+    puts '    bundle exec rake openstudio:change_log[2020-01-01,2020-01-10,<private_api_key>]'
+    puts
+    puts '  Notes:'
+    puts '    For creating token, see https://github.com/settings/tokens.'
+    puts '    Note that if passing apikey, then you must pass start_date and end_date as well. There must be no spaces'
+    puts '    between the arguments (see examples above).'
+  end
+
+  # Process Open Issues
+  def process
+    @github.list_issues(@user_and_repo, state: 'all').each do |issue|
+      if issue.state == 'open'
+        if issue.pull_request
+          if issue.created_at >= @start_date && issue.created_at <= @end_date
+            @total_open_pull_requests << issue
+          end
+        else
+          @total_open_issues << issue
+          if issue.created_at >= @start_date && issue.created_at <= @end_date
+            @new_issues << issue
+          end
+        end
+      else
+        # the issue is closed
+        if issue.closed_at >= @start_date && issue.closed_at <= @end_date
+          if issue.pull_request
+            @accepted_pull_requests << issue
+          else
+            @closed_issues << issue
+          end
+        end
+      end
+    end
+
+    @closed_issues.sort! { |x, y| x.number <=> y.number }
+    @new_issues.sort! { |x, y| x.number <=> y.number }
+    @accepted_pull_requests.sort! { |x, y| x.number <=> y.number }
+    @total_open_pull_requests.sort! { |x, y| x.number <=> y.number }
+  rescue StandardError => e
+    puts e.message
+    ChangeLog.help
+    exit(1)
+  end
+
+  def print_issue(issue)
+    is_feature = false
+    issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
+
+    if is_feature
+      "- Improved [##{issue.number}]( #{issue.html_url} ), #{issue.title}"
+    else
+      "- Fixed [\##{issue.number}]( #{issue.html_url} ), #{issue.title}"
+    end
+  end
+
+  def print_issues
+    puts "Total Open Issues: #{@total_open_issues.length}"
+    puts "Total Open Pull Requests: #{@total_open_pull_requests.length}"
+    puts "\nDate Range: #{@start_date.strftime('%m/%d/%y')} - #{@end_date.strftime('%m/%d/%y')}:"
+    puts "\nNew Issues: #{@new_issues.length} (" + @new_issues.map(&:number).join(', ') + ')'
+
+    puts "\nClosed Issues: #{@closed_issues.length}"
+    @closed_issues.each { |issue| puts print_issue(issue) }
+
+    puts "\nAccepted Pull Requests: #{@accepted_pull_requests.length}"
+    @accepted_pull_requests.each { |issue| puts print_issue(issue) }
+
+    puts "\nAll Open Issues: #{@total_open_issues.length} (" + @total_open_issues.map { |issue| "\##{issue.number}" }.join(', ') + ')'
+  end
+end

data/lib/measures/openstudio_extension_test_measure/measure.xml

@@ -1,17 +1,18 @@
+<?xml version="1.0"?>
 <measure>
   <schema_version>3.0</schema_version>
   <name>openstudio_extension_test_measure</name>
   <uid>36b99a29-41e1-4d85-9272-85d43b966e5a</uid>
-  <version_id>e9fedf04-7619-4c93-a865-0e54adfe3507</version_id>
-  <version_modified>20190430T155209Z</version_modified>
+  <version_id>edf7f103-9f51-4944-a5af-1d8fa2b0c9b7</version_id>
+  <version_modified>20200427T230714Z</version_modified>
   <xml_checksum>49BEF039</xml_checksum>
   <class_name>OpenStudioExtensionTestMeasure</class_name>
   <display_name>OpenStudio Extension Test Measure</display_name>
-  <description>Rotate your building relative to its current orientation. This will not rotate site shading objects.</description>
-  <modeler_description>Get the North Axis field for the  OS:Building object and adjusted it based on the user specified value. If the starting value is 20 degrees and the user value is 5 degrees, then the resulting value is 25 degrees.</modeler_description>
-  <arguments/>
-  <outputs/>
-  <provenances/>
+  <description>A measure that tests OpenStudio Extension gem functionality</description>
+  <modeler_description>This is a test measure that tests OpenStudio Extension gem functionality.</modeler_description>
+  <arguments />
+  <outputs />
+  <provenances />
   <tags>
     <tag>Envelope.Form</tag>
   </tags>
@@ -38,12 +39,6 @@
     </attribute>
   </attributes>
   <files>
-    <file>
-      <filename>LICENSE.md</filename>
-      <filetype>md</filetype>
-      <usage_type>license</usage_type>
-      <checksum>9640B6CB</checksum>
-    </file>
     <file>
       <filename>README.md.erb</filename>
       <filetype>erb</filetype>
@@ -51,16 +46,16 @@
       <checksum>703C9964</checksum>
     </file>
     <file>
-      <filename>README.md</filename>
+      <filename>LICENSE.md</filename>
       <filetype>md</filetype>
-      <usage_type>readme</usage_type>
-      <checksum>7258830F</checksum>
+      <usage_type>license</usage_type>
+      <checksum>E0468DD6</checksum>
     </file>
     <file>
       <filename>OpenStudioExtensionTestMeasure_Test.rb</filename>
       <filetype>rb</filetype>
       <usage_type>test</usage_type>
-      <checksum>8452EA9A</checksum>
+      <checksum>66A00EA8</checksum>
     </file>
     <file>
       <version>
@@ -71,13 +66,19 @@
       <filename>measure.rb</filename>
       <filetype>rb</filetype>
       <usage_type>script</usage_type>
-      <checksum>E5793A49</checksum>
+      <checksum>51BB85EF</checksum>
     </file>
     <file>
       <filename>os_lib_helper_methods.rb</filename>
       <filetype>rb</filetype>
       <usage_type>resource</usage_type>
-      <checksum>22515A49</checksum>
+      <checksum>07B01D67</checksum>
+    </file>
+    <file>
+      <filename>README.md</filename>
+      <filetype>md</filetype>
+      <usage_type>readme</usage_type>
+      <checksum>7258830F</checksum>
     </file>
   </files>
 </measure>

data/lib/openstudio/extension.rb

@@ -101,11 +101,9 @@ module OpenStudio
     def self.all_measure_dirs
       result = []
       all_extensions.each do |obj|
-        begin
-          dir = obj.new.measures_dir
-          result << dir if dir
-        rescue StandardError
-        end
+        dir = obj.new.measures_dir
+        result << dir if dir
+      rescue StandardError
       end
       return result.uniq
     end
@@ -117,11 +115,9 @@ module OpenStudio
     def self.all_file_dirs
       result = []
       all_extensions.each do |obj|
-        begin
-          dir = obj.new.files_dir
-          result << dir if dir
-        rescue StandardError
-        end
+        dir = obj.new.files_dir
+        result << dir if dir
+      rescue StandardError
       end
       return result.uniq
     end
@@ -230,5 +226,26 @@ module OpenStudio
 
       return osw
     end
+
+    ##
+    # Module method used to check whether a measure is present in an OSW file
+    ##
+    #  @param [Hash] in_osw Initial OSW object as a Hash, keys should be symbolized
+    #  @param [String] measure_dir_name Directory name of measure to set argument on
+    #  @param [String] step_name Optional argument, if present used to further identify the measure
+    #
+    #  @return [Boolean] true or false
+    def self.measure_in_osw(osw, measure_dir_name, step_name = nil)
+      result = false
+      osw[:steps].each do |step|
+        if step[:measure_dir_name] == measure_dir_name
+          if step_name.nil? || step[:name] == step_name
+            result = true
+          end
+        end
+      end
+
+      return result
+    end
   end
 end