raketary 0.1.3 → 0.2.4

data/lib/raketary/{app_bump.rb → bump_cmd.rb}

@@ -1,86 +1,80 @@
-#!/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/cmd'
 require 'raketeer/bump_task'
 
+
 module Raketary
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
-  class AppBump < Cmd
+  class BumpCmd < Cmd
     def initialize(*)
       super
-      
+
       @run_cmd = false
-      
-      parse!() do |op|
+
+      parse! do |op|
         op.on('-n','--dry-run','do a dry run (do NOT write to files)')
         op.on('-s','--strict','enforce semantic versioning (i.e., \\d+\\.\\d+\\.\\d+.*)')
+
         op.separator op.summary_indent
-        
-        op.on('-v','--ver [STR]',%q{show/set the version (e.g.: '1.2.3-alpha.4+beta.5') (default: show)}) do |ver|
+
+        op.on('-v','--ver [STR]',"show/set the version (e.g.: '1.2.3-alpha.4+beta.5')" \
+              ' (default: show)') do |ver|
           @run_cmd = true
           ver
         end
-        op.on('-m','--major [INT,STR]',%q{bump/set the major number (e.g.: +2, 4) (default: +1)}) do |major|
+        op.on('-m','--major [INT,STR]','bump/set the major number (e.g.: +2, 4) (default: +1)') do |major|
           @run_cmd = true
-          major.nil?() ? '+1' : major
+          major.nil? ? '+1' : major
         end
-        op.on('-i','--minor [INT,STR]',%q{bump/set the minor number (e.g.: +2, 4) (default: +1)}) do |minor|
+        op.on('-i','--minor [INT,STR]','bump/set the minor number (e.g.: +2, 4) (default: +1)') do |minor|
           @run_cmd = true
-          minor.nil?() ? '+1' : minor
+          minor.nil? ? '+1' : minor
         end
-        op.on('-p','--patch [INT,STR]',%q{bump/set the patch number (e.g.: +2, 4) (default: +1)}) do |patch|
+        op.on('-p','--patch [INT,STR]','bump/set the patch number (e.g.: +2, 4) (default: +1)') do |patch|
           @run_cmd = true
-          patch.nil?() ? '+1' : patch
+          patch.nil? ? '+1' : patch
         end
-        op.on('-r','--pre [STR]',%q{set/erase the pre-release extension (e.g.: 'alpha.4') (default: erase)}) do |pre|
+        op.on('-r','--pre [STR]',"set/erase the pre-release extension (e.g.: 'alpha.4')" \
+              ' (default: erase)') do |pre|
           @run_cmd = true
-          pre.nil?() ? '' : pre
+          pre.nil? ? '' : pre
         end
-        op.on('-b','--build [STR]',%q{set/erase the the build metadata (e.g.: 'beta.5') (default: erase)}) do |build|
+        op.on('-b','--build [STR]',"set/erase the the build metadata (e.g.: 'beta.5')" \
+              ' (default: erase)') do |build|
           @run_cmd = true
-          build.nil?() ? '' : build
+          build.nil? ? '' : build
         end
         op.on('-u','--bundle','bump the Gemfile.lock version') do
           @run_cmd = true
           true
         end
+
         op.separator op.summary_indent
-        
+
         op.on_tail('-x','--example','show some examples') do
-          puts <<~EOX
+          puts <<~EXAMPLES
             #{app.name} #{@name} -v  # Show the current version
             #{app.name} #{@name} -n  # Do a dry run for any task (will NOT write to files)
-            
+
             #{app.name} #{@name} -v '1.2.3-alpha.4-beta.5'  # Set the version manually
             #{app.name} #{@name} -m 1 -i 2 -p 3             # Set the version numbers
             #{app.name} #{@name} -r 'alpha.4' -b 'beta.5'   # Set the version extensions
             #{app.name} #{@name} -m -i -p                   # Bump the version numbers by 1
             #{app.name} #{@name} -m +2 -i +3 -p +4          # Bump the version numbers by X
