(MAINT) Refactor markdown content fixtures into files

Author: scotje

.gitignore

@@ -39,8 +39,8 @@ Gemfile.lock
 /log/
 /*.gem
 /spec/acceptance/nodesets/
-/spec/fixtures/manifests/
 /spec/fixtures/modules/
+/spec/fixtures/manifests/
 /inventory.yaml
 
 ## local coverage results

spec/fixtures/json/task.json

@@ -0,0 +1,22 @@
+{
+  "description": "Allows you to backup your database to local file.",
+  "input_method": "stdin",
+  "parameters": {
+    "database": {
+      "description": "Database to connect to",
+      "type": "Optional[String[1]]"
+    },
+    "user": {
+      "description": "The user",
+      "type": "Optional[String[1]]"
+    },
+    "password": {
+      "description": "The password",
+      "type": "Optional[String[1]]"
+    },
+     "sql": {
+      "description": "Path to file you want backup to",
+      "type": "String[1]"
+    }
+  }
+}

spec/fixtures/puppet/class.pp

@@ -0,0 +1,66 @@
+# An overview for a simple class.
+# @summary A simple class.
+# @todo Do a thing
+# @note some note
+# @since 1.0.0
+# @see www.puppet.com
+# @example This is an example
+#  class { 'klass':
+#    param1 => 1,
+#    param3 => 'foo',
+#  }
+# @example This is another example
+#  class { 'klass':
+#    param1 => 1,
+#    param3 => 'foo',
+#  }
+# @raise SomeError
+# @param param1 First param.
+# @param param2 Second param.
+# @option param2 [String] :opt1 something about opt1
+# @option param2 [Hash] :opt2 a hash of stuff
+# @param param3 Third param.
+# @param param4 Fourth param.
+# @enum param4 :one One option
+# @enum param4 :two Second option
+#
+class klass (
+  Integer $param1 = 1,
+  $param2 = undef,
+  String $param3 = 'hi',
+  Enum['one', 'two'] $param4 = 'two',
+) inherits foo::bar {
+}
+
+# Overview for class noparams
+# @api private
+class noparams () {}
+
+# An overview for a simple defined type.
+# @summary A simple defined type.
+# @since 1.1.0
+# @see www.puppet.com
+# @example Here's an example of this type:
+#  klass::dt { 'foo':
+#    param1 => 33,
+#    param4 => false,
+#  }
+# @return shouldn't return squat
+# @raise SomeError
+# @param param1 First param.
+# @param param2 Second param.
+# @option param2 [String] :opt1 something about opt1
+# @option param2 [Hash] :opt2 a hash of stuff
+# @param param3 Third param.
+# @param param4 Fourth param.
+# @param param5 Fifth param.
+# @enum param5 :a Option A
+# @enum param5 :b Option B
+define klass::dt (
+  Integer $param1 = 44,
+  $param2,
+  String $param3 = 'hi',
+  Boolean $param4 = true,
+  Enum['a', 'b'] $param5 = 'a'
+) {
+}

spec/fixtures/puppet/function.pp

@@ -0,0 +1,14 @@
+# A simple Puppet function.
+# @param param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+# @option param3 [Array] :param3opt Something about this option
+# @param param4 Fourth param.
+# @enum param4 :yes Yes option.
+# @enum param4 :no No option.
+# @raise SomeError this is some error
+# @return [Undef] Returns nothing.
+# @example Test
+#   $result = func(1, 2)
+function func(Integer $param1, $param2, String $param3 = hi, Enum['yes', 'no'] $param4 = 'yes') {
+}

spec/fixtures/puppet/plan.pp

@@ -0,0 +1,6 @@
+# A simple plan.
+# @param param1 First param.
+# @param param2 Second param.
+# @param param3 Third param.
+plan plann(String $param1, $param2, Integer $param3 = 1) {
+}

spec/fixtures/puppet/type_alias.pp

@@ -0,0 +1,8 @@
+# Documentation for Amodule::SimpleAlias
+type Amodule::SimpleAlias = Variant[Numeric,String[1,20]]
+
+# Documentation for Amodule::ComplexAlias
+type Amodule::ComplexAlias = Struct[{
+  value_type => Optional[ValueType],
+  merge      => Optional[MergeType]
+}]

spec/fixtures/ruby/data_type.rb

@@ -0,0 +1,12 @@
+# An example Puppet Data Type in Ruby.
+#
+# @param param1 A variant parameter.
+# @param param2 Optional String parameter.
+Puppet::DataTypes.create_type('UnitDataType') do
+  interface <<-PUPPET
+    attributes => {
+      param1 => Variant[Numeric, String[1,2]],
+      param2 => { type => Optional[String[1]], value => "param2" }
+    }
+    PUPPET
+end

spec/fixtures/ruby/func3x.rb

@@ -0,0 +1,12 @@
+# An example 3.x function
+Puppet::Parser::Functions.newfunction(:func3x, doc: <<-DOC
+ Documentation for an example 3.x function.
+ @param param1 [String] The first parameter.
+ @param param2 [Integer] The second parameter.
+ @return [Undef]
+ @example Calling the function.
+   func3x('hi', 10)
+ DOC
+ ) do |*args|
+   #...
+end

spec/fixtures/ruby/func4x.rb

@@ -0,0 +1,42 @@
+# An example 4.x function.
+#
+# @example Calling the function
+#   $result = func4x(1, 'foo')
+#
+# @example Calling the function with all args
+#   $result = func4x(1, 'foo', ['bar'])
+Puppet::Functions.create_function(:func4x) do
+  # An overview for the first overload.
+  # @raise SomeError this is some error
+  # @param param1 The first parameter.
+  # @param param2 The second parameter.
+  # @option param2 [String] :option an option
+  # @option param2 [String] :option2 another option
+  # @param param3 The third parameter.
+  # @param param4 The fourth parameter.
+  # @enum param4 :one Option one.
+  # @enum param4 :two Option two.
+  # @return Returns nothing.
+  # @example Calling the function foo
+  #   $result = func4x(1, 'foooo')
+  #
+  dispatch :foo do
+    param          'Integer',       :param1
+    param          'Any',           :param2
+    optional_param 'Array[String]', :param3
+    optional_param 'Enum[one, two]', :param4
+    return_type 'Undef'
+  end
+
+  # An overview for the second overload.
+  # @param param The first parameter.
+  # @param block The block parameter.
+  # @return Returns a string.
+  # @example Calling the function bar
+  #   $result = func4x(1, 'bar', ['foo'])
+  dispatch :other do
+    param 'Boolean', :param
+    block_param
+    return_type 'String'
+  end
+end

spec/fixtures/ruby/func4x_1.rb

@@ -0,0 +1,9 @@
+# An example 4.x function with only one signature.
+Puppet::Functions.create_function(:func4x_1) do
+  # @param param1 The first parameter.
+  # @return [Undef] Returns nothing.
+  dispatch :foobarbaz do
+    param          'Integer',       :param1
+  end
+end
+