Merge pull request #281 from joshcooper/file_ensurable

Add support for ensurable in types_extras_handler

Author: jpogran

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

@@ -5,14 +5,15 @@
 require 'puppet-strings/yard/code_objects'
 require 'puppet-strings/yard/util'
 
-# Implements the handler for Puppet resource type newparam/newproperty calls written in Ruby.
+# Implements the handler for Puppet resource type newparam/newproperty/ensurable calls written in Ruby.
 class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Yard::Handlers::Ruby::TypeBase
   # The default docstring when ensurable is used without given a docstring.
   DEFAULT_ENSURABLE_DOCSTRING = 'The basic property that the resource should be in.'
 
   namespace_only
   handles method_call(:newparam)
   handles method_call(:newproperty)
+  handles method_call(:ensurable)
 
   process do
 
@@ -38,9 +39,15 @@ class PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler < PuppetStrings::Ya
     method1_name = statement[0].children.drop(1).find{ |c| c.type == :ident }.source
     return unless ['Type', 'Puppet::Type'].include?(module_name) && method1_name == 'type'
 
+    # ensurable is syntatic sugar for newproperty
     typename = get_name(statement[0], 'Puppet::Type.type')
-    method2_name = caller_method
-    propertyname = get_name(statement, "Puppet::Type.type().#{method2_name}")
+    if caller_method == 'ensurable'
+      method2_name = 'newproperty'
+      propertyname = 'ensure'
+    else
+      method2_name = caller_method
+      propertyname = get_name(statement, "Puppet::Type.type().#{method2_name}")
+    end
 
     typeobject = get_type_yard_object(typename)
 

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'puppet-strings/yard'
+
+describe PuppetStrings::Yard::Handlers::Ruby::TypeExtrasHandler do
+  subject {
+    YARD::Parser::SourceParser.parse_string(source, :ruby)
+    YARD::Registry.all(:puppet_type)
+  }
+
+  describe 'parsing source with newproperty' do
+    let(:source) { <<~SOURCE
+      Puppet::Type.newtype(:database) do
+        desc 'database'
+      end
+      Puppet::Type.type(:database).newproperty(:file) do
+        desc 'The database file to use.'
+      end
+    SOURCE
+    }
+
+    it 'generates a doc string for a property' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object.properties.size).to eq(1)
+      expect(object.properties[0].name).to eq('file')
+      expect(object.properties[0].docstring).to eq('The database file to use.')
+    end
+  end
+
+  describe 'parsing source with newparam' do
+    let(:source) { <<~SOURCE
+      Puppet::Type.newtype(:database) do
+        desc 'database'
+      end
+      Puppet::Type.type(:database).newparam(:name) do
+        desc 'The database server name.'
+      end
+    SOURCE
+    }
+
+    it 'generates a doc string for a parameter that is also a namevar' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object.parameters.size).to eq(1)
+      expect(object.parameters[0].name).to eq('name')
+      expect(object.parameters[0].docstring).to eq('The database server name.')
+      expect(object.parameters[0].isnamevar).to eq(true)
+    end
+  end
+
+  describe 'parsing source with ensurable' do
+    let(:source) { <<~SOURCE
+      Puppet::Type.newtype(:database) do
+        desc 'database'
+      end
+      Puppet::Type.type(:database).ensurable do
+        desc 'What state the database should be in.'
+      end
+    SOURCE
+    }
+
+    it 'generates a doc string for an ensurable' do
+      expect(subject.size).to eq(1)
+      object = subject.first
+      expect(object.properties.size).to eq(1)
+      expect(object.properties[0].name).to eq('ensure')
+      expect(object.properties[0].docstring).to eq('What state the database should be in.')
+    end
+  end
+end