gem_toys 0.4.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6726b77757e83675406164f809d24df97db7c6f62ccc868fb3bf36cc10345c05
-  data.tar.gz: 3fa707cd47180bcb0783cfa4442aff662874cccdd5450287f33551b5de67c66a
+  metadata.gz: 061a23d19180942f3cb7ca6f4b43bfc5e48b5247e1ca45ec77969c0308cdf3aa
+  data.tar.gz: b57ac1d9e07c4a7f72ffaa3ff0e9d366160a47ffb2695232a7b928821ee0484c
 SHA512:
-  metadata.gz: ac8fbbde1b554d7cff6d8b05003f2529a140d89269ec43412817d4ddfc0dfa8b104ad85378ebad470207fbe9c8cae1cfc7ff7dc984c484ffad2955156139105d
-  data.tar.gz: 80708ae0701092648c7caa9f489a3477b88047ab1f5d970299e0ef8e376812b114d77656c55438b46ed863b5c376be01faf7bf1ebee90b8f158f3887abd20eda
+  metadata.gz: cec712bb01c015ba34dde170c5d7d855f56008e7234da72df02d8ed342dd9eb458ee06d7e4175e473dad213bba8f0229ca356fbc28a16ef06b42fe92186ea1b6
+  data.tar.gz: 5f0475c31feef1a52e77f59f4e30965c55401baa04fc425ca5a8864e9d6c0900d85e5fa06eac8936e2b09af0c498651e013e513cc1138b03f30e638c2678f540

data/CHANGELOG.md

@@ -2,8 +2,49 @@
 
 ## master (unreleased)
 
+## 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.
+*   Add `version` tool.
+*   Add an ability to release new `major`, `minor` or `patch` version.
+    Just specify keyword instead of number and it'll increase correctly.
+*   Print `git diff` for files which will be commited on `release`.
+*   Drop Ruby 2.4 support.
+    [Support of Ruby 2.4 has ended](https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/).
+*   Add and use `memery` dependency.
+*   Update `rubocop`, `remark`.
+
 ## 0.4.0 (2020-09-21)
 
+*   Improve version update script, support files with other String constants.
+*   Update bundle.
+
 ## 0.3.0 (2020-07-11)
 
 *   Add support for Ruby 2.4

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'date'
 require 'toys-core'
 
 require_relative 'template/common_code'
@@ -10,10 +9,17 @@ module GemToys
 	class Template
 		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: nil, unreleased_title: '## master (unreleased)')
+		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
 
@@ -32,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
@@ -46,97 +54,28 @@ module GemToys
 					end
 				end
 
-				tool :release do
-					required_arg :version
-
+				tool :version do
 					to_run do
 						@template = template
 
-						@today = Date.today.to_s
-
-						update_version_file
-
-						## Update CHANGELOG
-						update_changelog_file
-
-						## Build new gem file
-						exec_tool 'gem build'
-
-						wait_for_manual_check
-
-						## Checkout to a new git branch, required for protected `master` with CI
-						# sh "git switch -c v#{version}"
-
-						commit_changes
-
-						## Tag commit
-						puts 'Tagging the commit...'
-						sh "git tag -a v#{version} -m 'Version #{version}'"
-
-						## Push commit
-						puts 'Pushing commit...'
-						sh 'git push'
-
-						## Push tags
-						puts 'Pushing tags...'
-						sh 'git push --tags'
-
-						puts 'Pushing gem...'
-						sh "gem push #{current_gem_file}"
-					end
-
-					private
-
-					def update_version_file
-						puts 'Updating version file...'
-
-						File.write(
-							version_file_path,
-							version_file_content.sub(/(VERSION = )'.+'/, "\\1'#{version}'")
-						)
-					end
-
-					def update_changelog_file
-						puts 'Updating changelog file...'
-
-						@changelog_lines = File.readlines(changelog_file_path)
-
-						existing_line = find_version_line_in_changelog_file
-
-						if existing_line
-							return if (existing_date = existing_line.match(/\((.*)\)/)[1]) == @today
-
-							abort "There is already #{version} version with date #{existing_date}"
+						version = rubygems_versions.find(-> { current_version_hash }) do |rubygems_version|
+							rubygems_version[:number] == current_version
 						end
 
-						File.write changelog_file_path, new_changelog_content
-					end
-
-					def find_version_line_in_changelog_file
-						@changelog_lines.find { |line| line.start_with? "## #{version} " }
+						puts_versions [version]
 					end
+				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 + " #{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 #{version}'"
-					end
+				require_relative 'template/versions'
+				expand Template::Versions,
+					version_file_path: template.version_file_path
 
-					def wait_for_manual_check
-						$stdout.puts 'Please, validate files and commits before pushing.'
-						$stdin.gets
-					end
-				end
+				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
 	end

data/lib/gem_toys/template/common_code.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
+require 'memery'
+
 module GemToys
 	## Template with gem tools, should be expanded in toys file
 	class Template
 		## Module for common code between nested tools
 		module CommonCode
+			include Memery
+
 			private
 
