rvvm 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0658be412bda5c88fecb1bb022492703865072a78aa90acfe2e055cade7dab0d'
-  data.tar.gz: 8ff7f78d83a3af1c2e4c782be45cca46cb3a2a41cd7db86e91ee37ec991f599b
+  metadata.gz: 420096b77b4d823c6ad6a69509ffe6da56d4a63cf96152cd7d36a5ea41ab063a
+  data.tar.gz: 28b2c65e701d7f2bdfdb3b7bac2d0d7a9f62db9877d912d18eaa9a8e8d9aac78
 SHA512:
-  metadata.gz: 8529ec4e33507e4a26327b96630db95b0782e9d5f344a62d194828601356b19dc0507f4f777b6bfe4b42198cc25ca7cca274ee994b607832d0f5eafea41b6c51
-  data.tar.gz: 979591d920e12ae3e2bc0e112c887049177319c6d58aaef6b4b6b4343ac26029da797c834ccbce9ea892e67fb4018a508409ef88279cd81fd037e3d40fc530db
+  metadata.gz: b2cb584479a4fde2453c4d4830403db857d2dc197840dc44dd2b9b932881e111abea00fbad1ba52e7c2e01e4865b66911f12eef5110bdadb695a468df293aeb8
+  data.tar.gz: eea11a1a5f36f0a20d796dd87e165f7618b022c8062c81b0eb45122644a5291adcbd475973df785008bc3e43be866b3b78830bcb3c666636b17a03b138cde830

data/CHANGELOG.md

@@ -153,3 +153,21 @@
 1. Missing gemspec dependencies
 2. Minor spinner rendering bugs
 
+## TBI:
+
+1. Elaboration and simulation custom waveform trace dump file
+2. Project template files regeneration/restoration to default
+3. Crayon module tests
+4. RBS definitions
+
+## [1.1.0] - 2024-09-18
+
+### Added:
+
+1. Crayon.command to execute shell commands with spinners
+2. Crayon module tests
+3. RBS definitions
+
+### Fixed:
+
+1. More Crayons rendering bugs

data/lib/rvvm/crayons.rb

@@ -1,15 +1,23 @@
 # frozen_string_literal: true
 
 require "tty-spinner"
+require "tty-command"
 require "rainbow/refinement"
 
 using Rainbow
 
-# Utility module providing spinners and stdout mesage formatting.
+# Utility module providing an API to run shell commands
+# with spinners and stdout mesage formatting.
 #
 # @example
 #   require 'rvvm/crayons'
 #
+#   Crayons.init
+#
+#   # Runn a shell command with a spinner
+#   Crayons.command("Running command...", "ls -aln")
+#
+#   # Run custom code with a spinner
 #   Crayons.spinner_start("New task...")
 #
 #   # do stuff
@@ -29,6 +37,16 @@ module Crayons
   @thread = nil
   @thread_paused = false
   @spinner_running = false
+  @command = nil
+
+  # Initializes Crayons module.
+  #
+  # @return [void]
+  #
+  # @since 1.1.0
+  def self.init
+    @command = TTY::Command.new(printer: :null)
+  end
 
   # Returns spinner status.
   #
@@ -46,11 +64,14 @@ module Crayons
   # @since 1.0.0
   def self.spinner_start(message)
     print "\r\e[K"
-    @spinner = TTY::Spinner.new("[:spinner] #{message}")
+    @spinner = TTY::Spinner.new("[:spinner] #{message}", interval: 5)
     @spinner_running = true
     @thread = Thread.new do
       @spinner.auto_spin
-      sleep(0.1) while @thread_paused
+      while @thread_sleeping
+        print "\r\e[K"
+        sleep(0.1)
+      end
     end
   end
 
@@ -62,9 +83,10 @@ module Crayons
   def self.spinner_pause
     return unless @spinner_running
 
-    sleep(0.1)
     print "\r\e[K"
     @thread_paused = true
+    sleep(0.1)
+    print "\r\e[K"
   end
 
   # Resumes spinner thread execution.
@@ -110,6 +132,22 @@ module Crayons
     spinner_resume if @spinner_running
   end
 
+  # Runs a shell command with a spinner.
+  #
+  # @param tag [String] spinner tag
+  # @param cmd [String] shell command to be run
+  #
+  # @return [void]
+  #
+  # @since 1.1.0
+  def self.command(tag, cmd)
+    spinner_start(tag)
+    out = @command.run!(cmd)
+    spinner_log("#{out.out}\n")
+    spinner_stop(nil, out.success?)
+    puts ""
+  end
+
   # Logs a green text message to stdout.
   #
   # @param message [String] message to print

data/lib/rvvm/version.rb

@@ -3,5 +3,5 @@
 # Module holding current rvvm version.
 module Rvvm
   # Current rvvm module version.
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/rvvm.rb

@@ -55,6 +55,7 @@ module Rvvm
   OptionParser.new do |args|
     current_time = Time.now
     @formatted_time = current_time.strftime("%Y-%m-%d %H:%M:%S")
+    Crayons.init
 
     args.on("-h", "--help", "Shows this help") do
       puts "\nRVvM - Ruby Vivado Manager\n\n"