-            
+
             #{app.name} #{@name} -m            # Bump the major number by 1
             #{app.name} #{@name} -m 1          # Set the major number to 1
             #{app.name} #{@name} -m +2         # Bump the major number by 2
@@ -95,23 +89,24 @@ module Raketary
             #{app.name} #{@name} -b            # Erase the build metadata
             #{app.name} #{@name} -b 'beta.5'   # Set the build metadata
             #{app.name} #{@name} -u            # Bump the Gemfile.lock version
-          EOX
+          EXAMPLES
           exit
         end
       end
     end
-    
-    def run()
+
+    def run
       super()
       return unless @run_cmd
-      
-      bump_task = Raketeer::BumpTask.new()
-      bump_task.bump_bundle = false
-      bump_task.dry_run = app.options[:dry_run] ? true : false
-      bump_task.strict = app.options[:strict] ? true : false
-      
-      bump_task.check_env()
-      
+
+      bump_task = Raketeer::BumpTask.new do |task|
+        task.bump_bundle = false
+        task.dry_run = app.options[:dry_run] ? true : false
+        task.strict = app.options[:strict] ? true : false
+      end
+
+      bump_task.check_env
+
       bump_task.bump_all(Raketeer::BumpVer.new(
         version: app.options[:ver],
         major: app.options[:major],
@@ -120,9 +115,9 @@ module Raketary
         prerelease: app.options[:pre],
         build_meta: app.options[:build]
       ))
-      
-      bump_task.bump_bundle_file() if app.options[:bundle]
-      
+
+      bump_task.bump_bundle_file if app.options[:bundle]
+
       app.ran_cmd = true
     end
   end

data/lib/raketary/cmd.rb

@@ -1,32 +1,21 @@
-#!/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 'optparse'
 require 'raketary/errors'
 
+
 module Raketary
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class Cmd
@@ -34,70 +23,70 @@ module Raketary
     attr_reader :leftover_args
     attr_reader :name
     attr_reader :sub_cmds
-    
+
     def initialize(app,name)
       @app = app
       @leftover_args = []
       @name = name
       @sub_cmds = {}
     end
-    
+
     def parse!(is_app=false)
-      parser = OptionParser.new() do |op|
+      parser = OptionParser.new do |op|
         op.program_name = app.name
         op.version = app.version
-        
+
         op.banner = ''
         op.separator '' if is_app
-        
-        if !@sub_cmds.empty?()
+
+        if !@sub_cmds.empty?
           op.separator is_app ? 'Commands:' : "[#{@name}] Commands:"
-          
+
           @sub_cmds.each do |name,sub_cmd|
-            name_desc = ''.dup()
+            name_desc = ''.dup
             name_desc << op.summary_indent
             name_desc << ("%-#{op.summary_width}s #{sub_cmd.desc}" % [name])
-            
+
             op.separator name_desc
           end
           op.separator ''
         end
-        
+
         op.separator is_app ? 'Options:' : "[#{@name}] Options:"
-        
+
         op.on_tail('-h','--help','show this help')
-        
+
         yield op
       end
-      
+
       options = {}
-      @leftover_args = parser.order!(app.args,into: options).dup()
-      
-      options.keys.each do |key|
-        if (key_s = key.to_s()).include?('-')
-          options[key_s.gsub('-','_').to_sym()] = options[key]
+      @leftover_args = parser.order!(app.args,into: options).dup
+
+      options.each_key do |key|
+        if (key_s = key.to_s).include?('-')
+          options[key_s.gsub('-','_').to_sym] = options[key]
           options.delete(key)
         end
       end
       app.options.merge!(options)
-      
+
       app.parsers << parser
-      
-      if !app.args.nil?() && !(sub_cmd_name = app.args.shift()).nil?()
-        if !(sub_cmd = @sub_cmds[sub_cmd_name]).nil?()
+
+      if !app.args.nil? && !(sub_cmd_name = app.args.shift).nil?
+        if !(sub_cmd = @sub_cmds[sub_cmd_name]).nil?
           begin
