oslg 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0535a05d35fee722c018380a21e3253ce9764058b7092a80ac4904426c9fa243
-  data.tar.gz: 5919cb3f5ecb420a53c54b5740bf72177077cacb0a3a2cce65647ba12a8b4094
+  metadata.gz: 6a72f075eb3b3eb995fe06471af5b8e2bfd56326cc6dd944fd1ee7711d8d14c9
+  data.tar.gz: bb2f2143fb8a93f34b5e5b28dc7729d591a0869a05490b77b1165a5dacc23d99
 SHA512:
-  metadata.gz: 432dfef35fa88b722c2dff388ebe8f999e4a9bad0aaa987b495006c968572dac98773f5a7659866c3955620622b5b89a3c5544bdad1f577d3feba5bf51796fa5
-  data.tar.gz: 2696ecd29f72652774d0b6cf5db41a3e4b81af54c4d9a2cd8b64669500085c5d06914744ac061b42e878e3f27c6ac89387b094aeaf08f87b477fd9e2a2e8bef3
+  metadata.gz: 5d982229010b326f43b64324eb40811431140a000493f732b773a0736a63d0ffa661455eb2d77fc751beee2a7c05cf411f8bdcd218ccd75a3a9e527e6f29d0cd
+  data.tar.gz: aaaf89b502bf30d4091c8eb91e4003a79b6c4b84392611454ee23d3399dc6d4dca680f43afc86128146bff7fba21096147d06dfeca34fcb371bbb7907a2537e3

data/.github/workflows/pull_request.yml

@@ -39,7 +39,7 @@ jobs:
         docker exec -t test bundle exec rake
         docker kill test
   test_330x:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.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-18.04
+    runs-on: ubuntu-20.04
     steps:
     - name: Check out repository
       uses: actions/checkout@v2

data/README.md

@@ -1,15 +1,15 @@
 # oslg
 
