devops_assist 0.3.3 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94fff44947bd07b1d4c7910725c8fce1087f59d8fa3b4def053247c25bebb45
-  data.tar.gz: 309bcac9863e931d30dc81bea711bdae626c92c2824a03f468e41083dcf702aa
+  metadata.gz: 25dcd969f150b40b494562e4a2f4247fa93839857452687d84dce8727fdc12cf
+  data.tar.gz: 2ba0fc856e8dc5aacbaa63119a81f8d686321e6766fc1894ae2a1e7298ac3327
 SHA512:
-  metadata.gz: e8be68bcaaa7588f487f1eaad1e6961feba147b12f4646373ca27552ce7ab6d2a8713475b86e2fd43475e4b6afb9e868d28f94f3e5855629b66e5da7fdf15a8a
-  data.tar.gz: 3b621c532af465206a6833fadcfe5a8fd7b759f627b74102868e7d584ea3296a44cec0b13d240933187478dd182342db836b48557d42071fe0af018e50eddf75
+  metadata.gz: 3d2102fef7458504a64dec4a66f776127d9d712d2507a005327bd4e27085da9638eb22d343b96035ef36e567067f782c2b9a3d04bae8174f5a73f9e0fcdef94d
+  data.tar.gz: 448b1b76f9f4faa3dc9e66096cd681b087dc3e74a590da0a557d0ef58acf7be10602cf6557831a09f4f9de07df8cec48bd24a74730df0b4f849011e31950d3d4

data/.release_history.yml

@@ -19,4 +19,10 @@ devops_assist:
 - :version: 0.3.1
   :timestamp: 1664976434.566908
 - :version: 0.3.2
-  :timestamp: 1679541322.329349
+  :timestamp: 1679806218.9064217
+- :version: 0.3.4
+  :timestamp: 1679814741.9125335
+- :version: 0.3.4
+  :timestamp: 1679814912.2051551
+- :version: 0.3.4
+  :timestamp: 1679814952.708086

data/Gemfile

@@ -9,7 +9,8 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-#gem "git_cli", git: "git_cli", branch: "master"
-#gem "git_cli_prompt", git: "git_cli_prompt", branch: "master"
+#gem "git_cli", path: '../../git/git_cli'
+#gem "git_cli_prompt", path: '../../git/git_cli_prompt'
 #
+#gem 'toolrack', path: '../../WIP/toolrack'
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    devops_assist (0.3.3)
+    devops_assist (0.3.5)
       git_cli
       git_cli_prompt
       gvcs
@@ -19,7 +19,7 @@ GEM
       ptools (~> 1.4.0)
       teLogger
       toolrack
-    git_cli_prompt (0.3.1)
+    git_cli_prompt (0.3.2)
       teLogger
       toolrack
       tty-prompt
@@ -42,7 +42,7 @@ GEM
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
     teLogger (0.2.2)
-    toolrack (0.20.1)
+    toolrack (0.20.2)
       base58
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -57,7 +57,6 @@ GEM
     wisper (2.0.1)
 
 PLATFORMS
-  x86_64-darwin-21
   x86_64-linux
 
 DEPENDENCIES

data/lib/Rakefile

@@ -4,5 +4,6 @@
 
 path = File.expand_path(File.dirname(__FILE__))
 Dir.glob("#{path}/../tasks/**/*.rake").each { |f| 
+  #p f
   import f 
 }

data/lib/devops_assist/gem/{gem.rb → gem_utils.rb}

@@ -1,18 +1,19 @@
 
 require 'yaml'
 
-require_relative 'gemspec'
-
 module DevopsAssist
-  module Gem
+  class GemUtils
     include TR::CondUtils
-    include Gemspec
 
-    class GemError < StandardError; end
+    class GemUtilsError < StandardError; end
+
+    def initialize(gemRoot)
+      @root = gemRoot
+    end
 
-    def update_gem_version(root, newVersion, &block)
+    def update_gem_version(newVersion, &block)
 
-      version_file = find_gem_version_file(root)
+      version_file = find_gem_version_file
 
       if version_file.length > 1
         if block
@@ -25,7 +26,7 @@ module DevopsAssist
         selVerFile = version_file.first
       end
 
-      tmpFile = File.join(File.dirname(selVerFile),"version.rb.tmp")
+      tmpFile = File.join(File.dirname(selVerFile),"version-da.bak")
       FileUtils.mv(selVerFile,tmpFile)
 
       File.open(selVerFile,"w") do |f|
@@ -40,22 +41,18 @@ module DevopsAssist
         end
       end
 
-      FileUtils.rm tmpFile
+      FileUtils.rm(tmpFile)
 
       selVerFile
 
     end
 
-    def find_gem_version_file(root)
-      if is_empty?(root)
-         raise GemError, "Root path '#{root}' to find_gem_version_file is empty"
-      else
-        Dir.glob(File.join(root,"**/version.rb"))
-      end
+    def find_gem_version_file
+      raise GemUtilsError, "Root path '#{@root}' to find_gem_version_file is empty" if is_empty?(@root)
+      Dir.glob(File.join(@root,"**/version.rb"))
     end
 
-
-    def publish_gem(version, opts = { }, &block)
+    def self.publish_gem(version, opts = { }, &block)
 
       cred = find_rubygems_api_key
 
@@ -90,7 +87,7 @@ module DevopsAssist
 
     end
 
-    def publish_gem_file(gemfile, opts = { }, &block)
+    def self.publish_gem_file(gemfile, opts = { }, &block)
 
       cred = find_rubygems_api_key
 
@@ -116,17 +113,43 @@ module DevopsAssist
 
     end
 
+    def gem_name
+      gemspec.name
+    end
+
+    def gem_version_string
+      gem_version.version
+    end
+
+    def gem_version
+      gemspec.version
+    end
+
+    def gemspec
+      raise GemUtilsError, "Root path is not given" if is_empty?(@root)
+
+      if @_gemSpec.nil?
+        @_gemSpec = ::Gem::Specification.load(Dir.glob(File.join(@root,"*.gemspec")).first)
+        raise GemUtilsError, "Cannot find gemspec from #{@root}" if @_gemSpec.nil?
+      end
+
+      @_gemSpec
+    end
 
     private
-    def logger
+    def self.logger
       if @logger.nil?
         @logger = TeLogger::Tlogger.new
-        @logger.tag = :gem
+        @logger.tag = :gem_utils
       end
       @logger
     end
 
-    def find_rubygems_api_key
+    def logger
+      self.class.logger
+    end
+
+    def self.find_rubygems_api_key
       if TR::RTUtils.on_windows?
         credFile = File.join(ENV['USERPROFILE'],".gem","credentials")
       else

data/lib/devops_assist/release_log/release_log.rb

@@ -23,7 +23,7 @@ module DevopsAssist
       raise ReleaseLogError, "Release name cannot be empty" if is_empty?(relName)
       raise ReleaseLogError, "Version cannot be empty" if is_empty?(version)
 
-      raise ReleaseLogError, "Version '#{version}' already in the log file for release '#{relName}'" if is_version_exist?(version, relName)
+      #raise ReleaseLogError, "Version '#{version}' already in the log file for release '#{relName}'" if is_version_exist?(version, relName)
 
       rec = { version: version, timestamp: Time.now.to_f }
       if block

data/lib/devops_assist/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
+
 
 module DevopsAssist
-  VERSION = "0.3.3"
+  VERSION = "0.3.5"
 end

data/lib/devops_assist/version_manager.rb

@@ -3,12 +3,11 @@ require 'tty/prompt'
 
 module DevopsAssist
   module VersionManager
-    extend DevopsAssist::Gem
     extend TR::VUtils
 
     def self.prompt_version(gemName, last_version = "0.1.0")
 
-      begin
+      #begin
 
         last_version = "0.1.0" if is_empty?(last_version)
 
@@ -16,15 +15,12 @@ module DevopsAssist
         vers = possible_versions(last_version)
 
         vv = []
-
         vv << vers[2]
         vv << vers[1]
         vv << vers[0]
 
-        #vers << "Custom"
-        #vers << "Quit"
-        vv << "Custom"
-        vv << "Quit"
+        #vv << "Custom"
+        #vv << "Quit"
         #vers << [ \
         #          "Maybe not now..." \
         #          ,"Nah, forget it..." \
@@ -35,20 +31,24 @@ module DevopsAssist
           vv.each do |v|
             menu.choice v
           end
+
+          menu.choice "#{last_version} (current version - no change in version)", last_version
+          menu.choice "Custom version number", :custom
+          menu.choice "Abort", :abort
         end
 
         case vsel
