rvvm 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +159 -5
  4. data/Rakefile +0 -6
  5. data/doc/Crayons.html +1206 -0
  6. data/doc/Rvvm/Error.html +148 -0
  7. data/doc/Rvvm.html +2258 -0
  8. data/doc/Templates.html +227 -0
  9. data/doc/Utils.html +991 -0
  10. data/doc/_index.html +161 -0
  11. data/doc/class_list.html +54 -0
  12. data/doc/css/common.css +1 -0
  13. data/doc/css/full_list.css +58 -0
  14. data/doc/css/style.css +503 -0
  15. data/doc/file.README.html +444 -0
  16. data/doc/file_list.html +59 -0
  17. data/doc/frames.html +22 -0
  18. data/doc/index.html +444 -0
  19. data/doc/js/app.js +344 -0
  20. data/doc/js/full_list.js +242 -0
  21. data/doc/js/jquery.js +4 -0
  22. data/doc/method_list.html +334 -0
  23. data/doc/top-level-namespace.html +110 -0
  24. data/lib/rvvm/crayons.rb +8 -3
  25. data/lib/rvvm/utils.rb +2 -2
  26. data/lib/rvvm/version.rb +1 -1
  27. data/lib/rvvm.rb +5 -2
  28. data/sig/rvvm/crayons.rbs +12 -6
  29. data/sig/rvvm/utils.rbs +5 -5
  30. data/sig/rvvm.rbs +31 -5
  31. metadata +20 -1
data/doc/top-level-namespace.html ADDED
@@ -0,0 +1,110 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Top Level Namespace
8
+
9
+ &mdash; Documentation by YARD 0.9.37
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index</a> &raquo;
40
+
41
+
42
+ <span class="title">Top Level Namespace</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Top Level Namespace
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ </div>
80
+
81
+ <h2>Defined Under Namespace</h2>
82
+ <p class="children">
83
+
84
+
85
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Crayons.html" title="Crayons (module)">Crayons</a></span>, <span class='object_link'><a href="Rvvm.html" title="Rvvm (module)">Rvvm</a></span>, <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>, <span class='object_link'><a href="Utils.html" title="Utils (module)">Utils</a></span>
86
+
87
+
88
+
89
+
90
+ </p>
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+
100
+ </div>
101
+
102
+ <div id="footer">
103
+ Generated on Thu Sep 19 20:26:42 2024 by
104
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
105
+ 0.9.37 (ruby-3.2.5).
106
+ </div>
107
+
108
+ </div>
109
+ </body>
110
+ </html>
data/lib/rvvm/crayons.rb CHANGED
@@ -50,7 +50,7 @@ module Crayons
50
50
 
51
51
  # Returns spinner status.
52
52
  #
53
- # @returns @spinner_running [Boolean] spinner status
53
+ # @return [Boolean] spinner status
54
54
  def self.spinner_running?
55
55
  @spinner_running
56
56
  end
@@ -135,22 +135,27 @@ module Crayons
135
135
  #
136
136
  # @param tag [String] spinner tag
137
137
  # @param cmd [String] shell command to be run
138
+ # @param ignore_errors [Boolean] if false command exits on shell command failure
138
139
  #
139
140
  # @return [void]
140
141
  #
141
142
  # @since 1.1.0
142
- def self.command(tag, cmd)
143
+ def self.command(tag, cmd, ignore_errors: false)
143
144
  spinner_start(tag)
144
145
  out = @command.run!(cmd)
145
146
  spinner_log("#{out.out}\n")
146
147
  spinner_stop(nil, out.success?)
147
148
  puts ""
149
+
150
+ exit(1) unless out.success? && !ignore_errors
148
151
  rescue Errno::ENOENT
149
152
  spinner_stop(nil, false)
150
- log_error("\nError: #{cmd.split.first} not found!\n")
153
+ log_error("\nError: '#{cmd.split.first}' command not found!\n")
154
+ exit(1) unless ignore_errors
151
155
  rescue StandardError => e
152
156
  spinner_stop(nil, false)
153
157
  log_error("\nAn unexpected error ocurred:\n\n#{e.message}\n")
158
+ exit(1) unless ignore_errors
154
159
  end
155
160
 
156
161
  # Logs a green text message to stdout.
data/lib/rvvm/utils.rb CHANGED
@@ -105,8 +105,8 @@ module Utils
105
105
 
106
106
  # Checks if hash contains keys provided from an array.
107
107
  #
108
- # @param hash [Hash] hash to analyze
109
- # @param arra [Array] array of keys to look for in the hash
108
+ # @param [Hash] hash to analyze
109
+ # @param [Array] array of keys to look for in the hash
110
110
  #
111
111
  # @return [Bolean] true if all provided keys from a hash return nil
112
112
  # @return [Boolean] false if a provided key is found in the hash
data/lib/rvvm/version.rb CHANGED
@@ -3,5 +3,5 @@
3
3
  # Module holding current rvvm version.
4
4
  module Rvvm
5
5
  # Current rvvm module version.
6
- VERSION = "1.2.0"
6
+ VERSION = "1.2.2"
7
7
  end
data/lib/rvvm.rb CHANGED
@@ -109,6 +109,9 @@ module Rvvm
109
109
  args.on("--wavefile <WAVEFILE>", "Specifies waveform dump file to be openned in Vivado GUI")
110
110
  args.on("--prjconf <CONFIG>", "Specifies RVvM project config file if not using the one provided in the project")
111
111
  args.on("-l", "--dpilib", "Specifies a DPI-C shared library to be linked with a snapshot during elaboration")