-			def project_name
-				@project_name ||= File.basename context_directory
+			memoize def project_name
+				File.basename context_directory
 			end
 
-			def version_file_path
-				@version_file_path ||=
-					@template.version_file_path ||
+			memoize def version_file_path
+				@template.version_file_path ||
 					begin
 						project_path = project_name.tr '-', '/'
 						File.join context_directory, 'lib', project_path, 'version.rb'
@@ -24,25 +27,58 @@ module GemToys
 				File.read version_file_path
 			end
 
-			def current_version
-				@current_version ||= version_file_content.match(/VERSION = '(.+)'/)[1]
+			memoize def current_version
+				version_file_content.match(/VERSION = '(.+)'/)[1]
 			end
 
-			def changelog_file_path
-				@changelog_file_path ||= File.join context_directory, 'CHANGELOG.md'
+			memoize def changelog_file_path
+				File.join context_directory, @template.changelog_file_name
 			end
 
-			def gem_file_name
-				@gem_file_name ||= "#{project_name}-#{current_version}.gem"
+			memoize def gem_file_name
+				"#{project_name}-#{current_version}.gem"
 			end
 
-			def pkg_directory
-				@pkg_directory ||= "#{context_directory}/pkg"
+			memoize def pkg_directory
+				"#{context_directory}/pkg"
 			end
 
 			def current_gem_file
 				"#{pkg_directory}/#{gem_file_name}"
 			end
+
+			memoize def rubygems_connection
+				require 'faraday'
+				require 'faraday_middleware'
+
+				Faraday.new 'https://rubygems.org/api/v1' do |conn|
+					conn.response :json, parser_options: { symbolize_names: true }
+				end
+			end
+
+			memoize def rubygems_versions
+				rubygems_connection.get("versions/#{project_name}.json").body
+			end
+
+			def current_version_hash
+				{ number: current_version, created_at: 'unreleased' }
+			end
+
+			def puts_versions(versions)
+				require 'date'
+
+				longest_version_number = versions.map { |version| version[:number].length }.max
+
+				versions.each do |version|
+					created_at = begin
+						DateTime.parse(version[:created_at]).strftime('%F %R')
+					rescue Date::Error
+						version[:created_at]
+					end
+
+					puts "#{version[:number].ljust(longest_version_number)}  (#{created_at})"
+				end
+			end
 		end
 	end
 end

data/lib/gem_toys/template/release.rb

@@ -0,0 +1,114 @@
+# 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 :changelog_file_name, :version_file_path, :version_tag_prefix, :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
+						require 'date'
+
+						@template = template
+
+						@today = Date.today.to_s
+
+						handle_new_version
+
+						update_version_file
+
+						## Update CHANGELOG
+						update_changelog_file
+
+						## Build new gem file
+						exec_tool 'gem build'
+
+						wait_for_manual_check
+
+						## Commit, tag, push
+						process_git
+
+						puts 'Pushing gem...'
+						sh "gem push #{current_gem_file}"
+					end
+
+					private
+
+					self::VERSION_TYPES = %w[
+						major
+						minor
+						patch
+					].freeze
+
+					def handle_new_version
+						## https://github.com/dazuma/toys/issues/103
+						@new_version =
+							if (version_index = self.class::VERSION_TYPES.index(new_version))
+								current_version_parts =
+									current_version.split('.')[0..(self.class::VERSION_TYPES.count - 1)]
+								handle_keyword_in_new_version current_version_parts, version_index
+							else
+								new_version
+							end
+
+						clear_memery_cache! :current_version
+					end
+
+					def handle_keyword_in_new_version(current_version_parts, version_index)
+						current_version_parts.map.with_index do |version_part, index|
+							if index < version_index
+								version_part
+							elsif index == version_index
+								Integer(version_part) + 1
+							else
+								0
+							end
+						end.join('.')
+					end
+
+					def update_version_file
+						puts 'Updating version file...'
+
+						File.write(
+							version_file_path,
+							version_file_content.sub(/(VERSION = )'.+'/, "\\1'#{@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
+					end
+				end
+			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/template/versions.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GemToys
+	class Template
+		## Template with gem versions tool, expanding internally
+		class Versions
+			include Toys::Template
+
+			attr_reader :version_file_path
+
+			def initialize(version_file_path:)
+				@version_file_path = version_file_path
+			end
+
+			on_expand do |template|
+				tool :versions do
+					to_run do
+						@template = template
+
+						versions = rubygems_versions
+
+						versions.unshift current_version_hash if current_version != versions.first[:number]
+
+						puts_versions versions
+					end
+				end
+				alias_tool :releases, :versions
+			end
+		end
+	end
+end

data/lib/gem_toys/version.rb

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

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gem_toys
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-20 00:00:00.000000000 Z
+date: 2021-03-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: alt_memery
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +128,28 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.91.0
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 description: 'Toys template for gems, like building, releasing, etc.
 
   '
@@ -151,6 +193,10 @@ files:
 - lib/gem_toys.rb
 - 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
 licenses:
@@ -167,14 +213,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      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.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Toys template for gems