bake-modernize 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d9ed3838e0c1b650676239018878a1a0c45be35c7b587aad73d6f0d5ac21be
-  data.tar.gz: b86bbe7de20c897da7c0a54c5fa37be6757507a54fe85abe99c9eccb18d8044d
+  metadata.gz: 310142a997767785291aadb64e0cb29310a0776a7e1d6a5081ab5c674ea711fe
+  data.tar.gz: 944e2d7c534f5303c92f6b3564ed0777c4857d2eeb0c46877dff3bd4c8568cb2
 SHA512:
-  metadata.gz: 0bed6a9e824ef41b28ecd3b3e57c441765f9db7fcadff7a8c45384ef69cc7532713bb226af17e1ded790f35876bf0bf4f02aed46854e25fe0553aff91d75d00f
-  data.tar.gz: 7fdba301e95c47787c6dec71ce311b0a410967568771ad4b1f1349cb0ce346dc89345fd3a725a8692e51256313e83f7601850883af272d235d583915d5f5c39d
+  metadata.gz: a5366bbe5432f8c8e0c45a18a0b80457e2a48a9fdd1568336e10cd4c51c2c08c26233612ce7698fc085b93db3e48a7d79bb73586723952824dffd6c46c92d71a
+  data.tar.gz: 643d36c17ab69f94246bbcc6e5fcf986067acdfe0418cac26010bbba019659b71d318e2fa51a9393b48b195a89b835d3e99acaf1ab58872957c7ca300d23b77d

data/bake/modernize/contributing.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2023, by Samuel Williams.
+
+require 'bake/modernize'
+require 'markly'
+
+def contributing
+	update(root: Dir.pwd)
+	update_contributing(File.join(Dir.pwd, 'readme.md'))
+end
+
+def update(root:)
+	template_root = Bake::Modernize.template_path_for('contributing')
+	Bake::Modernize.copy_template(template_root, root)
+end
+
+private
+
+DEFAULT_CONTRIBUTING = <<~EOF
+We welcome contributions to this project.
+
+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.
+EOF
+
+def update_contributing(readme_path)
+	root = Markly.parse(File.read(readme_path))
+	
+	replacement = Markly.parse(DEFAULT_CONTRIBUTING)
+	
+	node = root.first_child
+	
+	while node
+		if node.type == :header && node.to_plaintext =~ /Contributing/
+			break
+		end
+		
+		node = node.next
+		return unless node
+	end
+	
+	contributing_header = node
+	node = node.next
+	
+	while node
+		next_node = node.next
+		node.delete
+		
+		node = next_node
+		
+		if next_node.nil? || node.type == :header
+			break
+		end
+	end
+	
+	node = contributing_header
+	replacement.each do |child|
+		node.insert_after(child)
+		node = child
+	end
+	
+	File.write(readme_path, root.to_markdown(width: 0))
+end

data/bake/modernize/editorconfig.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 require 'bake/modernize'
 
@@ -10,12 +10,6 @@ def editorconfig
 end
 
 def update(root:)
-	editorconfig_path = File.expand_path(".editorconfig", root)
-	
-	if File.exist?(editorconfig_path)
-		FileUtils.rm_rf(editorconfig_path)
-	end
-	
 	template_root = Bake::Modernize.template_path_for('editorconfig')
 	Bake::Modernize.copy_template(template_root, root)
 end

data/bake/modernize/git.rb

@@ -16,12 +16,33 @@ def update(root:)
 		system("git", "push", "-u", "origin", "main")
 	end
 	
+	current_gitignore_custom_lines = self.current_gitignore_custom_lines(root)
+	
 	template_root = Bake::Modernize.template_path_for('git')
 	Bake::Modernize.copy_template(template_root, root)
+	
+	if current_gitignore_custom_lines
+		File.open(File.join(root, ".gitignore"), "a") do |file|
+			file.puts
+			file.puts(current_gitignore_custom_lines)
+		end
+	end
 end
 
 private
 
+def current_gitignore_custom_lines(root)
+	gitignore_path = File.join(root, ".gitignore")
+	
+	if File.exist?(gitignore_path)
+		lines = File.readlines(gitignore_path)
+		if blank_index = lines.index{|line| line =~ /^\s*$/}
+			lines.shift(blank_index+1)
+			return lines
+		end
+	end
+end
+
 def current_branch
 	require 'open3'
 	

