raketary 0.1.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73333a3212384440ea74bde271093ab1858d69bf6d99f14bee2d97359fb7e4cc
-  data.tar.gz: db6a6efecd0b115a549ca9832382412c3678adcdeb78d00752751ba00e674b00
+  metadata.gz: a0e9cee720593352639f0730260e1ced416f72c4f359d160790861cfcbebbdd5
+  data.tar.gz: 130dde3aa7ca111fe6b2c7cdb9dc7e84c32df24316636897bdb3e3912e949f31
 SHA512:
-  metadata.gz: 505613ae4e2eb0df532ef071899b4f3b48811e6fecbc902da2748b9157acd1c83b5272a20870b0dd9708b122eb79093b9c696be31e77fc3eae3bb34ec174c34d
-  data.tar.gz: dec0c32f73a776857b3d3f2cdc4e1249c2624aac7c2873b44a561c0c48cc5e3e5cf40621837466a20a35ff8d1aa01d6c1516419bf39edcf5eda928cc6f3dc021
+  metadata.gz: a95bd2139952da7fe69a623f67e9a51d46f18fc283e27ac89c5346ba5965ddc0992d9e0295da79b267e914f2285ed37cec7f35655f8b2dee7ed06c89fb1f5ac7
+  data.tar.gz: 81a71a41cf9a0027a4e68c118400a15d7d743f5ec6ffaf0ab7bd413580b4a510014e88861f3fdb7de2bf4c81eba5990d6e1528da526d45b12bf842286682ff11

data/CHANGELOG.md

@@ -1,12 +1,58 @@
 # Changelog | Raketary
 
-Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+All notable changes to this project will be documented in this file.
+
+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/raketary/compare/v0.2.2...HEAD)
+-
+
+
+## [v0.2.2] - 2021-06-16
+### Changed
+- Formatted code with RuboCop.
+- Updated Gems.
+
+
+## [v0.2.1] - 2020-03-04
+### Fixed
+- Added back `irb` gem to Gemspec
+
+
+## [v0.2.0] - 2020-03-04
+### Added
+- Added `GHPSyncCmd` for syncing YARDoc to GitHub Pages
+    - Calls `rsync` to sync `./doc/` to another local directory
+    - File: `lib/raketary/ghp_sync_cmd.rb`
+    - Sub cmd: `ghp_sync`
+
+### Changed
+- Renamed `App*` classes (`app_*.rb` files) to `*Cmd` (`*_cmd.rb`) since they extend `Cmd`, not `App`
+
+
+## [v0.1.3] - 2020-03-02
+### Changed
+- Changed AppGitHubPkg logic to not check if username is nil (minor; not a bug)
+
+
+## [v0.1.2] - 2020-03-01
+### Added
+- Added `github_pkg` sub command using AppGitHubPkg & Raketeer::GitHubPkgTask
+    - This will publish/push your `pkg/*.gem` release(s) to GitHub Packages
+
+### Changed
+- Updated Gemfile.lock
+
+### Fixed
+- Fixed AppBump (`bump` sub command) to bump the bundle after bumping all
+    - Before this fix, it required you calling `bump` twice on the command line
 
-## [[Unreleased]](https://github.com/esotericpig/raketary/compare/v0.1.1...master)
 
 ## [v0.1.1] - 2019-12-18
 ### Changed
-- Add more info to CHANGELOG, README, TODO
+- Added more info to CHANGELOG, README, TODO
+
 
 ## [v0.1.0] - 2019-08-06
 ### Added

data/Gemfile

@@ -1,24 +1,6 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-#--
-# This file is part of Raketary.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Raketary is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Raketary is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Raketary.  If not, see <https://www.gnu.org/licenses/>.
-#++
-
 
 source 'https://rubygems.org'
 

data/Gemfile.lock

@@ -1,27 +1,35 @@
 PATH
   remote: .
   specs:
-    raketary (0.1.1)
-      irb (~> 1.0)
-      rake (~> 12.3)
+    raketary (0.2.2)
+      irb (~> 1.3)
+      rake (~> 13.0)
       raketeer (~> 0.2)
+      yard_ghurt (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    irb (1.2.0)
-      reline (>= 0.0.1)
-    rake (12.3.3)
-    raketeer (0.2.7)
+    io-console (0.5.9)
+    irb (1.3.5)
+      reline (>= 0.1.5)
+    rake (13.0.3)
+    raketeer (0.2.11)
       rake
-    reline (0.0.7)
+    reline (0.2.5)
+      io-console (~> 0.5)
+    yard (0.9.26)
+    yard_ghurt (1.2.1)
+      rake
+      yard
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler (~> 2.2)
   raketary!
+  yard (~> 0.9)
 
 BUNDLED WITH
-   2.0.2
+   2.2.20

data/README.md

@@ -6,7 +6,14 @@
 [![Changelog](https://img.shields.io/badge/changelog-md-%23A0522D.svg?style=for-the-badge)](CHANGELOG.md)
 [![License](https://img.shields.io/github/license/esotericpig/raketary.svg?color=%23A0522D&style=for-the-badge)](LICENSE.txt)
 
-CLI for [Raketeer](https://github.com/esotericpig/raketeer).
+CLI app for commonly-used Rake tasks.
+
+Includes:
+
+- [Raketeer](https://github.com/esotericpig/raketeer)
+- [YardGhurt](https://github.com/esotericpig/yard_ghurt)
+
+![Demo of Raketary on the command line](https://github.com/esotericpig/esotericpig.github.io/blob/master/pics/raketary_demo.gif)
 
 ## Contents
 
@@ -34,14 +41,14 @@ $ bundle exec rake install:local
 
 ## [Using](#contents)
 
-**TODO:** flesh out Using section
-
 ```
 $ raketary
 Usage: raketary [options] [command] [options]...
 
 Commands:
     bump                             Bump your project's version
+    ghp_sync                         Sync YARDoc to GitHub Pages repo
+    github_pkg                       Publish your project's gem(s) to GitHub Packages
     irb                              Open an irb session loaded with your library
     nokogiri                         Install Nokogiri libs
     run                              Run your project's main file: raketary run -- --version
@@ -59,7 +66,7 @@ $ raketary bump
 [bump] Options:
     -n, --dry-run                    do a dry run (do NOT write to files)
     -s, --strict                     enforce semantic versioning (i.e., \d+\.\d+\.\d+.*)
-    
+
     -v, --ver [STR]                  show/set the version (e.g.: '1.2.3-alpha.4+beta.5') (default: show)
     -m, --major [INT,STR]            bump/set the major number (e.g.: +2, 4) (default: +1)
     -i, --minor [INT,STR]            bump/set the minor number (e.g.: +2, 4) (default: +1)
@@ -67,7 +74,7 @@ $ raketary bump
     -r, --pre [STR]                  set/erase the pre-release extension (e.g.: 'alpha.4') (default: erase)
     -b, --build [STR]                set/erase the the build metadata (e.g.: 'beta.5') (default: erase)
     -u, --bundle                     bump the Gemfile.lock version
-    
+
     -h, --help                       show this help
     -x, --example                    show some examples
 ```
@@ -99,10 +106,35 @@ raketary bump -b 'beta.5'   # Set the build metadata
 raketary bump -u            # Bump the Gemfile.lock version
 ```
 
+**GitHub Pkg**
+
+```
+$ raketary github_pkg -h
+...
+[github_pkg] Options:
+    -u, --user [STR]                 set the GitHub username
+    -h, --help                       show this help
+```
+
+**GitHub Pages Sync**
+
+```
+$ raketary ghp_sync -h
+...
+[ghp_sync] Options:
+    -g, --ghp-dir STR                the destination (GitHub Pages) directory to sync "doc/" to
+
+    -d, --deploy                     actually deploy (don't just do a dry-run)
+    -s, --sync-args STR              additional args to pass to the sync command
+
+    -h, --help                       show this help
+```
+
 ## [Hacking](#contents)
 
 ```
 $ git clone 'https://github.com/esotericpig/raketary.git'
+$ cd raketary
 $ bundle install
 $ bundle exec rake -T
 ```
@@ -112,7 +144,7 @@ $ bundle exec rake -T
 [GNU LGPL v3+](LICENSE.txt)
 
 > Raketary (<https://github.com/esotericpig/raketary>)  
-> Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)  
+> Copyright (c) 2019-2021 Jonathan Bradley Whited  
 > 
 > Raketary 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,31 +1,28 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-#--
-# This file is part of Raketary.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Raketary is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Raketary is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Raketary.  If not, see <https://www.gnu.org/licenses/>.
-#++
-
 
 require 'bundler/gem_tasks'
 
 require 'rake/clean'
+require 'raketary/version'
 require 'raketeer/run'
+require 'yard'
+
 
 task default: [:run]
 
 CLEAN.exclude('.git/','stock/')
 CLOBBER.include('doc/')
+
+
+YARD::Rake::YardocTask.new do |task|
+  task.files = [File.join('lib','**','*.rb')]
+
+  task.options += ['--files','CHANGELOG.md,LICENSE.txt']
+  task.options += ['--readme','README.md']
+
+  task.options << '--protected' # Show protected methods
+  #task.options += ['--template-path',File.join('yard','templates')]
+  task.options += ['--title',"Raketary v#{Raketary::VERSION} Doc"]
+end

data/bin/raketary

@@ -4,25 +4,14 @@
 
 #--
 # This file is part of Raketary.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Raketary is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Raketary is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Raketary.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
 require 'raketary'
 
-app = Raketary::App.new()
+app = Raketary::App.new
 
-app.run()
+app.run

data/lib/raketary.rb

@@ -1,27 +1,15 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of Raketary.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Raketary is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Raketary is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Raketary.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
-TESTING_RAKETARY = ($0 == __FILE__)
+TESTING_RAKETARY = ($PROGRAM_NAME == __FILE__)
 
 if TESTING_RAKETARY
   require 'rubygems'
@@ -29,20 +17,23 @@ if TESTING_RAKETARY
 end
 
 require 'raketary/app'
-require 'raketary/app_bump'
-require 'raketary/app_irb'
-require 'raketary/app_nokogiri'
-require 'raketary/app_run'
+require 'raketary/bump_cmd'
 require 'raketary/cmd'
 require 'raketary/errors'
+require 'raketary/ghp_sync_cmd'
+require 'raketary/github_pkg_cmd'
+require 'raketary/irb_cmd'
+require 'raketary/nokogiri_cmd'
+require 'raketary/run_cmd'
 require 'raketary/sub_cmd'
 require 'raketary/version'
 
+
 ###
-# @author Jonathan Bradley Whited (@esotericpig)
+# @author Jonathan Bradley Whited
 # @since  0.1.0
 ###
 module Raketary
 end
 
-Raketary::App.new().run() if TESTING_RAKETARY
+Raketary::App.new.run if TESTING_RAKETARY

data/lib/raketary/app.rb

@@ -1,37 +1,28 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of Raketary.
-# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# Raketary is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# Raketary is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with Raketary.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2019-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
-require 'raketary/app_bump'
-require 'raketary/app_irb'
-require 'raketary/app_nokogiri'
-require 'raketary/app_run'
+require 'raketary/bump_cmd'
 require 'raketary/cmd'
+require 'raketary/ghp_sync_cmd'
+require 'raketary/github_pkg_cmd'
+require 'raketary/irb_cmd'
+require 'raketary/nokogiri_cmd'
+require 'raketary/run_cmd'
 require 'raketary/sub_cmd'
 require 'raketary/version'
 
+
 module Raketary
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class App < Cmd
@@ -41,42 +32,44 @@ module Raketary
     attr_accessor :ran_cmd
     attr_accessor :soft_error
     attr_reader :version
-    
+
     alias_method :ran_cmd?,:ran_cmd
-    
+
     def initialize(args=ARGV)
       super(self,'raketary')
-      
+
       @args = args
       @options = {}
       @parsers = []
       @ran_cmd = false
       @soft_error = nil
       @version = Raketary::VERSION
-      
+
       @sub_cmds = {
-        'bump' => SubCmd.new(%q(Bump your project's version),AppBump),
-        'irb' => SubCmd.new('Open an irb session loaded with your library',AppIRB),
-        'nokogiri' => SubCmd.new('Install Nokogiri libs',AppNokogiri),
-        'run' => SubCmd.new(%Q(Run your project's main file: #{@name} run -- --version),AppRun)
+        'bump' => SubCmd.new("Bump your project's version",BumpCmd),
+        'ghp_sync' => SubCmd.new('Sync YARDoc to GitHub Pages repo',GHPSyncCmd),
+        'github_pkg' => SubCmd.new("Publish your project's gem(s) to GitHub Packages",GitHubPkgCmd),
+        'irb' => SubCmd.new('Open an irb session loaded with your library',IRBCmd),
+        'nokogiri' => SubCmd.new('Install Nokogiri libs',NokogiriCmd),
+        'run' => SubCmd.new("Run your project's main file: #{@name} run -- --version",RunCmd)
       }
-      
+
       parse!(true) do |op|
         op.banner = "Usage: #{@name} [options] [command] [options]..."
-        
+
         op.on_tail('-v','--version',"show the version of #{@name}") do
           puts "#{@name} v#{@version}"
           exit
         end
       end
     end
-    
-    def run()
+
+    def run
       return if @ran_cmd
-      
-      puts @parsers.join()
-      
-      if !@soft_error.nil?()
+
+      puts @parsers.join
+
+      if !@soft_error.nil?
         puts
         puts "ERROR: #{@soft_error}"
       end