openstudio_measure_tester 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f5a572a08e1cf50dac9d00cbd082413321ee167bdf987176f0aa57ac8762ffc
-  data.tar.gz: 2d5465eec4d31216ba26a4a4907998bd29fa9650f592b7369474c2c8e5077820
+  metadata.gz: 465198d56107ba3fea7daa6d6cedbcfe060fa60278bb1fc8b9a5ceeedc5ee7bc
+  data.tar.gz: 81208f4245ce75e3d2af1a39594c653945761a70e39770c177dd55ef9ef2e72a
 SHA512:
-  metadata.gz: 4c7ade21a3fe0b0a77395cb0a4c647b000ef34037c50b67202dfb92662d6659e7c9980569b3ba76da67edba2a4f2a60523f8d933871ea4a0058d9485e1a8bc33
-  data.tar.gz: d46a3c20cabc1415ca754c3e9b5bffaf09615ae215674fe4555412319de76e02d5a1b4f97ce2da0e1075f41bb4296d9b989c0837e0a73ef207befca1073ca2d5
+  metadata.gz: 6312f7014254ec2600047a481575a01e396cec8f37f8225e917434a041314c728ee50378258d10d1d66ddec32f2b70e89911d919de276fe6636c6861451b984f
+  data.tar.gz: 8940105a13d6ec4d4bf87223e556762931995818f3ad5e802c8be57bb92195edcecd62819b93c842a9f3272013883d6eaecc10d059466a28c65ea76916f7eedb

data/.gitignore

@@ -21,8 +21,10 @@ Gemfile.lock
 /rubocop-results.xml
 !spec/files/rubocop-results.xml
 spec/files/rubocop/rubocop.json
+spec/files/minitest/minitest.json
 spec/**/.rubocop.yml
 
+
 # mac and rbenv stuff
 .DS_Store
 .ruby-version

data/.rubocop.yml

