puppet-strings 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2beba5e6c9153efb0208b8dd2fe19eb0ae1ea589
-  data.tar.gz: f64ddfa0a74a5aeef8e525cbb59512888dd6bc2f
+  metadata.gz: 1c66cddb3ce959fa86315c18de4cfd36e9c4b332
+  data.tar.gz: f71b3c4062b8ca1155c619d3634ca6da4ff0e2c1
 SHA512:
-  metadata.gz: 144215672c483f72a13b23897613fdf7440e6c6ce4d4310b407d7192a889037e58a1bc38a4a9d40b3fbf121c91bde7ccca2e126a374e91828a768c8a69b04405
-  data.tar.gz: 1e3525e0d4689fee040d12c9dac44f6184803d49327aa6707d18d64d641543deea47e526adf38c5a3af2dab4da6c1e46f86612c52fe747bbadabd4a71102b7e6
+  metadata.gz: 8aec3266ab3f8dccc3b6d8417c9862d07fd9f7c4d53e5945ebd0b502fb01ca5e3d31264ec71971799d5e61580bbb6d097b97a28ecba98acf331a7b095c658c0d
+  data.tar.gz: e1f0b911bdef1670b9db4beab036683cfd241193330008e44d443a83a235e17661ebfbbcc6995daa80381b29c2f166036af7d869659b6861cfbfd74355821621

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+##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
+- 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
 
 ###Summary

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 gem 'rgen'
 gem 'redcarpet'
-gem 'yard', '~> 0.9.5'
+gem 'yard', '0.9.5'
 
 if ENV['PUPPET_GEM_VERSION']
   gem 'puppet', ENV['PUPPET_GEM_VERSION'], :require => false
@@ -34,6 +34,6 @@ group :development do
   end
 end
 
-gem 'json',      '<= 1.8'   if RUBY_VERSION < '2.0.0'
-gem 'json_pure', '<= 2.0.1' if RUBY_VERSION < '2.0.0'
-gem 'rubocop'               if RUBY_VERSION >= '2.0.0'
+gem 'json',      '<= 1.8'    if RUBY_VERSION < '2.0.0'
+gem 'json_pure', '<= 2.0.1'  if RUBY_VERSION < '2.0.0'
+gem 'rubocop',   '<= 0.47.0' if RUBY_VERSION >= '2.0.0'

data/MAINTAINERS

@@ -0,0 +1,17 @@
+{
+  "version": 1,
+  "file_format": "This MAINTAINERS file format is described at http://pup.pt/maintainers",
+  "issues": "https://tickets.puppetlabs.com/browse/PDOC",
+  "people": [
+    {
+      "github": "whopper",
+      "email": "whopper@puppet.com",
+      "name": "Will Hopper"
+    },
+    {
+      "github": "scotje",
+      "email": "jesse@puppet.com",
+      "name": "Jesse Scott"
+    }
+  ]
+}

data/README.md

@@ -49,13 +49,20 @@ For Puppet 3.x:
 $ puppet resource package yard provider=gem
 ```
 
-For Puppet Enterprise 3.8:
+For Puppet Enterprise 3.8 (Linux):
 
 ```
 GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package yard provider=gem
 ```
 
-### 2. Puppet Enterprise 3.8 only: Install the redcarpet gem
+For Puppet Enterprise 3.8 (Windows):
+
+```
+$env:GEM_HOME = "C:\Program Files\Puppet Labs\Puppet Enterprise\sys\ruby\lib\ruby\gems\2.0.0"
+puppet resource package yard provider=gem
+```
+
+### 2. Puppet Enterprise 3.8 in Linux only: Install the redcarpet gem
 
 ```
 GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package redcarpet provider=gem
@@ -77,12 +84,19 @@ For Puppet 3.x:
 $ puppet resource package puppet-strings provider=gem
 ```
 
-For Puppet Enterprise 3.8:
+For Puppet Enterprise 3.8 (Linux):
 
 ```
 GEM_HOME=/opt/puppet/lib/ruby/gems/1.9.1 puppet resource package puppet-strings provider=gem
 ```
 
+For Puppet Enterprise 3.8 (Windows)
+
+```
+$env:GEM_HOME = "C:\Program Files\Puppet Labs\Puppet Enterprise\sys\ruby\lib\ruby\gems\2.0.0"
+puppet resource package puppet-strings provider=gem
+```
+
 ### 4. Optional: Set YARD options for Strings
 
 Puppet Strings supports YARD options (on the command line, run `yard help doc` for a list of possible options. To set YARD options, specify a `yardopts` file in the same directory in which you run `puppet strings`. 
@@ -176,6 +190,8 @@ To document Puppet classes and defined types, use a series of comments to create
 #
 # This is an example of how to document a Puppet class
 #
+# @summary A short summary of the purpose of the class.
+#
 # @example Declaring the class
 #   include example
 #
@@ -192,19 +208,20 @@ class example_class(
 The Strings elements appearing in the above comment block are:
 
 * Three comment lines, not prefixed with tags, give the class description.
+* The `@summary` YARD tag, which can be used for a short description of the class (fewer than 140 characters recommended).
 * The `@example` YARD tag, immediately followed by an optional title.
 * The `include` statement, which adds the usage example code.
 * Two `@param` tags, with the name of the parameter first, followed by a string describing the parameter's purpose.
 
-Puppet 4 is a typed language, so Puppet Strings automatically documents the parameter types from code. With Puppet 3, however, include the parameter type with the `@param` tag:
+Puppet 4 is a typed language, so Puppet Strings automatically documents the parameter types from code. You may optionally include a parameter type in the `@param` tag. Strings will emit a warning and ignore the documented type should it differ from the actual type.
+
+With Puppet 3 code, you must always include the parameter type with the `@param` tag:
 
 ```
