rkh-bundler 1.2.0.pre

Sign up to get free protection for your applications and to get access to all the features.
Files changed (176) hide show
  1. data/.gitignore +22 -0
  2. data/.travis.yml +42 -0
  3. data/CHANGELOG.md +1105 -0
  4. data/ISSUES.md +67 -0
  5. data/LICENSE +23 -0
  6. data/README.md +31 -0
  7. data/Rakefile +208 -0
  8. data/UPGRADING.md +103 -0
  9. data/bin/bundle +31 -0
  10. data/bundler.gemspec +31 -0
  11. data/lib/bundler.rb +353 -0
  12. data/lib/bundler/capistrano.rb +11 -0
  13. data/lib/bundler/cli.rb +693 -0
  14. data/lib/bundler/definition.rb +568 -0
  15. data/lib/bundler/dep_proxy.rb +43 -0
  16. data/lib/bundler/dependency.rb +134 -0
  17. data/lib/bundler/deployment.rb +58 -0
  18. data/lib/bundler/dsl.rb +256 -0
  19. data/lib/bundler/endpoint_specification.rb +78 -0
  20. data/lib/bundler/environment.rb +47 -0
  21. data/lib/bundler/fetcher.rb +225 -0
  22. data/lib/bundler/gem_helper.rb +162 -0
  23. data/lib/bundler/gem_helpers.rb +23 -0
  24. data/lib/bundler/gem_installer.rb +9 -0
  25. data/lib/bundler/gem_tasks.rb +2 -0
  26. data/lib/bundler/graph.rb +148 -0
  27. data/lib/bundler/index.rb +187 -0
  28. data/lib/bundler/installer.rb +190 -0
  29. data/lib/bundler/lazy_specification.rb +79 -0
  30. data/lib/bundler/lockfile_parser.rb +127 -0
  31. data/lib/bundler/match_platform.rb +13 -0
  32. data/lib/bundler/psyched_yaml.rb +15 -0
  33. data/lib/bundler/remote_specification.rb +57 -0
  34. data/lib/bundler/resolver.rb +486 -0
  35. data/lib/bundler/ruby_version.rb +94 -0
  36. data/lib/bundler/rubygems_ext.rb +153 -0
  37. data/lib/bundler/rubygems_integration.rb +394 -0
  38. data/lib/bundler/runtime.rb +233 -0
  39. data/lib/bundler/settings.rb +128 -0
  40. data/lib/bundler/setup.rb +23 -0
  41. data/lib/bundler/shared_helpers.rb +71 -0
  42. data/lib/bundler/source.rb +869 -0
  43. data/lib/bundler/spec_set.rb +137 -0
  44. data/lib/bundler/templates/Executable +16 -0
  45. data/lib/bundler/templates/Executable.standalone +12 -0
  46. data/lib/bundler/templates/Gemfile +4 -0
  47. data/lib/bundler/templates/newgem/Gemfile.tt +4 -0
  48. data/lib/bundler/templates/newgem/LICENSE.tt +22 -0
  49. data/lib/bundler/templates/newgem/README.md.tt +29 -0
  50. data/lib/bundler/templates/newgem/Rakefile.tt +2 -0
  51. data/lib/bundler/templates/newgem/bin/newgem.tt +3 -0
  52. data/lib/bundler/templates/newgem/gitignore.tt +17 -0
  53. data/lib/bundler/templates/newgem/lib/newgem.rb.tt +9 -0
  54. data/lib/bundler/templates/newgem/lib/newgem/version.rb.tt +7 -0
  55. data/lib/bundler/templates/newgem/newgem.gemspec.tt +17 -0
  56. data/lib/bundler/ui.rb +88 -0
  57. data/lib/bundler/vendor/net/http/faster.rb +27 -0
  58. data/lib/bundler/vendor/net/http/persistent.rb +468 -0
  59. data/lib/bundler/vendor/thor.rb +358 -0
  60. data/lib/bundler/vendor/thor/actions.rb +314 -0
  61. data/lib/bundler/vendor/thor/actions/create_file.rb +105 -0
  62. data/lib/bundler/vendor/thor/actions/create_link.rb +57 -0
  63. data/lib/bundler/vendor/thor/actions/directory.rb +93 -0
  64. data/lib/bundler/vendor/thor/actions/empty_directory.rb +134 -0
  65. data/lib/bundler/vendor/thor/actions/file_manipulation.rb +270 -0
  66. data/lib/bundler/vendor/thor/actions/inject_into_file.rb +109 -0
  67. data/lib/bundler/vendor/thor/base.rb +576 -0
  68. data/lib/bundler/vendor/thor/core_ext/file_binary_read.rb +9 -0
  69. data/lib/bundler/vendor/thor/core_ext/hash_with_indifferent_access.rb +75 -0
  70. data/lib/bundler/vendor/thor/core_ext/ordered_hash.rb +100 -0
  71. data/lib/bundler/vendor/thor/error.rb +30 -0
  72. data/lib/bundler/vendor/thor/group.rb +273 -0
  73. data/lib/bundler/vendor/thor/invocation.rb +168 -0
  74. data/lib/bundler/vendor/thor/parser.rb +4 -0
  75. data/lib/bundler/vendor/thor/parser/argument.rb +67 -0
  76. data/lib/bundler/vendor/thor/parser/arguments.rb +161 -0
  77. data/lib/bundler/vendor/thor/parser/option.rb +120 -0
  78. data/lib/bundler/vendor/thor/parser/options.rb +172 -0
  79. data/lib/bundler/vendor/thor/rake_compat.rb +66 -0
  80. data/lib/bundler/vendor/thor/runner.rb +309 -0
  81. data/lib/bundler/vendor/thor/shell.rb +88 -0
  82. data/lib/bundler/vendor/thor/shell/basic.rb +302 -0
  83. data/lib/bundler/vendor/thor/shell/color.rb +108 -0
  84. data/lib/bundler/vendor/thor/shell/html.rb +121 -0
  85. data/lib/bundler/vendor/thor/task.rb +113 -0
  86. data/lib/bundler/vendor/thor/util.rb +229 -0
  87. data/lib/bundler/vendor/thor/version.rb +3 -0
  88. data/lib/bundler/vendored_thor.rb +7 -0
  89. data/lib/bundler/version.rb +6 -0
  90. data/lib/bundler/vlad.rb +11 -0
  91. data/man/bundle-config.ronn +130 -0
  92. data/man/bundle-exec.ronn +111 -0
  93. data/man/bundle-install.ronn +335 -0
  94. data/man/bundle-package.ronn +59 -0
  95. data/man/bundle-update.ronn +176 -0
  96. data/man/bundle.ronn +83 -0
  97. data/man/gemfile.5.ronn +324 -0
  98. data/man/index.txt +6 -0
  99. data/spec/bundler/dsl_spec.rb +48 -0
  100. data/spec/bundler/gem_helper_spec.rb +174 -0
  101. data/spec/bundler/source_spec.rb +25 -0
  102. data/spec/cache/gems_spec.rb +239 -0
  103. data/spec/cache/git_spec.rb +124 -0
  104. data/spec/cache/path_spec.rb +103 -0
  105. data/spec/cache/platform_spec.rb +57 -0
  106. data/spec/install/deploy_spec.rb +211 -0
  107. data/spec/install/gems/c_ext_spec.rb +48 -0
  108. data/spec/install/gems/dependency_api_spec.rb +402 -0
  109. data/spec/install/gems/env_spec.rb +107 -0
  110. data/spec/install/gems/flex_spec.rb +313 -0
  111. data/spec/install/gems/groups_spec.rb +268 -0
  112. data/spec/install/gems/packed_spec.rb +84 -0
  113. data/spec/install/gems/platform_spec.rb +208 -0
  114. data/spec/install/gems/post_install_spec.rb +47 -0
  115. data/spec/install/gems/resolving_spec.rb +72 -0
  116. data/spec/install/gems/simple_case_spec.rb +814 -0
  117. data/spec/install/gems/standalone_spec.rb +260 -0
  118. data/spec/install/gems/sudo_spec.rb +74 -0
  119. data/spec/install/gems/win32_spec.rb +26 -0
  120. data/spec/install/gemspec_spec.rb +170 -0
  121. data/spec/install/git_spec.rb +796 -0
  122. data/spec/install/invalid_spec.rb +35 -0
  123. data/spec/install/path_spec.rb +405 -0
  124. data/spec/install/upgrade_spec.rb +26 -0
  125. data/spec/lock/git_spec.rb +35 -0
  126. data/spec/lock/lockfile_spec.rb +809 -0
  127. data/spec/other/check_spec.rb +265 -0
  128. data/spec/other/clean_spec.rb +492 -0
  129. data/spec/other/config_spec.rb +138 -0
  130. data/spec/other/console_spec.rb +54 -0
  131. data/spec/other/exec_spec.rb +229 -0
  132. data/spec/other/ext_spec.rb +37 -0
  133. data/spec/other/help_spec.rb +39 -0
  134. data/spec/other/init_spec.rb +40 -0
  135. data/spec/other/newgem_spec.rb +87 -0
  136. data/spec/other/open_spec.rb +35 -0
  137. data/spec/other/outdated_spec.rb +93 -0
  138. data/spec/other/platform_spec.rb +881 -0
  139. data/spec/other/show_spec.rb +88 -0
  140. data/spec/quality_spec.rb +62 -0
  141. data/spec/realworld/edgecases_spec.rb +177 -0
  142. data/spec/resolver/basic_spec.rb +20 -0
  143. data/spec/resolver/platform_spec.rb +82 -0
  144. data/spec/runtime/executable_spec.rb +120 -0
  145. data/spec/runtime/load_spec.rb +107 -0
  146. data/spec/runtime/platform_spec.rb +90 -0
  147. data/spec/runtime/require_spec.rb +261 -0
  148. data/spec/runtime/setup_spec.rb +755 -0
  149. data/spec/runtime/with_clean_env_spec.rb +80 -0
  150. data/spec/spec_helper.rb +98 -0
  151. data/spec/support/artifice/endopint_marshal_fail_basic_authentication.rb +13 -0
  152. data/spec/support/artifice/endpoint.rb +54 -0
  153. data/spec/support/artifice/endpoint_500.rb +37 -0
  154. data/spec/support/artifice/endpoint_api_missing.rb +16 -0
  155. data/spec/support/artifice/endpoint_basic_authentication.rb +13 -0
  156. data/spec/support/artifice/endpoint_extra.rb +27 -0
  157. data/spec/support/artifice/endpoint_extra_missing.rb +15 -0
  158. data/spec/support/artifice/endpoint_fallback.rb +18 -0
  159. data/spec/support/artifice/endpoint_marshal_fail.rb +11 -0
  160. data/spec/support/artifice/endpoint_redirect.rb +15 -0
  161. data/spec/support/builders.rb +604 -0
  162. data/spec/support/fakeweb/rack-1.0.0.marshal +2 -0
  163. data/spec/support/fakeweb/windows.rb +23 -0
  164. data/spec/support/helpers.rb +317 -0
  165. data/spec/support/indexes.rb +112 -0
  166. data/spec/support/matchers.rb +77 -0
  167. data/spec/support/path.rb +73 -0
  168. data/spec/support/platforms.rb +86 -0
  169. data/spec/support/ruby_ext.rb +20 -0
  170. data/spec/support/rubygems_ext.rb +37 -0
  171. data/spec/support/rubygems_hax/platform.rb +22 -0
  172. data/spec/support/sudo.rb +21 -0
  173. data/spec/update/gems_spec.rb +134 -0
  174. data/spec/update/git_spec.rb +196 -0
  175. data/spec/update/source_spec.rb +51 -0
  176. metadata +338 -0
