raykit 0.0.48 → 0.0.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 813784e2e2ef134abf5ef7eb7b4ba008af772e3f515ee6b7ad39a986ef115189
-  data.tar.gz: 3481d836aa38b596be652dd76dedf8ef5260ed0aaf4634a9cdebbde6b6135056
+  metadata.gz: b317f633ca2cb66a7f82a200081804a133d96b5aa3a22a8a50857b69468954e2
+  data.tar.gz: 3af4b61349f2d5fbce324db2116c214dc83b56fd08a7bfff3f514b2898ac9ff3
 SHA512:
-  metadata.gz: 90e04166fb5a294b4843b2e86a09906949bda4ca6296fe87a58e12487bfe64470c127e5eaaea2982d72adb2d4f6fd9f2a76c65e600ca4e743749e9ee8c9553fc
-  data.tar.gz: 0d62b92d187aaa6c4d856f58ea52e66b6c3ba449e6bcd177777a8a200ba8ae617fcb39186c9c63319deb38e46630fb5e562697bea21425544963fab0920a5572
+  metadata.gz: 311ab8cf559de63e1fc696c72d31de74b7a534b12a16ab8e6ec9d3c14acd270f224a0844a0f1751d5f0909e30f5e753922bc9f193956a3d2d03389671043cbaf
+  data.tar.gz: cf2d8fa22bf9071247693857a436a01be66204ccae06cf89a56df7c4a7f09290d1eed663b06d7530935a2444ae6d5486f33af0c809b3190dc4061bb30efa334a

data/README.md

@@ -1,3 +1,3 @@
-# rakit
+# raykit
 
 ruby gem supporting rake ci/cd tasks

data/lib/raykit.rb

@@ -6,20 +6,22 @@ require_relative './raykit/environment.rb'
 require_relative './raykit/logging.rb'
 require_relative './raykit/command.rb'
 require_relative './raykit/rake.rb'
-#require_relative './raykit/runner.rb'
 require_relative './raykit/console.rb'
 require 'rainbow'
 require 'rake/clean'
 require 'open3'
+require 'rake/testtask'
+
+TIMER= Raykit::Timer.new
+LOG = Raykit::Logging.new
 
-#CLEAN.include("**/bin","**/obj")
 
 module Raykit
     def Raykit.run(command) 
+
+        LOG.log('Raykit.run',Logger::Severity::DEBUG,"begin executing #{command}")
         cmd = Command.new(command)
-        #cmd.command = command
-        #cmd.run()#command)
-        elapsed_str = Timer.get_elapsed_str(cmd.elapsed)
+        elapsed_str = Timer.get_elapsed_str(cmd.elapsed,0)
         if(cmd.exitstatus == 0)
             puts elapsed_str + " " +  Rainbow(cmd.command).yellow.bright
             return elapsed_str + " " + cmd.command

data/lib/raykit/command.rb

@@ -2,12 +2,19 @@ require 'open3'
 require 'timeout'
 require 'json'
 require 'logger'
-BUFFER_SIZE=1024 if(!defined?(BUFFER_SIZE))
 
+BUFFER_SIZE=1024 if(!defined?(BUFFER_SIZE))
 module Raykit
+    # Functionality to support executing and logging system commands
     class Command
+        # The timeout in seconds, defaults to 0 if not specified
         attr_accessor :timeout
-        attr_accessor :directory,:start_time,:elapsed
+        # The working directory, defaults the current directory if not specified
+        attr_accessor :directory
+        # The start time
+        attr_accessor :start_time
+        # The execution time in seconds
+        attr_accessor :elapsed
         attr_accessor :command,:output,:error,:exitstatus
 
         def init_defaults 
@@ -29,6 +36,7 @@ module Raykit
         end
 
         def run() 
+            #buffer_size=1024
             @start_time = Time.now
             timer = Timer.new
             if(@timeout == 0)

data/lib/raykit/console.rb

@@ -2,6 +2,7 @@ require 'optparse'
 
 module Raykit
 
+    # Parses the command line arguments for the Raykit console application
     class Parser
         def self.parse(options)
             hash=Hash.new
