bake-modernize 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f92608c6a73d5f87ab1703178039a0873bda82d7d087c7ba9c7f04c095ba61b
-  data.tar.gz: 59a54e4692c2baf8f8f3666bd51cfd85e5b9d53bfb5d0b653ea56c8a382ffcb2
+  metadata.gz: b1400d55cce047ae23e05f6103b5895209c78b30900503faaea26d149b3035c9
+  data.tar.gz: 49b2ff82aaa4dbde6f6aed09166c40b8d836f60101913080339c612cdcf89638
 SHA512:
-  metadata.gz: c5703f8931e6e76c027825dd3cfa57ce8cecd2c080563cb75ec3da9e1bb462a50dd329349137f8d3ba81aca9e263a1134ceb80de451f6c236a180ac59d66cabd
-  data.tar.gz: cc4e6b075fd9d47ba6cb45bc1ec9e9568b551ee6633719dd3d2b5601f811483a4d4d89e4c43e5d669015cb8041b750b818c2f5a6d10e47a7ce804e64c837e269
+  metadata.gz: 9818500ac4ae7af1000527f9008ad4bfc202a4372e5069d5eda5d99aed1c7a89558f0a5f3ca4099420c3bc3cff0f41741c5011efd36eaca34da87517f50d76f6
+  data.tar.gz: 4900ea0f2307f4186d8b7a854a45239891d30462ac34480dba311a06c2b8cbba89230c78eca7835f1dabe90bd56d598323433b14421528285ad3c07c75ead2ee

data/bake/modernize/actions.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 require 'bake/modernize'
 require 'rugged'
@@ -29,6 +29,8 @@ def update(root:)
 	if readme_path
 		update_badges(readme_path, repository_url(root))
 	end
+	
+	system("bundle", "add", "--group", "documentation", "decode", chdir: root)
 end
 
 private
@@ -49,6 +51,13 @@ def update_filenames(root)
 	if development_path.exist?
 		FileUtils::Verbose.mv(development_path, test_path)
 	end
+	
+	# Move coverage.yaml to test-coverage.yaml
+	coverage_path = actions_root + "coverage.yaml"
+	test_coverage_path = actions_root + "test-coverage.yaml"
+	if coverage_path.exist?
+		FileUtils::Verbose.mv(coverage_path, test_coverage_path)
+	end
 end
 
 def repository_url(root)

data/bake/modernize/rubocop.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+require 'bake/modernize'
+require 'build/files/system'
+
+def rubocop
+	update(root: Dir.pwd)
+end
+
+def update(root:)
+	system("bundle", "add", "rubocop", "--group", "test", chdir: root)
+	
+	template_root = Bake::Modernize.template_path_for('rubocop')
+	Bake::Modernize.copy_template(template_root, root)
+	
+	system("bundle", "update", chdir: root)
+	system("bundle", "exec", "rubocop", chdir: root)
+end

data/bake/modernize.rb

@@ -1,8 +1,19 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2023, by Samuel Williams.
+# Copyright, 2020-2024, by Samuel Williams.
 
 def modernize
-	call('modernize:git', 'modernize:readme', 'modernize:actions', 'modernize:editorconfig', 'modernize:gemfile', 'modernize:signing', 'modernize:gemspec', 'modernize:license', 'modernize:frozen_string_literal', 'modernize:contributing')
+	call(
+		'modernize:git',
+		'modernize:readme',
+		'modernize:actions',
+		'modernize:editorconfig',
+		'modernize:gemfile',
+		'modernize:rubocop',
+		'modernize:signing',
+		'modernize:gemspec',
+		'modernize:license',
+		'modernize:contributing',
+	)
 end

data/lib/bake/modernize/license.rb

@@ -8,10 +8,13 @@ require 'yaml'
 
 module Bake
 	module Modernize
+		# Support the analysis of authorship and license details.
 		module License
 			GIT_BLAME_IGNORE_REVS = ".git-blame-ignore-revs"
 			
+			# Represents revisions to skip when analyzing authorship.
 			class SkipList
+				# Load the skip list from a directory.
 				def self.for(root)
 					full_path = File.join(root, GIT_BLAME_IGNORE_REVS)
 					
@@ -22,10 +25,14 @@ module Bake
 					end
 				end
 				
+				# Create a new skip list with the given revisions.
+				#
+				# @parameter revisions [Array(String)] The revisions to skip.
 				def initialize(revisions = [])
 					@revisions = Set.new(revisions)
 				end
 				
+				# Extract the revisions from the given path.
 				def extract(path)
 					File.open(path, 'r') do |file|
 						file.each_line do |line|
@@ -37,12 +44,15 @@ module Bake
 					end
 				end
 				
+				# Check if the given commit should be ignored.
 				def ignore?(commit)
 					@revisions.include?(commit.oid)
 				end
 			end
 			
+			# Represents a mailmap file which maps commit emails to proper names.
 			class Mailmap
+				# Load the mailmap from a directory.
 				def self.for(root)
 					full_path = File.join(root, '.mailmap')
 					
@@ -53,12 +63,15 @@ module Bake
 					end
 				end
 				
+				# Create a new, empty, mailmap.
 				def initialize
 					@names = {}
 				end
 				
+				# @attribute [Hash(String, String)] The mapping of commit emails to proper names.
 				attr :names
 				
+				# Extract the mailmap from the given path.
 				def extract(path)
 					File.open(path, 'r') do |file|
 						file.each_line do |line|
@@ -85,6 +98,7 @@ module Bake
 					\s+<(?<commit_email>[^>]+)>
 				/x
 				
+				# Extract the mailmap format from a line of input.
 				def extract_from_line(line)
 					line.match(PATTERN)
 				end
@@ -95,6 +109,7 @@ module Bake
 				# The default path is the root of the repository and for authors who have contributed to the entire repository or unspecified paths in the past.
 				DEFAULT_PATH = '.'
 				
+				# Load contributors from a directory.
 				def self.for(root)
 					full_path = File.join(root, '.contributors.yaml')
 					
@@ -104,11 +119,13 @@ module Bake
 						return contributors
 					end
 				end
-
+				
+				# Create a new, empty, contributors list.
 				def initialize
 					@contributions = []
 				end
 				
+				# Iterate over each contribution.
 				def each(&block)
 					@contributions.each do |contribution|
 						author = contribution[:author]
@@ -120,13 +137,17 @@ module Bake
 					end
 				end
 				
+				# Extract the contributors from the given path.
 				def extract(path)
 					@contributions.concat(
 						YAML.load_file(path, aliases: true, symbolize_names: true, permitted_classes: [Symbol, Date, Time])
 					)
 				end
 				
+				# @attribute [Array(Hash)] The list of paths from a given contribution.
 				def paths_for(contribution)
+					return to_enum(:paths_for, contribution) unless block_given?
+					
 					if path = contribution[:path]
 						yield path
 					# elsif paths = contribution[:paths]
@@ -138,8 +159,10 @@ module Bake
 					end
 				end
 			end
-
+			
+			# Represents the authorship of a repository.
 			class Authorship
+				# Represents a modification to a file.
 				Modification = Struct.new(:author, :time, :path, :id) do
 					def full_name
 						author[:name]
@@ -159,6 +182,7 @@ module Bake
 					end
 				end
 				
+				# Represents the copyright for an author.
 				Copyright = Struct.new(:dates, :author) do
 					def <=> other
 						self.to_a <=> other.to_a
@@ -170,14 +194,19 @@ module Bake
 					end
 				end
 				
+				# Create a new, empty, authorship.
 				def initialize
 					@paths = Hash.new{|h,k| h[k] = []}
 					@commits = Hash.new{|h,k| h[k] = []}
 				end
 				
+				# @attribute [Hash(String, Array(Modification))] The mapping of paths to modifications.
 				attr :paths
+				
+				# @attribute [Hash(String, Array(Modification))] The mapping of commits to modifications.
 				attr :commits
 				
+				# Add a modification to the authorship.
 				def add(path, author, time, id = nil)
 					modification = Modification.new(author, time, path, id)
 					
@@ -185,6 +214,7 @@ module Bake
 					@paths[path] << modification
 				end
 				
+				# Extract the authorship from the given root directory.
 				def extract(root = Dir.pwd)
 					mailmap = Mailmap.for(root)
 					skip_list = SkipList.for(root)
@@ -200,6 +230,7 @@ module Bake
 					return self
 				end
 				
+				# Authors, sorted by contribution date.
 				def sorted_authors
 					authors = Hash.new{|h,k| h[k] = 0}
 					
@@ -212,14 +243,17 @@ module Bake
 					return authors.sort_by{|k,v| [-v, k]}.map(&:first)
 				end
 				
+				# All copyrights.
 				def copyrights
 					copyrights_for_modifications(@paths.values.flatten)
 				end
 				
+				# All copyrights for a given path.
 				def copyrights_for_path(path)
 					copyrights_for_modifications(@paths[path])
 				end
 				
+				# All copyrights for a given modification.
 				def copyrights_for_modifications(modifications)
 					authors = modifications.group_by{|modification| modification.full_name}
 					

data/lib/bake/modernize/version.rb

@@ -5,6 +5,6 @@
 
 module Bake
 	module Modernize
-		VERSION = "0.25.0"
+		VERSION = "0.27.0"
 	end
 end

data/lib/bake/modernize.rb

@@ -8,16 +8,20 @@ require_relative 'modernize/version'
 require 'build/files/glob'
 require 'fileutils'
 
+# @namespace
 module Bake
+	# @namespace
 	module Modernize
 		ROOT = File.expand_path("../..", __dir__)
 		
 		TEMPLATE_ROOT = Build::Files::Path.new(ROOT) + "template"
 		
