gem_toys 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fc9bcdb919f2a0f201a81e39147393ae2fb8b3a6caa37cd38944770cef390de
-  data.tar.gz: ad694499de8f8a2db342c748ada96842cfb3396dc53ed33b35d1928ca89b078c
+  metadata.gz: 5f12dea34e3f97cd2d22bbe74577876988d63b14135f3881688adffb0aa1fe27
+  data.tar.gz: 3e7133b5a0c2b082d8108b63fcc403b86c52360c32faf4764eb569ae07052aa4
 SHA512:
-  metadata.gz: 3100babf6998a170b6d51c5e9f33a71e1e11742cd915a106d43a017190e21f9c7b629984c6729271f4f3c38f8b5024d6e696e0c448594e8ec48166edbdbcbee7
-  data.tar.gz: 36e525c0564e2685e4c404cc3f8f7aaf0ec03f04486b0fc4470bd1c69f752ddd4bd37a2ac130cf9d6701eebf9fc84747c705792a1fba261aef8a2242de737516
+  metadata.gz: 846247b5a5f1b69e4fde49feda00a66494a3ee4f6ca867dfd564723772749bcf25184560ae07e86c58f78a1b6beb07eb15562abfd925e8d58d5397a58c6916c5
+  data.tar.gz: 2587c1b34d42976accf1ef5b63b53b35ca068f4d26a89620d9ed349f215e01630d072fc520ac484b199cb264045dfc067e3ec89d644c32bcb3adda6ed1d057bf

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## master (unreleased)
 
+## 0.2.0 (2020-07-09)
+
+*   Add `:version_file_path` and `:unreleased_title` options
+*   Change the order of tasks: check (manually) before committing.
+*   Include `:exec` only unless already included.
+*   Improve usage documentation.
+*   Add output of process steps.
+
 ## 0.1.0 (2020-07-08)
 
 *   Initial commit

data/README.md

@@ -41,6 +41,20 @@ expand GemToys::Template
 alias_tool :g, :gem
 ```
 
+At invocation it will:
+
+1.  Update `lib/*gem_name*/version.rb` file.
+    Can be refined with `:version_file_path` option on `expand`.
+2.  Insert Markdown title with changes from `## master (unreleased)` in a `CHANGELOG.md` file.
+    Can be refined with `:unreleased_title` option on `expand`.
+3.  Execute `gem build`.
+4.  Ask you for manual check, if you want (print anything of OK).
+    You also can change manually a content of `CHANGELOG.md`, for example, before committing.
+5.  Commit these files.
+6.  Tag this commit with `vX.Y.Z`.
+7.  Push git commit and tag.
+8.  Push the new gem.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies.

data/lib/gem_toys/template.rb

@@ -3,58 +3,34 @@
 require 'date'
 require 'toys-core'
 
+require_relative 'template/common_code'
+
 module GemToys
 	## Template with gem tools, should be expanded in toys file
 	class Template
 		include Toys::Template
 
-		## Module for common code between nested tools
-		module CommonCode
-			private
-
-			def project_name
-				@project_name ||= File.basename context_directory
-			end
-
-			def version_file_path
-				project_path = project_name.tr '-', '/'
-				@version_file_path ||= File.join context_directory, 'lib', project_path, 'version.rb'
-			end
-
-			def version_file_content
-				File.read version_file_path
-			end
-
-			def current_version
-				@current_version ||= version_file_content.match(/VERSION = '(.+)'/)[1]
-			end
+		attr_reader :version_file_path, :unreleased_title
 
-			def changelog_file_path
-				@changelog_file_path ||= File.join context_directory, 'CHANGELOG.md'
-			end
-
-			def gem_file_name
-				@gem_file_name ||= "#{project_name}-#{current_version}.gem"
-			end
-
-			def pkg_directory
-				@pkg_directory ||= "#{context_directory}/pkg"
-			end
-
-			def current_gem_file
-				"#{pkg_directory}/#{gem_file_name}"
-			end
+		def initialize(version_file_path: nil, unreleased_title: '## master (unreleased)')
+			@version_file_path = version_file_path
+			@unreleased_title = unreleased_title
 		end
 
-		on_expand do
+		on_expand do |template|
 			tool :gem do
 				subtool_apply do
-					include :exec, exit_on_nonzero_status: true, log_level: Logger::UNKNOWN
+					unless include? :exec
+						include :exec, exit_on_nonzero_status: true, log_level: Logger::UNKNOWN
+					end
+
 					include CommonCode
 				end
 
 				tool :build do
-					def run
+					to_run do
+						@template = template
+
 						sh 'gem build'
 						FileUtils.mkdir_p pkg_directory
 						FileUtils.mv "#{context_directory}/#{gem_file_name}", current_gem_file
@@ -62,7 +38,9 @@ module GemToys
 				end
 
 				tool :install do
-					def run
+					to_run do
+						@template = template
+
 						exec_tool 'gem build'
 						sh "gem install #{current_gem_file}"
 					end
@@ -71,43 +49,53 @@ module GemToys
 				tool :release do
 					required_arg :version
 
-					def run
+					to_run do
+						@template = template
+
 						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}'"
 
-						## Build new gem file
-						exec_tool 'gem build'
-
-						wait_for_manual_check
-
 						## 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}'")
 					end
 
 					TODAY = Date.today.to_s
 
 					def update_changelog_file
+						puts 'Updating changelog file...'
+
 						@changelog_lines = File.readlines(changelog_file_path)
 
 						existing_line = find_version_line_in_changelog_file
@@ -126,12 +114,16 @@ module GemToys
 					end
 
 					def new_changelog_content
+						unreleased_title = @template.unreleased_title
 						@changelog_lines.insert(
-							@changelog_lines.index("## master (unreleased)\n") + 2, "## #{version} (#{TODAY})\n\n"
+							@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}'"

data/lib/gem_toys/template/common_code.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module GemToys
+	## Template with gem tools, should be expanded in toys file
+	class Template
+		## Module for common code between nested tools
+		module CommonCode
+			private
+
+			def project_name
+				@project_name ||= File.basename context_directory
+			end
+
+			def version_file_path
+				@version_file_path ||=
+					@template.version_file_path ||
+					begin
+						project_path = project_name.tr '-', '/'
+						File.join context_directory, 'lib', project_path, 'version.rb'
+					end
+			end
+
+			def version_file_content
+				File.read version_file_path
+			end
+
+			def current_version
+				@current_version ||= version_file_content.match(/VERSION = '(.+)'/)[1]
+			end
+
+			def changelog_file_path
+				@changelog_file_path ||= File.join context_directory, 'CHANGELOG.md'
+			end
+
+			def gem_file_name
+				@gem_file_name ||= "#{project_name}-#{current_version}.gem"
+			end
+
+			def pkg_directory
+				@pkg_directory ||= "#{context_directory}/pkg"
+			end
+
+			def current_gem_file
+				"#{pkg_directory}/#{gem_file_name}"
+			end
+		end
+	end
+end

data/lib/gem_toys/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem_toys
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -59,6 +59,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,6 +69,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.18
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.87.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +156,7 @@ files:
 - README.md
 - lib/gem_toys.rb
 - lib/gem_toys/template.rb
+- lib/gem_toys/template/common_code.rb
 - lib/gem_toys/version.rb
 homepage: https://github.com/AlexWayfer/gem_toys
 licenses: