overman 0.0.1 → 0.87.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (138) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +52 -0
  3. data/bin/foreman-runner +41 -0
  4. data/bin/overman +7 -0
  5. data/data/example/Procfile +4 -0
  6. data/data/example/Procfile.without_colon +2 -0
  7. data/data/example/error +7 -0
  8. data/data/example/log/neverdie.log +4 -0
  9. data/data/example/spawnee +14 -0
  10. data/data/example/spawner +7 -0
  11. data/data/example/ticker +14 -0
  12. data/data/example/utf8 +11 -0
  13. data/data/export/bluepill/master.pill.erb +28 -0
  14. data/data/export/daemon/master.conf.erb +14 -0
  15. data/data/export/daemon/process.conf.erb +8 -0
  16. data/data/export/daemon/process_master.conf.erb +2 -0
  17. data/data/export/launchd/launchd.plist.erb +33 -0
  18. data/data/export/runit/log/run.erb +7 -0
  19. data/data/export/runit/run.erb +4 -0
  20. data/data/export/supervisord/app.conf.erb +31 -0
  21. data/data/export/systemd/master.target.erb +5 -0
  22. data/data/export/systemd/process.service.erb +21 -0
  23. data/data/export/upstart/master.conf.erb +2 -0
  24. data/data/export/upstart/process.conf.erb +15 -0
  25. data/data/export/upstart/process_master.conf.erb +2 -0
  26. data/lib/foreman/cli.rb +162 -0
  27. data/lib/foreman/distribution.rb +9 -0
  28. data/lib/foreman/engine/cli.rb +105 -0
  29. data/lib/foreman/engine.rb +494 -0
  30. data/lib/foreman/env.rb +29 -0
  31. data/lib/foreman/export/base.rb +171 -0
  32. data/lib/foreman/export/bluepill.rb +12 -0
  33. data/lib/foreman/export/daemon.rb +28 -0
  34. data/lib/foreman/export/inittab.rb +42 -0
  35. data/lib/foreman/export/launchd.rb +22 -0
  36. data/lib/foreman/export/runit.rb +34 -0
  37. data/lib/foreman/export/supervisord.rb +16 -0
  38. data/lib/foreman/export/systemd.rb +34 -0
  39. data/lib/foreman/export/upstart.rb +46 -0
  40. data/lib/foreman/export.rb +36 -0
  41. data/lib/foreman/helpers.rb +45 -0
  42. data/lib/foreman/process.rb +81 -0
  43. data/lib/foreman/procfile.rb +94 -0
  44. data/lib/foreman/vendor/thor/lib/thor/actions/create_file.rb +103 -0
  45. data/lib/foreman/vendor/thor/lib/thor/actions/create_link.rb +59 -0
  46. data/lib/foreman/vendor/thor/lib/thor/actions/directory.rb +118 -0
  47. data/lib/foreman/vendor/thor/lib/thor/actions/empty_directory.rb +135 -0
  48. data/lib/foreman/vendor/thor/lib/thor/actions/file_manipulation.rb +327 -0
  49. data/lib/foreman/vendor/thor/lib/thor/actions/inject_into_file.rb +103 -0
  50. data/lib/foreman/vendor/thor/lib/thor/actions.rb +318 -0
  51. data/lib/foreman/vendor/thor/lib/thor/base.rb +656 -0
  52. data/lib/foreman/vendor/thor/lib/thor/command.rb +133 -0
  53. data/lib/foreman/vendor/thor/lib/thor/core_ext/hash_with_indifferent_access.rb +85 -0
  54. data/lib/foreman/vendor/thor/lib/thor/core_ext/io_binary_read.rb +12 -0
  55. data/lib/foreman/vendor/thor/lib/thor/core_ext/ordered_hash.rb +129 -0
  56. data/lib/foreman/vendor/thor/lib/thor/error.rb +32 -0
  57. data/lib/foreman/vendor/thor/lib/thor/group.rb +281 -0
  58. data/lib/foreman/vendor/thor/lib/thor/invocation.rb +177 -0
  59. data/lib/foreman/vendor/thor/lib/thor/line_editor/basic.rb +35 -0
  60. data/lib/foreman/vendor/thor/lib/thor/line_editor/readline.rb +88 -0
  61. data/lib/foreman/vendor/thor/lib/thor/line_editor.rb +17 -0
  62. data/lib/foreman/vendor/thor/lib/thor/parser/argument.rb +70 -0
  63. data/lib/foreman/vendor/thor/lib/thor/parser/arguments.rb +175 -0
  64. data/lib/foreman/vendor/thor/lib/thor/parser/option.rb +146 -0
  65. data/lib/foreman/vendor/thor/lib/thor/parser/options.rb +220 -0
  66. data/lib/foreman/vendor/thor/lib/thor/parser.rb +4 -0
  67. data/lib/foreman/vendor/thor/lib/thor/rake_compat.rb +71 -0
  68. data/lib/foreman/vendor/thor/lib/thor/runner.rb +322 -0
  69. data/lib/foreman/vendor/thor/lib/thor/shell/basic.rb +436 -0
  70. data/lib/foreman/vendor/thor/lib/thor/shell/color.rb +149 -0
  71. data/lib/foreman/vendor/thor/lib/thor/shell/html.rb +126 -0
  72. data/lib/foreman/vendor/thor/lib/thor/shell.rb +81 -0
  73. data/lib/foreman/vendor/thor/lib/thor/util.rb +268 -0
  74. data/lib/foreman/vendor/thor/lib/thor/version.rb +3 -0
  75. data/lib/foreman/vendor/thor/lib/thor.rb +492 -0
  76. data/lib/foreman/version.rb +5 -0
  77. data/lib/foreman.rb +17 -0
  78. data/man/overman.1 +284 -0
  79. data/spec/foreman/cli_spec.rb +111 -0
  80. data/spec/foreman/engine_spec.rb +114 -0
  81. data/spec/foreman/export/base_spec.rb +19 -0
  82. data/spec/foreman/export/bluepill_spec.rb +37 -0
  83. data/spec/foreman/export/daemon_spec.rb +97 -0
  84. data/spec/foreman/export/inittab_spec.rb +40 -0
  85. data/spec/foreman/export/launchd_spec.rb +31 -0
  86. data/spec/foreman/export/runit_spec.rb +36 -0
  87. data/spec/foreman/export/supervisord_spec.rb +38 -0
  88. data/spec/foreman/export/systemd_spec.rb +155 -0
  89. data/spec/foreman/export/upstart_spec.rb +118 -0
  90. data/spec/foreman/export_spec.rb +24 -0
  91. data/spec/foreman/helpers_spec.rb +26 -0
  92. data/spec/foreman/process_spec.rb +71 -0
  93. data/spec/foreman/procfile_spec.rb +57 -0
  94. data/spec/foreman_spec.rb +16 -0
  95. data/spec/helper_spec.rb +19 -0
  96. data/spec/resources/Procfile +5 -0
  97. data/spec/resources/Procfile.bad +2 -0
  98. data/spec/resources/bin/echo +2 -0
  99. data/spec/resources/bin/env +2 -0
  100. data/spec/resources/bin/test +2 -0
  101. data/spec/resources/bin/utf8 +2 -0
  102. data/spec/resources/export/bluepill/app-concurrency.pill +49 -0
  103. data/spec/resources/export/bluepill/app.pill +81 -0
  104. data/spec/resources/export/daemon/app-alpha-1.conf +7 -0
  105. data/spec/resources/export/daemon/app-alpha-2.conf +7 -0
  106. data/spec/resources/export/daemon/app-alpha.conf +2 -0
  107. data/spec/resources/export/daemon/app-bravo-1.conf +7 -0
  108. data/spec/resources/export/daemon/app-bravo.conf +2 -0
  109. data/spec/resources/export/daemon/app.conf +14 -0
  110. data/spec/resources/export/inittab/inittab.concurrency +4 -0
  111. data/spec/resources/export/inittab/inittab.default +6 -0
  112. data/spec/resources/export/launchd/launchd-a.default +29 -0
  113. data/spec/resources/export/launchd/launchd-b.default +29 -0
  114. data/spec/resources/export/launchd/launchd-c.default +30 -0
  115. data/spec/resources/export/runit/app-alpha-1/log/run +7 -0
  116. data/spec/resources/export/runit/app-alpha-1/run +4 -0
  117. data/spec/resources/export/runit/app-alpha-2/log/run +7 -0
  118. data/spec/resources/export/runit/app-alpha-2/run +4 -0
  119. data/spec/resources/export/runit/app-bravo-1/log/run +7 -0
  120. data/spec/resources/export/runit/app-bravo-1/run +4 -0
  121. data/spec/resources/export/supervisord/app-alpha-1.conf +42 -0
  122. data/spec/resources/export/supervisord/app-alpha-2.conf +22 -0
  123. data/spec/resources/export/systemd/app-alpha.1.service +18 -0
  124. data/spec/resources/export/systemd/app-alpha.2.service +18 -0
  125. data/spec/resources/export/systemd/app-alpha.target +2 -0
  126. data/spec/resources/export/systemd/app-bravo.1.service +18 -0
  127. data/spec/resources/export/systemd/app-bravo.target +2 -0
  128. data/spec/resources/export/systemd/app.target +5 -0
  129. data/spec/resources/export/upstart/app-alpha-1.conf +11 -0
  130. data/spec/resources/export/upstart/app-alpha-2.conf +11 -0
  131. data/spec/resources/export/upstart/app-alpha.conf +2 -0
  132. data/spec/resources/export/upstart/app-bravo-1.conf +11 -0
  133. data/spec/resources/export/upstart/app-bravo.conf +2 -0
  134. data/spec/resources/export/upstart/app.conf +2 -0
  135. data/spec/spec_helper.rb +177 -0
  136. metadata +147 -16
  137. data/lib/overman/version.rb +0 -5
  138. data/lib/overman.rb +0 -1