-# @param [String] first The first parameter for this class.
-# @param [Integer] second The second parameter for this class.
+# @param first [String] The first parameter for this class.
+# @param second [Integer] The second parameter for this class.
 ```
 
-Note that if you document a parameter's type, and that parameter already has a Puppet type specifier, Strings emits a warning.
-
 Defined types are documented in exactly the same way as classes:
 
 ```
@@ -332,8 +349,8 @@ To document a function in the Puppet 3 API, use the `doc` option to `newfunction
 ```ruby
 Puppet::Parser::Functions.newfunction(:example, doc: <<-DOC
 Documentation for an example 3.x function.
-@param [String] param1 The first parameter.
-@param [Integer] param2 The second parameter.
+@param param1 [String] The first parameter.
+@param param2 [Integer] The second parameter.
 @return [Undef]
 @example Calling the function.
   example('hi', 10)

data/Rakefile

@@ -21,12 +21,17 @@ end
 task :acceptance do
   require 'beaker-hostgenerator'
 
+  install_type = 'aio'
   target = ENV['platform']
   if ! target
     STDERR.puts 'TEST_TARGET environment variable is not set'
     STDERR.puts 'setting to default value of "centos7-64ma".'
-    target = 'centos7-64ma'
-    ENV['platform'] = target
+    target = "centos7-64ma{type=#{install_type}}"
+  end
+
+  unless target =~ /type=/
+    puts "INFO: adding 'type=#{install_type}' to host config"
+    target += "{type=#{install_type}}"
   end
 
   cli = BeakerHostGenerator::CLI.new([target])
@@ -36,10 +41,15 @@ task :acceptance do
   File.open(nodeset, 'w') do |fh|
     fh.print(cli.execute)
   end
+  puts "nodeset file:"
   puts nodeset
   sh 'gem build puppet-strings.gemspec'
   sh 'puppet module build spec/fixtures/acceptance/modules/test'
-  sh "BEAKER_set=#{ENV['platform']} rspec spec/acceptance/*.rb"
+  if ENV['BEAKER_keyfile']
+    sh "BEAKER_set=#{target} rspec spec/acceptance/*.rb"
+  else
+    sh "BEAKER_keyfile=$HOME/.ssh/id_rsa-acceptance BEAKER_set=#{target} rspec spec/acceptance/*.rb"
+  end
 end
 
 task(:rubocop) do

data/lib/puppet-strings/yard.rb

@@ -24,6 +24,9 @@ module PuppetStrings::Yard
     PuppetStrings::Yard::Tags::ParameterDirective.register!
     PuppetStrings::Yard::Tags::PropertyDirective.register!
 
+    # Register the summary tag
+    PuppetStrings::Yard::Tags::SummaryTag.register!
+
     # Ignore documentation on Puppet DSL calls
     # This prevents the YARD DSL parser from emitting warnings for Puppet's Ruby DSL
     YARD::Handlers::Ruby::DSLHandlerMethods::IGNORE_METHODS['create_function'] = true

data/lib/puppet-strings/yard/handlers/helpers.rb

@@ -0,0 +1,8 @@
+module PuppetStrings::Yard::Handlers::Helpers
+  # Logs a warning if a summary tag has more than 140 characters
+  def self.validate_summary_tag(object)
+    if object.has_tag?(:summary) && object.tag(:summary).text.length > 140
+      log.warn "The length of the summary for #{object.type} '#{object.name}' exceeds the recommended limit of 140 characters."
+    end
+  end
+end

data/lib/puppet-strings/yard/handlers/puppet/base.rb

@@ -31,8 +31,8 @@ class PuppetStrings::Yard::Handlers::Puppet::Base < YARD::Handlers::Base
         next
       end
 
-      # Warn if the parameter is typed and the tag also has a type
-      log.warn "The @param tag for parameter '#{parameter.name}' should not contain a type specification near #{statement.file}:#{statement.line}: ignoring in favor of parameter type information." if parameter.type && tag.types && !tag.types.empty?
+      # Warn if the parameter type and tag types don't match
+      log.warn "The type of the @param tag for parameter '#{parameter.name}' does not match the parameter type specification near #{statement.file}:#{statement.line}: ignoring in favor of parameter type information." if parameter.type && tag.types && !tag.types.empty? && parameter.type != tag.types[0]
 
       if parameter.type
         tag.types = [parameter.type]

data/lib/puppet-strings/yard/handlers/puppet/class_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/puppet/base'
 require 'puppet-strings/yard/parsers'
 require 'puppet-strings/yard/code_objects'
@@ -19,5 +20,8 @@ class PuppetStrings::Yard::Handlers::Puppet::ClassHandler < PuppetStrings::Yard:
 
     # Mark the class as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 end

data/lib/puppet-strings/yard/handlers/puppet/defined_type_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/puppet/base'
 require 'puppet-strings/yard/parsers'
 require 'puppet-strings/yard/code_objects'
@@ -19,5 +20,8 @@ class PuppetStrings::Yard::Handlers::Puppet::DefinedTypeHandler < PuppetStrings:
 
     # Mark the defined type as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 end

data/lib/puppet-strings/yard/handlers/puppet/function_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/puppet/base'
 require 'puppet-strings/yard/parsers'
 require 'puppet-strings/yard/code_objects'
@@ -27,6 +28,9 @@ class PuppetStrings::Yard::Handlers::Puppet::FunctionHandler < PuppetStrings::Ya
 
     # Mark the class as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 
   private

data/lib/puppet-strings/yard/handlers/ruby/function_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
 require 'puppet-strings/yard/util'
@@ -61,6 +62,9 @@ class PuppetStrings::Yard::Handlers::Ruby::FunctionHandler < PuppetStrings::Yard
 
     # Mark the function as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 
   private

data/lib/puppet-strings/yard/handlers/ruby/provider_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
 require 'puppet-strings/yard/util'
@@ -34,6 +35,9 @@ class PuppetStrings::Yard::Handlers::Ruby::ProviderHandler < PuppetStrings::Yard
 
     # Mark the provider as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 
   private

data/lib/puppet-strings/yard/handlers/ruby/type_handler.rb

@@ -1,3 +1,4 @@
+require 'puppet-strings/yard/handlers/helpers'
 require 'puppet-strings/yard/handlers/ruby/base'
 require 'puppet-strings/yard/code_objects'
 require 'puppet-strings/yard/util'
@@ -30,6 +31,9 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeHandler < PuppetStrings::Yard::Ha
 
     # Mark the type as public if it doesn't already have an api tag
     object.add_tag YARD::Tags::Tag.new(:api, 'public') unless object.has_tag? :api
+
+    # Warn if a summary longer than 140 characters was provided
+    PuppetStrings::Yard::Handlers::Helpers.validate_summary_tag(object) if object.has_tag? :summary
   end
 
   private

data/lib/puppet-strings/yard/tags.rb

@@ -3,4 +3,5 @@ module PuppetStrings::Yard::Tags
   require 'puppet-strings/yard/tags/parameter_directive'
   require 'puppet-strings/yard/tags/property_directive'
   require 'puppet-strings/yard/tags/overload_tag'
+  require 'puppet-strings/yard/tags/summary_tag'
 end

data/lib/puppet-strings/yard/tags/summary_tag.rb

@@ -0,0 +1,9 @@
+# Implements a summary tag for general purpose short descriptions
+
+class PuppetStrings::Yard::Tags::SummaryTag < YARD::Tags::Tag
+  # Registers the tag with YARD.
+  # @return [void]
+  def self.register!
+    YARD::Tags::Library.define_tag("puppet.summary", :summary)
+  end
+end

data/lib/puppet-strings/yard/templates/default/puppet_class/html/setup.rb

@@ -1,7 +1,7 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :overview, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, T('tags'), :source
 end
 
 # Renders the box_info section.

data/lib/puppet-strings/yard/templates/default/puppet_class/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_defined_type/html/setup.rb

@@ -1,5 +1,5 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :overview, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, T('tags'), :source
 end

data/lib/puppet-strings/yard/templates/default/puppet_defined_type/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb

@@ -1,5 +1,5 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :overview, [T('tags'), :source]
+  sections :header, :box_info, :summary, :overview, [T('tags'), :source]
 end

data/lib/puppet-strings/yard/templates/default/puppet_function/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_provider/html/setup.rb

@@ -1,7 +1,7 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :overview, T('tags'), :features, :confines, :defaults, :commands
+  sections :header, :box_info, :summary, :overview, T('tags'), :features, :confines, :defaults, :commands
 end
 
 # Renders the confines section.

data/lib/puppet-strings/yard/templates/default/puppet_provider/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb

@@ -1,7 +1,7 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :overview, T('tags'), :properties, :parameters, :features
+  sections :header, :box_info, :summary, :overview, T('tags'), :properties, :parameters, :features
 end
 
 # Renders the box_info section.

data/lib/puppet-strings/yard/templates/default/puppet_type/html/summary.erb

@@ -0,0 +1,4 @@
+<% if object.docstring.has_tag?(:summary) %>
+  <h2>Summary</h2>
+  <%= object.docstring.tag(:summary).text %>
+<% end %>

data/spec/acceptance/lib/util.rb

@@ -1,6 +1,104 @@
 module PuppetStrings
   module Acceptance
     module Util
+      GEOTRUST_GLOBAL_CA = <<-EOM
+-----BEGIN CERTIFICATE-----
+MIIDVDCCAjygAwIBAgIDAjRWMA0GCSqGSIb3DQEBBQUAMEIxCzAJBgNVBAYTAlVT
+MRYwFAYDVQQKEw1HZW9UcnVzdCBJbmMuMRswGQYDVQQDExJHZW9UcnVzdCBHbG9i
+YWwgQ0EwHhcNMDIwNTIxMDQwMDAwWhcNMjIwNTIxMDQwMDAwWjBCMQswCQYDVQQG
+EwJVUzEWMBQGA1UEChMNR2VvVHJ1c3QgSW5jLjEbMBkGA1UEAxMSR2VvVHJ1c3Qg
+R2xvYmFsIENBMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA2swYYzD9
+9BcjGlZ+W988bDjkcbd4kdS8odhM+KhDtgPpTSEHCIjaWC9mOSm9BXiLnTjoBbdq
+fnGk5sRgprDvgOSJKA+eJdbtg/OtppHHmMlCGDUUna2YRpIuT8rxh0PBFpVXLVDv
+iS2Aelet8u5fa9IAjbkU+BQVNdnARqN7csiRv8lVK83Qlz6cJmTM386DGXHKTubU
+1XupGc1V3sjs0l44U+VcT4wt/lAjNvxm5suOpDkZALeVAjmRCw7+OC7RHQWa9k0+
+bw8HHa8sHo9gOeL6NlMTOdReJivbPagUvTLrGAMoUgRx5aszPeE4uwc2hGKceeoW
+MPRfwCvocWvk+QIDAQABo1MwUTAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQWBBTA
+ephojYn7qwVkDBF9qn1luMrMTjAfBgNVHSMEGDAWgBTAephojYn7qwVkDBF9qn1l
+uMrMTjANBgkqhkiG9w0BAQUFAAOCAQEANeMpauUvXVSOKVCUn5kaFOSPeCpilKIn
+Z57QzxpeR+nBsqTP3UEaBU6bS+5Kb1VSsyShNwrrZHYqLizz/Tt1kL/6cdjHPTfS
+tQWVYrmm3ok9Nns4d0iXrKYgjy6myQzCsplFAMfOEVEiIuCl6rYVSAlk6l5PdPcF
+PseKUgzbFbS9bZvlxrFUaKnjaZC2mqUPuLk/IH2uSrW4nOQdtqvmlKXBx4Ot2/Un
+hw4EbNX/3aBd7YdStysVAq45pmp06drE57xNNB6pXE0zX5IJL4hmXXeXxx12E6nV
+5fEWCRE11azbJHFwLJhWC9kXtNHjUStedejV0NxPNO3CBWaAocvmMw==
+-----END CERTIFICATE-----
+EOM
+
+      USERTRUST_NETWORK_CA = <<-EOM
+-----BEGIN CERTIFICATE-----
+MIIEdDCCA1ygAwIBAgIQRL4Mi1AAJLQR0zYq/mUK/TANBgkqhkiG9w0BAQUFADCB
+lzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQHEw5TYWx0IExha2Ug
+Q2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMSEwHwYDVQQLExho
+dHRwOi8vd3d3LnVzZXJ0cnVzdC5jb20xHzAdBgNVBAMTFlVUTi1VU0VSRmlyc3Qt
+SGFyZHdhcmUwHhcNOTkwNzA5MTgxMDQyWhcNMTkwNzA5MTgxOTIyWjCBlzELMAkG
+A1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQHEw5TYWx0IExha2UgQ2l0eTEe
+MBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMSEwHwYDVQQLExhodHRwOi8v
+d3d3LnVzZXJ0cnVzdC5jb20xHzAdBgNVBAMTFlVUTi1VU0VSRmlyc3QtSGFyZHdh
+cmUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCx98M4P7Sof885glFn
+0G2f0v9Y8+efK+wNiVSZuTiZFvfgIXlIwrthdBKWHTxqctU8EGc6Oe0rE81m65UJ
+M6Rsl7HoxuzBdXmcRl6Nq9Bq/bkqVRcQVLMZ8Jr28bFdtqdt++BxF2uiiPsA3/4a
+MXcMmgF6sTLjKwEHOG7DpV4jvEWbe1DByTCP2+UretNb+zNAHqDVmBe8i4fDidNd
+oI6yqqr2jmmIBsX6iSHzCJ1pLgkzmykNRg+MzEk0sGlRvfkGzWitZky8PqxhvQqI
+DsjfPe58BEydCl5rkdbux+0ojatNh4lz0G6k0B4WixThdkQDf2Os5M1JnMWS9Ksy
+oUhbAgMBAAGjgbkwgbYwCwYDVR0PBAQDAgHGMA8GA1UdEwEB/wQFMAMBAf8wHQYD
+VR0OBBYEFKFyXyYbKJhDlV0HN9WFlp1L0sNFMEQGA1UdHwQ9MDswOaA3oDWGM2h0
+dHA6Ly9jcmwudXNlcnRydXN0LmNvbS9VVE4tVVNFUkZpcnN0LUhhcmR3YXJlLmNy
+bDAxBgNVHSUEKjAoBggrBgEFBQcDAQYIKwYBBQUHAwUGCCsGAQUFBwMGBggrBgEF
+BQcDBzANBgkqhkiG9w0BAQUFAAOCAQEARxkP3nTGmZev/K0oXnWO6y1n7k57K9cM
+//bey1WiCuFMVGWTYGufEpytXoMs61quwOQt9ABjHbjAbPLPSbtNk28Gpgoiskli
+CE7/yMgUsogWXecB5BKV5UU0s4tpvc+0hY91UZ59Ojg6FEgSxvunOxqNDYJAB+gE
+CJChicsZUN/KHAG8HQQZexB2lzvukJDKxA4fFm517zP4029bHpbj4HR3dHuKom4t
+3XbWOTCC8KucUvIqx69JXn7HaOWCgchqJ/kniCrVWFCVH/A7HFe7fRQ5YiuayZSS
+KqMiDP+JJn1fIytH1xUdqWqeUQ0qUZ6B+dQ7XnASfxAynB67nfhmqA==
+-----END CERTIFICATE-----
+EOM
+
+      EQUIFAX_CA = <<-EOM
+-----BEGIN CERTIFICATE-----
+MIIDIDCCAomgAwIBAgIENd70zzANBgkqhkiG9w0BAQUFADBOMQswCQYDVQQGEwJV
+UzEQMA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2Vy
+dGlmaWNhdGUgQXV0aG9yaXR5MB4XDTk4MDgyMjE2NDE1MVoXDTE4MDgyMjE2NDE1
+MVowTjELMAkGA1UEBhMCVVMxEDAOBgNVBAoTB0VxdWlmYXgxLTArBgNVBAsTJEVx
+dWlmYXggU2VjdXJlIENlcnRpZmljYXRlIEF1dGhvcml0eTCBnzANBgkqhkiG9w0B
+AQEFAAOBjQAwgYkCgYEAwV2xWGcIYu6gmi0fCG2RFGiYCh7+2gRvE4RiIcPRfM6f
+BeC4AfBONOziipUEZKzxa1NfBbPLZ4C/QgKO/t0BCezhABRP/PvwDN1Dulsr4R+A
+cJkVV5MW8Q+XarfCaCMczE1ZMKxRHjuvK9buY0V7xdlfUNLjUA86iOe/FP3gx7kC
+AwEAAaOCAQkwggEFMHAGA1UdHwRpMGcwZaBjoGGkXzBdMQswCQYDVQQGEwJVUzEQ
+MA4GA1UEChMHRXF1aWZheDEtMCsGA1UECxMkRXF1aWZheCBTZWN1cmUgQ2VydGlm
+aWNhdGUgQXV0aG9yaXR5MQ0wCwYDVQQDEwRDUkwxMBoGA1UdEAQTMBGBDzIwMTgw
+ODIyMTY0MTUxWjALBgNVHQ8EBAMCAQYwHwYDVR0jBBgwFoAUSOZo+SvSspXXR9gj
+IBBPM5iQn9QwHQYDVR0OBBYEFEjmaPkr0rKV10fYIyAQTzOYkJ/UMAwGA1UdEwQF
+MAMBAf8wGgYJKoZIhvZ9B0EABA0wCxsFVjMuMGMDAgbAMA0GCSqGSIb3DQEBBQUA
+A4GBAFjOKer89961zgK5F7WF0bnj4JXMJTENAKaSbn+2kmOeUJXRmm/kEd5jhW6Y
+7qj/WsjTVbJmcVfewCHrPSqnI0kBBIZCe/zuf6IWUrVnZ9NA2zsmWLIodz2uFHdh
+1voqZiegDfqnc1zqcPGUIWVEX/r87yloqaKHee9570+sB3c4
+-----END CERTIFICATE-----
+EOM
+
+GLOBALSIGN_CA = <<-EOM
+-----BEGIN CERTIFICATE-----
+MIIDdTCCAl2gAwIBAgILBAAAAAABFUtaw5QwDQYJKoZIhvcNAQEFBQAwVzELMAkG
+A1UEBhMCQkUxGTAXBgNVBAoTEEdsb2JhbFNpZ24gbnYtc2ExEDAOBgNVBAsTB1Jv
+b3QgQ0ExGzAZBgNVBAMTEkdsb2JhbFNpZ24gUm9vdCBDQTAeFw05ODA5MDExMjAw
+MDBaFw0yODAxMjgxMjAwMDBaMFcxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9i
+YWxTaWduIG52LXNhMRAwDgYDVQQLEwdSb290IENBMRswGQYDVQQDExJHbG9iYWxT
+aWduIFJvb3QgQ0EwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDaDuaZ
+jc6j40+Kfvvxi4Mla+pIH/EqsLmVEQS98GPR4mdmzxzdzxtIK+6NiY6arymAZavp
+xy0Sy6scTHAHoT0KMM0VjU/43dSMUBUc71DuxC73/OlS8pF94G3VNTCOXkNz8kHp
+1Wrjsok6Vjk4bwY8iGlbKk3Fp1S4bInMm/k8yuX9ifUSPJJ4ltbcdG6TRGHRjcdG
+snUOhugZitVtbNV4FpWi6cgKOOvyJBNPc1STE4U6G7weNLWLBYy5d4ux2x8gkasJ
+U26Qzns3dLlwR5EiUWMWea6xrkEmCMgZK9FGqkjWZCrXgzT/LCrBbBlDSgeF59N8
+9iFo7+ryUp9/k5DPAgMBAAGjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMBAf8E
+BTADAQH/MB0GA1UdDgQWBBRge2YaRQ2XyolQL30EzTSo//z9SzANBgkqhkiG9w0B
+AQUFAAOCAQEA1nPnfE920I2/7LqivjTFKDK1fPxsnCwrvQmeU79rXqoRSLblCKOz
+yj1hTdNGCbM+w6DjY1Ub8rrvrTnhQ7k4o+YviiY776BQVvnGCv04zcQLcFGUl5gE
+38NflNUVyRRBnMRddWQVDf9VMOyGj/8N7yy5Y0b2qvzfvGn9LhJIZJrglfCm7ymP
+AbEVtQwdpf5pLGkkeB6zpxxxYu7KyJesF12KwvhHhm4qxFYxldBniYUr+WymXUad
+DKqC5JlR3XC321Y9YeRq4VzW9v493kHMB65jUr9TU/Qr6cf9tveCX4XSQRjbgbME
+HMUfpIBvFSDJ3gyICh3WZlXi/EjJKSZp4A==
+-----END CERTIFICATE-----
+EOM
+
       def read_file_on(host, filename)
         on(host, "cat #{filename}").stdout
       end
@@ -10,6 +108,56 @@ module PuppetStrings
         test_module_info = modules['modules_by_path'].values.flatten.find { |mod_info| mod_info =~ module_regex }
         test_module_info.match(/\(([^)]*)\)/)[1]
       end
