raketeer 0.2.13 → 0.2.14

data/lib/raketeer/bump_task.rb

@@ -3,12 +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 'date'
 require 'rake'
 require 'rake/tasklib'
@@ -18,19 +17,16 @@ require 'raketeer/sem_ver'
 require 'raketeer/util'
 
 module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.4
-  ###
+  # @since 0.2.4
   class BumpTask < Rake::TaskLib
     attr_accessor :bump_bundle
-    attr_accessor :bump_files # Looks for a version number
+    attr_accessor :bump_files # Looks for a version number.
     attr_accessor :bundle_cmd
-    attr_accessor :changelogs # Looks for 'Unreleased' & a Markdown header
+    attr_accessor :changelogs # Looks for 'Unreleased' & a Markdown header.
     attr_accessor :dry_run
     attr_accessor :git_msg
     attr_accessor :name
-    attr_accessor :ruby_files # Looks for {ruby_var}
+    attr_accessor :ruby_files # Looks for {ruby_var}.
     attr_accessor :ruby_var
     attr_accessor :strict
 
@@ -38,7 +34,7 @@ module Raketeer
     alias_method :dry_run?,:dry_run
     alias_method :strict?,:strict
 
-    def initialize(name=:bump)
+    def initialize(name = :bump)
       super()
 
       @bump_bundle = false
@@ -48,40 +44,40 @@ module Raketeer
       @dry_run = false
       @git_msg = "git commit -m 'Bump version to v%{version}'"
       @name = name
-      @ruby_files = Rake::FileList[File.join('lib','**','version.rb')]
+      @ruby_files = Rake::FileList['lib/**/version.rb']
       @ruby_var = 'VERSION'
       @strict = false
 
-      yield self if block_given?
+      yield(self) if block_given?
       define
     end
 
     def define
       desc 'Show/Set/Bump the version'
-      task @name,[:version] do |task,args|
+      task @name,[:version] do |_task,args|
         bump_all(BumpVer.new(
           version: args.version,
           major: ENV['major'],
           minor: ENV['minor'],
           patch: ENV['patch'],
           prerelease: ENV['pre'],
-          build_meta: ENV['build']
+          build_meta: ENV['build'],
         ))
       end
 
       namespace @name do
         desc 'Bump/Set the major version'
-        task :major,[:major] do |task,args|
+        task :major,[:major] do |_task,args|
           bump_ver = BumpVer.new(major: args.major)
 
-          # You can't erase the major version (required)
+          # You can't erase the major version (required).
           bump_ver.major = '+1' if bump_ver.major.nil? || bump_ver.major.empty?
 
           bump_all(bump_ver)
         end
 
         desc 'Bump/Set the minor version'
-        task :minor,[:minor] do |task,args|
+        task :minor,[:minor] do |_task,args|
           bump_ver = BumpVer.new(minor: args.minor)
           bump_ver.minor = '+1' if bump_ver.minor.nil?
 
@@ -89,7 +85,7 @@ module Raketeer
         end
 
         desc 'Bump/Set the patch version'
-        task :patch,[:patch] do |task,args|
+        task :patch,[:patch] do |_task,args|
           bump_ver = BumpVer.new(patch: args.patch)
           bump_ver.patch = '+1' if bump_ver.patch.nil?
 
@@ -97,7 +93,7 @@ module Raketeer
         end
 
         desc 'Set/Erase the pre-release version'
-        task :pre,[:pre] do |task,args|
+        task :pre,[:pre] do |_task,args|
           bump_ver = BumpVer.new(prerelease: args.pre)
           bump_ver.prerelease = '' if bump_ver.prerelease.nil?
 
@@ -105,7 +101,7 @@ module Raketeer
         end
 
         desc 'Set/Erase the build metadata'
-        task :build,[:build] do |task,args|
+        task :build,[:build] do |_task,args|
           bump_ver = BumpVer.new(build_meta: args.build)
           bump_ver.build_meta = '' if bump_ver.build_meta.nil?
 
@@ -130,7 +126,7 @@ module Raketeer
 
       sem_vers = []
 
