puppet-function-updater 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4e20e5f6989948ee8a47c6be69b5c381a0817ae8b26ccf7daac5d3e437de74b
-  data.tar.gz: cd83a4c1687b449691de92a67de33a9a80fd11f31411232ff41472b4735cd3b5
+  metadata.gz: 7c8e70b6514414dcd252d6337de80765df70e417173250932fc332b6a2eaac90
+  data.tar.gz: e116616d37d9376ff3f4df574df00f75ba3a98ae16b02d1bfd83b0e1bea0a629
 SHA512:
-  metadata.gz: d308a64a254c50864dd8b0840f42cb2feee2da57c452696b0e3069ddb602bbb35119ee3708a71801e057c51c5b3aebaaff52ebf113e0a8380f714b1e5f1f1d66
-  data.tar.gz: c08d5bef117c504be32a60e19b42e860d63f9e390c0708d64ef0a345985499d7caf43b2e10c8b2d2494de4b0459d908807578d961d9fc65925814f7923939e9a
+  metadata.gz: aa9bf40727c562d18890b1a722d93276f46f544ba22ff995aaabb7184cb9fde47cb55f175365681f512145658642be906f373bad0d855401709c3cac5bbe857b
+  data.tar.gz: 0f77d9209e589364b682906af5f68fa87fb48dba1cc733b968da855aa8756657305b9c4998ff4324ed861c796c7a3a37df16f21c780bb650e36c4c25996a8369

data/CHANGELOG.md

@@ -1,2 +1,10 @@
+v0.0.3
+  * Cleans up by deleting the legacy function files if requested with `--clean`
+
+v0.0.2
+  * Now parses almost all of stdlib
+  * handles heredocs
+  * handles require statements outside the function block
+
 v0.0.1
   * Initial release

data/README.md

@@ -20,6 +20,167 @@ $ gem install puppet-function-updater
 Run the command `puppet_function_updater` in the root of a Puppet module, then
 inspect all the generated functions for suitability.
 
