gem_toys 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fc9bcdb919f2a0f201a81e39147393ae2fb8b3a6caa37cd38944770cef390de
-  data.tar.gz: ad694499de8f8a2db342c748ada96842cfb3396dc53ed33b35d1928ca89b078c
+  metadata.gz: 16feed698462675a843e0f84ec189d550db52292eee4c37d10f9b8352dcbed50
+  data.tar.gz: 5f523a901ef6e5256979056261f6b1c7051585e27e9bf9f37550ab7545215f3d
 SHA512:
-  metadata.gz: 3100babf6998a170b6d51c5e9f33a71e1e11742cd915a106d43a017190e21f9c7b629984c6729271f4f3c38f8b5024d6e696e0c448594e8ec48166edbdbcbee7
-  data.tar.gz: 36e525c0564e2685e4c404cc3f8f7aaf0ec03f04486b0fc4470bd1c69f752ddd4bd37a2ac130cf9d6701eebf9fc84747c705792a1fba261aef8a2242de737516
+  metadata.gz: 93aac7e65dbf9093754f3dc82f0770299feba396fcba5c89d70ffebc35a3208567891171830a99a1a9d962d8d2ae258b6a4adff242eae02babcb4f0578561b17
+  data.tar.gz: 04c08eb4ac3c2e552fe24413833fd4f3338dd0186aedd835ce2ed1cb3e2d17e0b391c90ed6ad0620f465a255558f93c5ac6c0b6a8f6a8971992794338c0272cf

data/CHANGELOG.md

@@ -2,6 +2,42 @@
 
 ## master (unreleased)
 
+## 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
+
+## 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

@@ -1,11 +1,11 @@
 # Gem Toys
 
-![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/gem_toys?style=flat-square)
+[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/gem_toys?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/gem_toys)
 [![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/gem_toys/master.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/gem_toys)
 [![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/gem_toys.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/gem_toys)
-![Depfu](https://img.shields.io/depfu/AlexWayfer/gem_toys?style=flat-square)
+[![Depfu](https://img.shields.io/depfu/AlexWayfer/benchmark_toys?style=flat-square)](https://depfu.com/repos/github/AlexWayfer/gem_toys)
 [![Inline docs](https://inch-ci.org/github/AlexWayfer/gem_toys.svg?branch=master)](https://inch-ci.org/github/AlexWayfer/gem_toys)
-[![license](https://img.shields.io/github/license/AlexWayfer/gem_toys.svg?style=flat-square)](https://github.com/AlexWayfer/gem_toys/blob/master/LICENSE)
+[![license](https://img.shields.io/github/license/AlexWayfer/gem_toys.svg?style=flat-square)](https://github.com/AlexWayfer/gem_toys/blob/master/LICENSE.txt)
 [![Gem](https://img.shields.io/gem/v/gem_toys.svg?style=flat-square)](https://rubygems.org/gems/gem_toys)
 
 [Toys](https://github.com/dazuma/toys) template for gems, like building, releasing, etc.
@@ -41,16 +41,39 @@ expand GemToys::Template
 alias_tool :g, :gem
 ```
 
+### Build
+
+`toys gem build` builds a gem with the current version and move it to the `pkg/` directory.
+
+### Install
+
+`toys gem install` [builds](#build) a gem and install it locally.
+
+### Release
+
+`toys gem release` does:
+
+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.  [Builds](#build) a gem.
+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.
-Then, run `bundle exec rspec` to run the tests.
+
+Then, run `toys rspec` to run the tests.
 
 To install this gem onto your local machine, run `toys gem install`.
-To release a new version, update the version number in `version.rb`,
-and then run `bundle exec rake release`, which will create a git tag
-for the version, push git commits and tags, and push the `.gem` file
-to [rubygems.org](https://rubygems.org).
+
+To release a new version, run `toys gem release %version%`. See how it works [here](#release).
 
 ## Contributing
 

data/lib/gem_toys/template.rb

@@ -1,147 +1,72 @@
 # frozen_string_literal: true
 
-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
-
-			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
+		attr_reader :version_file_path, :unreleased_title
 
-			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'
+
+						require 'fileutils'
 						FileUtils.mkdir_p pkg_directory
 						FileUtils.mv "#{context_directory}/#{gem_file_name}", current_gem_file
 					end
 				end
 
 				tool :install do
-					def run
+					to_run do
+						@template = template
+
 						exec_tool 'gem build'
 						sh "gem install #{current_gem_file}"
 					end
 				end
 
-				tool :release do
-					required_arg :version
-
-					def run
-						update_version_file
-
-						## Update CHANGELOG
-						update_changelog_file
-
-						## Checkout to a new git branch, required for protected `master` with CI
-						# sh "git switch -c v#{version}"
-
-						commit_changes
+				tool :version do
+					to_run do
+						@template = template
 
-						## Tag commit
-						sh "git tag -a v#{version} -m 'Version #{version}'"
-
-						## Build new gem file
-						exec_tool 'gem build'
-
-						wait_for_manual_check
-
-						## Push commit
-						sh 'git push'
-
-						## Push tags
-						sh 'git push --tags'
-
-						sh "gem push #{current_gem_file}"
-					end
-
-					private
-
-					def update_version_file
-						File.write version_file_path, version_file_content.sub(/'.+'/, "'#{version}'")
-					end
-
-					TODAY = Date.today.to_s
-
-					def update_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} " }
-					end
-
-					def new_changelog_content
-						@changelog_lines.insert(
-							@changelog_lines.index("## master (unreleased)\n") + 2, "## #{version} (#{TODAY})\n\n"
-						).join
+						puts_versions [version]
 					end
+				end
 
-					def commit_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,
+					version_file_path: template.version_file_path,
+					unreleased_title: template.unreleased_title
 			end
 		end
 	end

data/lib/gem_toys/template/common_code.rb

@@ -0,0 +1,84 @@
+# 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
+
+			memoize def project_name
+				File.basename context_directory
+			end
+
+			memoize def 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
+
+			memoize def current_version
+				version_file_content.match(/VERSION = '(.+)'/)[1]
+			end
+
+			memoize def changelog_file_path
+				File.join context_directory, 'CHANGELOG.md'
+			end
+
+			memoize def gem_file_name
+				"#{project_name}-#{current_version}.gem"
+			end
+
+			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('%b %e %Y %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,147 @@
+# frozen_string_literal: true
+
+module GemToys
+	class Template
+		## Template with gem release tool, expanding internally
+		class Release
+			include Toys::Template
+
+			attr_reader :version_file_path, :unreleased_title
+
+			def initialize(version_file_path:, unreleased_title:)
+				@version_file_path = version_file_path
+				@unreleased_title = unreleased_title
+			end
+
+			on_expand do |template|
+				tool :release do
+					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
+
+						## 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'
+
+						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 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
+					end
+				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.1.0'
+	VERSION = '0.6.0'
 end

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gem_toys
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Alexander Popov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2021-02-09 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
@@ -44,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.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.18.0
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.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.
 
   '
@@ -150,6 +192,9 @@ files:
 - README.md
 - 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/versions.rb
 - lib/gem_toys/version.rb
 homepage: https://github.com/AlexWayfer/gem_toys
 licenses:
@@ -167,13 +212,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.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Toys template for gems