Merge pull request #1 from malaikah/development

Extending and streamlining

Author: Alkivi SAS

Modulefile

@@ -1,9 +1,9 @@
-name    'alkivi-motd'
-version '0.0.3'
-source 'https://github.com/alkivi-sas/puppet-motd'
-author 'alkivi'
-license 'LGPLv3'
-summary 'Controls motd file on unix system'
-description 'Setup motd and give hability to register module'
-project_page 'https://github.com/alkivi-sas/puppet-motd'
-dependency 'puppetlabs/concat', '1.0.0'
+name    'alkivi-motd'
+version '0.0.3'
+source 'https://github.com/alkivi-sas/puppet-motd'
+author 'alkivi'
+license 'LGPLv3'
+summary 'Controls motd file on unix system'
+description 'Setup motd and give hability to register module'
+project_page 'https://github.com/alkivi-sas/puppet-motd'
+dependency 'puppetlabs/concat', '1.0.0'

manifests/init.pp

@@ -1,23 +1,41 @@
-class motd (
-  $motd    = '/etc/motd',
-  $headers = false,
-) {
-
-  concat { $motd:
-    owner => root,
-    group => root,
-    mode  => '0644',
-  }
-
-  # Add base info if necessary
-  if($headers)
-  {
-    concat::fragment{'motd_header':
-      target  => $motd,
-      content => template('motd/header.erb'),
-      order   => 01,
-    }
-  }
-
-}
-
+# == Class: motd
+#
+# configures concat target file with, optionally, a header.
+#
+# == parameters
+#
+# [*motd*]
+#  The path to our motd file
+#
+# [*headers*]
+#  If true, create a header file at the top of the concatted motd file.
+#  Defaults to false
+#
+# [*template*]
+#  Template to use to create headers.
+#  Defaults to a rather fetching graphic.
+#
+class motd (
+  $motd     = '/etc/motd',
+  $headers  = false,
+  $template = 'motd/header.erb',
+) {
+
+  concat { $motd:
+    owner => root,
+    group => root,
+    mode  => '0644',
+  }
+
+  # Add base info if necessary
+  if($headers)
+  {
+    concat::fragment{'motd_header':
+      target  => $motd,
+      content => template($template),
+      order   => 01,
+    }
+  }
+
+}
+

manifests/register.pp

@@ -1,15 +1,28 @@
-define motd::register($content='', $order=10) {
-  if($content == '')
-  {
-    $body = "    -- ${name}\n"
-  }
-  else
-  {
-    $body = $content
-  }
-
-  concat::fragment{"motd_fragment_${name}":
-    target  => $motd::motd,
-    content => $body,
-  }
-}
+# == Define: motd::register
+#
+# Can be used to add snippets to our motd file.
+#
+# == Parameters
+#
+# [*content*]
+#  The content of our fragment.
+#  Defaults to the name/title of the resource, prepended by '--'.
+#  Useful for listing things like applied classes. 
+#
+# [*order*]
+#  The order in which our fragment should appear in the target file.
+#  Defaults to '10'.
+#
+define motd::register(
+  $content = "    -- ${name}\n", 
+  $order = '10',
+) {
+
+  include ::motd
+  concat::fragment{"motd_fragment_${name}":
+    target  => $motd::motd,
+    content => $content,
+    order   => $order,
+  }
+  
+}