raketeer 0.2.13 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec89678553f96bde861d1db36fdf62362a986aae57d48920fcedb4b8d648d1ee
-  data.tar.gz: b5b1796833f6ab053e4e8582bb12e221d205bac73a90d2253713d81e206b7585
+  metadata.gz: fd7e5eed77aea6dd23233616f4c8cf54acc283479d0e53baecf46b453b6747a5
+  data.tar.gz: 209151fff66ec3751e67a7cc5856a4d2c7554be227858e7b12c5ff211883289c
 SHA512:
-  metadata.gz: 63a541a44b2cee494a9a113944c390297affdda18e745d6726b755bb9d766f9bbc8ceed58944146e2878a5e57750a83cdbeb036ad8b01758311020894d918209
-  data.tar.gz: 035bf26706bc7913dcac4b194a1a3d0ac6816812c76c5aed0713abdf2b7d8cb17942d2762a4592f281755a6bc8ce45db20e88b892d1d0b2854220e7f47e76cd8
+  metadata.gz: 8ddf10cb5326451f3ad8449253a283cde5b7f727abbfacb8b7b95eb810c656ac3abc3dccf5b280f5cbf398336c2f85abecd31893a6b1fc4fd6180d81f1d504bb
+  data.tar.gz: 1816342b4e2c04214ff5651384829850bd38e6dc36e83ebcd4da56419504de64a83485e44ea609c644084892ba921afc7bd91cd346abf4e0073df9dd3525c1e5

data/CHANGELOG.md

@@ -1,15 +1,21 @@
 # Changelog | Raketeer
 