@@ -1,6 +1,451 @@
-AllCops:
-  Exclude:
-    - 'spec/test_measures/**/*'
-require: rubocop-performance
-inherit_from:
-  - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml
+Gemspec/OrderedDependencies:
+  Enabled: true
+
+
+# This file was regenerated by Nicholas Long on 4/4/2025. 
+# The version that was on AWS S3 is going to be removed, but should
+# probably wait until 6 months after this is released to ensure 
+# old versions are not still in use. (If you see this message after Jan 1, 2026,
+# then remove this comment and delete the AWS rubocop configs.
+#    http://s3.amazonaws.com/openstudio-resources/styles/
+Layout:
+  Severity: error
+Lint:
+  Severity: error
+Metrics:
+  Severity: error
+Naming:
+  Severity: warning   
+Style:
+  Severity: error
+  
+# ==================== Layout ====================
+Layout/BlockAlignment:
+  Enabled: true
+
+# Need to allow indented case statements
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true
+
+Layout/EmptyLines:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundExceptionHandlingKeywords:
+  Enabled: true
+
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+Layout/ExtraSpacing:
+  Enabled: true
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+# Allow long lines to encourage sufficiently
+# detailed user-facing log messages.
+Layout/LineLength:
+  Enabled: true
+  Max: 1200
+  Severity: warning
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+# ==================== Linters ====================
+Lint/AmbiguousOperator:
+  Enabled: true
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+# Allow empty when branches to give
+# a space to clearly document the
+# reason that nothing is happening.
+Lint/EmptyWhen:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/NestedMethodDefinition:
+  Enabled: true
+
+Lint/ParenthesesAsGroupedExpression:
+  Enabled: true
+
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/RedundantRequireStatement:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/ShadowingOuterLocalVariable:
+  Enabled: true
+
+# NL 2020-05-03: Allow catching StandardError
+# TC renamed from Lint/HandleExceptions to Lint/SuppressedException for v4 style
+Lint/SuppressedException:
+  Enabled: false
+
+Lint/UnreachableCode:
+  Enabled: false
+
+# Disable checks for unused block arguments
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# Disable checks for ununsed method arguments
+Lint/UnusedMethodArgument:
+  Enabled: false
+
+
+# Allow variable initialization to indicate
+# what variable is going to be set by the next
+# block of code.
+Lint/UselessAssignment:
+  Enabled: false
+
+# ==================== Metrics ====================
+# NL 2020-05-03: Drastically increase the length of assignment branch condition
+Metrics/AbcSize:
+  Max: 250
+  Enabled: true
+  Severity: warning
+
+# NL 2020-05-03: Quintuple the length of allowable blocks
+Metrics/BlockLength:
+  Max: 250
+  Severity: warning
+  Enabled: true
+
+Metrics/BlockNesting:
+  Max: 5
+  Enabled: true
+
+Metrics/ClassLength:
+  Max: 500
+  CountComments: false
+  Severity: warning
+  Enabled: true
+
+# NL 2020-05-03: Increase the allowable cyclomatic complexity
+Metrics/CyclomaticComplexity:
+  Max: 100
+  Severity: warning
+  Enabled: true
+
+Metrics/MethodLength:
+  Max: 350
+  CountComments: false
+  Severity: warning
+  Enabled: true
+
+Metrics/ModuleLength:
+  Max: 500
+  CountComments: false
+  Severity: warning
+
+# Longer parameter list limits for methods that
+# add HVAC systems
+Metrics/ParameterLists:
+  Max: 15
+  Severity: warning
+  Enabled: true
+
+# NL 2020-05-03: increase tolerance
+Metrics/PerceivedComplexity:
+  Max: 100
+  Severity: warning
+  Enabled: true
+
+# ==================== Naming ====================
+# Intentionally allow set_foo because these methods do not
+# have corresponding getters.
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/BlockParameterName:
+  Enabled: true
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: true
+
+Naming/FileName:
+  Enabled: true
+
+Naming/MethodName:
+  Enabled: true
+
+Naming/MethodParameterName:
+  Enabled: true
+
+Naming/VariableName:
+  Enabled: true
+
+# Allow variables like coeff_1 for legibility
+Naming/VariableNumber:
+  Enabled: true
+
+# ==================== Performance ====================
+# These are disabled because they are in a separate gem.
+# Performance` cops have been extracted to the `rubocop-performance` gem.
+
+# NL 2020-05-03: match -> match? or =~ -> match? breaks certain OpenStudio measures.
+# Performance/RegexpMatch:
+#   Enabled: false
+
+# NL 2020-05-03: Allow gsub (instead of the preferred tr)
+# Performance/StringReplacement:
+#   Enabled: false
+
+# ==================== Security ====================
+Security/Eval:
+  Enabled: true
+
+# ==================== Styles ====================
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/AndOr:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/CombinableLoops:
+  Enabled: true
+
+Style/CommentAnnotation:
+  Enabled: true
+
+Style/CommentedKeyword:
+  Enabled: true
+
+# Allow this syntax -- do not autocorrect.
+#   a = if true
+#         1
+#       else
+#         2
+#       end
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Documentation will be covered by YARD.
+Style/Documentation:
+  Enabled: false
+
+Style/EachWithObject:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: true
+
+
+Style/FloatDivision:
+  Enabled: true
+
+# Allow for i in 0..3 loops
+Style/For:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: true
+
+# NL 2020-05-08: Do not add the frozen_string_literal: true to the top of the files.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Enabled: false
+
+# Disabled because in most of this codebase, the current approach is more readable.
+Style/GuardClause:
+  Enabled: false
+
+# Allow duplication inside conditional branches to keep
+# code that does certain tasks more consolidated.
+Style/IdenticalConditionalBranches:
+  Enabled: false  
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: true
+
+# Allow this type of nesting for logic clarity.
+Style/IfInsideElse:
+  Enabled: false  
+
+# Do not force people to use one-line if statements.
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/InverseMethods:
+  Enabled: true
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: true
+
+Style/MultilineIfThen:
+  Enabled: true
+
+# Allow multiple comparisons via || for clarity
+Style/MultipleComparison:
+  Enabled: false
+
+# Allow negatives
+# https://rubocop.readthedocs.io/en/latest/cops_style/#stylenegatedif
+Style/NegatedIf:
+  Enabled: false
+
+# Do not force people to use Next.
+Style/Next:
+  Enabled: false
+
+Style/Not:
+  Enabled: true
+
+# Do not convert 10000 to 10_000
+Style/NumericLiterals:
+  Enabled: false
+
+# Do not force using .zero?
+Style/NumericPredicate:
+  Enabled: false
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/PreferredHashMethods:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantFreeze:
+  Enabled: true
+
+Style/RedundantParentheses:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+# encourage explicit returns for clarity
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: true
+
+# Do NOT use &. for Safe Navigation
+Style/SafeNavigation:
+  Enabled: false
+
+Style/SelfAssignment:
+  Enabled: true
+
+Style/SignalException:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/SoleNestedConditional:
+  Enabled: true
+
+# Do NOT enable this because it appears $? is different than $CHILD_STATUS.
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringConcatenation:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+
+# Do not use %w, %W, %i, etc
+# Prefer [:a, :b, :c] over %i[a b c]
+Style/SymbolArray:
+  EnforcedStyle: brackets
+  Enabled: true
+
+Style/SymbolProc:
+  Enabled: true
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+
+# Do not use %w, %W, %i, etc
+# Prefer ['a', 'b', 'c'] over %w[a b c]
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: brackets
+
+Style/ZeroLengthPredicate:
+  Enabled: true
+  

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# Version 0.4.1
+
+* Switch rubocop and simplecov to development dependencies
+* Update rubocop syntax
+* Updates to support rubocop's new format
+
+# Version 0.4.0
+
+* Upgrade to Ruby 3.2.2
+* Updating gem versions of rubocop and simplecov
+
 # Version 0.3.3
 
 * Update license

data/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2024 Alliance for Sustainable Energy, LLC.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

data/cspell.json

@@ -0,0 +1,29 @@
+{
+    "version": "0.2",
+    "ignorePaths": [],
+    "dictionaryDefinitions": [],
+    "dictionaries": [],
+    "words": [
+        "Adak",
+        "ASHRAE",
+        "autocalculate",
+        "autorun",
+        "Condns",
+        "curdir",
+        "Drybulb",
+        "energyplus",
+        "Floorto",
+        "Goldwasser",
+        "HVAC",
+        "openstudio",
+        "Placemark",
+        "popen",
+        "roundto",
+        "snakecase",
+        "Timestep",
+        "weatherlocation",
+        "wmoundefined"
+    ],
+    "ignoreWords": [],
+    "import": []
+}

data/lib/openstudio_measure_tester/coverage.rb

@@ -7,13 +7,7 @@
 
 module OpenStudioMeasureTester
   class Coverage
-    attr_reader :total_percent_coverage
-    attr_reader :total_lines
-    attr_reader :total_relevant_lines
-    attr_reader :covered_lines
-    attr_reader :missed_lines
-    attr_reader :avg_hits_per_line
-    attr_reader :measure_coverages
+    attr_reader :total_percent_coverage, :total_lines, :total_relevant_lines, :covered_lines, :missed_lines, :avg_hits_per_line, :measure_coverages
 
     def initialize(path_to_results)
       @path_to_results = path_to_results
@@ -31,9 +25,9 @@ module OpenStudioMeasureTester
       unless File.exist? measure_file
         # magically try to find the path name by dropping the first element of array. This is
         # mainly needed for the testing framework as we are committing the .resultset.json which may
-        # have been generated by any user, esp since the file names are fully qualified in the .resultsset.json,
+        # have been generated by any user, esp since the file names are fully qualified in the .resultset.json,
         puts "Trying to determine the file path of unknown measure #{measure_file}"
-        measure_file = measure_file.split('/')[1..-1].join('/') until File.exist?(measure_file) || measure_file.split('/').empty?
+        measure_file = measure_file.split('/')[1..].join('/') until File.exist?(measure_file) || measure_file.split('/').empty?
       end
 
       # file should exist now. Read from the class name
@@ -74,12 +68,12 @@ module OpenStudioMeasureTester
       # the classname, then to go through and grab all the other files that exist for the same measure class name.
       # Two passes because the order of the files in .resultset.json is not guaranteed to have measure.rb first.
       measure_maps = {}
