Add deprecated tag

I had a stab at adding the deprecated flag

Fixes #339

Author: b4ldr

Gemfile

@@ -20,11 +20,12 @@ group :development do
   gem 'json_spec', '~> 1.1', '>= 1.1.5'
 
   gem 'mdl', '~> 0.11.0'
-  gem 'mocha'
 
   gem 'pry', require: false
   gem 'pry-byebug', require: false
   gem 'pry-stack_explorer', require: false
+  # Need the following otherwise we end up with puppetlabs_spec_helper 1.1.1
+  gem 'mocha', '~> 1.0'
   gem 'puppetlabs_spec_helper'
 
   gem 'rake'

lib/puppet-strings/markdown/base.rb

@@ -20,6 +20,7 @@ module PuppetStrings::Markdown
   #    [{:tag_name=>"summary", :text=>"A simple class."},
   #     {:tag_name=>"since", :text=>"1.0.0"},
   #     {:tag_name=>"see", :name=>"www.puppet.com"},
+  #     {:tag_name=>"deprecated", :text=>"Use a something else"},
   #     {:tag_name=>"example",
   #      :text=>
   #       "class { 'klass':\n" +
@@ -93,7 +94,8 @@ def initialize(registry, component_type)
       since: 'since',
       summary: 'summary',
       note: 'note',
-      todo: 'todo' }.each do |method_name, tag_name|
+      todo: 'todo',
+      deprecated: 'deprecated' }.each do |method_name, tag_name|
       # @return [String] unless the tag is nil or the string.empty?
       define_method method_name do
         @tags.find { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }[:text] if @tags.any? { |tag| tag[:tag_name] == tag_name && !tag[:text].empty? }

lib/puppet-strings/markdown/templates/classes_and_defines.erb

@@ -8,6 +8,10 @@
 <%= "The #{name} class." %>
 <% end -%>
 
+<% if deprecated -%>
+* **DEPRECATED** <%= deprecated %>
+
+<% end -%>
 <% if todo -%>
 * **TODO** <%= todo %>
 

lib/puppet-strings/markdown/templates/data_type.erb

@@ -8,6 +8,10 @@
 <%= "The #{name} data type." %>
 <% end -%>
 
+<% if deprecated -%>
+* **DEPRECATED** <%= deprecated %>
+
+<% end -%>
 <% if todo -%>
 * **TODO** <%= todo %>
 

lib/puppet-strings/markdown/templates/function.erb

@@ -11,6 +11,10 @@ Type: <%= type %>
 <% else -%>
 <%= "The #{name} function." %>
 
+<% end -%>
+<% if deprecated -%>
+* **DEPRECATED** <%= deprecated %>
+
 <% end -%>
 <% if todo -%>
 * **TODO** <%= todo %>

lib/puppet-strings/markdown/templates/resource_type.erb

@@ -8,6 +8,10 @@
 <%= "The #{name} type." %>
 <% end -%>
 
+<% if deprecated -%>
+* **DEPRECATED** <%= deprecated %>
+
+<% end -%>
 <% if todo -%>
 * **TODO** <%= todo %>
 

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

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
 end
 
 # Renders the box_info section.

lib/puppet-strings/yard/templates/default/puppet_data_type/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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

@@ -1,7 +1,7 @@
 # Initializes the template.
 # @return [void]
 def init
-  sections :header, :box_info, :summary, :overview, :note, :todo, T('tags'), :method_details_list, [T('method_details')], :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :method_details_list, [T('method_details')], :source
 end
 
 def method_listing

lib/puppet-strings/yard/templates/default/puppet_data_type_alias/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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

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

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

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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, :summary, :overview, :note, :todo, T('tags'), :source
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :source
 end

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

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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, :summary, :overview, [:note, :todo, T('tags'), :source]
+  sections :header, :box_info, :summary, :overview, [:note, :todo, :deprecated, T('tags'), :source]
 end

lib/puppet-strings/yard/templates/default/puppet_plan/html/deprecated.erb

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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

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

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

@@ -0,0 +1,6 @@
+<% object.tags(:deprecated).each do |tag| %>
+  <div class="note deprecated">
+    <strong>DEPRECATED:</strong>
+    <%= htmlify_line deprecated.text %>
+  </div>
+<% end %>

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, :summary, :overview, :note, :todo, T('tags'), :properties, :parameters, :features
+  sections :header, :box_info, :summary, :overview, :note, :todo, :deprecated, T('tags'), :properties, :parameters, :features
 end
 
 # Renders the box_info section.

spec/fixtures/puppet/class.pp

@@ -1,6 +1,7 @@
 # An overview for a simple class.
 # @summary A simple class.
 # @todo Do a thing
+# @deprecated Use a something else
 # @note some note
 # @since 1.0.0
 # @see www.puppet.com

spec/unit/puppet-strings/json_spec.rb

@@ -10,6 +10,7 @@
     expect(YARD::Parser::SourceParser.parse_string(<<~'SOURCE', :puppet).enumerator.length).to eq(2)
       # A simple class.
       # @todo Do a thing
+      # @deprecated Use a something else
       # @note Some note
       # @param param1 First param.
       # @param param2 Second param.

spec/unit/puppet-strings/markdown/base_spec.rb

@@ -9,6 +9,7 @@
         # An overview
         # @api private
         # @summary A simple class.
+        # @deprecated Use a something else
         # @param param1 First param.
         # @param param2 Second param.
         # @param param3 Third param.
@@ -56,6 +57,12 @@ class klass(Integer $param1, $param2, String $param3 = hi) inherits foo::bar {
       end
     end
 
+    describe '#deprecated' do
+      it 'returns the expected deprecated warning' do
+        expect(component.deprecated).to eq 'Use a something else'
+      end
+    end
+
     describe '#toc_info' do
       let(:toc) { component.toc_info }
 

spec/unit/puppet-strings/markdown_spec.rb

@@ -91,6 +91,12 @@ def parse_data_type_content
       end
     end
 
+    describe 'deprecated message' do
+      it 'includes deprecated message' do
+        expect(output).to match(%r{\*\*DEPRECATED\*\* Use a something else})
+      end
+    end
+
     describe 'with Puppet Plans', if: TEST_PUPPET_PLANS do
       before(:each) do
         parse_plan_content
@@ -154,6 +160,10 @@ def parse_data_type_content
         it 'includes return value' do
           expect(output).to match(%r{returns: `optional\[string\]`}i)
         end
+
+        it 'includes return value' do
+          expect(output).to match(%r{returns: `optional\[string\]`}i)
+        end
       end
     end
   end