-All notable changes to this project will be documented in this file.
+- [Keep a Changelog](https://keepachangelog.com/en/1.1.0),
+- [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-Format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0),
-and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
-
-## [[Unreleased]](https://github.com/esotericpig/raketeer/compare/v0.2.13...HEAD)
+## [Unreleased](https://github.com/esotericpig/raketeer/compare/v0.2.14...HEAD)
 -
 
+## [0.2.14](https://github.com/esotericpig/raketeer/compare/v0.2.13...v0.2.14) - 2025-06-06
+### Added
+- Added Yardoc to Rakefile.
 
-## [v0.2.13] - [2021-06-22](https://github.com/esotericpig/raketeer/compare/v0.2.12...v0.2.13)
+### Changed
+- Updated Gems.
+- Applied new RuboCop suggestions.
+- Renamed Git branch `master` to `main`.
+
+## [0.2.13](https://github.com/esotericpig/raketeer/compare/v0.2.12...v0.2.13) - 2021-06-22
 ### Fixed
 - Changed `bump` to reset lower version numbers.
     - If `v1.1.1`, major +1 will become => `v2.0.0` (not `v2.1.1`).
@@ -18,41 +24,35 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
     - It's debatable whether this is a *fix* or a *change*, but I'm labeling it as a *fix*, as this way is more usable and expected.
     - I debated whether to also drop off the pre-release and build-metadata, but it's a hard decision. Even though the version changed, maybe it's still a pre-release and/or still needs the same build-metadata. You could argue that bumping the major version should always drop it off, but I'm not sure. For now, they are unaffected by this change. In the future, major (only) +1 might also drop pre-release & build-metadata.
 
-
-## [v0.2.12] - [2021-06-18](https://github.com/esotericpig/raketeer/compare/v0.2.11...v0.2.12)
+## [0.2.12](https://github.com/esotericpig/raketeer/compare/v0.2.11...v0.2.12) - 2021-06-18
 ### Changed
 - Changed `bump` to also update GitHub compare links in Changelogs.
     - Example link in Changelog:
-        - `## [v0.2.11] - [2021-06-15](https://github.com/esotericpig/raketeer/compare/v0.2.10...v0.2.11)`
+        - `## [0.2.11](https://github.com/esotericpig/raketeer/compare/v0.2.10...v0.2.11) - 2021-06-15`
     - Updates `v0.2.10...v0.2.11` to `v0.2.11...<new_version>`.
 
-
-## [v0.2.11] - [2021-06-15](https://github.com/esotericpig/raketeer/compare/v0.2.10...v0.2.11)
+## [0.2.11](https://github.com/esotericpig/raketeer/compare/v0.2.10...v0.2.11) - 2021-06-15
 ### Changed
 - Added SPDX license ID to source files.
 
-
-## [v0.2.10] - 2021-05-30
+## [0.2.10] - 2021-05-30
 ### Changed
 - Formatted all code using RuboCop.
 
 ### Fixed
 - Updated Bundler and Gems because of GitHub security warning.
 
-
-## [v0.2.9] - 2020-03-01
+## [0.2.9] - 2020-03-01
 ### Changed
 - Changed Gemspec description (mainly for testing other project Raketary)
 
-
-## [v0.2.8] - 2020-03-01
+## [0.2.8] - 2020-03-01
 ### Added
 - GitHubPkg (lib/raketeer/github_pkg.rb)
 - GitHubPkgTask (lib/raketeer/github_pkg_task.rb)
     - Publish/Push your `pkg/*.gem` release(s) to GitHub Packages
 
-
-## [v0.2.7] - 2019-12-18
+## [0.2.7] - 2019-12-18
 ### Added
 - Add more info to README
 - Add default dirs to Util methods
@@ -63,24 +63,21 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 ### Fixed
 - Check env vars for bundle task in bump task
 
-
-## [v0.2.6] - 2019-08-03
+## [0.2.6] - 2019-08-03
 ### Changed
 - Refactored BumpTask for a new project I'm working on to use this project in a CLI
 
 ### Fixed
 - SemVer's initialize_copy()
 
-
-## [v0.2.5] - 2019-08-02
+## [0.2.5] - 2019-08-02
 ### Added
 - Added a strict mode (regex) to BumpTask, BumpVer, FilesBumper, & SemVer
 
 ### Fixed
 - Fixed the 'Nothing written (up-to-date)' feature in BumpTask (minor)
 
-
-## [v0.2.4] - 2019-08-02
+## [0.2.4] - 2019-08-02
 ### Added
 - BumpTask & 'raketeer/bump'
 - FilesBumper (lib/raketeer/files_bumper.rb)
@@ -94,13 +91,11 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 ### Changed
 - Util.find_main_executable() to not search for 'bin/*.rb' since almost no project uses an extension in the bin directory
 
-
-## [v0.2.3] - 2019-07-30
+## [0.2.3] - 2019-07-30
 ### Fixed
 - Fixed 'yield' typo in some tasks
 
-
-## [v0.2.2] - 2019-07-29
+## [0.2.2] - 2019-07-29
 ### Added
 - RunTask & 'raketeer/run'
 - Util
@@ -110,13 +105,11 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 - Refactored some code (minor)
 - Changed some documentation (minor)
 
-
-## [v0.2.1] - 2019-07-24
+## [0.2.1] - 2019-07-24
 ### Changed
 - Fixed minor/cosmetic typo
 
-
-## [v0.2.0] - 2019-07-24
+## [0.2.0] - 2019-07-24
 ### Added
 - All (lib/raketeer/all.rb); used to be Raketeers
     - `require 'raketeer/all'`
@@ -126,8 +119,7 @@ and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec
 ### Removed
 - Raketeers (lib/raketeer/raketeers.rb); renamed to All
 
-
-## [v0.1.0] - 2019-07-23
+## [0.1.0] - 2019-07-23
 ### Added
 - IRB task
 - Nokogiri installs

data/Gemfile

@@ -1,7 +1,18 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-
 source 'https://rubygems.org'
 
 gemspec
+
+group :development,:test do
+  gem 'bundler'  ,'~> 2.6'
+  gem 'irb'      ,'>= 1.0'
+  gem 'rdoc'     ,'~> 6.14'  # YARDoc RDoc (*.rb).
+  gem 'redcarpet','~> 3.6'   # YARDoc Markdown (*.md).
+  gem 'yard'     ,'~> 0.9'   # Doc.
+end
+
+group :test do
+  gem 'minitest' ,'~> 5.25'
+end

data/README.md

@@ -1,68 +1,69 @@
 # Raketeer
 
 [![Gem Version](https://badge.fury.io/rb/raketeer.svg)](https://badge.fury.io/rb/raketeer)
-
-[![Source Code](https://img.shields.io/badge/source-github-%23A0522D.svg?style=for-the-badge)](https://github.com/esotericpig/raketeer)
-[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg?style=for-the-badge)](CHANGELOG.md)
-[![License](https://img.shields.io/github/license/esotericpig/raketeer.svg?color=%23A0522D&style=for-the-badge)](LICENSE.txt)
+[![Source Code](https://img.shields.io/badge/source-github-%23211F1F.svg)](https://github.com/esotericpig/raketeer)
+[![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg)](CHANGELOG.md)
+[![License](https://img.shields.io/github/license/esotericpig/raketeer.svg)](LICENSE.txt)
 
 Extra Ruby Rake Tasks.
 
 A [CLI app](https://github.com/esotericpig/raketary) is also available that uses these tasks, which is useful for tasks like *bump* (which bumps the version for your RubyGem project) so that you don't have to include this Gem as a development dependency for every project.
 
-## Contents
+## // Contents
 
-- [Setup](#setup)
-- [Using](#using)
-- [Hacking](#hacking)
-- [License](#license)
+- [Setup](#-setup)
+- [Using](#-using)
+- [Hacking](#-hacking)
+- [License](#-license)
 
-## [Setup](#contents)
+## [//](#-contents) Setup
 
 Pick your poison...
 
 With the RubyGems CLI package manager:
 
-`$ gem install raketeer`
+```bash
+gem install raketeer
+```
 
-In your *Gemspec* (*<project>.gemspec*):
+In your *Gemspec*:
 
-```Ruby
-spec.add_development_dependency 'raketeer', '~> 0.2'
+```ruby
+spec.add_development_dependency 'raketeer', '~> X.X'
 ```
 
 In your *Gemfile*:
 
-```Ruby
-gem 'raketeer', '~> 0.2', group: [:development, :test]
+```ruby
+gem 'raketeer', '~> X.X', group: %i[development test]
 
 # or...
 gem 'raketeer', git: 'https://github.com/esotericpig/raketeer.git',
-                tag: 'v0.2.10', group: [:development, :test]
+                branch: 'main', group: %i[development test]
 ```
 
-Manually:
+From source:
 
-```
-$ git clone 'https://github.com/esotericpig/raketeer.git'
-$ cd raketeer
-$ bundle install
-$ bundle exec rake install:local
+```bash
+git clone 'https://github.com/esotericpig/raketeer.git'
+cd raketeer
+bundle install
+bundle exec rake install:local
 ```
 
-## [Using](#contents)
+## [//](#-contents) Using
 
 **Rakefile**
 
 In your *Rakefile*, you can either include all tasks...
 
-```Ruby
+```ruby
 require 'raketeer/all'
 ```
 
 Or, include the specific tasks that you need:
 
-```Ruby
+```ruby
 require 'raketeer/bump'
 require 'raketeer/github_pkg'
 require 'raketeer/irb'
@@ -70,9 +71,9 @@ require 'raketeer/nokogiri_installs'
 require 'raketeer/run'
 ```
 
-If you have conflicting tasks and/or you want to see what tasks have been included, you can put them in a namespace:
+If you have conflicting tasks and/or you want to see what tasks have been included (with `rake -T`), you can put them in a namespace:
 
-```Ruby
+```ruby
 namespace :rt do
   require 'raketeer/all'
 end
@@ -80,7 +81,7 @@ end
 
 **Included Tasks**
 
-```
+```bash
 rake bump[version]      # Show/Set/Bump the version
 rake bump:build[build]  # Set/Erase the build metadata
 rake bump:bundle        # Bump the Gemfile.lock version
@@ -97,10 +98,9 @@ rake nokogiri_other     # Install Nokogiri libs for other OSes
 rake run                # Run this project's main file: "rake run -- --version"
 ```
 
-**bump:help**
+**rake bump:help**
 
-```
-$ rake bump:help
+```bash
 rake bump  # Print the current version
 
 # You can run a dry run for any task (will not write to files)
@@ -142,38 +142,38 @@ If you need more control, for now, please look at the accessors of each task (be
 
 For example, in your *Rakefile*:
 
-```Ruby
+```ruby
 require 'raketeer/bump_task'
 
-Raketeer::BumpTask.new() do |task|
+Raketeer::BumpTask.new do |task|
   task.strict = true
 end
 ```
 
-```Ruby
+```ruby
 require 'raketeer/github_pkg_task'
 
-Raketeer::GitHubPkgTask.new() do |task|
+Raketeer::GitHubPkgTask.new do |task|
   task.deps << 'test'
   task.username = 'esotericpig'
 end
 ```
 
-## [Hacking](#contents)
+## [//](#-contents) Hacking
 
-```
+```bash
 $ git clone 'https://github.com/esotericpig/raketeer.git'
 $ cd raketeer
 $ bundle install
 $ bundle exec rake -T
 ```
 
-## [License](#contents)
+## [//](#-contents) License
 
 [GNU LGPL v3+](LICENSE.txt)
 
 > Raketeer (<https://github.com/esotericpig/raketeer>)  
-> Copyright (c) 2019-2021 Jonathan Bradley Whited  
+> Copyright (c) 2019-2025 Bradley Whited  
 > 
 > Raketeer is free software: you can redistribute it and/or modify  
 > it under the terms of the GNU Lesser General Public License as published by  

data/Rakefile

@@ -1,18 +1,21 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-
 require 'bundler/gem_tasks'
 
 require 'raketeer'
-
 require 'rake/clean'
+require 'yard'
 
 task default: []
 
-CLEAN.exclude('.git/','stock/')
+CLEAN.exclude('.git/','.github/','.idea/','stock/')
 CLOBBER.include('doc/')
 
+YARD::Rake::YardocTask.new(:doc) do |task|
+  task.options.push('--title',"Raketeer v#{Raketeer::VERSION}")
+end
+
 namespace :rt do
   require 'raketeer/all'
 end
@@ -21,10 +24,10 @@ namespace :todo do
   # TODO: make this into a task class
   # TODO: do 'gem:files'? and also 'gem:info' for all other methods?
   desc 'Output dat gemspec bootyliciousness'
-  task :gem do |task,args|
+  task :gem do |_task,_args|
     # TODO: if this doesn't work, read *.gemspec somehow? probably not...
     gem = Gem::Specification.find_by_name('raketeer')
     puts gem.files
-    #puts gem.methods.sort - Object.methods
+    # puts gem.methods.sort - Object.methods
   end
 end

data/lib/raketeer/all.rb

@@ -3,26 +3,13 @@
 
 #--
 # This file is part of Raketeer.
-# Copyright (c) 2019-2021 Jonathan Bradley Whited
+# Copyright (c) 2019 Bradley Whited
 #
 # SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'raketeer/bump' # @since 0.2.4
 require 'raketeer/github_pkg' # @since 0.2.8
 require 'raketeer/irb' # @since 0.2.0
 require 'raketeer/nokogiri_installs' # @since 0.1.0
 require 'raketeer/run' # @since 0.2.2
-
-
-module Raketeer
-  ###
-  # Defines all Raketeer tasks in your Rakefile.
-  #
-  # @author Jonathan Bradley Whited
-  # @since  0.2.0
-  ###
-  module All
-  end
-end

data/lib/raketeer/bump.rb

@@ -3,21 +3,11 @@
 
 #--
 # This file is part of Raketeer.
-# Copyright (c) 2019-2021 Jonathan Bradley Whited
+# Copyright (c) 2019 Bradley Whited
 #
 # SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'raketeer/bump_task'
 
-module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.4
-  ###
-  module Bump
-  end
-end
-
 Raketeer::BumpTask.new # @since 0.2.4