-        when "Custom"
+        when :custom
           vsel = pmt.ask("  Please provide custom version no:", required: true) 
-        when vv[-1]
+        when :abort
           raise DevopsAssist::Error, "  Aborted. Have a nice day! " 
         end
 
         vsel
 
-      rescue TTY::Reader::InputInterrupt
-        raise DevopsAssist::Error
-      end
+      #rescue TTY::Reader::InputInterrupt
+      #  raise DevopsAssist::Error
+      #end
       
     end
 

data/lib/devops_assist.rb

@@ -5,7 +5,7 @@ require_relative 'devops_assist/release_log/release_log'
 
 require_relative 'devops_assist/vcs/git/cli_prompt'
 
-require_relative 'devops_assist/gem/gem'
+require_relative 'devops_assist/gem/gem_utils'
 
 require_relative 'devops_assist/version_manager'
 
@@ -19,23 +19,6 @@ module DevopsAssist
   EnvKey = "DEVOPS_ASSIST"
   EnvKeyGemReleasing = "#{EnvKey}_GEM_RELEASING"
 
-  def self.is_debug_mode?
-    val = ENV["DEVOPS_ASSIST_DEBUG"]
-    (not val.nil? and val.downcase == "true")
-  end
-
-  def self.debug(msg)
-    logger.tdebug(:devops_assist, msg) if is_debug_mode?
-  end
-
-  private
-  def logger
-    if @logger.nil?
-      @logger = TeLogger::TLogger.new(STDOUT)
-    end
-    @logger
-  end
-
 end
 
 # load the rake tasks

data/tasks/devops_assist.rake

@@ -3,43 +3,41 @@
 require_relative '../lib/devops_assist'
 require 'tty/prompt'
 
+include DevopsAssist
+
 namespace :devops do
 
-  desc "Release gem file project"
-  task :release do
+  desc "Initialize the directory"
+  task :init do
 
-    if DevopsAssist.is_debug_mode?
-      STDOUT.puts "\n *********** DEBUG MODE ACTIVATED *************\n\n"
-    end
+    root = Dir.getwd
 
+    gu = GemUtils.new(root)
+
+  end
+
+  desc "Release gem file project"
+  task :release do
+ 
+    root = Dir.getwd
+    gu = GemUtils.new(root)
     begin
 
       pmt = TTY::Prompt.new
 
-      root = Dir.getwd
-
       # let's mark the session to allow automated context switching
       ENV[DevopsAssist::EnvKeyGemReleasing] = "true"
 
-      gemName = find_gem_name(root)
+      gemName = gu.gem_name
 
       pmt.say "  Starting gem release for gem #{gemName}", color: :yellow
 
-      DevopsAssist.debug "About to execute VCS Checkin"
-      # check in source code
-      res = Rake::Task["devops:vcs:checkin_changes"].execute
-      pmt.say "  Workspace check in done\n", color: :yellow
-
-      proceed = pmt.yes?(" Proceed with release? ") 
-      raise GitCliPrompt::UserAborted if not proceed
-
-      rl = DevopsAssist::ReleaseLogger.load
-
-      # select version
-      ver = DevopsAssist::VersionManager.prompt_version(gemName, rl.last_version_number(gemName))
-      pmt.say "  Version no. '#{ver}' chosen", color: :yellow
+      # select version 
+      #ver = DevopsAssist::VersionManager.prompt_version(gemName, rl.last_version_number(gemName))
+      ver = DevopsAssist::VersionManager.prompt_version(gemName, gu.gem_version_string)
+      pmt.say "  Version '#{ver}' is chosen", color: :yellow
 
-      selVerFile = update_gem_version(root, ver) do |*args|
+      selVerFile = gu.update_gem_version(ver) do |*args|
         ops = args.first
         case ops
         when :select_version_file
@@ -50,33 +48,85 @@ namespace :devops do
       end
       pmt.say "  Version file updated", color: :yellow
 
