bake-modernize 0.62.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b8c84fb38c24a7df3e697bde00f9e28d5725ff4435c36bc1943c3f3d9639e57
-  data.tar.gz: b1b37a9bb7567882ef2bf29ea5341e2f655a71753bfdb8ae83ef8932b492fc4a
+  metadata.gz: f1285a821430d0892953c2d45e86f8e5d11fe8d27d8212614ddb87914599370c
+  data.tar.gz: f1c4f3edb34b0bbecc4b5cada2286f2572173db3d168d21aa0fd8193dcb60b79
 SHA512:
-  metadata.gz: bcf556c3cc4c36c933fb83cec422ab2d11571ba92d548574f076caad8a6bc7738f501490edea101fb9420ea66d1ad6e76da47d0b1bc14424d115a443195d394b
-  data.tar.gz: 141b31cac4965846e143316b60065c32ad8a282d4e82c9d63287ebbf4be83f488ae90fcea489fb3e4a59c7c5d9eb01a2b0a3a569ff939e9c16ae2c59e3da9fb1
+  metadata.gz: f75c658d10774d709155f72b2933bcd818cad028d2cff2c80071b1b09f46e9caa3fccc82e3503d988d29d410dd08027887d4bba51d6ace5a5abd4931d2b08434
+  data.tar.gz: 35962d24b690a376da309acf3608817cee9340e1d330cf11a589153c445387e1a4e9e390d6b0836b021e5bb9f212878c7eb4a60bcdeedacb28fdce7ca23b0252

checksums.yaml.gz.sig

@@ -1 +1,4 @@
-`����J?0��zp��s���z���6q�K�S�����Z[��$ɧ����ߌ3Q9���A��ϐɘ���;�\7i����m�W?��g�$�Z��n�Q�E�H�
N��-؆j(�j��j���14����[�%��15��f�젓]/6�˾c�ԣ�s��� 2
��͇�dwb��p
+'O�v���Ej6ޗZjR�XKy���ښK�ݖr���b4�$_op�2��&m^՝B����y�)�&~W�9y߭�x+�	
+�����������1�^a�u)�]��C�c�O'�)%�>����F7��߈�����H.��MU2�vri��}S⃯M�B����m0T��˦.���`���z�"�q��V1_5���B�?�g��!�3{���~��+�Q
+d_��f1�#}u�j�T藯�����2 ���V�\m���
+9G4֎P1ݨ�cL���B��;$휕B��_8�v_�������E���S@|�o��h�Ir��)����

data/bake/modernize/license.rb

@@ -66,50 +66,7 @@ private
 
 def update_source_file_authors(authorship, path, modifications)
 	copyrights = authorship.copyrights_for_modifications(modifications)
-	
-	input = File.readlines(path)
-	output = []
-	
-	if input.first =~ /^\#!/
-		output.push input.shift
-	end
-	
-	# Drop any old copyright statements.
-	while input.first =~ /Copyright/i
-		input.shift
-	end
-	
-	if input.first =~ /^\#.*?\:/
-		output.push input.shift
-		if input.first.chomp.empty?
-			input.shift
-		end
-		output << "\n"
-	end
-	
-	# Remove any existing license:
-	while input.first =~ /^#.*$/
-		input.shift
-	end
-	
-	# Remove any empty lines:
-	while input.first&.chomp&.empty?
-		input.shift
-	end
-	
-	output << "# Released under the MIT License.\n"
-	
-	copyrights.each do |copyright|
-		output << "# #{copyright.statement}\n"
-	end
-	
-	output << "\n"
-	
-	output.concat(input)
-	
-	File.open(path, "w") do |file|
-		file.puts(output)
-	end
+	Bake::Modernize::License::SourceFile.update(path, copyrights: copyrights.map(&:statement))
 end
 
 def remove_license(readme_path)

data/lib/bake/modernize/license.rb

@@ -12,6 +12,55 @@ module Bake
 		module License
 			GIT_BLAME_IGNORE_REVS = ".git-blame-ignore-revs"
 			
+			# Updates Ruby source headers without removing documentation comments.
+			class SourceFile
+				MAGIC_COMMENT = /\A#\s*(?:-\*-\s*)?(?:coding|encoding|frozen_string_literal|warn_indent|shareable_constant_value)\s*[:=]/i
+				LICENSE_COMMENT = /\A#\s*(?:Released under\b|Copyright\b|SPDX-License-Identifier:)/i
+				
+				# Replace the license and copyright header for a Ruby source file.
+				# @parameter path [String] The source file path.
+				# @parameter copyrights [Array(String)] The copyright statements to write.
+				def self.update(path, copyrights:)
+					input = File.readlines(path)
+					prefix = []
+					
+					prefix << input.shift if input.first&.start_with?("#!")
+					while input.first&.match?(MAGIC_COMMENT)
+						prefix << input.shift
+					end
+					
+					# Keep the complete leading comment block, removing only known license metadata.
+					documentation = []
+					while line = input.first
+						break unless line.match?(/\A\s*#/) || line.strip.empty?
+						
+						input.shift
+						next if line.match?(LICENSE_COMMENT)
+						
+						documentation << line
+					end
+					
+					while documentation.first&.strip&.empty?
+						documentation.shift
+					end
+					while documentation.last&.strip&.empty?
+						documentation.pop
+					end
+					
+					output = prefix.dup
+					output << "\n" if output.any?
+					output << "# Released under the MIT License.\n"
+					copyrights.each do |copyright|
+						output << "# #{copyright}\n"
+					end
+					output << "\n"
+					output.concat(documentation)
+					output.concat(input)
+					
+					File.write(path, output.join)
+				end
+			end
+			
 			# Represents revisions to skip when analyzing authorship.
 			class SkipList
 				# Load the skip list from a directory.

data/lib/bake/modernize/version.rb

@@ -5,6 +5,6 @@
 
 module Bake
 	module Modernize
-		VERSION = "0.62.0"
+		VERSION = "0.63.0"
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.63.0
 platform: ruby
 authors:
 - Samuel Williams