puppet-strings 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c66cddb3ce959fa86315c18de4cfd36e9c4b332
-  data.tar.gz: f71b3c4062b8ca1155c619d3634ca6da4ff0e2c1
+  metadata.gz: 617d17b2ad3472b75cc4710c3041ff341f32f908
+  data.tar.gz: b79393ed1448e9a68e870b1c7c26e5e1e0fa7cd3
 SHA512:
-  metadata.gz: 8aec3266ab3f8dccc3b6d8417c9862d07fd9f7c4d53e5945ebd0b502fb01ca5e3d31264ec71971799d5e61580bbb6d097b97a28ecba98acf331a7b095c658c0d
-  data.tar.gz: e1f0b911bdef1670b9db4beab036683cfd241193330008e44d443a83a235e17661ebfbbcc6995daa80381b29c2f166036af7d869659b6861cfbfd74355821621
+  metadata.gz: fd878646dc1c5daa2d95cd60a8ee63ca1550862ee1cfefe333a826ba452b6ed5962460f49717cb754ee734b8a8a2aeab1a88b752b49ed358c05043da552ae6d6
+  data.tar.gz: 4991c269e0354a10b447078f8714627c034b00bcbdc8db0a1d99243e9f1108fdb7a1367540abe79405a3d1ac255f1d6f16d461b0819f4abe8f47cf877a8d5e42

data/CHANGELOG.md

@@ -1,29 +1,41 @@
-##2017-03-20 - Release 1.1.0
+## 2017-10-20 - Release 1.1.1
 