@@ -20,7 +21,11 @@ module Raykit
 
                 opts.on('-r','--rake [PATTERN]','rake [PATTERN]') do |pattern|
                     hash[:verb]="rake"
-                    hash[:pattern]=pattern
+                    if(pattern.nil?)
+                        hash[:pattern] = ''
+                    else
+                        hash[:pattern]=pattern
+                    end
                     return hash
                 end
 
@@ -35,6 +40,7 @@ module Raykit
         end
     end
 
+    # The implementation for the raykit console application
     class Console
         def self.run
             if(ARGV.length == 0)
@@ -89,18 +95,22 @@ module Raykit
         def self.rake(hash)
             Raykit::Git::remote_urls.each{|remote|
                 if(remote.include?(hash[:pattern]))
-                    puts "remote: #{remote}"
-                    cmd = Raykit::Rake::run(remote,'master')
-                    elapsed_str = Timer.get_elapsed_str(cmd.elapsed)
-                    if(cmd.exitstatus == 0)
-                        puts elapsed_str + " " +  Rainbow(cmd.command).yellow.bright + " (#{cmd.directory})"
-                        return elapsed_str + " " + cmd.command
-                    else
-                        puts "\r\n" + cmd.command + "\r\n"
-                        puts "\r\n" + cmd.output + "\r\n"
-                        puts "\r\n" + cmd.error + "\r\n"
-                        puts ''
-                        abort Rainbow(elapsed_str).red.bright + " " +  Rainbow(cmd.command).white
+                    begin
+                        puts "remote: #{remote}"
+                        cmd = Raykit::Rake::run(remote,'master')
+                        elapsed_str = Timer.get_elapsed_str(cmd.elapsed)
+                        if(cmd.exitstatus == 0)
+                            puts elapsed_str + " " +  Rainbow(cmd.command).yellow.bright + " (#{cmd.directory})"
+                            #return elapsed_str + " " + cmd.command
+                        else
+                            puts "\r\n" + cmd.command + "\r\n"
+                            puts "\r\n" + cmd.output + "\r\n"
+                            puts "\r\n" + cmd.error + "\r\n"
+                            puts ''
+                            puts Rainbow(elapsed_str).red.bright + " " +  Rainbow(cmd.command).white
+                        end
+                    rescue
+                        puts 'rescued...'
                     end
                 end
             }

data/lib/raykit/dotnet.rb

@@ -1,5 +1,6 @@
 module Raykit
     class DotNet
+        # initialize a C# library
         def self.initialize_csharp_lib(name)
             if(!Dir.exists?(name)) 
                 FileUtils.mkdir(name)
@@ -19,6 +20,7 @@ module Raykit
             end
         end
 
+        # initialize a C# console application
         def self.initialize_csharp_console(name)
             if(!Dir.exists?(name)) 
                 FileUtils.mkdir(name)

data/lib/raykit/environment.rb

@@ -1,52 +1,41 @@
+require 'pathname'
 
 module Raykit
+    # Provides functionality related to the development environment
     class Environment
-        def self.get_env key
-            ENV[key]
+        # Normalize a directory or filename to use forward slashes
+        def self.normalize_path(name)
+            name.gsub('\\','/')
         end
 
+        # The root directory for the development environment.
+        # May be set using the environment variable DEV_ROOT,
+        # otherwise defaults to the user home directory
         def self.root_dir
-            if(get_env('DEV_ROOT').nil?)
+            if(ENV['DEV_ROOT'].nil?)
                 Environment::home_dir
             else
-                get_env('DEV_ROOT').gsub('\\','/')
+                normalize_path(ENV['DEV_ROOT'])
             end
         end
          
+        # The user home directory
         def self.home_dir
-            get_env('HOME').gsub('\\','/')
+            normalize_path(ENV['HOME'])
         end
 
-        def self.log_dir
-            log_dir = "#{Environment::root_dir}/log"
-            if(!Dir.exist?(log_dir))
-                Dir.mkdir(log_dir)
-            end
-            log_dir
-        end
-
-        def self.work_dir
-            work_dir = "#{Environment::root_dir}/work"
-            if(!Dir.exist?(work_dir))
-                Dir.mkdir(work_dir)
-            end
-            work_dir
+        # Get, and create if it does not exist, a specific development directory
+        def self.get_dev_dir(name)
+            dir = Pathname.new("#{Environment::root_dir}/#{name}")
+            dir.mkpath
+            dir.to_s
         end
 
