gem_toys 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48cef709e2407ff05f6d4b10a262ef20bd399f14aed89ec446f5a57790d86460
-  data.tar.gz: 2a1386e9f03dd8d818e2dd7e6ec402d502424a913f2f86e251af6a9a0f3bf151
+  metadata.gz: 9c89427d93a3acd0536e28862539e50772f24059fec9253777560e9eba89cf03
+  data.tar.gz: 88dffcbdad90618b055900461bb2b37b946acf518570e584126bfb6ce2619b49
 SHA512:
-  metadata.gz: b4113d09e6f299ccc60c2880b3aeece288b9c018c9a41d3f805d080480017c56ddbeb7e5a1c85b9c0a8533b2a19dc62b2ea892a5b10d2d0917505624ba4ad573
-  data.tar.gz: bfcf1cd7c55c5aab00d9831f7f6ba587a588d4082af9a36d4e4d82191418a09e2f3bcfeaacf1c777c6699599a1cd052bc333648f98dd0a1f660d83cd82dd8121
+  metadata.gz: bba6338814ad5bb019833a4c1acb9441a6307e555edbe73f96326bcf3f0d156ead648bdd5eef444fedad74cecc15a6e940b60fc98ee7326de8b0c04d145751b0
+  data.tar.gz: 18d291e6dd2cd6dd3b94b4cd05295274d88accf9698d5b2827d369c08e49552f82275ca27d2f2d36b6c544c4a2882ac3e37d5c42b3e4c20b17f04ba4b1a4713f

data/CHANGELOG.md

@@ -2,6 +2,36 @@
 
 ## master (unreleased)
 
+## 0.8.0 (2021-04-16)
+
+*   Add `refresh` answer for release confirmation.
+
+## 0.7.1 (2021-03-04)
+
+*   Fix error about non-renamed `version` in one of aborts.
+*   Improve Regexp for date of existing release.
+    Catch only content inside the last parentheses.
+
+## 0.7.0 (2021-03-04)
+
+*   Add `:changelog_file_name` option.
+*   Add `:version_tag_prefix` option.
+*   Change date format for `versions` tool.
+*   Add documentation about `:version_file_path` option.
+*   Split `release` tool into modules for RuboCop satisfaction.
+
+## 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.
+*   Fix error with undefined `FileUtils`.
+*   Fix error with `release` tool via updating `alt_memery` to a fixed version.
+*   Update development dependencies.
+
 ## 0.5.0 (2020-11-29)
 
 *   Add `versions` tool with `releases` alias.

data/README.md

@@ -35,7 +35,15 @@ gem install gem_toys
 ```ruby
 # .toys.rb
 require 'gem_toys'
-expand GemToys::Template
+expand GemToys::Template,
+  ## 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
 
@@ -31,6 +38,8 @@ module GemToys
 						@template = template
 
 						sh 'gem build'
+
+						require 'fileutils'
 						FileUtils.mkdir_p pkg_directory
 						FileUtils.mv "#{context_directory}/#{gem_file_name}", current_gem_file
 					end
@@ -63,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

@@ -32,7 +32,7 @@ module GemToys
 			end
 
 			memoize def changelog_file_path
-				File.join context_directory, 'CHANGELOG.md'
+				File.join context_directory, @template.changelog_file_name
 			end
 
 			memoize def gem_file_name
@@ -71,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,35 @@
 # frozen_string_literal: true
 
+require 'highline'
+
+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 +51,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,45 +101,20 @@ 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
-						@changelog_lines.insert(
-							@changelog_lines.index("#{unreleased_title}\n") + 2,
-							'#' * unreleased_title.scan(/^#+/).first.size + " #{@new_version} (#{@today})\n\n"
-						).join
-					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}"
 						$stdout.puts
-						$stdout.puts 'Please, validate files before committing and pushing!'
-						$stdout.puts 'Press anything to continue, Ctrl+C to cancel.'
-						$stdin.gets
+
+						HighLine.new.choose do |menu|
+							menu.layout = :one_line
+
+							menu.prompt = 'Are these changes correct? '
+
+							menu.choice(:yes)
+							menu.choice(:no) { abort }
+							menu.choice(:refresh) { send(__method__) }
+						end
 					end
 				end
 			end

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.scan(/\(([^()]+)\)/).last.first) == @today
+
+						abort "There is already #{new_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.5.0'
+	VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_toys
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-29 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alt_memery
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.0
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -194,6 +208,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
@@ -212,13 +228,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Toys template for gems