-###Summary
+### BugFixes
+- Remove timestamps from footer of generated HTML pages ([GeoffWilliams](https://github.com/GeoffWilliams))
+- Fix argument handling for `rake strings::generate` ([hashar](https://github.com/hashar))
+
+### Other
+- Fixed Markdown formatting issues in CHANGELOG ([maju6406](https://github.com/maju6406))
+- Fixed typo in README ([hfm](https://github.com/hfm))
+- Fixed Markdown formatting issues in README ([gguillotte](https://github.com/gguillotte))
+- Update Travis CI configurations for Ruby and Puppet versions ([ghoneycutt](https://github.com/ghoneycutt))
+
+## 2017-03-20 - Release 1.1.0
+
+### Summary
 
 This release adds a new `summary` tag which can be used to add a short description to classes, functions, types, and providers. In addition, `@param` tags can now include type information in Puppet 4 code without warnings being issued.
 
 All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.1.0](https://tickets.puppetlabs.com/issues/?filter=25603).
 
-###Features
+### Features
 - The `summary` tag can be added to any code that puppet-strings supports. The recommended length limit for a summary is 140 characters. Warnings will be issued for strings longer than this limit.
 - Puppet 4 parameter types can now be explicitly documented. Previously, this was not allowed because Puppet 4 parameter types can be automatically determined without extra documentation. However, users may desire to do so anyway for consistency. Strings will emit a warning if the documented type does not match the actual type. In such an event, the incorrect documented type will be ignored in favor of the real one.
 
-##2016-11-28 - Release 1.0.0
+## 2016-11-28 - Release 1.0.0
 
-###Summary
+### Summary
 
 This release fixes up minor bugs from the 0.99.0 release and modifies the JSON schema for Puppet functions.
 
 All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com/browse/PDOC) JIRA project with the fix version of [1.0.0](https://tickets.puppetlabs.com/issues/?filter=23607).
 
-###Features
+### Features
 - The JSON schema for Puppet functions has been altered to include a new 'signatures' top-level key **(PDOC-125)**
   - Includes information about all function signatures (overloads). Existing overload key format has been preserved.
 - Reworked README for enhanced clarity **(PDOC-133)**
 
-###BugFixes
+### BugFixes
 - Fixed an issue where the search box in the code navigator overlapped list items below it **(PDOC-93)**
 - Strings can now handle multiple `defaultfor` calls in Puppet providers **(PDOC-95)**
 - Fixed an issue preventing the generated \_index.html file from being uploaded to GitHub pages via the gh_pages task **(PDOC-120)**
@@ -33,15 +45,15 @@ All related tickets can be found under the [PDOC](https://tickets.puppetlabs.com
 - Fixed an issue where certain Ruby string constructs were incompletely stripped from some docstrings **(PDOC-126)**
 - Hanging indents from type feature descriptions are now properly stripped **(PDOC-127)**
 
-##2016-10-10 - Release 0.99.0
+## 2016-10-10 - Release 0.99.0
 
-###Summary
+### Summary
 
 This release includes a complete rewrite of strings, fixing many bugs from previous versions and generally improving the user experience. This release is intended to be the last stop before the strings major version 1.0 is released, and nearly all of the functionality of the major release is included.
 
 All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.99.0](https://tickets.puppetlabs.com/issues/?filter=22705).
 
-###Features
+### Features
 - Complete overhaul, including code cleanup, bug fixes and new functionality **(PDOC-63)**
   - Documentation has been split into sections based on type: puppet 3x API functions, puppet 4x API functions, ruby classes, puppet language functions, types, and providers
   - New JSON schema organized to reflect the separation of types
@@ -55,21 +67,21 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
   - Note that the gem still requires puppet. We recommend that the strings gem be installed with puppet, as suggested in the  [README](https://github.com/puppetlabs/puppet-strings/blob/master/README.md#installing-puppet-strings)
 - New gemspec requirement on Ruby version 1.9.3, the oldest supported Ruby version
 
-###BugFixes
+### BugFixes
 
 - Prevents a blizzard of errors when documenting Puppet Core source and some puppet modules **(PDOC-63)**
   - As this is a complete rewrite, many known and unknown bugs from the original code were fixed along the way
 - Allow strings to be installed in PE 3.8 without overwriting existing puppet and facter installations with newer gems
 
-##2016-03-30 - Release 0.4.0
+## 2016-03-30 - Release 0.4.0
 
-###Summary
+### Summary
 
 This release adds JSON output support for strings, fixes a major bug that prevented strings from working with the 4.4.0 release of puppet, and is the last version of strings that will be released as a module.
 
 All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.4.0](https://tickets.puppetlabs.com/issues/?filter=18810).
 
-###Features
+### Features
 - Support for JSON output **(PDOC-23)**
   - Strings now has the ability to produce a JSON representation of a given puppet module
   - The details of the JSON schema can be found [here](https://github.com/puppetlabs/puppet-strings/blob/master/json_dom.md)
@@ -79,27 +91,27 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
   - The 0.4.0 release will be released concurrently as a ruby gem
   - After this release, all updates will only be available via the gem
 
-###Bugfixes
+### Bugfixes
 
 - Fix issue that prevented strings from running with Puppet 4.4.0 **(PDOC-75)**
 
-##2015-09-22 - Release 0.3.1
+## 2015-09-22 - Release 0.3.1
 
-###Summary
+### Summary
 
 This is a minor bug fix release.
 
 All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.3.1](https://tickets.puppetlabs.com/issues/?filter=15530).
 
-###Bugfixes
+### Bugfixes
 
 - Prevent strings from printing unnecessary quotes in error messages **(PDOC-57)**
 - Issue correct type check warnings for defined types **(PDOC-56)**
 - Allow providers, types, and defines to have the same name **(PDOC-54)**
 
-##2015-09-21 - Release 0.3.0
+## 2015-09-21 - Release 0.3.0
 
-###Summary
+### Summary
 
 This release includes support for Puppet Types and Providers, as well as
 type checking Puppet 4x functions and defined types.
@@ -107,7 +119,7 @@ type checking Puppet 4x functions and defined types.
 All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with
 the fix version of [0.3.0](https://tickets.puppetlabs.com/issues/?filter=15529).
 
-####Features
+#### Features
 
 - Support for Puppet Types and Providers **(PDOC-35)**
 - Type check Puppet 4x functions and defined types where possible and warn the user when types don't match.
@@ -123,22 +135,22 @@ the fix version of [0.3.0](https://tickets.puppetlabs.com/issues/?filter=15529).
   - Installation instructions using Puppet **(PDOC-33)**
 
 
-####Bugfixes
+#### Bugfixes
 
 - Fix markdown list processing **(PDOC-30)**
 - Fix namespacing for nested classes and defined types **(PDOC-20)**
 
 
-##2015-03-17 - Release 0.2.0
+## 2015-03-17 - Release 0.2.0
 
-###Summary
+### Summary
 
 This release includes improvements to the HTML output generated by strings and a few bug fixes.
 All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with the fix version of [0.2.0](https://tickets.puppetlabs.com/issues/?filter=13760).
 
 [PDOC JIRA]: https://tickets.puppetlabs.com/browse/PDOC
 
-####Features
+#### Features
 - Custom YARD templates for classes and defined types **(PDOC-17)**
     - Improved HMTL output that is more appropriate for Puppet code (especially for parameters)
     - Support for the explicit list of YARD tags we will be supporting initially (@param, @return, @since, @example)
@@ -150,8 +162,7 @@ All related tickets can be found under the [PDOC][PDOC JIRA] JIRA project with t
     - Our own custom YARD templates which can be easily extended and tweaked
 - Addition of RubCop Travis CI job to ensure code quality and consistency **(PDOC-8)**
 
-####Bugfixes
+#### Bugfixes
 - Puppet namespaces are no longer mangled for nested classes and defined types **(PDOC-25)**
 - Strings is now compatible with the renaming of the Puppetx/puppetx namespace to PuppetX/puppet_x **(PDOC-26)**
 - Strings will no longer crash when documenting 3x functions with less than two arguments passed into newfunction **(PDOC-27)**
-

data/Gemfile

@@ -23,6 +23,7 @@ group :acceptance do
   gem 'beaker', '< 3.0'
   gem 'beaker-rspec'
   gem 'beaker-hostgenerator'
+  gem 'beaker-abs'
 end
 
 group :development do

data/README.md

@@ -37,7 +37,7 @@ Note that if you are running PE 3.8, you'll have a few extra steps to install pu
 
 The easiest way to install the `yard` gem is with Puppet itself:
 
-For Puppet 4.x and Puppet Enterprise 2015.2 and later:
+For Puppet >= 4 and Puppet Enterprise 2015.2 and later:
 
 ```
 $ puppet resource package yard provider=puppet_gem
@@ -120,7 +120,7 @@ To generate documentation for a Puppet module, run Strings from that module's di
 To generate documentation for specific files in a module, run the `puppet strings generate` subcommand and specify the files. 
 
 ```
-puppet strings generate first.pp second.pp`
+puppet strings generate first.pp second.pp
 ```
 
 To generate documentation for specific directories, run the `puppet strings generate` command and specify the directories:
@@ -438,19 +438,19 @@ The `strings:generate` and `strings:gh_pages:update` tasks are available in `pup
 
 First, update your Gemfile and your Rakefile.:
 
-1. Add the following to your Gemfile to use `puppet-strings`:
+1.  Add the following to your Gemfile to use `puppet-strings`:
 
-   ```ruby
-gem 'puppet-strings'
-   ```
+    ```ruby
+    gem 'puppet-strings'
+    ```
 
-2. Add the following to your `Rakefile` to use the `puppet-strings` tasks:
+2.  Add the following to your `Rakefile` to use the `puppet-strings` tasks:
 
-   ```ruby
-require 'puppet-strings/tasks'
-   ```
+    ```ruby
+    require 'puppet-strings/tasks'
+    ```
    
-   Adding this `require` automatically creates the Rake tasks below.
+    Adding this `require` automatically creates the Rake tasks below.
 
 #### Generate documentation with additional options
 

data/Rakefile

@@ -23,6 +23,7 @@ task :acceptance do
 
   install_type = 'aio'
   target = ENV['platform']
+  abs = if ENV['BEAKER_ABS'] then 'abs' else 'vmpooler' end
   if ! target
     STDERR.puts 'TEST_TARGET environment variable is not set'
     STDERR.puts 'setting to default value of "centos7-64ma".'
@@ -34,7 +35,7 @@ task :acceptance do
     target += "{type=#{install_type}}"
   end
 
-  cli = BeakerHostGenerator::CLI.new([target])
+  cli = BeakerHostGenerator::CLI.new([target, '--hypervisor', abs])
   nodeset_dir = 'spec/acceptance/nodesets'
   nodeset = "#{nodeset_dir}/#{target}.yml"
   FileUtils.mkdir_p(nodeset_dir)

data/lib/puppet-strings/tasks/generate.rb

@@ -14,8 +14,11 @@ namespace :strings do
       markup: args[:markup] || 'markdown',
     }
 
-    options[:json] = args[:json] if args.key? :json
-    options[:yard_args] = args[:yard_args].split if args.key? :yard_args
+	# rubocop:disable Style/PreferredHashMethods
+	# `args` is a Rake::TaskArguments and has no key? method
+    options[:json] = args[:json] if args.has_key? :json
+    options[:yard_args] = args[:yard_args].split if args.has_key? :yard_args
+	# rubocop:enable Style/PreferredHashMethods
 
     PuppetStrings.generate(patterns, options)
   end

data/lib/puppet-strings/yard/templates/default/layout/html/footer.erb

@@ -0,0 +1,3 @@
+<div id="footer">
+     Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
+</div>

data/spec/acceptance/emit_json_options.rb

@@ -5,37 +5,37 @@ require 'json'
 include PuppetStrings::Acceptance::Util
 
 describe 'Emitting JSON' do
-expected = {
-  "puppet_classes" => [],
-  "defined_types" => [],
-  "resource_types" => [],
-  "providers" => [],
-  "puppet_functions" => [
-    "name" => "function3x",
-    "file" => "/etc/puppet/modules/test/lib/puppet/parser/functions/function3x.rb",
-    "line" => 1,
-    "type" => "ruby3x",
-    "signatures" => [
-      {
-        "signature" =>"function3x()",
-        "docstring" => {
-          "text" => "This is the function documentation for `function3x`",
-          "tags" => [
-            {
-              "tag_name"=>"return",
-              "text"=>"",
-              "types"=>["Any"]
-            }
-          ]
-        }
-      },
-    ],
-    "docstring" => {
-      "text" => "This is the function documentation for `function3x`",
-      "tags" => ["tag_name" => "return", "text" => "", "types" => ["Any"]]},
-      "source" => "Puppet::Parser::Functions.newfunction(:function3x, :doc => \"This is the function documentation for `function3x`\") do |args|\nend"
-  ]
-}
+  expected = {
+    "puppet_classes" => [],
+    "defined_types" => [],
+    "resource_types" => [],
+    "providers" => [],
+    "puppet_functions" => [
+      "name" => "function3x",
+      "file" => "/etc/puppet/modules/test/lib/puppet/parser/functions/function3x.rb",
+      "line" => 1,
+      "type" => "ruby3x",
+      "signatures" => [
+        {
+          "signature" =>"function3x()",
+          "docstring" => {
+            "text" => "This is the function documentation for `function3x`",
+            "tags" => [
+              {
+                "tag_name"=>"return",
+                "text"=>"",
+                "types"=>["Any"]
+              }
+            ]
+          }
+        },
+      ],
+      "docstring" => {
+        "text" => "This is the function documentation for `function3x`",
+        "tags" => ["tag_name" => "return", "text" => "", "types" => ["Any"]]},
+        "source" => "Puppet::Parser::Functions.newfunction(:function3x, :doc => \"This is the function documentation for `function3x`\") do |args|\nend"
+    ]
+  }
 
   it 'should emit JSON to stdout when using the --emit-json-stdout option' do
     test_module_path = get_test_module_path(master, /Module test/)
@@ -49,7 +49,7 @@ expected = {
     test_module_path = get_test_module_path(master, /Module test/)
     tmpfile = master.tmpfile('json_output.json')
     on master, puppet('strings', 'generate', "--emit-json #{tmpfile}", "#{test_module_path}/lib/puppet/parser/functions/function3x.rb")
-      output = read_file_on(master, tmpfile)
-      expect(JSON.parse(output)).to eq(expected)
+    output = read_file_on(master, tmpfile)
+    expect(JSON.parse(output)).to eq(expected)
   end
 end

data/spec/acceptance/lib/util.rb

@@ -75,7 +75,7 @@ A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
 -----END CERTIFICATE-----
 EOM
 
-GLOBALSIGN_CA = <<-EOM
+      GLOBALSIGN_CA = <<-EOM
 -----BEGIN CERTIFICATE-----
 MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG
 A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv

data/spec/unit/puppet-strings/yard/parsers/puppet/parser_spec.rb

@@ -170,14 +170,14 @@ SOURCE
   end
 
   describe 'parsing puppet functions with return type in defintion', if: TEST_FUNCTION_RETURN_TYPE do
-      let(:source) { <<SOURCE
+    let(:source) { <<SOURCE
   # A simple foo function.
   # @return Returns a string
   function foo() >> String {
     notice world
   }
 SOURCE
-      }
+    }
 
     it 'should parse the puppet function statement' do
       subject.parse
@@ -189,14 +189,14 @@ SOURCE
   end
 
   describe 'parsing puppet functions with complex return types in defintion', if: TEST_FUNCTION_RETURN_TYPE do
-      let(:source) { <<SOURCE
+    let(:source) { <<SOURCE
   # A simple foo function.
   # @return Returns a struct with a hash including one key which must be an integer between 1 and 10.
   function foo() >> Struct[{'a' => Integer[1, 10]}] {
     notice world
   }
 SOURCE
-      }
+    }
 
     it 'should parse the puppet function statement' do
       subject.parse

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -83,6 +83,7 @@ files:
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_provider.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_type.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/setup.rb
+- lib/puppet-strings/yard/templates/default/layout/html/footer.erb
 - lib/puppet-strings/yard/templates/default/layout/html/objects.erb
 - lib/puppet-strings/yard/templates/default/layout/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/box_info.erb
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - puppet, >= 3.7.0
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD