urbanopt-scenario 0.12.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f57c37ca80b5720cc531f38164d66148b350ab038c826c06de5e4e74eb2f1d12
-  data.tar.gz: adb6a418f90e07392b33c51f65e8559ac39930f695c5e126dc0df0428e44cff6
+  metadata.gz: ac3b8620cce878dcc8a1053ba2a5341c65d7548ae5132fafe1239333cf819864
+  data.tar.gz: 392fd2ce49e3c470661b2e43c8e68ef6eb726587132ccb780aff11cd02877e61
 SHA512:
-  metadata.gz: 3c3b92bfbb9679bd2db1b55aa47db0418c669a1c293364b77732c15b817cebca5a9977b6b206841f00d43f279350260bf114905178a5bc1ccb6870f76e0dd3d8
-  data.tar.gz: 76c16600d3634084e0ff6011d2952ac8ed7abf4ef8573d2d97d01efd502b535fdc409c69b2d22f51b6ee3bc27349e5a580b5d37c6441b3d594b3ce453f74d89c
+  metadata.gz: 27c005602ae92c2dfa18c74820d6986f1b600adba88880b9b34835950b71d2668478720c2ccdba1f3e1758002b72be07eefbd4910c24ca60a3ec8b8cdd16e8f6
+  data.tar.gz: a7f7b94a01bb2523dc5cbfa054a13974f00319125688e5b93b80a79f6490c9416fcd8b2885deb91bba3a7b38c40c376c73f9f7dabce2340251ecfe2dcbc49afc

data/.github/workflows/nightly_ci_build.yml

@@ -3,30 +3,28 @@ name: Scenario-gem CI
 
 on:
   workflow_dispatch:
-  # push:
+  push:
   schedule:
     # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule
     # 5 am UTC (11pm MDT the day before) every weekday night in MDT
     - cron: '21 5 * * 2-6'
-  pull_request:
-    types: [review_requested]
 
 env:
-  # This env var should enforce develop branch of all dependencies
+  # This env var will enforce develop branch of all dependencies
   FAVOR_LOCAL_GEMS: true
   GEM_DEVELOPER_KEY: ${{ secrets.GEM_DEVELOPER_KEY }}
 
 jobs:
   weeknight-tests:
-    # ubuntu-latest works since https://github.com/rbenv/ruby-build/releases/tag/v20220710 (July 10, 2022)
-    # https://github.com/rbenv/ruby-build/discussions/1940
     runs-on: ubuntu-latest
     container:
-      image: docker://nrel/openstudio:3.7.0
+      image: docker://nrel/openstudio:3.9.0
     steps:
       - uses: actions/checkout@v4
       - name: Update gems
-        run: bundle update
+        run: |
+          bundle install
+          bundle update
       - name: Run Rspec
         run: bundle exec rspec
       - name: Coveralls

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # URBANopt Scenario Gem
 
+## Version 1.0.0
+
+Date Range: 05/06/24 - 01/23/25
+
+* Upgrade to OpenStudio 3.9 and Ruby 3.2.2 by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/276
+* Fixup openstudio-extension-gem sub bundle errors by @jmarrec in https://github.com/urbanopt/urbanopt-scenario-gem/pull/275
+
+### New Contributors
+
+* @jmarrec made their first contribution in https://github.com/urbanopt/urbanopt-scenario-gem/pull/275
+
+**Full Changelog**: https://github.com/urbanopt/urbanopt-scenario-gem/compare/v0.12.0...v1.0.0
+
 ## Version 0.12.0
 Date Range: 01/10/24 - 05/06/24
 * Use new version of reporting-gem by @vtnate in https://github.com/urbanopt/urbanopt-scenario-gem/pull/271
