rbcli 0.3.1 → 0.3.3

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 (62) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +63 -63
  4. data/docs/404.html +9 -9
  5. data/docs/advanced/automatic_updates/index.html +30 -30
  6. data/docs/advanced/command_types/index.html +78 -78
  7. data/docs/advanced/distributed_state_locking/index.html +30 -30
  8. data/docs/advanced/hooks/index.html +42 -42
  9. data/docs/advanced/index.html +27 -27
  10. data/docs/advanced/index.xml +12 -50
  11. data/docs/advanced/interactive_commands/index.html +35 -35
  12. data/docs/advanced/logging/index.html +36 -36
  13. data/docs/advanced/remote_execution/index.html +51 -51
  14. data/docs/advanced/state_storage/index.html +34 -34
  15. data/docs/advanced/user_config_files/index.html +30 -30
  16. data/docs/categories/index.html +27 -27
  17. data/docs/categories/index.xml +3 -2
  18. data/docs/development/changelog/index.html +91 -60
  19. data/docs/development/code_of_conduct/index.html +27 -27
  20. data/docs/development/contributing/index.html +40 -40
  21. data/docs/development/index.html +27 -27
  22. data/docs/development/index.xml +6 -16
  23. data/docs/development/license/index.html +26 -26
  24. data/docs/index.html +26 -26
  25. data/docs/index.json +15 -15
  26. data/docs/index.xml +20 -90
  27. data/docs/quick_reference/index.html +54 -54
  28. data/docs/quick_reference/index.xml +3 -2
  29. data/docs/sitemap.xml +0 -1
  30. data/docs/tags/index.html +27 -27
  31. data/docs/tags/index.xml +3 -2
  32. data/docs/tutorial/10-getting_started/index.html +33 -33
  33. data/docs/tutorial/20-project_layout/index.html +55 -55
  34. data/docs/tutorial/30-your_first_command/index.html +90 -90
  35. data/docs/tutorial/40-options_parameters_and_arguments/index.html +167 -167
  36. data/docs/tutorial/50-publishing/index.html +30 -30
  37. data/docs/tutorial/index.html +27 -27
  38. data/docs/tutorial/index.xml +8 -28
  39. data/docs/whoami/index.html +28 -28
  40. data/docs/whoami/index.xml +3 -2
  41. data/docs-src/.hugo_build.lock +0 -0
  42. data/docs-src/content/development/changelog.md +20 -0
  43. data/docs-src/makesite.sh +4 -4
  44. data/exe/rbcli +1 -1
  45. data/lib/rbcli/configuration/configurate.rb +1 -1
  46. data/lib/rbcli/engine/command.rb +1 -1
  47. data/lib/rbcli/engine/load_project.rb +1 -1
  48. data/lib/rbcli/engine/parser.rb +9 -7
  49. data/lib/rbcli/features/userconfig.rb +3 -3
  50. data/lib/rbcli/state_storage/localstate.rb +1 -1
  51. data/lib/rbcli/util/optimist.rb +1063 -0
  52. data/lib/rbcli/version.rb +1 -1
  53. data/lib/rbcli-tool/generators.rb +3 -3
  54. data/lib/rbcli-tool/mdless_fix.rb +1 -1
  55. data/lib/rbcli-tool/project.rb +3 -3
  56. data/lib/rbcli-tool/util.rb +3 -3
  57. data/rbcli.gemspec +16 -14
  58. data/skeletons/micro/executable +6 -1
  59. data/skeletons/mini/executable +6 -1
  60. data/skeletons/project/untitled.gemspec +4 -4
  61. metadata +31 -30
  62. data/lib/rbcli/util/trollop.rb +0 -1050
data/lib/rbcli/version.rb CHANGED
@@ -19,5 +19,5 @@
19
19
  ##################################################################################
20
20
 
21
21
  module Rbcli
22
- VERSION = '0.3.1'
22
+ VERSION = '0.3.3'
23
23
  end
@@ -42,7 +42,7 @@ module RBCliTool
42
42
  end
43
43
 
44
44
  def run
45
- if File.exists? @dest
45
+ if File.exist? @dest
46
46
  RBCliTool.continue_confirmation "The command #{@template_vars[:name]} already exists; contents will be overwritten."
47
47
  FileUtils.rm_rf @dest
48
48
  end
@@ -70,7 +70,7 @@ module RBCliTool
70
70
  confirmed = false
71
71
  @filepaths.each do |file|
72
72
  next if file[:dest].end_with? '.sh' and @template_vars[:no_script]
73
- if File.exists? file[:dest]
73
+ if File.exist? file[:dest]
74
74
  RBCliTool.continue_confirmation "The script command #{@template_vars[:name]} already exists; contents will be overwritten." unless confirmed
75
75
  confirmed = true
76
76
  FileUtils.rm_rf file[:dest]
@@ -94,7 +94,7 @@ module RBCliTool
94
94
  end
95
95
 
96
96
  def run
97
- if File.exists? @dest
97
+ if File.exist? @dest
98
98
  RBCliTool.continue_confirmation "The #{@typename} hook already exists; contents will be overwritten."
99
99
  FileUtils.rm_rf @dest
100
100
  end
@@ -378,7 +378,7 @@ module CLIMarkdown
378
378
  base = File.expand_path(File.dirname(@file))
379
379
  img_path = File.join(base,img_path)
380
380
  end
381
- if File.exists?(img_path)
381
+ if File.exist?(img_path)
382
382
  pre = match[2].size > 0 ? " #{c([:d,:blue])}[#{match[2].strip}]\n" : ''
383
383
  post = tail.size > 0 ? "\n #{c([:b,:blue])}-- #{tail} --" : ''
384
384
  img = %x{imgcat "#{img_path}"}
@@ -91,7 +91,7 @@ module RBCliTool
91
91
  RBCliTool.cp_file @micropath, "#{@dest}/#{@template_vars[:cmdname]}", @template_vars
92
92
  end
93
93
 
94
- def exists?
94
+ def exist?
95
95
  project_exists?
96
96
  end
97
97
 
@@ -99,7 +99,7 @@ module RBCliTool
99
99
  # We look for the .rbcli file in the current tree and return the root path
100
100
  searchpath = path
101
101
  while !searchpath.empty?
102
- return searchpath if File.directory? searchpath and File.exists? "#{searchpath}/.rbcli"
102
+ return searchpath if File.directory? searchpath and File.exist? "#{searchpath}/.rbcli"
103
103
  spath = searchpath.split('/')
104
104
  searchpath = (spath.length == 2) ? '/' : spath[0..-2].join('/')
105
105
  end
@@ -110,7 +110,7 @@ module RBCliTool
110
110
 
111
111
  def project_exists?
112
112
  # If the specified file already exists...
113
- #return true if File.exists? @dest
113
+ #return true if File.exist? @dest
114
114
 
115
115
  # Or if the .rbcli file exists anywhere in the tree, we know that we are in a subdirectory of a project
116
116
  Project::find_root(@dest)
@@ -28,13 +28,13 @@ module RBCliTool
28
28
  end
29
29
 
30
30
  def render
31
- ERB.new(File.read(@filename), nil, '-').result(binding)
31
+ ERB.new(File.read(@filename), trim_mode: '-').result(binding)
32
32
  end
33
33
  end
34
34
 
35
35
  def self.cp_file src, dest, template_vars = nil
36
36
  dest = "#{dest}#{src.split('/')[-1]}" if dest.end_with? '/'
37
- if File.exists? dest
37
+ if File.exist? dest
38
38
  puts "File #{dest} already exists. Please delete it and try again."
39
39
  false
40
40
  else
@@ -47,7 +47,7 @@ module RBCliTool
47
47
  FileUtils.cp src, dest
48
48
  end
49
49
 
50
- FileUtils.rm_f "#{File.dirname(dest)}/.keep" if File.exists? "#{File.dirname(dest)}/.keep"
50
+ FileUtils.rm_f "#{File.dirname(dest)}/.keep" if File.exist? "#{File.dirname(dest)}/.keep"
51
51
  puts "Done!"
52
52
  true
53
53
  end
data/rbcli.gemspec CHANGED
@@ -53,19 +53,21 @@ Gem::Specification.new do |spec|
53
53
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
54
54
  spec.require_paths = ['lib']
55
55
 
56
- spec.add_development_dependency 'bundler', '~> 2.2'
57
- spec.add_development_dependency 'rake', '~> 13.0'
58
- # spec.add_development_dependency 'rspec', '~> 3.8'
59
- # spec.add_development_dependency 'minitest', '~> 5.0'
56
+ spec.add_development_dependency 'bundler', '>= 2'
57
+ spec.add_development_dependency 'rake', '>= 13'
60
58
 