-      # Order matters for outputting the most accurate version
+      # NOTE: Order matters for outputting the most accurate version.
       sem_vers << bump_ruby_files(bump_ver)
       sem_vers << bump_bump_files(bump_ver)
       sem_vers << bump_changelogs(bump_ver)
@@ -151,7 +147,7 @@ module Raketeer
       # should be without making changes.
       if !@git_msg.nil?
         puts '[Git]:'
-        puts '= ' + (@git_msg % {version: sem_vers[0].to_s})
+        puts "= #{format(@git_msg,version: sem_vers[0].to_s)}"
       end
     end
 
@@ -184,7 +180,7 @@ module Raketeer
       sh(*sh_cmd,verbose: false)
     end
 
-    # @see https://keepachangelog.com/en/1.0.0/
+    # @see https://keepachangelog.com/en/1.1.0
     def bump_changelogs(bump_ver)
       return nil if @changelogs.empty?
 
@@ -205,14 +201,14 @@ module Raketeer
         if bumper.line =~ unreleased_regex
           next if @unreleased_bumped
 
-          # Match from the end, in case the URL has a number (like '%20')
+          # Match from the end, in case the URL has a number (like '%20').
           match = bumper.line.match(/(#{SemVer.regex(@strict)})(\.{3}.*)\z/m)
 
           next if match.nil? || match.length < 3 || (i = match.begin(0)) < 1
 
           match = [bumper.line[0..i - 1],match[1],match[-1]]
 
-          next if match.any? {|m| m.nil? || m.strip.empty? }
+          next if match.any? { |m| m.nil? || m.strip.empty? }
 
           orig_line = bumper.line.dup
           bumper.line = match[1]
@@ -237,7 +233,7 @@ module Raketeer
 
           match = [match[1],match[2],match[-1]]
 
-          next if match.any? {|m| m.nil? || m.strip.empty? }
+          next if match.any? { |m| m.nil? || m.strip.empty? }
 
           orig_line = bumper.line.dup
           bumper.line = match[1]
@@ -253,8 +249,8 @@ module Raketeer
 
             bumper.line = (match[0] << bumper.line)
 
-            # Replace the date with today's date for the new Markdown header, if it exists
-            match[2].sub!(/\d+\s*\-\s*\d+\s*\-\s*\d+(.*)\z/m,"#{Date.today.strftime('%F')}\\1")
+            # Replace the date with today's date for the new Markdown header, if it exists.
+            match[2].sub!(/\d+\s*-\s*\d+\s*-\s*\d+(.*)\z/m,"#{Date.today.strftime('%F')}\\1")
 
             # Fix the link if there is one:
             #   https://github.com/esotericpig/raketeer/compare/v0.2.10...v0.2.11
@@ -266,10 +262,11 @@ module Raketeer
             versions_match = match[2].match(versions_regex)
 
             if versions_match
-              match[2].sub!(versions_regex,
+              match[2].sub!(
+                versions_regex,
                 "#{versions_match[:end_ver]}" \
                 "#{versions_match[:sep]}" \
-                "#{bumper.sem_ver}"
+                "#{bumper.sem_ver}",
               )
             end
 
@@ -281,7 +278,7 @@ module Raketeer
             bumper.line << "\n\n"
           end
 
-          # We are adding a new Markdown header, so always set the line back to its original value
+          # We are adding a new Markdown header, so always set the line back to its original value.
           bumper.line = orig_line
         end
       end
@@ -299,7 +296,7 @@ module Raketeer
         next if bumper.changes > 0 || !bumper.sem_ver.nil?
         next if (match = bumper.line.match(version_var_regex)).nil?
         next if match.length < 4
-        next if match[1..2].any? {|m| m.nil? || m.strip.empty? }
+        next if match[1..2].any? { |m| m.nil? || m.strip.empty? }
 
         orig_line = bumper.line.dup
         bumper.line = match[2]
@@ -330,32 +327,32 @@ module Raketeer
     end
 
     def print_help
-      puts <<-HELP
-rake #{@name}  # Print the current version
-
-# You can run a dry run for any task (will not write to files)
-rake #{@name} dryrun=true
-
-rake #{@name}[1.2.3-alpha.4-beta.5]       # Set the version manually
-rake #{@name} major=1 minor=2 patch=3     # Set the version numbers
-rake #{@name} pre=alpha.4 build=beta.5    # Set the version extensions
-rake #{@name} major=+1 minor=+1 patch=+1  # Bump the version numbers by 1
-rake #{@name} major=+2 minor=+3 patch=+4  # Bump the version numbers by X
-
-rake #{@name}:major          # Bump the major version by 1
-rake #{@name}:major[1]       # Set the major version to 1
-rake #{@name}:major[+2]      # Bump the major version by 2
-rake #{@name}:minor          # Bump the minor version by 1
-rake #{@name}:minor[2]       # Set the minor version to 2
-rake #{@name}:minor[+3]      # Bump the minor version by 3
-rake #{@name}:patch          # Bump the patch version by 1
-rake #{@name}:patch[3]       # Set the patch version to 3
-rake #{@name}:patch[+4]      # Bump the patch version by 4
-rake #{@name}:pre            # Erase the pre-release version
-rake #{@name}:pre[alpha.4]   # Set the pre-release version
-rake #{@name}:build          # Erase the build metadata
-rake #{@name}:build[beta.5]  # Set the build metadata
-rake #{@name}:bundle         # Bump the Gemfile.lock version
+      puts <<~HELP
+        rake #{@name}  # Print the current version
+
+        # You can run a dry run for any task (will not write to files)
+        rake #{@name} dryrun=true
+
+        rake #{@name}[1.2.3-alpha.4-beta.5]       # Set the version manually
+        rake #{@name} major=1 minor=2 patch=3     # Set the version numbers
+        rake #{@name} pre=alpha.4 build=beta.5    # Set the version extensions
+        rake #{@name} major=+1 minor=+1 patch=+1  # Bump the version numbers by 1
+        rake #{@name} major=+2 minor=+3 patch=+4  # Bump the version numbers by X
+
+        rake #{@name}:major          # Bump the major version by 1
+        rake #{@name}:major[1]       # Set the major version to 1
+        rake #{@name}:major[+2]      # Bump the major version by 2
+        rake #{@name}:minor          # Bump the minor version by 1
+        rake #{@name}:minor[2]       # Set the minor version to 2
+        rake #{@name}:minor[+3]      # Bump the minor version by 3
+        rake #{@name}:patch          # Bump the patch version by 1
+        rake #{@name}:patch[3]       # Set the patch version to 3
+        rake #{@name}:patch[+4]      # Bump the patch version by 4
+        rake #{@name}:pre            # Erase the pre-release version
+        rake #{@name}:pre[alpha.4]   # Set the pre-release version
+        rake #{@name}:build          # Erase the build metadata
+        rake #{@name}:build[beta.5]  # Set the build metadata
+        rake #{@name}:bundle         # Bump the Gemfile.lock version
       HELP
     end
   end

data/lib/raketeer/bump_ver.rb

@@ -3,21 +3,17 @@
 
 #--
 # 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/sem_ver'
 
 module Raketeer
-  ###
   # Bump Version
   #
-  # @author Jonathan Bradley Whited
-  # @since  0.2.4
-  ###
+  # @since 0.2.4
   class BumpVer < SemVer
     def initialize(version: nil,major: nil,minor: nil,patch: nil,prerelease: nil,build_meta: nil)
       super()
@@ -41,7 +37,7 @@ module Raketeer
     end
 
     def init_str(obj)
-      return obj.nil? ? nil : obj.to_s.strip
+      return obj&.to_s&.strip
     end
 
     def bump!(sem_ver)
@@ -52,7 +48,7 @@ module Raketeer
           if @major.is_a?(Integer)
             sem_ver.major = @major
           elsif @major.empty?
-            sem_ver.major = 0 # There must always be a major version
+            sem_ver.major = 0 # There must always be a major version.
           else
             sem_ver.major = 0 if sem_ver.major.nil?
 
@@ -105,19 +101,10 @@ module Raketeer
         end
 
         if !@prerelease.nil?
-          if @prerelease.empty?
-            sem_ver.prerelease = nil
-          else
-            sem_ver.prerelease = @prerelease
-          end
+          sem_ver.prerelease = @prerelease.empty? ? nil : @prerelease
         end
-
         if !@build_meta.nil?
-          if @build_meta.empty?
-            sem_ver.build_meta = nil
-          else
-            sem_ver.build_meta = @build_meta
-          end
+          sem_ver.build_meta = @build_meta.empty? ? nil : @build_meta
         end
       end
 

data/lib/raketeer/files_bumper.rb

@@ -3,20 +3,16 @@
 
 #--
 # 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_ver'
 require 'raketeer/sem_ver'
 
 module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.4
-  ###
+  # @since 0.2.4
   class FilesBumper
     attr_reader :bump_ver
     attr_reader :bump_ver_empty
@@ -55,7 +51,7 @@ module Raketeer
       @lines << line if push
     end
 
-    def bump_files(&block)
+    def bump_files
       @files.each do |filename|
         puts "[#{filename}]:"
 
@@ -65,7 +61,7 @@ module Raketeer
           next
         end
 
-        @changes = 0 # For possible future use
+        @changes = 0 # For possible future use.
         @lines = []
         @sem_ver = nil
 
@@ -74,7 +70,7 @@ module Raketeer
         File.foreach(filename) do |line|
           @line = line
 
-          block.call(self) if !@line.strip.empty?
+          yield(self) if !@line.strip.empty?
 
           @lines << @line
         end
@@ -91,7 +87,7 @@ module Raketeer
               file.puts @lines
             end
 
-            puts "#{@changes} change#{@changes == 1 ? '' : 's'} written"
+            puts "#{@changes} change#{'s' if @changes == 1} written"
           end
         else
           puts "Nothing written (up-to-date): #{@sem_ver}"

data/lib/raketeer/github_pkg.rb

@@ -3,22 +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/github_pkg_task'
 
-
-module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.8
-  ###
-  module GitHubPkg
-  end
-end
-
 Raketeer::GitHubPkgTask.new # @since 0.2.8

data/lib/raketeer/github_pkg_task.rb

@@ -3,29 +3,24 @@
 
 #--
 # 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 'rake'
 require 'rake/tasklib'
 require 'raketeer/util'
 
-
 module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.8
-  ###
+  # @since 0.2.8
   class GitHubPkgTask < Rake::TaskLib
     attr_accessor :deps
     attr_accessor :description
     attr_accessor :name
     attr_accessor :username
 
-    def initialize(name=:github_pkg)
+    def initialize(name = :github_pkg)
       super()
 
       @deps = [:build]
@@ -33,7 +28,7 @@ module Raketeer
       @name = name
       @username = nil
 
-      yield self if block_given?
+      yield(self) if block_given?
 
       @username = Util.find_github_username if @username.nil?
 
@@ -44,13 +39,13 @@ module Raketeer
 
     def define
       desc @description
-      task @name => Array(@deps) do |task,args|
+      task @name => Array(@deps) do |_task,_args|
         sh_cmd = ['gem']
 
         sh_cmd.push('push')
         sh_cmd.push('--key','github')
         sh_cmd.push('--host',"https://rubygems.pkg.github.com/#{username}")
-        sh_cmd.push(*Dir.glob(File.join('pkg','*.gem'))) # Is this okay for multiple gems?
+        sh_cmd.push(*Dir.glob('pkg/*.gem')) # TODO: Is this okay for multiple gems?
 
         sh(*sh_cmd)
       end

data/lib/raketeer/irb.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/irb_task'
 
-module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.2.0
-  ###
-  module IRB
-  end
-end
-
 Raketeer::IRBTask.new # @since 0.2.0

data/lib/raketeer/irb_task.rb

@@ -3,23 +3,17 @@
 
 #--
 # 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 'rake'
-
 require 'rake/tasklib'
-
 require 'raketeer/util'
 
 module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
+  # @since 0.1.0
   class IRBTask < Rake::TaskLib
     attr_accessor :description
     attr_accessor :irb_cmd
@@ -29,7 +23,7 @@ module Raketeer
 
     alias_method :warning?,:warning
 
-    def initialize(name=:irb)
+    def initialize(name = :irb)
       super()
 
       @description = 'Open an irb session loaded with this library'
@@ -41,7 +35,7 @@ module Raketeer
       @irb_cmd.push('-r','rubygems')
       @irb_cmd.push('-r','bundler/setup')
 
-      yield self if block_given?
+      yield(self) if block_given?
 
       @irb_cmd.push('-r',@main_module) unless @main_module.nil?
       @irb_cmd << '-w' if @warning
@@ -51,7 +45,7 @@ module Raketeer
 
     def define
       desc @description
-      task @name do |task,args|
+      task @name do |_task,_args|
         sh(*@irb_cmd)
       end
     end

data/lib/raketeer/nokogiri_install_tasks.rb

@@ -3,21 +3,16 @@
 
 #--
 # 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 'rake'
-
 require 'rake/tasklib'
 
 module Raketeer
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
+  # @since 0.1.0
   class NokogiriInstallTask < Rake::TaskLib
     attr_accessor :description
     attr_accessor :install_cmd
@@ -40,58 +35,49 @@ module Raketeer
       end
     end
 
-    def run(task,args)
+    def run(_task,_args)
       sh(*@install_cmd)
     end
   end
 
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
+  # @since 0.1.0
   class NokogiriAPTTask < NokogiriInstallTask
-    def initialize(name=:nokogiri_apt,&block)
+    def initialize(name = :nokogiri_apt,&block)
       super(name)
 
       @description = 'Install Nokogiri libs for Ubuntu/Debian'
 
-      @install_cmd = %w[ sudo apt-get install ]
-      @install_cmd << 'build-essential'
-      @install_cmd << 'libgmp-dev'
-      @install_cmd << 'liblzma-dev'
-      @install_cmd << 'patch'
-      @install_cmd << 'ruby-dev'
-      @install_cmd << 'zlib1g-dev'
+      @install_cmd = %w[
+        sudo apt install
+        zlib1g-dev liblzma-dev patch
+        build-essential ruby-dev
+        xz-utils libgmp-dev
+      ]
 
       define(&block)
     end
   end
 
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
+  # @since 0.1.0
   class NokogiriDNFTask < NokogiriInstallTask
-    def initialize(name=:nokogiri_dnf,&block)
+    def initialize(name = :nokogiri_dnf,&block)
       super(name)
 
       @description = 'Install Nokogiri libs for Fedora/CentOS/Red Hat'
 
-      @install_cmd = %w[ sudo dnf install ]
-      @install_cmd << 'gcc'
-      @install_cmd << 'ruby-devel'
-      @install_cmd << 'zlib-devel'
+      @install_cmd = %w[
+        sudo dnf install
+        zlib-devel xz patch
+        make gcc rpm-build ruby-devel
+      ]
 
       define(&block)
     end
   end
 
-  ###
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
+  # @since 0.1.0
   class NokogiriOtherTask < NokogiriInstallTask
-    def initialize(name=:nokogiri_other,&block)
+    def initialize(name = :nokogiri_other,&block)
       super(name)
 
       @description = 'Install Nokogiri libs for other OSes'
@@ -99,7 +85,7 @@ module Raketeer
       define(&block)
     end
 
-    def run(task,args)
+    def run(_task,_args)
       puts 'Please go to this link for installing Nokogiri on your system:'
       puts '  https://nokogiri.org/tutorials/installing_nokogiri.html'
     end

data/lib/raketeer/nokogiri_installs.rb

@@ -3,25 +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/nokogiri_install_tasks'
 
-module Raketeer
-  ###
-  # Defines all Nokogiri install tasks in your Rakefile.
-  #
-  # @author Jonathan Bradley Whited
-  # @since  0.1.0
-  ###
-  module NokogiriInstalls
-  end
-end
-
 Raketeer::NokogiriAPTTask.new # @since 0.1.0
 Raketeer::NokogiriDNFTask.new # @since 0.1.0
 Raketeer::NokogiriOtherTask.new # @since 0.1.0