bake-modernize 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ccc35944a73c49b82c67b6dfe17a0010f7653da8f3cf1c861915a4be1a5017
-  data.tar.gz: 885e420146d6319d69949d12da0ef15d6af06001e42b3cbfa8dcd5bdb038ee1e
+  metadata.gz: 23c20cae9dae81e435771d980f8c7944a78e818809cca3161ac428d94fd690f6
+  data.tar.gz: 1bb494fe765f62e0da2ad5b4a690e519499acc01db7e19ec66949d574cb83a7b
 SHA512:
-  metadata.gz: 5835b74331b32293a53b771ebc0c92caa9e823b8fe90156aebaca98d10c876f060d3f60f82904256a0d11e2662c4cdfa791dffde13b845cced6e4ca3adbfc721
-  data.tar.gz: 432d156c7e168cf87a0038e7f2cb4e0d28a668414438d5a4ab1a14109294048a5e9e44ee31e90a7b9f5c8746bdfd7986ff6ab6d2e4f9ed02e1545cb667d0ce14
+  metadata.gz: f287b0e61d32d6d3f9b60e6b93a796a3de8529581617691b6bfc784a5a6f30e9c7405b994736d5c0cbed774a89371431fd2b2202ec044b92705a06e981ed390c
+  data.tar.gz: e36f6ef0a58d24e8196726d732fdb2b4d09643ea299636ff66279b326e2eccd07c47ab1387c903edb03442dc540b93118b8ca811123040a6d030014e4490ee4e

data/bake/modernize/frozen_string_literal.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
 def frozen_string_literal
 	update(root: Dir.pwd)
 end

data/bake/modernize/license.rb

@@ -3,7 +3,7 @@
 # Released under the MIT License.
 # Copyright, 2022, by Samuel Williams.
 
-require 'console'
+require 'bake/modernize'
 
 LICENSE = <<~LICENSE
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -31,16 +31,15 @@ def license
 end
 
 def update(root:)
-	authors, paths = self.authors(root)
+	authorship = Bake::Modernize::License::Authorship.new
+	authorship.extract(root)
 	
 	buffer = StringIO.new
 	buffer.puts "# MIT License"
 	buffer.puts
 	
-	authors.map do |author, dates|
-		years = dates.map(&:year).uniq
-		
-		buffer.puts "Copyright, #{years.join('-')}, by #{author}.  "
+	authorship.copyrights.each do |copyright|
+		buffer.puts "#{copyright.statement}  "
 	end
 	
 	buffer.puts
@@ -50,19 +49,21 @@ def update(root:)
 		file.write(buffer.string)
 	end
 	
-	paths.each do |path, authors|
+	authorship.paths.each do |path, modifications|
 		next unless File.exist?(path)
 		
 		case path
 		when /\.rb$/
-			self.update_source_file_authors(path, authors)
+			self.update_source_file_authors(authorship, path, modifications)
 		end
 	end
 end
 
 private
 
-def update_source_file_authors(path, authors)
+def update_source_file_authors(authorship, path, modifications)
+	copyrights = authorship.copyrights_for_modifications(modifications)
+	
 	input = File.readlines(path)
 	output = []
 	
@@ -84,16 +85,14 @@ def update_source_file_authors(path, authors)
 	end
 	
 	# Remove any empty lines:
-	while input.first.chomp.empty?
+	while input.first&.chomp&.empty?
 		input.shift
 	end
 	
 	output << "# Released under the MIT License.\n"
 	
-	authors.each do |author, dates|
-		years = dates.map(&:year).uniq
-		
-		output << "# Copyright, #{years.join('-')}, by #{author}.\n"
+	copyrights.each do |copyright|
+		output << "# #{copyright.statement}\n"
 	end
 	
 	output << "\n"
@@ -104,67 +103,3 @@ def update_source_file_authors(path, authors)
 		file.puts(output)
 	end
 end
-
-def authors(root)
-	paths = {}
-	authors = {}
-	
-	total = `git rev-list --count HEAD`.to_i
-	
-	input, output = IO.pipe
-	pid = Process.spawn("git", "log", "--name-only", "--pretty=format:%ad\t%an", out: output, chdir: root)
-	
-	output.close
-	
-	progress = Console.logger.progress(self, total)
-	
-	while header = (input.readline.chomp rescue nil)
-		break if header.empty?
-		progress.increment
-		
-		date, author = header.split("\t", 2)
-		date = Date.parse(date)
-		
-		while path = (input.readline.chomp rescue nil)
-			break if path.empty?
-			
-			paths[path] ||= {}
-			paths[path][author] ||= []
-			paths[path][author] << date
-			
-			authors[author] ||= []
-			authors[author] << date
-		end
-	end
-	
-	input.close
-	Process.wait2(pid)
-	
-	paths.each do |path, authors|
-		authors.transform_values! do |dates|
-			dates.minmax
-		end
-	end
-	
-	paths.transform_values! do |authors|
-		authors.transform_values! do |dates|
-			dates.minmax
-		end
-		
-		authors.sort_by do |author, dates|
-			dates
-		end
-	end
-	
-	authors.transform_values! do |dates|
-		dates.minmax
-	end
-	
-	authors = authors.to_a
-	
-	authors.sort_by! do |author, dates|
-		dates
-	end
-	
-	return authors, paths
-end