+
+      def install_ca_certs(host)
+        return unless host.platform =~ /windows/
+
+        step "Installing Geotrust CA cert"
+        create_remote_file(host, "geotrustglobal.pem", GEOTRUST_GLOBAL_CA)
+        on host, "chmod 644 geotrustglobal.pem"
+        on host, "cmd /c certutil -v -addstore Root `cygpath -w geotrustglobal.pem`"
+
+        step "Installing Usertrust Network CA cert"
+        create_remote_file(host, "usertrust-network.pem", USERTRUST_NETWORK_CA)
+        on host, "chmod 644 usertrust-network.pem"
+        on host, "cmd /c certutil -v -addstore Root `cygpath -w usertrust-network.pem`"
+
+        step "Installing Equifax CA cert"
+        create_remote_file(host, "equifax.pem", EQUIFAX_CA)
+        on host, "chmod 644 equifax.pem"
+        on host, "cmd /c certutil -v -addstore Root `cygpath -w equifax.pem`"
+
+        step "Installing Globalsign CA cert"
+        create_remote_file(host, "globalsign.pem", GLOBALSIGN_CA)
+        on host, "chmod 644 globalsign.pem"
+        on host, "cmd /c certutil -v -addstore Root `cygpath -w globalsign.pem`"
+        on host, "cp globalsign.pem \"$(cygpath \"#{find_windows_rubygems_ssl_certs_dir(host)}\")\""
+      end
+
+      def find_windows_rubygems_ssl_certs_dir(host)
+        return unless host.platform =~ /windows/
+        ssl_certs_dir = File.dirname(on(host, "#{gem_command(host)} which rubygems").stdout.strip) << '/rubygems/ssl_certs'
+      end
+    end
+
+    module CommandUtils
+      def ruby_command(host)
+        "env PATH=\"#{host['privatebindir']}:${PATH}\" ruby"
+      end
+      module_function :ruby_command
+
+      def gem_command(host, type='aio')
+        if type == 'aio'
+          if host['platform'] =~ /windows/
+            "PATH=\"#{host['privatebindir']}:${PATH}\" cmd /c gem"
+          else
+            "PATH=\"#{host['privatebindir']}:${PATH}\" gem"
+          end
+        else
+          on(host, 'which gem').stdout.chomp
+        end
+      end
+      module_function :gem_command
     end
   end
 end

