Merge pull request #204 from NREL/update_license_year_2025

update copyright year in LICENSE file

Author: anchapin

.rubocop.yml

@@ -4,8 +4,8 @@ AllCops:
     - init_templates/**/*
     - lib/measures/**/resources/*
     - lib/openstudio/extension/core/**/*
+  TargetRubyVersion: 3.2.2
 
 require: rubocop-performance
 inherit_from:
   - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml
-

CHANGELOG.md

@@ -1,4 +1,7 @@
 # OpenStudio(R) Extension Gem
+## Version 0.9.2
+* Updating LICENSE.md in doc_templates to use 2025 for the year
+* Fixed some rubocop offenses
 
 ## Version 0.9.1
 * Updating faraday to 1.10.4 to remove deprecation notice

Gemfile

@@ -1,5 +1,8 @@
 source 'http://rubygems.org'
 
+# Specify your gem's dependencies in openstudio-extension.# gemspec commented out to avoid circular dependency during bundle install
+# gemspec
+
 # Specify your gem's dependencies in openstudio-extension.gemspec
 
 # line below used for testing when need to test against branch instead of release of standards. Should be commented out prior to merge to develop
@@ -8,3 +11,5 @@ source 'http://rubygems.org'
 gemspec
 
 # gem 'openstudio-standards', '= 0.2.17.rc1', :github => 'NREL/openstudio-standards', :ref => '3.5.0_changes'
+
+gem 'rubocop-performance', '~> 1.20'

README.md

@@ -85,6 +85,7 @@ export RUBYLIB=/Applications/OpenStudio-3.1.0/Ruby
 
 |OpenStudio Extension Gem|OpenStudio|Ruby|
 |:--------------:|:----------:|:--------:|
+| 0.9.2          | 3.10     | 3.2.2  |
 | 0.8.0          | 3.8      | 3.2    |
 | 0.7.1          | 3.7      | 2.7    |
 | 0.7.0          | 3.7      | 2.7    |

doc_templates/LICENSE.md

@@ -1,4 +1,4 @@
-OpenStudio(R), Copyright (c) 2008, 2023 Alliance for Sustainable Energy, LLC.
+OpenStudio(R), Copyright (c) 2008, 2025 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:
 

lib/change_log.rb

@@ -89,10 +89,10 @@ def process
       end
     end
 
-    @closed_issues.sort! { |x, y| x.number <=> y.number }
-    @new_issues.sort! { |x, y| x.number <=> y.number }
-    @accepted_pull_requests.sort! { |x, y| x.number <=> y.number }
-    @total_open_pull_requests.sort! { |x, y| x.number <=> y.number }
+    @closed_issues.sort_by!(&:number)
+    @new_issues.sort_by!(&:number)
+    @accepted_pull_requests.sort_by!(&:number)
+    @total_open_pull_requests.sort_by!(&:number)
   rescue StandardError => e
     puts e.message
     ChangeLog.help
@@ -122,6 +122,6 @@ def print_issues
     puts "\nAccepted Pull Requests: #{@accepted_pull_requests.length}"
     @accepted_pull_requests.each { |issue| puts print_issue(issue) }
 
-    puts "\nAll Open Issues: #{@total_open_issues.length} (" + @total_open_issues.map { |issue| "\##{issue.number}" }.join(', ') + ')'
+    puts "\nAll Open Issues: #{@total_open_issues.length} (#{@total_open_issues.map { |issue| "\##{issue.number}" }.join(', ')})"
   end
 end

lib/openstudio/extension.rb

@@ -56,9 +56,10 @@ def self.all_extensions
       # DLM: consider calling Bundler.require in this method
       # do not call Bundler.require when requiring this file, only when calling this method
       result = []
-     
+
       ObjectSpace.each_object(::Class) do |obj|
         next if !obj.ancestors.include?(OpenStudio::Extension::Extension)
+
         result << obj
       end
 

lib/openstudio/extension/rake_task.rb

@@ -14,6 +14,7 @@ class RakeTask < Rake::TaskLib
       attr_accessor :name, :measures_dir, :core_dir, :doc_templates_dir, :files_dir
 
       def initialize(*args, &task_block)
+        super
         @name = args.shift || :openstudio
 
         setup_subtasks(@name)
@@ -124,11 +125,7 @@ def setup_subtasks(name)
               bcl = ::BCL::ComponentMethods.new
 
               # check for env var specifying keyword first
-              if ENV['bcl_search_keyword']
-                keyword = ENV['bcl_search_keyword']
-              else
-                keyword = 'Space'
-              end
+              keyword = ENV['bcl_search_keyword'] || 'Space'
               num_results = 10
               # bcl.search params: search_string, filter_string, return_all_results?
               puts "searching BCL measures for keyword: #{keyword}"

lib/openstudio/extension/runner.rb

@@ -9,7 +9,6 @@
 require 'open3'
 require 'openstudio'
 require 'yaml'
-require 'fileutils'
 require 'parallel'
 require 'bcl'
 