-      coverage_results['coverage'].keys.each do |key|
+      coverage_results['coverage'].each_key do |key|
         parts = key.split('/')
         if parts.last == 'measure.rb'
           class_name = parse_class_name(key)
           measure_maps[class_name] = {
-            class_name: class_name,
+            class_name:,
             root_path: File.dirname(key),
             files: [key]
           }
@@ -87,7 +81,7 @@ module OpenStudioMeasureTester
       end
 
       # second pass, add other files.
-      coverage_results['coverage'].keys.each do |key|
+      coverage_results['coverage'].each_key do |key|
         next if key.split('/').last == 'measure.rb'
 
         measure_maps.each do |m_key, m_value|
@@ -120,7 +114,7 @@ module OpenStudioMeasureTester
           cov_results_by_line.delete(nil)
 
           cov = cov_results_by_line.count { |x| x > 0 }
-          fhash['percent_coverage'] = ((cov.to_f / cov_results_by_line.size.to_f) * 100).round(2)
+          fhash['percent_coverage'] = ((cov.to_f / cov_results_by_line.size) * 100).round(2)
           fhash['missed_lines'] = cov_results_by_line.size - cov
           fhash['relevant_lines'] = cov_results_by_line.size
           fhash['covered_lines'] = cov
@@ -132,7 +126,7 @@ module OpenStudioMeasureTester
           mhash['files'] << fhash
         end
 
-        mhash['percent_coverage'] = (mhash['covered_lines'].to_f / mhash['relevant_lines'].to_f * 100).round(2)
+        mhash['percent_coverage'] = (mhash['covered_lines'].to_f / mhash['relevant_lines'] * 100).round(2)
         @measure_coverages[class_name] = mhash
         @total_lines += mhash['total_lines']
         @total_relevant_lines += mhash['relevant_lines']
@@ -144,7 +138,7 @@ module OpenStudioMeasureTester
       lines = @total_relevant_lines # unnecessary but breaks formatting otherwise
       # lines can be zero if coverage doesn't run correctly
       if lines != 0
-        @total_percent_coverage = (@total_covered_lines.to_f / lines.to_f * 100).round(2)
+        @total_percent_coverage = (@total_covered_lines.to_f / lines * 100).round(2)
       end
       pp "Total Coverage: #{@total_percent_coverage}"
 

data/lib/openstudio_measure_tester/dashboard.rb

@@ -22,7 +22,7 @@ module OpenStudioMeasureTester
     end
 
     def render
-      rendered = ERB.new(@template, 0, nil, '@html').result(binding)
+      rendered = ERB.new(@template, trim_mode: nil, eoutvar: '@html').result(binding)
       save_dir = "#{@test_results_directory}/dashboard"
 
       # Render the dashboard

