bake-modernize 0.12.2 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8708852628f7fe5a80eb8a171632b94365fb5e69d6055ae1030fa592f063f2ba
-  data.tar.gz: ab6f411c37a31334ac3a1782cfa984b71ffece573872db866f46958d42eb9bb2
+  metadata.gz: bbf86cb6271ebbf9ed15d1909a86717bbbf62e8841c418a6f969899bece3ca76
+  data.tar.gz: 84836cfd97548092a8fe01144b94f7ffaff0c8aec0b81ecee02a8e23602c4d0c
 SHA512:
-  metadata.gz: 1ad1b00641f494861f974cfda466c02d6b09ccdf388f3082751d90778ee950d8c4ab6a1b9f75c858d90d1445939701a2ceac3734b4fd4b5fe905ef4d29e44123
-  data.tar.gz: 9ba24cbe9ae2a669c60397e98c147e4583c8c701bb2b33512aebba951e82bb1e3144e3fa2095215be561088708495aaedae21f478cc62036fd9cdd5dc0657ce3
+  metadata.gz: 1eb461c262b102a09ef679c786d2eb4aa219d4a1fd02f8c5c62ad6e28b405a8732322f08ee9276a95ec794a7afbba1ec48965d7407e93199385bfdee7664348c
+  data.tar.gz: 17fcdc0fb3d60ab8c71858c8f9b98732562bcb18842495426304f4a31fd6b518db86c0d98a8fa221ac35224f20442afae5b412392d2af81c9d5ef214c08b0350

data/bake/modernize/actions.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'bake/modernize'
 require 'rugged'

data/bake/modernize/editorconfig.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'bake/modernize'
 

data/bake/modernize/frozen_string_literal.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+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

data/bake/modernize/gemfile.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require 'bake/modernize'
 

data/bake/modernize/gemspec.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 # Rewrite the current gemspec.
 def gemspec
@@ -127,9 +131,9 @@ def directory_glob_for(spec, paths = spec.files)
 	end
 	
 	if dotfiles
-		return "Dir.glob('{#{directories.keys.join(',')}}/**/*', File::FNM_DOTMATCH, base: __dir__)"
+		return "Dir.glob(['{#{directories.keys.join(',')}}/**/*', '*.md'], File::FNM_DOTMATCH, base: __dir__)"
 	else
-		return "Dir['{#{directories.keys.join(',')}}/**/*', base: __dir__]"
+		return "Dir['{#{directories.keys.join(',')}}/**/*', '*.md', base: __dir__]"
 	end
 end
 

data/bake/modernize/git.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require 'bake/modernize'
 
@@ -11,6 +15,9 @@ def update(root:)
 		system("git", "branch", "-M", "main")
 		system("git", "push", "-u", "origin", "main")
 	end
+	
+	template_root = Bake::Modernize.template_path_for('git')
+	Bake::Modernize.copy_template(template_root, root)
 end
 
 private

data/bake/modernize/license.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
 
 require 'console'
 
@@ -27,7 +31,7 @@ def license
 end
 
 def update(root:)
-	authors = self.authors(root)
+	authors, paths = self.authors(root)
 	
 	buffer = StringIO.new
 	buffer.puts "# MIT License"
@@ -45,51 +49,113 @@ def update(root:)
 	File.open("license.md", "w") do |file|
 		file.write(buffer.string)
 	end
+	
+	paths.each do |path, authors|
+		next unless File.exist?(path)
+		
+		case path
+		when /\.rb$/
+			self.update_source_file_authors(path, authors)
+		end
+	end
 end
 
 private
 
+def update_source_file_authors(path, authors)
+	input = File.readlines(path)
+	output = []
+	
+	if input.first =~ /^\#!/
+		output.push 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"
+	
+	authors.each do |author, dates|
+		years = dates.map(&:year).uniq
+		
+		output << "# Copyright, #{years.join('-')}, by #{author}.\n"
+	end
+	
+	output << "\n"
+	
+	output.concat(input)
+	
+	File.open(path, "w") do |file|
+		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
@@ -99,6 +165,6 @@ def authors(root)
 	authors.sort_by! do |author, dates|
 		dates
 	end
-
-	return authors
+	
+	return authors, paths
 end

data/bake/modernize/readme.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2022, by Samuel Williams.
 
 require 'bake/modernize'
 require 'build/files/system'

data/bake/modernize/signing.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021-2022, by Samuel Williams.
 
 require 'bake/modernize'
 

data/bake/modernize.rb

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

data/lib/bake/modernize/version.rb

@@ -1,25 +1,10 @@
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 module Bake
 	module Modernize
-		VERSION = "0.12.2"
+		VERSION = "0.13.2"
 	end
 end

data/lib/bake/modernize.rb

@@ -1,22 +1,7 @@
-# Copyright, 2020, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2020-2022, by Samuel Williams.
 
 require "bake/modernize/version"
 require 'build/files/glob'

data/license.md

@@ -0,0 +1,22 @@
+# MIT License
+
+Copyright, 2020-2022, by Samuel Williams.  
+Copyright, 2021-2022, by Olle Jonsson.  
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/readme.md

@@ -0,0 +1,23 @@
+# Bake Modernize
+
+A gem for modernizing files in your Ruby project.
+
+[![Development Status](https://github.com/ioquatix/bake-modernize/workflows/Test/badge.svg)](https://github.com/ioquatix/bake-modernize/actions?workflow=Test)
+
+## Usage
+
+Ensure your project is backed up (e.g. using git).
+
+``` ruby
+$ bake modernize
+```
+
+It will modernize your project.
+
+## Contributing
+
+1.  Fork it
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+4.  Push to the branch (`git push origin my-new-feature`)
+5.  Create new Pull Request

data/template/git/.gitignore

@@ -0,0 +1,5 @@
+/.bundle/
+/pkg/
+/gems.locked
+/.covered.db
+/external

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.2
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2022-08-18 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -133,6 +133,7 @@ files:
 - bake/modernize.rb
 - bake/modernize/actions.rb
 - bake/modernize/editorconfig.rb
+- bake/modernize/frozen_string_literal.rb
 - bake/modernize/gemfile.rb
 - bake/modernize/gemspec.rb
 - bake/modernize/git.rb
@@ -141,11 +142,14 @@ files:
 - bake/modernize/signing.rb
 - lib/bake/modernize.rb
 - lib/bake/modernize/version.rb
+- license.md
+- readme.md
 - template/actions/.github/workflows/coverage.yaml
 - template/actions/.github/workflows/documentation.yaml
 - template/actions/.github/workflows/test-external.yaml
 - template/actions/.github/workflows/test.yaml
 - template/editorconfig/.editorconfig
+- template/git/.gitignore
 - template/readme/README.md
 homepage: https://github.com/ioquatix/bake-modernize
 licenses: