openvox 7.37.1 → 8.19.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 (1086) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -3
  3. data/Gemfile +17 -12
  4. data/README.md +25 -30
  5. data/Rakefile +43 -33
  6. data/bin/puppet +1 -0
  7. data/examples/hiera/README.md +68 -57
  8. data/examples/hiera/data/common.yaml +12 -0
  9. data/examples/hiera/data/dc1.yaml +6 -0
  10. data/examples/hiera/hiera.yaml +15 -0
  11. data/examples/hiera/modules/ntp/data/common.yaml +4 -0
  12. data/examples/hiera/modules/ntp/hiera.yaml +9 -0
  13. data/examples/hiera/modules/ntp/manifests/config.pp +16 -4
  14. data/examples/hiera/modules/ntp/templates/ntp.conf.epp +3 -0
  15. data/examples/hiera/modules/users/manifests/common.pp +7 -2
  16. data/examples/hiera/modules/users/manifests/dc1.pp +7 -2
  17. data/examples/hiera/site.pp +1 -1
  18. data/ext/build_defaults.yaml +1 -1
  19. data/ext/windows/service/daemon.rb +54 -60
  20. data/install.rb +21 -92
  21. data/lib/hiera/puppet_function.rb +8 -6
  22. data/lib/hiera/scope.rb +15 -13
  23. data/lib/hiera_puppet.rb +4 -6
  24. data/lib/puppet/agent/disabler.rb +5 -3
  25. data/lib/puppet/agent/locker.rb +2 -2
  26. data/lib/puppet/agent.rb +6 -4
  27. data/lib/puppet/application/agent.rb +305 -301
  28. data/lib/puppet/application/apply.rb +124 -117
  29. data/lib/puppet/application/catalog.rb +2 -0
  30. data/lib/puppet/application/config.rb +2 -0
  31. data/lib/puppet/application/describe.rb +50 -48
  32. data/lib/puppet/application/device.rb +224 -223
  33. data/lib/puppet/application/doc.rb +57 -58
  34. data/lib/puppet/application/epp.rb +2 -0
  35. data/lib/puppet/application/face_base.rb +18 -17
  36. data/lib/puppet/application/facts.rb +2 -0
  37. data/lib/puppet/application/filebucket.rb +174 -168
  38. data/lib/puppet/application/generate.rb +3 -1
  39. data/lib/puppet/application/help.rb +2 -0
  40. data/lib/puppet/application/indirection_base.rb +2 -0
  41. data/lib/puppet/application/lookup.rb +181 -181
  42. data/lib/puppet/application/module.rb +2 -0
  43. data/lib/puppet/application/node.rb +2 -0
  44. data/lib/puppet/application/parser.rb +2 -0
  45. data/lib/puppet/application/plugin.rb +2 -0
  46. data/lib/puppet/application/report.rb +2 -0
  47. data/lib/puppet/application/resource.rb +106 -96
  48. data/lib/puppet/application/script.rb +76 -74
  49. data/lib/puppet/application/ssl.rb +100 -92
  50. data/lib/puppet/application.rb +32 -32
  51. data/lib/puppet/application_support.rb +3 -2
  52. data/lib/puppet/coercion.rb +5 -3
  53. data/lib/puppet/compilable_resource_type.rb +4 -2
  54. data/lib/puppet/concurrent/lock.rb +2 -3
  55. data/lib/puppet/concurrent/synchronized.rb +2 -2
  56. data/lib/puppet/concurrent/thread_local_singleton.rb +1 -0
  57. data/lib/puppet/concurrent.rb +2 -0
  58. data/lib/puppet/configurer/downloader.rb +11 -5
  59. data/lib/puppet/configurer/fact_handler.rb +17 -16
  60. data/lib/puppet/configurer/plugin_handler.rb +2 -0
  61. data/lib/puppet/configurer.rb +40 -36
  62. data/lib/puppet/confine/any.rb +3 -1
  63. data/lib/puppet/confine/boolean.rb +3 -1
  64. data/lib/puppet/confine/exists.rb +3 -1
  65. data/lib/puppet/confine/false.rb +3 -1
  66. data/lib/puppet/confine/feature.rb +3 -2
  67. data/lib/puppet/confine/true.rb +3 -1
  68. data/lib/puppet/confine/variable.rb +4 -2
  69. data/lib/puppet/confine.rb +5 -2
  70. data/lib/puppet/confine_collection.rb +6 -3
  71. data/lib/puppet/confiner.rb +5 -3
  72. data/lib/puppet/context/trusted_information.rb +12 -10
  73. data/lib/puppet/context.rb +2 -0
  74. data/lib/puppet/daemon.rb +26 -10
  75. data/lib/puppet/data_binding.rb +3 -1
  76. data/lib/puppet/datatypes/error.rb +3 -1
  77. data/lib/puppet/datatypes/impl/error.rb +2 -0
  78. data/lib/puppet/datatypes.rb +12 -7
  79. data/lib/puppet/defaults.rb +164 -125
  80. data/lib/puppet/environments.rb +13 -15
  81. data/lib/puppet/error.rb +19 -15
  82. data/lib/puppet/etc.rb +10 -5
  83. data/lib/puppet/external/dot.rb +65 -75
  84. data/lib/puppet/face/catalog/select.rb +4 -2
  85. data/lib/puppet/face/catalog.rb +7 -5
  86. data/lib/puppet/face/config.rb +30 -31
  87. data/lib/puppet/face/epp.rb +25 -26
  88. data/lib/puppet/face/facts.rb +8 -6
  89. data/lib/puppet/face/generate.rb +5 -2
  90. data/lib/puppet/face/help/action.erb +0 -1
  91. data/lib/puppet/face/help/face.erb +0 -1
  92. data/lib/puppet/face/help/global.erb +1 -1
  93. data/lib/puppet/face/help.rb +80 -62
  94. data/lib/puppet/face/module/changes.rb +4 -3
  95. data/lib/puppet/face/module/install.rb +7 -4
  96. data/lib/puppet/face/module/list.rb +52 -53
  97. data/lib/puppet/face/module/uninstall.rb +2 -0
  98. data/lib/puppet/face/module/upgrade.rb +5 -3
  99. data/lib/puppet/face/module.rb +3 -1
  100. data/lib/puppet/face/node/clean.rb +4 -2
  101. data/lib/puppet/face/node.rb +5 -3
  102. data/lib/puppet/face/parser.rb +18 -19
  103. data/lib/puppet/face/plugin.rb +10 -8
  104. data/lib/puppet/face/report.rb +10 -10
  105. data/lib/puppet/face/resource.rb +2 -0
  106. data/lib/puppet/face.rb +2 -0
  107. data/lib/puppet/facter_impl.rb +1 -1
  108. data/lib/puppet/feature/base.rb +13 -13
  109. data/lib/puppet/feature/bolt.rb +2 -0
  110. data/lib/puppet/feature/cfpropertylist.rb +2 -0
  111. data/lib/puppet/feature/eventlog.rb +2 -0
  112. data/lib/puppet/feature/hiera_eyaml.rb +2 -0
  113. data/lib/puppet/feature/hocon.rb +2 -0
  114. data/lib/puppet/feature/libuser.rb +5 -3
  115. data/lib/puppet/feature/msgpack.rb +2 -0
  116. data/lib/puppet/feature/pe_license.rb +4 -2
  117. data/lib/puppet/feature/pson.rb +6 -0
  118. data/lib/puppet/feature/selinux.rb +2 -0
  119. data/lib/puppet/feature/ssh.rb +3 -1
  120. data/lib/puppet/feature/telnet.rb +3 -7
  121. data/lib/puppet/feature/zlib.rb +3 -1
  122. data/lib/puppet/ffi/posix/constants.rb +3 -1
  123. data/lib/puppet/ffi/posix/functions.rb +2 -1
  124. data/lib/puppet/ffi/posix.rb +2 -0
  125. data/lib/puppet/ffi/windows/api_types.rb +3 -1
  126. data/lib/puppet/ffi/windows/constants.rb +80 -78
  127. data/lib/puppet/ffi/windows/functions.rb +76 -75
  128. data/lib/puppet/ffi/windows/structs.rb +6 -5
  129. data/lib/puppet/ffi/windows.rb +2 -0
  130. data/lib/puppet/file_bucket/dipper.rb +20 -11
  131. data/lib/puppet/file_bucket/file.rb +8 -6
  132. data/lib/puppet/file_bucket.rb +2 -0
  133. data/lib/puppet/file_serving/base.rb +17 -9
  134. data/lib/puppet/file_serving/configuration/parser.rb +13 -10
  135. data/lib/puppet/file_serving/configuration.rb +10 -7
  136. data/lib/puppet/file_serving/content.rb +2 -0
  137. data/lib/puppet/file_serving/fileset.rb +23 -19
  138. data/lib/puppet/file_serving/http_metadata.rb +3 -4
  139. data/lib/puppet/file_serving/metadata.rb +26 -23
  140. data/lib/puppet/file_serving/mount/file.rb +15 -11
  141. data/lib/puppet/file_serving/mount/locales.rb +5 -5
  142. data/lib/puppet/file_serving/mount/modules.rb +3 -0
  143. data/lib/puppet/file_serving/mount/pluginfacts.rb +5 -5
  144. data/lib/puppet/file_serving/mount/plugins.rb +5 -5
  145. data/lib/puppet/file_serving/mount/scripts.rb +3 -0
  146. data/lib/puppet/file_serving/mount/tasks.rb +3 -0
  147. data/lib/puppet/file_serving/mount.rb +4 -1
  148. data/lib/puppet/file_serving/terminus_helper.rb +2 -0
  149. data/lib/puppet/file_serving/terminus_selector.rb +3 -1
  150. data/lib/puppet/file_serving.rb +2 -0
  151. data/lib/puppet/file_system/file_impl.rb +9 -8
  152. data/lib/puppet/file_system/jruby.rb +2 -0
  153. data/lib/puppet/file_system/memory_file.rb +3 -0
  154. data/lib/puppet/file_system/memory_impl.rb +5 -1
  155. data/lib/puppet/file_system/path_pattern.rb +4 -2
  156. data/lib/puppet/file_system/posix.rb +7 -2
  157. data/lib/puppet/file_system/uniquefile.rb +33 -31
  158. data/lib/puppet/file_system/windows.rb +33 -22
  159. data/lib/puppet/file_system.rb +5 -3
  160. data/lib/puppet/forge/cache.rb +4 -3
  161. data/lib/puppet/forge/errors.rb +3 -4
  162. data/lib/puppet/forge/repository.rb +6 -3
  163. data/lib/puppet/forge.rb +20 -22
  164. data/lib/puppet/functions/abs.rb +7 -4
  165. data/lib/puppet/functions/alert.rb +2 -0
  166. data/lib/puppet/functions/all.rb +3 -1
  167. data/lib/puppet/functions/annotate.rb +2 -0
  168. data/lib/puppet/functions/any.rb +3 -1
  169. data/lib/puppet/functions/assert_type.rb +5 -2
  170. data/lib/puppet/functions/binary_file.rb +4 -1
  171. data/lib/puppet/functions/break.rb +4 -2
  172. data/lib/puppet/functions/call.rb +2 -1
  173. data/lib/puppet/functions/camelcase.rb +4 -3
  174. data/lib/puppet/functions/capitalize.rb +4 -3
  175. data/lib/puppet/functions/ceiling.rb +3 -2
  176. data/lib/puppet/functions/chomp.rb +3 -2
  177. data/lib/puppet/functions/chop.rb +3 -2
  178. data/lib/puppet/functions/compare.rb +5 -3
  179. data/lib/puppet/functions/contain.rb +7 -4
  180. data/lib/puppet/functions/convert_to.rb +2 -0
  181. data/lib/puppet/functions/crit.rb +2 -0
  182. data/lib/puppet/functions/debug.rb +2 -0
  183. data/lib/puppet/functions/defined.rb +10 -6
  184. data/lib/puppet/functions/dig.rb +13 -10
  185. data/lib/puppet/functions/downcase.rb +4 -2
  186. data/lib/puppet/functions/each.rb +2 -0
  187. data/lib/puppet/functions/emerg.rb +2 -0
  188. data/lib/puppet/functions/empty.rb +2 -0
  189. data/lib/puppet/functions/epp.rb +2 -1
  190. data/lib/puppet/functions/err.rb +2 -0
  191. data/lib/puppet/functions/eyaml_lookup_key.rb +17 -16
  192. data/lib/puppet/functions/filter.rb +8 -7
  193. data/lib/puppet/functions/find_file.rb +6 -0
  194. data/lib/puppet/functions/find_template.rb +2 -0
  195. data/lib/puppet/functions/flatten.rb +2 -0
  196. data/lib/puppet/functions/floor.rb +3 -2
  197. data/lib/puppet/functions/get.rb +4 -2
  198. data/lib/puppet/functions/getvar.rb +7 -5
  199. data/lib/puppet/functions/group_by.rb +2 -2
  200. data/lib/puppet/functions/hiera.rb +2 -0
  201. data/lib/puppet/functions/hiera_array.rb +2 -0
  202. data/lib/puppet/functions/hiera_hash.rb +2 -0
  203. data/lib/puppet/functions/hiera_include.rb +3 -0
  204. data/lib/puppet/functions/hocon_data.rb +5 -5
  205. data/lib/puppet/functions/import.rb +3 -1
  206. data/lib/puppet/functions/include.rb +5 -2
  207. data/lib/puppet/functions/index.rb +5 -4
  208. data/lib/puppet/functions/info.rb +2 -0
  209. data/lib/puppet/functions/inline_epp.rb +2 -1
  210. data/lib/puppet/functions/join.rb +4 -2
  211. data/lib/puppet/functions/json_data.rb +6 -6
  212. data/lib/puppet/functions/keys.rb +2 -0
  213. data/lib/puppet/functions/length.rb +2 -1
  214. data/lib/puppet/functions/lest.rb +2 -0
  215. data/lib/puppet/functions/lookup.rb +12 -12
  216. data/lib/puppet/functions/lstrip.rb +3 -2
  217. data/lib/puppet/functions/map.rb +4 -2
  218. data/lib/puppet/functions/match.rb +8 -5
  219. data/lib/puppet/functions/max.rb +75 -8
  220. data/lib/puppet/functions/min.rb +75 -8
  221. data/lib/puppet/functions/module_directory.rb +2 -0
  222. data/lib/puppet/functions/new.rb +5 -3
  223. data/lib/puppet/functions/next.rb +3 -1
  224. data/lib/puppet/functions/notice.rb +2 -0
  225. data/lib/puppet/functions/reduce.rb +8 -11
  226. data/lib/puppet/functions/regsubst.rb +15 -16
  227. data/lib/puppet/functions/require.rb +7 -3
  228. data/lib/puppet/functions/return.rb +2 -0
  229. data/lib/puppet/functions/reverse_each.rb +2 -0
  230. data/lib/puppet/functions/round.rb +2 -0
  231. data/lib/puppet/functions/rstrip.rb +3 -2
  232. data/lib/puppet/functions/scanf.rb +2 -0
  233. data/lib/puppet/functions/size.rb +2 -2
  234. data/lib/puppet/functions/slice.rb +4 -1
  235. data/lib/puppet/functions/sort.rb +2 -0
  236. data/lib/puppet/functions/split.rb +2 -0
  237. data/lib/puppet/functions/step.rb +2 -0
  238. data/lib/puppet/functions/strftime.rb +5 -3
  239. data/lib/puppet/functions/strip.rb +3 -2
  240. data/lib/puppet/functions/then.rb +3 -0
  241. data/lib/puppet/functions/tree_each.rb +4 -3
  242. data/lib/puppet/functions/type.rb +2 -0
  243. data/lib/puppet/functions/unique.rb +12 -9
  244. data/lib/puppet/functions/unwrap.rb +2 -0
  245. data/lib/puppet/functions/upcase.rb +4 -2
  246. data/lib/puppet/functions/values.rb +2 -0
  247. data/lib/puppet/functions/versioncmp.rb +2 -1
  248. data/lib/puppet/functions/warning.rb +2 -0
  249. data/lib/puppet/functions/with.rb +2 -0
  250. data/lib/puppet/functions/yaml_data.rb +13 -13
  251. data/lib/puppet/functions.rb +57 -61
  252. data/lib/puppet/generate/models/type/property.rb +4 -1
  253. data/lib/puppet/generate/models/type/type.rb +5 -2
  254. data/lib/puppet/generate/type.rb +11 -5
  255. data/lib/puppet/gettext/config.rb +16 -9
  256. data/lib/puppet/gettext/module_translations.rb +2 -1
  257. data/lib/puppet/gettext/stubs.rb +2 -0
  258. data/lib/puppet/graph/key.rb +2 -0
  259. data/lib/puppet/graph/prioritizer.rb +2 -0
  260. data/lib/puppet/graph/rb_tree_map.rb +43 -24
  261. data/lib/puppet/graph/relationship_graph.rb +31 -29
  262. data/lib/puppet/graph/sequential_prioritizer.rb +2 -0
  263. data/lib/puppet/graph/simple_graph.rb +63 -57
  264. data/lib/puppet/graph.rb +2 -0
  265. data/lib/puppet/http/client.rb +10 -6
  266. data/lib/puppet/http/dns.rb +12 -12
  267. data/lib/puppet/http/errors.rb +4 -2
  268. data/lib/puppet/http/external_client.rb +4 -3
  269. data/lib/puppet/http/factory.rb +3 -1
  270. data/lib/puppet/http/pool.rb +3 -1
  271. data/lib/puppet/http/pool_entry.rb +2 -0
  272. data/lib/puppet/http/proxy.rb +21 -19
  273. data/lib/puppet/http/redirector.rb +5 -3
  274. data/lib/puppet/http/resolver/server_list.rb +5 -4
  275. data/lib/puppet/http/resolver/settings.rb +2 -1
  276. data/lib/puppet/http/resolver/srv.rb +2 -1
  277. data/lib/puppet/http/resolver.rb +4 -2
  278. data/lib/puppet/http/response.rb +2 -0
  279. data/lib/puppet/http/response_converter.rb +4 -3
  280. data/lib/puppet/http/response_net_http.rb +2 -1
  281. data/lib/puppet/http/retry_after_handler.rb +4 -3
  282. data/lib/puppet/http/service/ca.rb +37 -5
  283. data/lib/puppet/http/service/compiler.rb +13 -10
  284. data/lib/puppet/http/service/file_server.rb +5 -3
  285. data/lib/puppet/http/service/puppetserver.rb +3 -2
  286. data/lib/puppet/http/service/report.rb +5 -7
  287. data/lib/puppet/http/service.rb +17 -22
  288. data/lib/puppet/http/session.rb +6 -4
  289. data/lib/puppet/http/site.rb +3 -1
  290. data/lib/puppet/http.rb +4 -2
  291. data/lib/puppet/indirector/catalog/compiler.rb +81 -80
  292. data/lib/puppet/indirector/catalog/json.rb +2 -0
  293. data/lib/puppet/indirector/catalog/msgpack.rb +2 -0
  294. data/lib/puppet/indirector/catalog/rest.rb +2 -0
  295. data/lib/puppet/indirector/catalog/store_configs.rb +3 -3
  296. data/lib/puppet/indirector/catalog/yaml.rb +2 -0
  297. data/lib/puppet/indirector/code.rb +2 -0
  298. data/lib/puppet/indirector/data_binding/hiera.rb +2 -1
  299. data/lib/puppet/indirector/data_binding/none.rb +2 -0
  300. data/lib/puppet/indirector/direct_file_server.rb +4 -1
  301. data/lib/puppet/indirector/envelope.rb +2 -0
  302. data/lib/puppet/indirector/errors.rb +2 -0
  303. data/lib/puppet/indirector/exec.rb +5 -3
  304. data/lib/puppet/indirector/face.rb +17 -28
  305. data/lib/puppet/indirector/fact_search.rb +4 -2
  306. data/lib/puppet/indirector/facts/facter.rb +10 -7
  307. data/lib/puppet/indirector/facts/json.rb +4 -2
  308. data/lib/puppet/indirector/facts/memory.rb +2 -0
  309. data/lib/puppet/indirector/facts/network_device.rb +2 -0
  310. data/lib/puppet/indirector/facts/rest.rb +2 -0
  311. data/lib/puppet/indirector/facts/store_configs.rb +3 -2
  312. data/lib/puppet/indirector/facts/yaml.rb +2 -0
  313. data/lib/puppet/indirector/file_bucket_file/file.rb +33 -27
  314. data/lib/puppet/indirector/file_bucket_file/rest.rb +6 -3
  315. data/lib/puppet/indirector/file_bucket_file/selector.rb +2 -1
  316. data/lib/puppet/indirector/file_content/file.rb +2 -0
  317. data/lib/puppet/indirector/file_content/file_server.rb +2 -0
  318. data/lib/puppet/indirector/file_content/rest.rb +3 -1
  319. data/lib/puppet/indirector/file_content/selector.rb +2 -0
  320. data/lib/puppet/indirector/file_content.rb +2 -0
  321. data/lib/puppet/indirector/file_metadata/file.rb +2 -0
  322. data/lib/puppet/indirector/file_metadata/file_server.rb +2 -0
  323. data/lib/puppet/indirector/file_metadata/http.rb +4 -2
  324. data/lib/puppet/indirector/file_metadata/rest.rb +3 -1
  325. data/lib/puppet/indirector/file_metadata/selector.rb +2 -0
  326. data/lib/puppet/indirector/file_metadata.rb +2 -0
  327. data/lib/puppet/indirector/file_server.rb +3 -0
  328. data/lib/puppet/indirector/generic_http.rb +2 -0
  329. data/lib/puppet/indirector/hiera.rb +8 -7
  330. data/lib/puppet/indirector/indirection.rb +50 -41
  331. data/lib/puppet/indirector/json.rb +9 -6
  332. data/lib/puppet/indirector/memory.rb +5 -2
  333. data/lib/puppet/indirector/msgpack.rb +11 -7
  334. data/lib/puppet/indirector/node/exec.rb +6 -6
  335. data/lib/puppet/indirector/node/json.rb +2 -1
  336. data/lib/puppet/indirector/node/memory.rb +2 -0
  337. data/lib/puppet/indirector/node/msgpack.rb +2 -0
  338. data/lib/puppet/indirector/node/plain.rb +2 -0
  339. data/lib/puppet/indirector/node/rest.rb +2 -0
  340. data/lib/puppet/indirector/node/store_configs.rb +3 -3
  341. data/lib/puppet/indirector/node/yaml.rb +2 -0
  342. data/lib/puppet/indirector/none.rb +3 -2
  343. data/lib/puppet/indirector/plain.rb +2 -0
  344. data/lib/puppet/indirector/report/json.rb +4 -2
  345. data/lib/puppet/indirector/report/msgpack.rb +3 -1
  346. data/lib/puppet/indirector/report/processor.rb +3 -0
  347. data/lib/puppet/indirector/report/rest.rb +2 -13
  348. data/lib/puppet/indirector/report/yaml.rb +4 -2
  349. data/lib/puppet/indirector/request.rb +15 -12
  350. data/lib/puppet/indirector/resource/ral.rb +10 -10
  351. data/lib/puppet/indirector/resource/store_configs.rb +3 -1
  352. data/lib/puppet/indirector/resource/validator.rb +2 -0
  353. data/lib/puppet/indirector/rest.rb +3 -1
  354. data/lib/puppet/indirector/store_configs.rb +2 -0
  355. data/lib/puppet/indirector/terminus.rb +8 -4
  356. data/lib/puppet/indirector/yaml.rb +7 -5
  357. data/lib/puppet/indirector.rb +3 -0
  358. data/lib/puppet/info_service/class_information_service.rb +16 -17
  359. data/lib/puppet/info_service/plan_information_service.rb +5 -3
  360. data/lib/puppet/info_service/task_information_service.rb +10 -9
  361. data/lib/puppet/info_service.rb +1 -0
  362. data/lib/puppet/interface/action.rb +46 -42
  363. data/lib/puppet/interface/action_builder.rb +12 -6
  364. data/lib/puppet/interface/action_manager.rb +9 -6
  365. data/lib/puppet/interface/documentation.rb +40 -34
  366. data/lib/puppet/interface/face_collection.rb +18 -14
  367. data/lib/puppet/interface/option.rb +23 -11
  368. data/lib/puppet/interface/option_builder.rb +14 -9
  369. data/lib/puppet/interface/option_manager.rb +12 -10
  370. data/lib/puppet/interface.rb +9 -8
  371. data/lib/puppet/loaders.rb +2 -1
  372. data/lib/puppet/metatype/manager.rb +16 -15
  373. data/lib/puppet/module/plan.rb +22 -15
  374. data/lib/puppet/module/task.rb +33 -28
  375. data/lib/puppet/module.rb +59 -47
  376. data/lib/puppet/module_tool/applications/application.rb +17 -12
  377. data/lib/puppet/module_tool/applications/checksummer.rb +3 -3
  378. data/lib/puppet/module_tool/applications/installer.rb +78 -87
  379. data/lib/puppet/module_tool/applications/uninstaller.rb +24 -22
  380. data/lib/puppet/module_tool/applications/unpacker.rb +11 -9
  381. data/lib/puppet/module_tool/applications/upgrader.rb +66 -60
  382. data/lib/puppet/module_tool/applications.rb +2 -0
  383. data/lib/puppet/module_tool/checksums.rb +4 -3
  384. data/lib/puppet/module_tool/dependency.rb +5 -4
  385. data/lib/puppet/module_tool/errors/base.rb +3 -1
  386. data/lib/puppet/module_tool/errors/installer.rb +6 -5
  387. data/lib/puppet/module_tool/errors/shared.rb +16 -15
  388. data/lib/puppet/module_tool/errors/uninstaller.rb +3 -2
  389. data/lib/puppet/module_tool/errors/upgrader.rb +4 -3
  390. data/lib/puppet/module_tool/errors.rb +2 -0
  391. data/lib/puppet/module_tool/install_directory.rb +8 -5
  392. data/lib/puppet/module_tool/installed_modules.rb +5 -2
  393. data/lib/puppet/module_tool/local_tarball.rb +10 -8
  394. data/lib/puppet/module_tool/metadata.rb +36 -30
  395. data/lib/puppet/module_tool/shared_behaviors.rb +61 -43
  396. data/lib/puppet/module_tool/tar/gnu.rb +12 -8
  397. data/lib/puppet/module_tool/tar/mini.rb +6 -4
  398. data/lib/puppet/module_tool/tar.rb +4 -2
  399. data/lib/puppet/module_tool.rb +11 -11
  400. data/lib/puppet/network/authconfig.rb +2 -0
  401. data/lib/puppet/network/authorization.rb +2 -0
  402. data/lib/puppet/network/client_request.rb +7 -4
  403. data/lib/puppet/network/format.rb +9 -3
  404. data/lib/puppet/network/format_handler.rb +9 -7
  405. data/lib/puppet/network/format_support.rb +8 -7
  406. data/lib/puppet/network/formats.rb +34 -25
  407. data/lib/puppet/network/http/api/indirected_routes.rb +38 -45
  408. data/lib/puppet/network/http/api/indirection_type.rb +2 -1
  409. data/lib/puppet/network/http/api/master/v3/environments.rb +2 -1
  410. data/lib/puppet/network/http/api/master/v3.rb +2 -1
  411. data/lib/puppet/network/http/api/master.rb +2 -0
  412. data/lib/puppet/network/http/api/server/v3/environments.rb +21 -15
  413. data/lib/puppet/network/http/api/server/v3.rb +14 -13
  414. data/lib/puppet/network/http/api/server.rb +2 -0
  415. data/lib/puppet/network/http/api.rb +20 -18
  416. data/lib/puppet/network/http/connection.rb +6 -4
  417. data/lib/puppet/network/http/error.rb +5 -3
  418. data/lib/puppet/network/http/handler.rb +12 -14
  419. data/lib/puppet/network/http/issues.rb +2 -0
  420. data/lib/puppet/network/http/memory_response.rb +3 -1
  421. data/lib/puppet/network/http/request.rb +22 -10
  422. data/lib/puppet/network/http/response.rb +2 -0
  423. data/lib/puppet/network/http/route.rb +14 -11
  424. data/lib/puppet/network/http.rb +2 -0
  425. data/lib/puppet/network/http_pool.rb +4 -3
  426. data/lib/puppet/network/uri.rb +2 -0
  427. data/lib/puppet/network.rb +2 -0
  428. data/lib/puppet/node/environment.rb +36 -33
  429. data/lib/puppet/node/facts.rb +10 -10
  430. data/lib/puppet/node/server_facts.rb +6 -6
  431. data/lib/puppet/node.rb +12 -12
  432. data/lib/puppet/pal/catalog_compiler.rb +2 -3
  433. data/lib/puppet/pal/compiler.rb +11 -6
  434. data/lib/puppet/pal/function_signature.rb +5 -3
  435. data/lib/puppet/pal/json_catalog_encoder.rb +7 -2
  436. data/lib/puppet/pal/pal_api.rb +2 -0
  437. data/lib/puppet/pal/pal_impl.rb +103 -108
  438. data/lib/puppet/pal/plan_signature.rb +4 -2
  439. data/lib/puppet/pal/script_compiler.rb +4 -2
  440. data/lib/puppet/pal/task_signature.rb +15 -9
  441. data/lib/puppet/parameter/boolean.rb +2 -0
  442. data/lib/puppet/parameter/package_options.rb +3 -1
  443. data/lib/puppet/parameter/path.rb +7 -3
  444. data/lib/puppet/parameter/value.rb +5 -3
  445. data/lib/puppet/parameter/value_collection.rb +17 -16
  446. data/lib/puppet/parameter.rb +17 -16
  447. data/lib/puppet/parser/abstract_compiler.rb +2 -3
  448. data/lib/puppet/parser/ast/block_expression.rb +4 -2
  449. data/lib/puppet/parser/ast/branch.rb +2 -0
  450. data/lib/puppet/parser/ast/hostclass.rb +4 -2
  451. data/lib/puppet/parser/ast/leaf.rb +3 -0
  452. data/lib/puppet/parser/ast/node.rb +2 -0
  453. data/lib/puppet/parser/ast/pops_bridge.rb +13 -13
  454. data/lib/puppet/parser/ast/resource.rb +8 -8
  455. data/lib/puppet/parser/ast/resource_instance.rb +3 -0
  456. data/lib/puppet/parser/ast/resourceparam.rb +9 -7
  457. data/lib/puppet/parser/ast/top_level_construct.rb +2 -0
  458. data/lib/puppet/parser/ast.rb +16 -15
  459. data/lib/puppet/parser/catalog_compiler.rb +3 -3
  460. data/lib/puppet/parser/compiler/catalog_validator/relationship_validator.rb +4 -2
  461. data/lib/puppet/parser/compiler/catalog_validator.rb +2 -0
  462. data/lib/puppet/parser/compiler.rb +45 -44
  463. data/lib/puppet/parser/e4_parser_adapter.rb +17 -16
  464. data/lib/puppet/parser/files.rb +8 -6
  465. data/lib/puppet/parser/functions/assert_type.rb +43 -41
  466. data/lib/puppet/parser/functions/binary_file.rb +16 -14
  467. data/lib/puppet/parser/functions/break.rb +29 -27
  468. data/lib/puppet/parser/functions/contain.rb +3 -1
  469. data/lib/puppet/parser/functions/create_resources.rb +18 -14
  470. data/lib/puppet/parser/functions/defined.rb +104 -102
  471. data/lib/puppet/parser/functions/dig.rb +26 -24
  472. data/lib/puppet/parser/functions/digest.rb +3 -1
  473. data/lib/puppet/parser/functions/each.rb +101 -99
  474. data/lib/puppet/parser/functions/epp.rb +4 -3
  475. data/lib/puppet/parser/functions/fail.rb +11 -9
  476. data/lib/puppet/parser/functions/file.rb +16 -14
  477. data/lib/puppet/parser/functions/filter.rb +57 -55
  478. data/lib/puppet/parser/functions/find_file.rb +19 -18
  479. data/lib/puppet/parser/functions/fqdn_rand.rb +25 -23
  480. data/lib/puppet/parser/functions/generate.rb +23 -21
  481. data/lib/puppet/parser/functions/hiera.rb +95 -93
  482. data/lib/puppet/parser/functions/hiera_array.rb +83 -82
  483. data/lib/puppet/parser/functions/hiera_hash.rb +93 -92
  484. data/lib/puppet/parser/functions/hiera_include.rb +93 -92
  485. data/lib/puppet/parser/functions/include.rb +5 -3
  486. data/lib/puppet/parser/functions/inline_epp.rb +4 -3
  487. data/lib/puppet/parser/functions/inline_template.rb +15 -13
  488. data/lib/puppet/parser/functions/lest.rb +36 -34
  489. data/lib/puppet/parser/functions/lookup.rb +132 -130
  490. data/lib/puppet/parser/functions/map.rb +54 -52
  491. data/lib/puppet/parser/functions/match.rb +31 -29
  492. data/lib/puppet/parser/functions/md5.rb +4 -2
  493. data/lib/puppet/parser/functions/new.rb +916 -915
  494. data/lib/puppet/parser/functions/next.rb +36 -34
  495. data/lib/puppet/parser/functions/realize.rb +13 -11
  496. data/lib/puppet/parser/functions/reduce.rb +134 -132
  497. data/lib/puppet/parser/functions/regsubst.rb +8 -5
  498. data/lib/puppet/parser/functions/require.rb +8 -5
  499. data/lib/puppet/parser/functions/return.rb +90 -88
  500. data/lib/puppet/parser/functions/reverse_each.rb +59 -57
  501. data/lib/puppet/parser/functions/scanf.rb +25 -23
  502. data/lib/puppet/parser/functions/sha1.rb +4 -2
  503. data/lib/puppet/parser/functions/sha256.rb +3 -1
  504. data/lib/puppet/parser/functions/shellquote.rb +2 -0
  505. data/lib/puppet/parser/functions/slice.rb +27 -25
  506. data/lib/puppet/parser/functions/split.rb +7 -6
  507. data/lib/puppet/parser/functions/sprintf.rb +8 -7
  508. data/lib/puppet/parser/functions/step.rb +62 -60
  509. data/lib/puppet/parser/functions/strftime.rb +175 -173
  510. data/lib/puppet/parser/functions/tag.rb +10 -7
  511. data/lib/puppet/parser/functions/tagged.rb +16 -13
  512. data/lib/puppet/parser/functions/template.rb +27 -24
  513. data/lib/puppet/parser/functions/then.rb +54 -52
  514. data/lib/puppet/parser/functions/type.rb +36 -34
  515. data/lib/puppet/parser/functions/versioncmp.rb +3 -2
  516. data/lib/puppet/parser/functions/with.rb +22 -20
  517. data/lib/puppet/parser/functions.rb +12 -9
  518. data/lib/puppet/parser/parser_factory.rb +2 -0
  519. data/lib/puppet/parser/relationship.rb +9 -3
  520. data/lib/puppet/parser/resource/param.rb +4 -2
  521. data/lib/puppet/parser/resource.rb +42 -40
  522. data/lib/puppet/parser/scope.rb +84 -70
  523. data/lib/puppet/parser/script_compiler.rb +12 -12
  524. data/lib/puppet/parser/templatewrapper.rb +3 -2
  525. data/lib/puppet/parser/type_loader.rb +31 -30
  526. data/lib/puppet/parser.rb +3 -1
  527. data/lib/puppet/plugins/configuration.rb +2 -0
  528. data/lib/puppet/plugins/syntax_checkers.rb +2 -1
  529. data/lib/puppet/plugins.rb +3 -1
  530. data/lib/puppet/pops/adaptable.rb +5 -3
  531. data/lib/puppet/pops/adapters.rb +4 -1
  532. data/lib/puppet/pops/evaluator/access_operator.rb +133 -120
  533. data/lib/puppet/pops/evaluator/callable_signature.rb +6 -5
  534. data/lib/puppet/pops/evaluator/closure.rb +272 -277
  535. data/lib/puppet/pops/evaluator/collector_transformer.rb +18 -15
  536. data/lib/puppet/pops/evaluator/collectors/abstract_collector.rb +10 -8
  537. data/lib/puppet/pops/evaluator/collectors/catalog_collector.rb +4 -3
  538. data/lib/puppet/pops/evaluator/collectors/exported_collector.rb +6 -5
  539. data/lib/puppet/pops/evaluator/collectors/fixed_set_collector.rb +10 -10
  540. data/lib/puppet/pops/evaluator/compare_operator.rb +36 -21
  541. data/lib/puppet/pops/evaluator/deferred_resolver.rb +19 -17
  542. data/lib/puppet/pops/evaluator/epp_evaluator.rb +19 -18
  543. data/lib/puppet/pops/evaluator/evaluator_impl.rb +245 -245
  544. data/lib/puppet/pops/evaluator/external_syntax_support.rb +3 -2
  545. data/lib/puppet/pops/evaluator/json_strict_literal_evaluator.rb +6 -5
  546. data/lib/puppet/pops/evaluator/literal_evaluator.rb +5 -5
  547. data/lib/puppet/pops/evaluator/puppet_proc.rb +6 -3
  548. data/lib/puppet/pops/evaluator/relationship_operator.rb +14 -11
  549. data/lib/puppet/pops/evaluator/runtime3_converter.rb +34 -30
  550. data/lib/puppet/pops/evaluator/runtime3_resource_support.rb +35 -35
  551. data/lib/puppet/pops/evaluator/runtime3_support.rb +32 -39
  552. data/lib/puppet/pops/functions/dispatch.rb +7 -7
  553. data/lib/puppet/pops/functions/dispatcher.rb +8 -7
  554. data/lib/puppet/pops/functions/function.rb +18 -20
  555. data/lib/puppet/pops/issue_reporter.rb +25 -22
  556. data/lib/puppet/pops/issues.rb +10 -5
  557. data/lib/puppet/pops/label_provider.rb +6 -4
  558. data/lib/puppet/pops/loader/base_loader.rb +4 -4
  559. data/lib/puppet/pops/loader/dependency_loader.rb +8 -4
  560. data/lib/puppet/pops/loader/gem_support.rb +5 -2
  561. data/lib/puppet/pops/loader/generic_plan_instantiator.rb +2 -0
  562. data/lib/puppet/pops/loader/loader.rb +8 -8
  563. data/lib/puppet/pops/loader/loader_paths.rb +42 -41
  564. data/lib/puppet/pops/loader/module_loaders.rb +45 -49
  565. data/lib/puppet/pops/loader/predefined_loader.rb +3 -3
  566. data/lib/puppet/pops/loader/puppet_function_instantiator.rb +6 -2
  567. data/lib/puppet/pops/loader/puppet_plan_instantiator.rb +6 -2
  568. data/lib/puppet/pops/loader/puppet_resource_type_impl_instantiator.rb +6 -5
  569. data/lib/puppet/pops/loader/ruby_data_type_instantiator.rb +5 -1
  570. data/lib/puppet/pops/loader/ruby_function_instantiator.rb +5 -1
  571. data/lib/puppet/pops/loader/ruby_legacy_function_instantiator.rb +18 -8
  572. data/lib/puppet/pops/loader/runtime3_type_loader.rb +4 -3
  573. data/lib/puppet/pops/loader/simple_environment_loader.rb +3 -3
  574. data/lib/puppet/pops/loader/static_loader.rb +29 -27
  575. data/lib/puppet/pops/loader/task_instantiator.rb +4 -2
  576. data/lib/puppet/pops/loader/type_definition_instantiator.rb +9 -5
  577. data/lib/puppet/pops/loader/typed_name.rb +4 -2
  578. data/lib/puppet/pops/loader/uri_helper.rb +3 -1
  579. data/lib/puppet/pops/loaders.rb +27 -23
  580. data/lib/puppet/pops/lookup/configured_data_provider.rb +2 -0
  581. data/lib/puppet/pops/lookup/context.rb +32 -23
  582. data/lib/puppet/pops/lookup/data_adapter.rb +2 -0
  583. data/lib/puppet/pops/lookup/data_dig_function_provider.rb +8 -7
  584. data/lib/puppet/pops/lookup/data_hash_function_provider.rb +5 -3
  585. data/lib/puppet/pops/lookup/data_provider.rb +2 -0
  586. data/lib/puppet/pops/lookup/environment_data_provider.rb +2 -0
  587. data/lib/puppet/pops/lookup/explainer.rb +47 -45
  588. data/lib/puppet/pops/lookup/function_provider.rb +8 -6
  589. data/lib/puppet/pops/lookup/global_data_provider.rb +4 -3
  590. data/lib/puppet/pops/lookup/hiera_config.rb +208 -160
  591. data/lib/puppet/pops/lookup/interpolation.rb +21 -10
  592. data/lib/puppet/pops/lookup/invocation.rb +4 -0
  593. data/lib/puppet/pops/lookup/key_recorder.rb +6 -3
  594. data/lib/puppet/pops/lookup/location_resolver.rb +4 -2
  595. data/lib/puppet/pops/lookup/lookup_adapter.rb +39 -34
  596. data/lib/puppet/pops/lookup/lookup_key.rb +3 -1
  597. data/lib/puppet/pops/lookup/lookup_key_function_provider.rb +4 -2
  598. data/lib/puppet/pops/lookup/module_data_provider.rb +12 -9
  599. data/lib/puppet/pops/lookup/sub_lookup.rb +7 -3
  600. data/lib/puppet/pops/lookup.rb +16 -11
  601. data/lib/puppet/pops/merge_strategy.rb +22 -16
  602. data/lib/puppet/pops/migration/migration_checker.rb +8 -5
  603. data/lib/puppet/pops/model/ast.rb +786 -685
  604. data/lib/puppet/pops/model/ast_transformer.rb +18 -18
  605. data/lib/puppet/pops/model/factory.rb +33 -31
  606. data/lib/puppet/pops/model/model_label_provider.rb +5 -2
  607. data/lib/puppet/pops/model/model_tree_dumper.rb +32 -30
  608. data/lib/puppet/pops/model/pn_transformer.rb +5 -6
  609. data/lib/puppet/pops/model/tree_dumper.rb +7 -4
  610. data/lib/puppet/pops/parser/code_merger.rb +3 -3
  611. data/lib/puppet/pops/parser/epp_parser.rb +6 -5
  612. data/lib/puppet/pops/parser/epp_support.rb +10 -9
  613. data/lib/puppet/pops/parser/evaluating_parser.rb +13 -9
  614. data/lib/puppet/pops/parser/heredoc_support.rb +14 -14
  615. data/lib/puppet/pops/parser/interpolation_support.rb +25 -25
  616. data/lib/puppet/pops/parser/lexer2.rb +74 -62
  617. data/lib/puppet/pops/parser/lexer_support.rb +57 -57
  618. data/lib/puppet/pops/parser/locatable.rb +2 -2
  619. data/lib/puppet/pops/parser/locator.rb +47 -43
  620. data/lib/puppet/pops/parser/parser_support.rb +22 -21
  621. data/lib/puppet/pops/parser/pn_parser.rb +10 -9
  622. data/lib/puppet/pops/parser/slurp_support.rb +41 -40
  623. data/lib/puppet/pops/patterns.rb +14 -14
  624. data/lib/puppet/pops/pcore.rb +7 -6
  625. data/lib/puppet/pops/pn.rb +8 -5
  626. data/lib/puppet/pops/puppet_stack.rb +3 -1
  627. data/lib/puppet/pops/resource/param.rb +13 -12
  628. data/lib/puppet/pops/resource/resource_type_impl.rb +47 -45
  629. data/lib/puppet/pops/semantic_error.rb +3 -1
  630. data/lib/puppet/pops/serialization/abstract_reader.rb +6 -4
  631. data/lib/puppet/pops/serialization/abstract_writer.rb +11 -9
  632. data/lib/puppet/pops/serialization/deserializer.rb +3 -0
  633. data/lib/puppet/pops/serialization/extension.rb +8 -0
  634. data/lib/puppet/pops/serialization/from_data_converter.rb +16 -9
  635. data/lib/puppet/pops/serialization/instance_reader.rb +2 -0
  636. data/lib/puppet/pops/serialization/instance_writer.rb +2 -0
  637. data/lib/puppet/pops/serialization/json.rb +9 -5
  638. data/lib/puppet/pops/serialization/json_path.rb +3 -1
  639. data/lib/puppet/pops/serialization/object.rb +6 -3
  640. data/lib/puppet/pops/serialization/serializer.rb +20 -16
  641. data/lib/puppet/pops/serialization/time_factory.rb +2 -1
  642. data/lib/puppet/pops/serialization/to_data_converter.rb +9 -6
  643. data/lib/puppet/pops/serialization/to_stringified_converter.rb +8 -7
  644. data/lib/puppet/pops/serialization.rb +10 -8
  645. data/lib/puppet/pops/time/timespan.rb +33 -21
  646. data/lib/puppet/pops/time/timestamp.rb +12 -5
  647. data/lib/puppet/pops/types/annotatable.rb +3 -2
  648. data/lib/puppet/pops/types/annotation.rb +6 -4
  649. data/lib/puppet/pops/types/class_loader.rb +17 -15
  650. data/lib/puppet/pops/types/implementation_registry.rb +4 -1
  651. data/lib/puppet/pops/types/iterable.rb +24 -14
  652. data/lib/puppet/pops/types/p_binary_type.rb +6 -6
  653. data/lib/puppet/pops/types/p_init_type.rb +15 -12
  654. data/lib/puppet/pops/types/p_meta_type.rb +6 -5
  655. data/lib/puppet/pops/types/p_object_type.rb +104 -79
  656. data/lib/puppet/pops/types/p_object_type_extension.rb +15 -14
  657. data/lib/puppet/pops/types/p_runtime_type.rb +12 -10
  658. data/lib/puppet/pops/types/p_sem_ver_range_type.rb +3 -2
  659. data/lib/puppet/pops/types/p_sem_ver_type.rb +8 -8
  660. data/lib/puppet/pops/types/p_sensitive_type.rb +3 -5
  661. data/lib/puppet/pops/types/p_timespan_type.rb +7 -5
  662. data/lib/puppet/pops/types/p_timestamp_type.rb +4 -3
  663. data/lib/puppet/pops/types/p_type_set_type.rb +51 -44
  664. data/lib/puppet/pops/types/p_uri_type.rb +41 -33
  665. data/lib/puppet/pops/types/puppet_object.rb +2 -1
  666. data/lib/puppet/pops/types/recursion_guard.rb +12 -6
  667. data/lib/puppet/pops/types/ruby_generator.rb +19 -14
  668. data/lib/puppet/pops/types/ruby_method.rb +8 -7
  669. data/lib/puppet/pops/types/string_converter.rb +113 -103
  670. data/lib/puppet/pops/types/tree_iterators.rb +16 -20
  671. data/lib/puppet/pops/types/type_acceptor.rb +2 -0
  672. data/lib/puppet/pops/types/type_asserter.rb +5 -3
  673. data/lib/puppet/pops/types/type_assertion_error.rb +1 -1
  674. data/lib/puppet/pops/types/type_calculator.rb +56 -49
  675. data/lib/puppet/pops/types/type_conversion_error.rb +2 -10
  676. data/lib/puppet/pops/types/type_factory.rb +25 -16
  677. data/lib/puppet/pops/types/type_formatter.rb +60 -65
  678. data/lib/puppet/pops/types/type_mismatch_describer.rb +62 -53
  679. data/lib/puppet/pops/types/type_parser.rb +124 -117
  680. data/lib/puppet/pops/types/type_set_reference.rb +3 -0
  681. data/lib/puppet/pops/types/type_with_members.rb +2 -2
  682. data/lib/puppet/pops/types/types.rb +267 -249
  683. data/lib/puppet/pops/utils.rb +43 -45
  684. data/lib/puppet/pops/validation/checker4_0.rb +65 -58
  685. data/lib/puppet/pops/validation/tasks_checker.rb +7 -5
  686. data/lib/puppet/pops/validation/validator_factory_4_0.rb +2 -2
  687. data/lib/puppet/pops/validation.rb +26 -23
  688. data/lib/puppet/pops/visitable.rb +2 -0
  689. data/lib/puppet/pops/visitor.rb +18 -4
  690. data/lib/puppet/pops.rb +6 -3
  691. data/lib/puppet/property/boolean.rb +2 -0
  692. data/lib/puppet/property/ensure.rb +17 -16
  693. data/lib/puppet/property/keyvalue.rb +15 -14
  694. data/lib/puppet/property/list.rb +10 -9
  695. data/lib/puppet/property/ordered_list.rb +6 -5
  696. data/lib/puppet/property.rb +47 -48
  697. data/lib/puppet/provider/aix_object.rb +15 -9
  698. data/lib/puppet/provider/command.rb +2 -0
  699. data/lib/puppet/provider/confine.rb +2 -0
  700. data/lib/puppet/provider/exec/posix.rb +4 -1
  701. data/lib/puppet/provider/exec/shell.rb +2 -0
  702. data/lib/puppet/provider/exec/windows.rb +6 -4
  703. data/lib/puppet/provider/exec.rb +6 -4
  704. data/lib/puppet/provider/file/posix.rb +37 -19
  705. data/lib/puppet/provider/file/windows.rb +28 -29
  706. data/lib/puppet/provider/group/aix.rb +4 -2
  707. data/lib/puppet/provider/group/directoryservice.rb +7 -5
  708. data/lib/puppet/provider/group/groupadd.rb +16 -10
  709. data/lib/puppet/provider/group/ldap.rb +3 -0
  710. data/lib/puppet/provider/group/pw.rb +4 -3
  711. data/lib/puppet/provider/group/windows_adsi.rb +10 -7
  712. data/lib/puppet/provider/ldap.rb +5 -3
  713. data/lib/puppet/provider/nameservice/directoryservice.rb +72 -62
  714. data/lib/puppet/provider/nameservice/objectadd.rb +4 -4
  715. data/lib/puppet/provider/nameservice/pw.rb +8 -8
  716. data/lib/puppet/provider/nameservice.rb +23 -19
  717. data/lib/puppet/provider/network_device.rb +2 -2
  718. data/lib/puppet/provider/package/aix.rb +29 -27
  719. data/lib/puppet/provider/package/appdmg.rb +24 -22
  720. data/lib/puppet/provider/package/apple.rb +7 -5
  721. data/lib/puppet/provider/package/apt.rb +28 -25
  722. data/lib/puppet/provider/package/aptitude.rb +3 -3
  723. data/lib/puppet/provider/package/aptrpm.rb +18 -14
  724. data/lib/puppet/provider/package/blastwave.rb +19 -22
  725. data/lib/puppet/provider/package/dnf.rb +12 -5
  726. data/lib/puppet/provider/package/dnfmodule.rb +17 -15
  727. data/lib/puppet/provider/package/dpkg.rb +24 -25
  728. data/lib/puppet/provider/package/fink.rb +17 -15
  729. data/lib/puppet/provider/package/freebsd.rb +6 -4
  730. data/lib/puppet/provider/package/gem.rb +29 -26
  731. data/lib/puppet/provider/package/hpux.rb +9 -7
  732. data/lib/puppet/provider/package/macports.rb +6 -4
  733. data/lib/puppet/provider/package/nim.rb +27 -28
  734. data/lib/puppet/provider/package/openbsd.rb +37 -34
  735. data/lib/puppet/provider/package/opkg.rb +17 -14
  736. data/lib/puppet/provider/package/pacman.rb +39 -42
  737. data/lib/puppet/provider/package/pip.rb +32 -31
  738. data/lib/puppet/provider/package/pip2.rb +3 -2
  739. data/lib/puppet/provider/package/pip3.rb +3 -2
  740. data/lib/puppet/provider/package/pkg.rb +46 -41
  741. data/lib/puppet/provider/package/pkgdmg.rb +23 -17
  742. data/lib/puppet/provider/package/pkgin.rb +14 -13
  743. data/lib/puppet/provider/package/pkgng.rb +20 -15
  744. data/lib/puppet/provider/package/pkgutil.rb +40 -41
  745. data/lib/puppet/provider/package/portage.rb +73 -69
  746. data/lib/puppet/provider/package/ports.rb +19 -16
  747. data/lib/puppet/provider/package/portupgrade.rb +48 -55
  748. data/lib/puppet/provider/package/puppet_gem.rb +6 -15
  749. data/lib/puppet/provider/package/puppetserver_gem.rb +16 -13
  750. data/lib/puppet/provider/package/rpm.rb +45 -40
  751. data/lib/puppet/provider/package/rug.rb +11 -11
  752. data/lib/puppet/provider/package/sun.rb +28 -24
  753. data/lib/puppet/provider/package/sunfreeware.rb +3 -1
  754. data/lib/puppet/provider/package/tdnf.rb +9 -2
  755. data/lib/puppet/provider/package/up2date.rb +10 -10
  756. data/lib/puppet/provider/package/urpmi.rb +9 -7
  757. data/lib/puppet/provider/package/windows/exe_package.rb +11 -9
  758. data/lib/puppet/provider/package/windows/msi_package.rb +5 -3
  759. data/lib/puppet/provider/package/windows/package.rb +8 -5
  760. data/lib/puppet/provider/package/windows.rb +10 -9
  761. data/lib/puppet/provider/package/xbps.rb +127 -0
  762. data/lib/puppet/provider/package/yum.rb +65 -62
  763. data/lib/puppet/provider/package/zypper.rb +29 -29
  764. data/lib/puppet/provider/package.rb +9 -7
  765. data/lib/puppet/provider/package_targetable.rb +5 -3
  766. data/lib/puppet/provider/parsedfile.rb +21 -17
  767. data/lib/puppet/provider/service/base.rb +19 -23
  768. data/lib/puppet/provider/service/bsd.rb +7 -5
  769. data/lib/puppet/provider/service/daemontools.rb +42 -39
  770. data/lib/puppet/provider/service/debian.rb +12 -10
  771. data/lib/puppet/provider/service/freebsd.rb +50 -52
  772. data/lib/puppet/provider/service/gentoo.rb +11 -9
  773. data/lib/puppet/provider/service/init.rb +33 -31
  774. data/lib/puppet/provider/service/launchd.rb +38 -31
  775. data/lib/puppet/provider/service/openbsd.rb +17 -16
  776. data/lib/puppet/provider/service/openrc.rb +6 -5
  777. data/lib/puppet/provider/service/openwrt.rb +7 -6
  778. data/lib/puppet/provider/service/rcng.rb +7 -5
  779. data/lib/puppet/provider/service/redhat.rb +10 -7
  780. data/lib/puppet/provider/service/runit.rb +16 -15
  781. data/lib/puppet/provider/service/service.rb +7 -8
  782. data/lib/puppet/provider/service/smf.rb +42 -37
  783. data/lib/puppet/provider/service/src.rb +29 -29
  784. data/lib/puppet/provider/service/systemd.rb +48 -48
  785. data/lib/puppet/provider/service/upstart.rb +37 -37
  786. data/lib/puppet/provider/service/windows.rb +45 -48
  787. data/lib/puppet/provider/user/aix.rb +24 -20
  788. data/lib/puppet/provider/user/directoryservice.rb +98 -91
  789. data/lib/puppet/provider/user/hpux.rb +33 -35
  790. data/lib/puppet/provider/user/ldap.rb +13 -10
  791. data/lib/puppet/provider/user/openbsd.rb +24 -22
  792. data/lib/puppet/provider/user/pw.rb +8 -7
  793. data/lib/puppet/provider/user/user_role_add.rb +40 -36
  794. data/lib/puppet/provider/user/useradd.rb +64 -53
  795. data/lib/puppet/provider/user/windows_adsi.rb +14 -10
  796. data/lib/puppet/provider.rb +20 -19
  797. data/lib/puppet/reference/configuration.rb +55 -47
  798. data/lib/puppet/reference/function.rb +2 -0
  799. data/lib/puppet/reference/indirection.rb +33 -28
  800. data/lib/puppet/reference/metaparameter.rb +3 -1
  801. data/lib/puppet/reference/providers.rb +12 -10
  802. data/lib/puppet/reference/report.rb +2 -0
  803. data/lib/puppet/reference/type.rb +7 -5
  804. data/lib/puppet/relationship.rb +10 -9
  805. data/lib/puppet/reports/http.rb +3 -2
  806. data/lib/puppet/reports/log.rb +4 -3
  807. data/lib/puppet/reports/store.rb +9 -6
  808. data/lib/puppet/reports.rb +8 -6
  809. data/lib/puppet/resource/catalog.rb +54 -53
  810. data/lib/puppet/resource/status.rb +9 -7
  811. data/lib/puppet/resource/type.rb +65 -41
  812. data/lib/puppet/resource/type_collection.rb +10 -6
  813. data/lib/puppet/resource.rb +91 -81
  814. data/lib/puppet/runtime.rb +2 -0
  815. data/lib/puppet/scheduler/job.rb +2 -0
  816. data/lib/puppet/scheduler/scheduler.rb +4 -2
  817. data/lib/puppet/scheduler/splay_job.rb +16 -3
  818. data/lib/puppet/scheduler/timer.rb +2 -0
  819. data/lib/puppet/scheduler.rb +3 -1
  820. data/lib/puppet/settings/alias_setting.rb +5 -5
  821. data/lib/puppet/settings/array_setting.rb +2 -1
  822. data/lib/puppet/settings/autosign_setting.rb +2 -1
  823. data/lib/puppet/settings/base_setting.rb +23 -18
  824. data/lib/puppet/settings/boolean_setting.rb +5 -3
  825. data/lib/puppet/settings/certificate_revocation_setting.rb +2 -1
  826. data/lib/puppet/settings/config_file.rb +11 -9
  827. data/lib/puppet/settings/directory_setting.rb +2 -0
  828. data/lib/puppet/settings/duration_setting.rb +5 -4
  829. data/lib/puppet/settings/enum_setting.rb +3 -1
  830. data/lib/puppet/settings/environment_conf.rb +19 -15
  831. data/lib/puppet/settings/errors.rb +6 -3
  832. data/lib/puppet/settings/file_or_directory_setting.rb +4 -7
  833. data/lib/puppet/settings/file_setting.rb +15 -24
  834. data/lib/puppet/settings/http_extra_headers_setting.rb +2 -1
  835. data/lib/puppet/settings/ini_file.rb +5 -3
  836. data/lib/puppet/settings/integer_setting.rb +3 -1
  837. data/lib/puppet/settings/path_setting.rb +2 -0
  838. data/lib/puppet/settings/port_setting.rb +4 -2
  839. data/lib/puppet/settings/priority_setting.rb +13 -12
  840. data/lib/puppet/settings/server_list_setting.rb +7 -6
  841. data/lib/puppet/settings/string_setting.rb +2 -0
  842. data/lib/puppet/settings/symbolic_enum_setting.rb +3 -1
  843. data/lib/puppet/settings/terminus_setting.rb +2 -0
  844. data/lib/puppet/settings/ttl_setting.rb +7 -5
  845. data/lib/puppet/settings/value_translator.rb +9 -7
  846. data/lib/puppet/settings.rb +171 -163
  847. data/lib/puppet/ssl/base.rb +9 -6
  848. data/lib/puppet/ssl/certificate.rb +6 -4
  849. data/lib/puppet/ssl/certificate_request.rb +34 -38
  850. data/lib/puppet/ssl/certificate_request_attributes.rb +7 -4
  851. data/lib/puppet/ssl/certificate_signer.rb +3 -3
  852. data/lib/puppet/ssl/digest.rb +2 -0
  853. data/lib/puppet/ssl/error.rb +3 -0
  854. data/lib/puppet/ssl/oids.rb +11 -9
  855. data/lib/puppet/ssl/openssl_loader.rb +6 -4
  856. data/lib/puppet/ssl/ssl_context.rb +2 -0
  857. data/lib/puppet/ssl/ssl_provider.rb +13 -9
  858. data/lib/puppet/ssl/state_machine.rb +153 -22
  859. data/lib/puppet/ssl/verifier.rb +3 -2
  860. data/lib/puppet/ssl.rb +3 -1
  861. data/lib/puppet/syntax_checkers/base64.rb +7 -5
  862. data/lib/puppet/syntax_checkers/epp.rb +7 -6
  863. data/lib/puppet/syntax_checkers/json.rb +7 -7
  864. data/lib/puppet/syntax_checkers/pp.rb +7 -6
  865. data/lib/puppet/syntax_checkers.rb +3 -1
  866. data/lib/puppet/test/test_helper.rb +30 -44
  867. data/lib/puppet/thread_local.rb +2 -0
  868. data/lib/puppet/transaction/additional_resource_generator.rb +12 -7
  869. data/lib/puppet/transaction/event.rb +8 -5
  870. data/lib/puppet/transaction/event_manager.rb +12 -11
  871. data/lib/puppet/transaction/persistence.rb +16 -16
  872. data/lib/puppet/transaction/report.rb +34 -27
  873. data/lib/puppet/transaction/resource_harness.rb +17 -9
  874. data/lib/puppet/transaction.rb +37 -35
  875. data/lib/puppet/trusted_external.rb +10 -5
  876. data/lib/puppet/type/component.rb +14 -7
  877. data/lib/puppet/type/exec.rb +71 -61
  878. data/lib/puppet/type/file/checksum.rb +6 -2
  879. data/lib/puppet/type/file/checksum_value.rb +6 -4
  880. data/lib/puppet/type/file/content.rb +24 -20
  881. data/lib/puppet/type/file/ctime.rb +5 -4
  882. data/lib/puppet/type/file/data_sync.rb +9 -6
  883. data/lib/puppet/type/file/ensure.rb +24 -25
  884. data/lib/puppet/type/file/group.rb +3 -1
  885. data/lib/puppet/type/file/mode.rb +14 -11
  886. data/lib/puppet/type/file/mtime.rb +5 -3
  887. data/lib/puppet/type/file/owner.rb +3 -2
  888. data/lib/puppet/type/file/selcontext.rb +24 -23
  889. data/lib/puppet/type/file/source.rb +31 -30
  890. data/lib/puppet/type/file/target.rb +23 -25
  891. data/lib/puppet/type/file/type.rb +3 -2
  892. data/lib/puppet/type/file.rb +60 -54
  893. data/lib/puppet/type/filebucket.rb +6 -4
  894. data/lib/puppet/type/group.rb +14 -13
  895. data/lib/puppet/type/notify.rb +4 -3
  896. data/lib/puppet/type/package.rb +47 -45
  897. data/lib/puppet/type/resources.rb +39 -34
  898. data/lib/puppet/type/schedule.rb +21 -21
  899. data/lib/puppet/type/service.rb +19 -18
  900. data/lib/puppet/type/stage.rb +2 -0
  901. data/lib/puppet/type/tidy.rb +40 -34
  902. data/lib/puppet/type/user.rb +62 -56
  903. data/lib/puppet/type/whit.rb +2 -1
  904. data/lib/puppet/type.rb +180 -227
  905. data/lib/puppet/util/at_fork/noop.rb +2 -0
  906. data/lib/puppet/util/at_fork/solaris.rb +37 -39
  907. data/lib/puppet/util/at_fork.rb +3 -1
  908. data/lib/puppet/util/autoload.rb +10 -4
  909. data/lib/puppet/util/backups.rb +13 -11
  910. data/lib/puppet/util/character_encoding.rb +9 -6
  911. data/lib/puppet/util/checksums.rb +16 -12
  912. data/lib/puppet/util/classgen.rb +18 -23
  913. data/lib/puppet/util/colors.rb +67 -65
  914. data/lib/puppet/util/command_line/puppet_option_parser.rb +18 -16
  915. data/lib/puppet/util/command_line/trollop.rb +695 -673
  916. data/lib/puppet/util/command_line.rb +7 -5
  917. data/lib/puppet/util/constant_inflector.rb +4 -3
  918. data/lib/puppet/util/diff.rb +17 -18
  919. data/lib/puppet/util/docs.rb +8 -4
  920. data/lib/puppet/util/errors.rb +13 -11
  921. data/lib/puppet/util/execution.rb +58 -36
  922. data/lib/puppet/util/execution_stub.rb +2 -0
  923. data/lib/puppet/util/feature.rb +9 -9
  924. data/lib/puppet/util/file_watcher.rb +3 -0
  925. data/lib/puppet/util/fileparsing.rb +20 -24
  926. data/lib/puppet/util/filetype.rb +43 -43
  927. data/lib/puppet/util/http_proxy.rb +2 -0
  928. data/lib/puppet/util/inifile.rb +13 -18
  929. data/lib/puppet/util/instance_loader.rb +3 -0
  930. data/lib/puppet/util/json.rb +2 -0
  931. data/lib/puppet/util/json_lockfile.rb +4 -1
  932. data/lib/puppet/util/ldap/connection.rb +21 -19
  933. data/lib/puppet/util/ldap/generator.rb +2 -0
  934. data/lib/puppet/util/ldap/manager.rb +20 -21
  935. data/lib/puppet/util/ldap.rb +2 -0
  936. data/lib/puppet/util/libuser.rb +3 -2
  937. data/lib/puppet/util/limits.rb +2 -0
  938. data/lib/puppet/util/lockfile.rb +8 -8
  939. data/lib/puppet/util/log/destination.rb +4 -3
  940. data/lib/puppet/util/log/destinations.rb +20 -20
  941. data/lib/puppet/util/log.rb +40 -31
  942. data/lib/puppet/util/logging.rb +34 -30
  943. data/lib/puppet/util/metaid.rb +2 -1
  944. data/lib/puppet/util/metric.rb +9 -6
  945. data/lib/puppet/util/monkey_patches.rb +22 -30
  946. data/lib/puppet/util/multi_match.rb +9 -5
  947. data/lib/puppet/util/network_device/base.rb +3 -2
  948. data/lib/puppet/util/network_device/config.rb +9 -9
  949. data/lib/puppet/util/network_device/transport/base.rb +1 -1
  950. data/lib/puppet/util/network_device/transport.rb +2 -0
  951. data/lib/puppet/util/network_device.rb +2 -0
  952. data/lib/puppet/util/package/version/debian.rb +33 -31
  953. data/lib/puppet/util/package/version/gem.rb +3 -0
  954. data/lib/puppet/util/package/version/pip.rb +14 -8
  955. data/lib/puppet/util/package/version/range/eq.rb +4 -1
  956. data/lib/puppet/util/package/version/range/gt.rb +3 -0
  957. data/lib/puppet/util/package/version/range/gt_eq.rb +3 -0
  958. data/lib/puppet/util/package/version/range/lt.rb +4 -1
  959. data/lib/puppet/util/package/version/range/lt_eq.rb +3 -0
  960. data/lib/puppet/util/package/version/range/min_max.rb +5 -0
  961. data/lib/puppet/util/package/version/range/simple.rb +2 -0
  962. data/lib/puppet/util/package/version/range.rb +9 -5
  963. data/lib/puppet/util/package/version/rpm.rb +7 -5
  964. data/lib/puppet/util/package.rb +5 -2
  965. data/lib/puppet/util/pidlock.rb +11 -10
  966. data/lib/puppet/util/platform.rb +5 -3
  967. data/lib/puppet/util/plist.rb +16 -16
  968. data/lib/puppet/util/posix.rb +27 -24
  969. data/lib/puppet/util/profiler/aggregate.rb +7 -10
  970. data/lib/puppet/util/profiler/around_profiler.rb +2 -1
  971. data/lib/puppet/util/profiler/logging.rb +3 -1
  972. data/lib/puppet/util/profiler/object_counts.rb +2 -0
  973. data/lib/puppet/util/profiler/wall_clock.rb +6 -5
  974. data/lib/puppet/util/profiler.rb +2 -0
  975. data/lib/puppet/util/provider_features.rb +10 -6
  976. data/lib/puppet/util/psych_support.rb +2 -0
  977. data/lib/puppet/util/rdoc/code_objects.rb +18 -20
  978. data/lib/puppet/util/rdoc/generators/puppet_generator.rb +118 -128
  979. data/lib/puppet/util/rdoc/generators/template/puppet/puppet.rb +62 -79
  980. data/lib/puppet/util/rdoc/parser/puppet_parser_core.rb +32 -29
  981. data/lib/puppet/util/rdoc/parser/puppet_parser_rdoc2.rb +3 -1
  982. data/lib/puppet/util/rdoc/parser.rb +3 -1
  983. data/lib/puppet/util/rdoc.rb +10 -9
  984. data/lib/puppet/util/reference.rb +7 -32
  985. data/lib/puppet/util/resource_template.rb +3 -1
  986. data/lib/puppet/util/retry_action.rb +6 -5
  987. data/lib/puppet/util/rpm_compare.rb +31 -28
  988. data/lib/puppet/util/rubygems.rb +3 -3
  989. data/lib/puppet/util/run_mode.rb +46 -4
  990. data/lib/puppet/util/selinux.rb +72 -38
  991. data/lib/puppet/util/skip_tags.rb +2 -0
  992. data/lib/puppet/util/splayer.rb +2 -0
  993. data/lib/puppet/util/storage.rb +13 -13
  994. data/lib/puppet/util/suidmanager.rb +38 -37
  995. data/lib/puppet/util/symbolic_file_mode.rb +76 -76
  996. data/lib/puppet/util/tag_set.rb +4 -2
  997. data/lib/puppet/util/tagging.rb +12 -13
  998. data/lib/puppet/util/terminal.rb +6 -4
  999. data/lib/puppet/util/user_attr.rb +9 -7
  1000. data/lib/puppet/util/warnings.rb +4 -0
  1001. data/lib/puppet/util/watched_file.rb +4 -1
  1002. data/lib/puppet/util/watcher/change_watcher.rb +2 -0
  1003. data/lib/puppet/util/watcher/periodic_watcher.rb +2 -1
  1004. data/lib/puppet/util/watcher/timer.rb +2 -0
  1005. data/lib/puppet/util/watcher.rb +5 -5
  1006. data/lib/puppet/util/windows/access_control_entry.rb +3 -1
  1007. data/lib/puppet/util/windows/access_control_list.rb +10 -7
  1008. data/lib/puppet/util/windows/adsi.rb +82 -74
  1009. data/lib/puppet/util/windows/com.rb +10 -7
  1010. data/lib/puppet/util/windows/daemon.rb +77 -80
  1011. data/lib/puppet/util/windows/error.rb +7 -5
  1012. data/lib/puppet/util/windows/eventlog.rb +13 -9
  1013. data/lib/puppet/util/windows/file.rb +49 -45
  1014. data/lib/puppet/util/windows/monkey_patches/process.rb +2 -3
  1015. data/lib/puppet/util/windows/principal.rb +37 -34
  1016. data/lib/puppet/util/windows/process.rb +36 -40
  1017. data/lib/puppet/util/windows/registry.rb +60 -58
  1018. data/lib/puppet/util/windows/root_certs.rb +5 -3
  1019. data/lib/puppet/util/windows/security.rb +92 -90
  1020. data/lib/puppet/util/windows/security_descriptor.rb +2 -0
  1021. data/lib/puppet/util/windows/service.rb +24 -12
  1022. data/lib/puppet/util/windows/sid.rb +23 -21
  1023. data/lib/puppet/util/windows/string.rb +2 -0
  1024. data/lib/puppet/util/windows/user.rb +56 -55
  1025. data/lib/puppet/util/windows.rb +8 -1
  1026. data/lib/puppet/util/yaml.rb +3 -1
  1027. data/lib/puppet/util.rb +112 -161
  1028. data/lib/puppet/vendor.rb +3 -1
  1029. data/lib/puppet/version.rb +5 -2
  1030. data/lib/puppet/x509/cert_provider.rb +48 -12
  1031. data/lib/puppet/x509/pem_store.rb +3 -1
  1032. data/lib/puppet/x509.rb +2 -0
  1033. data/lib/puppet.rb +22 -19
  1034. data/lib/puppet_pal.rb +2 -0
  1035. data/lib/puppet_x.rb +2 -0
  1036. data/locales/puppet.pot +9723 -5
  1037. data/man/man5/puppet.conf.5 +121 -912
  1038. data/man/man8/puppet-agent.8 +39 -107
  1039. data/man/man8/puppet-apply.8 +18 -51
  1040. data/man/man8/puppet-catalog.8 +25 -122
  1041. data/man/man8/puppet-config.8 +22 -70
  1042. data/man/man8/puppet-describe.8 +6 -22
  1043. data/man/man8/puppet-device.8 +13 -49
  1044. data/man/man8/puppet-doc.8 +8 -24
  1045. data/man/man8/puppet-epp.8 +23 -168
  1046. data/man/man8/puppet-facts.8 +14 -92
  1047. data/man/man8/puppet-filebucket.8 +22 -54
  1048. data/man/man8/puppet-generate.8 +5 -35
  1049. data/man/man8/puppet-help.8 +8 -29
  1050. data/man/man8/puppet-lookup.8 +25 -61
  1051. data/man/man8/puppet-module.8 +19 -124
  1052. data/man/man8/puppet-node.8 +47 -68
  1053. data/man/man8/puppet-parser.8 +12 -55
  1054. data/man/man8/puppet-plugin.8 +10 -33
  1055. data/man/man8/puppet-report.8 +10 -53
  1056. data/man/man8/puppet-resource.8 +19 -44
  1057. data/man/man8/puppet-script.8 +11 -33
  1058. data/man/man8/puppet-ssl.8 +12 -30
  1059. data/man/man8/puppet.8 +90 -20
  1060. data/tasks/tag.rake +34 -0
  1061. metadata +77 -65
  1062. data/CONTRIBUTING.md +0 -161
  1063. data/examples/hiera/etc/hiera.yaml +0 -15
  1064. data/examples/hiera/etc/hieradb/common.yaml +0 -3
  1065. data/examples/hiera/etc/hieradb/dc1.yaml +0 -6
  1066. data/examples/hiera/etc/hieradb/development.yaml +0 -2
  1067. data/examples/hiera/etc/puppet.conf +0 -3
  1068. data/examples/hiera/modules/data/manifests/common.pp +0 -4
  1069. data/examples/hiera/modules/ntp/manifests/data.pp +0 -4
  1070. data/examples/hiera/modules/ntp/templates/ntp.conf.erb +0 -3
  1071. data/examples/hiera/modules/users/manifests/development.pp +0 -4
  1072. data/lib/puppet/external/pson/common.rb +0 -374
  1073. data/lib/puppet/external/pson/pure/generator.rb +0 -395
  1074. data/lib/puppet/external/pson/pure/parser.rb +0 -308
  1075. data/lib/puppet/external/pson/pure.rb +0 -15
  1076. data/lib/puppet/external/pson/version.rb +0 -8
  1077. data/lib/puppet/module_tool/contents_description.rb +0 -89
  1078. data/tasks/benchmark.rake +0 -180
  1079. data/tasks/ci.rake +0 -24
  1080. data/tasks/generate_ast_model.rake +0 -90
  1081. data/tasks/generate_cert_fixtures.rake +0 -194
  1082. data/tasks/manpages.rake +0 -67
  1083. data/tasks/memwalk.rake +0 -195
  1084. data/tasks/parallel.rake +0 -410
  1085. data/tasks/parser.rake +0 -22
  1086. data/tasks/yard.rake +0 -59
