Merge pull request #785 from JCotton1123/dynamic-deflate-types

Add deflate params: types, notes

README.md

@@ -22,6 +22,7 @@
         * [Class: apache::mod::wsgi](#class-apachemodwsgi)
         * [Class: apache::mod::fcgid](#class-apachemodfcgid)
         * [Class: apache::mod::negotiation](#class-apachemodnegotiation)
+        * [Class: apache::mod::deflate](#class-apachemoddeflate)
         * [Defined Type: apache::vhost](#defined-type-apachevhost)
         * [Parameter: `directories` for apache::vhost](#parameter-directories-for-apachevhost)
         * [SSL parameters for apache::vhost](#ssl-parameters-for-apachevhost)
@@ -722,6 +723,28 @@ A string that sets the `ForceLanguagePriority` option. Defaults to `Prefer Fallb
 
 An array of languages to set the `LanguagePriority` option of the module.
 
+####Class: `apache::mod::deflate`
+
+Installs and configures mod_deflate. If no parameters are provided, a default configuration is applied.
+
+```puppet
+  class { '::apache::mod::deflate':
+    types => [ 'text/html', 'text/css' ],
+    notes => {
+      'Input' => 'instream',
+      'Ratio' => 'ratio',
+    },
+  }
+```
+
+#####`types`
+
+An array of mime types that will be deflated.
+
+#####`notes`
+
+A hash where the key represents the type and the value represents the note name.
+
 ####Defined Type: `apache::vhost`
 
 The Apache module allows a lot of flexibility in the setup and configuration of virtual hosts. This flexibility is due, in part, to `vhost`'s being a defined resource type, which allows it to be evaluated multiple times with different parameters.

manifests/mod/deflate.pp

@@ -1,6 +1,18 @@
-class apache::mod::deflate {
+class apache::mod::deflate (
+  $types = [
+    'text/html text/plain text/xml',
+    'text/css',
+    'application/x-javascript application/javascript application/ecmascript',
+    'application/rss+xml'
+  ],
+  $notes = {
+    'Input'  => 'instream',
+    'Output' => 'outstream',
+    'Ratio'  => 'ratio'
+  }
+) {
   ::apache::mod { 'deflate': }
-  # Template uses no variables
+
   file { 'deflate.conf':
     ensure  => file,
     path    => "${::apache::mod_dir}/deflate.conf",

spec/classes/mod/deflate_spec.rb

@@ -6,21 +6,28 @@ def general_deflate_specs
 
   it do
     is_expected.to contain_file("deflate.conf").with_content(
-      "AddOutputFilterByType DEFLATE text/html text/plain text/xml\n"\
       "AddOutputFilterByType DEFLATE text/css\n"\
-      "AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript\n"\
-      "AddOutputFilterByType DEFLATE application/rss+xml\n"\
+      "AddOutputFilterByType DEFLATE text/html\n"\
       "\n"\
       "DeflateFilterNote Input instream\n"\
-      "DeflateFilterNote Output outstream\n"\
       "DeflateFilterNote Ratio ratio\n"
     )
   end
 end
 
 describe 'apache::mod::deflate', :type => :class do
   let :pre_condition do
-    'include apache'
+    'class { "apache":
+      default_mods => false,
+    }
+    class { "apache::mod::deflate":
+      types => [ "text/html", "text/css" ],
+      notes => {
+        "Input" => "instream",
+        "Ratio" => "ratio",
+      }
+    }
+    '
   end
 
   context "On a Debian OS with default params" do

templates/mod/deflate.conf.erb

@@ -1,8 +1,7 @@
-AddOutputFilterByType DEFLATE text/html text/plain text/xml
-AddOutputFilterByType DEFLATE text/css
-AddOutputFilterByType DEFLATE application/x-javascript application/javascript application/ecmascript
-AddOutputFilterByType DEFLATE application/rss+xml
+<%- @types.sort.each do |type| -%>
+AddOutputFilterByType DEFLATE <%= type %>
+<%- end -%>
 
-DeflateFilterNote Input instream
-DeflateFilterNote Output outstream
-DeflateFilterNote Ratio ratio
+<%- @notes.sort.each do |type,note| -%>
+DeflateFilterNote <%= type %> <%=note %>
+<%- end -%>