RubyGems - openstudio_measure_tester - Versions diffs - 0.1.0 → 0.1.1 - Mend

openstudio_measure_tester 0.1.0 → 0.1.1

Files changed (16) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +8 -0
data/LICENSE.md +21 -6
data/README.md +4 -3
data/lib/openstudio_measure_tester/core_ext.rb +13 -4
data/lib/openstudio_measure_tester/coverage.rb +21 -30
data/lib/openstudio_measure_tester/dashboard.rb +4 -4
data/lib/openstudio_measure_tester/minitest_result.rb +4 -9
data/lib/openstudio_measure_tester/openstudio_style.rb +98 -104
data/lib/openstudio_measure_tester/openstudio_testing_result.rb +16 -8
data/lib/openstudio_measure_tester/rubocop_result.rb +34 -40
data/lib/openstudio_measure_tester/templates/dashboard.html.erb +7 -0
data/lib/openstudio_measure_tester/test_helper.rb +1 -1
data/lib/openstudio_measure_tester/version.rb +1 -1
data/openstudio_measure_tester.gemspec +2 -2
metadata +17 -16

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee7af990e240c38e29341eb17dab7b7fbddfb40f
-  data.tar.gz: f9f56720afa2ef09657ab39b5807d7d6c58d7331
+  metadata.gz: cf7807726298de144c1f44ded68e11af9b389c38
+  data.tar.gz: afa2d01a892ea3fb49a5e4d93555b40974873d35
 SHA512:
-  metadata.gz: d3abc1e06e369c3846727777b2705898a96bb96dabd5c291f75a1b089629286c2d972e1195120eff54e80e410ac6beb79c12cb4af35a6071cab7594d12049e96
-  data.tar.gz: 963f1db63936d2aeea57e6793eed70511b6498dcbd1f6df7eaba260cbf8a1291c581f233e799e838662ce07941cafba48798a6b43d41f20bfbf693a14fe5c33a
+  metadata.gz: 5e10be74cad42b0c28d455d2dca57c9dad75a3cc8e6f3d85436c7c2f8af64361afcd926595d00005339a7c3c720f1408630cb0b155e39a658215f8ee4ccdbb87
+  data.tar.gz: 2ca984e2587912994d06f0ca7d779c6b3fa2acb96730769e3928c423750e8285706814ec4529e68b7668df9cf9e234e599f2bf7638d3da3dd504fcd2d47a5024

data/CHANGELOG.md ADDED

@@ -0,0 +1,8 @@
+# Version 0.1.1
+* Check for the existence of the LICENSE.md file in the root of the measures
+# Version 0.1
+* Initial release of the OpenStudio Tester Gem.

data/LICENSE.md CHANGED

@@ -1,13 +1,28 @@
 OpenStudio(R), Copyright (c) 2008-2018, 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:
+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.
+(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.
+(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.
+(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.
+(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 HOLDERS AND 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, THE UNITED STATES GOVERNMENT, OR ANY CONTRIBUTORS 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.
+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.

data/README.md CHANGED

@@ -1,6 +1,7 @@
-# OpenStudio Measure Tester
+# OpenStudio® Measure Tester
-[![Build Status](https://travis-ci.org/NREL/OpenStudio-measure-tester-gem.svg?branch=master)](https://travis-ci.org/NREL/OpenStudio-measure-tester-gem)
+[![Build Status](https://travis-ci.org/NREL/OpenStudio-measure-tester-gem.svg?branch=develop)](https://travis-ci.org/NREL/OpenStudio-measure-tester-gem)
+[![Gem Version](https://badge.fury.io/rb/openstudio_measure_tester.svg)](https://badge.fury.io/rb/openstudio_measure_tester)
 The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing OpenStudio measures.
@@ -17,7 +18,7 @@ The OpenStudio Measure Tester is a rubygem that exposes rake tasks for testing O
         # or
-        gem 'openstudio_measure_tester', path: '../<path-to-checkout'
+        gem 'openstudio_measure_tester', path: '../<path-to-checkout>'
         ```
     * Rakefile

data/lib/openstudio_measure_tester/core_ext.rb CHANGED

@@ -29,10 +29,10 @@
 class String
   def to_snakecase
     r = gsub(/::/, '/')
-      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-      .tr('-', '_')
-      .downcase
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
     r.gsub!('energy_plus', 'energyplus')
     r.gsub!('open_studio', 'openstudio')
     r
@@ -67,3 +67,12 @@ class String
     r
   end
 end
+# Extend the Git log to add an empty method - for rubocop autocorrect happiness.
+module Git
+  class Log
+    def empty?
+      size.zero? # rubocop:disable Style/ZeroLengthPredicate
+    end
+  end
+end

data/lib/openstudio_measure_tester/coverage.rb CHANGED

@@ -47,7 +47,6 @@ module OpenStudioMeasureTester
       @measure_coverages = {}
       parse_results
     end
     def parse_results
@@ -76,8 +75,8 @@ module OpenStudioMeasureTester
       end
       measure_names.each do |measure_name|
-        #cn = ''
-        results = coverage_results['coverage'].select {|key, _data| key.include? measure_name}
+        cn = ''
+        results = coverage_results['coverage'].select { |key, _data| key.include? measure_name }
         mhash = {}
         mhash['total_lines'] = 0
@@ -93,29 +92,27 @@ module OpenStudioMeasureTester
           fhash['total_lines'] = data.size
           # get the class name
-          # if fhash['name'] == 'measure.rb'
-          #   unless File.exist? key
-          #     # magically try to find the path name by dropping the first element of array
-          #     puts "Trying to determine the file path of unknown measure #{key}"
-          #     until File.exist?(key) || key.split('/').size == 0
-          #       key = key.split('/')[1..-1].join('/')
-          #     end
-          #   end
-          #   # file should exist now
-          #   File.readlines(key).each do |line|
-          #     if (line.include? 'class') && line.split(' ')[0] == 'class'
-          #       cn = line.split(' ')[1]
-          #       break
-          #     end
-          #   end
-          # end
+          if fhash['name'] == 'measure.rb'
+            unless File.exist? key
+              # magically try to find the path name by dropping the first element of array
+              puts "Trying to determine the file path of unknown measure #{key}"
+              key = key.split('/')[1..-1].join('/') until File.exist?(key) || key.split('/').empty?
+            end
+            # file should exist now
+            File.readlines(key).each do |line|
+              if (line.include? 'class') && line.split(' ')[0] == 'class'
+                cn = line.split(' ')[1].gsub /_?[tT]est\z/, ''
+                break
+              end
+            end
+          end
           mhash['total_lines'] += fhash['total_lines']
           # remove nils from array
           data.delete(nil)
-          cov = data.count {|x| x > 0}
+          cov = data.count { |x| x > 0 }
           fhash['percent_coverage'] = ((cov.to_f / data.size.to_f) * 100).round(2)
           fhash['missed_lines'] = data.size - cov
           fhash['relevant_lines'] = data.size
@@ -127,16 +124,13 @@ module OpenStudioMeasureTester
           mhash['missed_lines'] += fhash['missed_lines']
           mhash['files'] << fhash
         end
         mhash['percent_coverage'] = (mhash['covered_lines'].to_f / mhash['relevant_lines'].to_f * 100).round(2)
-        #@measure_coverages[cn] = mhash
-        @measure_coverages[measure_name] = mhash
+        @measure_coverages[cn] = mhash
         @total_lines += mhash['total_lines']
         @total_relevant_lines += mhash['relevant_lines']
         @total_covered_lines += mhash['covered_lines']
         @total_missed_lines += mhash['missed_lines']
       end
       # pp @measure_coverages
@@ -146,11 +140,10 @@ module OpenStudioMeasureTester
         @total_percent_coverage = (@total_covered_lines.to_f / lines.to_f * 100).round(2)
       end
       pp "Total Coverage: #{@total_percent_coverage}"
     end
     def to_hash
-      results = {};
+      results = {}
       results['total_percent_coverage'] = @total_percent_coverage
       results['total_lines'] = @total_lines
       results['total_relevant_lines'] = @total_relevant_lines
@@ -168,7 +161,5 @@ module OpenStudioMeasureTester
         file << JSON.pretty_generate(res_hash)
       end
     end
   end
-end
+end

data/lib/openstudio_measure_tester/dashboard.rb CHANGED

@@ -1,4 +1,4 @@
-require "erb"
+require 'erb'
 module OpenStudioMeasureTester
   class Dashboard
     attr_reader :html
@@ -15,7 +15,7 @@ module OpenStudioMeasureTester
     end
     def render
-      rendered = ERB.new(@template, 0, "", "@html").result( binding )
+      rendered = ERB.new(@template, 0, '', '@html').result(binding)
       save_dir = "#{@base_dir}/test_results/dashboard"
       # Render the dashboard
@@ -26,8 +26,8 @@ module OpenStudioMeasureTester
       # KAF: for some reason, not overwriting the files.  delete them from destination first
       FileUtils.remove_dir("#{save_dir}/css") if Dir.exist?"#{save_dir}/css"
       FileUtils.remove_dir("#{save_dir}/js") if Dir.exist? "#{save_dir}/js"
-      FileUtils.cp_r("#{resource_path}/css", "#{save_dir}/css", :remove_destination => true )
-      FileUtils.cp_r("#{resource_path}/js", "#{save_dir}/js", :remove_destination => true )
+      FileUtils.cp_r("#{resource_path}/css", "#{save_dir}/css", remove_destination: true)
+      FileUtils.cp_r("#{resource_path}/js", "#{save_dir}/js", remove_destination: true)
     end
   end
 end

data/lib/openstudio_measure_tester/minitest_result.rb CHANGED

@@ -52,7 +52,6 @@ module OpenStudioMeasureTester
       parse_results
       to_file
     end
     def parse_results
@@ -60,9 +59,9 @@ module OpenStudioMeasureTester
         puts "Parsing minitest report #{file}"
         hash = Hash.from_xml(File.read(file))
-        #pp hash
+        # pp hash
-        measure_name = file.split('/')[-1].split('.')[0].split('-')[1]
+        measure_name = file.split('/')[-1].split('.')[0].split('-')[1].gsub /-?[tT]est\z/, ''
         mhash = {}
@@ -75,7 +74,7 @@ module OpenStudioMeasureTester
         # Note: only 1 failure and 1 error possible per test
         errors, failures = parse_measure(hash)
-        mhash['issues'] = {errors: errors, failures: failures}
+        mhash['issues'] = { errors: errors, failures: failures }
         @measure_results[measure_name] = mhash
@@ -84,13 +83,11 @@ module OpenStudioMeasureTester
         @total_errors += mhash['measure_errors']
         @total_failures += mhash['measure_failures']
         @total_skipped += mhash['measure_skipped']
       end
       @error_status = true if @total_errors > 0
-      #pp measure_results
+      # pp measure_results
     end
     def to_file
@@ -115,7 +112,6 @@ module OpenStudioMeasureTester
     private
     def parse_measure(measure)
       errors = []
       failures = []
@@ -138,7 +134,6 @@ module OpenStudioMeasureTester
       end
       return errors, failures
     end
   end
 end

data/lib/openstudio_measure_tester/openstudio_style.rb CHANGED

@@ -32,90 +32,76 @@ module OpenStudioMeasureTester
     attr_reader :measure_messages
     CHECKS = [
-        {
-            regex: /OpenStudio::Ruleset::ModelUserScript/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::ModelUserScript is deprecated, use OpenStudio::Measure::ModelMeasure instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /OpenStudio::Ruleset::OSRunner/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::OSRunner is deprecated, use OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new) instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /OpenStudio::Ruleset::OSRunner/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::OSRunner is deprecated, use OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new) instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :test
-        }, {
-            regex: /OpenStudio::Ruleset::OSArgumentVector/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::OSArgumentVector is deprecated, use OpenStudio::Measure::OSArgumentVector instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /OpenStudio::Ruleset::OSArgument/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::OSArgument is deprecated, use OpenStudio::Measure::OSArgument instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /OpenStudio::Ruleset::OSArgumentMap/,
-            check_type: :if_exists,
-            message: 'OpenStudio::Ruleset::OSArgumentMap is deprecated, use OpenStudio::Measure.convertOSArgumentVectorToMap(arguments) instead.',
-            type: :deprecated,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /def description(.*?)end/m,
-            check_type: :if_missing,
-            message: '\'def description\' is missing.',
-            type: :syntax,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /def modeler_description(.*?)end/m,
-            check_type: :if_missing,
-            message: '\'def modeler_description\' is missing.',
-            type: :syntax,
-            severity: :error,
-            file_type: :measure
-        }, {
-            regex: /require .openstudio_measure_tester\/test_helper./,
-            check_type: :if_missing,
-            message: "Must include 'require 'openstudio_measure_tester/test_helper'' in Test file to report coverage correctly.",
-            type: :syntax,
-            severity: :error,
-            file_type: :test
-        }, {
-            regex: /MiniTest::Unit::TestCase/,
-            check_type: :if_exists,
-            message: "MiniTest::Unit::TestCase is deprecated. Use MiniTest::Test.",
-            type: :syntax,
-            severity: :warning,
-            file_type: :test
-        }, {
-            regex: /require .openstudio\/ruleset  /,
-            check_type: :if_exists,
-            message: "Require openstudio/ruleset/* is deprecated. Use require 'openstudio/measure/*'",
-            type: :syntax,
-            severity: :warning,
-            file_type: :test
-        }
+      {
+        regex: /OpenStudio::Ruleset::ModelUserScript/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::ModelUserScript is deprecated, use OpenStudio::Measure::ModelMeasure instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :measure
+      }, {
+        regex: /OpenStudio::Ruleset::OSRunner/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::OSRunner is deprecated, use OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new) instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :measure
+      }, {
+        regex: /OpenStudio::Ruleset::OSRunner/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::OSRunner is deprecated, use OpenStudio::Measure::OSRunner.new(OpenStudio::WorkflowJSON.new) instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :test
+      }, {
+        regex: /OpenStudio::Ruleset::OSArgumentVector/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::OSArgumentVector is deprecated, use OpenStudio::Measure::OSArgumentVector instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :measure
+      }, {
+        regex: /OpenStudio::Ruleset::OSArgument/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::OSArgument is deprecated, use OpenStudio::Measure::OSArgument instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :measure
+      }, {
+        regex: /OpenStudio::Ruleset::OSArgumentMap/,
+        check_type: :if_exists,
+        message: 'OpenStudio::Ruleset::OSArgumentMap is deprecated, use OpenStudio::Measure.convertOSArgumentVectorToMap(arguments) instead.',
+        type: :deprecated,
+        severity: :error,
+        file_type: :measure
+      }, {
+        regex: /require .openstudio_measure_tester\/test_helper./,
+        check_type: :if_missing,
+        message: "Must include 'require 'openstudio_measure_tester/test_helper'' in Test file to report coverage correctly.",
+        type: :syntax,
+        severity: :error,
+        file_type: :test
+      }, {
+        regex: /MiniTest::Unit::TestCase/,
+        check_type: :if_exists,
+        message: 'MiniTest::Unit::TestCase is deprecated. Use MiniTest::Test.',
+        type: :syntax,
+        severity: :warning,
+        file_type: :test
+      }, {
+        regex: /require .openstudio\/ruleset  /,
+        check_type: :if_exists,
+        message: "Require openstudio/ruleset/* is deprecated. Use require 'openstudio/measure/*'",
+        type: :syntax,
+        severity: :warning,
+        file_type: :test
+      }
     ].freeze
     # Pass in the measures_glob with the filename (typically measure.rb)
     def initialize(measures_glob)
       @measures_glob = measures_glob
-      @results = {by_measure: {}}
+      @results = { by_measure: {} }
       # Individual measure messages
       @measure_messages = []
@@ -158,6 +144,12 @@ module OpenStudioMeasureTester
         measure_missing = true
       end
+      # Test the existence of LICENSE.md
+      unless File.exist? "#{measure_dir}/LICENSE.md"
+        log_message("Could not find LICENSE.md in '#{measure_dir}'.", :general, :warning)
+      end
       unless measure_missing
         measure = OpenStudio::BCLMeasure.load(measure_dir)
         if measure.empty?
@@ -181,23 +173,25 @@ module OpenStudioMeasureTester
       # pp @measure_messages
       # calculate the info, warnings, errors and return the measure data
       # TODO: break out the issues by file
       return {
-          @measure_classname.to_sym => {
-              measure_info: @measure_messages.nil? ? 0 : @measure_messages.count{|h| h[:severity] == :info},
-              measure_warnings: @measure_messages.nil? ? 0 : @measure_messages.count{|h| h[:severity] == :warning},
-              measure_errors: @measure_messages.nil? ? 0 : @measure_messages.count{|h| h[:severity] == :error},
-              issues: @measure_messages.clone
-          }
+        @measure_classname.to_sym => {
+          measure_info: @measure_messages.nil? ? 0 : @measure_messages.count { |h| h[:severity] == :info },
+          measure_warnings: @measure_messages.nil? ? 0 : @measure_messages.count { |h| h[:severity] == :warning },
+          measure_errors: @measure_messages.nil? ? 0 : @measure_messages.count { |h| h[:severity] == :error },
+          issues: @measure_messages.clone
+        }
       }
     end
     def log_message(message, type = :syntax, severity = :info)
       new_message = {
-          message: message,
-          type: type,
-          severity: severity
+        message: message,
+        type: type,
+        severity: severity
       }
       @measure_messages << new_message
     end
@@ -219,7 +213,7 @@ module OpenStudioMeasureTester
     def save_results
       FileUtils.mkdir 'openstudio_style' unless Dir.exist? 'openstudio_style'
-      File.open("openstudio_style/openstudio_style.json", 'w') do |file|
+      File.open('openstudio_style/openstudio_style.json', 'w') do |file|
         file << JSON.pretty_generate(@results)
       end
     end
@@ -320,7 +314,7 @@ module OpenStudioMeasureTester
       end
       if measure_hash[:values_from_file][:name] != measure_hash[:name]
-        log_message("Measure class as snake_case name does not match <name> in XML. Run openstudio measure -u .", :structure, :error)
+        log_message('Measure class as snake_case name does not match <name> in XML. Run openstudio measure -u .', :structure, :error)
       end
       if measure_hash[:values_from_file][:description].empty?
@@ -352,12 +346,12 @@ module OpenStudioMeasureTester
     def get_attributes_from_measure(measure_dir, class_name)
       result = {
-          values_from_file: {
-              name: '',
-              display_name: '',
-              description: '',
-              modeler_description: ''
-          }
+        values_from_file: {
+          name: '',
+          display_name: '',
+          description: '',
+          modeler_description: ''
+        }
       }
       begin
@@ -408,7 +402,7 @@ module OpenStudioMeasureTester
       result[:description] = measure.description
       result[:modeler_description] = measure.modelerDescription
       result[:tags] = []
-      measure.tags.each {|tag| result[:tags] << tag}
+      measure.tags.each { |tag| result[:tags] << tag }
       result[:outputs] = []
       begin
@@ -431,15 +425,15 @@ module OpenStudioMeasureTester
       measure.attributes.each do |a|
         value_type = a.valueType
         if value_type == 'Boolean'.to_AttributeValueType
-          attributes << {name: a.name, display_name: a.displayName(true).get, value: a.valueAsBoolean}
+          attributes << { name: a.name, display_name: a.displayName(true).get, value: a.valueAsBoolean }
         elsif value_type == 'Double'.to_AttributeValueType
-          attributes << {name: a.name, display_name: a.displayName(true).get, value: a.valueAsDouble}
+          attributes << { name: a.name, display_name: a.displayName(true).get, value: a.valueAsDouble }
         elsif value_type == 'Integer'.to_AttributeValueType
-          attributes << {name: a.name, display_name: a.displayName(true).get, value: a.valueAsInteger}
+          attributes << { name: a.name, display_name: a.displayName(true).get, value: a.valueAsInteger }
         elsif value_type == 'Unsigned'.to_AttributeValueType
-          attributes << {name: a.name, display_name: a.displayName(true).get, value: a.valueAsUnsigned}
+          attributes << { name: a.name, display_name: a.displayName(true).get, value: a.valueAsUnsigned }
         elsif value_type == 'String'.to_AttributeValueType
-          attributes << {name: a.name, display_name: a.displayName(true).get, value: a.valueAsString}
+          attributes << { name: a.name, display_name: a.displayName(true).get, value: a.valueAsString }
         end
       end
       result[:attributes] = attributes
@@ -484,9 +478,9 @@ module OpenStudioMeasureTester
         elsif type == 'Choice'.to_OSArgumentType
           arg[:default_value] = argument.defaultValueAsString if argument.hasDefaultValue
           arg[:choice_values] = []
-          argument.choiceValues.each {|value| arg[:choice_values] << value}
+          argument.choiceValues.each { |value| arg[:choice_values] << value }
           arg[:choice_display_names] = []
-          argument.choiceValueDisplayNames.each {|value| arg[:choice_display_names] << value}
+          argument.choiceValueDisplayNames.each { |value| arg[:choice_display_names] << value }
         elsif type == 'Path'.to_OSArgumentType
           arg[:default_value] = argument.defaultValueAsPath.to_s if argument.hasDefaultValue

data/lib/openstudio_measure_tester/openstudio_testing_result.rb CHANGED

@@ -39,16 +39,25 @@ module OpenStudioMeasureTester
       @results = {}
       # get the repository info
+      # TODO add failsafe
       g = Git.open(Dir.pwd)
       config = g.config
-      repo_name = config['remote.origin.url'].split('/')[1].split('.')[0]
-      current_branch = g.branch.name
-      @results['repo_name'] = repo_name
-      @results['current_branch'] = current_branch
-      # TODO add failsafe
+      repo_name = config['remote.origin.url'] ? config['remote.origin.url'].split('/').last.chomp('.git') : nil
+      current_branch = g.branch.name ? g.branch.name : nil
+      logs = g.log
+      sha = nil
+      if !logs.empty?
+        sha = logs.first.sha
+      end
       # check if the results data already exist, and if so, then load the file now to keep the results
       load_results
+      # add/overwrite repo info in results
+      @results['repo_name'] = repo_name
+      @results['current_branch'] = current_branch
+      @results['sha'] = sha
       aggregate_results
     end
@@ -61,7 +70,7 @@ module OpenStudioMeasureTester
           FileUtils.mv "#{@results_dir}/coverage", "#{@test_results_dir}/."
           cov = OpenStudioMeasureTester::Coverage.new("#{@test_results_dir}/coverage")
-          @results["coverage"] = cov.to_hash
+          @results['coverage'] = cov.to_hash
         end
         # minitest
@@ -110,7 +119,7 @@ module OpenStudioMeasureTester
       filename = "#{@test_results_dir}/combined_results.json"
       begin
         @results = JSON.parse(File.read(filename)) if File.exist? filename
-      rescue
+      rescue StandardError
         @results = {}
       end
     end
@@ -164,4 +173,3 @@ module OpenStudioMeasureTester
     end
   end
 end

data/lib/openstudio_measure_tester/rubocop_result.rb CHANGED

@@ -47,7 +47,6 @@ module OpenStudioMeasureTester
     attr_reader :by_measure
     def initialize(path_to_results)
       @path_to_results = path_to_results
       @error_status = false
       @total_files = 0
@@ -63,7 +62,6 @@ module OpenStudioMeasureTester
       parse_results
       to_file
     end
     def parse_results
@@ -72,14 +70,19 @@ module OpenStudioMeasureTester
         puts "Parsing Rubocop report #{file}"
         hash = Hash.from_xml(File.read(file))
+        if hash.nil?
+          puts 'Error reporting Rubocop'
+          return
+        end
         # get measure names
         measure_names = []
-        #cn= ''
+        # cn= ''
         hash['checkstyle']['file'].each do |key, data|
           parts = key['name'].split('/')
           if parts.last == 'measure.rb'
-           name = parts[-2]
-           measure_names << name
+            name = parts[-2]
+            measure_names << name
           end
         end
@@ -87,14 +90,13 @@ module OpenStudioMeasureTester
         @total_files = hash['checkstyle']['file'].length
         measure_names.each do |measure_name|
-          #cn= ''
-          results = hash['checkstyle']['file'].select {|data| data['name'].include? measure_name }
+          cn = ''
+          results = hash['checkstyle']['file'].select { |data| data['name'].include? measure_name }
           mhash = {}
           mhash['measure_issues'] = 0
           mhash['measure_info'] = 0
-          mhash['measure_warnings'] = 0
+          mhash['measure_warnings'] = 0
           mhash['measure_errors'] = 0
           mhash['files'] = []
@@ -104,14 +106,14 @@ module OpenStudioMeasureTester
             fhash['violations'] = []
             # get the class name
-            # if fhash['file_name'] == 'measure.rb'
-            #   File.readlines(key['name']).each do |line|
-            #     if (line.include? 'class') && line.split(' ')[0] == 'class'
-            #         cn = line.split(' ')[1]
-            #         break
-            #     end
-            #   end
-            # end
+            if fhash['file_name'] == 'measure.rb'
+              File.readlines(key['name']).each do |line|
+                if (line.include? 'class') && line.split(' ')[0] == 'class'
+                  cn = line.split(' ')[1].gsub /_?[tT]est\z/, ''
+                  break
+                end
+              end
+            end
             if key['error']
               @file_issues = 0
@@ -124,28 +126,27 @@ module OpenStudioMeasureTester
               if key['error'].class == Array
                 @file_issues = key['error'].length
                 key['error'].each do |s|
-                  if s['severity'] === "info"
+                  if s['severity'] === 'info'
                     @file_info += 1
-                  elsif s['severity'] === "warning"
+                  elsif s['severity'] === 'warning'
                     @file_warnings += 1
-                  elsif s['severity'] === "error" #TODO: look up complete list of codes
+                  elsif s['severity'] === 'error' # TODO: look up complete list of codes
                     @file_errors += 1
                   end
-                  violations << {line: s['line'], column: s['column'], severity: s['severity'], message: s['message']}
+                  violations << { line: s['line'], column: s['column'], severity: s['severity'], message: s['message'] }
                 end
               end
               if key['error'].class == Hash
                 @file_issues = 1
-                if key['error']['severity'] === "info"
+                if key['error']['severity'] === 'info'
                   @file_info += 1
-                elsif key['error']['severity'] === "warning"
+                elsif key['error']['severity'] === 'warning'
                   @file_warnings += 1
-                elsif key['error']['severity'] === "error"
+                elsif key['error']['severity'] === 'error'
                   @file_errors += 1
                 end
-                violations << {line: key['error']['line'], column: key['error']['column'], severity: key['error']['severity'], message: key['error']['message']}
+                violations << { line: key['error']['line'], column: key['error']['column'], severity: key['error']['severity'], message: key['error']['message'] }
               end
               fhash['issues'] = @file_issues
@@ -153,7 +154,7 @@ module OpenStudioMeasureTester
               fhash['warning'] = @file_warnings
               fhash['error'] = @file_errors
               fhash['violations'] = violations
               mhash['measure_issues'] += @file_issues
               mhash['measure_info'] += @file_info
               mhash['measure_warnings'] += @file_warnings
@@ -161,33 +162,27 @@ module OpenStudioMeasureTester
               @total_issues += @file_issues
               @total_info += @file_info
-              @total_warnings += @file_warnings
+              @total_warnings += @file_warnings
               @total_errors += @file_errors
             end
-            mhash['files'] << fhash
+            mhash['files'] << fhash
           end
-        #@summary << mhash
-        #@by_measure[cn] = mhash
-        @by_measure[measure_name] = mhash
+          # @summary << mhash
+          @by_measure[cn] = mhash
         end
       end
       puts "total files: #{total_files}"
       puts "total issues: #{@total_issues} (#{@total_info} info, #{@total_warnings} warnings, #{@total_errors} errors)"
-      # TODO: still need to get errors ID'd
       @error_status = true if @total_errors > 0
     end
     def to_hash
-      results = {};
+      results = {}
       results['total_measures'] = @total_measures
       results['total_files'] = @total_files
       results['total_issues'] = @total_issues
@@ -206,7 +201,6 @@ module OpenStudioMeasureTester
       FileUtils.mkdir_p "#{@path_to_results}/" unless Dir.exist? "#{@path_to_results}/"
       File.open("#{@path_to_results}/rubocop.json", 'w') do |file|
         file << JSON.pretty_generate(res_hash)
       end
     end
   end

data/lib/openstudio_measure_tester/templates/dashboard.html.erb CHANGED

@@ -26,6 +26,13 @@
           <div class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center pb-2 mb-3 border-bottom">
             <h1 class="h2 accent">Overview</h1>
           </div>
+          <div class="justify-content-between align-items-center pb-2 mb-3 border-bottom">
+            <div class="row px-1">
+              <div class="col-sm-4"><span class="h5 pr-1">Repo</span><% if @hash['repo_name'] %><%= @hash['repo_name'] %><% end %></div>
+              <div class="col-sm-3"><span class="h5 pr-1">Branch</span><% if @hash['current_branch'] %><%= @hash['current_branch'] %><% end %></div>
+              <div class="col-sm-5"><span class="h5 pr-1">Commit</span><% if @hash['sha'] %><%= @hash['sha'] %><% end %></div>
+            </div>
+          </div>
           <div class="row">
             <div class="col-sm">
               <div class="card">

data/lib/openstudio_measure_tester/test_helper.rb CHANGED

@@ -28,7 +28,7 @@
 $coverage_started = false
 unless $coverage_started
-  puts "Coverage starting"
+  puts 'Coverage starting'
   require 'simplecov'
   SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
     [

data/lib/openstudio_measure_tester/version.rb CHANGED

@@ -27,5 +27,5 @@
 ########################################################################################################################
 module OpenStudioMeasureTester
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

data/openstudio_measure_tester.gemspec CHANGED

@@ -1,5 +1,5 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'openstudio_measure_tester/version'
@@ -25,11 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport', '~> 5.1.4'
   spec.add_dependency 'ci_reporter_minitest', '~> 1.0.0'
+  spec.add_dependency 'git', '~> 1.3.0'
   spec.add_dependency 'minitest', '~> 5.4.0'
   spec.add_dependency 'minitest-reporters', '~> 1.1'
   spec.add_dependency 'rake', '~> 12.3'
   spec.add_dependency 'rubocop', '~> 0.52'
   spec.add_dependency 'rubocop-checkstyle_formatter', '~> 0.4'
   spec.add_dependency 'simplecov', '~> 0.15'
-  spec.add_dependency 'git', '~> 1.3.0'
 end

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openstudio_measure_tester
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nicholas Long
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-03-03 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -150,20 +164,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
-- !ruby/object:Gem::Dependency
-  name: git
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.3.0
 description: Testing framework for OpenStudio measures
 email:
 - nicholas.long@nrel.gov
@@ -175,6 +175,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.md
 - README.md