@@ -0,0 +1,358 @@
1
+ require 'thor/base'
2
+
3
+ class Thor
4
+ class << self
5
+ # Sets the default task when thor is executed without an explicit task to be called.
6
+ #
7
+ # ==== Parameters
8
+ # meth<Symbol>:: name of the defaut task
9
+ #
10
+ def default_task(meth=nil)
11
+ case meth
12
+ when :none
13
+ @default_task = 'help'
14
+ when nil
15
+ @default_task ||= from_superclass(:default_task, 'help')
16
+ else
17
+ @default_task = meth.to_s
18
+ end
19
+ end
20
+
21
+ # Registers another Thor subclass as a command.
22
+ #
23
+ # ==== Parameters
24
+ # klass<Class>:: Thor subclass to register
25
+ # command<String>:: Subcommand name to use
26
+ # usage<String>:: Short usage for the subcommand
27
+ # description<String>:: Description for the subcommand
28
+ def register(klass, subcommand_name, usage, description, options={})
29
+ if klass <= Thor::Group
30
+ desc usage, description, options
31
+ define_method(subcommand_name) { invoke klass }
32
+ else
33
+ desc usage, description, options
34
+ subcommand subcommand_name, klass
35
+ end
36
+ end
37
+
38
+ # Defines the usage and the description of the next task.
39
+ #
40
+ # ==== Parameters
41
+ # usage<String>
42
+ # description<String>
43
+ # options<String>
44
+ #
45
+ def desc(usage, description, options={})
46
+ if options[:for]
47
+ task = find_and_refresh_task(options[:for])
48
+ task.usage = usage if usage
49
+ task.description = description if description
50
+ else
51
+ @usage, @desc, @hide = usage, description, options[:hide] || false
52
+ end
53
+ end
54
+
55
+ # Defines the long description of the next task.
56
+ #
57
+ # ==== Parameters
58
+ # long description<String>
59
+ #
60
+ def long_desc(long_description, options={})
61
+ if options[:for]
62
+ task = find_and_refresh_task(options[:for])
63
+ task.long_description = long_description if long_description
64
+ else
65
+ @long_desc = long_description
66
+ end
67
+ end
68
+
69
+ # Maps an input to a task. If you define:
70
+ #
71
+ # map "-T" => "list"
72
+ #
73
+ # Running:
74
+ #
75
+ # thor -T
76
+ #
77
+ # Will invoke the list task.
78
+ #
79
+ # ==== Parameters
80
+ # Hash[String|Array => Symbol]:: Maps the string or the strings in the array to the given task.
81
+ #
82
+ def map(mappings=nil)
83
+ @map ||= from_superclass(:map, {})
84
+
85
+ if mappings
86
+ mappings.each do |key, value|
87
+ if key.respond_to?(:each)
88
+ key.each {|subkey| @map[subkey] = value}
89
+ else
90
+ @map[key] = value
91
+ end
92
+ end
93
+ end
94
+
95
+ @map
96
+ end
97
+
98
+ # Declares the options for the next task to be declared.
99
+ #
100
+ # ==== Parameters
101
+ # Hash[Symbol => Object]:: The hash key is the name of the option and the value
102
+ # is the type of the option. Can be :string, :array, :hash, :boolean, :numeric
103
+ # or :required (string). If you give a value, the type of the value is used.
104
+ #
105
+ def method_options(options=nil)
106
+ @method_options ||= {}
107
+ build_options(options, @method_options) if options
108
+ @method_options
109
+ end
110
+
111
+ # Adds an option to the set of method options. If :for is given as option,
112
+ # it allows you to change the options from a previous defined task.
113
+ #
114
+ # def previous_task
115
+ # # magic
116
+ # end
117
+ #
118
+ # method_option :foo => :bar, :for => :previous_task
119
+ #
120
+ # def next_task
121
+ # # magic
122
+ # end
123
+ #
124
+ # ==== Parameters
125
+ # name<Symbol>:: The name of the argument.
126
+ # options<Hash>:: Described below.
127
+ #
128
+ # ==== Options
129
+ # :desc - Description for the argument.
130
+ # :required - If the argument is required or not.
131
+ # :default - Default value for this argument. It cannot be required and have default values.
132
+ # :aliases - Aliases for this option.
133
+ # :type - The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
134
+ # :banner - String to show on usage notes.
135
+ #
136
+ def method_option(name, options={})
137
+ scope = if options[:for]
138
+ find_and_refresh_task(options[:for]).options
139
+ else
140
+ method_options
141
+ end
142
+
143
+ build_option(name, options, scope)
144
+ end
145
+
146
+ # Prints help information for the given task.
147
+ #
148
+ # ==== Parameters
149
+ # shell<Thor::Shell>
150
+ # task_name<String>
151
+ #
152
+ def task_help(shell, task_name)
153
+ meth = normalize_task_name(task_name)
154
+ task = all_tasks[meth]
155
+ handle_no_task_error(meth) unless task
156
+
157
+ shell.say "Usage:"
158
+ shell.say " #{banner(task)}"
159
+ shell.say
160
+ class_options_help(shell, nil => task.options.map { |_, o| o })
161
+ if task.long_description
162
+ shell.say "Description:"
163
+ shell.print_wrapped(task.long_description, :ident => 2)
164
+ else
165
+ shell.say task.description
166
+ end
167
+ end
168
+
169
+ # Prints help information for this class.
170
+ #
171
+ # ==== Parameters
172
+ # shell<Thor::Shell>
173
+ #
174
+ def help(shell, subcommand = false)
175
+ list = printable_tasks(true, subcommand)
176
+ Thor::Util.thor_classes_in(self).each do |klass|
177
+ list += klass.printable_tasks(false)
178
+ end
179
+ list.sort!{ |a,b| a[0] <=> b[0] }
180
+
181
+ shell.say "Tasks:"
182
+ shell.print_table(list, :ident => 2, :truncate => true)
183
+ shell.say
184
+ class_options_help(shell)
185
+ end
186
+
187
+ # Returns tasks ready to be printed.
188
+ def printable_tasks(all = true, subcommand = false)
189
+ (all ? all_tasks : tasks).map do |_, task|
190
+ next if task.hidden?
191
+ item = []
192
+ item << banner(task, false, subcommand)
193
+ item << (task.description ? "# #{task.description.gsub(/\s+/m,' ')}" : "")
194
+ item
195
+ end.compact
196
+ end
197
+
198
+ def subcommands
199
+ @subcommands ||= from_superclass(:subcommands, [])
200
+ end
201
+
202
+ def subcommand(subcommand, subcommand_class)
203
+ self.subcommands << subcommand.to_s
204
+ subcommand_class.subcommand_help subcommand
205
+ define_method(subcommand) { |*args| invoke subcommand_class, args }
206
+ end
207
+
208
+ # Extend check unknown options to accept a hash of conditions.
209
+ #
210
+ # === Parameters
211
+ # options<Hash>: A hash containing :only and/or :except keys
212
+ def check_unknown_options!(options={})
213
+ @check_unknown_options ||= Hash.new
214
+ options.each do |key, value|
215
+ if value
216
+ @check_unknown_options[key] = Array(value)
217
+ else
218
+ @check_unknown_options.delete(key)
219
+ end
220
+ end
221
+ @check_unknown_options
222
+ end
223
+
224
+ # Overwrite check_unknown_options? to take subcommands and options into account.
225
+ def check_unknown_options?(config) #:nodoc:
226
+ options = check_unknown_options
227
+ return false unless options
228
+
229
+ task = config[:current_task]
230
+ return true unless task
231
+
232
+ name = task.name
233
+
234
+ if subcommands.include?(name)
235
+ false
236
+ elsif options[:except]
237
+ !options[:except].include?(name.to_sym)
238
+ elsif options[:only]
239
+ options[:only].include?(name.to_sym)
240
+ else
241
+ true
242
+ end
243
+ end
244
+
245
+ protected
246
+
247
+ # The method responsible for dispatching given the args.
248
+ def dispatch(meth, given_args, given_opts, config) #:nodoc:
249
+ meth ||= retrieve_task_name(given_args)
250
+ task = all_tasks[normalize_task_name(meth)]
251
+
252
+ if task
253
+ args, opts = Thor::Options.split(given_args)
254
+ else
255
+ args, opts = given_args, nil
256
+ task = Thor::DynamicTask.new(meth)
257
+ end
258
+
259
+ opts = given_opts || opts || []
260
+ config.merge!(:current_task => task, :task_options => task.options)
261
+
262
+ trailing = args[Range.new(arguments.size, -1)]
263
+ new(args, opts, config).invoke_task(task, trailing || [])
264
+ end
265
+
266
+ # The banner for this class. You can customize it if you are invoking the
267
+ # thor class by another ways which is not the Thor::Runner. It receives
268
+ # the task that is going to be invoked and a boolean which indicates if
269
+ # the namespace should be displayed as arguments.
270
+ #
271
+ def banner(task, namespace = nil, subcommand = false)
272
+ "#{basename} #{task.formatted_usage(self, $thor_runner, subcommand)}"
273
+ end
274
+
275
+ def baseclass #:nodoc:
276
+ Thor
277
+ end
278
+
279
+ def create_task(meth) #:nodoc:
280
+ if @usage && @desc
281
+ base_class = @hide ? Thor::HiddenTask : Thor::Task
282
+ tasks[meth] = base_class.new(meth, @desc, @long_desc, @usage, method_options)
283
+ @usage, @desc, @long_desc, @method_options, @hide = nil
284
+ true
285
+ elsif self.all_tasks[meth] || meth == "method_missing"
286
+ true
287
+ else
288
+ puts "[WARNING] Attempted to create task #{meth.inspect} without usage or description. " <<
289
+ "Call desc if you want this method to be available as task or declare it inside a " <<
290
+ "no_tasks{} block. Invoked from #{caller[1].inspect}."
291
+ false
292
+ end
293
+ end
294
+
295
+ def initialize_added #:nodoc:
296
+ class_options.merge!(method_options)
297
+ @method_options = nil
298
+ end
299
+
300
+ # Retrieve the task name from given args.
301
+ def retrieve_task_name(args) #:nodoc:
302
+ meth = args.first.to_s unless args.empty?
303
+
304
+ if meth && (map[meth] || meth !~ /^\-/)
305
+ args.shift
306
+ else
307
+ nil
308
+ end
309
+ end
310
+
311
+ # Receives a task name (can be nil), and try to get a map from it.
312
+ # If a map can't be found use the sent name or the default task.
313
+ def normalize_task_name(meth) #:nodoc:
314
+ meth = map[meth.to_s] || find_subcommand_and_update_argv(meth) || meth || default_task
315
+ meth.to_s.gsub('-','_') # treat foo-bar > foo_bar
316
+ end
317
+
318
+ # terrible hack that overwrites ARGV
319
+ def find_subcommand_and_update_argv(subcmd_name) #:nodoc:
320
+ return unless subcmd_name
321
+ cmd = find_subcommand(subcmd_name)
322
+ ARGV[0] = cmd if cmd
323
+ cmd
324
+ end
325
+
326
+ def find_subcommand(subcmd_name)
327
+ possibilities = find_subcommand_possibilities subcmd_name
328
+ if possibilities.size > 1
329
+ raise "Ambiguous subcommand #{subcmd_name} matches [#{possibilities.join(', ')}]"
330
+ elsif possibilities.size < 1
331
+ return nil
332
+ end
333
+
334
+ possibilities.first
335
+ end
336
+
337
+ def find_subcommand_possibilities(subcmd_name)
338
+ len = subcmd_name.length
339
+ all_tasks.map {|t| t.first}.select { |n| subcmd_name == n[0, len] }
340
+ end
341
+
342
+ def subcommand_help(cmd)
343
+ desc "help [COMMAND]", "Describe subcommands or one specific subcommand"
344
+ class_eval <<-RUBY
345
+ def help(task = nil, subcommand = true); super; end
346
+ RUBY
347
+ end
348
+ end
349
+
350
+ include Thor::Base
351
+
352
+ map HELP_MAPPINGS => :help
353
+
354
+ desc "help [TASK]", "Describe available tasks or one specific task"
355
+ def help(task = nil, subcommand = false)
356
+ task ? self.class.task_help(shell, task) : self.class.help(shell, subcommand)
357
+ end
358
+ end
@@ -0,0 +1,314 @@
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 => "Supress 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.gsub(@destination_stack[0], '.')
118
+ remove_dot ? (path[2..-1] || '') : path
119
+ end
120
+
121
+ # Holds source paths in instance so they can be manipulated.
122
+ #
123
+ def source_paths
124
+ @source_paths ||= self.class.source_paths_for_search
125
+ end
126
+
127
+ # Receives a file or directory and search for it in the source paths.
128
+ #
129
+ def find_in_source_paths(file)
130
+ relative_root = relative_to_original_destination_root(destination_root, false)
131
+
132
+ source_paths.each do |source|
133
+ source_file = File.expand_path(file, File.join(source, relative_root))
134
+ return source_file if File.exists?(source_file)
135
+ end
136
+
137
+ message = "Could not find #{file.inspect} in any of your source paths. "
138
+
139
+ unless self.class.source_root
140
+ message << "Please invoke #{self.class.name}.source_root(PATH) with the PATH containing your templates. "
141
+ end
142
+
143
+ if source_paths.empty?
144
+ message << "Currently you have no source paths."
145
+ else
146
+ message << "Your current source paths are: \n#{source_paths.join("\n")}"
147
+ end
148
+
149
+ raise Error, message
150
+ end
151
+
152
+ # Do something in the root or on a provided subfolder. If a relative path
153
+ # is given it's referenced from the current root. The full path is yielded
154
+ # to the block you provide. The path is set back to the previous path when
155
+ # the method exits.
156
+ #
157
+ # ==== Parameters
158
+ # dir<String>:: the directory to move to.
159
+ # config<Hash>:: give :verbose => true to log and use padding.
160
+ #
161
+ def inside(dir='', config={}, &block)
162
+ verbose = config.fetch(:verbose, false)
163
+ pretend = options[:pretend]
164
+
165
+ say_status :inside, dir, verbose
166
+ shell.padding += 1 if verbose
167
+ @destination_stack.push File.expand_path(dir, destination_root)
168
+
169
+ # If the directory doesnt exist and we're not pretending
170
+ if !File.exist?(destination_root) && !pretend
171
+ FileUtils.mkdir_p(destination_root)
172
+ end
173
+
174
+ if pretend
175
+ # In pretend mode, just yield down to the block
176
+ block.arity == 1 ? yield(destination_root) : yield
177
+ else
178
+ FileUtils.cd(destination_root) { block.arity == 1 ? yield(destination_root) : yield }
179
+ end
180
+
181
+ @destination_stack.pop
182
+ shell.padding -= 1 if verbose
183
+ end
184
+
185
+ # Goes to the root and execute the given block.
186
+ #
187
+ def in_root
188
+ inside(@destination_stack.first) { yield }
189
+ end
190
+
191
+ # Loads an external file and execute it in the instance binding.
192
+ #
193
+ # ==== Parameters
194
+ # path<String>:: The path to the file to execute. Can be a web address or
195
+ # a relative path from the source root.
196
+ #
197
+ # ==== Examples
198
+ #
199
+ # apply "http://gist.github.com/103208"
200
+ #
201
+ # apply "recipes/jquery.rb"
202
+ #
203
+ def apply(path, config={})
204
+ verbose = config.fetch(:verbose, true)
205
+ is_uri = path =~ /^https?\:\/\//
206
+ path = find_in_source_paths(path) unless is_uri
207
+
208
+ say_status :apply, path, verbose
209
+ shell.padding += 1 if verbose
210
+
211
+ if is_uri
212
+ contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
213
+ else
214
+ contents = open(path) {|io| io.read }
215
+ end
216
+
217
+ instance_eval(contents, path)
218
+ shell.padding -= 1 if verbose
219
+ end
220
+
221
+ # Executes a command returning the contents of the command.
222
+ #
223
+ # ==== Parameters
224
+ # command<String>:: the command to be executed.
225
+ # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
226
+ # to append an executable to command executation.
227
+ #
228
+ # ==== Example
229
+ #
230
+ # inside('vendor') do
231
+ # run('ln -s ~/edge rails')
232
+ # end
233
+ #
234
+ def run(command, config={})
235
+ return unless behavior == :invoke
236
+
237
+ destination = relative_to_original_destination_root(destination_root, false)
238
+ desc = "#{command} from #{destination.inspect}"
239
+
240
+ if config[:with]
241
+ desc = "#{File.basename(config[:with].to_s)} #{desc}"
242
+ command = "#{config[:with]} #{command}"
243
+ end
244
+
245
+ say_status :run, desc, config.fetch(:verbose, true)
246
+
247
+ unless options[:pretend]
248
+ config[:capture] ? `#{command}` : system("#{command}")
249
+ end
250
+ end
251
+
252
+ # Executes a ruby script (taking into account WIN32 platform quirks).
253
+ #
254
+ # ==== Parameters
255
+ # command<String>:: the command to be executed.
256
+ # config<Hash>:: give :verbose => false to not log the status.
257
+ #
258
+ def run_ruby_script(command, config={})
259
+ return unless behavior == :invoke
260
+ run command, config.merge(:with => Thor::Util.ruby_command)
261
+ end
262
+
263
+ # Run a thor command. A hash of options can be given and it's converted to
264
+ # switches.
265
+ #
266
+ # ==== Parameters
267
+ # task<String>:: the task to be invoked
268
+ # args<Array>:: arguments to the task
269
+ # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output.
270
+ # Other options are given as parameter to Thor.
271
+ #
272
+ #
273
+ # ==== Examples
274
+ #
275
+ # thor :install, "http://gist.github.com/103208"
276
+ # #=> thor install http://gist.github.com/103208
277
+ #
278
+ # thor :list, :all => true, :substring => 'rails'
279
+ # #=> thor list --all --substring=rails
280
+ #
281
+ def thor(task, *args)
282
+ config = args.last.is_a?(Hash) ? args.pop : {}
283
+ verbose = config.key?(:verbose) ? config.delete(:verbose) : true
284
+ pretend = config.key?(:pretend) ? config.delete(:pretend) : false
285
+ capture = config.key?(:capture) ? config.delete(:capture) : false
286
+
287
+ args.unshift task
288
+ args.push Thor::Options.to_switches(config)
289
+ command = args.join(' ').strip
290
+
291
+ run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
292
+ end
293
+
294
+ protected
295
+
296
+ # Allow current root to be shared between invocations.
297
+ #
298
+ def _shared_configuration #:nodoc:
299
+ super.merge!(:destination_root => self.destination_root)
300
+ end
301
+
302
+ def _cleanup_options_and_set(options, key) #:nodoc:
303
+ case options
304
+ when Array
305
+ %w(--force -f --skip -s).each { |i| options.delete(i) }
306
+ options << "--#{key}"
307
+ when Hash
308
+ [:force, :skip, "force", "skip"].each { |i| options.delete(i) }
309
+ options.merge!(key => true)
310
+ end
311
+ end
312
+
313
+ end
314
+ end