data/spec/spec_helper_acceptance.rb

@@ -1,7 +1,7 @@
 require 'beaker-rspec/spec_helper'
 require 'beaker-rspec/helpers/serverspec'
-
 $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), 'acceptance/lib'))
+require 'util'
 
 unless ENV['RS_PROVISION'] == 'no'
   install_puppet
@@ -13,15 +13,16 @@ RSpec.configure do |c|
 
   # Configure all nodes in nodeset
   c.before :suite do
+    extend PuppetStrings::Acceptance::CommandUtils
     hosts.each do |host|
       scp_to(host, Dir.glob('puppet-strings*.gem').first, 'puppet-strings.gem')
-      on host, 'gem install puppet-strings.gem'
+      install_ca_certs(host)
+      on host, "#{gem_command(host)} install yard"
+      on host, "#{gem_command(host)} install rgen"
+      on host, "#{gem_command(host)} install puppet-strings.gem"
 
       scp_to(host, Dir.glob('spec/fixtures/acceptance/modules/test/pkg/username-test*.gz').first, 'test.tar.gz')
       on host, puppet('module', 'install', 'test.tar.gz')
-
-      on host, 'gem install yard'
-      on host, 'gem install rgen'
     end
   end
 end

data/spec/unit/puppet-strings/json_spec.rb

@@ -83,7 +83,7 @@ Puppet::Type.type(:database).provide :linux do
   defaultfor :osfamily => 'RedHat', :operatingsystemmajrelease => '7'
   has_feature :implements_some_feature
   has_feature :some_other_feature
-  commands foo: /usr/bin/foo
+  commands foo: '/usr/bin/foo'
 end
 
 Puppet::Type.newtype(:database) do

data/spec/unit/puppet-strings/yard/handlers/puppet/class_handler_spec.rb

@@ -111,7 +111,30 @@ SOURCE
     end
   end
 
-  describe 'parsing a class with a typed parameter that also has a @param tag type' do
+  describe 'parsing a class with a typed parameter that also has a @param tag type which matches' do
+    let(:source) { <<-SOURCE
+# A simple foo class.
+# @param [Integer] param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+class foo(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
+  file { '/tmp/foo':
+    ensure => present
+  }
+}
+SOURCE
+    }
+
+    it 'should respect the type that was documented' do
+      expect{ subject }.to output('').to_stdout_from_any_process
+      expect(subject.size).to eq(1)
+      tags = subject.first.tags(:param)
+      expect(tags.size).to eq(3)
+      expect(tags[0].types).to eq(['Integer'])
+    end
+  end
+
+  describe 'parsing a class with a typed parameter that also has a @param tag type which does not match' do
     let(:source) { <<-SOURCE
 # A simple foo class.
 # @param [Boolean] param1 First param.
@@ -126,7 +149,7 @@ SOURCE
     }
 
     it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: The @param tag for parameter 'param1' should not contain a type specification near \(stdin\):5: ignoring in favor of parameter type information\./).to_stdout_from_any_process