-      # build the gem
+
+      # check in source code
+      # Check in must be done 1st or else the 'gem build' process will fail
+      # because build will use git command. For any files that already deleted,
+      # the build will failed to find the files and throw exception
+      res = Rake::Task["devops:vcs:checkin_changes"].execute
+      pmt.say "  Workspace check in done\n", color: :yellow
+
+      proceed = pmt.yes?(" Proceed to build the gem? ", color: :yellow) 
+      raise GitCliPrompt::UserAborted if not proceed
+
+
+      # test build the gem, make sure there is no error
+      # If error expected the scripts stops here
       Rake::Task["build"].execute
 
+      # Record the version number in the log files 
+      # for reporting traceability
+      rl = DevopsAssist::ReleaseLogger.load
       rl.log_release(gemName, ver)
-      pmt.say "  Release version number is logged", color: :yellow
+      #pmt.say "  Release version number is logged after successful test built", color: :yellow
+
+      ## If successfully built, following files shall be changed
+      #miscFiles = []
+      #miscFiles << selVerFile  # version.rb
+      #miscFiles << DevopsAssist::ReleaseLogger::LOG_NAME  # release_history.yml
+      #miscFiles << 'Gemfile.lock'
+      #Rake::Task["devops:vcs:checkin_misc_files"].execute({ root: root, files: miscFiles, version: ver })
+      #pmt.say "  Updated files during release prep have committed into version control", color: :yellow
+
+      ## check in source code
+      #res = Rake::Task["devops:vcs:checkin_changes"].execute
+      #pmt.say "  Workspace check in done\n", color: :yellow
+
+      #proceed = pmt.yes?(" Proceed with release? ") 
+      #raise GitCliPrompt::UserAborted if not proceed
+
+      # 
+      # Actual building the real gems build the gem
+      # Any possible reasons here error but not the one above?
+      #
+      # Main reason to do double build is to avoid to generate
+      # 2 log entries in Git for each build, which the 2nd (latest) 
+      # log is just about the version updates (version pre 0.4.x way)
+      #
+      #Rake::Task["build"].execute
+
+      #rl.log_release(gemName, ver)
+      #pmt.say "  Release version number is logged", color: :yellow
 
       # publish gem
       Rake::Task["devops:gem:publish_gem"].execute({ version: ver, pmt: pmt })
 
       # following files shall change when gem is built
-      miscFiles = []
-      miscFiles << selVerFile
-      miscFiles << DevopsAssist::ReleaseLogger::LOG_NAME
-      miscFiles << 'Gemfile.lock'
-      Rake::Task["devops:vcs:checkin_misc_files"].execute({ root: root, files: miscFiles, version: ver })
-      pmt.say "  Updated files during release prep have committed into version control", color: :yellow
+      #miscFiles = []
+      #miscFiles << selVerFile
+      #miscFiles << DevopsAssist::ReleaseLogger::LOG_NAME
+      #miscFiles << 'Gemfile.lock'
+      #Rake::Task["devops:vcs:checkin_misc_files"].execute({ root: root, files: miscFiles, version: ver })
+      #pmt.say "  Updated files during release prep have committed into version control", color: :yellow
 
       Rake::Task["devops:vcs:tag_source_code"].execute({ root: root, version: ver })
       pmt.say "  Source code is tagged as version #{ver}", color: :yellow
 
       Rake::Task["devops:vcs:push_source_code"].execute({ root: root, pmt: pmt })
 
+      install = pmt.yes?(" Install the released gem to local environment? ")
+      if install
+        STDOUT.puts `gem install pkg/#{gemName}-#{ver}.gem`
+      end
+
+      pmt.say " Gem #{gemName} version #{ver} released successfully ", color: :green
+
     rescue GitCliPrompt::UserAborted, GitCliPrompt::UserChangedMind, TTY::Reader::InputInterrupt
+      STDOUT.puts
     rescue Exception => ex
       STDERR.puts ex.message
-      STDERR.puts ex.backtrace.join('\n') if DevopsAssist.is_debug_mode?
       STDOUT.puts "\n\nAborted\n"
+      #STDERR.puts ex.backtrace.join('\n')
     end
 
   end

data/tasks/gem.rake

@@ -3,7 +3,7 @@ require_relative '../lib/devops_assist'
 
 require 'tty/prompt'
 
-include DevopsAssist::Gem
+#include DevopsAssist::Gem
 include TR::VUtils
 
 namespace :devops do
@@ -14,7 +14,9 @@ namespace :devops do
 
       root = Dir.getwd
 