-A logger module for _picky_ [OpenStudio](https://openstudio-sdk-documentation.s3.amazonaws.com/index.html) [Measure](https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/) developers who wish to select what gets logged to which target (e.g. OpenStudio _runner_ vs custom JSON file). Add:
+A logger module for _picky_ [OpenStudio](https://openstudio.net) [Measure](https://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/) developers who wish to select what gets logged to which target (e.g. OpenStudio _runner_ vs custom JSON file). Add:
 
 ```
 gem "oslg", git: "https://github.com/rd2/oslg", branch: "main"
 ```
 
-... in a measure's development environment "Gemfile", and then run:
+... in a v2.1 [bundled](https://bundler.io) _Measure_ development environment "Gemfile" (or instead as a _gemspec_ dependency), and then run:
 
 ```
-bundle install
+bundle install (or 'bundle update')
 ```
 
 ### OpenStudio & EnergyPlus
@@ -21,7 +21,7 @@ In most cases, critical (and many non-critical) OpenStudio anomalies will be cau
 As a Ruby module, one can access __oslg__ by _extending_ a measure module or class:
 
 ```
-module Modu
+module M
   extend OSlg
   ...
 end
@@ -39,56 +39,56 @@ FATAL
 
 DEBUG messages aren't benign at all, but are certainly less informative for the typical Measure user.
 
-Initially, __oslg__ sets 2x internal variable states: `level` (INFO) and `status` (< DEBUG). The variable `level` 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. `Modu.reset(Modu::DEBUG)`), then all DEBUG messages would also be logged. The variable `status` is reset with each new log entry if the latter's log level is more severe than its predecessor (e.g. `status == Modu::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 variable states: `level` (INFO) and `status` (< DEBUG). The variable `level` 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 variable `status` 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):  
 
 ```
-Modu.debug?
-Modu.warn?
-Modu.error?
-Modu.fatal?
+M.debug?
+M.warn?
+M.error?
+M.fatal?
 ```
 
-It's sometimes not a bad idea to rely on a _clean_ slate (e.g. within RSpecs). This flushes out all previous logs and resets `level` (INFO) and `status` (< DEBUG) - use with caution in production code!
+It's sometimes not a bad idea to rely on a _clean_ slate (e.g. within RSpecs). The following flushes out all previous logs and resets `level` (INFO) and `status` (< DEBUG) - use with caution in production code!
 
 ```
-Modu.clean!
+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.
 
 ```
-Modu.log(Modu::FATAL, "Missing input JSON file")
+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 users can fix.
 
 ```
-Modu.log(Modu::ERROR, "Measure won't process MASSLESS materials")
+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.
 
 ```
-Modu.log(Modu::WARN, "Surface area < 100cm2")
+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.
 
 ```
-Modu.log(Modu::INFO, "Envelope compliant to prescriptive code requirements")
+M.log(M::INFO, "Envelope compliant to prescriptive code requirements")
 ```
 
 Finally, a number of sanity checks are likely warranted to ensure Ruby doesn't crash (e.g., invalid access to uninitialized variables), especially for lower-level functions. We suggest implementing safe fallbacks when this occurs, but __DEBUG__ errors could nonetheless be triggered to signal a bug.
 
 ```
-Modu.log(Modu::DEBUG, "Hash? expecting Array (method)")
+M.log(M::DEBUG, "Hash? expecting Array (method)")
 ```
 
 All log entries are stored in a single Ruby _Array_, with each individual log entry as a Ruby _Hash_ with 2x _keys_ ```:level``` and ```:message```, e.g.:
 
 ```
-Modu.logs.each do |log|
-  puts "Uh-oh: #{log[:message]}" if log[:level] > Modu::INFO
+M.logs.each do |log|
+  puts "Uh-oh: #{log[:message]}" if log[:level] > M::INFO
 end
 ```
 
@@ -100,19 +100,19 @@ Typically, developers would first catch bad input, log an error message and poss
 
 ```
 unless var.is_a?(Array)
-  Modu.log(Modu::DEBUG, "#{var.class}? expecting Array (method)")
+  M.log(M::DEBUG, "#{var.class}? expecting Array (method)")
   return false
 end
 ```
 
-The following are __oslg__ one-liner methods that _log & return_ in one go. These are for some of the most common checks OpenStudio SDK Ruby developers are likely to need. These methods require _valid_ arguments for __oslg__ to actually log. Although often expecting strings as arguments, the methods will try to convert other types to strings (e.g. classes, numbers, even entire arrays) if possible.
+The following are __oslg__ one-liner methods that _log & return_ in one go. These are for some of the most common checks OpenStudio SDK Ruby developers are likely to need. The methods require _valid_ arguments for __oslg__ to actually log. Although often expecting strings as arguments, the methods will try to convert other types to strings (e.g. classes, numbers, even entire arrays) if possible.
 
 ---
 
 __invalid__: for logging e.g. uninitialized or nilled objects:
 
 ```
-return Modu.invalid("area", "sum", 0, Modu::ERROR, false) unless area
+return M.invalid("area", "sum", 0, M::ERROR, false) unless area
 ```
 
 This logs an ERROR message informing users that an invalid object, 'area', was caught while running method 'sum', and then exits by returning _false_. The logged message would be:
@@ -125,8 +125,8 @@ The 3rd argument (e.g. _0_) is ignored unless `> 0` - a useful option when asser
 
 ```
 def sum(areas, units)
-  return Modu.invalid("areas", "sum", 1) unless areas
-  return Modu.invalid("units", "sum", 2) unless units
+  return M.invalid("areas", "sum", 1) unless areas
+  return M.invalid("units", "sum", 2) unless units
   ...
 end
 ```
@@ -144,7 +144,7 @@ The first 2x __invalid__ method arguments (faulty object ID, calling method ID)
 __mismatch__: for logging incompatible instances vs classes:
 
 ```
-return Modu.mismatch("areas", areas, Array, "sum") unless areas.is_a?(Array)
+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_):
@@ -153,30 +153,30 @@ If 'areas' were a _String_, __mismatch__ would generate the following DEBUG log
 "'areas' String? expecting Array (sum)"
 ```
 
-These 4x __mismatch__ arguments are required (an object ID, a valid Ruby object, the mismatched Ruby class, and the calling method ID). As a safeguard, __oslg__ will NOT log a _mismatch_ if the object is an actual instance of the class. As with __invalid__, there are 2x optional _terminal_ arguments, e.g. `Modu::ERROR, false)`.
+These 4x __mismatch__ arguments are required (an object ID, a valid Ruby object, the mismatched Ruby class, and the calling method ID). As a safeguard, __oslg__ will NOT log a _mismatch_ if the object is an actual instance of the class. As with __invalid__, there are 2x optional _terminal_ arguments, e.g. `M::ERROR, false)`.
 
 ---
 
 __hashkey__: for logging missing _Hash_ keys:
 
 ```
-return Modu.hashkey("faces", faces, :area, "sum") unless faces.key?(:area)
+return M.hashkey("faces", faces, :area, "sum") unless faces.key?(:area)
 ```
 
-If the _Hash_ `faces` does not hold `:area` as one of its keys, then __mismatch__ would generate the following DEBUG log message (before returning _nil_):
+If the _Hash_ `faces` does not hold `:area` as one of its keys, then __hashkey__ would generate the following DEBUG log message (before returning _nil_):
 
 ```
 "'faces' Hash: no key 'area' (sum)"
 ```
 
-Similar to __mismatch__, the method __hashkey__ requires 4x arguments (a _Hash_ ID, a valid Ruby _Hash_, the missing _key_, and the calling method ID). There are also 2x optional _terminal_ arguments, e.g. `Modu::ERROR, false)`.
+Similar to __mismatch__, the method __hashkey__ requires 4x arguments (a _Hash_ ID, a valid Ruby _Hash_, the missing _key_, and the calling method ID). There are also 2x optional _terminal_ arguments, e.g. `M::ERROR, false)`.
 
 ---
 
 __empty__: for logging empty _Enumerable_ (e.g. _Array_, _Hash_) instances or uninitialized boost optionals (e.g. uninitialized _ThermalZone_ object of an _OpenStudio Space_):
 
 ```
-return Modu.empty("faces", "sum", Modu::ERROR, false) if faces.empty?
+return M.empty("faces", "sum", M::ERROR, false) if faces.empty?
 ```
 
 An empty `faces` _Hash_ would generate the following ERROR log message (before returning _false_):
@@ -192,8 +192,8 @@ Again, the first 2x arguments are required; the last 2x are optional.
 __zero__: for logging zero'ed (or nearly-zero'ed) values:
 
 ```
-Modu.zero("area", "sum", Modu::FATAL, false) if area.zero?
-Modu.zero("area", "sum", Modu::FATAL, false) if area.abs < TOL
+M.zero("area", "sum", M::FATAL, false) if area.zero?
+M.zero("area", "sum", M::FATAL, false) if area.abs < TOL
 ```
 ... generating the following FATAL log message (before returning _false_):
 
@@ -209,7 +209,7 @@ And again, the first 2x arguments are required; the last 2x are optional.
 __negative__: for logging negative (< 0) values:
 
 ```
-Modu.negative("area", "sum", Modu::FATAL, false) if area < 0
+M.negative("area", "sum", M::FATAL, false) if area < 0
 ```
 ... generating this FATAL log message (before returning _false_):
 
@@ -218,3 +218,7 @@ Modu.negative("area", "sum", Modu::FATAL, false) if area < 0
 ```
 
 You guessed it: the first 2x arguments are required; the last 2x as optionals.
+
+---
+
+Look up the full __oslg__ API [here](https://www.rubydoc.info/gems/oslg).

data/Rakefile

@@ -3,9 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "yard"
-YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib/oslg/oslog.rb"]
-end
-
 task default: :spec

data/lib/oslg/version.rb

@@ -29,5 +29,5 @@
 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 module OSlg
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

data/oslg.gemspec

@@ -6,14 +6,17 @@ Gem::Specification.new do |s|
   # Specify which files should be added to the gem when it is released.
   # "git ls-files -z" loads files in the RubyGem that have been added into git.
   s.files                 = Dir.chdir(File.expand_path("..", __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
   end
 
   s.name                  = "oslg"
   s.version               = OSlg::VERSION
   s.license               = "BSD-3-Clause"
   s.summary               = "OpenStudio SDK logger"
-  s.description           = "For SDK users who select what's logged where."
+  s.description           = "For OpenStudio SDK users who wish to select "     \
+                            "what gets logged to which target."
   s.authors               = ["Denis Bourgeois"]
   s.email                 = ["denis@rd2.ca"]
   s.platform              = Gem::Platform::RUBY
@@ -27,7 +30,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 2.1"
   s.add_development_dependency "rake",    "~> 13.0"
   s.add_development_dependency "rspec",   "~> 3.11"
-  s.add_development_dependency "yard",    "~> 0.9"
 
   s.metadata["homepage_uri"]    = s.homepage
   s.metadata["source_code_uri"] = "#{s.homepage}/tree/v#{s.version}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oslg
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Denis Bourgeois
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-26 00:00:00.000000000 Z
+date: 2022-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,21 +52,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.11'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-description: For SDK users who select what's logged where.
+description: For OpenStudio SDK users who wish to select what gets logged to which
+  target.
 email:
 - denis@rd2.ca
 executables: []
@@ -89,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.2
+  source_code_uri: https://github.com/rd2/oslg/tree/v0.2.3
   bug_tracker_uri: https://github.com/rd2/oslg/issues
 post_install_message:
 rdoc_options: []