+      expect{ subject }.to output(/\[warn\]: The type of the @param tag for parameter 'param1' does not match the parameter type specification near \(stdin\):5: ignoring in favor of parameter type information./).to_stdout_from_any_process
     end
   end
 
@@ -152,4 +175,43 @@ SOURCE
       expect(tags[1].types).to eq(['Boolean'])
     end
   end
+
+  describe 'parsing a class with a summary' do
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+  # A simple foo class.
+  # @summary A short summary.
+  class foo() {
+    file { '/tmp/foo':
+      ensure => present
+    }
+  }
+  SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+  # A simple foo class.
+  # @summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!
+  class foo() {
+    file { '/tmp/foo':
+      ensure => present
+    }
+  }
+  SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_class 'foo' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/handlers/puppet/defined_type_handler_spec.rb

@@ -111,7 +111,30 @@ SOURCE
     end
   end
 
-  describe 'parsing a defined type with a typed parameter that also has a @param tag type' do
+  describe 'parsing a defined type with a typed parameter that also has a @param tag type which matches' do
+    let(:source) { <<-SOURCE
+# A simple foo defined type.
+# @param [Integer] param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+define foo(Integer $param1, $param2, String $param3 = hi) {
+  file { '/tmp/foo':
+    ensure => present
+  }
+}
+SOURCE
+    }
+
+    it 'should respect the type that was documented' do
+      expect{ subject }.to output('').to_stdout_from_any_process
+      expect(subject.size).to eq(1)
+      tags = subject.first.tags(:param)
+      expect(tags.size).to eq(3)
+      expect(tags[0].types).to eq(['Integer'])
+    end
+  end
+
+  describe 'parsing a defined type with a typed parameter that also has a @param tag type which does not match' do
     let(:source) { <<-SOURCE
 # A simple foo defined type.
 # @param [Boolean] param1 First param.
@@ -126,7 +149,7 @@ SOURCE
     }
 
     it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: The @param tag for parameter 'param1' should not contain a type specification near \(stdin\):5: ignoring in favor of parameter type information\./).to_stdout_from_any_process
+      expect{ subject }.to output(/\[warn\]: The type of the @param tag for parameter 'param1' does not match the parameter type specification near \(stdin\):5: ignoring in favor of parameter type information./).to_stdout_from_any_process
     end
   end
 
@@ -152,4 +175,50 @@ SOURCE
       expect(tags[1].types).to eq(['Boolean'])
     end
   end
+
+  describe 'parsing a defined type with a summary' do
+
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+# A simple foo defined type.
+# @summary A short summary.
+# @param param1 First param.
+# @param [Boolean] param2 Second param.
+# @param param3 Third param.
+define foo(Integer $param1, $param2, String $param3 = hi) {
+  file { '/tmp/foo':
+    ensure => present
+  }
+}
+SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+# A simple foo defined type.
+# @summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!
+# @param param1 First param.
+# @param [Boolean] param2 Second param.
+# @param param3 Third param.
+define foo(Integer $param1, $param2, String $param3 = hi) {
+  file { '/tmp/foo':
+    ensure => present
+  }
+}
+SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_defined_type 'foo' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/handlers/puppet/function_handler_spec.rb

@@ -115,7 +115,29 @@ SOURCE
     end
   end
 
-  describe 'parsing a function with a typed parameter that also has a @param tag type' do
+  describe 'parsing a function with a typed parameter that also has a @param tag type which matches' do
+    let(:source) { <<-SOURCE
+# A simple foo function.
+# @param [Integer] param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+# @return [Undef] Returns nothing.
+function foo(Integer $param1, $param2, String $param3 = hi) {
+  notice 'hello world'
+}
+SOURCE
+    }
+
+    it 'should respect the type that was documented' do
+      expect{ subject }.to output('').to_stdout_from_any_process
+      expect(subject.size).to eq(1)
+      tags = subject.first.tags(:param)
+      expect(tags.size).to eq(3)
+      expect(tags[0].types).to eq(['Integer'])
+    end
+  end
+
+  describe 'parsing a function with a typed parameter that also has a @param tag type which does not match' do
     let(:source) { <<-SOURCE
 # A simple foo function.
 # @param [Boolean] param1 First param.
@@ -129,7 +151,7 @@ SOURCE
     }
 
     it 'should output a warning' do
-      expect{ subject }.to output(/\[warn\]: The @param tag for parameter 'param1' should not contain a type specification near \(stdin\):6: ignoring in favor of parameter type information\./).to_stdout_from_any_process
+      expect{ subject }.to output(/\[warn\]: The type of the @param tag for parameter 'param1' does not match the parameter type specification near \(stdin\):6: ignoring in favor of parameter type information./).to_stdout_from_any_process
     end
   end
 
@@ -238,4 +260,41 @@ SOURCE
       expect(tags[0].types).to eq(['Any'])
     end
   end
+
+  describe 'parsing a function with a summary' do
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+# A simple foo function.
+# @summary A short summary.
+# @return [String] foo
+function foo() {
+  notice 'hello world'
+}
+SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+# A simple foo function.
+# @summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!
+function foo() {
+  notice 'hello world'
+}
+
+SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_function 'foo' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/handlers/ruby/function_handler_spec.rb

@@ -654,4 +654,43 @@ end
       expect{ subject }.to output(/\[warn\]: The docstring for Puppet 4.x function 'foo' contains @return tags near \(stdin\):3: return value documentation should be made on the dispatch call\./).to_stdout_from_any_process
     end
   end
+
+  describe 'parsing a function with a summary' do
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+# An example 4.x function.
+# @summary A short summary.
+Puppet::Functions.create_function(:foo) do
+  # @return [Undef]
+  dispatch :foo do
+  end
+end
+SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+# An example 4.x function.
+# @summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!
+Puppet::Functions.create_function(:foo) do
+  # @return [Undef]
+  dispatch :foo do
+  end
+end
+SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_function 'foo' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/handlers/ruby/provider_handler_spec.rb

@@ -105,4 +105,35 @@ SOURCE
       expect(object.commands).to eq({'foo' => '/usr/bin/foo'})
     end
   end
+
+  describe 'parsing a provider with a summary' do
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+Puppet::Type.type(:custom).provide :linux do
+  @doc = '@summary A short summary.'
+end
+SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+Puppet::Type.type(:custom).provide :linux do
+  @doc = '@summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!'
+end
+SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_provider 'linux' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

data/spec/unit/puppet-strings/yard/handlers/ruby/type_handler_spec.rb

@@ -235,4 +235,35 @@ SOURCE
       expect(object.parameters[0].isnamevar).to eq(true)
     end
   end
+
+  describe 'parsing a type with a summary' do
+    context 'when the summary has fewer than 140 characters' do
+      let(:source) { <<-SOURCE
+Puppet::Type.newtype(:database) do
+  @doc = '@summary A short summary.'
+end
+SOURCE
+      }
+
+      it 'should parse the summary' do
+        expect{ subject }.to output('').to_stdout_from_any_process
+        expect(subject.size).to eq(1)
+        summary = subject.first.tags(:summary)
+        expect(summary.first.text).to eq('A short summary.')
+      end
+    end
+
+    context 'when the summary has more than 140 characters' do
+      let(:source) { <<-SOURCE
+Puppet::Type.newtype(:database) do
+  @doc = '@summary A short summary that is WAY TOO LONG. AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH this is not what a summary is for! It should be fewer than 140 characters!!'
+end
+SOURCE
+      }
+
+      it 'should log a warning' do
+        expect{ subject }.to output(/\[warn\]: The length of the summary for puppet_type 'database' exceeds the recommended limit of 140 characters./).to_stdout_from_any_process
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-strings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Puppet Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-28 00:00:00.000000000 Z
+date: 2017-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -41,6 +41,7 @@ files:
 - Gemfile
 - JSON.md
 - LICENSE
+- MAINTAINERS
 - README.md
 - Rakefile
 - lib/puppet-strings.rb
@@ -58,6 +59,7 @@ files:
 - lib/puppet-strings/yard/code_objects/provider.rb
 - lib/puppet-strings/yard/code_objects/type.rb
 - lib/puppet-strings/yard/handlers.rb
+- lib/puppet-strings/yard/handlers/helpers.rb
 - lib/puppet-strings/yard/handlers/puppet/base.rb
 - lib/puppet-strings/yard/handlers/puppet/class_handler.rb
 - lib/puppet-strings/yard/handlers/puppet/defined_type_handler.rb
@@ -73,6 +75,7 @@ files:
 - lib/puppet-strings/yard/tags/overload_tag.rb
 - lib/puppet-strings/yard/tags/parameter_directive.rb
 - lib/puppet-strings/yard/tags/property_directive.rb
+- lib/puppet-strings/yard/tags/summary_tag.rb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/css/common.css
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_class.erb
 - lib/puppet-strings/yard/templates/default/fulldoc/html/full_list_puppet_defined_type.erb
@@ -87,28 +90,33 @@ files:
 - lib/puppet-strings/yard/templates/default/puppet_class/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_class/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_class/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_defined_type/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_defined_type/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/setup.rb
 - lib/puppet-strings/yard/templates/default/puppet_function/html/source.erb
+- lib/puppet-strings/yard/templates/default/puppet_function/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/collection.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/features.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_provider/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_provider/html/summary.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/box_info.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/features.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/header.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/overview.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/parameters.erb
 - lib/puppet-strings/yard/templates/default/puppet_type/html/setup.rb
+- lib/puppet-strings/yard/templates/default/puppet_type/html/summary.erb
 - lib/puppet-strings/yard/templates/default/tags/html/puppet_overload.erb
 - lib/puppet-strings/yard/templates/default/tags/setup.rb
 - lib/puppet-strings/yard/util.rb
@@ -161,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - puppet, >= 3.7.0
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Puppet documentation via YARD