openstudio-extension 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f30db90eedc5082df2e101e84f8d6a3abb662338
-  data.tar.gz: aae7e0380a89c970d8bcfd2d94f5035470d30dc2
+  metadata.gz: 5d7389d56992364d7223efc9cf7e62c9e826253a
+  data.tar.gz: 5e2e0ab5c076f75d0fa6fa3b651f81cbc74fac1b
 SHA512:
-  metadata.gz: cb1e179a4ac5f17a6dae6cb40250aedfa9c54bb064919341e5dacc3a73c0b7d2ae3a5bcde6945cea264bdff9b9e5c7628670f492ec64415b3a0f7a7c74e36a26
-  data.tar.gz: e5d9bcefd983cd4d8de23dd737acfdfae66cdac1ad4d74f7af1719eafb530f36183182657ce658b4f6b0e8e23667a4e6e8d1f52fa79798e2e71c5643495ee596
+  metadata.gz: 69b29c4717bae6fd524d2d8980a8efd3cc231264baa22c8b0ce92261dff208644da25906d8a5810079b66af69ac317abfa0e8dc1b19d4cadce59f47ce6028d00
+  data.tar.gz: 547d1a2b58207f8dc17389bbfe27d88693c86ce4ff7466b031948eddcffe7be0191308f47a99793d4f23de5b14cd9377c5566767deb4d5dfed870287be9bc46c

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 # OpenStudio Extension Gem
 
-## Version 0.1.4 (unreleased)
+## Version 0.1.5
+
+* Fix bug to respect the runner.conf file when using Extension::Runner with no options
+
+## Version 0.1.4
 
 * Update license copyright dates
 * Update template for Gemfile to include FAVOR_LOCAL_GEMS env variable

data/README.md

@@ -150,7 +150,7 @@ Common Rake Tasks that are available to derivative extension gems include:
 | 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`: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 |
@@ -235,22 +235,11 @@ Or install it yourself as:
 
 # TODO
 
-- [X] Finalize documentation on naming conventions, etc
-- [X] Add test measure
-- [X] Rake task ```openstudio:update_measures```
-- [X] Rake task ```openstudio:test_with_openstudio```
 - [ ] 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?
-- [X] Get all rake tasks working on Travis
 - [ ] Capture useful output from Travis (measure dashboard results, log files, zip of build products, etc) and put it somewhere (s3?  naming convention?)
-- [X] ```Extension::openstudio_extension_version``` _DLM: should we rename? should people overwrite this in their class?_
-- [X] ```Extension::measures_dir``` _DLM: I think this can have a default implementation, right? If something does not need to be overridden should it be a module method rather than a class one?  KAF: this is in rake task for now
-- [X] ```Extension::list_measures``` _DLM: I think this can have a default implementation, right?_KAF: In Rake task for now
 - [ ] ```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?_
-- [X] ```Runner::initialize``` _DLM: should say that the path argument should be for a dir with a Gemfile right?_
-- [X] ```Runner::configure_osw``` _DLM: should take in an OSW, add paths to all measure and file dirs for loaded OpenStudio Extensions, write out configured OSW_
 - [ ] 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)
-- [X] Add a `rake init new_ext_gem` to Rakefile
 - [ ] Add tests to the extension/core

data/lib/openstudio/extension/runner.rb

@@ -56,17 +56,18 @@ module OpenStudio
       ##
       #  @param [String] dirname Directory to run commands in, defaults to Dir.pwd. If directory includes a Gemfile then create a local bundle.
       #  @param bundle_without [Hash] Hash describing the distribution of the variable.
-      #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods.
+      #  @param options [Hash] Hash describing options for running the simulation. These are the defaults for all runs unless overriden within the run_* methods. Note if options is used, then a local runner.conf file will not be loaded.
       #  @option options [String] :max_datapoints Max number of datapoints to run
       #  @option options [String] :num_parallel Number of simulations to run in parallel at a time
       #  @option options [String] :run_simulations Set to true to run the simulations
       #  @option options [String] :verbose Set to true to receive extra information while running simulations
       def initialize(dirname = Dir.pwd, bundle_without = [], options = {})
         # DLM: I am not sure if we want to use the main root directory to create these bundles
-        # had the idea of passing in a Gemfile name/alias and path to Gemfile, then doing the bundle in ~/OpenStudio/#{alias} or something like that?
+        # had the idea of passing in a Gemfile name/alias and path to Gemfile, then doing the bundle
+        # in ~/OpenStudio/#{alias} or something like that?
 
         # if the dirname contains a runner.conf file, then use the config file to specify the parameters
-        if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && !options
+        if File.exist?(File.join(dirname, OpenStudio::Extension::RunnerConfig::FILENAME)) && options.empty?
           puts 'Using runner options from runner.conf file'
           runner_config = OpenStudio::Extension::RunnerConfig.new(dirname)
           @options = runner_config.options

data/lib/openstudio/extension/runner_config.rb

@@ -104,6 +104,19 @@ module OpenStudio
         end
       end
 
+      ##
+      # Update a runner config value
+      #
+      # @param [String] key, The name of the key to update
+      # @param [Variant] new_value, The new value to set the `key` to.
+      def update_config(key, new_value)
+        if @data.key? key.to_sym
+          @data[key.to_sym] = new_value
+        else
+          raise "Could not find key '#{key}' to update in RunnerConfig."
+        end
+      end
+
       ##
       # Return the options as hash
       def options

data/lib/openstudio/extension/version.rb

@@ -35,6 +35,6 @@
 
 module OpenStudio
   module Extension
-    VERSION = '0.1.4'.freeze
+    VERSION = '0.1.5'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler