openstudio-extension 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cc5634df3c8c1a9c8a711707cd6b6a9d07b4a0f0f01aed1726576e244a0c5b2
-  data.tar.gz: 8e433cbc4b7cc8b6737544771bb5273d8a7a267b8153ea936a2af3dccb61b486
+  metadata.gz: 26988c39ed89e37921a6a42330ad8e499571fca8c7fe3c11b626ad7e01fef336
+  data.tar.gz: 94e01bc35378f6a13f6415084c013b5a8667892f1b0924095f5a12e1cbed2d8f
 SHA512:
-  metadata.gz: 455200a3b2e03ae2b5ef3d15f67690297c04f7886ce31a5f358f02a907a394a5cc0f0ba57b7b44efa96633443f4d23316e391716548cbcaf70af11881389fe44
-  data.tar.gz: 9f478fb250845c5e99b9d1d12ba4261b5b7c82fb2f69bffcd594c5ec1f8a5463d76c4de51202cac29b2f875d07bfffd35cc6fa53ae4e8d4baa3732a0d0c57e22
+  metadata.gz: 2d309ada8c6984ef040af1b2b0ace8562bfdddcf12d0f790564d977bdbbd19c2a3191e439de9aba640c053145061b5c99daad6ed028404bd05d31c07bbad14b5
+  data.tar.gz: 77458bd7a6789412d6881a376418b08c694522b1b4e767df0e5a539d0e5ad95aa134b27a101bf29edd0a17b841f46eaf2e4d44c1ec7d109a90c0a33cbb2d50bd

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,40 @@
 # OpenStudio Extension Gem
 
