isono 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (43) hide show
  1. data/LICENSE +202 -0
  2. data/NOTICE +2 -0
  3. data/bin/cli +122 -0
  4. data/isono.gemspec +47 -0
  5. data/lib/ext/shellwords.rb +172 -0
  6. data/lib/isono.rb +61 -0
  7. data/lib/isono/amqp_client.rb +169 -0
  8. data/lib/isono/daemonize.rb +96 -0
  9. data/lib/isono/event_delegate_context.rb +56 -0
  10. data/lib/isono/event_observable.rb +86 -0
  11. data/lib/isono/logger.rb +48 -0
  12. data/lib/isono/manifest.rb +161 -0
  13. data/lib/isono/messaging_client.rb +116 -0
  14. data/lib/isono/models/event_log.rb +28 -0
  15. data/lib/isono/models/job_state.rb +35 -0
  16. data/lib/isono/models/node_state.rb +70 -0
  17. data/lib/isono/models/resource_instance.rb +35 -0
  18. data/lib/isono/node.rb +158 -0
  19. data/lib/isono/node_modules/base.rb +65 -0
  20. data/lib/isono/node_modules/data_store.rb +57 -0
  21. data/lib/isono/node_modules/event_channel.rb +72 -0
  22. data/lib/isono/node_modules/event_logger.rb +39 -0
  23. data/lib/isono/node_modules/job_channel.rb +86 -0
  24. data/lib/isono/node_modules/job_collector.rb +47 -0
  25. data/lib/isono/node_modules/job_worker.rb +152 -0
  26. data/lib/isono/node_modules/node_collector.rb +87 -0
  27. data/lib/isono/node_modules/node_heartbeat.rb +26 -0
  28. data/lib/isono/node_modules/rpc_channel.rb +482 -0
  29. data/lib/isono/rack.rb +67 -0
  30. data/lib/isono/rack/builder.rb +40 -0
  31. data/lib/isono/rack/data_store.rb +20 -0
  32. data/lib/isono/rack/job.rb +74 -0
  33. data/lib/isono/rack/map.rb +56 -0
  34. data/lib/isono/rack/object_method.rb +20 -0
  35. data/lib/isono/rack/proc.rb +50 -0
  36. data/lib/isono/rack/thread_pass.rb +22 -0
  37. data/lib/isono/resource_manifest.rb +273 -0
  38. data/lib/isono/runner/agent.rb +89 -0
  39. data/lib/isono/runner/rpc_server.rb +198 -0
  40. data/lib/isono/serializer.rb +43 -0
  41. data/lib/isono/thread_pool.rb +169 -0
  42. data/lib/isono/util.rb +212 -0
  43. metadata +185 -0
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ Copyright (c) 2010 axsh Ltd.
2
+ Copyright (c) 2010 Masahiro Fujiwara
data/bin/cli ADDED
@@ -0,0 +1,122 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ begin
4
+ require 'rubygems'
5
+ require 'isono'
6
+ rescue LoadError => e
7
+ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
8
+ require 'isono'
9
+ end
10
+
11
+ require 'optparse'
12
+
13
+ common = {:amqp_server_uri=>'amqp://localhost/'}
14
+
15
+ parser = OptionParser.new { |opt|
16
+ }
17
+
18
+ args = ARGV.dup
19
+
20
+ parser.order!(args)
21
+ subcommand = args.shift
22
+
23
+ class CommandRequest
24
+ attr_accessor :namespace, :command, :opts
25
+ attr_accessor :print_proc
26
+
27
+ def initialize(&blk)
28
+ @opts = {}
29
+ instance_eval &blk if blk
30
+ end
31
+
32
+ def print_proc(&blk)
33
+ @print_proc = blk if blk
34
+ @print_proc
35
+ end
36
+ end
37
+
38
+
39
+ class EventRequest
40
+ end
41
+
42
+ case subcommand
43
+ when 'load_resource'
44
+ request = CommandRequest.new { |c|
45
+ c.namespace = 'resource_locator'
46
+ c.command = 'install'
47
+ OptionParser.new { |opt|
48
+ opt.on("-y FILE") { |path|
49
+ require 'yaml'
50
+ c.opts[:instance_data] = YAML.load(path)
51
+ }
52
+ opt.on("-e STR") { |buf|
53
+
54
+ p c.opts[:instance_data] = eval(buf)
55
+ }
56
+ }.parse!(args)
57
+
58
+ c.opts[:resource_name] = args.shift || abort("missing resource_name")
59
+ c.opts[:agent_id] = args.shift || abort("missing agent_id")
60
+ }
61
+ when 'unload_resource'
62
+ request = CommandRequest.new { |c|
63
+ c.namespace = 'resource_locator'
64
+ c.command = 'uninstall'
65
+ c.opts[:resource_id] = args.shift
66
+ }
67
+ when 'show_resource'
68
+ request = CommandRequest.new { |c|
69
+ c.namespace = 'resource_locator'
70
+ c.command = 'list_instances'
71
+ c.print_proc { |res|
72
+ p res
73
+ }
74
+ }
75
+ when 'show_agents'
76
+ request = CommandRequest.new { |c|
77
+ c.namespace = 'agent_collector'
78
+ c.command = 'list'
79
+ c.print_proc { |res|
80
+ p res
81
+ }
82
+ }
83
+ else
84
+ abort("unknown command: #{subcommand}")
85
+ end
86
+
87
+
88
+ require 'eventmachine'
89
+
90
+ EM.run {
91
+ cc = Isono::MessagingClient.new
92
+ cc.connect(common[:amqp_server_uri]) {
93
+
94
+ case request
95
+ when CommandRequest
96
+ cc.async_command(request.namespace,
97
+ request.command,
98
+ request.opts) { |req|
99
+ req.timeout_sec = 5.0
100
+
101
+ req.on_success { |res|
102
+ request.print_proc.call(res) if request.print_proc
103
+
104
+ cc.close { EM.stop }
105
+ }
106
+ req.on_error { |res|
107
+ case res
108
+ when :timeout
109
+ STDERR.puts "request timedout"
110
+ end
111
+ cc.close { EM.stop; exit 1; }
112
+ }
113
+ }
114
+ when EventRequest
115
+ cc.send_event(event)
116
+ EM.next_tick {
117
+ cc.close { EM.stop }
118
+ }
119
+ end
120
+
121
+ }
122
+ }
@@ -0,0 +1,47 @@
1
+ # -*- encoding: utf-8 -*-
2
+
3
+ Gem::Specification.new do |s|
4
+ s.name = %q{isono}
5
+ s.version = "0.1.0"
6
+
7
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
8
+ s.authors = ["axsh Ltd.", "Masahiro Fujiwara"]
9
+ s.date = %q{2010-11-18}
10
+ s.default_executable = %q{cli}
11
+ s.email = ["dev@axsh.net", "m-fujiwara@axsh.net"]
12
+ s.executables = ["cli"]
13
+ s.files = ["bin/cli", "lib/ext/shellwords.rb", "lib/isono.rb", "lib/isono/rack/object_method.rb", "lib/isono/rack/proc.rb", "lib/isono/rack/data_store.rb", "lib/isono/rack/map.rb", "lib/isono/rack/job.rb", "lib/isono/rack/builder.rb", "lib/isono/rack/thread_pass.rb", "lib/isono/logger.rb", "lib/isono/rack.rb", "lib/isono/messaging_client.rb", "lib/isono/resource_manifest.rb", "lib/isono/node.rb", "lib/isono/manifest.rb", "lib/isono/event_delegate_context.rb", "lib/isono/amqp_client.rb", "lib/isono/node_modules/job_channel.rb", "lib/isono/node_modules/base.rb", "lib/isono/node_modules/event_logger.rb", "lib/isono/node_modules/event_channel.rb", "lib/isono/node_modules/node_heartbeat.rb", "lib/isono/node_modules/node_collector.rb", "lib/isono/node_modules/data_store.rb", "lib/isono/node_modules/job_collector.rb", "lib/isono/node_modules/rpc_channel.rb", "lib/isono/node_modules/job_worker.rb", "lib/isono/serializer.rb", "lib/isono/models/node_state.rb", "lib/isono/models/resource_instance.rb", "lib/isono/models/event_log.rb", "lib/isono/models/job_state.rb", "lib/isono/daemonize.rb", "lib/isono/util.rb", "lib/isono/thread_pool.rb", "lib/isono/runner/rpc_server.rb", "lib/isono/runner/agent.rb", "lib/isono/event_observable.rb", "isono.gemspec", "LICENSE", "NOTICE"]
14
+ s.homepage = %q{http://github.com/axsh/isono}
15
+ s.require_paths = ["lib"]
16
+ s.required_ruby_version = Gem::Requirement.new(">= 1.8.7")
17
+ s.rubygems_version = %q{1.3.6}
18
+ s.summary = %q{Messageing and agent fabric}
19
+
20
+ if s.respond_to? :specification_version then
21
+ current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
22
+ s.specification_version = 3
23
+
24
+ if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
25
+ s.add_runtime_dependency(%q<amqp>, [">= 0.6.7"])
26
+ s.add_runtime_dependency(%q<eventmachine>, [">= 0.12.10"])
27
+ s.add_runtime_dependency(%q<statemachine>, [">= 1.0.0"])
28
+ s.add_runtime_dependency(%q<log4r>, [">= 0"])
29
+ s.add_development_dependency(%q<bacon>, [">= 0"])
30
+ s.add_development_dependency(%q<rake>, [">= 0"])
31
+ else
32
+ s.add_dependency(%q<amqp>, [">= 0.6.7"])
33
+ s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
34
+ s.add_dependency(%q<statemachine>, [">= 1.0.0"])
35
+ s.add_dependency(%q<log4r>, [">= 0"])
36
+ s.add_dependency(%q<bacon>, [">= 0"])
37
+ s.add_dependency(%q<rake>, [">= 0"])
38
+ end
39
+ else
40
+ s.add_dependency(%q<amqp>, [">= 0.6.7"])
41
+ s.add_dependency(%q<eventmachine>, [">= 0.12.10"])
42
+ s.add_dependency(%q<statemachine>, [">= 1.0.0"])
43
+ s.add_dependency(%q<log4r>, [">= 0"])
44
+ s.add_dependency(%q<bacon>, [">= 0"])
45
+ s.add_dependency(%q<rake>, [">= 0"])
46
+ end
47
+ end
@@ -0,0 +1,172 @@
1
+ #
2
+ # shellwords.rb: Manipulates strings a la UNIX Bourne shell
3
+ #
4
+
5
+ #
6
+ # This module manipulates strings according to the word parsing rules
7
+ # of the UNIX Bourne shell.
8
+ #
9
+ # The shellwords() function was originally a port of shellwords.pl,
10
+ # but modified to conform to POSIX / SUSv3 (IEEE Std 1003.1-2001).
11
+ #
12
+ # Authors:
13
+ # - Wakou Aoyama
14
+ # - Akinori MUSHA <knu@iDaemons.org>
15
+ #
16
+ # Contact:
17
+ # - Akinori MUSHA <knu@iDaemons.org> (current maintainer)
18
+ #
19
+ module Shellwords
20
+ #
21
+ # Splits a string into an array of tokens in the same way the UNIX
22
+ # Bourne shell does.
23
+ #
24
+ # argv = Shellwords.split('here are "two words"')
25
+ # argv #=> ["here", "are", "two words"]
26
+ #
27
+ # +String#shellsplit+ is a shorthand for this function.
28
+ #
29
+ # argv = 'here are "two words"'.shellsplit
30
+ # argv #=> ["here", "are", "two words"]
31
+ #
32
+ def shellsplit(line)
33
+ line = String.new(line) rescue
34
+ raise(ArgumentError, "Argument must be a string")
35
+ line.lstrip!
36
+ words = []
37
+ until line.empty?
38
+ field = ''
39
+ loop do
40
+ if line.sub!(/\A"(([^"\\]|\\.)*)"/, '') then
41
+ snippet = $1.gsub(/\\(.)/, '\1')
42
+ elsif line =~ /\A"/ then
43
+ raise ArgumentError, "Unmatched double quote: #{line}"
44
+ elsif line.sub!(/\A'([^']*)'/, '') then
45
+ snippet = $1
46
+ elsif line =~ /\A'/ then
47
+ raise ArgumentError, "Unmatched single quote: #{line}"
48
+ elsif line.sub!(/\A\\(.)?/, '') then
49
+ snippet = $1 || '\\'
50
+ elsif line.sub!(/\A([^\s\\'"]+)/, '') then
51
+ snippet = $1
52
+ else
53
+ line.lstrip!
54
+ break
55
+ end
56
+ field.concat(snippet)
57
+ end
58
+ words.push(field)
59
+ end
60
+ words
61
+ end
62
+
63
+ alias shellwords shellsplit
64
+
65
+ module_function :shellsplit, :shellwords
66
+
67
+ class << self
68
+ alias split shellsplit
69
+ end
70
+
71
+ #
72
+ # Escapes a string so that it can be safely used in a Bourne shell
73
+ # command line.
74
+ #
75
+ # Note that a resulted string should be used unquoted and is not
76
+ # intended for use in double quotes nor in single quotes.
77
+ #
78
+ # open("| grep #{Shellwords.escape(pattern)} file") { |pipe|
79
+ # # ...
80
+ # }
81
+ #
82
+ # +String#shellescape+ is a shorthand for this function.
83
+ #
84
+ # open("| grep #{pattern.shellescape} file") { |pipe|
85
+ # # ...
86
+ # }
87
+ #
88
+ def shellescape(str)
89
+ # An empty argument will be skipped, so return empty quotes.
90
+ return "''" if str.empty?
91
+
92
+ str = str.dup
93
+
94
+ # Process as a single byte sequence because not all shell
95
+ # implementations are multibyte aware.
96
+ str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")
97
+
98
+ # A LF cannot be escaped with a backslash because a backslash + LF
99
+ # combo is regarded as line continuation and simply ignored.
100
+ str.gsub!(/\n/, "'\n'")
101
+
102
+ return str
103
+ end
104
+
105
+ module_function :shellescape
106
+
107
+ class << self
108
+ alias escape shellescape
109
+ end
110
+
111
+ #
112
+ # Builds a command line string from an argument list +array+ joining
113
+ # all elements escaped for Bourne shell and separated by a space.
114
+ #
115
+ # open('|' + Shellwords.join(['grep', pattern, *files])) { |pipe|
116
+ # # ...
117
+ # }
118
+ #
119
+ # +Array#shelljoin+ is a shorthand for this function.
120
+ #
121
+ # open('|' + ['grep', pattern, *files].shelljoin) { |pipe|
122
+ # # ...
123
+ # }
124
+ #
125
+ def shelljoin(array)
126
+ array.map { |arg| shellescape(arg) }.join(' ')
127
+ end
128
+
129
+ module_function :shelljoin
130
+
131
+ class << self
132
+ alias join shelljoin
133
+ end
134
+ end
135
+
136
+ class String
137
+ #
138
+ # call-seq:
139
+ # str.shellsplit => array
140
+ #
141
+ # Splits +str+ into an array of tokens in the same way the UNIX
142
+ # Bourne shell does. See +Shellwords::shellsplit+ for details.
143
+ #
144
+ def shellsplit
145
+ Shellwords.split(self)
146
+ end
147
+
148
+ #
149
+ # call-seq:
150
+ # str.shellescape => string
151
+ #
152
+ # Escapes +str+ so that it can be safely used in a Bourne shell
153
+ # command line. See +Shellwords::shellescape+ for details.
154
+ #
155
+ def shellescape
156
+ Shellwords.escape(self)
157
+ end
158
+ end
159
+
160
+ class Array
161
+ #
162
+ # call-seq:
163
+ # array.shelljoin => string
164
+ #
165
+ # Builds a command line string from an argument list +array+ joining
166
+ # all elements escaped for Bourne shell and separated by a space.
167
+ # See +Shellwords::shelljoin+ for details.
168
+ #
169
+ def shelljoin
170
+ Shellwords.join(self)
171
+ end
172
+ end