Merge pull request #342 from b4ldr/depraceted_tag

Author: chelnak

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=>"No longer supported and will be removed in a future release"},
   #     {: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