+		# Compute the template root path relative to the gem root.
 		def self.template_path_for(path)
 			TEMPLATE_ROOT + path
 		end
 		
+		# Check if the destination path is stale compared to the source path.
 		def self.stale?(source_path, destination_path)
 			if File.exist?(destination_path)
 				return !FileUtils.identical?(source_path, destination_path)
@@ -26,6 +30,10 @@ module Bake
 			return true
 		end
 		
+		# Copy files from the source path to the destination path.
+		#
+		# @parameter source_path [String] The source path.
+		# @parameter destination_path [String] The destination path.
 		def self.copy_template(source_path, destination_path)
 			glob = Build::Files::Glob.new(source_path, '**/*')
 			

data/template/actions/.github/workflows/documentation-coverage.yaml

@@ -0,0 +1,25 @@
+name: Documentation Coverage
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+  COVERAGE: PartialSummary
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "3.3"
+        bundler-cache: true
+    
+    - name: Validate coverage
+      timeout-minutes: 5
+      run: bundle exec bake decode:index:coverage lib

data/template/actions/.github/workflows/{coverage.yaml → test-coverage.yaml}

@@ -1,4 +1,4 @@
-name: Coverage
+name: Test Coverage
 
 on: [push, pull_request]
 

data/template/rubocop/.github/workflows/rubocop.yaml

@@ -0,0 +1,36 @@
+name: Test External
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  CONSOLE_OUTPUT: XTerm
+
+jobs:
+  test:
+    name: ${{matrix.ruby}} on ${{matrix.os}}
+    runs-on: ${{matrix.os}}-latest
+    
+    strategy:
+      matrix:
+        os:
+          - ubuntu
+          - macos
+        
+        ruby:
+          - "3.1"
+          - "3.2"
+          - "3.3"
+    
+    steps:
+    - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{matrix.ruby}}
+        bundler-cache: true
+    
+    - name: Run RuboCop
+      timeout-minutes: 10
+      run: bundle exec rubocop

data/template/rubocop/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  DisabledByDefault: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  EnforcedStyle: tabs
+
+Layout/InitialIndentation:
+  Enabled: true
+
+Layout/IndentationWidth:
+  Enabled: true
+  Width: 1
+
+Layout/IndentationConsistency:
+  Enabled: true
+  EnforcedStyle: normal
+
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/BeginEndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/DefEndAlignment:
+  Enabled: true
+
+Layout/CaseIndentation:
+  Enabled: true
+
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-06-28 00:00:00.000000000 Z
+date: 2024-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -121,25 +121,28 @@ files:
 - bake/modernize/contributing.rb
 - bake/modernize/contributors.rb
 - bake/modernize/editorconfig.rb
-- bake/modernize/frozen_string_literal.rb
 - bake/modernize/gemfile.rb
 - bake/modernize/gemspec.rb
 - bake/modernize/git.rb
 - bake/modernize/license.rb
 - bake/modernize/readme.rb
+- bake/modernize/rubocop.rb
 - bake/modernize/signing.rb
 - lib/bake/modernize.rb
 - lib/bake/modernize/license.rb
 - lib/bake/modernize/version.rb
 - license.md
 - readme.md
-- template/actions/.github/workflows/coverage.yaml
+- template/actions/.github/workflows/documentation-coverage.yaml
 - template/actions/.github/workflows/documentation.yaml
+- template/actions/.github/workflows/test-coverage.yaml
 - template/actions/.github/workflows/test-external.yaml
 - template/actions/.github/workflows/test.yaml
 - template/editorconfig/.editorconfig
 - template/git/.gitignore
 - template/readme/readme.md
+- template/rubocop/.github/workflows/rubocop.yaml
+- template/rubocop/.rubocop.yml
 homepage: https://github.com/ioquatix/bake-modernize
 licenses:
 - MIT

data/bake/modernize/frozen_string_literal.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
-
-def frozen_string_literal
-	update(root: Dir.pwd)
-end
-
-def update(root:)
-	Dir.glob("**/*.rb", base: root).each do |path|
-		case path
-		when /\.rb$/
-			update_source_file(path)
-		end
-	end
-end
-
-private
-
-def update_source_file(path)
-	input = File.readlines(path)
-	output = []
-	
-	# Skip the hash-bang line:
-	if input.first =~ /^\#!/
-		output.push input.shift
-	end
-	
-	options = {}
-	
-	while input.first =~ /^\#\s*(.*?):(.*)$/
-		options[$1.strip] = $2.strip
-		input.shift
-	end
-	
-	options['frozen_string_literal'] ||= 'true'
-	
-	options.each do |key, value|
-		output.push "# #{key}: #{value}"
-	end
-	
-	unless input.first&.chomp&.empty?
-		output.push "\n"
-	end
-	
-	# Add the rest of the file:
-	output.push(*input)
-	
-	File.open(path, "w") do |file|
-		file.puts(output)
-	end
-end