gem_toys 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4618c51d0060981f796f40c91b6e746f6cc9860adcdbae6b291e9740b4f617df
-  data.tar.gz: 42efd278a9c5821c85eb776dae8f1dde46ac957d1c98842c716f5f769de313f0
+  metadata.gz: 1b8a68d7567f6698b428f46a2f69694259e066412bedb21b55eda4585b76c70b
+  data.tar.gz: 74cfd96138c6e0a10eacec2235500f775d5f02b0f3ab215f88b0c911a8cf33a2
 SHA512:
-  metadata.gz: 1a8a580cb0ec036fcd80c6c27ef1ecf289c9d87e5696d044b585bcf2ffe05c6ef22c96fee1f2836aa0f9e9f875545b2b3cb501b5d1d3b75fd4bca4edf78b5ac9
-  data.tar.gz: 0ae8062f7f01ed27afdf635dbc06a25495a6d6039470a469e6ea5213eecaa66301afce1a9561bc87bd3401822f98e5c6b2443a249926ca8d0eecf0bcf18f70cf
+  metadata.gz: 98da90d85c1cb6f361bdef8d7a0ec42d5c0ba500121f3fc9655dacb24f160f9a9c21599afb01bf9ed3672a954c9ef27df384e988b8ad382e505cb1bedb1e1cab
+  data.tar.gz: d236a46c35fcedeb008aafbb4f1836e497c39d2b001b125634a60b114b555fd567b4236aa2294b50f708869a80dd416bf1998a585494c3854ba545128a0729a4

data/CHANGELOG.md

@@ -2,8 +2,13 @@
 
 ## master (unreleased)
 
+## 0.7.0 (2021-03-04)
+
 ## 0.6.1 (2021-02-10)
 
+*   Gently abort when `unreleased_title` not found.
+*   Improve documentation about `:unreleased_title` option.
+
 ## 0.6.0 (2021-02-10)
 
 *   Support Ruby 3.

data/README.md

@@ -36,7 +36,14 @@ gem install gem_toys
 # .toys.rb
 require 'gem_toys'
 expand GemToys::Template,
-  unreleased_title: '## Unreleased' ## default is `## master (unreleased)`
+  ## default is `CHANGELOG.md`
+  changelog_file_name: 'ChangeLog.md',
+  ## default is `## master (unreleased)`
+  unreleased_title: '## Unreleased',
+  ## default is `"lib/#{project_name_with_slashes_instead_dashes}/version.rb"`
+  version_file_path: 'lib/my-awesome_gem.rb',
+  ## default is `v`, so tags are like `v4.1.0`
+  version_tag_prefix: ''
 
 # `gem` namespace created, aliases are optional, but handful
 alias_tool :g, :gem

data/lib/gem_toys/template.rb

@@ -9,10 +9,17 @@ module GemToys
 	class Template
 		include Toys::Template
 
-		attr_reader :version_file_path, :unreleased_title
-
-		def initialize(version_file_path: nil, unreleased_title: '## master (unreleased)')
+		attr_reader :changelog_file_name, :version_file_path, :version_tag_prefix, :unreleased_title
+
+		def initialize(
+			changelog_file_name: 'CHANGELOG.md',
+			version_file_path: nil,
+			version_tag_prefix: 'v',
+			unreleased_title: '## master (unreleased)'
+		)
+			@changelog_file_name = changelog_file_name
 			@version_file_path = version_file_path
+			@version_tag_prefix = version_tag_prefix
 			@unreleased_title = unreleased_title
 		end
 
@@ -65,7 +72,9 @@ module GemToys
 
 				require_relative 'template/release'
 				expand Template::Release,
+					changelog_file_name: template.changelog_file_name,
 					version_file_path: template.version_file_path,
+					version_tag_prefix: template.version_tag_prefix,
 					unreleased_title: template.unreleased_title
 			end
 		end

data/lib/gem_toys/template/common_code.rb

@@ -31,12 +31,8 @@ module GemToys
 				version_file_content.match(/VERSION = '(.+)'/)[1]
 			end
 
-			memoize def changelog_file_name
-				'CHANGELOG.md'
-			end
-
 			memoize def changelog_file_path
-				File.join context_directory, changelog_file_name
+				File.join context_directory, @template.changelog_file_name
 			end
 
 			memoize def gem_file_name
@@ -75,7 +71,7 @@ module GemToys
 
 				versions.each do |version|
 					created_at = begin
-						DateTime.parse(version[:created_at]).strftime('%b %e %Y %R')
+						DateTime.parse(version[:created_at]).strftime('%F %R')
 					rescue Date::Error
 						version[:created_at]
 					end

data/lib/gem_toys/template/release.rb

@@ -1,20 +1,33 @@
 # frozen_string_literal: true
 
+require_relative 'release/changelog'
+require_relative 'release/git'
+
 module GemToys
 	class Template
 		## Template with gem release tool, expanding internally
 		class Release
 			include Toys::Template
 
-			attr_reader :version_file_path, :unreleased_title
+			attr_reader :changelog_file_name, :version_file_path, :version_tag_prefix, :unreleased_title
 
-			def initialize(version_file_path:, unreleased_title:)
+			def initialize(
+				changelog_file_name:,
+				version_file_path:,
+				version_tag_prefix:,
+				unreleased_title:
+			)
+				@changelog_file_name = changelog_file_name
 				@version_file_path = version_file_path
+				@version_tag_prefix = version_tag_prefix
 				@unreleased_title = unreleased_title
 			end
 
 			on_expand do |template|
 				tool :release do
