github_cli 0.5.0 → 0.5.1
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.
- data/CHANGELOG.md +5 -0
- data/Gemfile.lock +1 -1
- data/Rakefile +4 -1
- data/github_cli.gemspec +3 -1
- data/lib/github_cli/dsl.rb +7 -3
- data/lib/github_cli/thor_ext.rb +1 -3
- data/lib/github_cli/vendor/thor/actions/create_file.rb +105 -0
- data/lib/github_cli/vendor/thor/actions/create_link.rb +57 -0
- data/lib/github_cli/vendor/thor/actions/directory.rb +98 -0
- data/lib/github_cli/vendor/thor/actions/empty_directory.rb +153 -0
- data/lib/github_cli/vendor/thor/actions/file_manipulation.rb +308 -0
- data/lib/github_cli/vendor/thor/actions/inject_into_file.rb +109 -0
- data/lib/github_cli/vendor/thor/actions.rb +318 -0
- data/lib/github_cli/vendor/thor/base.rb +641 -0
- data/lib/github_cli/vendor/thor/core_ext/dir_escape.rb +0 -0
- data/lib/github_cli/vendor/thor/core_ext/file_binary_read.rb +9 -0
- data/lib/github_cli/vendor/thor/core_ext/hash_with_indifferent_access.rb +75 -0
- data/lib/github_cli/vendor/thor/core_ext/ordered_hash.rb +100 -0
- data/lib/github_cli/vendor/thor/empty.txt +0 -0
- data/lib/github_cli/vendor/thor/error.rb +35 -0
- data/lib/github_cli/vendor/thor/group.rb +285 -0
- data/lib/github_cli/vendor/thor/invocation.rb +170 -0
- data/lib/github_cli/vendor/thor/parser/argument.rb +74 -0
- data/lib/github_cli/vendor/thor/parser/arguments.rb +171 -0
- data/lib/github_cli/vendor/thor/parser/option.rb +121 -0
- data/lib/github_cli/vendor/thor/parser/options.rb +178 -0
- data/lib/github_cli/vendor/thor/parser.rb +4 -0
- data/lib/github_cli/vendor/thor/rake_compat.rb +71 -0
- data/lib/github_cli/vendor/thor/runner.rb +321 -0
- data/lib/github_cli/vendor/thor/shell/basic.rb +389 -0
- data/lib/github_cli/vendor/thor/shell/color.rb +144 -0
- data/lib/github_cli/vendor/thor/shell/html.rb +123 -0
- data/lib/github_cli/vendor/thor/shell.rb +88 -0
- data/lib/github_cli/vendor/thor/task.rb +132 -0
- data/lib/github_cli/vendor/thor/util.rb +266 -0
- data/lib/github_cli/vendor/thor/version.rb +3 -0
- data/lib/github_cli/vendor/thor.rb +379 -0
- data/lib/github_cli/vendor.rb +7 -5
- data/lib/github_cli/version.rb +3 -1
- metadata +45 -22
- data/bin/ghc +0 -2
@@ -0,0 +1,318 @@
|
|
1
|
+
require 'fileutils'
|
2
|
+
require 'uri'
|
3
|
+
require 'thor/core_ext/file_binary_read'
|
4
|
+
require 'thor/actions/create_file'
|
5
|
+
require 'thor/actions/create_link'
|
6
|
+
require 'thor/actions/directory'
|
7
|
+
require 'thor/actions/empty_directory'
|
8
|
+
require 'thor/actions/file_manipulation'
|
9
|
+
require 'thor/actions/inject_into_file'
|
10
|
+
|
11
|
+
class Thor
|
12
|
+
module Actions
|
13
|
+
attr_accessor :behavior
|
14
|
+
|
15
|
+
def self.included(base) #:nodoc:
|
16
|
+
base.extend ClassMethods
|
17
|
+
end
|
18
|
+
|
19
|
+
module ClassMethods
|
20
|
+
# Hold source paths for one Thor instance. source_paths_for_search is the
|
21
|
+
# method responsible to gather source_paths from this current class,
|
22
|
+
# inherited paths and the source root.
|
23
|
+
#
|
24
|
+
def source_paths
|
25
|
+
@_source_paths ||= []
|
26
|
+
end
|
27
|
+
|
28
|
+
# Stores and return the source root for this class
|
29
|
+
def source_root(path=nil)
|
30
|
+
@_source_root = path if path
|
31
|
+
@_source_root
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns the source paths in the following order:
|
35
|
+
#
|
36
|
+
# 1) This class source paths
|
37
|
+
# 2) Source root
|
38
|
+
# 3) Parents source paths
|
39
|
+
#
|
40
|
+
def source_paths_for_search
|
41
|
+
paths = []
|
42
|
+
paths += self.source_paths
|
43
|
+
paths << self.source_root if self.source_root
|
44
|
+
paths += from_superclass(:source_paths, [])
|
45
|
+
paths
|
46
|
+
end
|
47
|
+
|
48
|
+
# Add runtime options that help actions execution.
|
49
|
+
#
|
50
|
+
def add_runtime_options!
|
51
|
+
class_option :force, :type => :boolean, :aliases => "-f", :group => :runtime,
|
52
|
+
:desc => "Overwrite files that already exist"
|
53
|
+
|
54
|
+
class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
|
55
|
+
:desc => "Run but do not make any changes"
|
56
|
+
|
57
|
+
class_option :quiet, :type => :boolean, :aliases => "-q", :group => :runtime,
|
58
|
+
:desc => "Suppress status output"
|
59
|
+
|
60
|
+
class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
|
61
|
+
:desc => "Skip files that already exist"
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
# Extends initializer to add more configuration options.
|
66
|
+
#
|
67
|
+
# ==== Configuration
|
68
|
+
# behavior<Symbol>:: The actions default behavior. Can be :invoke or :revoke.
|
69
|
+
# It also accepts :force, :skip and :pretend to set the behavior
|
70
|
+
# and the respective option.
|
71
|
+
#
|
72
|
+
# destination_root<String>:: The root directory needed for some actions.
|
73
|
+
#
|
74
|
+
def initialize(args=[], options={}, config={})
|
75
|
+
self.behavior = case config[:behavior].to_s
|
76
|
+
when "force", "skip"
|
77
|
+
_cleanup_options_and_set(options, config[:behavior])
|
78
|
+
:invoke
|
79
|
+
when "revoke"
|
80
|
+
:revoke
|
81
|
+
else
|
82
|
+
:invoke
|
83
|
+
end
|
84
|
+
|
85
|
+
super
|
86
|
+
self.destination_root = config[:destination_root]
|
87
|
+
end
|
88
|
+
|
89
|
+
# Wraps an action object and call it accordingly to the thor class behavior.
|
90
|
+
#
|
91
|
+
def action(instance) #:nodoc:
|
92
|
+
if behavior == :revoke
|
93
|
+
instance.revoke!
|
94
|
+
else
|
95
|
+
instance.invoke!
|
96
|
+
end
|
97
|
+
end
|
98
|
+
|
99
|
+
# Returns the root for this thor class (also aliased as destination root).
|
100
|
+
#
|
101
|
+
def destination_root
|
102
|
+
@destination_stack.last
|
103
|
+
end
|
104
|
+
|
105
|
+
# Sets the root for this thor class. Relatives path are added to the
|
106
|
+
# directory where the script was invoked and expanded.
|
107
|
+
#
|
108
|
+
def destination_root=(root)
|
109
|
+
@destination_stack ||= []
|
110
|
+
@destination_stack[0] = File.expand_path(root || '')
|
111
|
+
end
|
112
|
+
|
113
|
+
# Returns the given path relative to the absolute root (ie, root where
|
114
|
+
# the script started).
|
115
|
+
#
|
116
|
+
def relative_to_original_destination_root(path, remove_dot=true)
|
117
|
+
path = path.dup
|
118
|
+
if path.gsub!(@destination_stack[0], '.')
|
119
|
+
remove_dot ? (path[2..-1] || '') : path
|
120
|
+
else
|
121
|
+
path
|
122
|
+
end
|
123
|
+
end
|
124
|
+
|
125
|
+
# Holds source paths in instance so they can be manipulated.
|
126
|
+
#
|
127
|
+
def source_paths
|
128
|
+
@source_paths ||= self.class.source_paths_for_search
|
129
|
+
end
|
130
|
+
|
131
|
+
# Receives a file or directory and search for it in the source paths.
|
132
|
+
#
|
133
|
+
def find_in_source_paths(file)
|
134
|
+
relative_root = relative_to_original_destination_root(destination_root, false)
|
135
|
+
|
136
|
+
source_paths.each do |source|
|
137
|
+
source_file = File.expand_path(file, File.join(source, relative_root))
|
138
|
+
return source_file if File.exists?(source_file)
|
139
|
+
end
|
140
|
+
|
141
|
+
message = "Could not find #{file.inspect} in any of your source paths. "
|
142
|
+
|
143
|
+
unless self.class.source_root
|
144
|
+
message << "Please invoke #{self.class.name}.source_root(PATH) with the PATH containing your templates. "
|
145
|
+
end
|
146
|
+
|
147
|
+
if source_paths.empty?
|
148
|
+
message << "Currently you have no source paths."
|
149
|
+
else
|
150
|
+
message << "Your current source paths are: \n#{source_paths.join("\n")}"
|
151
|
+
end
|
152
|
+
|
153
|
+
raise Error, message
|
154
|
+
end
|
155
|
+
|
156
|
+
# Do something in the root or on a provided subfolder. If a relative path
|
157
|
+
# is given it's referenced from the current root. The full path is yielded
|
158
|
+
# to the block you provide. The path is set back to the previous path when
|
159
|
+
# the method exits.
|
160
|
+
#
|
161
|
+
# ==== Parameters
|
162
|
+
# dir<String>:: the directory to move to.
|
163
|
+
# config<Hash>:: give :verbose => true to log and use padding.
|
164
|
+
#
|
165
|
+
def inside(dir='', config={}, &block)
|
166
|
+
verbose = config.fetch(:verbose, false)
|
167
|
+
pretend = options[:pretend]
|
168
|
+
|
169
|
+
say_status :inside, dir, verbose
|
170
|
+
shell.padding += 1 if verbose
|
171
|
+
@destination_stack.push File.expand_path(dir, destination_root)
|
172
|
+
|
173
|
+
# If the directory doesnt exist and we're not pretending
|
174
|
+
if !File.exist?(destination_root) && !pretend
|
175
|
+
FileUtils.mkdir_p(destination_root)
|
176
|
+
end
|
177
|
+
|
178
|
+
if pretend
|
179
|
+
# In pretend mode, just yield down to the block
|
180
|
+
block.arity == 1 ? yield(destination_root) : yield
|
181
|
+
else
|
182
|
+
FileUtils.cd(destination_root) { block.arity == 1 ? yield(destination_root) : yield }
|
183
|
+
end
|
184
|
+
|
185
|
+
@destination_stack.pop
|
186
|
+
shell.padding -= 1 if verbose
|
187
|
+
end
|
188
|
+
|
189
|
+
# Goes to the root and execute the given block.
|
190
|
+
#
|
191
|
+
def in_root
|
192
|
+
inside(@destination_stack.first) { yield }
|
193
|
+
end
|
194
|
+
|
195
|
+
# Loads an external file and execute it in the instance binding.
|
196
|
+
#
|
197
|
+
# ==== Parameters
|
198
|
+
# path<String>:: The path to the file to execute. Can be a web address or
|
199
|
+
# a relative path from the source root.
|
200
|
+
#
|
201
|
+
# ==== Examples
|
202
|
+
#
|
203
|
+
# apply "http://gist.github.com/103208"
|
204
|
+
#
|
205
|
+
# apply "recipes/jquery.rb"
|
206
|
+
#
|
207
|
+
def apply(path, config={})
|
208
|
+
verbose = config.fetch(:verbose, true)
|
209
|
+
is_uri = path =~ /^https?\:\/\//
|
210
|
+
path = find_in_source_paths(path) unless is_uri
|
211
|
+
|
212
|
+
say_status :apply, path, verbose
|
213
|
+
shell.padding += 1 if verbose
|
214
|
+
|
215
|
+
if is_uri
|
216
|
+
contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
|
217
|
+
else
|
218
|
+
contents = open(path) {|io| io.read }
|
219
|
+
end
|
220
|
+
|
221
|
+
instance_eval(contents, path)
|
222
|
+
shell.padding -= 1 if verbose
|
223
|
+
end
|
224
|
+
|
225
|
+
# Executes a command returning the contents of the command.
|
226
|
+
#
|
227
|
+
# ==== Parameters
|
228
|
+
# command<String>:: the command to be executed.
|
229
|
+
# config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
|
230
|
+
# to append an executable to command executation.
|
231
|
+
#
|
232
|
+
# ==== Example
|
233
|
+
#
|
234
|
+
# inside('vendor') do
|
235
|
+
# run('ln -s ~/edge rails')
|
236
|
+
# end
|
237
|
+
#
|
238
|
+
def run(command, config={})
|
239
|
+
return unless behavior == :invoke
|
240
|
+
|
241
|
+
destination = relative_to_original_destination_root(destination_root, false)
|
242
|
+
desc = "#{command} from #{destination.inspect}"
|
243
|
+
|
244
|
+
if config[:with]
|
245
|
+
desc = "#{File.basename(config[:with].to_s)} #{desc}"
|
246
|
+
command = "#{config[:with]} #{command}"
|
247
|
+
end
|
248
|
+
|
249
|
+
say_status :run, desc, config.fetch(:verbose, true)
|
250
|
+
|
251
|
+
unless options[:pretend]
|
252
|
+
config[:capture] ? `#{command}` : system("#{command}")
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
# Executes a ruby script (taking into account WIN32 platform quirks).
|
257
|
+
#
|
258
|
+
# ==== Parameters
|
259
|
+
# command<String>:: the command to be executed.
|
260
|
+
# config<Hash>:: give :verbose => false to not log the status.
|
261
|
+
#
|
262
|
+
def run_ruby_script(command, config={})
|
263
|
+
return unless behavior == :invoke
|
264
|
+
run command, config.merge(:with => Thor::Util.ruby_command)
|
265
|
+
end
|
266
|
+
|
267
|
+
# Run a thor command. A hash of options can be given and it's converted to
|
268
|
+
# switches.
|
269
|
+
#
|
270
|
+
# ==== Parameters
|
271
|
+
# task<String>:: the task to be invoked
|
272
|
+
# args<Array>:: arguments to the task
|
273
|
+
# config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output.
|
274
|
+
# Other options are given as parameter to Thor.
|
275
|
+
#
|
276
|
+
#
|
277
|
+
# ==== Examples
|
278
|
+
#
|
279
|
+
# thor :install, "http://gist.github.com/103208"
|
280
|
+
# #=> thor install http://gist.github.com/103208
|
281
|
+
#
|
282
|
+
# thor :list, :all => true, :substring => 'rails'
|
283
|
+
# #=> thor list --all --substring=rails
|
284
|
+
#
|
285
|
+
def thor(task, *args)
|
286
|
+
config = args.last.is_a?(Hash) ? args.pop : {}
|
287
|
+
verbose = config.key?(:verbose) ? config.delete(:verbose) : true
|
288
|
+
pretend = config.key?(:pretend) ? config.delete(:pretend) : false
|
289
|
+
capture = config.key?(:capture) ? config.delete(:capture) : false
|
290
|
+
|
291
|
+
args.unshift task
|
292
|
+
args.push Thor::Options.to_switches(config)
|
293
|
+
command = args.join(' ').strip
|
294
|
+
|
295
|
+
run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
|
296
|
+
end
|
297
|
+
|
298
|
+
protected
|
299
|
+
|
300
|
+
# Allow current root to be shared between invocations.
|
301
|
+
#
|
302
|
+
def _shared_configuration #:nodoc:
|
303
|
+
super.merge!(:destination_root => self.destination_root)
|
304
|
+
end
|
305
|
+
|
306
|
+
def _cleanup_options_and_set(options, key) #:nodoc:
|
307
|
+
case options
|
308
|
+
when Array
|
309
|
+
%w(--force -f --skip -s).each { |i| options.delete(i) }
|
310
|
+
options << "--#{key}"
|
311
|
+
when Hash
|
312
|
+
[:force, :skip, "force", "skip"].each { |i| options.delete(i) }
|
313
|
+
options.merge!(key => true)
|
314
|
+
end
|
315
|
+
end
|
316
|
+
|
317
|
+
end
|
318
|
+
end
|