+### Example:
+
+```
+[~/Projects/puppetlabs-stdlib]$ puppet_function_updater --verbose
+INFO: Creating lib/puppet/functions/stdlib/abs.rb
+INFO: Creating lib/puppet/functions/stdlib/any2array.rb
+INFO: Creating lib/puppet/functions/stdlib/any2bool.rb
+INFO: Creating lib/puppet/functions/stdlib/assert_private.rb
+INFO: Creating lib/puppet/functions/stdlib/base64.rb
+INFO: Creating lib/puppet/functions/stdlib/basename.rb
+INFO: Creating lib/puppet/functions/stdlib/bool2num.rb
+INFO: Creating lib/puppet/functions/stdlib/bool2str.rb
+INFO: Creating lib/puppet/functions/stdlib/camelcase.rb
+INFO: Creating lib/puppet/functions/stdlib/capitalize.rb
+INFO: Creating lib/puppet/functions/stdlib/ceiling.rb
+INFO: Creating lib/puppet/functions/stdlib/chomp.rb
+INFO: Creating lib/puppet/functions/stdlib/chop.rb
+INFO: Creating lib/puppet/functions/stdlib/clamp.rb
+INFO: Creating lib/puppet/functions/stdlib/concat.rb
+INFO: Creating lib/puppet/functions/stdlib/convert_base.rb
+INFO: Creating lib/puppet/functions/stdlib/count.rb
+INFO: Creating lib/puppet/functions/stdlib/deep_merge.rb
+ERROR: The function attempted to load libraries outside the function block.
+WARN: cannot load such file -- puppet/parser/functions (ignored)
+INFO: Creating lib/puppet/functions/stdlib/defined_with_params.rb
+INFO: Creating lib/puppet/functions/stdlib/delete.rb
+INFO: Creating lib/puppet/functions/stdlib/delete_at.rb
+INFO: Creating lib/puppet/functions/stdlib/delete_regex.rb
+INFO: Creating lib/puppet/functions/stdlib/delete_undef_values.rb
+INFO: Creating lib/puppet/functions/stdlib/delete_values.rb
+INFO: Creating lib/puppet/functions/stdlib/deprecation.rb
+INFO: Creating lib/puppet/functions/stdlib/difference.rb
+INFO: Creating lib/puppet/functions/stdlib/dig.rb
+INFO: Creating lib/puppet/functions/stdlib/dig44.rb
+INFO: Creating lib/puppet/functions/stdlib/dirname.rb
+INFO: Creating lib/puppet/functions/stdlib/dos2unix.rb
+INFO: Creating lib/puppet/functions/stdlib/downcase.rb
+INFO: Creating lib/puppet/functions/stdlib/empty.rb
+INFO: Creating lib/puppet/functions/stdlib/enclose_ipv6.rb
+INFO: Creating lib/puppet/functions/stdlib/ensure_packages.rb
+ERROR: The function attempted to load libraries outside the function block.
+WARN: cannot load such file -- puppet/parser/functions (ignored)
+INFO: Creating lib/puppet/functions/stdlib/ensure_resource.rb
+ERROR: The function attempted to load libraries outside the function block.
+WARN: cannot load such file -- puppet/parser/functions (ignored)
+INFO: Creating lib/puppet/functions/stdlib/ensure_resources.rb
+INFO: Creating lib/puppet/functions/stdlib/flatten.rb
+INFO: Creating lib/puppet/functions/stdlib/floor.rb
+INFO: Creating lib/puppet/functions/stdlib/fqdn_rand_string.rb
+INFO: Creating lib/puppet/functions/stdlib/fqdn_rotate.rb
+INFO: Creating lib/puppet/functions/stdlib/fqdn_uuid.rb
+INFO: Creating lib/puppet/functions/stdlib/get_module_path.rb
+ERROR: The function attempted to load libraries outside the function block.
+WARN: cannot load such file -- puppet/parser/functions (ignored)
+INFO: Creating lib/puppet/functions/stdlib/getparam.rb
+INFO: Creating lib/puppet/functions/stdlib/getvar.rb
+INFO: Creating lib/puppet/functions/stdlib/glob.rb
+INFO: Creating lib/puppet/functions/stdlib/grep.rb
+INFO: Creating lib/puppet/functions/stdlib/has_interface_with.rb
+INFO: Creating lib/puppet/functions/stdlib/has_ip_address.rb
+INFO: Creating lib/puppet/functions/stdlib/has_ip_network.rb
+INFO: Creating lib/puppet/functions/stdlib/has_key.rb
+INFO: Creating lib/puppet/functions/stdlib/hash.rb
+INFO: Creating lib/puppet/functions/stdlib/intersection.rb
+INFO: Creating lib/puppet/functions/stdlib/is_absolute_path.rb
+INFO: Creating lib/puppet/functions/stdlib/is_array.rb
+INFO: Creating lib/puppet/functions/stdlib/is_bool.rb
+INFO: Creating lib/puppet/functions/stdlib/is_domain_name.rb
+INFO: Creating lib/puppet/functions/stdlib/is_email_address.rb
+INFO: Creating lib/puppet/functions/stdlib/is_float.rb
+INFO: Creating lib/puppet/functions/stdlib/is_function_available.rb
+INFO: Creating lib/puppet/functions/stdlib/is_hash.rb
+INFO: Creating lib/puppet/functions/stdlib/is_integer.rb
+INFO: Creating lib/puppet/functions/stdlib/is_ip_address.rb
+INFO: Creating lib/puppet/functions/stdlib/is_ipv4_address.rb
+INFO: Creating lib/puppet/functions/stdlib/is_ipv6_address.rb
+INFO: Creating lib/puppet/functions/stdlib/is_mac_address.rb
+INFO: Creating lib/puppet/functions/stdlib/is_numeric.rb
+INFO: Creating lib/puppet/functions/stdlib/is_string.rb
+INFO: Creating lib/puppet/functions/stdlib/join.rb
+INFO: Creating lib/puppet/functions/stdlib/join_keys_to_values.rb
+INFO: Creating lib/puppet/functions/stdlib/keys.rb
+INFO: Creating lib/puppet/functions/stdlib/load_module_metadata.rb
+INFO: Creating lib/puppet/functions/stdlib/loadjson.rb
+INFO: Creating lib/puppet/functions/stdlib/loadyaml.rb
+INFO: Creating lib/puppet/functions/stdlib/lstrip.rb
+INFO: Creating lib/puppet/functions/stdlib/max.rb
+INFO: Creating lib/puppet/functions/stdlib/member.rb
+INFO: Creating lib/puppet/functions/stdlib/merge.rb
+INFO: Creating lib/puppet/functions/stdlib/min.rb
+INFO: Creating lib/puppet/functions/stdlib/num2bool.rb
+INFO: Creating lib/puppet/functions/stdlib/parsejson.rb
+INFO: Creating lib/puppet/functions/stdlib/parseyaml.rb
+INFO: Creating lib/puppet/functions/stdlib/pick.rb
+INFO: Creating lib/puppet/functions/stdlib/pick_default.rb
+INFO: Creating lib/puppet/functions/stdlib/prefix.rb
+INFO: Creating lib/puppet/functions/stdlib/private.rb
+INFO: Creating lib/puppet/functions/stdlib/pry.rb
+INFO: Creating lib/puppet/functions/stdlib/pw_hash.rb
+INFO: Creating lib/puppet/functions/stdlib/range.rb
+INFO: Creating lib/puppet/functions/stdlib/regexpescape.rb
+INFO: Creating lib/puppet/functions/stdlib/reject.rb
+INFO: Creating lib/puppet/functions/stdlib/reverse.rb
+INFO: Creating lib/puppet/functions/stdlib/round.rb
+INFO: Creating lib/puppet/functions/stdlib/rstrip.rb
+INFO: Creating lib/puppet/functions/stdlib/seeded_rand.rb
+INFO: Creating lib/puppet/functions/stdlib/shell_escape.rb
+INFO: Creating lib/puppet/functions/stdlib/shell_join.rb
+INFO: Creating lib/puppet/functions/stdlib/shell_split.rb
+INFO: Creating lib/puppet/functions/stdlib/shuffle.rb
+INFO: Creating lib/puppet/functions/stdlib/size.rb
+INFO: Creating lib/puppet/functions/stdlib/sort.rb
+INFO: Creating lib/puppet/functions/stdlib/squeeze.rb
+INFO: Creating lib/puppet/functions/stdlib/str2bool.rb
+INFO: Creating lib/puppet/functions/stdlib/str2saltedsha512.rb
+INFO: Creating lib/puppet/functions/stdlib/strftime.rb
+INFO: Creating lib/puppet/functions/stdlib/strip.rb
+INFO: Creating lib/puppet/functions/stdlib/suffix.rb
+INFO: Creating lib/puppet/functions/stdlib/swapcase.rb
+INFO: Creating lib/puppet/functions/stdlib/time.rb
+INFO: Creating lib/puppet/functions/stdlib/to_bytes.rb
+INFO: Creating lib/puppet/functions/stdlib/try_get_value.rb
+INFO: Creating lib/puppet/functions/stdlib/type.rb
+INFO: Creating lib/puppet/functions/stdlib/type3x.rb
+INFO: Creating lib/puppet/functions/stdlib/union.rb
+INFO: Creating lib/puppet/functions/stdlib/unique.rb
+INFO: Creating lib/puppet/functions/stdlib/unix2dos.rb
+INFO: Creating lib/puppet/functions/stdlib/upcase.rb
+INFO: Creating lib/puppet/functions/stdlib/uriescape.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_absolute_path.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_array.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_augeas.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_bool.rb
+ERROR: The function attempted to load libraries outside the function block.
+WARN: cannot load such file -- puppet/util/execution (ignored)
+INFO: Creating lib/puppet/functions/stdlib/validate_cmd.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_domain_name.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_email_address.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_hash.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_integer.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_ip_address.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_ipv4_address.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_ipv6_address.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_numeric.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_re.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_slength.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_string.rb
+INFO: Creating lib/puppet/functions/stdlib/validate_x509_rsa_key_pair.rb
+ERROR: Oh crap; the generated function isn't valid Ruby code!
+ERROR: <compiled>:47: dynamic constant assignment
+    NUM_ARGS = 2 unless defined? NUM_ARGS
+             ^
+INFO: Creating lib/puppet/functions/stdlib/values.rb
+INFO: Creating lib/puppet/functions/stdlib/values_at.rb
+INFO: Creating lib/puppet/functions/stdlib/zip.rb
+INFO: Functions generated. Please inspect for suitability and then
+INFO: update any Puppet code with the new function names.
+INFO: See https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+INFO: for more information about Puppet's modern Ruby function API.
+```
+
 
 ## Limitations
 