+					include Release::Changelog
+					include Release::Git
+
 					required_arg :new_version
 
 					to_run do
@@ -36,22 +49,8 @@ module GemToys
 
 						wait_for_manual_check
 
-						## Checkout to a new git branch, required for protected `master` with CI
-						# sh "git switch -c v#{@new_version}"
-
-						commit_changes
-
-						## Tag commit
-						puts 'Tagging the commit...'
-						sh "git tag -a v#{@new_version} -m 'Version #{@new_version}'"
-
-						## Push commit
-						puts 'Pushing commit...'
-						sh 'git push'
-
-						## Push tags
-						puts 'Pushing tags...'
-						sh 'git push --tags'
+						## Commit, tag, push
+						process_git
 
 						puts 'Pushing gem...'
 						sh "gem push #{current_gem_file}"
@@ -100,50 +99,6 @@ module GemToys
 						)
 					end
 
-					def update_changelog_file
-						puts 'Updating changelog file...'
-
-						@changelog_lines = File.readlines(changelog_file_path)
-
-						existing_line = @changelog_lines.find { |line| line.start_with? "## #{@new_version} " }
-
-						if existing_line
-							return if (existing_date = existing_line.match(/\((.*)\)/)[1]) == @today
-
-							abort "There is already #{version} version with date #{existing_date}"
-						end
-
-						File.write changelog_file_path, new_changelog_content
-					end
-
-					def new_changelog_content
-						unreleased_title = @template.unreleased_title
-
-						unreleased_title_index = @changelog_lines.index("#{unreleased_title}\n")
-
-						abort_without_unreleased_title unless unreleased_title_index
-
-						@changelog_lines.insert(
-							unreleased_title_index + 2,
-							'#' * unreleased_title.scan(/^#+/).first.size + " #{@new_version} (#{@today})\n\n"
-						).join
-					end
-
-					def abort_without_unreleased_title
-						abort <<~TEXT
-							`#{@template.unreleased_title}` not found in the `#{changelog_file_name}` as the title for unreleased changes.
-							Please, use `:unreleased_title` option if you have non-default one.
-						TEXT
-					end
-
-					def commit_changes
-						puts 'Committing changes...'
-
-						sh "git add #{version_file_path} #{changelog_file_path}"
-
-						sh "git commit -m 'Update version to #{@new_version}'"
-					end
-
 					def wait_for_manual_check
 						$stdout.puts
 						sh "git diff #{version_file_path} #{changelog_file_path}"

data/lib/gem_toys/template/release/changelog.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GemToys
+	class Template
+		class Release
+			## Helper module with methods about CHANGELOG file for `release` tool
+			module Changelog
+				private
+
+				def update_changelog_file
+					puts 'Updating changelog file...'
+
+					@changelog_lines = File.readlines(changelog_file_path)
+
+					existing_line = @changelog_lines.find { |line| line.start_with? "## #{@new_version} " }
+
+					if existing_line
+						return if (existing_date = existing_line.match(/\((.*)\)/)[1]) == @today
+
+						abort "There is already #{version} version with date #{existing_date}"
+					end
+
+					File.write changelog_file_path, new_changelog_content
+				end
+
+				def new_changelog_content
+					unreleased_title = @template.unreleased_title
+
+					unreleased_title_index = @changelog_lines.index("#{unreleased_title}\n")
+
+					abort_without_unreleased_title unless unreleased_title_index
+
+					@changelog_lines.insert(
+						unreleased_title_index + 2,
+						'#' * unreleased_title.scan(/^#+/).first.size + " #{@new_version} (#{@today})\n\n"
+					).join
+				end
+
+				def abort_without_unreleased_title
+					abort <<~TEXT
+						`#{@template.unreleased_title}` not found in the `#{@template.changelog_file_name}` as the title for unreleased changes.
+						Please, use `:unreleased_title` option if you have non-default one.
+					TEXT
+				end
+			end
+		end
+	end
+end

data/lib/gem_toys/template/release/git.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module GemToys
+	class Template
+		class Release
+			## Helper module with methods about `git` for `release` tool
+			module Git
+				private
+
+				def process_git
+					new_version_git_tag = "#{@template.version_tag_prefix}#{@new_version}"
+
+					## Checkout to a new git branch, required for protected `master` with CI
+					# sh "git switch -c #{new_version_git_tag}"
+
+					commit_changes
+
+					## Tag commit
+					puts 'Tagging the commit...'
+					sh "git tag -a #{new_version_git_tag} -m 'Version #{@new_version}'"
+
+					## Push commit
+					puts 'Pushing commit...'
+					sh 'git push'
+
+					## Push tags
+					puts 'Pushing tags...'
+					sh 'git push --tags'
+				end
+
+				def commit_changes
+					puts 'Committing changes...'
+
+					sh "git add #{version_file_path} #{changelog_file_path}"
+
+					sh "git commit -m 'Update version to #{@new_version}'"
+				end
+			end
+		end
+	end
+end

data/lib/gem_toys/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GemToys
-	VERSION = '0.6.1'
+	VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_toys
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alt_memery
@@ -194,6 +194,8 @@ files:
 - lib/gem_toys/template.rb
 - lib/gem_toys/template/common_code.rb
 - lib/gem_toys/template/release.rb
+- lib/gem_toys/template/release/changelog.rb
+- lib/gem_toys/template/release/git.rb
 - lib/gem_toys/template/versions.rb
 - lib/gem_toys/version.rb
 homepage: https://github.com/AlexWayfer/gem_toys