puppet-function-updater 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/CHANGELOG.md +2 -0
- data/LICENSE +201 -0
- data/README.md +37 -0
- data/bin/puppet_function_updater +78 -0
- data/lib/pfu.rb +23 -0
- data/lib/pfu/generator.rb +35 -0
- data/lib/pfu/parser.rb +45 -0
- data/lib/pfu/version.rb +3 -0
- data/lib/puppet/functions/testing/direct.rb +39 -0
- data/lib/puppet/functions/testing/module.rb +39 -0
- data/lib/puppet/functions/testing/noopts.rb +41 -0
- data/templates/function.erb +33 -0
- metadata +59 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 43740352c17551ddd5440e4ece70ad04248b2ee9a3c64ad7a8cd13e2f6a2c8f1
|
4
|
+
data.tar.gz: c515002e42faadc8fee35f37a6a76805d2cc0d44ace7d9609e494cc4590c9360
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: a8fa785031af5cd3d22adaee5db4363bb8849ee541ef0c939cdb67d34e9715b266f83ddf708721ac4f3c23ccbdd84d999eba5c8daef97b0a326097fb26cdad2b
|
7
|
+
data.tar.gz: 642f1dedcb74988a68f6c872598ac9d18f55db968a328b4a8f4a7b58f00b9d0f9e69584605f767fcaf0f94fcfb2c107e2b6001a6e7c000fd65787fc4ab603bfe
|
data/CHANGELOG.md
ADDED
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.
|
data/README.md
ADDED
@@ -0,0 +1,37 @@
|
|
1
|
+
# Puppet Function Updater
|
2
|
+
|
3
|
+
Port legacy Puppet 3.x functions to the new function API automatically.
|
4
|
+
|
5
|
+
Run this command with a space separated list of either function file paths, or
|
6
|
+
directories containing functions. If omitted, it will default to porting all the
|
7
|
+
legacy functions, so you can just run this in the root of a Puppet module and it
|
8
|
+
will do the right thing.
|
9
|
+
|
10
|
+
|
11
|
+
## Installation
|
12
|
+
|
13
|
+
```
|
14
|
+
$ gem install puppet-function-updater
|
15
|
+
```
|
16
|
+
|
17
|
+
|
18
|
+
## Usage
|
19
|
+
|
20
|
+
Run the command `puppet_function_updater` in the root of a Puppet module, then
|
21
|
+
inspect all the generated functions for suitability.
|
22
|
+
|
23
|
+
|
24
|
+
## Limitations
|
25
|
+
|
26
|
+
This is super early in development and has not yet been battle tested.
|
27
|
+
|
28
|
+
|
29
|
+
## Disclaimer
|
30
|
+
|
31
|
+
I take no liability for the use of this tool.
|
32
|
+
|
33
|
+
|
34
|
+
Contact
|
35
|
+
-------
|
36
|
+
|
37
|
+
binford2k@gmail.com
|
@@ -0,0 +1,78 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
|
3
|
+
|
4
|
+
require 'logger'
|
5
|
+
require 'optparse'
|
6
|
+
require 'pfu'
|
7
|
+
|
8
|
+
loglevel = Logger::WARN
|
9
|
+
options = {}
|
10
|
+
OptionParser.new do |opts|
|
11
|
+
opts.banner = "Usage: puppet_function_updater [paths]
|
12
|
+
|
13
|
+
Run this command with a space separated list of legacy function file paths and it
|
14
|
+
will attempt to automatically port them to the modern function API for you.
|
15
|
+
|
16
|
+
If you run it from the root of a module directory, it will infer the namespace of
|
17
|
+
the module and use it automatically in the generated function names.
|
18
|
+
|
19
|
+
If you pass no paths and run it from the root of a module, it will assume that you
|
20
|
+
mean to port all the legacy functions.
|
21
|
+
|
22
|
+
"
|
23
|
+
|
24
|
+
opts.on('-v', '--verbose', 'Show verbose output') do
|
25
|
+
loglevel = Logger::INFO
|
26
|
+
end
|
27
|
+
|
28
|
+
opts.on('-d', '--debug', 'Show debugging messages') do
|
29
|
+
loglevel = Logger::DEBUG
|
30
|
+
end
|
31
|
+
|
32
|
+
opts.on('-n', '--namespace NAMESPACE', 'The namespace for the generated functions to live in') do |arg|
|
33
|
+
options[:namespace] = arg
|
34
|
+
end
|
35
|
+
|
36
|
+
opts.on('--shell', 'Open a pry shell for debugging (must have Pry installed)') do
|
37
|
+
options[:shell] = true
|
38
|
+
end
|
39
|
+
|
40
|
+
opts.on('--version', 'Show version number') do
|
41
|
+
puts Pfu::VERSION
|
42
|
+
exit
|
43
|
+
end
|
44
|
+
|
45
|
+
end.parse!
|
46
|
+
|
47
|
+
$logger = Logger.new($stderr)
|
48
|
+
$logger.level = loglevel
|
49
|
+
$logger.formatter = proc { |severity,datetime,progname,msg| "#{severity}: #{msg}\n" }
|
50
|
+
|
51
|
+
options[:filenames] = ARGV.map {|f| File.expand_path f} unless ARGV.empty?
|
52
|
+
options[:filenames] ||= ['lib/puppet/parser/functions']
|
53
|
+
|
54
|
+
options[:filenames].map! do |path|
|
55
|
+
next path unless File.directory? path
|
56
|
+
|
57
|
+
Dir.glob("#{path}/*")
|
58
|
+
end
|
59
|
+
options[:filenames].flatten!
|
60
|
+
|
61
|
+
if options[:namespace].nil?
|
62
|
+
if File.exist? 'metadata.json'
|
63
|
+
metadata = JSON.parse(File.read('metadata.json'))
|
64
|
+
options[:namespace] = metadata['name'].split('-')[1]
|
65
|
+
else
|
66
|
+
$logger.warn "*********** Namespace is highly suggested! *********** "
|
67
|
+
$logger.warn " Either run this command from within a module"
|
68
|
+
$logger.warn " or provide a namespace with the --namespace argument!"
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
if options[:shell]
|
73
|
+
require 'pry'
|
74
|
+
binding.pry
|
75
|
+
exit 0
|
76
|
+
end
|
77
|
+
|
78
|
+
Pfu.new(options).refactor!
|
data/lib/pfu.rb
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
class Pfu
|
2
|
+
require 'pfu/parser'
|
3
|
+
require 'pfu/generator'
|
4
|
+
require 'pfu/version'
|
5
|
+
|
6
|
+
def initialize(options)
|
7
|
+
@filenames = options[:filenames]
|
8
|
+
@namespace = options[:namespace]
|
9
|
+
end
|
10
|
+
|
11
|
+
def refactor!
|
12
|
+
@filenames.each do |path|
|
13
|
+
data = Pfu::Parser.parse(path)
|
14
|
+
data[:namespace] = @namespace
|
15
|
+
Pfu::Generator.write(data)
|
16
|
+
end
|
17
|
+
|
18
|
+
$logger.info "Functions generated. Please inspect for suitability and then"
|
19
|
+
$logger.info "update any Puppet code with the new function names."
|
20
|
+
$logger.info "See https://puppet.com/docs/puppet/latest/custom_functions_ruby.html"
|
21
|
+
$logger.info "for more information about Puppet's modern Ruby function API."
|
22
|
+
end
|
23
|
+
end
|
@@ -0,0 +1,35 @@
|
|
1
|
+
require 'erb'
|
2
|
+
require 'fileutils'
|
3
|
+
|
4
|
+
class Pfu::Generator
|
5
|
+
def self.write(opts)
|
6
|
+
newpath = "lib/puppet/functions/#{opts[:namespace]}/#{opts[:name]}.rb"
|
7
|
+
if File.exist?(newpath)
|
8
|
+
$logger.error "Cowardly refusing to overwrite #{newpath}"
|
9
|
+
return
|
10
|
+
end
|
11
|
+
|
12
|
+
opts[:fullname] = case opts[:namespace]
|
13
|
+
when '', nil
|
14
|
+
opts[:name]
|
15
|
+
else
|
16
|
+
"#{opts[:namespace]}::#{opts[:name]}"
|
17
|
+
end
|
18
|
+
|
19
|
+
template = File.join(File.dirname(__FILE__), '..', '..', 'templates', 'function.erb')
|
20
|
+
contents = ERB.new(File.read(template), nil, '-').result(binding)
|
21
|
+
|
22
|
+
begin
|
23
|
+
# syntax check the code before writing it
|
24
|
+
RubyVM::InstructionSequence.compile(contents)
|
25
|
+
FileUtils.mkdir_p("lib/puppet/functions/#{opts[:namespace]}")
|
26
|
+
File.write(newpath, contents)
|
27
|
+
$logger.info "Created #{newpath}."
|
28
|
+
rescue Exception => e
|
29
|
+
$logger.error "Oh crap; the generated function isn't valid Ruby code!"
|
30
|
+
$logger.error e.message
|
31
|
+
$logger.debug e.backtrace.join("\n")
|
32
|
+
end
|
33
|
+
|
34
|
+
end
|
35
|
+
end
|
data/lib/pfu/parser.rb
ADDED
@@ -0,0 +1,45 @@
|
|
1
|
+
module Puppet
|
2
|
+
module Parser
|
3
|
+
module Functions
|
4
|
+
|
5
|
+
def self.newfunction(funcname, opts = {}, &block)
|
6
|
+
return [funcname, opts, block.source_location.last]
|
7
|
+
end
|
8
|
+
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
12
|
+
|
13
|
+
|
14
|
+
class Pfu::Parser
|
15
|
+
def self.parse(path)
|
16
|
+
source = File.read(path)
|
17
|
+
lines = source.split("\n")
|
18
|
+
|
19
|
+
funcname, opts, lineno = eval(source)
|
20
|
+
|
21
|
+
|
22
|
+
stripcount = case source
|
23
|
+
when /module\s+Puppet::Parser::Functions/
|
24
|
+
2
|
25
|
+
when /Puppet::Parser::Functions.newfunction/
|
26
|
+
1
|
27
|
+
end
|
28
|
+
|
29
|
+
block = lines[(lineno-1)..-1].join("\n")
|
30
|
+
block.gsub!(/\A.*\|\w+\|/, '') # remove block arg string ("|args|")
|
31
|
+
block.gsub!(/((end|})\s*){#{stripcount}}(^#.*|\s*)*\z/, '') # remove closing block keywords and trailing comments
|
32
|
+
|
33
|
+
header = lines[0...(lines.index { |l| l =~ /Puppet::Parser::Functions/ })].join("\n")
|
34
|
+
args = lines[lineno-1].match(/\|\s*(\w+)\s*\|/)[1]
|
35
|
+
|
36
|
+
|
37
|
+
opts[:name] = funcname.to_sym
|
38
|
+
opts[:header] = header
|
39
|
+
opts[:args] = args
|
40
|
+
opts[:implementation] = block
|
41
|
+
|
42
|
+
opts
|
43
|
+
end
|
44
|
+
|
45
|
+
end
|
data/lib/pfu/version.rb
ADDED
@@ -0,0 +1,39 @@
|
|
1
|
+
# This is an autogenerated function, ported from the original legacy version.
|
2
|
+
# It /should work/ as is, but will not have all the benefits of the modern
|
3
|
+
# function API. You should see the function docs to learn how to add function
|
4
|
+
# signatures for type safety and to document this function using puppet-strings.
|
5
|
+
#
|
6
|
+
# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
|
7
|
+
#
|
8
|
+
# ---- original file header ----
|
9
|
+
# A comment! Theoretically it would tell you what the function does.
|
10
|
+
# ---- original file header ----
|
11
|
+
#
|
12
|
+
# @summary
|
13
|
+
# Just a naive strlen example
|
14
|
+
#
|
15
|
+
Puppet::Functions.create_function(:'testing::direct') do
|
16
|
+
# @param args
|
17
|
+
# The original array of arguments. Port this to individually managed params
|
18
|
+
# to get the full benefit of the modern function API.
|
19
|
+
#
|
20
|
+
# @return [Data type]
|
21
|
+
# Describe what the function returns here
|
22
|
+
#
|
23
|
+
dispatch :default_impl do
|
24
|
+
# Call the method named 'default_impl' when this is matched
|
25
|
+
# Port this to match individual params for better type safety
|
26
|
+
repeated_param 'Any', :args
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
def default_impl(*args)
|
31
|
+
|
32
|
+
raise "Wrong number of args" unless args.size == 1 # arg validation
|
33
|
+
raise "Wrong type of args" unless args.first.is_a String # arg validation
|
34
|
+
value = args.first # arg handling
|
35
|
+
|
36
|
+
value.length # implementation
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# This is an autogenerated function, ported from the original legacy version.
|
2
|
+
# It /should work/ as is, but will not have all the benefits of the modern
|
3
|
+
# function API. You should see the function docs to learn how to add function
|
4
|
+
# signatures for type safety and to document this function using puppet-strings.
|
5
|
+
#
|
6
|
+
# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
|
7
|
+
#
|
8
|
+
# ---- original file header ----
|
9
|
+
|
10
|
+
# ---- original file header ----
|
11
|
+
#
|
12
|
+
# @summary
|
13
|
+
# Just a naive strlen example
|
14
|
+
#
|
15
|
+
Puppet::Functions.create_function(:'testing::module') do
|
16
|
+
# @param args
|
17
|
+
# The original array of arguments. Port this to individually managed params
|
18
|
+
# to get the full benefit of the modern function API.
|
19
|
+
#
|
20
|
+
# @return [Data type]
|
21
|
+
# Describe what the function returns here
|
22
|
+
#
|
23
|
+
dispatch :default_impl do
|
24
|
+
# Call the method named 'default_impl' when this is matched
|
25
|
+
# Port this to match individual params for better type safety
|
26
|
+
repeated_param 'Any', :args
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
def default_impl(*args)
|
31
|
+
|
32
|
+
raise "Wrong number of args" unless args.size == 1 # arg validation
|
33
|
+
raise "Wrong type of args" unless args.first.is_a String # arg validation
|
34
|
+
value = args.first # arg handling
|
35
|
+
|
36
|
+
value.length # implementation
|
37
|
+
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# This is an autogenerated function, ported from the original legacy version.
|
2
|
+
# It /should work/ as is, but will not have all the benefits of the modern
|
3
|
+
# function API. You should see the function docs to learn how to add function
|
4
|
+
# signatures for type safety and to document this function using puppet-strings.
|
5
|
+
#
|
6
|
+
# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
|
7
|
+
#
|
8
|
+
# ---- original file header ----
|
9
|
+
#! /usr/bin/env ruby
|
10
|
+
# This is a leading comment
|
11
|
+
# it might have docs or something
|
12
|
+
# ---- original file header ----
|
13
|
+
#
|
14
|
+
# @summary
|
15
|
+
#
|
16
|
+
#
|
17
|
+
Puppet::Functions.create_function(:'testing::noopts') do
|
18
|
+
# @param args
|
19
|
+
# The original array of arguments. Port this to individually managed params
|
20
|
+
# to get the full benefit of the modern function API.
|
21
|
+
#
|
22
|
+
# @return [Data type]
|
23
|
+
# Describe what the function returns here
|
24
|
+
#
|
25
|
+
dispatch :default_impl do
|
26
|
+
# Call the method named 'default_impl' when this is matched
|
27
|
+
# Port this to match individual params for better type safety
|
28
|
+
repeated_param 'Any', :args
|
29
|
+
end
|
30
|
+
|
31
|
+
|
32
|
+
def default_impl(*args)
|
33
|
+
|
34
|
+
raise "Wrong number of args" unless args.size == 1 # arg validation
|
35
|
+
raise "Wrong type of args" unless args.first.is_a String # arg validation
|
36
|
+
value = args.first # arg handling
|
37
|
+
|
38
|
+
value.length # implementation
|
39
|
+
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# This is an autogenerated function, ported from the original legacy version.
|
2
|
+
# It /should work/ as is, but will not have all the benefits of the modern
|
3
|
+
# function API. You should see the function docs to learn how to add function
|
4
|
+
# signatures for type safety and to document this function using puppet-strings.
|
5
|
+
#
|
6
|
+
# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
|
7
|
+
#
|
8
|
+
# ---- original file header ----
|
9
|
+
<%= opts[:header] %>
|
10
|
+
# ---- original file header ----
|
11
|
+
#
|
12
|
+
# @summary
|
13
|
+
# <%= opts[:doc] %>
|
14
|
+
#
|
15
|
+
Puppet::Functions.create_function(:'<%= opts[:fullname] %>') do
|
16
|
+
# @param <%= opts[:args] %>
|
17
|
+
# The original array of arguments. Port this to individually managed params
|
18
|
+
# to get the full benefit of the modern function API.
|
19
|
+
#
|
20
|
+
# @return [Data type]
|
21
|
+
# Describe what the function returns here
|
22
|
+
#
|
23
|
+
dispatch :default_impl do
|
24
|
+
# Call the method named 'default_impl' when this is matched
|
25
|
+
# Port this to match individual params for better type safety
|
26
|
+
repeated_param 'Any', :<%= opts[:args] %>
|
27
|
+
end
|
28
|
+
|
29
|
+
|
30
|
+
def default_impl(*<%= opts[:args] %>)
|
31
|
+
<%= opts[:implementation] %>
|
32
|
+
end
|
33
|
+
end
|
metadata
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: puppet-function-updater
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Ben Ford
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2019-11-27 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: |
|
14
|
+
Run this command with a space separated list of either function file paths, or
|
15
|
+
directories containing functions. If omitted, it will default to porting all the
|
16
|
+
legacy functions, so you can just run this in the root of a Puppet module and it
|
17
|
+
will do the right thing.
|
18
|
+
email: ben.ford@puppet.com
|
19
|
+
executables:
|
20
|
+
- puppet_function_updater
|
21
|
+
extensions: []
|
22
|
+
extra_rdoc_files: []
|
23
|
+
files:
|
24
|
+
- CHANGELOG.md
|
25
|
+
- LICENSE
|
26
|
+
- README.md
|
27
|
+
- bin/puppet_function_updater
|
28
|
+
- lib/pfu.rb
|
29
|
+
- lib/pfu/generator.rb
|
30
|
+
- lib/pfu/parser.rb
|
31
|
+
- lib/pfu/version.rb
|
32
|
+
- lib/puppet/functions/testing/direct.rb
|
33
|
+
- lib/puppet/functions/testing/module.rb
|
34
|
+
- lib/puppet/functions/testing/noopts.rb
|
35
|
+
- templates/function.erb
|
36
|
+
homepage:
|
37
|
+
licenses:
|
38
|
+
- Apache-2.0
|
39
|
+
metadata: {}
|
40
|
+
post_install_message:
|
41
|
+
rdoc_options: []
|
42
|
+
require_paths:
|
43
|
+
- lib
|
44
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
45
|
+
requirements:
|
46
|
+
- - ">="
|
47
|
+
- !ruby/object:Gem::Version
|
48
|
+
version: '0'
|
49
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
requirements: []
|
55
|
+
rubygems_version: 3.0.2
|
56
|
+
signing_key:
|
57
|
+
specification_version: 4
|
58
|
+
summary: Automagically ports legacy Puppet functions to the modern API.
|
59
|
+
test_files: []
|