@@ -194,7 +207,7 @@ Date Range: 01/15/20 - 03/30/20:
 - Fixed [#83]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/83 ), add multiple pV
 - Fixed [#88]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/88 ), add units to CSV reports
 - Fixed [#89]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/89 ), created Save feature report method
-- Fixed [#91]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/91 ), add total_costruction_cost to reports
+- Fixed [#91]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/91 ), add total_construction_cost to reports
 - Fixed [#95]( https://github.com/urbanopt/urbanopt-scenario-gem/issues/95 ), list datapoint failures
 - Fixed [#98]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/98 ), add power, net power, net energy and apparent power to timeseries results
 - Fixed [#101]( https://github.com/urbanopt/urbanopt-scenario-gem/pull/101 ), fix for unit conversion when timeseries doe not exist

data/Gemfile

@@ -23,7 +23,7 @@ allow_local = ENV['FAVOR_LOCAL_GEMS']
 # if allow_local && File.exist?('../urbanopt-core-gem')
 #  gem 'urbanopt-core', path: '../urbanopt-core-gem'
 # elsif allow_local
-# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'os37'
+# gem 'urbanopt-core', github: 'URBANopt/urbanopt-core-gem', branch: 'os39'
 # end
 
 # if allow_local && File.exist?('../openstudio-common-measures-gem')

data/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
 contributors. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/doc_templates/copyright_erb.txt

@@ -1,6 +1,6 @@
 <%
   # *********************************************************************************
-  # URBANopt (tm), Copyright (c) 2019-2024, Alliance for Sustainable Energy, LLC, and other
+  # URBANopt (tm), Copyright (c) 2019-2025, Alliance for Sustainable Energy, LLC, and other
   # contributors. All rights reserved.
 
   # Redistribution and use in source and binary forms, with or without modification,

data/lib/urbanopt/scenario/logger.rb

@@ -9,7 +9,7 @@ module URBANopt
   module Scenario
     @@logger = Logger.new($stdout)
 
-    # Definining class variable "@@logger" to log errors, info and warning messages.
+    # Defining class variable "@@logger" to log errors, info and warning messages.
     def self.logger
       @@logger
     end

data/lib/urbanopt/scenario/scenario_csv.rb

@@ -48,21 +48,31 @@ module URBANopt
       # Require all simulation mappers in mapper_files_dir
       def load_mapper_files
         # loads default values from extension gem
-        options = OpenStudio::Extension::RunnerConfig.default_config
+        @options = OpenStudio::Extension::RunnerConfig.default_config(@root_dir)
         # check if runner.conf file exists
         if File.exist?(File.join(@root_dir, OpenStudio::Extension::RunnerConfig::FILENAME))
           runner_config = OpenStudio::Extension::RunnerConfig.new(@root_dir)
-          # use the default values overriden with runner.conf values
-          options = options.merge(runner_config.options)
+          # use the default values overridden with runner.conf values where not
+          # nil nor empty strings
+          @options = @options.merge(runner_config.options.reject{|k, v| v.nil? || (v.kind_of?(String) && v === '')})
         end
 
         # bundle path is assigned from the runner.conf if it exists or is assigned in the root_dir
-        bundle_path = !options.key?(:bundle_install_path) || options[:bundle_install_path] === '' ? File.join(@root_dir, '.bundle/install/') : options[:bundle_install_path]
+        # if bundle install path is not provided or is empty, it will be placed in root_dir/.bundle/install, otherwise use the provided path
+        if !@options.key?(:bundle_install_path) || @options[:bundle_install_path] === ''
+          @options[:bundle_install_path] = File.join(@root_dir, '.bundle/install/')
+        else
+          @options[:bundle_install_path]= Pathname.new(@options[:bundle_install_path]).cleanpath.to_s
+        end
+        bundle_path = @options[:bundle_install_path]
+
+        puts "Bundle final path is set to: #{bundle_path}"
 
         # checks if bundle path doesn't exist or is empty
         if !Dir.exist?(bundle_path) || Dir.empty?(bundle_path)
-          # install bundle
-          OpenStudio::Extension::Runner.new(@root_dir)
+          Bundler.with_unbundled_env do
+            OpenStudio::Extension::Runner.new(@root_dir, [], @options)
+          end
         end
 
         # find all lib dirs in the bundle path and add them to the path

data/lib/urbanopt/scenario/scenario_datapoint_base.rb

@@ -89,7 +89,7 @@ module URBANopt
       # rubocop: enable Style/EvalWithLocation #:nodoc:
 
       ##
-      # Return true if the datapoint is out of date, false otherwise.  Non-existant files are out of date.
+      # Return true if the datapoint is out of date, false otherwise.  Non-existent files are out of date.
       ##
       # [return:] _Boolean_ - True if the datapoint is out of date, false otherwise.
       def out_of_date?

data/lib/urbanopt/scenario/scenario_runner_osw.rb

@@ -46,11 +46,11 @@ module URBANopt
 
       ##
       # Create and run all SimulationFileOSW for Scenario.
-      # A staged runner is implented to run buildings, then transformers then district systems.
+      # A staged runner is implemented to run buildings, then transformers then district systems.
       # - instantiate openstudio runner to run .osw files.
       # - create simulation files for this scenario.
       # - get feature_type value from in.osw files
-      # - cretae 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
+      # - create 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
       # - add each osw file to its corresponding group id +simulation_dir+ is out_of_date
       # - Run osw file groups in order and store simulation failure in a array.
       ##
@@ -78,7 +78,7 @@ module URBANopt
         #   end
         # end
 
-        # cretae 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
+        # create 3 groups to store .osw files (+building_osws+ , +transformer_osws+ , +district_system_osws+)
         building_osws = []
         transformer_osws = []
         district_system_osws = []

data/lib/urbanopt/scenario/simulation_dir_base.rb

@@ -30,7 +30,7 @@ module URBANopt
 
       ##
       # Return true if the simulation is out of date (input files newer than results), false otherwise.
-      # Non-existant simulation input files are out of date.
+      # Non-existent simulation input files are out of date.
       ##
       def out_of_date?
         raise 'out_of_date? is not implemented for SimulationFileBase, override in your class'

data/lib/urbanopt/scenario/simulation_dir_osw.rb

@@ -110,7 +110,7 @@ module URBANopt
 
       ##
       # Return true if the simulation is out of date (input files newer than results), false otherwise.
-      # Non-existant simulation input files are out of date.
+      # Non-existent simulation input files are out of date.
       ##
       def out_of_date?
         if !File.exist?(run_dir)

data/lib/urbanopt/scenario/version.rb

@@ -5,6 +5,6 @@
 
 module URBANopt
   module Scenario
-    VERSION = '0.12.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

data/urbanopt-scenario-gem.gemspec

@@ -21,14 +21,14 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '~> 2.7.0'
+  # We support exactly Ruby v3.2.2 because os-extension requires bundler==2.4.10 and that requires Ruby 3.2.2: https://stdgems.org/bundler/
+  # It would be nice to be able to use newer patches of Ruby 3.2, which would require os-extension to relax its dependency on bundler.
+  spec.required_ruby_version = '3.2.2'
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
-  spec.add_development_dependency 'rake', '~> 13.1'
-  spec.add_development_dependency 'rspec', '~> 3.12'
-  spec.add_development_dependency 'simplecov', '~> 0.18.2'
-  spec.add_development_dependency 'simplecov-lcov', '~> 0.8.0'
-  spec.add_runtime_dependency 'sqlite3', '~> 1.6.0'
-  spec.add_runtime_dependency 'urbanopt-core', '~> 0.11.0'
-  spec.add_runtime_dependency 'urbanopt-reporting', '~> 0.10.0'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'simplecov', '0.22.0'
+  spec.add_development_dependency 'simplecov-lcov', '0.8.0'
+  spec.add_runtime_dependency 'sqlite3', '~> 2.0.0'
+  spec.add_runtime_dependency 'urbanopt-core', '~> 1.0.0'
+  spec.add_runtime_dependency 'urbanopt-reporting', '~> 1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urbanopt-scenario
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rawad El Kontar
@@ -9,76 +9,48 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.8.0
 - !ruby/object:Gem::Dependency
@@ -87,42 +59,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: urbanopt-reporting
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 1.0.0
 description: Library to export data point OSW files from URBANopt Scenario CSV
 email:
 - rawad.elkontar@nrel.gov
@@ -194,16 +166,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - '='
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Library to export data point OSW files from URBANopt Scenario CSV