oslg 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 398d4fc89206f836beea1d95578ef91629243c4f037ab9ac304359c16843e6ab
-  data.tar.gz: dcfb0a23e252ac13a396fda86117d7ae04aa087e9e4ec740c5efb93f2637b701
+  metadata.gz: 6309b9c37cd0135fc85fd44a2903d7594ccf1b0d952f64cec3df1b7c9d5f32e9
+  data.tar.gz: 1d4b53beb732dd9d0680f59e79e1d078f5d4d0b2289bfe3ac8f224bae3bb0ff4
 SHA512:
-  metadata.gz: 5d8b0d2c29ab175e2179d6caaf10b155720a64f2063a1249e8523808020f0f46d0de743c566634e9bcf6e2f6bd0d001eb7470cfc322e67165a0b6841251032f8
-  data.tar.gz: 95a1e72eb075129b5e7e01f94b5a6c2341c47314733c38ae0d51b7b8b501d2b453259c03c5698a8c77aa3566d6f9a648350b4d09ed4f9ffbf3e74d07069574fd
+  metadata.gz: 1edc4f411a77d1aaa0e2c6d48a9847ef3239af027d4699894519a8f1286b639c4a11dbd6bc96c2ef1cec43047d0601b5d01d38f178efde2e638786e890103b5a
+  data.tar.gz: 29899ed065067829900502b40ecd053c354a9255954bc18a1b735c30aaf1d6edab6a5c369a37af01b63e5330ef0b27cd8c4855dbecadfc352d1e5733b18f7ff0

data/.github/workflows/pull_request.yml

@@ -3,11 +3,11 @@ name: Pull Request CI
 on:
   pull_request:
     branches:
-      - main
+      - dev
 
 jobs:
   test_300x:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -23,7 +23,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_321x:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -39,7 +39,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_330x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -55,7 +55,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_340x:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2
@@ -70,3 +70,35 @@ jobs:
         docker exec -t test bundle update
         docker exec -t test bundle exec rake
         docker kill test
+  test_351x:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.5.1
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.5.1
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test
+  test_361x:
+    runs-on: ubuntu-22.04
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+    - name: Run Tests
+      run: |
+        echo $(pwd)
+        echo $(ls)
+        docker pull nrel/openstudio:3.6.1
+        docker run --name test --rm -d -t -v $(pwd):/work -w /work nrel/openstudio:3.6.1
+        docker exec -t test pwd
+        docker exec -t test ls
+        docker exec -t test bundle update
+        docker exec -t test bundle exec rake
+        docker kill test

data/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2022, Denis Bourgeois
+Copyright (c) 2022-2023, Denis Bourgeois
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -18,7 +18,7 @@ In most cases, critical (and many non-critical) OpenStudio anomalies will be cau
 
 ### Recommended use
 
-As a Ruby module, one can access __oslg__ by _extending_ a measure module or class:
+As a Ruby module, one can access __oslg__ by _extending_ a Measure module or class:
 
 ```
 module M
@@ -39,7 +39,7 @@ FATAL
 
 DEBUG messages aren't benign at all, but are certainly less informative for the typical Measure user.
 
-Initially, __oslg__ sets 2x internal attributes: `level` (INFO) and `status` (< DEBUG). The `level` attribute is a user-set threshold below which less severe logs (e.g. DEBUG) are ignored. For instance, if `level` were _reset_ to DEBUG (e.g. `M.reset(M::DEBUG)`), then all DEBUG messages would also be logged. The `status` attribute is reset with each new log entry if the latter's log level is more severe than its predecessor (e.g. `status == M::FATAL` if there is a single log entry registered as FATAL). To check the curent __oslg__ `status` (true or false):  
+Initially, __oslg__ sets 2x internal attributes: `level` (INFO) and `status` (< DEBUG). The `level` attribute is a user-set threshold below which less severe logs (e.g. DEBUG) are ignored. For instance, if `level` were _reset_ to DEBUG (e.g. `M.reset(M::DEBUG)`), then all DEBUG messages would also be logged. The `status` attribute is reset with each new log entry when the latter's log level is more severe than its predecessors (e.g. `status == M::FATAL` if there is a single log entry registered as FATAL). To check the curent __oslg__ `status` (true or false):  
 
 ```
 M.debug?