-            sub_cmd.cmd_class.new(app,sub_cmd_name).run()
+            sub_cmd.cmd_class.new(app,sub_cmd_name).run
           rescue DoNotRunCmdError => e
             app.soft_error = e.soft_msg
           end
         end
       end
-      
+
       return parser
     end
-    
-    def run()
-      raise DoNotRunCmdError if app.options[:help] || app.ran_cmd?()
+
+    def run
+      raise DoNotRunCmdError if app.options[:help] || app.ran_cmd?
     end
   end
 end

data/lib/raketary/errors.rb

@@ -1,37 +1,25 @@
-#!/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
 #++
 
 
 module Raketary
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.1.0
   ###
   class DoNotRunCmdError < StandardError
     attr_accessor :soft_msg
-    
+
     def initialize(msg=nil)
       super(msg)
-      
+
       @soft_msg = msg
     end
   end

data/lib/raketary/ghp_sync_cmd.rb

@@ -0,0 +1,85 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of Raketary.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+
+require 'rake'
+require 'raketary/cmd'
+require 'shellwords'
+require 'yard_ghurt/ghp_sync_task'
+
+
+module Raketary
+  ###
+  # @author Jonathan Bradley Whited
+  # @since  0.2.0
+  ###
+  class GHPSyncCmd < Cmd
+    def initialize(*)
+      super
+
+      # Kind of hacky, but necessary because sync_args can have a hyphen/dash.
+      app.args.each_with_index do |arg,i|
+        arg = arg.strip
+
+        if arg == '-s' || arg.downcase == '--sync-args'
+          sync_args = app.args[i + 1] # If out of bounds, nil
+
+          if !sync_args.nil?
+            sync_args = Shellwords.split(sync_args)
+            sync_args = nil if sync_args.nil? || sync_args.empty?
+
+            app.options[:sync_args] = sync_args
+          end
+
+          app.args.delete_at(i)
+          app.args.delete_at(i) # If out of bounds, no error
+
+          break
+        end
+      end
+
+      parse! do |op|
+        op.on('-g','--ghp-dir STR','the destination (GitHub Pages) directory to sync "doc/" to')
+
+        op.separator op.summary_indent
+
+        op.on('-d','--deploy',"actually deploy (don't just do a dry-run)")
+        op.on('-s','--sync-args STR','additional args to pass to the sync command') do |sync_args|
+          app.options[:sync_args] # Already processed above
+        end
+
+        op.separator op.summary_indent
+      end
+    end
+
+    def run
+      super()
+
+      ghp_dir = app.options[:ghp_dir]
+
+      return unless ghp_dir
+
+      deploy = app.options[:deploy]
+      sync_args = app.options[:sync_args]
+
+      sync_task = YardGhurt::GHPSyncTask.new do |task|
+        task.ghp_dir = ghp_dir
+        task.sync_args.push(*sync_args) unless sync_args.nil?
+      end
+
+      sync_task = Rake::Task[sync_task.name]
+
+      sync_task.reenable
+      sync_task.invoke(deploy)
+
+      app.ran_cmd = true
+    end
+  end
+end

data/lib/raketary/github_pkg_cmd.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of Raketary.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
+#++
+
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'raketary/cmd'
+require 'raketeer/github_pkg_task'
+
+
+module Raketary
+  ###
+  # @author Jonathan Bradley Whited
+  # @since  0.1.2
+  ###
+  class GitHubPkgCmd < Cmd
+    def initialize(*)
+      super
+
+      parse! do |op|
+        op.on('-u','--user STR','set the GitHub username')
+
+        op.separator op.summary_indent
+      end
+    end
+
+    def run
+      super()
+
+      ghpkg_task = Raketeer::GitHubPkgTask.new do |task|
+        task.username = app.options[:user]
+      end
+
+      ghpkg_task = Rake::Task[ghpkg_task.name]
+
+      ghpkg_task.reenable
+      ghpkg_task.invoke
+
+      app.ran_cmd = true
+    end
+  end
+end