61
- spec.add_dependency 'colorize', '~> 0.8'
62
- spec.add_dependency 'deep_merge', '~> 1.2'
63
- spec.add_dependency 'aws-sdk-dynamodb', '~> 1.64'
64
- spec.add_dependency 'macaddr', '~> 1.7'
65
- spec.add_dependency 'rufus-scheduler', '~> 3.8'
66
- spec.add_dependency 'octokit', '~> 4.21'
67
- spec.add_dependency 'mdless', '~> 1.0'
68
- spec.add_dependency 'net-ssh', '~> 6.1'
69
- spec.add_dependency 'net-scp', '~> 3.0'
70
- # spec.add_dependency 'trollop', '~> 2.1'
59
+ spec.add_dependency 'colorize', '~> 1'
60
+ spec.add_dependency 'deep_merge', '~> 1'
61
+ spec.add_dependency 'aws-sdk-dynamodb', '~> 1'
62
+ spec.add_dependency 'macaddr', '~> 1'
63
+ spec.add_dependency 'rufus-scheduler', '~> 3'
64
+ spec.add_dependency 'octokit', RUBY_VERSION >= '3.3.0' ? '~> 8' : '~> 7'
65
+ spec.add_dependency 'mdless', RUBY_VERSION >= '3.3.0' ? '~> 2' : '~> 1'
66
+ spec.add_dependency 'net-ssh', '~> 7'
67
+ spec.add_dependency 'net-scp', '~> 4'
68
+ #TODO: Pull in the Optimist gem once the required PR's have been merged:
69
+ # https://github.com/ManageIQ/optimist/pull/145
70
+ # https://github.com/ManageIQ/optimist/pull/146
71
+ # https://github.com/ManageIQ/optimist/pull/147
72
+ # spec.add_dependency 'optimist', '???'
71
73
  end
@@ -7,7 +7,12 @@
7
7
  ## It's job is to load and execute the application.
8
8
  #########################################################
9
9
 
10
- require (ENV['RBCLI_ENV'] == 'development') ? ENV['RBCLI_DEVPATH'] || 'rbcli' : 'rbcli'
10
+ require 'bundler/inline'
11
+ gemfile do
12
+ source 'https://rubygems.org'
13
+ ruby ">= <%= RUBY_VERSION %>"
14
+ gem 'rbcli', '>= <%= @vars[:rbcli_version] %>', require: true
15
+ end
11
16
 
12
17
  #########################
13
18
  ## Configuration Block ##
@@ -7,7 +7,12 @@
7
7
  ## It's job is to load and execute the application.
8
8
  #########################################################
9
9
 
10
- require (ENV['RBCLI_ENV'] == 'development') ? ENV['RBCLI_DEVPATH'] || 'rbcli' : 'rbcli'
10
+ require 'bundler/inline'
11
+ gemfile do
12
+ source 'https://rubygems.org'
13
+ ruby ">= <%= RUBY_VERSION %>"
14
+ gem 'rbcli', '>= <%= @vars[:rbcli_version] %>', require: true
15
+ end
11
16
 
12
17
  #########################
13
18
  ## Configuration Block ##
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
13
13
  spec.homepage = "TODO: Put your gem's website or public repo URL here."
14
14
  spec.license = 'None'
15
15
 
16
- spec.required_ruby_version = '>= 2.3'
16
+ spec.required_ruby_version = ">= <%= RUBY_VERSION %>"
17
17
 
18
18
  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
19
19
  # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -32,9 +32,9 @@ Gem::Specification.new do |spec|
32
32
  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
33
33
  spec.require_paths = ['application', 'config', 'default_user_configs', 'hooks', 'lib']
34
34
 
35
- spec.add_development_dependency 'bundler', '~> 2.2'
36
- spec.add_development_dependency 'rake', '~> 13.0'
37
- spec.add_development_dependency 'rspec', '~> 3.10'
35
+ spec.add_development_dependency 'bundler', '~> 2'
36
+ spec.add_development_dependency 'rake', '~> 13'
37
+ spec.add_development_dependency 'rspec', '~> 3'
38
38
 
39
39
  spec.add_dependency 'rbcli', '>= <%= @vars[:rbcli_version] %>'
40
40
  end
metadata CHANGED
@@ -1,169 +1,169 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rbcli
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.3.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrew Khoury
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2021-10-20 00:00:00.000000000 Z
11
+ date: 2024-04-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - "~>"
17
+ - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '2.2'
19
+ version: '2'
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - "~>"
24
+ - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: '2.2'
26
+ version: '2'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rake
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - "~>"
31
+ - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: '13.0'
33
+ version: '13'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - "~>"
38
+ - - ">="
39
39
  - !ruby/object:Gem::Version
40
- version: '13.0'
40
+ version: '13'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: colorize
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
45
  - - "~>"
46
46
  - !ruby/object:Gem::Version
47
- version: '0.8'
47
+ version: '1'
48
48
  type: :runtime
49
49
  prerelease: false
50
50
  version_requirements: !ruby/object:Gem::Requirement
51
51
  requirements:
52
52
  - - "~>"
53
53
  - !ruby/object:Gem::Version
54
- version: '0.8'
54
+ version: '1'
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: deep_merge
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
59
  - - "~>"
60
60
  - !ruby/object:Gem::Version
61
- version: '1.2'
61
+ version: '1'
62
62
  type: :runtime
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
- version: '1.2'
68
+ version: '1'
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: aws-sdk-dynamodb
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
73
  - - "~>"
74
74
  - !ruby/object:Gem::Version
75
- version: '1.64'
75
+ version: '1'
76
76
  type: :runtime
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
80
  - - "~>"
81
81
  - !ruby/object:Gem::Version
82
- version: '1.64'
82
+ version: '1'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: macaddr
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
87
  - - "~>"
88
88
  - !ruby/object:Gem::Version
89
- version: '1.7'
89
+ version: '1'
90
90
  type: :runtime
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
94
  - - "~>"
95
95
  - !ruby/object:Gem::Version
96
- version: '1.7'
96
+ version: '1'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: rufus-scheduler
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
101
  - - "~>"
102
102
  - !ruby/object:Gem::Version
103
- version: '3.8'
103
+ version: '3'
104
104
  type: :runtime
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
108
  - - "~>"
109
109
  - !ruby/object:Gem::Version
110
- version: '3.8'
110
+ version: '3'
111
111
  - !ruby/object:Gem::Dependency
112
112
  name: octokit
113
113
  requirement: !ruby/object:Gem::Requirement
114
114
  requirements:
115
115
  - - "~>"
116
116
  - !ruby/object:Gem::Version
117
- version: '4.21'
117
+ version: '8'
118
118
  type: :runtime
119
119
  prerelease: false
120
120
  version_requirements: !ruby/object:Gem::Requirement
121
121
  requirements:
122
122
  - - "~>"
123
123
  - !ruby/object:Gem::Version
124
- version: '4.21'
124
+ version: '8'
125
125
  - !ruby/object:Gem::Dependency
126
126
  name: mdless
127
127
  requirement: !ruby/object:Gem::Requirement
128
128
  requirements:
129
129
  - - "~>"
130
130
  - !ruby/object:Gem::Version
131
- version: '1.0'
131
+ version: '2'
132
132
  type: :runtime
133
133
  prerelease: false
134
134
  version_requirements: !ruby/object:Gem::Requirement
135
135
  requirements:
136
136
  - - "~>"
137
137
  - !ruby/object:Gem::Version
138
- version: '1.0'
138
+ version: '2'
139
139
  - !ruby/object:Gem::Dependency
140
140
  name: net-ssh
141
141
  requirement: !ruby/object:Gem::Requirement
142
142
  requirements:
143
143
  - - "~>"
144
144
  - !ruby/object:Gem::Version
145
- version: '6.1'
145
+ version: '7'
146
146
  type: :runtime
147
147
  prerelease: false
148
148
  version_requirements: !ruby/object:Gem::Requirement
149
149
  requirements:
150
150
  - - "~>"
151
151
  - !ruby/object:Gem::Version
152
- version: '6.1'
152
+ version: '7'
153
153
  - !ruby/object:Gem::Dependency
154
154
  name: net-scp
155
155
  requirement: !ruby/object:Gem::Requirement
156
156
  requirements:
157
157
  - - "~>"
158
158
  - !ruby/object:Gem::Version
159
- version: '3.0'
159
+ version: '4'
160
160
  type: :runtime
161
161
  prerelease: false
162
162
  version_requirements: !ruby/object:Gem::Requirement
163
163
  requirements:
164
164
  - - "~>"
165
165
  - !ruby/object:Gem::Version
166
- version: '3.0'
166
+ version: '4'
167
167
  description: RBCli is a framework to quickly develop command-line tools and applications.
168
168
  email:
169
169
  - akhoury@live.com
@@ -185,6 +185,7 @@ files:
185
185
  - Rakefile
186
186
  - bin/console
187
187
  - bin/setup
188
+ - docs-src/.hugo_build.lock
188
189
  - docs-src/archetypes/default.md
189
190
  - docs-src/config.toml
190
191
  - docs-src/content/_index.md
@@ -596,8 +597,8 @@ files:
596
597
  - lib/rbcli/util/deprecation_warning.rb
597
598
  - lib/rbcli/util/hash_deep_symbolize.rb
598
599
  - lib/rbcli/util/msg.rb
600
+ - lib/rbcli/util/optimist.rb
599
601
  - lib/rbcli/util/string_colorize.rb
600
- - lib/rbcli/util/trollop.rb
601
602
  - lib/rbcli/version.rb
602
603
  - rbcli.gemspec
603
604
  - skeletons/micro/executable
@@ -649,7 +650,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
649
650
  - !ruby/object:Gem::Version
650
651
  version: '0'
651
652
  requirements: []
652
- rubygems_version: 3.2.3
653
+ rubygems_version: 3.5.3
653
654
  signing_key:
654
655
  specification_version: 4
655
656
  summary: A CLI Application/Tooling Framework for Ruby