@@ -161,12 +162,14 @@ module Rvvm
   # @return [void]
   #
   # @since 0.8.0
-  def self.execute(command)
+  def self.execute(tag, command)
     if @args[:debug]
-      Crayons.spinner_log(command)
+      puts command
+      Crayons.spinner_start(tag)
       sleep(1)
+      Crayons.spinner_stop(nil, true)
     else
-      system(command)
+      Crayons.command(tag, command)
     end
   end
 
@@ -247,7 +250,7 @@ module Rvvm
     system('git commit -am "Initial commit"')
     Crayons.spinner_resume
 
-    Crayons.spinner_log("\n")
+    Crayons.spinner_log("")
     Crayons.spinner_stop("Done!", true)
     Crayons.log_pass("\nRVvM: New project generated. ^^\n\n")
 
@@ -289,6 +292,7 @@ module Rvvm
     puts ""
   rescue JSON::ParserError => e
     Crayons.log_error("     Invalid config json!\n\n#{e.message}")
+    puts""
     exit(1)
   end
 
@@ -307,18 +311,12 @@ module Rvvm
   #
   # @since 0.8.0
   def self.compile
-    cmd_args = @config[:compilation][:args]
+    cmd_args = @config[:compilation][:args].strip
     logname = @args[:complog] || File.join([@config[:project][:logDir], @config[:compilation][:logDir], @config[:compilation][:log]])
     complist = @args[:compilelist] || @config[:compilation][:list]
 
-    Crayons.spinner_start("Compiling HDL sources...")
-
     cmd = "xvlog -sv -f #{complist} -log #{logname} #{cmd_args}"
-    Crayons.spinner_pause
-    exit = execute(cmd)
-    Crayons.spinner_resume
-    Crayons.spinner_stop(nil, exit)
-    puts ""
+    execute("Compiling HDL sources...", cmd)
   end
 
   # Compiles C/C++ sources into a shared library to use during
@@ -328,15 +326,11 @@ module Rvvm
   #
   # @Since 0.9.0
   def self.dpi_c
-    cmd_args = @config[:dpi][:args]
+    cmd_args = @config[:dpi][:args].strip
     dpilist = @args[:dpilist] || @config[:dpi][:list]
 
-    Crayons.spinner_start("Building DPI-C library...")
-
     cmd = "sxc -f #{dpilist} #{cmd_args}"
-    exit = execute(cmd)
-    Crayons.spinner_stop(nil, exit)
-    puts ""
+    execute("Building DPI-C library...", cmd)
   end
 
   # Elaborates project into a testbench snapshot using xelab.
@@ -348,19 +342,14 @@ module Rvvm
     cmd_args = @config[:elaboration][:args]
     cmd_args << " -sv_lib dpi" if @args[:dpi] || @args[:dpilib] || @config[:dpi][:dpilib] == 1
     cmd_args << " -debug wave" if @args[:wave]
+    cmd_args.strip!
     logname = @args[:elablog] || File.join([@config[:project][:logDir], @config[:elaboration][:logDir], @config[:elaboration][:log]])
     tb_top = @args[:tbtop] || @config[:elaboration][:tbTop]
     tb = @args[:tb] || @config[:elaboration][:tb]
     timescale = @args[:timescale] || @config[:elaboration][:timescale]
 
-    Crayons.spinner_start("Elaborating testbench: #{tb}...")
-
     cmd = "xelab #{tb_top} -relax -s #{tb} -timescale #{timescale} -log #{logname} #{cmd_args}"
-    Crayons.spinner_pause
-    exit = execute(cmd)
-    Crayons.spinner_resume
-    Crayons.spinner_stop(nil, exit)
-    puts ""
+    execute("Elaborating testbench #{tb}...", cmd)
   end
 
   # Runs UVM test simulation on an elaborated testbench snapshot using xrun.
@@ -373,8 +362,9 @@ module Rvvm
     if @args[:wave]
       cmd_args << " --tclbatch wfcfg.tcl"
     else
-      cmd_args << "-R"
+      cmd_args << " -R"
     end
+    cmd_args.strip!
 
     # Run simulaton on an array of tests.
     # If in not running in batch mode testlist is an array with a single test
@@ -386,8 +376,6 @@ module Rvvm
 
     testlist.each_with_index do |simtest, i|
       simtest.strip!
-      puts "" if i.positive?
-      Crayons.spinner_start("Running test #{i + 1}/#{testlist.size}: #{simtest}...")
 
       logname = File.join([@config[:project][:logDir], @config[:simulation][:logDir], @config[:simulation][:log]])
       logname = Utils.interpolate(logname, { testname: simtest })
@@ -395,13 +383,8 @@ module Rvvm
       verb = "UVM_#{@args[:verb] || @config[:simulation][:verbosity]}"
 
       cmd = "xsim #{tb} -log #{logname} -testplusarg \"UVM_VERBOSITY=#{verb}\" -testplusarg \"UVM_TESTNAME=#{simtest}\" #{cmd_args}"
