(#229) Add checks to output for resource types

Resolves #229

Author: scotje

lib/puppet-strings/markdown/resource_type.rb

@@ -12,11 +12,28 @@ def render
     end
 
     def properties
-      @registry[:properties]
+      return nil unless @registry[:properties]
+
+      @registry[:properties].sort_by { |p| p[:name] }
+    end
+
+    def checks
+      return nil unless @registry[:checks]
+
+      @registry[:checks].sort_by { |p| p[:name] }
+    end
+
+    # "checks" (such as "onlyif" or "creates") are another type of property
+    def properties_and_checks
+      return nil if properties.nil? && checks.nil?
+
+      ((properties || []) + (checks || [])).sort_by { |p| p[:name] }
     end
 
     def parameters
-      @registry[:parameters]
+      return nil unless @registry[:parameters]
+
+      @registry[:parameters].sort_by { |p| p[:name] }
     end
 
     def regex_in_data_type?(data_type)

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

@@ -44,12 +44,12 @@
 
 <% end -%>
 <% end -%>
-<% if properties -%>
+<% if properties_and_checks -%>
 #### Properties
 
 The following properties are available in the `<%= name %>` <%= @type %>.
 
-<% properties.each do |prop| -%>
+<% properties_and_checks.each do |prop| -%>
 ##### `<%= prop[:name] %>`
 
 <% if prop[:values] -%>

lib/puppet-strings/yard/code_objects/type.rb

@@ -73,6 +73,9 @@ def to_hash
   class Property < Parameter
   end
 
+  class Check < Parameter
+  end
+
   # Represents a resource type feature.
   class Feature
     attr_reader :name, :docstring
@@ -95,7 +98,7 @@ def to_hash
     end
   end
 
-  attr_reader :properties, :features
+  attr_reader :properties, :features, :checks
 
   # Initializes a new resource type.
   # @param [String] name The resource type name.
@@ -134,6 +137,14 @@ def add_feature(feature)
     @features << feature
   end
 
+  # Adds a check to the resource type.
+  # @param [PuppetStrings::Yard::CodeObjects::Type::Check] check The check to add.
+  # @return [void]
+  def add_check(check)
+    @checks ||= []
+    @checks << check
+  end
+
   def parameters
     # just return params if there are no providers
     return @parameters if providers.empty?
@@ -163,14 +174,18 @@ def providers
   # @return [Hash] Returns a hash representation of the code object.
   def to_hash
     hash = {}
+
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
-    hash[:properties] = properties.map(&:to_hash) if properties && !properties.empty?
-    hash[:parameters] = parameters.map(&:to_hash) if parameters && !parameters.empty?
-    hash[:features] = features.map(&:to_hash) if features && !features.empty?
-    hash[:providers] = self.providers.map(&:to_hash) if providers && !providers.empty?
+
+    hash[:docstring]  = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
+    hash[:properties] = properties.sort_by { |p| p.name }.map(&:to_hash) if properties && !properties.empty?
+    hash[:parameters] = parameters.sort_by { |p| p.name }.map(&:to_hash) if parameters && !parameters.empty?
+    hash[:checks]     = checks.sort_by { |c| c.name }.map(&:to_hash) if checks && !checks.empty?
+    hash[:features]   = features.sort_by { |f| f.name }.map(&:to_hash) if features && !features.empty?
+    hash[:providers]  = providers.sort_by { |p| p.name }.map(&:to_hash) if providers && !providers.empty?
+
     hash
   end
 end

lib/puppet-strings/yard/handlers/ruby/type_base.rb

@@ -52,6 +52,12 @@ def create_property(name, node)
     property
   end
 
+  def create_check(name, node)
+    check = PuppetStrings::Yard::CodeObjects::Type::Check.new(name, find_docstring(node, "Puppet resource check '#{name}'"))
+    set_values(node, check)
+    check
+  end
+
   def set_values(node, object)
     return unless node.block && node.block.count >= 2
 

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

@@ -59,6 +59,12 @@ def populate_type_data(object)
         name = node_as_string(parameters[0])
         next unless name
         object.add_parameter(create_parameter(name, node))
+      elsif method_name == 'newcheck'
+        # Add a check to the object
+        next unless parameters.count >= 1
+        name = node_as_string(parameters[0])
+        next unless name
+        object.add_check(create_check(name, node))
       elsif method_name == 'feature'
         # Add a feature to the object
         next unless parameters.count >= 2

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

@@ -16,7 +16,9 @@ def box_info
 def properties
   # Properties are the same thing as parameters (from the documentation standpoint),
   # so reuse the same template but with a different title and data source.
-  @parameters = object.properties || []
+  #
+  # "checks" such as "creates" and "onlyif" are another type of property
+  @parameters = (object.properties || []) + (object.checks || [])
   @parameters.sort_by! { |p| p.name }
   @tag_title = 'Properties'
   erb(:parameters)

spec/fixtures/ruby/resource_type.rb

@@ -44,4 +44,8 @@
     newvalue(:error)
     defaultto 'warn'
   end
+
+  newcheck(:exists) do
+    desc 'Check to see if the database already exists'
+  end
 end

spec/unit/puppet-strings/markdown_spec.rb

@@ -84,6 +84,12 @@ def parse_data_type_content
       end
     end
 
+    describe 'resource types' do
+      it 'includes checks in parameter list for the database type' do
+        expect(output).to match(/check to see if the database already exists/i)
+      end
+    end
+
     describe 'with Puppet Plans', :if => TEST_PUPPET_PLANS do
       before(:each) do
         parse_plan_content

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

@@ -278,6 +278,25 @@
     end
   end
 
+  describe 'parsing a type with a check with the name of "onlyif"' do
+    let(:source) { <<-SOURCE
+Puppet::Type.newtype(:testexec) do
+  desc 'An example exec type with a check.'
+  newcheck(:onlyif) do
+    desc 'a test check param'
+  end
+end
+    SOURCE
+    }
+
+    it 'should register a check object on the parent type object' do
+      expect(subject.size).to eq(1)
+      type_object = subject.first
+      expect(type_object.checks.size).to eq(1)
+      expect(type_object.checks[0].name).to eq('onlyif')
+    end
+  end
+
   describe 'parsing a type with a summary' do
     context 'when the summary has fewer than 140 characters' do
       let(:source) { <<-SOURCE