data/bin/puppet_function_updater

@@ -30,6 +30,10 @@ mean to port all the legacy functions.
     loglevel = Logger::DEBUG
   end
 
+  opts.on('-c', '--clean', 'Show debugging messages') do
+    options[:clean] = true
+  end
+
   opts.on('-n', '--namespace NAMESPACE', 'The namespace for the generated functions to live in') do |arg|
     options[:namespace] = arg
   end

data/lib/pfu.rb

@@ -6,13 +6,16 @@ class Pfu
   def initialize(options)
     @filenames = options[:filenames]
     @namespace = options[:namespace]
+    @clean     = options[:clean]
   end
 
   def refactor!
     @filenames.each do |path|
       next unless data = Pfu::Parser.parse(path)
       data[:namespace] = @namespace
-      Pfu::Generator.write(data)
+      if Pfu::Generator.write(data)
+        FileUtils.rm(path) if @clean
+      end
     end
 
     $logger.info "Functions generated. Please inspect for suitability and then"

data/lib/pfu/generator.rb

@@ -24,13 +24,16 @@ class Pfu::Generator
 
     begin
       # syntax check the code before writing it
+      # TODO: validate that it actually creates a puppet function
       RubyVM::InstructionSequence.compile(contents)
       FileUtils.mkdir_p("lib/puppet/functions/#{opts[:namespace]}")
       File.write(newpath, contents)
+      return true
     rescue Exception => e
       $logger.error "Oh crap; the generated function isn't valid Ruby code!"
       $logger.error e.message
       $logger.debug e.backtrace.join("\n")
+      return false
     end
 
   end

data/lib/pfu/version.rb

@@ -1,3 +1,3 @@
 class Pfu
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppet-function-updater
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ben Ford