@@ -54,25 +54,25 @@ It's sometimes not a bad idea to rely on a _clean_ slate (e.g. within RSpecs). T
 M.clean!
 ```
 
-EnergyPlus will run, with e.g. out-of-range material or fluid properties, while logging ERROR messages in the process. It remains up to users to decide what to do with simulation results. We recommend something similar with __oslg__. For instance, we suggest logging as __FATAL__ any error that should halt measure processes and prevent OpenStudio from launching an EnergyPlus simulation. This could be missing or poorly-defined OpenStudio files.
+EnergyPlus will run with e.g. out-of-range material or fluid properties, while logging ERROR messages in the process. It remains up to users to decide what to do with simulation results. We recommend something similar with __oslg__. For instance, we suggest logging as __FATAL__ any error that should halt Measure processes and prevent OpenStudio from launching an EnergyPlus simulation. This could be missing or poorly-defined OpenStudio files.
 
 ```
 M.log(M::FATAL, "Missing input JSON file")
 ```
 
-Consider logging non-fatal __ERROR__ messages when encountering invalid OpenStudio file entries, i.e. well-defined, yet invalid vis-à-vis EnergyPlus limitations. The invalid object could be simply ignored, while the measure pursues its (otherwise valid) calculations ... with OpenStudio ultimately launching an EnergyPlus simulation. If a simulation indeed ran (ultimately a go/no-go decision made by the EnergyPlus simulation engine), it would be up to users to decide if simulation results were valid or useful, given the context - maybe based on __oslg__ logged messages. In short, non-fatal ERROR logs should ideally point to bad input (that users can fix).
+Consider logging non-fatal __ERROR__ messages when encountering invalid OpenStudio file entries, i.e. well-defined, yet invalid vis-à-vis EnergyPlus limitations. The invalid object could be simply ignored, while the Measure pursues its (otherwise valid) calculations ... with OpenStudio ultimately launching an EnergyPlus simulation. If a simulation indeed ran (ultimately a go/no-go decision made by the EnergyPlus simulation engine), it would be up to users to decide if simulation results were valid or useful, given the context - maybe based on __oslg__ logged messages. In short, non-fatal ERROR logs should ideally point to bad input (that users can fix).
 
 ```
 M.log(M::ERROR, "Measure won't process MASSLESS materials")
 ```
 
-A __WARNING__ could be triggered from inherit limitations of the underlying measure scope or methodology (something users may have little knowledge of beforehand). For instance, surfaces the size of dinner plates are often artifacts of poor 3D model design. It's usually not a good idea to have such small surfaces in an OpenStudio model, but neither OpenStudio nor EnergyPlus will necessarily warn users of such occurrences. It's up to users to decide on the suitable course of action.
+A __WARNING__ could be triggered from inherit limitations of the underlying Measure scope or methodology (something users may have little knowledge of beforehand). For instance, surfaces the size of dinner plates are often artifacts of poor 3D model design. It's usually not a good idea to have such small surfaces in an OpenStudio model, but neither OpenStudio nor EnergyPlus will necessarily warn users of such occurrences. It's up to users to decide on the suitable course of action.
 
 ```
 M.log(M::WARN, "Surface area < 100cm2")
 ```
 
-There's also the possibility of logging __INFO__-rmative messages for users, e.g. the final state of a measure variable before exiting.
+There's also the possibility of logging __INFO__-rmative messages for users, e.g. the final state of a Measure variable before exiting.
 
 ```
 M.log(M::INFO, "Envelope compliant to prescriptive code requirements")
@@ -131,7 +131,7 @@ def sum(areas, units)
 end
 ```
 
-... would generate the following if both `areas` and `units` arguments were nilled:
+... would generate the following if both `areas` and `units` arguments were for instance _nilled_:
 ```
 "Invalid 'areas' arg #1 (sum)"
 "Invalid 'units' arg #2 (sum)"
@@ -147,7 +147,7 @@ __mismatch__: for logging incompatible instances vs classes:
 return M.mismatch("areas", areas, Array, "sum") unless areas.is_a?(Array)
 ```
 
-If 'areas' were a _String_, __mismatch__ would generate the following DEBUG log message (before returning _nil_):
+If 'areas' were for example a _String_, __mismatch__ would generate the following DEBUG log message (before returning _nil_):
 
 ```
 "'areas' String? expecting Array (sum)"

data/lib/oslg/oslog.rb

@@ -1,6 +1,6 @@
 # BSD 3-Clause License
 #