-      Crayons.spinner_pause
-      exit = execute(cmd)
-      Crayons.spinner_resume
-      Crayons.spinner_stop(nil, exit)
+      execute("Running UVM test #{i + 1}/#{testlist.size}: #{simtest}...", cmd)
     end
-
-    puts ""
   end
 
   # Runs a pure SystemVerilog/Verilog simulation using xrun.
@@ -410,17 +393,13 @@ module Rvvm
   #
   # @since 0.9.0
   def self.run_sv
-    cmd_args = @config[:simulation][:args]
+    cmd_args = @config[:simulation][:args].strip!
     tb = @args[:simtb] || @args[:tb] || @config[:elaboration][:tb]
 
-    Crayons.spinner_start("Running pure SV/V simulation...")
     logname = @args[:simlog] || File.join([@config[:project][:logDir], @config[:simulation][:logDir], "svsim.log"])
 
     cmd = "xsim #{tb} -log #{logname} #{cmd_args}"
-    Crayons.spinner_pause
-    exit = execute(cmd)
-    Crayons.spinner_resume
-    Crayons.spinner_stop(nil, exit)
+    execute("Running pure SV/V simulation...", cmd)
   end
 
   # Opens last generated waveform trace dump to inspect in Vivado GUI.
@@ -432,7 +411,7 @@ module Rvvm
     dump = @args[:wavefile] || "#{@config[:elaboration][:tb]}.wdb"
 
     cmd = "xsim --gui #{dump}"
-    execute(cmd)
+    execute("Running Vivado GUI...", cmd)
 
     exit(0)
   end
@@ -443,13 +422,8 @@ module Rvvm
   #
   # @since 0.9.0
   def self.coverage
-    Crayons.spinner_start("Generating UVM functional coverage report...")
-
     cmd = "xcrg -report_format html -dir xsim.covdb"
-    Crayons.spinner_pause
-    exit = execute(cmd)
-    Crayons.spinner_resume
-    Crayons.spinner_stop(nil, exit)
+    execute("Generating UVM test functional coverage report...", cmd)
   end
 
   # Opens last generated functional coverage report in a HTML dashboard.
@@ -459,7 +433,7 @@ module Rvvm
   # @since 0.9.0
   def self.cov_report
     Dir.chdir("xcrg_func_cov_report")
-    execute("./dashboard.html")
+    execute("Opening coverage dashboard...", "./dashboard.html")
 
     exit(0)
   end
@@ -491,7 +465,6 @@ module Rvvm
     end
     conf[:username] = Utils.git_userame || " "
 
-    puts ""
     Crayons.spinner_start("Generating SV #{type} template...")
     Utils.gen_template(@templates[:module], "#{name}.sv", conf, path)
     Crayons.spinner_stop(nil, true)
@@ -524,7 +497,6 @@ module Rvvm
       path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
     end
 
-    puts ""
     Crayons.spinner_start("Generating SV pkg template...")
     Utils.gen_template(@templates[:package], "#{name}.sv", conf, path)
     Crayons.spinner_stop(nil, true)
@@ -556,7 +528,6 @@ module Rvvm
       path = File.join([@config[:project][:path], @args[:path] || @templates[:module][:file][:path]])
     end
 
-    puts ""
     Crayons.spinner_start("Generating generic SV file template...")
     Utils.gen_template(@templates[:svfile], "#{name}.sv", conf, path)
     Crayons.spinner_stop(nil, true)

data/sig/rvvm/crayons.rbs

@@ -0,0 +1,17 @@
+module Crayons
+  
+  def self.spinner_running?: () -> Boolean
+
+  def self.spinner_start: (String) -> void
+
+  def self.spinner_stop: (String, Boolean) -> void
+
+  def self.spinner_log: (String) -> void
+
+  def self.command: (String, String) -> void
+
+  def self.log_pass: (String) -> void
+
+  def self.log_error: (String) -> void
+
+end

data/sig/rvvm/utils.rbs

@@ -0,0 +1,15 @@
+module Utils
+  
+  def self.interpolate: (String, Hash) -> String
+
+  def self.gen_file: (String, String) -> void
+
+  def self.gen_template: (Hash, String, Hash, String) -> void
+
+  def self.find_file_dir: (String, String) -> String
+
+  def self.git_username: () -> String
+
+  def self.all_nil? (Hash, Array) -> Boolean
+
+end

data/sig/rvvm.rbs

@@ -1,4 +1,13 @@
 module Rvvm
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  
+  def self.execute: (String, String) -> void
+
+  def self.create_new_project: (String) -> void
+
+  def self.create_module: (String, String) -> void
+
+  def self.create_pkg: (String) -> void
+
+  def self.create_svfile: (String) -> void
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rvvm
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - mrbya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.16'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.16'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rainbow
+  name: tty-command
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +76,8 @@ files:
 - lib/rvvm/utils.rb
 - lib/rvvm/version.rb
 - sig/rvvm.rbs
+- sig/rvvm/crayons.rbs
+- sig/rvvm/utils.rbs
 homepage: https://gitlab.com/such-hdl-much-wow/rvvm.git
 licenses:
 - MIT