openstudio-extension 0.1.2 → 0.1.3

data/lib/openstudio/extension/runner_config.rb

@@ -0,0 +1,114 @@
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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 'json'
+
+module OpenStudio
+  module Extension
+    class RunnerConfig
+      FILENAME = 'runner.conf'.freeze
+
+      ##
+      # Class to store configuration of the runner options.
+      ##
+      #  @param [String] dirname Directory where runner.conf file is stored, typically the root of the extension.
+      def initialize(dirname)
+        # read in the runner config from file, if it exists, otherwise inform the user to run
+        # the rake task
+        @dirname = dirname
+
+        check_file = File.join(@dirname, FILENAME)
+        if File.exist? check_file
+          @data = JSON.parse(File.read(check_file), symbolize_names: true)
+        else
+          raise "There is no runner.conf in directory #{@dirname}. Run `rake openstudio:runner:init`"
+        end
+      end
+
+      ##
+      # Add runner configuration that may be used in other extensions
+      #
+      #  @param [String] name, Name of the new config option
+      def add_config_option(name, value)
+        if @data.key? name.to_sym
+          raise "Runner config already has the named option of #{name}"
+        end
+
+        # TODO: do we need to verify that name is allowed to be a key?
+        @data[name.to_sym] = value
+      end
+
+      ##
+      # Return the default runner configuration
+      def self.default_config
+        return {
+          file_version: '0.1.0',
+          max_datapoints: 1E9.to_i,
+          num_parallel: 2,
+          run_simulations: true,
+          verbose: false
+        }
+      end
+
+      ##
+      # Save a templated runner configuration to the specified directory. Note that this will override any
+      # config that has been created
+      #
+      #  @param [String] dirname Directory where runner.conf file is stored, typically the root of the extension.
+      def self.init(dirname)
+        File.open(File.join(dirname, FILENAME), 'w') do |f|
+          f << JSON.pretty_generate(default_config)
+        end
+
+        return default_config
+      end
+
+      ##
+      # Save the updated config options, if they have changed. Changes will typically only occur if calling add_config
+      # option
+      def save
+        File.open(File.join(@dirname, FILENAME), 'w') do |f|
+          f << JSON.pretty_generate(@data)
+        end
+      end
+
+      ##
+      # Return the options as hash
+      def options
+        return @data
+      end
+    end
+  end
+end

data/lib/openstudio/extension/version.rb

@@ -1,40 +1,40 @@
-# *******************************************************************************
-# OpenStudio(R), Copyright (c) 2008-2019, 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.
-# *******************************************************************************
-
-module OpenStudio
-  module Extension
-    VERSION = '0.1.2'.freeze
-  end
-end
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) 2008-2019, 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.
+# *******************************************************************************
+
+module OpenStudio
+  module Extension
+    VERSION = '0.1.3'.freeze
+  end
+end

data/openstudio-extension.gemspec

@@ -1,33 +1,34 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'openstudio/extension/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'openstudio-extension'
-  spec.version       = OpenStudio::Extension::VERSION
-  spec.authors       = ['Katherine Fleming', 'Nicholas Long', 'Dan Macumber']
-  spec.email         = ['katherine.fleming@nrel.gov', 'nicholas.long@nrel.gov', 'daniel.macumber@nrel.gov']
-  spec.platform      = Gem::Platform::RUBY
-
-  spec.summary       = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
-  spec.description   = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
-  spec.homepage      = 'https://openstudio.net'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'bundler', '~> 1.9'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rubocop', '~> 0.54.0'
-  spec.add_dependency 'json_pure'
-  spec.add_dependency 'openstudio-workflow'
-  spec.add_dependency 'openstudio_measure_tester', '~> 0.1.7'
-  spec.add_dependency 'parallel', '~> 1.12.0'
-end
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openstudio/extension/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'openstudio-extension'
+  spec.version       = OpenStudio::Extension::VERSION
+  spec.authors       = ['Katherine Fleming', 'Nicholas Long', 'Dan Macumber']
+  spec.email         = ['katherine.fleming@nrel.gov', 'nicholas.long@nrel.gov', 'daniel.macumber@nrel.gov']
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.summary       = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
+  spec.description   = 'openstudio base gem for creating generic extensions with encapsulated data and measures.'
+  spec.homepage      = 'https://openstudio.net'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler', '~> 1.9'
+  spec.add_dependency 'json_pure', '2.2.0'
+  spec.add_dependency 'openstudio-workflow', '~> 1.3.4'
+  spec.add_dependency 'openstudio_measure_tester', '~> 0.1.7'
+  spec.add_dependency 'parallel', '~> 1.12.0'
+
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'rubocop', '~> 0.54.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio-extension
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Katherine Fleming
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-04 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -27,103 +27,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
+        version: 2.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: openstudio-workflow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
+        version: 1.3.4
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: openstudio_measure_tester
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
-  type: :development
+        version: 0.1.7
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: 0.1.7
 - !ruby/object:Gem::Dependency
-  name: json_pure
+  name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: openstudio-workflow
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '12.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: openstudio_measure_tester
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
-  type: :runtime
+        version: '3.7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: parallel
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
-  type: :runtime
+        version: 0.54.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 0.54.0
 description: openstudio base gem for creating generic extensions with encapsulated
   data and measures.
 email:
@@ -137,6 +137,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Jenkinsfile
 - README.md
@@ -165,7 +166,7 @@ files:
 - lib/measures/openstudio_extension_test_measure/measure.rb
 - lib/measures/openstudio_extension_test_measure/measure.xml
 - lib/measures/openstudio_extension_test_measure/resources/os_lib_helper_methods.rb
-- lib/measures/openstudio_extension_test_measure/tests/OpenStudioExtensionTestMeasure_Test.rb
+- lib/measures/openstudio_extension_test_measure/tests/openstudio_extension_test_measure_test.rb
 - lib/openstudio-extension.rb
 - lib/openstudio/extension.rb
 - lib/openstudio/extension/core/CreateResults.rb
@@ -209,6 +210,7 @@ files:
 - lib/openstudio/extension/core/os_lib_schedules.rb
 - lib/openstudio/extension/rake_task.rb
 - lib/openstudio/extension/runner.rb
+- lib/openstudio/extension/runner_config.rb
 - lib/openstudio/extension/version.rb
 - openstudio-extension.gemspec
 homepage: https://openstudio.net
@@ -230,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: openstudio base gem for creating generic extensions with encapsulated data