poise-javascript 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +11 -0
  3. data/.kitchen.travis.yml +9 -0
  4. data/.kitchen.yml +8 -0
  5. data/.travis.yml +21 -0
  6. data/.yardopts +7 -0
  7. data/Berksfile +28 -0
  8. data/CHANGELOG.md +6 -0
  9. data/Gemfile +33 -0
  10. data/LICENSE +201 -0
  11. data/README.md +332 -0
  12. data/Rakefile +17 -0
  13. data/chef/attributes/default.rb +23 -0
  14. data/chef/recipes/default.rb +19 -0
  15. data/lib/poise_javascript.rb +24 -0
  16. data/lib/poise_javascript/cheftie.rb +18 -0
  17. data/lib/poise_javascript/error.rb +23 -0
  18. data/lib/poise_javascript/javascript_command_mixin.rb +56 -0
  19. data/lib/poise_javascript/javascript_providers.rb +40 -0
  20. data/lib/poise_javascript/javascript_providers/base.rb +97 -0
  21. data/lib/poise_javascript/javascript_providers/dummy.rb +77 -0
  22. data/lib/poise_javascript/javascript_providers/iojs.rb +64 -0
  23. data/lib/poise_javascript/javascript_providers/nodejs.rb +64 -0
  24. data/lib/poise_javascript/javascript_providers/scl.rb +79 -0
  25. data/lib/poise_javascript/javascript_providers/system.rb +71 -0
  26. data/lib/poise_javascript/resources.rb +29 -0
  27. data/lib/poise_javascript/resources/javascript_execute.rb +83 -0
  28. data/lib/poise_javascript/resources/javascript_runtime.rb +85 -0
  29. data/lib/poise_javascript/resources/javascript_runtime_test.rb +226 -0
  30. data/lib/poise_javascript/resources/node_package.rb +254 -0
  31. data/lib/poise_javascript/resources/npm_install.rb +94 -0
  32. data/lib/poise_javascript/version.rb +20 -0
  33. data/poise-javascript.gemspec +41 -0
  34. data/test/cookbooks/poise-javascript_test/metadata.rb +18 -0
  35. data/test/cookbooks/poise-javascript_test/recipes/default.rb +49 -0
  36. data/test/gemfiles/chef-12.gemfile +19 -0
  37. data/test/gemfiles/master.gemfile +23 -0
  38. data/test/integration/default/serverspec/default_spec.rb +107 -0
  39. data/test/spec/javascript_command_mixin_spec.rb +59 -0
  40. data/test/spec/javascript_providers/base_spec.rb +89 -0
  41. data/test/spec/javascript_providers/dummy_spec.rb +62 -0
  42. data/test/spec/javascript_providers/iojs_spec.rb +77 -0
  43. data/test/spec/javascript_providers/nodejs_spec.rb +82 -0
  44. data/test/spec/javascript_providers/scl_spec.rb +68 -0
  45. data/test/spec/javascript_providers/system_spec.rb +73 -0
  46. data/test/spec/resources/javascript_execute_spec.rb +67 -0
  47. data/test/spec/resources/node_package_spec.rb +324 -0
  48. data/test/spec/resources/npm_install_spec.rb +118 -0
  49. data/test/spec/spec_helper.rb +19 -0
  50. metadata +169 -0
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 87ed0bbec54b3c7681900b503feeadeebfac334c
4
+ data.tar.gz: 7b6f67bb74c9b4572c90637dd69b57bda048d6a2
5
+ SHA512:
6
+ metadata.gz: ebcddb3fc2e318faa0602a3ce0e1d55c48677179905de3b49d82a86d0687569baa6668f8d92756a58146018a990b907cfb2b070fc8d532f8cc65d219dd9561c4
7
+ data.tar.gz: e02421d4911426ff63a825a79fe000a1c99910cbed48c3f348e358888b28f6650b99aeec02b9a43ad0889ef37f274d0a7b220f8207d07ee098d3c0140e4a2a42
@@ -0,0 +1,11 @@
1
+ Berksfile.lock
2
+ Gemfile.lock
3
+ test/gemfiles/*.lock
4
+ .kitchen/
5
+ .kitchen.local.yml
6
+ test/docker/
7
+ coverage/
8
+ pkg/
9
+ .yardoc/
10
+ doc/
11
+
@@ -0,0 +1,9 @@
1
+ ---
2
+ driver:
3
+ name: docker
4
+ binary: "./docker"
5
+ socket: tcp://docker.poise.io:443
6
+ tls_verify: true
7
+ tls_cacert: test/docker/docker.ca
8
+ tls_cert: test/docker/docker.pem
9
+ tls_key: test/docker/docker.key
@@ -0,0 +1,8 @@
1
+ ---
2
+ #<% require 'poise_boiler' %>
3
+ <%= PoiseBoiler.kitchen(platforms: 'linux') %>
4
+
5
+ suites:
6
+ - name: default
7
+ run_list:
8
+ - recipe[poise-javascript_test]
@@ -0,0 +1,21 @@
1
+ ---
2
+ sudo: false
3
+ cache: bundler
4
+ language: ruby
5
+ rvm:
6
+ - '2.2'
7
+ addons:
8
+ apt:
9
+ packages:
10
+ - libgecode-dev
11
+ env:
12
+ global:
13
+ - USE_SYSTEM_GECODE=true
14
+ - KITCHEN_LOCAL_YAML=.kitchen.travis.yml
15
+ - secure: NDa++p5J73q5JjH25x8p1IJiCZXHPq4kd2n/ChAHrda+va/+d5cxtIHUDAFtfKJAeIr9W2yAjCm/VBsncZbxAbQai1y6zF9hU/aoWOyYxFWJkB65Off5WiYnWYB9gzDteHzAcXcsLds3KOse4MQPkxmdh0Q9bmK/I/IaPojjajP2bwAYmSIjj4jKLIGKS6VWx1MlyZk2ZHY0x++MChz6D/jTPeQDZgm8ubZIP+I+BoAl7VSZ+5ZhfpGcxE8zEC1iofbyT7JAKQC0FD3u/zHrZzFeqRSXw7Yt+TmdPNr5yzZZyOhez0BVpkDAxPbhZpxcIi4qVeiZ05yS8eu9auLZ7bP05CG3VOWZpGPpzTAh1Z60o0ysGbtSbHuexUR6bxztSvUdEGSgrEhNvPjZvfDdWH/zrVFQxo39t8hvX9n3KmInDw6WKcS0Q7yZPekZK0R+4HrpGvG+QQZkbWvWPX0JPyzT17Az+1kGWfmsFI/XJby9hYvPiiYX6WOhI8Kls4BrFCCKIScW3OE0SIO5JasJ+SeqFGifCppEeuKsJ8bK61l1iurTTYoIl8e69E5Sn2yXa5rfMuKDvRyzGPQFWKw8o+saGeh5A+HOufBM6Bm85XwtAuRq2o9KloSqYhITnfWoj6xWckUuOrCSKsJrtl5QkuG45uaImPv11wiPwz4Sag0=
16
+ bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
17
+ script:
18
+ - "./bin/rake travis"
19
+ gemfile:
20
+ - test/gemfiles/chef-12.gemfile
21
+ - test/gemfiles/master.gemfile
@@ -0,0 +1,7 @@
1
+ --plugin classmethods
2
+ --embed-mixin ClassMethods
3
+ --hide-api private
4
+ --markup markdown
5
+ --hide-void-return
6
+ --tag provides:Provides
7
+ --tag action:Actions
@@ -0,0 +1,28 @@
1
+ #
2
+ # Copyright 2015, Noah Kantrowitz
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+
17
+ source 'https://supermarket.chef.io/'
18
+ extension 'halite'
19
+
20
+ # Force the rebuild every time for development.
21
+ cookbook 'poise', gem: 'poise'
22
+ cookbook 'poise-languages', gem: 'poise-languages'
23
+ cookbook 'poise-javascript', gem: 'poise-javascript'
24
+
25
+ group :test do
26
+ cookbook 'poise-javascript_test', path: 'test/cookbooks/poise-javascript_test'
27
+ cookbook 'apt'
28
+ end
@@ -0,0 +1,6 @@
1
+ # Poise-Javascript Changelog
2
+
3
+ ## v1.0.0
4
+
5
+ * Initial release!
6
+
data/Gemfile ADDED
@@ -0,0 +1,33 @@
1
+ #
2
+ # Copyright 2015, Noah Kantrowitz
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+
17
+ source 'https://rubygems.org/'
18
+
19
+ gemspec path: File.expand_path('..', __FILE__)
20
+
21
+ def dev_gem(name, path: File.join('..', name), github: nil)
22
+ path = File.expand_path(File.join('..', path), __FILE__)
23
+ if File.exist?(path)
24
+ gem name, path: path
25
+ elsif github
26
+ gem name, github: github
27
+ end
28
+ end
29
+
30
+ dev_gem 'halite'
31
+ dev_gem 'poise'
32
+ dev_gem 'poise-boiler'
33
+ dev_gem 'poise-languages'
data/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,332 @@
1
+ # Poise-Javascript Cookbook
2
+
3
+ [![Build Status](https://img.shields.io/travis/poise/poise-javascript.svg)](https://travis-ci.org/poise/poise-javascript)
4
+ [![Gem Version](https://img.shields.io/gem/v/poise-javascript.svg)](https://rubygems.org/gems/poise-javascript)
5
+ [![Cookbook Version](https://img.shields.io/cookbook/v/poise-javascript.svg)](https://supermarket.chef.io/cookbooks/poise-javascript)
6
+ [![Coverage](https://img.shields.io/codecov/c/github/poise/poise-javascript.svg)](https://codecov.io/github/poise/poise-javascript)
7
+ [![Gemnasium](https://img.shields.io/gemnasium/poise/poise-javascript.svg)](https://gemnasium.com/poise/poise-javascript)
8
+ [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
9
+
10
+ A [Chef](https://www.chef.io/) cookbook to provide a unified interface for
11
+ installing server-side JavaScript runtimes like Node.js and io.js.
12
+
13
+ ## Quick Start
14
+
15
+ To install the latest available version of Node.js 0.12:
16
+
17
+ ```ruby
18
+ javascript_runtime '0.12'
19
+ ```
20
+
21
+ ## Supported JavaScript Runtimes
22
+
23
+ This cookbook can install Node.js and io.js on Linux and OS X.
24
+
25
+ ## Requirements
26
+
27
+ Chef 12 or newer is required.
28
+
29
+ ## Attributes
30
+
31
+ Attributes are used to configure the default recipe.
32
+
33
+ * `node['poise-javascript']['install_nodejs']` – Install a Node.js runtime. *(default: true)*
34
+ * `node['poise-javascript']['install_iojs']` – Install an io.js runtime. *(default: false)*
35
+
36
+ ## Recipes
37
+
38
+ ### `default`
39
+
40
+ The default recipe installs Node.js or io.js based on the node attributes. It is
41
+ entirely optional and can be ignored in favor of direct use of the
42
+ `javascript_runtime` resource.
43
+
44
+ ## Resources
45
+
46
+ ### `javascript_runtime`
47
+
48
+ The `javascript_runtime` resource installs a JavaScript interpreter.
49
+
50
+ ```ruby
51
+ javascript_runtime '0.12'
52
+ ```
53
+
54
+ #### Actions
55
+
56
+ * `:install` – Install the JavaScript interpreter. *(default)*
57
+ * `:uninstall` – Uninstall the JavaScript interpreter.
58
+
59
+ #### Properties
60
+
61
+ * `version` – Version of the runtime to install. If a partial version is given,
62
+ use the latest available version matching that prefix. *(name property)*
63
+
64
+ #### Provider Options
65
+
66
+ The `poise-javascript` library offers an additional way to pass configuration
67
+ information to the final provider called "options". Options are key/value pairs
68
+ that are passed down to the `javascript_runtime` provider and can be used to control how it
69
+ installs JavaScript. These can be set in the `javascript_runtime`
70
+ resource using the `options` method, in node attributes or via the
71
+ `javascript_runtime_options` resource. The options from all sources are merged
72
+ together in to a single hash.
73
+
74
+ When setting options in the resource you can either set them for all providers:
75
+
76
+ ```ruby
77
+ javascript_runtime 'myapp' do
78
+ version '0.10'
79
+ options dev_package: false
80
+ end
81
+ ```
82
+
83
+ or for a single provider:
84
+
85
+ ```ruby
86
+ javascript_runtime 'myapp' do
87
+ version '0.10'
88
+ options :system, dev_package: false
89
+ end
90
+ ```
91
+
92
+ Setting via node attributes is generally how an end-user or application cookbook
93
+ will set options to customize installations in the library cookbooks they are using.
94
+ You can set options for all installations or for a single runtime:
95
+
96
+ ```ruby
97
+ # Global, for all installations.
98
+ override['poise-javascript']['options']['version'] = '0.10'
99
+ # Single installation.
100
+ override['poise-javascript']['myapp']['version'] = 'iojs'
101
+ ```
102
+
103
+ The `javascript_runtime_options` resource is also available to set node attributes
104
+ for a specific installation in a DSL-friendly way:
105
+
106
+ ```ruby
107
+ javascript_runtime_options 'myapp' do
108
+ version 'iojs'
109
+ end
110
+ ```
111
+
112
+ Unlike resource attributes, provider options can be different for each provider.
113
+ Not all providers support the same options so make sure to the check the
114
+ documentation for each provider to see what options the use.
115
+
116
+ ### `javascript_runtime_options`
117
+
118
+ The `javascript_runtime_options` resource allows setting provider options in a
119
+ DSL-friendly way. See [the Provider Options](#provider-options) section for more
120
+ information about provider options overall.
121
+
122
+ ```ruby
123
+ javascript_runtime_options 'myapp' do
124
+ version 'iojs'
125
+ end
126
+ ```
127
+
128
+ #### Actions
129
+
130
+ * `:run` – Apply the provider options. *(default)*
131
+
132
+ #### Properties
133
+
134
+ * `resource` – Name of the `javascript_runtime` resource. *(name property)*
135
+ * `for_provider` – Provider to set options for.
136
+
137
+ All other attribute keys will be used as options data.
138
+
139
+ ### `javascript_execute`
140
+
141
+ The `javascript_execute` resource executes a JavaScript script using the configured runtime.
142
+
143
+ ```ruby
144
+ javascript_execute 'myapp.js' do
145
+ user 'myuser'
146
+ end
147
+ ```
148
+
149
+ This uses the built-in `execute` resource and supports all the same properties.
150
+
151
+ #### Actions
152
+
153
+ * `:run` – Execute the script. *(default)*
154
+
155
+ #### Properties
156
+
157
+ * `command` – Script and arguments to run. Must not include the `node`. *(name attribute)*
158
+ * `javascript` – Name of the `javascript_runtime` resource to use. If not specified, the
159
+ most recently declared `javascript_runtime` will be used. Can also be set to the
160
+ full path to a `node` binary.
161
+
162
+ For other properties see the [Chef documentation](https://docs.chef.io/resource_execute.html#attributes).
163
+
164
+ ### `node_package`
165
+
166
+ The `node_package` resource installs Node.js packages using
167
+ [NPM](https://www.npmjs.com/).
168
+
169
+ ```ruby
170
+ node_package 'express' do
171
+ version '4.13.3'
172
+ end
173
+ ```
174
+
175
+ This uses the built-in `package` resource and supports the same actions and
176
+ properties. Multi-package installs are supported using the standard syntax.
177
+
178
+ #### Actions
179
+
180
+ * `:install` – Install the package. *(default)*
181
+ * `:upgrade` – Upgrade the package.
182
+ * `:remove` – Uninstall the package.
183
+
184
+ The `:purge` and `:reconfigure` actions are not supported.
185
+
186
+ #### Properties
187
+
188
+ * `group` – System group to install the package.
189
+ * `package_name` – Package or packages to install. *(name property)*
190
+ * `path` – Path to install the package in to. If unset install using `--global`.
191
+ *(default: nil)*
192
+ * `version` – Version or versions to install.
193
+ * `javascript` – Name of the `javascript_runtime` resource to use. If not specified, the
194
+ most recently declared `javascript_runtime` will be used. Can also be set to the
195
+ full path to a `node` binary.
196
+ * `unsafe_perm` – Enable `--unsafe-perm`. *(default: true)*
197
+ * `user` – System user to install the package.
198
+
199
+ For other properties see the [Chef documentation](https://docs.chef.io/resource_package.html#attributes).
200
+ The `response_file`, `response_file_variables`, and `source` properties are not
201
+ supported.
202
+
203
+ ### `npm_install`
204
+
205
+ The `npm_install` resource runs `npm install` for a package.
206
+
207
+ ```ruby
208
+ npm_install '/opt/myapp'
209
+ ```
210
+
211
+ The underlying `npm install` command will run on every converge, but notifications
212
+ will only be triggered if a package is actually installed.
213
+
214
+ #### Actions
215
+
216
+ * `:install` – Run `npm install`. *(default)*
217
+
218
+ #### Properties
219
+
220
+ * `path` – Path to the package folder containing a `package.json`. *(name attribute)*
221
+ * `group` – System group to install the packages.
222
+ * `javascript` – Name of the `javascript_runtime` resource to use. If not specified, the
223
+ most recently declared `javascript_runtime` will be used. Can also be set to the
224
+ full path to a `node` binary.
225
+ * `production` – Enable production install mode. *(default: true)*
226
+ * `unsafe_perm` – Enable `--unsafe-perm`. *(default: true)*
227
+ * `user` – System user to install the packages.
228
+
229
+ ## Javascript Providers
230
+
231
+ ### Common Options
232
+
233
+ These provider options are supported by all providers.
234
+
235
+ * `version` – Override the runtime version.
236
+
237
+ ### `system`
238
+
239
+ The `system` provider installs Node.js using system packages. This is currently
240
+ only tested on platforms using `apt-get` and `yum` (Debian, Ubuntu, RHEL, CentOS
241
+ Amazon Linux, and Fedora). It may work on other platforms but is untested.
242
+
243
+ ```ruby
244
+ javascript_runtime 'myapp' do
245
+ provider :system
246
+ version '0.10'
247
+ end
248
+ ```
249
+
250
+ #### Options
251
+
252
+ * `dev_package` – Install the package with the headers and other development
253
+ files. Can be set to a string to select the dev package specifically.
254
+ *(default: true)*
255
+ * `package_name` – Override auto-detection of the package name.
256
+ * `package_upgrade` – Install using action `:upgrade`. *(default: false)*
257
+ * `package_version` – Override auto-detection of the package version.
258
+
259
+ ### `scl`
260
+
261
+ The `scl` provider installs Node.js using the [Software Collections](https://www.softwarecollections.org/)
262
+ packages. This is only available on RHEL and CentOS. SCL offers more
263
+ recent versions of Node.js than the system packages for the most part. If an SCL
264
+ package exists for the requests version, it will be used in preference to the
265
+ `system` provider.
266
+
267
+ ```ruby
268
+ javascript_runtime 'myapp' do
269
+ provider :scl
270
+ version '0.10'
271
+ end
272
+ ```
273
+
274
+ ### `nodejs`
275
+
276
+ The `nodejs` provider installs Node.js from the static binaries on nodejs.org.
277
+ Support is included for Linux and OS X.
278
+
279
+ ```ruby
280
+ javascript_runtime 'myapp' do
281
+ provider :nodejs
282
+ version '0.12'
283
+ end
284
+ ```
285
+
286
+ #### Options
287
+
288
+ * `path` – Folder to install Node.js to. *(default: /opt/nodejs-<version>)*
289
+ * `static_version` – Specific version number to use for computing the URL and
290
+ path. *(default: automatic from `version`)*
291
+ * `strip_components` – Value to pass to tar --strip-components. *(automatic)*
292
+ * `url` – URL template to download the archive from. *(default: automatic)*
293
+
294
+ ### `iojs`
295
+
296
+ The `iojs` provider installs io.js from the static binaries on iojs.org.
297
+ Support is included for Linux and OS X.
298
+
299
+ ```ruby
300
+ javascript_runtime 'myapp' do
301
+ provider :iojs
302
+ version '3'
303
+ end
304
+ ```
305
+
306
+ #### Options
307
+
308
+ * `path` – Folder to install io.js to. *(default: /opt/iojs-<version>)*
309
+ * `static_version` – Specific version number to use for computing the URL and
310
+ path. *(default: automatic from `version`)*
311
+ * `strip_components` – Value to pass to tar --strip-components. *(automatic)*
312
+ * `url` – URL template to download the archive from. *(default: automatic)*
313
+
314
+ ## Sponsors
315
+
316
+ The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
317
+
318
+ ## License
319
+
320
+ Copyright 2015, Noah Kantrowitz
321
+
322
+ Licensed under the Apache License, Version 2.0 (the "License");
323
+ you may not use this file except in compliance with the License.
324
+ You may obtain a copy of the License at
325
+
326
+ http://www.apache.org/licenses/LICENSE-2.0
327
+
328
+ Unless required by applicable law or agreed to in writing, software
329
+ distributed under the License is distributed on an "AS IS" BASIS,
330
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
331
+ See the License for the specific language governing permissions and
332
+ limitations under the License.