@@ -1,991 +1,992 @@
1
- Puppet::Parser::Functions::newfunction(
1
+ # frozen_string_literal: true
2
+
3
+ Puppet::Parser::Functions.newfunction(
2
4
  :new,
3
5
  :type => :rvalue,
4
6
  :arity => -1,
5
- :doc => <<-DOC
6
- Creates a new instance/object of a given data type.
7
+ :doc => <<~DOC
8
+ Creates a new instance/object of a given data type.
7
9
 
8
- This function makes it possible to create new instances of
9
- concrete data types. If a block is given it is called with the
10
- just created instance as an argument.
10
+ This function makes it possible to create new instances of
11
+ concrete data types. If a block is given it is called with the
12
+ just created instance as an argument.
11
13
 
12
- Calling this function is equivalent to directly
13
- calling the data type:
14
+ Calling this function is equivalent to directly
15
+ calling the data type:
14
16
 
15
- **Example:** `new` and calling type directly are equivalent
17
+ **Example:** `new` and calling type directly are equivalent
16
18
 
17
- ```puppet
18
- $a = Integer.new("42")
19
- $b = Integer("42")
20
- ```
19
+ ```puppet
20
+ $a = Integer.new("42")
21
+ $b = Integer("42")
22
+ ```
21
23
 
22
- These would both convert the string `"42"` to the decimal value `42`.
24
+ These would both convert the string `"42"` to the decimal value `42`.
23
25
 
24
- **Example:** arguments by position or by name
26
+ **Example:** arguments by position or by name
25
27
 
26
- ```puppet
27
- $a = Integer.new("42", 8)
28
- $b = Integer({from => "42", radix => 8})
29
- ```
28
+ ```puppet
29
+ $a = Integer.new("42", 8)
30
+ $b = Integer({from => "42", radix => 8})
31
+ ```
30
32
 
31
- This would convert the octal (radix 8) number `"42"` in string form
32
- to the decimal value `34`.
33
+ This would convert the octal (radix 8) number `"42"` in string form
34
+ to the decimal value `34`.
33
35
 
34
- The new function supports two ways of giving the arguments:
36
+ The new function supports two ways of giving the arguments:
35
37
 
36
- * by name (using a hash with property to value mapping)
37
- * by position (as regular arguments)
38
+ * by name (using a hash with property to value mapping)
39
+ * by position (as regular arguments)
38
40
 
39
- Note that it is not possible to create new instances of
40
- some abstract data types (for example `Variant`). The data type `Optional[T]` is an
41
- exception as it will create an instance of `T` or `undef` if the
42
- value to convert is `undef`.
41
+ Note that it is not possible to create new instances of
42
+ some abstract data types (for example `Variant`). The data type `Optional[T]` is an
43
+ exception as it will create an instance of `T` or `undef` if the
44
+ value to convert is `undef`.
43
45
 
44
- The arguments that can be given is determined by the data type.
46
+ The arguments that can be given is determined by the data type.
45
47
 
46
- > An assertion is always made that the produced value complies with the given type constraints.
48
+ > An assertion is always made that the produced value complies with the given type constraints.
47
49
 
48
- **Example:** data type constraints are checked
50
+ **Example:** data type constraints are checked
49
51
 
50
- ```puppet
51
- Integer[0].new("-100")
52
- ```
52
+ ```puppet
53
+ Integer[0].new("-100")
54
+ ```
53
55
 
54
- Would fail with an assertion error (since value is less than 0).
56
+ Would fail with an assertion error (since value is less than 0).
55
57
 
56
- The following sections show the arguments and conversion rules
57
- per data type built into the Puppet Type System.
58
-
59
- ### Conversion to Optional[T] and NotUndef[T]
60
-
61
- Conversion to these data types is the same as a conversion to the type argument `T`.
62
- In the case of `Optional[T]` it is accepted that the argument to convert may be `undef`.
63
- It is however not acceptable to give other arguments (than `undef`) that cannot be
64
- converted to `T`.
58
+ The following sections show the arguments and conversion rules
59
+ per data type built into the Puppet Type System.
60
+
61
+ ### Conversion to Optional[T] and NotUndef[T]
62
+
63
+ Conversion to these data types is the same as a conversion to the type argument `T`.
64
+ In the case of `Optional[T]` it is accepted that the argument to convert may be `undef`.
65
+ It is however not acceptable to give other arguments (than `undef`) that cannot be
66
+ converted to `T`.
65
67
 
66
- ### Conversion to Integer
68
+ ### Conversion to Integer
67
69
 
68
- A new `Integer` can be created from `Integer`, `Float`, `Boolean`, and `String` values.
69
- For conversion from `String` it is possible to specify the radix (base).
70
+ A new `Integer` can be created from `Integer`, `Float`, `Boolean`, and `String` values.
71
+ For conversion from `String` it is possible to specify the radix (base).
70
72
 
71
- ```puppet
72
- type Radix = Variant[Default, Integer[2,2], Integer[8,8], Integer[10,10], Integer[16,16]]
73
+ ```puppet
74
+ type Radix = Variant[Default, Integer[2,2], Integer[8,8], Integer[10,10], Integer[16,16]]
73
75
 
74
- function Integer.new(
75
- String $value,
76
- Radix $radix = 10,
77
- Boolean $abs = false
78
- )
76
+ function Integer.new(
77
+ String $value,
78
+ Radix $radix = 10,
79
+ Boolean $abs = false
80
+ )
79
81
 
80
- function Integer.new(
81
- Variant[Numeric, Boolean] $value,
82
- Boolean $abs = false
83
- )
84
- ```
82
+ function Integer.new(
83
+ Variant[Numeric, Boolean] $value,
84
+ Boolean $abs = false
85
+ )
86
+ ```
85
87
 
86
- * When converting from `String` the default radix is 10.
87
- * If radix is not specified an attempt is made to detect the radix from the start of the string:
88
- * `0b` or `0B` is taken as radix 2.
89
- * `0x` or `0X` is taken as radix 16.
90
- * `0` as radix 8.
91
- * All others are decimal.
92
- * Conversion from `String` accepts an optional sign in the string.
93
- * For hexadecimal (radix 16) conversion an optional leading "0x", or "0X" is accepted.
94
- * For octal (radix 8) an optional leading "0" is accepted.
95
- * For binary (radix 2) an optional leading "0b" or "0B" is accepted.
96
- * When `radix` is set to `default`, the conversion is based on the leading.
97
- characters in the string. A leading "0" for radix 8, a leading "0x", or "0X" for
98
- radix 16, and leading "0b" or "0B" for binary.
99
- * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
100
- * Conversion from `Integer`, `Float`, and `Boolean` ignores the radix.
101
- * `Float` value fractions are truncated (no rounding).
102
- * When `abs` is set to `true`, the result will be an absolute integer.
103
-
104
- Examples - Converting to Integer:
105
-
106
- ```puppet
107
- $a_number = Integer("0xFF", 16) # results in 255
108
- $a_number = Integer("010") # results in 8
109
- $a_number = Integer("010", 10) # results in 10
110
- $a_number = Integer(true) # results in 1
111
- $a_number = Integer(-38, 10, true) # results in 38
112
- ```
113
-
114
- ### Conversion to Float
115
-
116
- A new `Float` can be created from `Integer`, `Float`, `Boolean`, and `String` values.
117
- For conversion from `String` both float and integer formats are supported.
118
-
119
- ```puppet
120
- function Float.new(
121
- Variant[Numeric, Boolean, String] $value,
122
- Boolean $abs = true
123
- )
124
- ```
125
-
126
- * For an integer, the floating point fraction of `.0` is added to the value.
127
- * A `Boolean` `true` is converted to 1.0, and a `false` to 0.0
128
- * In `String` format, integer prefixes for hex and binary are understood (but not octal since
129
- floating point in string format may start with a '0').
130
- * When `abs` is set to `true`, the result will be an absolute floating point value.
131
-
132
- ### Conversion to Numeric
133
-
134
- A new `Integer` or `Float` can be created from `Integer`, `Float`, `Boolean` and
135
- `String` values.
136
-
137
- ```puppet
138
- function Numeric.new(
139
- Variant[Numeric, Boolean, String] $value,
140
- Boolean $abs = true
141
- )
142
- ```
143
-
144
- * If the value has a decimal period, or if given in scientific notation
145
- (e/E), the result is a `Float`, otherwise the value is an `Integer`. The
146
- conversion from `String` always uses a radix based on the prefix of the string.
147
- * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
148
- * When `abs` is set to `true`, the result will be an absolute `Float`or `Integer` value.
149
-
150
- Examples - Converting to Numeric
151
-
152
- ```puppet
153
- $a_number = Numeric(true) # results in 1
154
- $a_number = Numeric("0xFF") # results in 255
155
- $a_number = Numeric("010") # results in 8
156
- $a_number = Numeric("3.14") # results in 3.14 (a float)
157
- $a_number = Numeric(-42.3, true) # results in 42.3
158
- $a_number = Numeric(-42, true) # results in 42
159
- ```
160
-
161
- ### Conversion to Timespan
162
-
163
- A new `Timespan` can be created from `Integer`, `Float`, `String`, and `Hash` values. Several variants of the constructor are provided.
164
-
165
- #### Timespan from seconds
166
-
167
- When a Float is used, the decimal part represents fractions of a second.
168
-
169
- ```puppet
170
- function Timespan.new(
171
- Variant[Float, Integer] $value
172
- )
173
- ```
174
-
175
- #### Timespan from days, hours, minutes, seconds, and fractions of a second
176
-
177
- The arguments can be passed separately in which case the first four, days, hours, minutes, and seconds are mandatory and the rest are optional.
178
- All values may overflow and/or be negative. The internal 128-bit nano-second integer is calculated as:
179
-
180
- ```
181
- (((((days * 24 + hours) * 60 + minutes) * 60 + seconds) * 1000 + milliseconds) * 1000 + microseconds) * 1000 + nanoseconds
182
- ```
183
-
184
- ```puppet
185
- function Timespan.new(
186
- Integer $days, Integer $hours, Integer $minutes, Integer $seconds,
187
- Integer $milliseconds = 0, Integer $microseconds = 0, Integer $nanoseconds = 0
188
- )
189
- ```
190
-
191
- or, all arguments can be passed as a `Hash`, in which case all entries are optional:
192
-
193
- ```puppet
194
- function Timespan.new(
195
- Struct[{
196
- Optional[negative] => Boolean,
197
- Optional[days] => Integer,
198
- Optional[hours] => Integer,
199
- Optional[minutes] => Integer,
200
- Optional[seconds] => Integer,
201
- Optional[milliseconds] => Integer,
202
- Optional[microseconds] => Integer,
203
- Optional[nanoseconds] => Integer
204
- }] $hash
205
- )
206
- ```
207
-
208
- #### Timespan from String and format directive patterns
209
-
210
- The first argument is parsed using the format optionally passed as a string or array of strings. When an array is used, an attempt
211
- will be made to parse the string using the first entry and then with each entry in succession until parsing succeeds. If the second
212
- argument is omitted, an array of default formats will be used.
213
-
214
- An exception is raised when no format was able to parse the given string.
215
-
216
- ```puppet
217
- function Timespan.new(
218
- String $string, Variant[String[2],Array[String[2], 1]] $format = <default format>)
219
- )
220
- ```
221
-
222
- the arguments may also be passed as a `Hash`:
223
-
224
- ```puppet
225
- function Timespan.new(
226
- Struct[{
227
- string => String[1],
228
- Optional[format] => Variant[String[2],Array[String[2], 1]]
229
- }] $hash
230
- )
231
- ```
232
-
233
- The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
234
- a conversion specifier as follows:
235
- ```
236
- %[Flags][Width]Conversion
237
- ```
238
-
239
- ##### Flags:
240
-
241
- | Flag | Meaning
242
- | ---- | ---------------
243
- | - | Don't pad numerical output
244
- | _ | Use spaces for padding
245
- | 0 | Use zeros for padding
246
-
247
- ##### Format directives:
248
-
249
- | Format | Meaning |
250
- | ------ | ------- |
251
- | D | Number of Days |
252
- | H | Hour of the day, 24-hour clock |
253
- | M | Minute of the hour (00..59) |
254
- | S | Second of the minute (00..59) |
255
- | L | Millisecond of the second (000..999) |
256
- | N | Fractional seconds digits |
257
-
258
- The format directive that represents the highest magnitude in the format will be allowed to
259
- overflow. I.e. if no "%D" is used but a "%H" is present, then the hours may be more than 23.
260
-
261
- The default array contains the following patterns:
262
-
263
- ```
264
- ['%D-%H:%M:%S', '%D-%H:%M', '%H:%M:%S', '%H:%M']
265
- ```
266
-
267
- Examples - Converting to Timespan
268
-
269
- ```puppet
270
- $duration = Timespan(13.5) # 13 seconds and 500 milliseconds
271
- $duration = Timespan({days=>4}) # 4 days
272
- $duration = Timespan(4, 0, 0, 2) # 4 days and 2 seconds
273
- $duration = Timespan('13:20') # 13 hours and 20 minutes (using default pattern)
274
- $duration = Timespan('10:03.5', '%M:%S.%L') # 10 minutes, 3 seconds, and 5 milli-seconds
275
- $duration = Timespan('10:03.5', '%M:%S.%N') # 10 minutes, 3 seconds, and 5 nano-seconds
276
- ```
277
-
278
- ### Conversion to Timestamp
279
-
280
- A new `Timestamp` can be created from `Integer`, `Float`, `String`, and `Hash` values. Several variants of the constructor are provided.
281
-
282
- #### Timestamp from seconds since epoch (1970-01-01 00:00:00 UTC)
283
-
284
- When a Float is used, the decimal part represents fractions of a second.
285
-
286
- ```puppet
287
- function Timestamp.new(
288
- Variant[Float, Integer] $value
289
- )
290
- ```
291
-
292
- #### Timestamp from String and patterns consisting of format directives
293
-
294
- The first argument is parsed using the format optionally passed as a string or array of strings. When an array is used, an attempt
295
- will be made to parse the string using the first entry and then with each entry in succession until parsing succeeds. If the second
296
- argument is omitted, an array of default formats will be used.
297
-
298
- A third optional timezone argument can be provided. The first argument will then be parsed as if it represents a local time in that
299
- timezone. The timezone can be any timezone that is recognized when using the '%z' or '%Z' formats, or the word 'current', in which
300
- case the current timezone of the evaluating process will be used. The timezone argument is case insensitive.
301
-
302
- The default timezone, when no argument is provided, or when using the keyword `default`, is 'UTC'.
303
-
304
- It is illegal to provide a timezone argument other than `default` in combination with a format that contains '%z' or '%Z' since that
305
- would introduce an ambiguity as to which timezone to use. The one extracted from the string, or the one provided as an argument.
306
-
307
- An exception is raised when no format was able to parse the given string.
308
-
309
- ```puppet
310
- function Timestamp.new(
311
- String $string,
312
- Variant[String[2],Array[String[2], 1]] $format = <default format>,
313
- String $timezone = default)
314
- )
315
- ```
316
-
317
- the arguments may also be passed as a `Hash`:
318
-
319
- ```puppet
320
- function Timestamp.new(
321
- Struct[{
322
- string => String[1],
323
- Optional[format] => Variant[String[2],Array[String[2], 1]],
324
- Optional[timezone] => String[1]
325
- }] $hash
326
- )
327
- ```
328
-
329
- The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
330
- a conversion specifier as follows:
331
- ```
332
- %[Flags][Width]Conversion
333
- ```
334
-
335
- ##### Flags:
336
-
337
- | Flag | Meaning
338
- | ---- | ---------------
339
- | - | Don't pad numerical output
340
- | _ | Use spaces for padding
341
- | 0 | Use zeros for padding
342
- | # | Change names to upper-case or change case of am/pm
343
- | ^ | Use uppercase
344
- | : | Use colons for %z
345
-
346
- ##### Format directives (names and padding can be altered using flags):
347
-
348
- **Date (Year, Month, Day):**
349
-
350
- | Format | Meaning |
351
- | ------ | ------- |
352
- | Y | Year with century, zero-padded to at least 4 digits |
353
- | C | year / 100 (rounded down such as 20 in 2009) |
354
- | y | year % 100 (00..99) |
355
- | m | Month of the year, zero-padded (01..12) |
356
- | B | The full month name ("January") |
357
- | b | The abbreviated month name ("Jan") |
358
- | h | Equivalent to %b |
359
- | d | Day of the month, zero-padded (01..31) |
360
- | e | Day of the month, blank-padded ( 1..31) |
361
- | j | Day of the year (001..366) |
362
-
363
- **Time (Hour, Minute, Second, Subsecond):**
364
-
365
- | Format | Meaning |
366
- | ------ | ------- |
367
- | H | Hour of the day, 24-hour clock, zero-padded (00..23) |
368
- | k | Hour of the day, 24-hour clock, blank-padded ( 0..23) |
369
- | I | Hour of the day, 12-hour clock, zero-padded (01..12) |
370
- | l | Hour of the day, 12-hour clock, blank-padded ( 1..12) |
371
- | P | Meridian indicator, lowercase ("am" or "pm") |
372
- | p | Meridian indicator, uppercase ("AM" or "PM") |
373
- | M | Minute of the hour (00..59) |
374
- | S | Second of the minute (00..60) |
375
- | L | Millisecond of the second (000..999). Digits under millisecond are truncated to not produce 1000 |
376
- | N | Fractional seconds digits, default is 9 digits (nanosecond). Digits under a specified width are truncated to avoid carry up |
88
+ * When converting from `String` the default radix is 10.
89
+ * If radix is not specified an attempt is made to detect the radix from the start of the string:
90
+ * `0b` or `0B` is taken as radix 2.
91
+ * `0x` or `0X` is taken as radix 16.
92
+ * `0` as radix 8.
93
+ * All others are decimal.
94
+ * Conversion from `String` accepts an optional sign in the string.
95
+ * For hexadecimal (radix 16) conversion an optional leading "0x", or "0X" is accepted.
96
+ * For octal (radix 8) an optional leading "0" is accepted.
97
+ * For binary (radix 2) an optional leading "0b" or "0B" is accepted.
98
+ * When `radix` is set to `default`, the conversion is based on the leading.
99
+ characters in the string. A leading "0" for radix 8, a leading "0x", or "0X" for
100
+ radix 16, and leading "0b" or "0B" for binary.
101
+ * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
102
+ * Conversion from `Integer`, `Float`, and `Boolean` ignores the radix.
103
+ * `Float` value fractions are truncated (no rounding).
104
+ * When `abs` is set to `true`, the result will be an absolute integer.
105
+
106
+ Examples - Converting to Integer:
107
+
108
+ ```puppet
109
+ $a_number = Integer("0xFF", 16) # results in 255
110
+ $a_number = Integer("010") # results in 8
111
+ $a_number = Integer("010", 10) # results in 10
112
+ $a_number = Integer(true) # results in 1
113
+ $a_number = Integer(-38, 10, true) # results in 38
114
+ ```
115
+
116
+ ### Conversion to Float
117
+
118
+ A new `Float` can be created from `Integer`, `Float`, `Boolean`, and `String` values.
119
+ For conversion from `String` both float and integer formats are supported.
120
+
121
+ ```puppet
122
+ function Float.new(
123
+ Variant[Numeric, Boolean, String] $value,
124
+ Boolean $abs = true
125
+ )
126
+ ```
127
+
128
+ * For an integer, the floating point fraction of `.0` is added to the value.
129
+ * A `Boolean` `true` is converted to 1.0, and a `false` to 0.0
130
+ * In `String` format, integer prefixes for hex and binary are understood (but not octal since
131
+ floating point in string format may start with a '0').
132
+ * When `abs` is set to `true`, the result will be an absolute floating point value.
133
+
134
+ ### Conversion to Numeric
135
+
136
+ A new `Integer` or `Float` can be created from `Integer`, `Float`, `Boolean` and
137
+ `String` values.
138
+
139
+ ```puppet
140
+ function Numeric.new(
141
+ Variant[Numeric, Boolean, String] $value,
142
+ Boolean $abs = true
143
+ )
144
+ ```
145
+
146
+ * If the value has a decimal period, or if given in scientific notation
147
+ (e/E), the result is a `Float`, otherwise the value is an `Integer`. The
148
+ conversion from `String` always uses a radix based on the prefix of the string.
149
+ * Conversion from `Boolean` results in 0 for `false` and 1 for `true`.
150
+ * When `abs` is set to `true`, the result will be an absolute `Float`or `Integer` value.
151
+
152
+ Examples - Converting to Numeric
153
+
154
+ ```puppet
155
+ $a_number = Numeric(true) # results in 1
156
+ $a_number = Numeric("0xFF") # results in 255
157
+ $a_number = Numeric("010") # results in 8
158
+ $a_number = Numeric("3.14") # results in 3.14 (a float)
159
+ $a_number = Numeric(-42.3, true) # results in 42.3
160
+ $a_number = Numeric(-42, true) # results in 42
161
+ ```
162
+
163
+ ### Conversion to Timespan
164
+
165
+ A new `Timespan` can be created from `Integer`, `Float`, `String`, and `Hash` values. Several variants of the constructor are provided.
166
+
167
+ #### Timespan from seconds
168
+
169
+ When a Float is used, the decimal part represents fractions of a second.
170
+
171
+ ```puppet
172
+ function Timespan.new(
173
+ Variant[Float, Integer] $value
174
+ )
175
+ ```
176
+
177
+ #### Timespan from days, hours, minutes, seconds, and fractions of a second
178
+
179
+ The arguments can be passed separately in which case the first four, days, hours, minutes, and seconds are mandatory and the rest are optional.
180
+ All values may overflow and/or be negative. The internal 128-bit nano-second integer is calculated as:
181
+
182
+ ```
183
+ (((((days * 24 + hours) * 60 + minutes) * 60 + seconds) * 1000 + milliseconds) * 1000 + microseconds) * 1000 + nanoseconds
184
+ ```
185
+
186
+ ```puppet
187
+ function Timespan.new(
188
+ Integer $days, Integer $hours, Integer $minutes, Integer $seconds,
189
+ Integer $milliseconds = 0, Integer $microseconds = 0, Integer $nanoseconds = 0
190
+ )
191
+ ```
192
+
193
+ or, all arguments can be passed as a `Hash`, in which case all entries are optional:
194
+
195
+ ```puppet
196
+ function Timespan.new(
197
+ Struct[{
198
+ Optional[negative] => Boolean,
199
+ Optional[days] => Integer,
200
+ Optional[hours] => Integer,
201
+ Optional[minutes] => Integer,
202
+ Optional[seconds] => Integer,
203
+ Optional[milliseconds] => Integer,
204
+ Optional[microseconds] => Integer,
205
+ Optional[nanoseconds] => Integer
206
+ }] $hash
207
+ )
208
+ ```
209
+
210
+ #### Timespan from String and format directive patterns
211
+
212
+ The first argument is parsed using the format optionally passed as a string or array of strings. When an array is used, an attempt
213
+ will be made to parse the string using the first entry and then with each entry in succession until parsing succeeds. If the second
214
+ argument is omitted, an array of default formats will be used.
215
+
216
+ An exception is raised when no format was able to parse the given string.
217
+
218
+ ```puppet
219
+ function Timespan.new(
220
+ String $string, Variant[String[2],Array[String[2], 1]] $format = <default format>)
221
+ )
222
+ ```
223
+
224
+ the arguments may also be passed as a `Hash`:
225
+
226
+ ```puppet
227
+ function Timespan.new(
228
+ Struct[{
229
+ string => String[1],
230
+ Optional[format] => Variant[String[2],Array[String[2], 1]]
231
+ }] $hash
232
+ )
233
+ ```
234
+
235
+ The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
236
+ a conversion specifier as follows:
237
+ ```
238
+ %[Flags][Width]Conversion
239
+ ```
240
+
241
+ ##### Flags:
242
+
243
+ | Flag | Meaning
244
+ | ---- | ---------------
245
+ | - | Don't pad numerical output
246
+ | _ | Use spaces for padding
247
+ | 0 | Use zeros for padding
248
+
249
+ ##### Format directives:
250
+
251
+ | Format | Meaning |
252
+ | ------ | ------- |
253
+ | D | Number of Days |
254
+ | H | Hour of the day, 24-hour clock |
255
+ | M | Minute of the hour (00..59) |
256
+ | S | Second of the minute (00..59) |
257
+ | L | Millisecond of the second (000..999) |
258
+ | N | Fractional seconds digits |
259
+
260
+ The format directive that represents the highest magnitude in the format will be allowed to
261
+ overflow. I.e. if no "%D" is used but a "%H" is present, then the hours may be more than 23.
262
+
263
+ The default array contains the following patterns:
264
+
265
+ ```
266
+ ['%D-%H:%M:%S', '%D-%H:%M', '%H:%M:%S', '%H:%M']
267
+ ```
268
+
269
+ Examples - Converting to Timespan
270
+
271
+ ```puppet
272
+ $duration = Timespan(13.5) # 13 seconds and 500 milliseconds
273
+ $duration = Timespan({days=>4}) # 4 days
274
+ $duration = Timespan(4, 0, 0, 2) # 4 days and 2 seconds
275
+ $duration = Timespan('13:20') # 13 hours and 20 minutes (using default pattern)
276
+ $duration = Timespan('10:03.5', '%M:%S.%L') # 10 minutes, 3 seconds, and 5 milli-seconds
277
+ $duration = Timespan('10:03.5', '%M:%S.%N') # 10 minutes, 3 seconds, and 5 nano-seconds
278
+ ```
279
+
280
+ ### Conversion to Timestamp
281
+
282
+ A new `Timestamp` can be created from `Integer`, `Float`, `String`, and `Hash` values. Several variants of the constructor are provided.
283
+
284
+ #### Timestamp from seconds since epoch (1970-01-01 00:00:00 UTC)
285
+
286
+ When a Float is used, the decimal part represents fractions of a second.
287
+
288
+ ```puppet
289
+ function Timestamp.new(
290
+ Variant[Float, Integer] $value
291
+ )
292
+ ```
293
+
294
+ #### Timestamp from String and patterns consisting of format directives
295
+
296
+ The first argument is parsed using the format optionally passed as a string or array of strings. When an array is used, an attempt
297
+ will be made to parse the string using the first entry and then with each entry in succession until parsing succeeds. If the second
298
+ argument is omitted, an array of default formats will be used.
299
+
300
+ A third optional timezone argument can be provided. The first argument will then be parsed as if it represents a local time in that
301
+ timezone. The timezone can be any timezone that is recognized when using the '%z' or '%Z' formats, or the word 'current', in which
302
+ case the current timezone of the evaluating process will be used. The timezone argument is case insensitive.
303
+
304
+ The default timezone, when no argument is provided, or when using the keyword `default`, is 'UTC'.
305
+
306
+ It is illegal to provide a timezone argument other than `default` in combination with a format that contains '%z' or '%Z' since that
307
+ would introduce an ambiguity as to which timezone to use. The one extracted from the string, or the one provided as an argument.
308
+
309
+ An exception is raised when no format was able to parse the given string.
310
+
311
+ ```puppet
312
+ function Timestamp.new(
313
+ String $string,
314
+ Variant[String[2],Array[String[2], 1]] $format = <default format>,
315
+ String $timezone = default)
316
+ )
317
+ ```
318
+
319
+ the arguments may also be passed as a `Hash`:
320
+
321
+ ```puppet
322
+ function Timestamp.new(
323
+ Struct[{
324
+ string => String[1],
325
+ Optional[format] => Variant[String[2],Array[String[2], 1]],
326
+ Optional[timezone] => String[1]
327
+ }] $hash
328
+ )
329
+ ```
330
+
331
+ The directive consists of a percent (%) character, zero or more flags, optional minimum field width and
332
+ a conversion specifier as follows:
333
+ ```
334
+ %[Flags][Width]Conversion
335
+ ```
336
+
337
+ ##### Flags:
338
+
339
+ | Flag | Meaning
340
+ | ---- | ---------------
341
+ | - | Don't pad numerical output
342
+ | _ | Use spaces for padding
343
+ | 0 | Use zeros for padding
344
+ | # | Change names to upper-case or change case of am/pm
345
+ | ^ | Use uppercase
346
+ | : | Use colons for %z
347
+
348
+ ##### Format directives (names and padding can be altered using flags):
349
+
350
+ **Date (Year, Month, Day):**
351
+
352
+ | Format | Meaning |
353
+ | ------ | ------- |
354
+ | Y | Year with century, zero-padded to at least 4 digits |
355
+ | C | year / 100 (rounded down such as 20 in 2009) |
356
+ | y | year % 100 (00..99) |
357
+ | m | Month of the year, zero-padded (01..12) |
358
+ | B | The full month name ("January") |
359
+ | b | The abbreviated month name ("Jan") |
360
+ | h | Equivalent to %b |
361
+ | d | Day of the month, zero-padded (01..31) |
362
+ | e | Day of the month, blank-padded ( 1..31) |
363
+ | j | Day of the year (001..366) |
364
+
365
+ **Time (Hour, Minute, Second, Subsecond):**
366
+
367
+ | Format | Meaning |
368
+ | ------ | ------- |
369
+ | H | Hour of the day, 24-hour clock, zero-padded (00..23) |
370
+ | k | Hour of the day, 24-hour clock, blank-padded ( 0..23) |
371
+ | I | Hour of the day, 12-hour clock, zero-padded (01..12) |
372
+ | l | Hour of the day, 12-hour clock, blank-padded ( 1..12) |
373
+ | P | Meridian indicator, lowercase ("am" or "pm") |
374
+ | p | Meridian indicator, uppercase ("AM" or "PM") |
375
+ | M | Minute of the hour (00..59) |
376
+ | S | Second of the minute (00..60) |
377
+ | L | Millisecond of the second (000..999). Digits under millisecond are truncated to not produce 1000 |
378
+ | N | Fractional seconds digits, default is 9 digits (nanosecond). Digits under a specified width are truncated to avoid carry up |
377
379
 
378
- **Time (Hour, Minute, Second, Subsecond):**
379
-
380
- | Format | Meaning |
381
- | ------ | ------- |
382
- | z | Time zone as hour and minute offset from UTC (e.g. +0900) |
383
- | :z | hour and minute offset from UTC with a colon (e.g. +09:00) |
384
- | ::z | hour, minute and second offset from UTC (e.g. +09:00:00) |
385
- | Z | Abbreviated time zone name or similar information. (OS dependent) |
386
-
387
- **Weekday:**
388
-
389
- | Format | Meaning |
390
- | ------ | ------- |
391
- | A | The full weekday name ("Sunday") |
392
- | a | The abbreviated name ("Sun") |
393
- | u | Day of the week (Monday is 1, 1..7) |
394
- | w | Day of the week (Sunday is 0, 0..6) |
395
-
396
- **ISO 8601 week-based year and week number:**
397
-
398
- The first week of YYYY starts with a Monday and includes YYYY-01-04.
399
- The days in the year before the first week are in the last week of
400
- the previous year.
401
-
402
- | Format | Meaning |
403
- | ------ | ------- |
404
- | G | The week-based year |
405
- | g | The last 2 digits of the week-based year (00..99) |
406
- | V | Week number of the week-based year (01..53) |
407
-
408
- **Week number:**
409
-
410
- The first week of YYYY that starts with a Sunday or Monday (according to %U
411
- or %W). The days in the year before the first week are in week 0.
412
-
413
- | Format | Meaning |
414
- | ------ | ------- |
415
- | U | Week number of the year. The week starts with Sunday. (00..53) |
416
- | W | Week number of the year. The week starts with Monday. (00..53) |
417
-
418
- **Seconds since the Epoch:**
419
-
420
- | Format | Meaning |
421
- | s | Number of seconds since 1970-01-01 00:00:00 UTC. |
422
-
423
- **Literal string:**
424
-
425
- | Format | Meaning |
426
- | ------ | ------- |
427
- | n | Newline character (\n) |
428
- | t | Tab character (\t) |
429
- | % | Literal "%" character |
430
-
431
- **Combination:**
432
-
433
- | Format | Meaning |
434
- | ------ | ------- |
435
- | c | date and time (%a %b %e %T %Y) |
436
- | D | Date (%m/%d/%y) |
437
- | F | The ISO 8601 date format (%Y-%m-%d) |
438
- | v | VMS date (%e-%^b-%4Y) |
439
- | x | Same as %D |
440
- | X | Same as %T |
441
- | r | 12-hour time (%I:%M:%S %p) |
442
- | R | 24-hour time (%H:%M) |
443
- | T | 24-hour time (%H:%M:%S) |
444
-
445
- The default array contains the following patterns:
446
-
447
- When a timezone argument (other than `default`) is explicitly provided:
448
-
449
- ```
450
- ['%FT%T.L', '%FT%T', '%F']
451
- ```
452
-
453
- otherwise:
454
-
455
- ```
456
- ['%FT%T.%L %Z', '%FT%T %Z', '%F %Z', '%FT%T.L', '%FT%T', '%F']
457
- ```
458
-
459
- Examples - Converting to Timestamp
460
-
461
- ```puppet
462
- $ts = Timestamp(1473150899) # 2016-09-06 08:34:59 UTC
463
- $ts = Timestamp({string=>'2015', format=>'%Y'}) # 2015-01-01 00:00:00.000 UTC
464
- $ts = Timestamp('Wed Aug 24 12:13:14 2016', '%c') # 2016-08-24 12:13:14 UTC
465
- $ts = Timestamp('Wed Aug 24 12:13:14 2016 PDT', '%c %Z') # 2016-08-24 19:13:14.000 UTC
466
- $ts = Timestamp('2016-08-24 12:13:14', '%F %T', 'PST') # 2016-08-24 20:13:14.000 UTC
467
- $ts = Timestamp('2016-08-24T12:13:14', default, 'PST') # 2016-08-24 20:13:14.000 UTC
380
+ **Time (Hour, Minute, Second, Subsecond):**
381
+
382
+ | Format | Meaning |
383
+ | ------ | ------- |
384
+ | z | Time zone as hour and minute offset from UTC (e.g. +0900) |
385
+ | :z | hour and minute offset from UTC with a colon (e.g. +09:00) |
386
+ | ::z | hour, minute and second offset from UTC (e.g. +09:00:00) |
387
+ | Z | Abbreviated time zone name or similar information. (OS dependent) |
388
+
389
+ **Weekday:**
390
+
391
+ | Format | Meaning |
392
+ | ------ | ------- |
393
+ | A | The full weekday name ("Sunday") |
394
+ | a | The abbreviated name ("Sun") |
395
+ | u | Day of the week (Monday is 1, 1..7) |
396
+ | w | Day of the week (Sunday is 0, 0..6) |
397
+
398
+ **ISO 8601 week-based year and week number:**
399
+
400
+ The first week of YYYY starts with a Monday and includes YYYY-01-04.
401
+ The days in the year before the first week are in the last week of
402
+ the previous year.
403
+
404
+ | Format | Meaning |
405
+ | ------ | ------- |
406
+ | G | The week-based year |
407
+ | g | The last 2 digits of the week-based year (00..99) |
408
+ | V | Week number of the week-based year (01..53) |
409
+
410
+ **Week number:**
411
+
412
+ The first week of YYYY that starts with a Sunday or Monday (according to %U
413
+ or %W). The days in the year before the first week are in week 0.
414
+
415
+ | Format | Meaning |
416
+ | ------ | ------- |
417
+ | U | Week number of the year. The week starts with Sunday. (00..53) |
418
+ | W | Week number of the year. The week starts with Monday. (00..53) |
419
+
420
+ **Seconds since the Epoch:**
421
+
422
+ | Format | Meaning |
423
+ | s | Number of seconds since 1970-01-01 00:00:00 UTC. |
424
+
425
+ **Literal string:**
426
+
427
+ | Format | Meaning |
428
+ | ------ | ------- |
429
+ | n | Newline character (\n) |
430
+ | t | Tab character (\t) |
431
+ | % | Literal "%" character |
432
+
433
+ **Combination:**
434
+
435
+ | Format | Meaning |
436
+ | ------ | ------- |
437
+ | c | date and time (%a %b %e %T %Y) |
438
+ | D | Date (%m/%d/%y) |
439
+ | F | The ISO 8601 date format (%Y-%m-%d) |
440
+ | v | VMS date (%e-%^b-%4Y) |
441
+ | x | Same as %D |
442
+ | X | Same as %T |
443
+ | r | 12-hour time (%I:%M:%S %p) |
444
+ | R | 24-hour time (%H:%M) |
445
+ | T | 24-hour time (%H:%M:%S) |
446
+
447
+ The default array contains the following patterns:
448
+
449
+ When a timezone argument (other than `default`) is explicitly provided:
450
+
451
+ ```
452
+ ['%FT%T.L', '%FT%T', '%F']
453
+ ```
454
+
455
+ otherwise:
456
+
457
+ ```
458
+ ['%FT%T.%L %Z', '%FT%T %Z', '%F %Z', '%FT%T.L', '%FT%T', '%F']
459
+ ```
460
+
461
+ Examples - Converting to Timestamp
462
+
463
+ ```puppet
464
+ $ts = Timestamp(1473150899) # 2016-09-06 08:34:59 UTC
465
+ $ts = Timestamp({string=>'2015', format=>'%Y'}) # 2015-01-01 00:00:00.000 UTC
466
+ $ts = Timestamp('Wed Aug 24 12:13:14 2016', '%c') # 2016-08-24 12:13:14 UTC
467
+ $ts = Timestamp('Wed Aug 24 12:13:14 2016 PDT', '%c %Z') # 2016-08-24 19:13:14.000 UTC
468
+ $ts = Timestamp('2016-08-24 12:13:14', '%F %T', 'PST') # 2016-08-24 20:13:14.000 UTC
469
+ $ts = Timestamp('2016-08-24T12:13:14', default, 'PST') # 2016-08-24 20:13:14.000 UTC
468
470
 
469
- ```
471
+ ```
470
472
 
471
- ### Conversion to Type
473
+ ### Conversion to Type
472
474
 
473
- A new `Type` can be create from its `String` representation.
475
+ A new `Type` can be create from its `String` representation.
474
476
 
475
- **Example:** Creating a type from a string
477
+ **Example:** Creating a type from a string
476
478
 
477
- ```puppet
478
- $t = Type.new('Integer[10]')
479
- ```
480
-
481
- ### Conversion to String
479
+ ```puppet
480
+ $t = Type.new('Integer[10]')
481
+ ```
482
+
483
+ ### Conversion to String
482
484
 
483
- Conversion to `String` is the most comprehensive conversion as there are many
484
- use cases where a string representation is wanted. The defaults for the many options
485
- have been chosen with care to be the most basic "value in textual form" representation.
486
- The more advanced forms of formatting are intended to enable writing special purposes formatting
487
- functions in the Puppet language.
485
+ Conversion to `String` is the most comprehensive conversion as there are many
486
+ use cases where a string representation is wanted. The defaults for the many options
487
+ have been chosen with care to be the most basic "value in textual form" representation.
488
+ The more advanced forms of formatting are intended to enable writing special purposes formatting
489
+ functions in the Puppet language.
488
490
 
489
- A new string can be created from all other data types. The process is performed in
490
- several steps - first the data type of the given value is inferred, then the resulting data type
491
- is used to find the most significant format specified for that data type. And finally,
492
- the found format is used to convert the given value.
493
-
494
- The mapping from data type to format is referred to as the *format map*. This map
495
- allows different formatting depending on type.
491
+ A new string can be created from all other data types. The process is performed in
492
+ several steps - first the data type of the given value is inferred, then the resulting data type
493
+ is used to find the most significant format specified for that data type. And finally,
494
+ the found format is used to convert the given value.
495
+
496
+ The mapping from data type to format is referred to as the *format map*. This map
497
+ allows different formatting depending on type.
496
498
 
497
- **Example:** Positive Integers in Hexadecimal prefixed with '0x', negative in Decimal
499
+ **Example:** Positive Integers in Hexadecimal prefixed with '0x', negative in Decimal
498
500
 
499
- ```puppet
500
- $format_map = {
501
- Integer[default, 0] => "%d",
502
- Integer[1, default] => "%#x"
503
- }
504
- String("-1", $format_map) # produces '-1'
505
- String("10", $format_map) # produces '0xa'
506
- ```
507
-
508
- A format is specified on the form:
509
-
510
- ```
511
- %[Flags][Width][.Precision]Format
512
- ```
513
-
514
- `Width` is the number of characters into which the value should be fitted. This allocated space is
515
- padded if value is shorter. By default it is space padded, and the flag `0` will cause padding with `0`
516
- for numerical formats.
517
-
518
- `Precision` is the number of fractional digits to show for floating point, and the maximum characters
519
- included in a string format.
520
-
521
- Note that all data type supports the formats `s` and `p` with the meaning "default string representation" and
522
- "default programmatic string representation" (which for example means that a String is quoted in 'p' format).
523
-
524
- #### Signatures of String conversion
525
-
526
- ```puppet
527
- type Format = Pattern[/^%([\s\+\-#0\[\{<\(\|]*)([1-9][0-9]*)?(?:\.([0-9]+))?([a-zA-Z])/]
528
- type ContainerFormat = Struct[{
529
- format => Optional[String],
530
- separator => Optional[String],
531
- separator2 => Optional[String],
532
- string_formats => Hash[Type, Format]
533
- }]
534
- type TypeMap = Hash[Type, Variant[Format, ContainerFormat]]
535
- type Formats = Variant[Default, String[1], TypeMap]
536
-
537
- function String.new(
538
- Any $value,
539
- Formats $string_formats
540
- )
541
- ```
542
-
543
- Where:
501
+ ```puppet
502
+ $format_map = {
503
+ Integer[default, 0] => "%d",
504
+ Integer[1, default] => "%#x"
505
+ }
506
+ String("-1", $format_map) # produces '-1'
507
+ String("10", $format_map) # produces '0xa'
508
+ ```
509
+
510
+ A format is specified on the form:
511
+
512
+ ```
513
+ %[Flags][Width][.Precision]Format
514
+ ```
515
+
516
+ `Width` is the number of characters into which the value should be fitted. This allocated space is
517
+ padded if value is shorter. By default it is space padded, and the flag `0` will cause padding with `0`
518
+ for numerical formats.
519
+
520
+ `Precision` is the number of fractional digits to show for floating point, and the maximum characters
521
+ included in a string format.
522
+
523
+ Note that all data type supports the formats `s` and `p` with the meaning "default string representation" and
524
+ "default programmatic string representation" (which for example means that a String is quoted in 'p' format).
525
+
526
+ #### Signatures of String conversion
527
+
528
+ ```puppet
529
+ type Format = Pattern[/^%([\s\+\-#0\[\{<\(\|]*)([1-9][0-9]*)?(?:\.([0-9]+))?([a-zA-Z])/]
530
+ type ContainerFormat = Struct[{
531
+ format => Optional[String],
532
+ separator => Optional[String],
533
+ separator2 => Optional[String],
534
+ string_formats => Hash[Type, Format]
535
+ }]
536
+ type TypeMap = Hash[Type, Variant[Format, ContainerFormat]]
537
+ type Formats = Variant[Default, String[1], TypeMap]
538
+
539
+ function String.new(
540
+ Any $value,
541
+ Formats $string_formats
542
+ )
543
+ ```
544
+
545
+ Where:
544
546
 
545
- * `separator` is the string used to separate entries in an array, or hash (extra space should not be included at
546
- the end), defaults to `","`
547
- * `separator2` is the separator between key and value in a hash entry (space padding should be included as
548
- wanted), defaults to `" => "`.
549
- * `string_formats` is a data type to format map for values contained in arrays and hashes - defaults to `{Any => "%p"}`. Note that
550
- these nested formats are not applicable to data types that are containers; they are always formatted as per the top level
551
- format specification.
552
-
553
- **Example:** Simple Conversion to String (using defaults)
554
-
555
- ```puppet
556
- $str = String(10) # produces '10'
557
- $str = String([10]) # produces '["10"]'
558
- ```
559
-
560
- **Example:** Simple Conversion to String specifying the format for the given value directly
561
-
562
- ```puppet
563
- $str = String(10, "%#x") # produces '0x10'
564
- $str = String([10], "%(a") # produces '("10")'
565
- ```
566
-
567
- **Example:** Specifying type for values contained in an array
568
-
569
- ```puppet
570
- $formats = {
571
- Array => {
572
- format => '%(a',
573
- string_formats => { Integer => '%#x' }
574
- }
575
- }
576
- $str = String([1,2,3], $formats) # produces '(0x1, 0x2, 0x3)'
577
- ```
578
-
579
- The given formats are merged with the default formats, and matching of values to convert against format is based on
580
- the specificity of the mapped type; for example, different formats can be used for short and long arrays.
581
-
582
- #### Integer to String
583
-
584
- | Format | Integer Formats
585
- | ------ | ---------------
586
- | d | Decimal, negative values produces leading '-'.
587
- | x X | Hexadecimal in lower or upper case. Uses ..f/..F for negative values unless + is also used. A `#` adds prefix 0x/0X.
588
- | o | Octal. Uses ..0 for negative values unless `+` is also used. A `#` adds prefix 0.
589
- | b B | Binary with prefix 'b' or 'B'. Uses ..1/..1 for negative values unless `+` is also used.
590
- | c | Numeric value representing a Unicode value, result is a one unicode character string, quoted if alternative flag # is used
591
- | s | Same as d, or d in quotes if alternative flag # is used.
592
- | p | Same as d.
593
- | eEfgGaA | Converts integer to float and formats using the floating point rules.
594
-
595
- Defaults to `d`.
596
-
597
- #### Float to String
598
-
599
- | Format | Float formats
600
- | ------ | -------------
601
- | f | Floating point in non exponential notation.
602
- | e E | Exponential notation with 'e' or 'E'.
603
- | g G | Conditional exponential with 'e' or 'E' if exponent < -4 or >= the precision.
604
- | a A | Hexadecimal exponential form, using 'x'/'X' as prefix and 'p'/'P' before exponent.
605
- | s | Converted to string using format p, then applying string formatting rule, alternate form # quotes result.
606
- | p | Same as f format with minimum significant number of fractional digits, prec has no effect.
607
- | dxXobBc | Converts float to integer and formats using the integer rules.
608
-
609
- Defaults to `p`.
610
-
611
- #### String to String
612
-
613
- | Format | String
614
- | ------ | ------
615
- | s | Unquoted string, verbatim output of control chars.
616
- | p | Programmatic representation - strings are quoted, interior quotes and control chars are escaped.
617
- | C | Each `::` name segment capitalized, quoted if alternative flag `#` is used.
618
- | c | Capitalized string, quoted if alternative flag `#` is used.
619
- | d | Downcased string, quoted if alternative flag `#` is used.
620
- | u | Upcased string, quoted if alternative flag `#` is used.
621
- | t | Trims leading and trailing whitespace from the string, quoted if alternative flag `#` is used.
622
-
623
- Defaults to `s` at top level and `p` inside array or hash.
624
-
625
- #### Boolean to String
626
-
627
- | Format | Boolean Formats
628
- | ---- | -------------------
629
- | t T | String 'true'/'false' or 'True'/'False', first char if alternate form is used (i.e. 't'/'f' or 'T'/'F').
630
- | y Y | String 'yes'/'no', 'Yes'/'No', 'y'/'n' or 'Y'/'N' if alternative flag `#` is used.
631
- | dxXobB | Numeric value 0/1 in accordance with the given format which must be valid integer format.
632
- | eEfgGaA | Numeric value 0.0/1.0 in accordance with the given float format and flags.
633
- | s | String 'true' / 'false'.
634
- | p | String 'true' / 'false'.
635
-
636
- #### Regexp to String
637
-
638
- | Format | Regexp Formats
639
- | ---- | --------------
640
- | s | No delimiters, quoted if alternative flag `#` is used.
641
- | p | Delimiters `/ /`.
642
-
643
- #### Undef to String
644
-
645
- | Format | Undef formats
646
- | ------ | -------------
647
- | s | Empty string, or quoted empty string if alternative flag `#` is used.
648
- | p | String 'undef', or quoted '"undef"' if alternative flag `#` is used.
649
- | n | String 'nil', or 'null' if alternative flag `#` is used.
650
- | dxXobB | String 'NaN'.
651
- | eEfgGaA | String 'NaN'.
652
- | v | String 'n/a'.
653
- | V | String 'N/A'.
654
- | u | String 'undef', or 'undefined' if alternative `#` flag is used.
655
-
656
- #### Default value to String
657
-
658
- | Format | Default formats
659
- | ------ | ---------------
660
- | d D | String 'default' or 'Default', alternative form `#` causes value to be quoted.
661
- | s | Same as d.
662
- | p | Same as d.
663
-
664
- #### Binary value to String
665
-
666
- | Format | Default formats
667
- | ------ | ---------------
668
- | s | binary as unquoted UTF-8 characters (errors if byte sequence is invalid UTF-8). Alternate form escapes non ascii bytes.
669
- | p | 'Binary("<base64strict>")'
670
- | b | '<base64>' - base64 string with newlines inserted
671
- | B | '<base64strict>' - base64 strict string (without newlines inserted)
672
- | u | '<base64urlsafe>' - base64 urlsafe string
673
- | t | 'Binary' - outputs the name of the type only
674
- | T | 'BINARY' - output the name of the type in all caps only
675
-
676
- * The alternate form flag `#` will quote the binary or base64 text output.
677
- * The format `%#s` allows invalid UTF-8 characters and outputs all non ascii bytes
678
- as hex escaped characters on the form `\\xHH` where `H` is a hex digit.
679
- * The width and precision values are applied to the text part only in `%p` format.
680
-
681
- #### Array & Tuple to String
682
-
683
- | Format | Array/Tuple Formats
684
- | ------ | -------------
685
- | a | Formats with `[ ]` delimiters and `,`, alternate form `#` indents nested arrays/hashes.
686
- | s | Same as a.
687
- | p | Same as a.
547
+ * `separator` is the string used to separate entries in an array, or hash (extra space should not be included at
548
+ the end), defaults to `","`
549
+ * `separator2` is the separator between key and value in a hash entry (space padding should be included as
550
+ wanted), defaults to `" => "`.
551
+ * `string_formats` is a data type to format map for values contained in arrays and hashes - defaults to `{Any => "%p"}`. Note that
552
+ these nested formats are not applicable to data types that are containers; they are always formatted as per the top level
553
+ format specification.
554
+
555
+ **Example:** Simple Conversion to String (using defaults)
556
+
557
+ ```puppet
558
+ $str = String(10) # produces '10'
559
+ $str = String([10]) # produces '["10"]'
560
+ ```
561
+
562
+ **Example:** Simple Conversion to String specifying the format for the given value directly
563
+
564
+ ```puppet
565
+ $str = String(10, "%#x") # produces '0x10'
566
+ $str = String([10], "%(a") # produces '("10")'
567
+ ```
568
+
569
+ **Example:** Specifying type for values contained in an array
570
+
571
+ ```puppet
572
+ $formats = {
573
+ Array => {
574
+ format => '%(a',
575
+ string_formats => { Integer => '%#x' }
576
+ }
577
+ }
578
+ $str = String([1,2,3], $formats) # produces '(0x1, 0x2, 0x3)'
579
+ ```
580
+
581
+ The given formats are merged with the default formats, and matching of values to convert against format is based on
582
+ the specificity of the mapped type; for example, different formats can be used for short and long arrays.
583
+
584
+ #### Integer to String
585
+
586
+ | Format | Integer Formats
587
+ | ------ | ---------------
588
+ | d | Decimal, negative values produces leading '-'.
589
+ | x X | Hexadecimal in lower or upper case. Uses ..f/..F for negative values unless + is also used. A `#` adds prefix 0x/0X.
590
+ | o | Octal. Uses ..0 for negative values unless `+` is also used. A `#` adds prefix 0.
591
+ | b B | Binary with prefix 'b' or 'B'. Uses ..1/..1 for negative values unless `+` is also used.
592
+ | c | Numeric value representing a Unicode value, result is a one unicode character string, quoted if alternative flag # is used
593
+ | s | Same as d, or d in quotes if alternative flag # is used.
594
+ | p | Same as d.
595
+ | eEfgGaA | Converts integer to float and formats using the floating point rules.
596
+
597
+ Defaults to `d`.
598
+
599
+ #### Float to String
600
+
601
+ | Format | Float formats
602
+ | ------ | -------------
603
+ | f | Floating point in non exponential notation.
604
+ | e E | Exponential notation with 'e' or 'E'.
605
+ | g G | Conditional exponential with 'e' or 'E' if exponent < -4 or >= the precision.
606
+ | a A | Hexadecimal exponential form, using 'x'/'X' as prefix and 'p'/'P' before exponent.
607
+ | s | Converted to string using format p, then applying string formatting rule, alternate form # quotes result.
608
+ | p | Same as f format with minimum significant number of fractional digits, prec has no effect.
609
+ | dxXobBc | Converts float to integer and formats using the integer rules.
610
+
611
+ Defaults to `p`.
612
+
613
+ #### String to String
614
+
615
+ | Format | String
616
+ | ------ | ------
617
+ | s | Unquoted string, verbatim output of control chars.
618
+ | p | Programmatic representation - strings are quoted, interior quotes and control chars are escaped.
619
+ | C | Each `::` name segment capitalized, quoted if alternative flag `#` is used.
620
+ | c | Capitalized string, quoted if alternative flag `#` is used.
621
+ | d | Downcased string, quoted if alternative flag `#` is used.
622
+ | u | Upcased string, quoted if alternative flag `#` is used.
623
+ | t | Trims leading and trailing whitespace from the string, quoted if alternative flag `#` is used.
624
+
625
+ Defaults to `s` at top level and `p` inside array or hash.
626
+
627
+ #### Boolean to String
628
+
629
+ | Format | Boolean Formats
630
+ | ---- | -------------------
631
+ | t T | String 'true'/'false' or 'True'/'False', first char if alternate form is used (i.e. 't'/'f' or 'T'/'F').
632
+ | y Y | String 'yes'/'no', 'Yes'/'No', 'y'/'n' or 'Y'/'N' if alternative flag `#` is used.
633
+ | dxXobB | Numeric value 0/1 in accordance with the given format which must be valid integer format.
634
+ | eEfgGaA | Numeric value 0.0/1.0 in accordance with the given float format and flags.
635
+ | s | String 'true' / 'false'.
636
+ | p | String 'true' / 'false'.
637
+
638
+ #### Regexp to String
639
+
640
+ | Format | Regexp Formats
641
+ | ---- | --------------
642
+ | s | No delimiters, quoted if alternative flag `#` is used.
643
+ | p | Delimiters `/ /`.
644
+
645
+ #### Undef to String
646
+
647
+ | Format | Undef formats
648
+ | ------ | -------------
649
+ | s | Empty string, or quoted empty string if alternative flag `#` is used.
650
+ | p | String 'undef', or quoted '"undef"' if alternative flag `#` is used.
651
+ | n | String 'nil', or 'null' if alternative flag `#` is used.
652
+ | dxXobB | String 'NaN'.
653
+ | eEfgGaA | String 'NaN'.
654
+ | v | String 'n/a'.
655
+ | V | String 'N/A'.
656
+ | u | String 'undef', or 'undefined' if alternative `#` flag is used.
657
+
658
+ #### Default value to String
659
+
660
+ | Format | Default formats
661
+ | ------ | ---------------
662
+ | d D | String 'default' or 'Default', alternative form `#` causes value to be quoted.
663
+ | s | Same as d.
664
+ | p | Same as d.
665
+
666
+ #### Binary value to String
667
+
668
+ | Format | Default formats
669
+ | ------ | ---------------
670
+ | s | binary as unquoted UTF-8 characters (errors if byte sequence is invalid UTF-8). Alternate form escapes non ascii bytes.
671
+ | p | 'Binary("<base64strict>")'
672
+ | b | '<base64>' - base64 string with newlines inserted
673
+ | B | '<base64strict>' - base64 strict string (without newlines inserted)
674
+ | u | '<base64urlsafe>' - base64 urlsafe string
675
+ | t | 'Binary' - outputs the name of the type only
676
+ | T | 'BINARY' - output the name of the type in all caps only
677
+
678
+ * The alternate form flag `#` will quote the binary or base64 text output.
679
+ * The format `%#s` allows invalid UTF-8 characters and outputs all non ascii bytes
680
+ as hex escaped characters on the form `\\xHH` where `H` is a hex digit.
681
+ * The width and precision values are applied to the text part only in `%p` format.
682
+
683
+ #### Array & Tuple to String
684
+
685
+ | Format | Array/Tuple Formats
686
+ | ------ | -------------
687
+ | a | Formats with `[ ]` delimiters and `,`, alternate form `#` indents nested arrays/hashes.
688
+ | s | Same as a.
689
+ | p | Same as a.
688
690
 
689
- See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
690
- more information about options.
691
+ See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
692
+ more information about options.
691
693
 
692
- The alternate form flag `#` will cause indentation of nested array or hash containers. If width is also set
693
- it is taken as the maximum allowed length of a sequence of elements (not including delimiters). If this max length
694
- is exceeded, each element will be indented.
695
-
696
- #### Hash & Struct to String
697
-
698
- | Format | Hash/Struct Formats
699
- | ------ | -------------
700
- | h | Formats with `{ }` delimiters, `,` element separator and ` => ` inner element separator unless overridden by flags.
701
- | s | Same as h.
702
- | p | Same as h.
703
- | a | Converts the hash to an array of [k,v] tuples and formats it using array rule(s).
694
+ The alternate form flag `#` will cause indentation of nested array or hash containers. If width is also set
695
+ it is taken as the maximum allowed length of a sequence of elements (not including delimiters). If this max length
696
+ is exceeded, each element will be indented.
697
+
698
+ #### Hash & Struct to String
699
+
700
+ | Format | Hash/Struct Formats
701
+ | ------ | -------------
702
+ | h | Formats with `{ }` delimiters, `,` element separator and ` => ` inner element separator unless overridden by flags.
703
+ | s | Same as h.
704
+ | p | Same as h.
705
+ | a | Converts the hash to an array of [k,v] tuples and formats it using array rule(s).
704
706
 
705
- See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
706
- more information about options.
707
+ See "Flags" `<[({\|` for formatting of delimiters, and "Additional parameters for containers; Array and Hash" for
708
+ more information about options.
707
709
 
708
- The alternate form flag `#` will format each hash key/value entry indented on a separate line.
710
+ The alternate form flag `#` will format each hash key/value entry indented on a separate line.
709
711
 
710
- #### Type to String
712
+ #### Type to String
711
713
 
712
- | Format | Array/Tuple Formats
713
- | ------ | -------------
714
- | s | The same as `p`, quoted if alternative flag `#` is used.
715
- | p | Outputs the type in string form as specified by the Puppet Language.
714
+ | Format | Array/Tuple Formats
715
+ | ------ | -------------
716
+ | s | The same as `p`, quoted if alternative flag `#` is used.
717
+ | p | Outputs the type in string form as specified by the Puppet Language.
716
718
 
717
- #### Flags
719
+ #### Flags
718
720
 
719
- | Flag | Effect
720
- | ------ | ------
721
- | (space) | A space instead of `+` for numeric output (`-` is shown), for containers skips delimiters.
722
- | # | Alternate format; prefix 0x/0x, 0 (octal) and 0b/0B for binary, Floats force decimal '.'. For g/G keep trailing 0.
723
- | + | Show sign +/- depending on value's sign, changes x, X, o, b, B format to not use 2's complement form.
724
- | - | Left justify the value in the given width.
725
- | 0 | Pad with 0 instead of space for widths larger than value.
726
- | <[({\| | Defines an enclosing pair <> [] () {} or \| \| when used with a container type.
721
+ | Flag | Effect
722
+ | ------ | ------
723
+ | (space) | A space instead of `+` for numeric output (`-` is shown), for containers skips delimiters.
724
+ | # | Alternate format; prefix 0x/0x, 0 (octal) and 0b/0B for binary, Floats force decimal '.'. For g/G keep trailing 0.
725
+ | + | Show sign +/- depending on value's sign, changes x, X, o, b, B format to not use 2's complement form.
726
+ | - | Left justify the value in the given width.
727
+ | 0 | Pad with 0 instead of space for widths larger than value.
728
+ | <[({\| | Defines an enclosing pair <> [] () {} or \| \| when used with a container type.
727
729
 
728
- ### Conversion to Boolean
730
+ ### Conversion to Boolean
729
731
 
730
- Accepts a single value as argument:
732
+ Accepts a single value as argument:
731
733
 
732
- * Float 0.0 is `false`, all other float values are `true`
733
- * Integer 0 is `false`, all other integer values are `true`
734
- * Strings
735
- * `true` if 'true', 'yes', 'y' (case independent compare)
736
- * `false` if 'false', 'no', 'n' (case independent compare)
737
- * Boolean is already boolean and is simply returned
734
+ * Float 0.0 is `false`, all other float values are `true`
735
+ * Integer 0 is `false`, all other integer values are `true`
736
+ * Strings
737
+ * `true` if 'true', 'yes', 'y' (case independent compare)
738
+ * `false` if 'false', 'no', 'n' (case independent compare)
739
+ * Boolean is already boolean and is simply returned
738
740
 
739
- ### Conversion to Array and Tuple
741
+ ### Conversion to Array and Tuple
740
742
 
741
- When given a single value as argument:
743
+ When given a single value as argument:
742
744
 
743
- * A non empty `Hash` is converted to an array matching `Array[Tuple[Any,Any], 1]`.
744
- * An empty `Hash` becomes an empty array.
745
- * An `Array` is simply returned.
746
- * An `Iterable[T]` is turned into an array of `T` instances.
747
- * A `Binary` is converted to an `Array[Integer[0,255]]` of byte values
745
+ * A non empty `Hash` is converted to an array matching `Array[Tuple[Any,Any], 1]`.
746
+ * An empty `Hash` becomes an empty array.
747
+ * An `Array` is simply returned.
748
+ * An `Iterable[T]` is turned into an array of `T` instances.
749
+ * A `Binary` is converted to an `Array[Integer[0,255]]` of byte values
748
750
 
749
751
 
750
- When given a second Boolean argument:
752
+ When given a second Boolean argument:
751
753
 
752
- * if `true`, a value that is not already an array is returned as a one element array.
753
- * if `false`, (the default), converts the first argument as shown above.
754
+ * if `true`, a value that is not already an array is returned as a one element array.
755
+ * if `false`, (the default), converts the first argument as shown above.
754
756
 
755
- **Example:** Ensuring value is an array
757
+ **Example:** Ensuring value is an array
756
758
 
757
- ```puppet
758
- $arr = Array($value, true)
759
- ```
760
-
761
- Conversion to a `Tuple` works exactly as conversion to an `Array`, only that the constructed array is
762
- asserted against the given tuple type.
763
-
764
- ### Conversion to Hash and Struct
765
-
766
- Accepts a single value as argument:
767
-
768
- * An empty `Array` becomes an empty `Hash`
769
- * An `Array` matching `Array[Tuple[Any,Any], 1]` is converted to a hash where each tuple describes a key/value entry
770
- * An `Array` with an even number of entries is interpreted as `[key1, val1, key2, val2, ...]`
771
- * An `Iterable` is turned into an `Array` and then converted to hash as per the array rules
772
- * A `Hash` is simply returned
759
+ ```puppet
760
+ $arr = Array($value, true)
761
+ ```
762
+
763
+ Conversion to a `Tuple` works exactly as conversion to an `Array`, only that the constructed array is
764
+ asserted against the given tuple type.
765
+
766
+ ### Conversion to Hash and Struct
767
+
768
+ Accepts a single value as argument:
769
+
770
+ * An empty `Array` becomes an empty `Hash`
771
+ * An `Array` matching `Array[Tuple[Any,Any], 1]` is converted to a hash where each tuple describes a key/value entry
772
+ * An `Array` with an even number of entries is interpreted as `[key1, val1, key2, val2, ...]`
773
+ * An `Iterable` is turned into an `Array` and then converted to hash as per the array rules
774
+ * A `Hash` is simply returned
773
775
 
774
- Alternatively, a tree can be constructed by giving two values; an array of tuples on the form `[path, value]`
775
- (where the `path` is the path from the root of a tree, and `value` the value at that position in the tree), and
776
- either the option `'tree'` (do not convert arrays to hashes except the top level), or
777
- `'hash_tree'` (convert all arrays to hashes).
776
+ Alternatively, a tree can be constructed by giving two values; an array of tuples on the form `[path, value]`
777
+ (where the `path` is the path from the root of a tree, and `value` the value at that position in the tree), and
778
+ either the option `'tree'` (do not convert arrays to hashes except the top level), or
779
+ `'hash_tree'` (convert all arrays to hashes).
778
780
 
779
- The tree/hash_tree forms of Hash creation are suited for transforming the result of an iteration
780
- using `tree_each` and subsequent filtering or mapping.
781
+ The tree/hash_tree forms of Hash creation are suited for transforming the result of an iteration
782
+ using `tree_each` and subsequent filtering or mapping.
781
783
 
782
- **Example:** Mapping a hash tree
784
+ **Example:** Mapping a hash tree
783
785
 
784
- Mapping an arbitrary structure in a way that keeps the structure, but where some values are replaced
785
- can be done by using the `tree_each` function, mapping, and then constructing a new Hash from the result:
786
+ Mapping an arbitrary structure in a way that keeps the structure, but where some values are replaced
787
+ can be done by using the `tree_each` function, mapping, and then constructing a new Hash from the result:
786
788
 
787
- ```puppet
788
- # A hash tree with 'water' at different locations
789
- $h = { a => { b => { x => 'water'}}, b => { y => 'water'} }
790
- # a helper function that turns water into wine
791
- function make_wine($x) { if $x == 'water' { 'wine' } else { $x } }
792
- # create a flattened tree with water turned into wine
793
- $flat_tree = $h.tree_each.map |$entry| { [$entry[0], make_wine($entry[1])] }
794
- # create a new Hash and log it
795
- notice Hash($flat_tree, 'hash_tree')
796
- ```
797
-
798
- Would notice the hash `{a => {b => {x => wine}}, b => {y => wine}}`
799
-
800
- Conversion to a `Struct` works exactly as conversion to a `Hash`, only that the constructed hash is
801
- asserted against the given struct type.
789
+ ```puppet
790
+ # A hash tree with 'water' at different locations
791
+ $h = { a => { b => { x => 'water'}}, b => { y => 'water'} }
792
+ # a helper function that turns water into wine
793
+ function make_wine($x) { if $x == 'water' { 'wine' } else { $x } }
794
+ # create a flattened tree with water turned into wine
795
+ $flat_tree = $h.tree_each.map |$entry| { [$entry[0], make_wine($entry[1])] }
796
+ # create a new Hash and log it
797
+ notice Hash($flat_tree, 'hash_tree')
798
+ ```
799
+
800
+ Would notice the hash `{a => {b => {x => wine}}, b => {y => wine}}`
801
+
802
+ Conversion to a `Struct` works exactly as conversion to a `Hash`, only that the constructed hash is
803
+ asserted against the given struct type.
802
804
 
803
- ### Conversion to a Regexp
805
+ ### Conversion to a Regexp
804
806
 
805
- A `String` can be converted into a `Regexp`
807
+ A `String` can be converted into a `Regexp`
806
808
 
807
- **Example**: Converting a String into a Regexp
808
- ```puppet
809
- $s = '[a-z]+\.com'
810
- $r = Regexp($s)
811
- if('foo.com' =~ $r) {
812
- ...
813
- }
814
- ```
809
+ **Example**: Converting a String into a Regexp
810
+ ```puppet
811
+ $s = '[a-z]+\.com'
812
+ $r = Regexp($s)
813
+ if('foo.com' =~ $r) {
814
+ ...
815
+ }
816
+ ```
815
817
 
816
- ### Creating a SemVer
817
-
818
- A SemVer object represents a single [Semantic Version](http://semver.org/).
819
- It can be created from a String, individual values for its parts, or a hash specifying the value per part.
820
- See the specification at [semver.org](http://semver.org/) for the meaning of the SemVer's parts.
821
-
822
- The signatures are:
823
-
824
- ```puppet
825
- type PositiveInteger = Integer[0,default]
826
- type SemVerQualifier = Pattern[/\A(?<part>[0-9A-Za-z-]+)(?:\.\g<part>)*\Z/]
827
- type SemVerString = String[1]
828
- type SemVerHash =Struct[{
829
- major => PositiveInteger,
830
- minor => PositiveInteger,
831
- patch => PositiveInteger,
832
- Optional[prerelease] => SemVerQualifier,
833
- Optional[build] => SemVerQualifier
834
- }]
835
-
836
- function SemVer.new(SemVerString $str)
837
-
838
- function SemVer.new(
839
- PositiveInteger $major
840
- PositiveInteger $minor
841
- PositiveInteger $patch
842
- Optional[SemVerQualifier] $prerelease = undef
843
- Optional[SemVerQualifier] $build = undef
844
- )
845
-
846
- function SemVer.new(SemVerHash $hash_args)
847
- ```
818
+ ### Creating a SemVer
819
+
820
+ A SemVer object represents a single [Semantic Version](http://semver.org/).
821
+ It can be created from a String, individual values for its parts, or a hash specifying the value per part.
822
+ See the specification at [semver.org](http://semver.org/) for the meaning of the SemVer's parts.
823
+
824
+ The signatures are:
825
+
826
+ ```puppet
827
+ type PositiveInteger = Integer[0,default]
828
+ type SemVerQualifier = Pattern[/\A(?<part>[0-9A-Za-z-]+)(?:\.\g<part>)*\Z/]
829
+ type SemVerString = String[1]
830
+ type SemVerHash =Struct[{
831
+ major => PositiveInteger,
832
+ minor => PositiveInteger,
833
+ patch => PositiveInteger,
834
+ Optional[prerelease] => SemVerQualifier,
835
+ Optional[build] => SemVerQualifier
836
+ }]
837
+
838
+ function SemVer.new(SemVerString $str)
839
+
840
+ function SemVer.new(
841
+ PositiveInteger $major
842
+ PositiveInteger $minor
843
+ PositiveInteger $patch
844
+ Optional[SemVerQualifier] $prerelease = undef
845
+ Optional[SemVerQualifier] $build = undef
846
+ )
847
+
848
+ function SemVer.new(SemVerHash $hash_args)
849
+ ```
848
850
 
849
- **Examples:** SemVer and SemVerRange usage
850
-
851
- ```puppet
852
- # As a type, SemVer can describe disjunct ranges which versions can be
853
- # matched against - here the type is constructed with two
854
- # SemVerRange objects.
855
- #
856
- $t = SemVer[
857
- SemVerRange('>=1.0.0 <2.0.0'),
858
- SemVerRange('>=3.0.0 <4.0.0')
859
- ]
860
- notice(SemVer('1.2.3') =~ $t) # true
861
- notice(SemVer('2.3.4') =~ $t) # false
862
- notice(SemVer('3.4.5') =~ $t) # true
863
- ```
864
-
865
- ### Creating a SemVerRange
866
-
867
- A `SemVerRange` object represents a range of `SemVer`. It can be created from
868
- a `String`, or from two `SemVer` instances, where either end can be given as
869
- a literal `default` to indicate infinity. The string format of a `SemVerRange` is specified by
870
- the [Semantic Version Range Grammar](https://github.com/npm/node-semver#ranges).
871
-
872
- > Use of the comparator sets described in the grammar (joining with `||`) is not supported.
873
-
874
- The signatures are:
875
-
876
- ```puppet
877
- type SemVerRangeString = String[1]
878
- type SemVerRangeHash = Struct[{
879
- min => Variant[Default, SemVer],
880
- Optional[max] => Variant[Default, SemVer],
881
- Optional[exclude_max] => Boolean
882
- }]
883
-
884
- function SemVerRange.new(
885
- SemVerRangeString $semver_range_string
886
- )
887
-
888
- function SemVerRange.new(
889
- Variant[Default,SemVer] $min
890
- Variant[Default,SemVer] $max
891
- Optional[Boolean] $exclude_max = undef
892
- )
893
-
894
- function SemVerRange.new(
895
- SemVerRangeHash $semver_range_hash
896
- )
897
- ```
898
-
899
- For examples of `SemVerRange` use, see "Creating a SemVer".
900
-
901
- ### Creating a Binary
902
-
903
- A `Binary` object represents a sequence of bytes and it can be created from a String in Base64 format,
904
- an Array containing byte values. A Binary can also be created from a Hash containing the value to convert to
905
- a `Binary`.
906
-
907
- The signatures are:
908
-
909
- ```puppet
910
- type ByteInteger = Integer[0,255]
911
- type Base64Format = Enum["%b", "%u", "%B", "%s"]
912
- type StringHash = Struct[{value => String, "format" => Optional[Base64Format]}]
913
- type ArrayHash = Struct[{value => Array[ByteInteger]}]
914
- type BinaryArgsHash = Variant[StringHash, ArrayHash]
915
-
916
- function Binary.new(
917
- String $base64_str,
918
- Optional[Base64Format] $format
919
- )
920
-
921
- function Binary.new(
922
- Array[ByteInteger] $byte_array
923
- }
924
-
925
- # Same as for String, or for Array, but where arguments are given in a Hash.
926
- function Binary.new(BinaryArgsHash $hash_args)
927
- ```
928
-
929
- The formats have the following meaning:
930
-
931
- | format | explanation |
932
- | ---- | ---- |
933
- | B | The data is in base64 strict encoding
934
- | u | The data is in URL safe base64 encoding
935
- | b | The data is in base64 encoding, padding as required by base64 strict, is added by default
936
- | s | The data is a puppet string. The string must be valid UTF-8, or convertible to UTF-8 or an error is raised.
937
- | r | (Ruby Raw) the byte sequence in the given string is used verbatim irrespective of possible encoding errors
938
-
939
- * The default format is `%B`.
940
- * Note that the format `%r` should be used sparingly, or not at all. It exists for backwards compatibility reasons when someone receiving
941
- a string from some function and that string should be treated as Binary. Such code should be changed to return a Binary instead of a String.
942
-
943
- **Examples:** Creating a Binary
944
-
945
- ```puppet
946
- # create the binary content "abc"
947
- $a = Binary('YWJj')
948
-
949
- # create the binary content from content in a module's file
950
- $b = binary_file('mymodule/mypicture.jpg')
951
- ```
952
-
953
- * Since 4.5.0
954
- * Binary type since 4.8.0
955
-
956
- Creating an instance of a `Type` using the `Init` type.
957
- -------
851
+ **Examples:** SemVer and SemVerRange usage
852
+
853
+ ```puppet
854
+ # As a type, SemVer can describe disjunct ranges which versions can be
855
+ # matched against - here the type is constructed with two
856
+ # SemVerRange objects.
857
+ #
858
+ $t = SemVer[
859
+ SemVerRange('>=1.0.0 <2.0.0'),
860
+ SemVerRange('>=3.0.0 <4.0.0')
861
+ ]
862
+ notice(SemVer('1.2.3') =~ $t) # true
863
+ notice(SemVer('2.3.4') =~ $t) # false
864
+ notice(SemVer('3.4.5') =~ $t) # true
865
+ ```
866
+
867
+ ### Creating a SemVerRange
868
+
869
+ A `SemVerRange` object represents a range of `SemVer`. It can be created from
870
+ a `String`, or from two `SemVer` instances, where either end can be given as
871
+ a literal `default` to indicate infinity. The string format of a `SemVerRange` is specified by
872
+ the [Semantic Version Range Grammar](https://github.com/npm/node-semver#ranges).
873
+
874
+ > Use of the comparator sets described in the grammar (joining with `||`) is not supported.
875
+
876
+ The signatures are:
877
+
878
+ ```puppet
879
+ type SemVerRangeString = String[1]
880
+ type SemVerRangeHash = Struct[{
881
+ min => Variant[Default, SemVer],
882
+ Optional[max] => Variant[Default, SemVer],
883
+ Optional[exclude_max] => Boolean
884
+ }]
885
+
886
+ function SemVerRange.new(
887
+ SemVerRangeString $semver_range_string
888
+ )
889
+
890
+ function SemVerRange.new(
891
+ Variant[Default,SemVer] $min
892
+ Variant[Default,SemVer] $max
893
+ Optional[Boolean] $exclude_max = undef
894
+ )
895
+
896
+ function SemVerRange.new(
897
+ SemVerRangeHash $semver_range_hash
898
+ )
899
+ ```
900
+
901
+ For examples of `SemVerRange` use, see "Creating a SemVer".
902
+
903
+ ### Creating a Binary
904
+
905
+ A `Binary` object represents a sequence of bytes and it can be created from a String in Base64 format,
906
+ an Array containing byte values. A Binary can also be created from a Hash containing the value to convert to
907
+ a `Binary`.
908
+
909
+ The signatures are:
910
+
911
+ ```puppet
912
+ type ByteInteger = Integer[0,255]
913
+ type Base64Format = Enum["%b", "%u", "%B", "%s"]
914
+ type StringHash = Struct[{value => String, "format" => Optional[Base64Format]}]
915
+ type ArrayHash = Struct[{value => Array[ByteInteger]}]
916
+ type BinaryArgsHash = Variant[StringHash, ArrayHash]
917
+
918
+ function Binary.new(
919
+ String $base64_str,
920
+ Optional[Base64Format] $format
921
+ )
922
+
923
+ function Binary.new(
924
+ Array[ByteInteger] $byte_array
925
+ }
926
+
927
+ # Same as for String, or for Array, but where arguments are given in a Hash.
928
+ function Binary.new(BinaryArgsHash $hash_args)
929
+ ```
930
+
931
+ The formats have the following meaning:
932
+
933
+ | format | explanation |
934
+ | ---- | ---- |
935
+ | B | The data is in base64 strict encoding
936
+ | u | The data is in URL safe base64 encoding
937
+ | b | The data is in base64 encoding, padding as required by base64 strict, is added by default
938
+ | s | The data is a puppet string. The string must be valid UTF-8, or convertible to UTF-8 or an error is raised.
939
+ | r | (Ruby Raw) the byte sequence in the given string is used verbatim irrespective of possible encoding errors
940
+
941
+ * The default format is `%B`.
942
+ * Note that the format `%r` should be used sparingly, or not at all. It exists for backwards compatibility reasons when someone receiving
943
+ a string from some function and that string should be treated as Binary. Such code should be changed to return a Binary instead of a String.
944
+
945
+ **Examples:** Creating a Binary
946
+
947
+ ```puppet
948
+ # create the binary content "abc"
949
+ $a = Binary('YWJj')
950
+
951
+ # create the binary content from content in a module's file
952
+ $b = binary_file('mymodule/mypicture.jpg')
953
+ ```
954
+
955
+ * Since 4.5.0
956
+ * Binary type since 4.8.0
957
+
958
+ Creating an instance of a `Type` using the `Init` type.
959
+ -------
958
960
 
959
- The type `Init[T]` describes a value that can be used when instantiating a type. When used as the first argument in a call to `new`, it
960
- will dispatch the call to its contained type and optionally augment the parameter list with additional arguments.
961
+ The type `Init[T]` describes a value that can be used when instantiating a type. When used as the first argument in a call to `new`, it
962
+ will dispatch the call to its contained type and optionally augment the parameter list with additional arguments.
961
963
 
962
- **Example:** Creating an instance of Integer using Init[Integer]
964
+ **Example:** Creating an instance of Integer using Init[Integer]
963
965
 
964
- ```puppet
965
- # The following declaration
966
- $x = Init[Integer].new('128')
967
- # is exactly the same as
968
- $x = Integer.new('128')
969
- ```
966
+ ```puppet
967
+ # The following declaration
968
+ $x = Init[Integer].new('128')
969
+ # is exactly the same as
970
+ $x = Integer.new('128')
971
+ ```
970
972
 
971
- or, with base 16 and using implicit new
973
+ or, with base 16 and using implicit new
972
974
 
973
- ```puppet
974
- # The following declaration
975
- $x = Init[Integer,16]('80')
976
- # is exactly the same as
977
- $x = Integer('80', 16)
978
- ```
975
+ ```puppet
976
+ # The following declaration
977
+ $x = Init[Integer,16]('80')
978
+ # is exactly the same as
979
+ $x = Integer('80', 16)
980
+ ```
979
981
 
980
- **Example:** Creating an instance of String using a predefined format
982
+ **Example:** Creating an instance of String using a predefined format
981
983
 
982
- ```puppet
983
- $fmt = Init[String,'%#x']
984
- notice($fmt(256)) # will notice '0x100'
985
- ```
984
+ ```puppet
985
+ $fmt = Init[String,'%#x']
986
+ notice($fmt(256)) # will notice '0x100'
987
+ ```
986
988
 
987
- DOC
988
- ) do |args|
989
+ DOC
990
+ ) do |_args|
989
991
  Puppet::Parser::Functions::Error.is4x('new')
990
992
  end
991
-