-# Copyright (c) 2022, Denis Bourgeois
+# Copyright (c) 2022-2023, Denis Bourgeois
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -127,6 +127,7 @@ module OSlg
   # @return [String] "DEBUG", "INFO", "WARN", "ERROR" or "FATAL"
   def tag(level)
     return @@tag[level] if level >= DEBUG && level <= FATAL
+
     ""
   end
 
@@ -138,6 +139,7 @@ module OSlg
   # @return [String] preset OSlg message
   def msg(status)
     return @@msg[status] if status >= DEBUG && status <= FATAL
+
     ""
   end
 
@@ -163,6 +165,7 @@ module OSlg
       @@logs << {level: level, message: message}
       @@status = level if level > @@status
     end
+
     @@status
   end
 
@@ -194,10 +197,11 @@ module OSlg
     mth = mth[0...60] + " ..." if mth.length > 60
     return res if mth.empty?
 
-    msg  = "Invalid '#{id}' "
+    msg = "Invalid '#{id}' "
     msg += "arg ##{ord} " if ord > 0
     msg += "(#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -232,6 +236,7 @@ module OSlg
 
     msg = "'#{id}' #{obj.class}? expecting #{cl} (#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -264,8 +269,9 @@ module OSlg
     mth = mth[0...60] + " ..." if mth.length > 60
     return res if mth.empty?
 
-    msg  = "Missing '#{key}' key in '#{id}' Hash (#{mth})"
+    msg = "Missing '#{key}' key in '#{id}' Hash (#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -294,8 +300,9 @@ module OSlg
     mth = mth[0...60] + " ..." if mth.length > 60
     return res if mth.empty?
 
-    msg  = "Empty '#{id}' (#{mth})"
+    msg = "Empty '#{id}' (#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -325,8 +332,9 @@ module OSlg
     mth = mth[0...60] + " ..." if mth.length > 60
     return res if mth.empty?
 
-    msg  = "Zero '#{id}' (#{mth})"
+    msg = "Zero '#{id}' (#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -355,9 +363,10 @@ module OSlg
 
     mth = mth[0...60] + " ..." if mth.length > 60
     return res if mth.empty?
-    
-    msg  = "Negative '#{id}' (#{mth})"
+
+    msg = "Negative '#{id}' (#{mth})"
     log(lvl, msg) if lvl >= DEBUG && lvl <= FATAL
+
     res
   end
 
@@ -368,6 +377,7 @@ module OSlg
   def clean!
     @@status = 0
     @@logs   = []
+
     @@level
   end
 

data/lib/oslg/version.rb

@@ -1,6 +1,6 @@
 # BSD 3-Clause License
 #
-# Copyright (c) 2022, Denis Bourgeois
+# Copyright (c) 2022-2023, Denis Bourgeois
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -29,5 +29,5 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module OSlg
-  VERSION = "0.2.5".freeze
+  VERSION = "0.2.7".freeze
 end

data/lib/oslg.rb

@@ -1,6 +1,6 @@
 # BSD 3-Clause License
 #
-# Copyright (c) 2022, Denis Bourgeois
+# Copyright (c) 2022-2023, Denis Bourgeois
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without

data/oslg.gemspec

@@ -24,14 +24,14 @@ Gem::Specification.new do |s|
   s.bindir                = "exe"
   s.require_paths         = ["lib"]
   s.executables           = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  s.required_ruby_version = [">= 2.5.0", "< 2.7.3"]
+  s.required_ruby_version = [">= 2.5.0", "< 3"]
   s.metadata              = {}
 
   s.add_development_dependency "bundler", "~> 2.1"
   s.add_development_dependency "rake",    "~> 13.0"
   s.add_development_dependency "rspec",   "~> 3.11"
 
-  s.metadata["homepage_uri"]    = s.homepage
+  s.metadata["homepage_uri"   ] = s.homepage
   s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}"
   s.metadata["bug_tracker_uri"] = "#{s.homepage}/issues"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oslg
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - Denis Bourgeois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,7 @@ licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/rd2/oslg
-  source_code_uri: https://github.com/rd2/oslg/tree/v0.2.5
+  source_code_uri: https://github.com/rd2/oslg/tree/v0.2.7
   bug_tracker_uri: https://github.com/rd2/oslg/issues
 post_install_message:
 rdoc_options: []
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 2.7.3
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="