data/bake/modernize/license.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 require 'bake/modernize'
+require 'markly'
 
 LICENSE = <<~LICENSE
 Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -49,6 +50,8 @@ def update(root:)
 		file.write(buffer.string)
 	end
 	
+	remove_license(File.join(root, "readme.md"))
+	
 	authorship.paths.each do |path, modifications|
 		next unless File.exist?(path)
 		
@@ -108,3 +111,32 @@ def update_source_file_authors(authorship, path, modifications)
 		file.puts(output)
 	end
 end
+
+def remove_license(readme_path)
+	root = Markly.parse(File.read(readme_path))
+	
+	node = root.first_child
+	
+	while node
+		if node.type == :header && node.to_plaintext =~ /License/
+			break
+		end
+		
+		node = node.next
+		return unless node
+	end
+	
+	while node
+		next_node = node.next
+		node.delete
+		
+		node = next_node
+		
+		if next_node.nil? || node.type == :header
+			break
+		end
+	end
+	
+	File.write(readme_path, root.to_markdown(width: 0))
+end
+

data/bake/modernize.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, 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')
+	call('modernize:git', 'modernize:readme', 'modernize:actions', 'modernize:editorconfig', 'modernize:gemfile', 'modernize:signing', 'modernize:gemspec', 'modernize:license', 'modernize:frozen_string_literal', 'modernize:contributing')
 end

data/conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/lib/bake/modernize/license.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2022, by Samuel Williams.
+# Copyright, 2022-2023, by Samuel Williams.
 
 require 'rugged'
 require 'yaml'
@@ -34,13 +34,27 @@ module Bake
 							# Skip empty lines
 							next if line =~ /^\s*$/
 							# Parse line
-							# Format: Full Name <email@address>
-							line.match(/^(.*) <(.*)>$/) do |match|
-								@names[match[2]] = match[1]
+							
+							
+							user = extract_from_line(line)
+							if commit_email = user[:commit_email] and proper_name = user[:proper_name]
+								@names[commit_email] = proper_name
 							end
 						end
 					end
 				end
+				
+				# Format: Proper Name <proper@email.xx> Commit Name <commit@email.xx>
+				PATTERN = /
+					(?<proper_name>[^<]+)?
+					(\s+<(?<proper_email>[^>]+)>)?
+					(\s+(?<commit_name>[^<]+)?)?
+					\s+<(?<commit_email>[^>]+)>
+				/x
+				
+				def extract_from_line(line)
+					line.match(PATTERN)
+				end
 			end
 
 			class Contributors

data/lib/bake/modernize/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2020-2022, by Samuel Williams.
+# Copyright, 2020-2023, by Samuel Williams.
 
 module Bake
 	module Modernize
-		VERSION = "0.15.0"
+		VERSION = "0.16.0"
 	end
 end

data/readme.md

@@ -16,8 +16,10 @@ 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
+We welcome contributions to this project.
+
+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/contributing/conduct.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-modernize
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -38,7 +38,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -111,7 +111,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - bake/modernize.rb
 - bake/modernize/actions.rb
+- bake/modernize/contributing.rb
 - bake/modernize/editorconfig.rb
 - bake/modernize/frozen_string_literal.rb
 - bake/modernize/gemfile.rb
@@ -140,6 +141,7 @@ files:
 - bake/modernize/license.rb
 - bake/modernize/readme.rb
 - bake/modernize/signing.rb
+- conduct.md
 - lib/bake/modernize.rb
 - lib/bake/modernize/license.rb
 - lib/bake/modernize/version.rb
@@ -149,9 +151,10 @@ files:
 - template/actions/.github/workflows/documentation.yaml
 - template/actions/.github/workflows/test-external.yaml
 - template/actions/.github/workflows/test.yaml
+- template/contributing/conduct.md
 - template/editorconfig/.editorconfig
 - template/git/.gitignore
-- template/readme/README.md
+- template/readme/readme.md
 homepage: https://github.com/ioquatix/bake-modernize
 licenses:
 - MIT
@@ -172,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Automatically modernize parts of your project/gem.