@@ -48,7 +47,7 @@ def initialize(dirname = Dir.pwd, bundle_without = [], options = {})
           runner_config = OpenStudio::Extension::RunnerConfig.new(dirname)
           # use the default values overriden with runner.conf values where not
           # nil nor empty strings
-          @options = @options.merge(runner_config.options.reject{|k, v| v.nil? || (v.kind_of?(String) && v === '')})
+          @options = @options.merge(runner_config.options.reject { |k, v| v.nil? || (v.is_a?(String) && v == '') })
         end
 
         if !options.empty?
@@ -61,8 +60,8 @@ def initialize(dirname = Dir.pwd, bundle_without = [], options = {})
         @dirname = File.absolute_path(dirname)
 
         # use passed options, otherwise assume @dirname
-        @gemfile_path = !@options.key?(:gemfile_path) || @options[:gemfile_path] === '' ? File.join(@dirname, 'Gemfile') : @options[:gemfile_path]
-        @bundle_install_path = !@options.key?(:bundle_install_path) || @options[:bundle_install_path] === '' ? File.join(@dirname, '.bundle/install/') : @options[:bundle_install_path]
+        @gemfile_path = !@options.key?(:gemfile_path) || @options[:gemfile_path] == '' ? File.join(@dirname, 'Gemfile') : @options[:gemfile_path]
+        @bundle_install_path = !@options.key?(:bundle_install_path) || @options[:bundle_install_path] == '' ? File.join(@dirname, '.bundle/install/') : @options[:bundle_install_path]
         @original_dir = Dir.pwd
 
         # gemfile directory
@@ -100,7 +99,7 @@ def initialize(dirname = Dir.pwd, bundle_without = [], options = {})
 
             # check existing config
             needs_config = true
-            if conf_bpath = Bundler.configured_bundle_path.explicit_path
+            if (conf_bpath = Bundler.configured_bundle_path.explicit_path)
               puts 'bundler config exists'
               needs_config = false
 
@@ -362,7 +361,7 @@ def list_measures(measures_dir)
         puts "#{measures.length} MEASURES FOUND"
         measures.each do |measure|
           name = measure.split('/')[-2]
-          puts name.to_s
+          puts name
         end
       end
 
@@ -497,9 +496,9 @@ def update_copyright(root_dir, doc_templates_dir)
           FileUtils.cp(File.join(doc_templates_dir, 'LICENSE.md'), File.join(root_dir, 'LICENSE.md'))
         end
 
-        ruby_regex = /^\#\s?[\#\*]{12,}.*copyright.*?\#\s?[\#\*]{12,}\s*$/mi
-        erb_regex = /^<%\s*\#\s?[\#\*]{12,}.*copyright.*?\#\s?[\#\*]{12,}\s*%>$/mi
-        js_regex = /^\/\* @preserve.*copyright.*?\*\//mi
+        ruby_regex = /^\#\s?[\#*]{12,}.*copyright.*?\#\s?[\#*]{12,}\s*$/mi
+        erb_regex = /^<%\s*\#\s?[\#*]{12,}.*copyright.*?\#\s?[\#*]{12,}\s*%>$/mi
+        js_regex = %r{^/\* @preserve.*copyright.*?\*/}mi
 
         filename = File.join(doc_templates_dir, 'copyright_ruby.txt')
         puts "Copyright file path: #{filename}"
@@ -542,14 +541,13 @@ def update_copyright(root_dir, doc_templates_dir)
           { glob: "#{root_dir}/**/*.js.erb", license: js_header_text, regex: js_regex }
         ]
         # This is the bundle deployment folder
-        excluded_subfolders = ['vendor'].map{|d| "#{root_dir}/vendor/bundle"}
-
+        excluded_subfolders = ['vendor'].map { |d| "#{root_dir}/vendor/bundle" }
 
         puts "Encoding.default_external = #{Encoding.default_external}"
         puts "Encoding.default_internal = #{Encoding.default_internal}"
 
         paths.each do |path|
-          Dir[path[:glob]].reject{|f| excluded_subfolders.any?{|d| f[d]} }.each do |dir_file|
+          Dir[path[:glob]].reject { |f| excluded_subfolders.any? { |d| f[d] } }.each do |dir_file|
             puts "Updating license in file #{dir_file}"
             f = File.read(dir_file)
             if f.match?(path[:regex])

lib/openstudio/extension/runner_config.rb

@@ -69,7 +69,7 @@ def self.default_config(dirname)
           run_simulations: true,
           verbose: false,
           gemfile_path: '',
-          bundle_install_path: get_local_bundle_config_path(dirname),
+          bundle_install_path: get_local_bundle_config_path(dirname)
         }
       end
 
@@ -81,7 +81,7 @@ def self.default_config(dirname)
       def self.init(dirname)
         runner_conf_file = File.join(dirname, FILENAME)
         if File.exist?(runner_conf_file)
-          puts "runner.conf already exists, saving a runner.conf.bak, previous config:"
+          puts 'runner.conf already exists, saving a runner.conf.bak, previous config:'
           puts File.read(runner_conf_file)
           FileUtils.cp(runner_conf_file, "#{FILENAME}.bak")
         end