112
+ args.on("--ignore-errors", "Ignores Vivado tool and shell command errors and continues execution") do
113
+ @args[:ignore_errors] = true
114
+ end
112
115
  args.on("--debug", "Script debug")
113
116
  end.parse!(into: @args)
114
117
 
@@ -172,7 +175,7 @@ module Rvvm
172
175
  Crayons.spinner_log(command)
173
176
  Crayons.spinner_stop(nil, true)
174
177
  else
175
- Crayons.command(tag, command)
178
+ Crayons.command(tag, command, ignore_errors: @args[:ignore_errors])
176
179
  end
177
180
  end
178
181
 
@@ -327,7 +330,7 @@ module Rvvm
327
330
  #
328
331
  # @return [void]
329
332
  #
330
- # @Since 0.9.0
333
+ # @since 0.9.0
331
334
  def self.dpi_c
332
335
  cmd_args = @config[:dpi][:args].strip
333
336
  dpilist = @args[:dpilist] || @config[:dpi][:list]
data/sig/rvvm/crayons.rbs CHANGED
@@ -1,17 +1,23 @@
1
1
  module Crayons
2
+
3
+ def self.init: () -> void
2
4
 
3
5
  def self.spinner_running?: () -> Boolean
4
6
 
5
- def self.spinner_start: (String) -> void
7
+ def self.spinner_start: (message: String) -> void
8
+
9
+ def self.spinner_pause: () -> void
10
+
11
+ def self.spinner_resume: () -> void
6
12
 
7
- def self.spinner_stop: (String, Boolean) -> void
13
+ def self.spinner_stop: (message: String, exit: Boolean) -> void
8
14
 
9
- def self.spinner_log: (String) -> void
15
+ def self.spinner_log: (message: String) -> void
10
16
 
11
- def self.command: (String, String) -> void
17
+ def self.command: (tag: String, cmd: String, ignore_errors: Boolean) -> void
12
18
 
13
- def self.log_pass: (String) -> void
19
+ def self.log_pass: (message: String) -> void
14
20
 
15
- def self.log_error: (String) -> void
21
+ def self.log_error: (message: String) -> void
16
22
 
17
23
  end
data/sig/rvvm/utils.rbs CHANGED
@@ -1,15 +1,15 @@
1
1
  module Utils
2
2
 
3
- def self.interpolate: (String, Hash) -> String
3
+ def self.interpolate: (string: String, hash: Hash) -> String
4
4
 
5
- def self.gen_file: (String, String) -> void
5
+ def self.gen_file: (path: String, content: String) -> void
6
6
 
7
- def self.gen_template: (Hash, String, Hash, String) -> void
7
+ def self.gen_template: (template: Hash, name: String, name: Hash, name: String) -> void
8
8
 
9
- def self.find_file_dir: (String, String) -> String
9
+ def self.find_file_dir: (filename: String, path: String) -> String
10
10
 
11
11
  def self.git_username: () -> String
12
12
 
13
- def self.all_nil? (Hash, Array) -> Boolean
13
+ def self.all_nil?: (hash: Hash, array: Array) -> Boolean
14
14
 
15
15
  end
data/sig/rvvm.rbs CHANGED
@@ -1,13 +1,39 @@
1
1
  module Rvvm
2
2
  VERSION: String
3
3
 
4
- def self.execute: (String, String) -> void
4
+ def self.check_args: () -> void
5
5
 
6
- def self.create_new_project: (String) -> void
6
+ def self.handle_args: () -> void
7
+
8
+ def self.execute: (tag: String, command: String) -> void
9
+
10
+ def self.create_new_project: (name: String) -> void
11
+
12
+ def self.load_config: () -> void
13
+
14
+ def self.prj_top: () -> void
15
+
16
+ def self.compile: () -> void
17
+
18
+ def self.dpi_c: () -> void
19
+
20
+ def self.elaborate: () -> void
21
+
22
+ def self.run_sim: () -> void
23
+
24
+ def self.run_sv: () -> void
25
+
26
+ def self.gui: () -> void
27
+
28
+ def self.coverage: () -> void
29
+
30
+ def self.cov_report: () -> void
31
+
32
+ def self.create_module: (name: String, type: String) -> void
7
33
 
8
- def self.create_module: (String, String) -> void
34
+ def self.create_pkg: (name: String) -> void
9
35
 
10
- def self.create_pkg: (String) -> void
36
+ def self.create_svfile: (name: String) -> void
11
37
 
12
- def self.create_svfile: (String) -> void
38
+ def self.run: () -> void
13
39
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rvvm
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.0
4
+ version: 1.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - mrbya
@@ -69,6 +69,25 @@ files:
69
69
  - README.md
70
70
  - Rakefile
71
71
  - bin/sandbox
72
+ - doc/Crayons.html
73
+ - doc/Rvvm.html
74
+ - doc/Rvvm/Error.html
75
+ - doc/Templates.html
76
+ - doc/Utils.html
77
+ - doc/_index.html
78
+ - doc/class_list.html
79
+ - doc/css/common.css
80
+ - doc/css/full_list.css
81
+ - doc/css/style.css
82
+ - doc/file.README.html
83
+ - doc/file_list.html
84
+ - doc/frames.html
85
+ - doc/index.html
86
+ - doc/js/app.js
87
+ - doc/js/full_list.js
88
+ - doc/js/jquery.js
89
+ - doc/method_list.html
90
+ - doc/top-level-namespace.html
72
91
  - exe/rvvm
73
92
  - lib/rvvm.rb
74
93
  - lib/rvvm/crayons.rb