data/lib/openstudio_measure_tester/github_actions_report.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# *******************************************************************************
+# OpenStudio(R), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://openstudio.net/license
+# *******************************************************************************
+
+module OpenStudioMeasureTester
+  class GithubActionsReport
+    attr_reader :minitest_summary_table, :all_annotations
+
+    # @param test_results_directory [String]: The directory
+    def initialize(test_results_directory)
+      @test_results_directory = test_results_directory
+      file = File.read("#{@test_results_directory}/combined_results.json")
+      @hash = JSON.parse(file)
+      @minitest_summary_table = nil
+      @all_annotations = []
+    end
+
+    def write_step_summary(msg)
+      puts msg
+      if !ENV['GITHUB_STEP_SUMMARY'].nil?
+        File.write(ENV['GITHUB_STEP_SUMMARY'], "#{msg}\n", mode: 'a+')
+      end
+    end
+
+    def hash_to_markdown(h, header0, header1)
+      n0 = [h.keys.map(&:to_s).map(&:size).max, header0.size].max
+      n1 = [h.values.map(&:to_s).map(&:size).max, header1.size].max
+
+      content = [
+        "| #{header0.ljust(n0)} | #{header1.ljust(n1)} |",
+        "| #{'-' * n0} | #{'-' * n1} |"
+      ] + h.map { |k, v| "| #{k.ljust(n0)} | #{v.to_s.ljust(n1)} |" }
+      return content.join("\n")
+    end
+
+    def make_minitest_step_summary_table
+      write_step_summary('## Minitest')
+      write_step_summary('')
+
+      total_tests = @hash['minitest']['total_tests']
+      total_assertions = @hash['minitest']['total_assertions']
+      total_errors = @hash['minitest']['total_errors']
+      total_failures = @hash['minitest']['total_failures']
+      total_skipped = @hash['minitest']['total_skipped']
+      total_compatibility_errors = @hash['minitest']['total_compatibility_errors']
+      total_load_errors = @hash['minitest'].fetch('total_load_errors', []).count
+
+      passed = total_tests - (total_failures + total_errors + total_skipped)
+      pct = passed.to_f / (total_tests - total_skipped)
+
+      h = {
+        'Total Tests' => total_tests,
+        'Load Error' => total_load_errors,
+        'Passed' => passed,
+        'Success Rate' => format('%.2f%%', (pct * 100.0)),
+        'Failures' => total_failures,
+        'Errors' => total_errors,
+        'Skipped' => total_skipped,
+        'Incompatible' => total_compatibility_errors,
+        'Total Assertions' => total_assertions
+      }
+
+      @minitest_summary_table = hash_to_markdown(h, 'Metric', 'Value')
+
+      write_step_summary(@minitest_summary_table)
+      write_step_summary('')
+    end
+
+    def make_minitest_annotations
+      @all_annotations = []
+
+      report_xmls = Dir["#{@test_results_directory}/minitest/reports/TEST-*.xml"]
+      report_xmls.each do |report_xml|
+        doc = REXML::Document.new(File.open(report_xml)).root
+        testsuite_element = doc.elements['testsuite']
+        filepath = testsuite_element.attributes['filepath']
+        testsuite_element.elements.each('testcase') do |testcase|
+          test_name = testcase.attributes['name']
+          line = testcase.attributes['lineno'].to_i
+          tested_class = testcase.attributes['classname']
+
+          testcase.elements.each('failure') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::error file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{tested_class}.#{test_name}: #{message}"
+            @all_annotations << annot
+          end
+          testcase.elements.each('error') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::error file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{message}"
+            @all_annotations << annot
+          end
+          testcase.elements.each('skipped') do |x|
+            title = x.attributes['type']
+            message = x.attributes['message']
+            annot = "::warning file=#{filepath},line=#{line},endLine=#{line + 1},title=#{title}::#{message}"
+            @all_annotations << annot
+          end
+        end
+      end
+      @all_annotations.each { |a| puts a }
+      nil
+    end
+  end
+end

data/lib/openstudio_measure_tester/minitest_result.rb

@@ -7,16 +7,7 @@
 
 module OpenStudioMeasureTester
   class MinitestResult
-    attr_reader :error_status
-
-    attr_reader :total_assertions
-    attr_reader :total_errors
-    attr_reader :total_failures
-    attr_reader :total_skipped
-    attr_reader :total_tests
-    attr_reader :total_compatibility_errors
-    attr_reader :measure_results
-    attr_reader :summary
+    attr_reader :error_status, :total_assertions, :total_errors, :total_failures, :total_skipped, :total_tests, :total_compatibility_errors, :measure_results, :summary
 
     def initialize(path_to_results)
       @path_to_results = path_to_results
@@ -79,7 +70,7 @@ module OpenStudioMeasureTester
           doc = REXML::Document.new(File.open(report_xmls[0])).root
 
           if doc
-            # Note: only 1 failure and 1 error possible per test
+            # NOTE: only 1 failure and 1 error possible per test
             testsuite_element = doc.elements['testsuite']
             errors, failures, skipped = parse_measure(testsuite_element)
 
@@ -127,8 +118,6 @@ module OpenStudioMeasureTester
       @summary[:total_load_errors] = @total_load_errors
       @summary[:by_measure] = @measure_results
 
-      # pp @summary
-
       FileUtils.mkdir "#{@path_to_results}/" unless Dir.exist? "#{@path_to_results}/"
       File.open("#{@path_to_results}/minitest.json", 'w') do |file|
         file << JSON.pretty_generate(summary)
@@ -148,7 +137,7 @@ module OpenStudioMeasureTester
         elsif testcase.elements['failure']
           failures << testcase.elements['failure']
         elsif testcase.elements['skipped']
-          skipped << 'Skipped test: ' + testcase.elements['skipped'].attributes['type']
+          skipped << "Skipped test: #{testcase.elements['skipped'].attributes['type']}"
         end
       end
 

data/lib/openstudio_measure_tester/openstudio_style.rb

@@ -7,8 +7,7 @@
 
 module OpenStudioMeasureTester
   class OpenStudioStyle
-    attr_reader :results
-    attr_reader :measure_messages
+    attr_reader :results, :measure_messages
 
     CHECKS = [
       {
@@ -180,9 +179,9 @@ module OpenStudioMeasureTester
 
     def log_message(message, type = :syntax, severity = :info)
       new_message = {
-        message: message,
-        type: type,
-        severity: severity
+        message:,
+        type:,
+        severity:
       }
       @measure_messages << new_message
     end

data/lib/openstudio_measure_tester/openstudio_testing_result.rb

@@ -88,7 +88,7 @@ module OpenStudioMeasureTester
         # minitest
         if Dir.exist?("#{@orig_results_dir}/test/html_reports") || Dir.exist?("#{@orig_results_dir}/test/reports")
           puts 'Found Minitest Results, parsing'
-          # Do not delete the compatibilty directory which is generated when the test is run
+          # Do not delete the compatibility directory which is generated when the test is run
           FileUtils.rm_rf "#{@test_results_dir}/minitest/html_reports" if Dir.exist? "#{@test_results_dir}/minitest/html_reports"
           FileUtils.rm_rf "#{@test_results_dir}/minitest/reports" if Dir.exist? "#{@test_results_dir}/minitest/reports"
 
@@ -135,8 +135,8 @@ module OpenStudioMeasureTester
       # there must be no unit test failures
       # pp @results
       final_exit_code = 0
-      if @results['rubocop']
-        # more than 10 errors per file on average
+      # more than 10 errors per file on average
+      if @results['rubocop'] && (@results['rubocop']['total_errors'].nonzero? && @results['rubocop']['total_files'].nonzero?)
         status = @results['rubocop']['total_errors'] / @results['rubocop']['total_files']
         if status > 10
           puts "More than 10 RuboCop errors per file found. Found #{status}"
@@ -159,11 +159,9 @@ module OpenStudioMeasureTester
         end
       end
 
-      if @results['minitest']
-        if @results['minitest'][:total_errors] > 0 || @results['minitest'][:total_failures] > 0
-          puts 'Unit Test (Minitest) errors/failures found.'
-          final_exit_code = 1
-        end
+      if @results['minitest'] && (@results['minitest'][:total_errors] > 0 || @results['minitest'][:total_failures] > 0)
+        puts 'Unit Test (Minitest) errors/failures found.'
+        final_exit_code = 1
       end
 
       # if @results['coverage']

data/lib/openstudio_measure_tester/rake_task.rb

@@ -27,11 +27,11 @@ module OpenStudioMeasureTester
     def setup_subtasks(name)
       namespace name do
         ####################################### Minitest and Coverage #######################################
-        desc 'new test task'
+        desc 'Run Minitest and Coverage on Measures'
         task :test do
           runner = OpenStudioMeasureTester::Runner.new(Rake.application.original_dir)
           # Need to pass in the current directory because the results of minitest and coverage end up going into
-          # the root directorys
+          # the root directories
           exit runner.run_test(false, Dir.pwd, false)
         end
 

data/lib/openstudio_measure_tester/rubocop_result.rb

@@ -7,23 +7,7 @@
 
 module OpenStudioMeasureTester
   class RubocopResult
-    attr_reader :error_status
-
-    attr_reader :file_issues
-    attr_reader :file_info
-    attr_reader :file_warnings
-    attr_reader :file_errors
-
-    attr_reader :total_measures
-    attr_reader :total_files
-
-    attr_reader :total_issues
-    attr_reader :total_info
-    attr_reader :total_warnings
-    attr_reader :total_errors
-
-    attr_reader :summary
-    attr_reader :by_measure
+    attr_reader :error_status, :file_issues, :file_info, :file_warnings, :file_errors, :total_measures, :total_files, :total_issues, :total_info, :total_warnings, :total_errors, :summary, :by_measure
 
     def initialize(path_to_results)
       @path_to_results = path_to_results
@@ -90,7 +74,8 @@ module OpenStudioMeasureTester
           doc.elements.each('//checkstyle/file') do |rc_file|
             # Allow processing when the file is just the measure.rb
             if rc_file.attributes['name'] != 'measure.rb'
-              if !rc_file.attributes['name'].include? measure_name
+              parts = rc_file.attributes['name'].split(File::SEPARATOR)
+              if !parts.include? measure_name
                 next
               end
             end
@@ -109,7 +94,7 @@ module OpenStudioMeasureTester
               if File.exist? rc_file.attributes['name']
                 File.readlines(rc_file.attributes['name']).each do |line|
                   if (line.include? 'class') && line.split(' ')[0] == 'class'
-                    cn = line.split(' ')[1].gsub /_?[tT]est\z/, ''
+                    cn = line.split(' ')[1].gsub(/_?[tT]est\z/, '')
                     break
                   end
                 end
@@ -126,11 +111,12 @@ module OpenStudioMeasureTester
             violations = []
             rc_file.elements.each('error') do |rc_error|
               @file_issues += 1
-              if rc_error.attributes['severity'] == 'info'
+              case rc_error.attributes['severity']
+              when 'info'
                 @file_info += 1
-              elsif rc_error.attributes['severity'] == 'warning'
+              when 'warning'
                 @file_warnings += 1
-              elsif rc_error.attributes['severity'] == 'error'
+              when 'error'
                 @file_errors += 1
               end
               violations << {

data/lib/openstudio_measure_tester/runner.rb

@@ -32,6 +32,12 @@ module OpenStudioMeasureTester
       template.render
     end
 
+    def github_actions_report
+      gha_reporter = OpenStudioMeasureTester::GithubActionsReport.new(test_results_dir)
+      gha_reporter.make_minitest_step_summary_table
+      gha_reporter.make_minitest_annotations
+    end
+
     # Prepare the current directory and the root directory to remove old test results before running
     # the new tests
     #
@@ -67,8 +73,10 @@ module OpenStudioMeasureTester
       # copy over the .rubocop.yml file into the root directory of where this is running.
       shared_rubocop_file = File.expand_path('../../.rubocop.yml', File.dirname(__FILE__))
       dest_file = "#{File.expand_path(@base_dir)}/.rubocop.yml"
-      if shared_rubocop_file != dest_file
+      if !File.exist?(dest_file)
         FileUtils.copy(shared_rubocop_file, dest_file)
+      elsif File.read(shared_rubocop_file) != File.read(dest_file)
+        puts "Using specific custom .rubocop.yml rather than the OpenStudio-measure-tester-gem's one"
       end
 
       puts "Current directory is #{@base_dir}"
@@ -84,7 +92,7 @@ module OpenStudioMeasureTester
 
     # Post process the various results and save them into the base_dir
     #
-    # @param original_results_directory [string] Location of the results from coverag and minitest
+    # @param original_results_directory [string] Location of the results from coverage and minitest
     def post_process_results(original_results_directory = nil)
       puts ' ========================= Starting Results Post Process ================================'
       puts "Current directory: #{@base_dir}"
@@ -96,6 +104,8 @@ module OpenStudioMeasureTester
       # call the create dashboard command now that we have results
       dashboard
 
+      github_actions_report if ENV['GITHUB_ACTIONS']
+
       # return the results exit code
       return results.exit_code
     end
@@ -144,8 +154,11 @@ module OpenStudioMeasureTester
         # out and output_path do not actually save the results, has to be appended after the formatter.
         # out: 'junk.xml',
         # output_path: 'junk.xml',
-        auto_correct: auto_correct,
+        auto_correct:,
         color: false,
+        # cf #76 - Because we pass a glob to the Runner.run, we must pass
+        # force_exclusion to respect the files excluded in the .rubocop.yml
+        force_exclusion: true,
         formatters: ['simple', ['RuboCop::Formatter::CheckstyleFormatter', rubocop_results_file]]
       }
 

data/lib/openstudio_measure_tester/version.rb

@@ -6,5 +6,5 @@
 # *******************************************************************************
 
 module OpenStudioMeasureTester
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.4.1'
 end

data/lib/openstudio_measure_tester.rb

@@ -7,10 +7,10 @@
 
 require 'openstudio'
 
-require 'pp'
 require 'rexml/document'
 require 'minitest'
 require 'simplecov'
+require 'json'
 
 begin
   require 'git'
@@ -36,6 +36,7 @@ require_relative 'openstudio_measure_tester/coverage'
 require_relative 'openstudio_measure_tester/rubocop_result'
 require_relative 'openstudio_measure_tester/openstudio_testing_result'
 require_relative 'openstudio_measure_tester/dashboard'
+require_relative 'openstudio_measure_tester/github_actions_report'
 require_relative 'openstudio_measure_tester/runner'
 
 require_relative 'openstudio_measure_tester/rake_task'

data/openstudio_measure_tester.gemspec

@@ -27,18 +27,18 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.7.0'
+  spec.required_ruby_version = '~> 3.2.2'
 
   spec.add_dependency 'git', '~> 1.12.0'
   spec.add_dependency 'minitest', '~> 5.14.0'
   spec.add_dependency 'minitest-reporters', '~> 1.4.2'
-  spec.add_dependency 'rake', '~> 13.0'
   spec.add_dependency 'parser', '3.2.2.2'
-  spec.add_dependency 'rubocop', '~> 1.15.0'
-  spec.add_dependency 'rubocop-performance', '~> 1.11.3'
-  spec.add_dependency 'rubocop-checkstyle_formatter', '~> 0.4.0'
-  spec.add_dependency 'simplecov', '~> 0.18.2'
+  spec.add_dependency 'rake', '~> 13.0'
 
-  spec.add_development_dependency 'bundler', '>= 2.1.0'
+  spec.add_development_dependency 'rubocop', '1.50'
+  spec.add_development_dependency 'rubocop-checkstyle_formatter', '0.6.0'
+  spec.add_development_dependency 'rubocop-performance', '1.20.0'
+  spec.add_development_dependency 'simplecov', '0.22.0'
+  spec.add_development_dependency 'bundler', '2.4.10'
   spec.add_development_dependency 'rspec', '~> 3.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openstudio_measure_tester
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Nicholas Long
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -56,103 +56,103 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.4.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 3.2.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: 3.2.2.2
 - !ruby/object:Gem::Dependency
-  name: parser
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.2.2
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.2.2
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.0
-  type: :runtime
+        version: '1.50'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: '1.50'
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: rubocop-checkstyle_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
-  type: :runtime
+        version: 0.6.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.11.3
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-checkstyle_formatter
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
+        version: 1.20.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.2
-  type: :runtime
+        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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.4.10
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +186,7 @@ files:
 - bin/console
 - bin/run_measure_tests
 - bin/setup
+- cspell.json
 - dashboard/css/bootstrap-grid.css
 - dashboard/css/bootstrap-grid.min.css
 - dashboard/css/bootstrap-reboot.css
@@ -200,6 +201,7 @@ files:
 - lib/openstudio_measure_tester/core_ext.rb
 - lib/openstudio_measure_tester/coverage.rb
 - lib/openstudio_measure_tester/dashboard.rb
+- lib/openstudio_measure_tester/github_actions_report.rb
 - lib/openstudio_measure_tester/minitest_result.rb
 - lib/openstudio_measure_tester/openstudio_style.rb
 - lib/openstudio_measure_tester/openstudio_testing_result.rb
@@ -214,7 +216,7 @@ licenses: []
 metadata:
   bug_tracker_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/issues
   changelog_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/blob/develop/CHANGELOG.md
-  source_code_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/tree/v0.3.3
+  source_code_uri: https://github.com/NREL/OpenStudio-measure-tester-gem/tree/v0.4.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -223,14 +225,14 @@ 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: Testing framework for OpenStudio measures