@@ -0,0 +1,118 @@
1
+ require "foreman/vendor/thor/lib/thor/actions/empty_directory"
2
+
3
+ class Foreman::Thor
4
+ module Actions
5
+ # Copies recursively the files from source directory to root directory.
6
+ # If any of the files finishes with .tt, it's considered to be a template
7
+ # and is placed in the destination without the extension .tt. If any
8
+ # empty directory is found, it's copied and all .empty_directory files are
9
+ # ignored. If any file name is wrapped within % signs, the text within
10
+ # the % signs will be executed as a method and replaced with the returned
11
+ # value. Let's suppose a doc directory with the following files:
12
+ #
13
+ # doc/
14
+ # components/.empty_directory
15
+ # README
16
+ # rdoc.rb.tt
17
+ # %app_name%.rb
18
+ #
19
+ # When invoked as:
20
+ #
21
+ # directory "doc"
22
+ #
23
+ # It will create a doc directory in the destination with the following
24
+ # files (assuming that the `app_name` method returns the value "blog"):
25
+ #
26
+ # doc/
27
+ # components/
28
+ # README
29
+ # rdoc.rb
30
+ # blog.rb
31
+ #
32
+ # <b>Encoded path note:</b> Since Foreman::Thor internals use Object#respond_to? to check if it can
33
+ # expand %something%, this `something` should be a public method in the class calling
34
+ # #directory. If a method is private, Foreman::Thor stack raises PrivateMethodEncodedError.
35
+ #
36
+ # ==== Parameters
37
+ # source<String>:: the relative path to the source root.
38
+ # destination<String>:: the relative path to the destination root.
39
+ # config<Hash>:: give :verbose => false to not log the status.
40
+ # If :recursive => false, does not look for paths recursively.
41
+ # If :mode => :preserve, preserve the file mode from the source.
42
+ # If :exclude_pattern => /regexp/, prevents copying files that match that regexp.
43
+ #
44
+ # ==== Examples
45
+ #
46
+ # directory "doc"
47
+ # directory "doc", "docs", :recursive => false
48
+ #
49
+ def directory(source, *args, &block)
50
+ config = args.last.is_a?(Hash) ? args.pop : {}
51
+ destination = args.first || source
52
+ action Directory.new(self, source, destination || source, config, &block)
53
+ end
54
+
55
+ class Directory < EmptyDirectory #:nodoc:
56
+ attr_reader :source
57
+
58
+ def initialize(base, source, destination = nil, config = {}, &block)
59
+ @source = File.expand_path(base.find_in_source_paths(source.to_s))
60
+ @block = block
61
+ super(base, destination, {:recursive => true}.merge(config))
62
+ end
63
+
64
+ def invoke!
65
+ base.empty_directory given_destination, config
66
+ execute!
67
+ end
68
+
69
+ def revoke!
70
+ execute!
71
+ end
72
+
73
+ protected
74
+
75
+ def execute!
76
+ lookup = Util.escape_globs(source)
77
+ lookup = config[:recursive] ? File.join(lookup, "**") : lookup
78
+ lookup = file_level_lookup(lookup)
79
+
80
+ files(lookup).sort.each do |file_source|
81
+ next if File.directory?(file_source)
82
+ next if config[:exclude_pattern] && file_source.match(config[:exclude_pattern])
83
+ file_destination = File.join(given_destination, file_source.gsub(source, "."))
84
+ file_destination.gsub!("/./", "/")
85
+
86
+ case file_source
87
+ when /\.empty_directory$/
88
+ dirname = File.dirname(file_destination).gsub(%r{/\.$}, "")
89
+ next if dirname == given_destination
90
+ base.empty_directory(dirname, config)
91
+ when /#{TEMPLATE_EXTNAME}$/
92
+ base.template(file_source, file_destination[0..-4], config, &@block)
93
+ else
94
+ base.copy_file(file_source, file_destination, config, &@block)
95
+ end
96
+ end
97
+ end
98
+
99
+ if RUBY_VERSION < "2.0"
100
+ def file_level_lookup(previous_lookup)
101
+ File.join(previous_lookup, "{*,.[a-z]*}")
102
+ end
103
+
104
+ def files(lookup)
105
+ Dir[lookup]
106
+ end
107
+ else
108
+ def file_level_lookup(previous_lookup)
109
+ File.join(previous_lookup, "*")
110
+ end
111
+
112
+ def files(lookup)
113
+ Dir.glob(lookup, File::FNM_DOTMATCH)
114
+ end
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,135 @@
1
+ class Foreman::Thor
2
+ module Actions
3
+ # Creates an empty directory.
4
+ #
5
+ # ==== Parameters
6
+ # destination<String>:: the relative path to the destination root.
7
+ # config<Hash>:: give :verbose => false to not log the status.
8
+ #
9
+ # ==== Examples
10
+ #
11
+ # empty_directory "doc"
12
+ #
13
+ def empty_directory(destination, config = {})
14
+ action EmptyDirectory.new(self, destination, config)
15
+ end
16
+
17
+ # Class which holds create directory logic. This is the base class for
18
+ # other actions like create_file and directory.
19
+ #
20
+ # This implementation is based in Templater actions, created by Jonas Nicklas
21
+ # and Michael S. Klishin under MIT LICENSE.
22
+ #
23
+ class EmptyDirectory #:nodoc:
24
+ attr_reader :base, :destination, :given_destination, :relative_destination, :config
25
+
26
+ # Initializes given the source and destination.
27
+ #
28
+ # ==== Parameters
29
+ # base<Foreman::Thor::Base>:: A Foreman::Thor::Base instance
30
+ # source<String>:: Relative path to the source of this file
31
+ # destination<String>:: Relative path to the destination of this file
32
+ # config<Hash>:: give :verbose => false to not log the status.
33
+ #
34
+ def initialize(base, destination, config = {})
35
+ @base = base
36
+ @config = {:verbose => true}.merge(config)
37
+ self.destination = destination
38
+ end
39
+
40
+ # Checks if the destination file already exists.
41
+ #
42
+ # ==== Returns
43
+ # Boolean:: true if the file exists, false otherwise.
44
+ #
45
+ def exists?
46
+ ::File.exist?(destination)
47
+ end
48
+
49
+ def invoke!
50
+ invoke_with_conflict_check do
51
+ ::FileUtils.mkdir_p(destination)
52
+ end
53
+ end
54
+
55
+ def revoke!
56
+ say_status :remove, :red
57
+ ::FileUtils.rm_rf(destination) if !pretend? && exists?
58
+ given_destination
59
+ end
60
+
61
+ protected
62
+
63
+ # Shortcut for pretend.
64
+ #
65
+ def pretend?
66
+ base.options[:pretend]
67
+ end
68
+
69
+ # Sets the absolute destination value from a relative destination value.
70
+ # It also stores the given and relative destination. Let's suppose our
71
+ # script is being executed on "dest", it sets the destination root to
72
+ # "dest". The destination, given_destination and relative_destination
73
+ # are related in the following way:
74
+ #
75
+ # inside "bar" do
76
+ # empty_directory "baz"
77
+ # end
78
+ #
79
+ # destination #=> dest/bar/baz
80
+ # relative_destination #=> bar/baz
81
+ # given_destination #=> baz
82
+ #
83
+ def destination=(destination)
84
+ return unless destination
85
+ @given_destination = convert_encoded_instructions(destination.to_s)
86
+ @destination = ::File.expand_path(@given_destination, base.destination_root)
87
+ @relative_destination = base.relative_to_original_destination_root(@destination)
88
+ end
89
+
90
+ # Filenames in the encoded form are converted. If you have a file:
91
+ #
92
+ # %file_name%.rb
93
+ #
94
+ # It calls #file_name from the base and replaces %-string with the
95
+ # return value (should be String) of #file_name:
96
+ #
97
+ # user.rb
98
+ #
99
+ # The method referenced can be either public or private.
100
+ #
101
+ def convert_encoded_instructions(filename)
102
+ filename.gsub(/%(.*?)%/) do |initial_string|
103
+ method = $1.strip
104
+ base.respond_to?(method, true) ? base.send(method) : initial_string
105
+ end
106
+ end
107
+
108
+ # Receives a hash of options and just execute the block if some
109
+ # conditions are met.
110
+ #
111
+ def invoke_with_conflict_check(&block)
112
+ if exists?
113
+ on_conflict_behavior(&block)
114
+ else
115
+ say_status :create, :green
116
+ yield unless pretend?
117
+ end
118
+
119
+ destination
120
+ end
121
+
122
+ # What to do when the destination file already exists.
123
+ #
124
+ def on_conflict_behavior
125
+ say_status :exist, :blue
126
+ end
127
+
128
+ # Shortcut to say_status shell method.
129
+ #
130
+ def say_status(status, color)
131
+ base.shell.say_status status, relative_destination, color if config[:verbose]
132
+ end
133
+ end
134
+ end
135
+ end
@@ -0,0 +1,327 @@
1
+ require "erb"
2
+ require "open-uri"
3
+
4
+ class Foreman::Thor
5
+ module Actions
6
+ # Copies the file from the relative source to the relative destination. If
7
+ # the destination is not given it's assumed to be equal to the source.
8
+ #
9
+ # ==== Parameters
10
+ # source<String>:: the relative path to the source root.
11
+ # destination<String>:: the relative path to the destination root.
12
+ # config<Hash>:: give :verbose => false to not log the status, and
13
+ # :mode => :preserve, to preserve the file mode from the source.
14
+
15
+ #
16
+ # ==== Examples
17
+ #
18
+ # copy_file "README", "doc/README"
19
+ #
20
+ # copy_file "doc/README"
21
+ #
22
+ def copy_file(source, *args, &block)
23
+ config = args.last.is_a?(Hash) ? args.pop : {}
24
+ destination = args.first || source
25
+ source = File.expand_path(find_in_source_paths(source.to_s))
26
+
27
+ create_file destination, nil, config do
28
+ content = File.binread(source)
29
+ content = yield(content) if block
30
+ content
31
+ end
32
+ if config[:mode] == :preserve
33
+ mode = File.stat(source).mode
34
+ chmod(destination, mode, config)
35
+ end
36
+ end
37
+
38
+ # Links the file from the relative source to the relative destination. If
39
+ # the destination is not given it's assumed to be equal to the source.
40
+ #
41
+ # ==== Parameters
42
+ # source<String>:: the relative path to the source root.
43
+ # destination<String>:: the relative path to the destination root.
44
+ # config<Hash>:: give :verbose => false to not log the status.
45
+ #
46
+ # ==== Examples
47
+ #
48
+ # link_file "README", "doc/README"
49
+ #
50
+ # link_file "doc/README"
51
+ #
52
+ def link_file(source, *args)
53
+ config = args.last.is_a?(Hash) ? args.pop : {}
54
+ destination = args.first || source
55
+ source = File.expand_path(find_in_source_paths(source.to_s))
56
+
57
+ create_link destination, source, config
58
+ end
59
+
60
+ # Gets the content at the given address and places it at the given relative
61
+ # destination. If a block is given instead of destination, the content of
62
+ # the url is yielded and used as location.
63
+ #
64
+ # ==== Parameters
65
+ # source<String>:: the address of the given content.
66
+ # destination<String>:: the relative path to the destination root.
67
+ # config<Hash>:: give :verbose => false to not log the status.
68
+ #
69
+ # ==== Examples
70
+ #
71
+ # get "http://gist.github.com/103208", "doc/README"
72
+ #
73
+ # get "http://gist.github.com/103208" do |content|
74
+ # content.split("\n").first
75
+ # end
76
+ #
77
+ def get(source, *args, &block)
78
+ config = args.last.is_a?(Hash) ? args.pop : {}
79
+ destination = args.first
80
+
81
+ source = File.expand_path(find_in_source_paths(source.to_s)) unless source =~ %r{^https?\://}
82
+ render = open(source) { |input| input.binmode.read }
83
+
84
+ destination ||= if block_given?
85
+ block.arity == 1 ? yield(render) : yield
86
+ else
87
+ File.basename(source)
88
+ end
89
+
90
+ create_file destination, render, config
91
+ end
92
+
93
+ # Gets an ERB template at the relative source, executes it and makes a copy
94
+ # at the relative destination. If the destination is not given it's assumed
95
+ # to be equal to the source removing .tt from the filename.
96
+ #
97
+ # ==== Parameters
98
+ # source<String>:: the relative path to the source root.
99
+ # destination<String>:: the relative path to the destination root.
100
+ # config<Hash>:: give :verbose => false to not log the status.
101
+ #
102
+ # ==== Examples
103
+ #
104
+ # template "README", "doc/README"
105
+ #
106
+ # template "doc/README"
107
+ #
108
+ def template(source, *args, &block)
109
+ config = args.last.is_a?(Hash) ? args.pop : {}
110
+ destination = args.first || source.sub(/#{TEMPLATE_EXTNAME}$/, "")
111
+
112
+ source = File.expand_path(find_in_source_paths(source.to_s))
113
+ context = config.delete(:context) || instance_eval("binding")
114
+
115
+ create_file destination, nil, config do
116
+ content = CapturableERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
117
+ content = yield(content) if block
118
+ content
119
+ end
120
+ end
121
+
122
+ # Changes the mode of the given file or directory.
123
+ #
124
+ # ==== Parameters
125
+ # mode<Integer>:: the file mode
126
+ # path<String>:: the name of the file to change mode
127
+ # config<Hash>:: give :verbose => false to not log the status.
128
+ #
129
+ # ==== Example
130
+ #
131
+ # chmod "script/server", 0755
132
+ #
133
+ def chmod(path, mode, config = {})
134
+ return unless behavior == :invoke
135
+ path = File.expand_path(path, destination_root)
136
+ say_status :chmod, relative_to_original_destination_root(path), config.fetch(:verbose, true)
137
+ FileUtils.chmod_R(mode, path) unless options[:pretend]
138
+ end
139
+
140
+ # Prepend text to a file. Since it depends on insert_into_file, it's reversible.
141
+ #
142
+ # ==== Parameters
143
+ # path<String>:: path of the file to be changed
144
+ # data<String>:: the data to prepend to the file, can be also given as a block.
145
+ # config<Hash>:: give :verbose => false to not log the status.
146
+ #
147
+ # ==== Example
148
+ #
149
+ # prepend_to_file 'config/environments/test.rb', 'config.gem "rspec"'
150
+ #
151
+ # prepend_to_file 'config/environments/test.rb' do
152
+ # 'config.gem "rspec"'
153
+ # end
154
+ #
155
+ def prepend_to_file(path, *args, &block)
156
+ config = args.last.is_a?(Hash) ? args.pop : {}
157
+ config[:after] = /\A/
158
+ insert_into_file(path, *(args << config), &block)
159
+ end
160
+ alias_method :prepend_file, :prepend_to_file
161
+
162
+ # Append text to a file. Since it depends on insert_into_file, it's reversible.
163
+ #
164
+ # ==== Parameters
165
+ # path<String>:: path of the file to be changed
166
+ # data<String>:: the data to append to the file, can be also given as a block.
167
+ # config<Hash>:: give :verbose => false to not log the status.
168
+ #
169
+ # ==== Example
170
+ #
171
+ # append_to_file 'config/environments/test.rb', 'config.gem "rspec"'
172
+ #
173
+ # append_to_file 'config/environments/test.rb' do
174
+ # 'config.gem "rspec"'
175
+ # end
176
+ #
177
+ def append_to_file(path, *args, &block)
178
+ config = args.last.is_a?(Hash) ? args.pop : {}
179
+ config[:before] = /\z/
180
+ insert_into_file(path, *(args << config), &block)
181
+ end
182
+ alias_method :append_file, :append_to_file
183
+
184
+ # Injects text right after the class definition. Since it depends on
185
+ # insert_into_file, it's reversible.
186
+ #
187
+ # ==== Parameters
188
+ # path<String>:: path of the file to be changed
189
+ # klass<String|Class>:: the class to be manipulated
190
+ # data<String>:: the data to append to the class, can be also given as a block.
191
+ # config<Hash>:: give :verbose => false to not log the status.
192
+ #
193
+ # ==== Examples
194
+ #
195
+ # inject_into_class "app/controllers/application_controller.rb", ApplicationController, " filter_parameter :password\n"
196
+ #
197
+ # inject_into_class "app/controllers/application_controller.rb", ApplicationController do
198
+ # " filter_parameter :password\n"
199
+ # end
200
+ #
201
+ def inject_into_class(path, klass, *args, &block)
202
+ config = args.last.is_a?(Hash) ? args.pop : {}
203
+ config[:after] = /class #{klass}\n|class #{klass} .*\n/
204
+ insert_into_file(path, *(args << config), &block)
205
+ end
206
+
207
+ # Run a regular expression replacement on a file.
208
+ #
209
+ # ==== Parameters
210
+ # path<String>:: path of the file to be changed
211
+ # flag<Regexp|String>:: the regexp or string to be replaced
212
+ # replacement<String>:: the replacement, can be also given as a block
213
+ # config<Hash>:: give :verbose => false to not log the status.
214
+ #
215
+ # ==== Example
216
+ #
217
+ # gsub_file 'app/controllers/application_controller.rb', /#\s*(filter_parameter_logging :password)/, '\1'
218
+ #
219
+ # gsub_file 'README', /rake/, :green do |match|
220
+ # match << " no more. Use thor!"
221
+ # end
222
+ #
223
+ def gsub_file(path, flag, *args, &block)
224
+ return unless behavior == :invoke
225
+ config = args.last.is_a?(Hash) ? args.pop : {}
226
+
227
+ path = File.expand_path(path, destination_root)
228
+ say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true)
229
+
230
+ unless options[:pretend]
231
+ content = File.binread(path)
232
+ content.gsub!(flag, *args, &block)
233
+ File.open(path, "wb") { |file| file.write(content) }
234
+ end
235
+ end
236
+
237
+ # Uncomment all lines matching a given regex. It will leave the space
238
+ # which existed before the comment hash in tact but will remove any spacing
239
+ # between the comment hash and the beginning of the line.
240
+ #
241
+ # ==== Parameters
242
+ # path<String>:: path of the file to be changed
243
+ # flag<Regexp|String>:: the regexp or string used to decide which lines to uncomment
244
+ # config<Hash>:: give :verbose => false to not log the status.
245
+ #
246
+ # ==== Example
247
+ #
248
+ # uncomment_lines 'config/initializers/session_store.rb', /active_record/
249
+ #
250
+ def uncomment_lines(path, flag, *args)
251
+ flag = flag.respond_to?(:source) ? flag.source : flag
252
+
253
+ gsub_file(path, /^(\s*)#[[:blank:]]*(.*#{flag})/, '\1\2', *args)
254
+ end
255
+
256
+ # Comment all lines matching a given regex. It will leave the space
257
+ # which existed before the beginning of the line in tact and will insert
258
+ # a single space after the comment hash.
259
+ #
260
+ # ==== Parameters
261
+ # path<String>:: path of the file to be changed
262
+ # flag<Regexp|String>:: the regexp or string used to decide which lines to comment
263
+ # config<Hash>:: give :verbose => false to not log the status.
264
+ #
265
+ # ==== Example
266
+ #
267
+ # comment_lines 'config/initializers/session_store.rb', /cookie_store/
268
+ #
269
+ def comment_lines(path, flag, *args)
270
+ flag = flag.respond_to?(:source) ? flag.source : flag
271
+
272
+ gsub_file(path, /^(\s*)([^#|\n]*#{flag})/, '\1# \2', *args)
273
+ end
274
+
275
+ # Removes a file at the given location.
276
+ #
277
+ # ==== Parameters
278
+ # path<String>:: path of the file to be changed
279
+ # config<Hash>:: give :verbose => false to not log the status.
280
+ #
281
+ # ==== Example
282
+ #
283
+ # remove_file 'README'
284
+ # remove_file 'app/controllers/application_controller.rb'
285
+ #
286
+ def remove_file(path, config = {})
287
+ return unless behavior == :invoke
288
+ path = File.expand_path(path, destination_root)
289
+
290
+ say_status :remove, relative_to_original_destination_root(path), config.fetch(:verbose, true)
291
+ ::FileUtils.rm_rf(path) if !options[:pretend] && File.exist?(path)
292
+ end
293
+ alias_method :remove_dir, :remove_file
294
+
295
+ attr_accessor :output_buffer
296
+ private :output_buffer, :output_buffer=
297
+
298
+ private
299
+
300
+ def concat(string)
301
+ @output_buffer.concat(string)
302
+ end
303
+
304
+ def capture(*args)
305
+ with_output_buffer { yield(*args) }
306
+ end
307
+
308
+ def with_output_buffer(buf = "") #:nodoc:
309
+ self.output_buffer, old_buffer = buf, output_buffer
310
+ yield
311
+ output_buffer
312
+ ensure
313
+ self.output_buffer = old_buffer
314
+ end
315
+
316
+ # Foreman::Thor::Actions#capture depends on what kind of buffer is used in ERB.
317
+ # Thus CapturableERB fixes ERB to use String buffer.
318
+ class CapturableERB < ERB
319
+ def set_eoutvar(compiler, eoutvar = "_erbout")
320
+ compiler.put_cmd = "#{eoutvar}.concat"
321
+ compiler.insert_cmd = "#{eoutvar}.concat"
322
+ compiler.pre_cmd = ["#{eoutvar} = ''"]
323
+ compiler.post_cmd = [eoutvar]
324
+ end
325
+ end
326
+ end
327
+ end
@@ -0,0 +1,103 @@
1
+ require "foreman/vendor/thor/lib/thor/actions/empty_directory"
2
+
3
+ class Foreman::Thor
4
+ module Actions
5
+ # Injects the given content into a file. Different from gsub_file, this
6
+ # method is reversible.
7
+ #
8
+ # ==== Parameters
9
+ # destination<String>:: Relative path to the destination root
10
+ # data<String>:: Data to add to the file. Can be given as a block.
11
+ # config<Hash>:: give :verbose => false to not log the status and the flag
12
+ # for injection (:after or :before) or :force => true for
13
+ # insert two or more times the same content.
14
+ #
15
+ # ==== Examples
16
+ #
17
+ # insert_into_file "config/environment.rb", "config.gem :thor", :after => "Rails::Initializer.run do |config|\n"
18
+ #
19
+ # insert_into_file "config/environment.rb", :after => "Rails::Initializer.run do |config|\n" do
20
+ # gems = ask "Which gems would you like to add?"
21
+ # gems.split(" ").map{ |gem| " config.gem :#{gem}" }.join("\n")
22
+ # end
23
+ #
24
+ def insert_into_file(destination, *args, &block)
25
+ data = block_given? ? block : args.shift
26
+ config = args.shift
27
+ action InjectIntoFile.new(self, destination, data, config)
28
+ end
29
+ alias_method :inject_into_file, :insert_into_file
30
+
31
+ class InjectIntoFile < EmptyDirectory #:nodoc:
32
+ attr_reader :replacement, :flag, :behavior
33
+
34
+ def initialize(base, destination, data, config)
35
+ super(base, destination, {:verbose => true}.merge(config))
36
+
37
+ @behavior, @flag = if @config.key?(:after)
38
+ [:after, @config.delete(:after)]
39
+ else
40
+ [:before, @config.delete(:before)]
41
+ end
42
+
43
+ @replacement = data.is_a?(Proc) ? data.call : data
44
+ @flag = Regexp.escape(@flag) unless @flag.is_a?(Regexp)
45
+ end
46
+
47
+ def invoke!
48
+ say_status :invoke
49
+
50
+ content = if @behavior == :after
51
+ '\0' + replacement
52
+ else
53
+ replacement + '\0'
54
+ end
55
+
56
+ replace!(/#{flag}/, content, config[:force])
57
+ end
58
+
59
+ def revoke!
60
+ say_status :revoke
61
+
62
+ regexp = if @behavior == :after
63
+ content = '\1\2'
64
+ /(#{flag})(.*)(#{Regexp.escape(replacement)})/m
65
+ else
66
+ content = '\2\3'
67
+ /(#{Regexp.escape(replacement)})(.*)(#{flag})/m
68
+ end
69
+
70
+ replace!(regexp, content, true)
71
+ end
72
+
73
+ protected
74
+
75
+ def say_status(behavior)
76
+ status = if behavior == :invoke
77
+ if flag == /\A/
78
+ :prepend
79
+ elsif flag == /\z/
80
+ :append
81
+ else
82
+ :insert
83
+ end
84
+ else
85
+ :subtract
86
+ end
87
+
88
+ super(status, config[:verbose])
89
+ end
90
+
91
+ # Adds the content to the file.
92
+ #
93
+ def replace!(regexp, string, force)
94
+ return if base.options[:pretend]
95
+ content = File.binread(destination)
96
+ if force || !content.include?(replacement)
97
+ content.gsub!(regexp, string)
98
+ File.open(destination, "wb") { |file| file.write(content) }
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end