-      selVerFile = update_gem_version(root, args) do |*args|
+      gu = GemUtils.new(root)
+
+      selVerFile = gu.update_gem_version(args) do |*args|
         ops = args.first
         case ops
         when :select_version_file
@@ -34,45 +36,40 @@ namespace :devops do
       pmt = args[:pmt]
       version = args[:version]
 
-      begin
-        ans = pmt.yes?("  Proceed to publish the gem to Rubygems?")
-        if ans
-          res, tg, out = publish_gem(version) do |*args|
-            ops = args.first
-            case ops
-            when :multiple_rubygems_account
-              acct = args[1]
-              selAct = pmt.select("  Please select one of the Rubygems credential to release:") do |menu|
-
-                acct.each do |k,v|
-                  menu.choice k, k
-                end
-
-                menu.choice "Skip", :skip
-                menu.choice "Quit", :quit
-
+      ans = pmt.yes?("  Proceed to publish the gem to Rubygems?")
+      if ans
+        res, tg, out = GemUtils.publish_gem(version) do |*args|
+          ops = args.first
+          case ops
+          when :multiple_rubygems_account
+            acct = args[1]
+            selAct = pmt.select("  Please select one of the Rubygems credential to release:") do |menu|
+              
+              acct.each do |k,v|
+                menu.choice k, k
               end
 
-              raise DevopsAssist::Error, " Aborted. Have a nice day " if selAct == :quit
+              menu.choice "Skip", :skip
+              menu.choice "Quit", :quit
 
-              selAct
             end
+            
+            raise DevopsAssist::Error, " Aborted. Have a nice day " if selAct == :quit
+
+            selAct
           end
+        end
 
-          pmt.say("  Gem publishing is skipped", color: :yellow) if res == :skipped
+        pmt.say("  Gem publishing is skipped", color: :yellow) if res == :skipped
 
-          if res.respond_to?(:success?)
-            if res.success?
-              pmt.say "  Gem published!\n", color: :yellow
-            else
-              pmt.say "  Gem publishing failed. Return message :\n#{out}", color: :red
-            end
+        if res.respond_to?(:success?)
+          if res.success?
+            pmt.say "  Gem published!\n", color: :yellow
+          else
+            pmt.say "  Gem publishing failed. Return message :\n#{out}", color: :red
           end
-
         end
 
-      rescue Exception => ex
-        pmt.error "Pushing to Rubygems failed. Error was : #{ex.message}\n\nPlease manually release to Rubygems"
       end
 
     end

data/tasks/vcs.rake

@@ -7,7 +7,12 @@ namespace :devops do
     desc "Checking in changes of source code"
     task :checkin_changes do
       cli = DevopsAssist::Vcs::Git::CliPrompt.new 
-      cli.commit(Dir.getwd)
+      cli.commit(Dir.getwd) do |ops|
+        case ops
+        when :raise_to_parent
+          true
+        end
+      end
     end
 
     desc "Checking in files generated by devops assist"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devops_assist
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.5
 platform: ruby
 authors:
 - Chris Liaw
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toolrack
@@ -112,8 +112,7 @@ files:
 - devops_assist.gemspec
 - lib/Rakefile
 - lib/devops_assist.rb
-- lib/devops_assist/gem/gem.rb
-- lib/devops_assist/gem/gemspec.rb
+- lib/devops_assist/gem/gem_utils.rb
 - lib/devops_assist/release_log/release_log.rb
 - lib/devops_assist/vcs/git/cli_prompt.rb
 - lib/devops_assist/vcs/vcs.rb
@@ -125,7 +124,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -141,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.6
-signing_key:
+signing_key: 
 specification_version: 4
 summary: ''
 test_files: []

data/lib/devops_assist/gem/gemspec.rb

@@ -1,28 +0,0 @@
-
-
-module DevopsAssist
-  module Gem
-    module Gemspec
-      include TR::CondUtils 
-
-      class GemspecError < StandardError; end
-
-      def find_gem_name(root)
-        spec = find_gemspec(root)
-        s = ::Gem::Specification.load(spec)
-        s.name
-      end
-
-      private
-      def find_gemspec(root)
-        if is_empty?(root)
-          raise GemspecError, "Root path '#{root}' to find_gemspec is empty"
-        else
-          Dir.glob(File.join(root,"*.gemspec")).first
-        end
-      end
-
-    end
-  end
-end
-