-        def self.clone_dir
-            work_dir = "#{Environment::root_dir}/work"
-            if(!Dir.exist?(work_dir))
-                Dir.mkdir(work_dir)
-            end
-            work_dir
-        end
-
-        def self.tmp_dir
-            dir = "#{Environment::root_dir}/tmp"
-            if(!Dir.exist?(dir))
-                Dir.mkdir(dir)
-            end
-            dir
+        # Get the size of a directory and its contents
+        def self.get_dir_size(dir)
+            Dir.glob(File.join(dir, '**', '*'))
+                .map{ |f| File.size(f) }
+                .inject(:+)
         end
     end
 end

data/lib/raykit/git.rb

@@ -33,6 +33,11 @@ module Raykit
             end
         end
 
+        # get the latest tag for the current directory
+        def self.get_latest_tag
+            `git describe --abbrev=0 --tags`.strip
+        end
+
         def self.get_current_branch
             text=`git branch`
             if(text.include?('HEAD detached'))
@@ -45,17 +50,13 @@ module Raykit
         end
 
         def self.get_latest_commit(remote,branch)
-            clone_dir="#{Environment::clone_dir}/#{get_relative_path(remote)}"
+            clone_dir="#{Environment::get_dev_dir('clone')}/#{get_relative_path(remote)}"
             if(!Dir.exist?(clone_dir))
                 parent_dir = File.expand_path('..',clone_dir)
                 if(!Dir.exist?(parent_dir))
                     FileUtils.mkdir_p(parent_dir)
                 end 
                 Command.new("git clone #{remote} #{clone_dir}")
-                #puts "cmd.command=#{cmd.command}"
-                #puts "cmd.exitstatus=#{cmd.exitstatus}"
-                #puts "cmd.output=#{cmd.output}"
-                #puts "cmd.error=#{cmd.error}"
             end
             Dir.chdir(clone_dir) do
                 Command.new('git pull')
@@ -96,7 +97,7 @@ module Raykit
         end
 
         def self.remote_urls
-            filename="#{Environment::log_dir}/Raykit.Git.RemoteUrls.json";
+            filename="#{Environment::get_dev_dir('log')}/Raykit.Git.RemoteUrls.json";
             if(File.exist?(filename))
                 JSON.parse(File.read(filename))
             else
@@ -105,7 +106,7 @@ module Raykit
         end
 
         def self.remote_urls=(urls)
-            filename="#{Environment::log_dir}/Raykit.Git.RemoteUrls.json"
+            filename="#{Environment::get_dev_dir('log')}/Raykit.Git.RemoteUrls.json"
             File.open(filename,'w'){|f|
                 f.write(JSON.generate(urls))
             }

data/lib/raykit/logging.rb

@@ -5,14 +5,19 @@ module Raykit
     class Logging
         attr_accessor :enabled,:loggers
 
+        # Logger::Severity DEBUG,ERROR,FATAL,INFO,UNKOWN,WARN
+        # defaults to WARN
+        attr_accessor :severity
+
         def initialize()
             @enabled = true
             @loggers = Hash.new
+            @severity= Logger::Severity::WARN
         end
 
         def get_logger(context)
             if(!loggers.has_key?(context))
-                Dir.chdir(Environment::log_dir) do
+                Dir.chdir(Environment::get_dev_dir('log')) do
                     # start the log over whenever the log exceeds 100 megabytes in size
                     loggers[context] = Logger.new("#{context}.log",0,100*1024*1024)
                 end
@@ -41,5 +46,5 @@ module Raykit
         end
     end
 
-    LOG = Logging.new
+    
 end

data/lib/raykit/rake.rb

@@ -3,31 +3,34 @@ require 'time'
 module Raykit
     class Rake
         def self.run(remote,branch,task='default')