data/lib/bake/modernize/license.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
+
+require 'rugged'
+
+module Bake
+	module Modernize
+		module License
+			class Mailmap
+				def self.for(root)
+					full_path = File.join(root, '.mailmap')
+					
+					if File.exist?(full_path)
+						mailmap = self.new
+						mailmap.extract(full_path)
+						return mailmap
+					end
+				end
+				
+				def initialize
+					@names = {}
+				end
+				
+				attr :names
+				
+				def extract(path)
+					File.open(path, 'r') do |file|
+						file.each_line do |line|
+							# Skip comments
+							next if line =~ /^#/
+							# Skip empty lines
+							next if line =~ /^\s*$/
+							# Parse line
+							# Format: Full Name <email@address>
+							line.match(/^(.*) <(.*)>$/) do |match|
+								@names[match[2]] = match[1]
+							end
+						end
+					end
+				end
+			end
+
+			class Authorship
+				Modification = Struct.new(:author, :time, :path) do
+					def full_name
+						author[:name]
+					end
+				end
+				
+				Copyright = Struct.new(:dates, :author) do
+					def <=> other
+						self.to_a <=> other.to_a
+					end
+					
+					def statement
+						years = self.dates.map(&:year).uniq
+						return "Copyright, #{years.join('-')}, by #{author}."
+					end
+				end
+				
+				def initialize
+					@paths = {}
+				end
+				
+				attr :paths
+				
+				def extract(root = Dir.pwd)
+					mailmap = Mailmap.for(root)
+					
+					walk(Rugged::Repository.discover(root), mailmap: mailmap)
+					
+					return self
+				end
+				
+				def copyrights
+					copyrights_for_modifications(@paths.values.flatten)
+				end
+				
+				def copyrights_for_path(path)
+					copyrights_for_modifications(@paths[path])
+				end
+				
+				def copyrights_for_modifications(modifications)
+					authors = modifications.group_by{|modification| modification.full_name}
+					
+					authors.map do |name, modifications|
+						Copyright.new(modifications.map(&:time).minmax, name)
+					end.sort
+				end
+				
+				private
+				
+				DEFAULT_SORT = Rugged::SORT_DATE | Rugged::SORT_TOPO | Rugged::SORT_REVERSE
+				
+				def walk(repository, mailmap: nil, show: "HEAD")
+					Rugged::Walker.walk(repository, show: show, sort: DEFAULT_SORT) do |commit|
+						diff = commit.diff
+						diff.find_similar!
+				
+						diff.each_delta do |delta|
+							old_path = delta.old_file[:path]
+							new_path = delta.new_file[:path]
+							
+							@paths[new_path] ||= []
+							
+							if old_path != new_path
+								# The file was moved, move copyright information too:
+								@paths[new_path].concat(@paths[old_path])
+							end
+							
+							author = commit.author
+							
+							if mailmap
+								if name = mailmap.names[author[:email]]
+									author[:name] = name
+								end
+							end
+							
+							@paths[new_path] << Modification.new(author, commit.time, new_path)
+						end
+					end
+				end
+			end
+		end
+	end
+end

data/lib/bake/modernize/version.rb

@@ -5,6 +5,6 @@
 
 module Bake
 	module Modernize
-		VERSION = "0.13.3"
+		VERSION = "0.14.0"
 	end
 end

data/lib/bake/modernize.rb

@@ -3,7 +3,8 @@
 # Released under the MIT License.
 # Copyright, 2020-2022, by Samuel Williams.
 
-require "bake/modernize/version"
+require_relative 'modernize/license'
+require_relative 'modernize/version'
 require 'build/files/glob'
 require 'fileutils'
 

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

@@ -1,22 +1,30 @@
 name: Documentation
 
-permissions:
-  contents: write
-
 on:
   push:
     branches:
       - main
 
+    # Allows you to run this workflow manually from the Actions tab:
+    workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages:
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment:
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
 
 env:
   CONSOLE_OUTPUT: XTerm
   BUNDLE_WITH: maintenance
 
 jobs:
-  deploy:
+  generate:
     runs-on: ubuntu-latest
     
     steps:
@@ -30,12 +38,24 @@ jobs:
     - name: Installing packages
       run: sudo apt-get install wget
     
-    - name: Prepare GitHub Pages
-      run: bundle exec bake github:pages:prepare --directory docs
-    
     - name: Generate documentation
       timeout-minutes: 5
       run: bundle exec bake utopia:project:static --force no
     
-    - name: Deploy GitHub Pages
-      run: bundle exec bake github:pages:commit --directory docs
+    - name: Upload documentation artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: docs
+  
+  deploy:
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    
+    needs: generate
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -141,6 +141,7 @@ files:
 - bake/modernize/readme.rb
 - bake/modernize/signing.rb
 - lib/bake/modernize.rb
+- lib/bake/modernize/license.rb
 - lib/bake/modernize/version.rb
 - license.md
 - readme.md