+## Version 0.3.0
+
+* remove the os_lib_reporting.rb helpers. This file is only used for OS reporting measure and should not be shared with other users.
+* Upgrade dependency to openstudio-workflow gem to `~> 2.1.0`
+* This version works only with EnergyPlus 9.4 since it depends on OpenStudio workflow `~> 2.1.0`
+
+## Version 0.2.5
+
+* Support runner options for bundle_install_path and gemfile_path
+* Laboratory and Data Center Support
+
+- Fixed [#71]( https://github.com/NREL/openstudio-extension-gem/pull/71 ), another fix for bcl rake tasks
+- Fixed [#72]( https://github.com/NREL/openstudio-extension-gem/pull/72 ), Add laboratory and data centers to os_lib_model_generation
+- Fixed [#74]( https://github.com/NREL/openstudio-extension-gem/pull/74 ), adding bundle path and gemfile path options
+
+## 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)
@@ -40,4 +75,4 @@
 
 ## Version 0.1.1
 
-* Initial release
+* Initial release

data/Gemfile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 source 'http://rubygems.org'
 
 # Specify your gem's dependencies in openstudio-extension.gemspec

data/README.md

@@ -146,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 |
@@ -176,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
@@ -236,8 +243,6 @@ 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?_

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 ########################################################################################################################
 #  openstudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC. All rights reserved.
 #
@@ -36,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/bin/console

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'openstudio/extension'

data/lib/change_log.rb

@@ -1,148 +1,157 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'github_api'
+# *******************************************************************************
+# 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'
 
-# Instructions:
-#   Get a token from github's settings (https://github.com/settings/tokens)
-#
-# Example:
-#   ruby change_log.rb -t abcdefghijklmnopqrstuvwxyz -s 2017-09-06
-#
-
-options = {}
-OptionParser.new do |opts|
-  opts.banner = "Usage: change_log.rb [options]\n" \
-                'Prints New, Open, Closed Issues, and number of accepted PRs'
-  opts.separator ''
-
-  # defaults, go back 90 days
-  options[:start_date] = Date.today - 90
-  options[:end_date] = Date.today
-
-  opts.on('-s', '--start-date [DATE]', Date, 'Start of data (e.g. 2017-09-06)') do |v|
-    options[:start_date] = v
-  end
-  opts.on('-e', '--end-date [DATE]', Date, 'End of data (e.g. 2017-09-13)') do |v|
-    options[:end_date] = v
-  end
-  opts.on('-t', '--token [String]', String, 'Github API Token') do |v|
-    options[:token] = v
+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
-end.parse!
-
-# Convert dates to time objects
-options[:start_date] = Time.parse(options[:start_date].to_s)
-options[:end_date] = Time.parse(options[:end_date].to_s)
-puts options
 
-### Repository options
-repo_owner = 'NREL'
-repo = 'openstudio-extension-gem'
-
-github = Github.new
-if options[:token]
-  puts 'Using github token'
-  github = Github.new oauth_token: options[:token]
-end
-
-total_open_issues = []
-total_open_pull_requests = []
-new_issues = []
-closed_issues = []
-accepted_pull_requests = []
-
-def get_num(issue)
-  issue.html_url.split('/')[-1].to_i
-end
-
-def get_issue_num(issue)
-  "\##{get_num(issue)}"
-end
-
-def get_html_url(issue)
-  issue.html_url
-end
-
-def get_title(issue)
-  issue.title
-end
-
-def print_issue(issue)
-  is_feature = false
-  issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
-
-  if is_feature
-    "- Improved [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
-  else
-    "- Fixed [#{get_issue_num(issue)}]( #{get_html_url(issue)} ), #{get_title(issue)}"
+  # 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
-end
 
-# Process Open Issues
-results = -1
-page = 1
-while results != 0
-  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
-                            state: 'open', per_page: 100, page: page
-  results = resp.length
-  resp.env[:body].each do |issue, _index|
-    created = Time.parse(issue.created_at)
-    if !issue.key?(:pull_request)
-      total_open_issues << issue
-      if created >= options[:start_date] && created <= options[:end_date]
-        new_issues << issue
+  # 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
-    else
-      total_open_pull_requests << issue
     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
 
-  page += 1
-end
+  def print_issue(issue)
+    is_feature = false
+    issue.labels.each { |label| is_feature = true if label.name == 'Feature Request' }
 
-# Process Closed Issues
-results = -1
-page = 1
-while results != 0
-  resp = github.issues.list user: repo_owner, repo: repo, sort: 'created', direction: 'asc',
-                            state: 'closed', per_page: 100, page: page
-  results = resp.length
-  resp.env[:body].each do |issue, _index|
-    created = Time.parse(issue.created_at)
-    closed = Time.parse(issue.closed_at)
-    if !issue.key?(:pull_request)
-      if created >= options[:start_date] && created <= options[:end_date]
-        new_issues << issue
-      end
-      if closed >= options[:start_date] && closed <= options[:end_date]
-        closed_issues << issue
-      end
-    elsif closed >= options[:start_date] && closed <= options[:end_date]
-      accepted_pull_requests << issue
+    if is_feature
+      "- Improved [##{issue.number}]( #{issue.html_url} ), #{issue.title}"
+    else
+      "- Fixed [\##{issue.number}]( #{issue.html_url} ), #{issue.title}"
     end
   end
 
-  page += 1
-end
-
-closed_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
-new_issues.sort! { |x, y| get_num(x) <=> get_num(y) }
-accepted_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
-total_open_pull_requests.sort! { |x, y| get_num(x) <=> get_num(y) }
-
-puts "Total Open Issues: #{total_open_issues.length}"
-puts "Total Open Pull Requests: #{total_open_pull_requests.length}"
-puts "\nDate Range: #{options[:start_date].strftime('%m/%d/%y')} - #{options[:end_date].strftime('%m/%d/%y')}:"
-puts "\nNew Issues: #{new_issues.length} (" + new_issues.map { |issue| get_issue_num(issue) }.join(', ') + ')'
+  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 "\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 "\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| get_issue_num(issue) }.join(', ') + ')'
+    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.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 # *******************************************************************************
 # OpenStudio(R), Copyright (c) 2008-2020, Alliance for Sustainable Energy, LLC.
 # All rights reserved.

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>