-            rel_dir=Raykit::Git::get_relative_path(remote)
-            commit=Raykit::Git::get_latest_commit(remote,branch)
-            log_filename="#{Environment::log_dir}/RayKit.Runner/#{rel_dir}/#{branch}/#{commit}.json"
-            if(File.exist?(log_filename))
-                return Command.parse(File.read(log_filename))
-            else
-                run_dir="#{Environment::tmp_dir}/#{Git::get_relative_path(remote)}.#{branch}.#{commit}"
-                if(!Dir.exist?(run_dir))
-                    parent_dir = File.expand_path('..',run_dir)
-                    if(!Dir.exist?(parent_dir))
-                        FileUtils.mkdir_p(parent_dir)
-                    end 
-                    cmd = Command.new("git clone #{remote} #{run_dir}")
-                end
-                Dir.chdir(run_dir) do
-                    cmd = Command.new("rake #{task}")
-                    parent_dir = File.dirname(log_filename)
-                    if(!Dir.exist?(parent_dir))
-                        FileUtils.mkdir_p(parent_dir)
-                    end 
-                    File.open(log_filename,'w'){|f|
-                        f.write(JSON.generate(cmd.to_hash))
-                    }
-                    return cmd
+            begin
+                rel_dir=Raykit::Git::get_relative_path(remote)
+                commit=Raykit::Git::get_latest_commit(remote,branch)
+                log_filename="#{Environment::get_dev_dir('log')}/RayKit.Runner/#{rel_dir}/#{branch}/#{commit}.json"
+                if(File.exist?(log_filename))
+                    return Command.parse(File.read(log_filename))
+                else
+                    run_dir="#{Environment::get_dev_dir('tmp')}/#{Git::get_relative_path(remote)}.#{branch}.#{commit}"
+                    if(!Dir.exist?(run_dir))
+                        parent_dir = File.expand_path('..',run_dir)
+                        if(!Dir.exist?(parent_dir))
+                            FileUtils.mkdir_p(parent_dir)
+                        end 
+                        cmd = Command.new("git clone #{remote} #{run_dir}")
+                    end
+                    Dir.chdir(run_dir) do
+                        cmd = Command.new("rake #{task}")
+                        parent_dir = File.dirname(log_filename)
+                        if(!Dir.exist?(parent_dir))
+                            FileUtils.mkdir_p(parent_dir)
+                        end 
+                        File.open(log_filename,'w'){|f|
+                            f.write(JSON.generate(cmd.to_hash))
+                        }
+                        return cmd
+                    end
                 end
+            rescue
             end
         end
     end

data/lib/raykit/timer.rb

@@ -1,24 +1,28 @@
 require 'time'
 
 module Raykit
+    # Provides functionality to record the time execution times
     class Timer
+        # The time at which start occurred
         attr_accessor :start_time
 
         def initialize
             @start_time=Time.now
         end
 
-        def elapsed # in seconds
+        # The elapsed time, in seconds, since the timer started
+        def elapsed
             return Time.now-@start_time
         end
 
-        def elapsed_str
-            get_elapsed_str(elapsed)
-            #"[" + "%.0f" % (elapsed) + "s]"
+        # The elapsed time, in seconds, as a formatted string
+        def elapsed_str(pad=0)
+            Timer.get_elapsed_str(elapsed,pad)
         end
 
-        def self.get_elapsed_str(elapsed)
-            "[" + "%.0f" % (elapsed) + "s]"
+        # Converts a time span in seconds to a formatted string
+        def self.get_elapsed_str(elapsed,pad=0)
+            "[" + "%.0f" % (elapsed) + "s]".ljust(pad)
         end
     end
 end

data/lib/raykit/version.rb

@@ -1,7 +1,9 @@
 module Raykit
+    # Version functionality
     class Version
         attr_accessor :start_time
 
+        # detect a version number based on the NAME variable, if defined
         def self.detect
             if(defined?(NAME))
                 csproj_filename = "#{NAME}/#{NAME}.csproj"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raykit
 version: !ruby/object:Gem::Version
-  version: 0.0.48
+  version: 0.0.49
 platform: ruby
 authors:
 - Lou Parslow
@@ -14,44 +14,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: supports common ci/cd development tasks
 email: lou.parslow@gmail.com
 executables: