output: Add output type

diff --git a/hugolib/page.go b/hugolib/page.go
index db31a90aecac422a4445a901e43d25b1e1923f1f..554bd30cd6d9f0537d2bd745fc51099a45465463 100644 (file)
--- a/hugolib/page.go
+++ b/hugolib/page.go
@@ -1886,8 +1886,8 @@ func kindFromFilename(filename string) string {
 
 // TODO(bep) output
 var (
-       mediaTypesWithRSS = media.Types{media.HtmlType, media.RSSType}
-       mediaTypesHTML    = media.Types{media.HtmlType}
+       mediaTypesWithRSS = media.Types{media.HTMLType, media.RSSType}
+       mediaTypesHTML    = media.Types{media.HTMLType}
 )
 
 func (p *Page) setValuesForKind(s *Site) {

diff --git a/hugolib/site_render.go b/hugolib/site_render.go
index 24c77a60b9a864000622476495f5a04824cbed47..54c88d9b2e8cf19f5bd8126f4a6d06709bdeaf73 100644 (file)
--- a/hugolib/site_render.go
+++ b/hugolib/site_render.go
@@ -67,7 +67,7 @@ func pageRenderer(s *Site, pages <-chan *Page, results chan<- error, wg *sync.Wa
                for _, mediaType := range p.mediaTypes {
                        switch mediaType {
 
-                       case media.HtmlType:
+                       case media.HTMLType:
                                targetPath := p.TargetPath()
 
                                layouts := p.layouts()

diff --git a/media/mediaType.go b/media/mediaType.go
new file mode 100644 (file)
index 0000000..4663a27
--- /dev/null
+++ b/media/mediaType.go
@@ -0,0 +1,66 @@
+// Copyright 2017-present The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package media
+
+import (
+       "fmt"
+)
+
+type Types []Type
+
+// A media type (also known as MIME type and content type) is a two-part identifier for
+// file formats and format contents transmitted on the Internet.
+// For Hugo's use case, we use the top-level type name / subtype name + suffix.
+// One example would be image/jpeg+jpg
+// If suffix is not provided, the sub type will be used.
+// See // https://en.wikipedia.org/wiki/Media_type
+type Type struct {
+       Type    string // i.e. text
+       SubType string // i.e. html
+       Suffix  string // i.e html
+}
+
+// Key return a key used to identify this media type. Hugo will register a set of
+// default media types. These can be overridden by the user in the configuration,
+// by defining a media type with the same Key.
+func (m Type) Key() string {
+       return fmt.Sprintf("%s/%s", m.Type, m.SubType)
+}
+
+func (m Type) String() string {
+       if m.Suffix != "" {
+               return fmt.Sprintf("%s/%s+%s", m.Type, m.SubType, m.Suffix)
+       }
+       return fmt.Sprintf("%s/%s", m.Type, m.SubType)
+}
+
+var (
+       HTMLType = Type{"text", "html", "html"}
+       RSSType  = Type{"application", "rss", "xml"}
+)
+
+// DefaultMediaTypes holds a default set of media types by Hugo.
+// These can be ovverriden, and more added if needed, in the Hugo configuration file.
+// The final media type set set will also be added as extensions to mime so
+// they will be recognised by the built-in server in Hugo.
+// TODO(bep) output remove
+var DefaultMediaTypes = Types{
+       HTMLType,
+       RSSType,
+
+       // TODO(bep) output
+}
+
+// TODO(bep) output mime.AddExtensionType
+// TODO(bep) text/template vs html/template

diff --git a/media/mediaType_test.go b/media/mediaType_test.go
new file mode 100644 (file)
index 0000000..64a0a65
--- /dev/null
+++ b/media/mediaType_test.go
@@ -0,0 +1,37 @@
+// Copyright 2017-present The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package media
+
+import (
+       "testing"
+
+       "github.com/stretchr/testify/require"
+)
+
+func TestDefaultTypes(t *testing.T) {
+       require.Equal(t, "text", HTMLType.Type)
+       require.Equal(t, "html", HTMLType.SubType)
+       require.Equal(t, "html", HTMLType.Suffix)
+
+       require.Equal(t, "text/html", HTMLType.Key())
+       require.Equal(t, "text/html+html", HTMLType.String())
+
+       require.Equal(t, "application", RSSType.Type)
+       require.Equal(t, "rss", RSSType.SubType)
+       require.Equal(t, "xml", RSSType.Suffix)
+
+       require.Equal(t, "application/rss", RSSType.Key())
+       require.Equal(t, "application/rss+xml", RSSType.String())
+
+}

diff --git a/media/type.go b/media/type.go
deleted file mode 100644 (file)
index 701f8f4..0000000
--- a/media/type.go
+++ /dev/null
@@ -1,65 +0,0 @@
-// Copyright 2017-present The Hugo Authors. All rights reserved.
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package media
-
-import (
-       "fmt"
-)
-
-type Types []Type
-
-// A media type (also known as MIME type and content type) is a two-part identifier for
-// file formats and format contents transmitted on the Internet.
-// For Hugo's use case, we use the top-level type name / subtype name + suffix.
-// One example would be image/jpeg+jpg
-// If suffix is not provided, the sub type will be used.
-// See // https://en.wikipedia.org/wiki/Media_type
-type Type struct {
-       Type    string // i.e. text
-       SubType string // i.e. html
-       Suffix  string // i.e html
-}
-
-// Key return a key used to identify this media type. Hugo will register a set of
-// default media types. These can be overridden by the user in the configuration,
-// by defining a media type with the same Key.
-func (m Type) Key() string {
-       if m.Suffix != "" {
-               return fmt.Sprintf("%s/%s+%s", m.Type, m.SubType, m.Suffix)
-       }
-       return fmt.Sprintf("%s/%s", m.Type, m.SubType)
-}
-
-func (m Type) String() string {
-       return m.Key()
-}
-
-var (
-       HtmlType = Type{"text", "html", "html"}
-       RSSType  = Type{"application", "rss", "xml"}
-)
-
-// DefaultMediaTypes holds a default set of media types by Hugo.
-// These can be ovverriden, and more added if needed, in the Hugo configuration file.
-// The final media type set set will also be added as extensions to mime so
-// they will be recognised by the built-in server in Hugo.
-var DefaultMediaTypes = Types{
-       HtmlType,
-       RSSType,
-
-       // TODO(bep) output
-}
-
-// TODO(bep) output mime.AddExtensionType
-// TODO(bep) text/template vs html/template

diff --git a/output/outputType.go b/output/outputType.go
new file mode 100644 (file)
index 0000000..d79ab05
--- /dev/null
+++ b/output/outputType.go
@@ -0,0 +1,46 @@
+// Copyright 2017-present The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package output
+
+import (
+       "github.com/spf13/hugo/media"
+)
+
+var (
+       HTMLType = Type{
+               Name:      "HTML",
+               MediaType: media.HTMLType,
+       }
+
+       RSSType = Type{
+               Name:      "RSS",
+               MediaType: media.RSSType,
+       }
+)
+
+// Type represents an output represenation, usually to a file on disk.
+type Type struct {
+       // The Name is used as an identifier. Internal output types (i.e. HTML and RSS)
+       // can be overridden by providing a new definition for those types.
+       Name string
+
+       MediaType media.Type
+
+       // Must be set to a value when there are two or more conflicting mediatype for the same resource.
+       Path string
+
+       // IsPlainText decides whether to use text/template or html/template
+       // as template parser.
+       IsPlainText bool
+}

diff --git a/output/outputType_test.go b/output/outputType_test.go
new file mode 100644 (file)
index 0000000..6f84c93
--- /dev/null
+++ b/output/outputType_test.go
@@ -0,0 +1,33 @@
+// Copyright 2017-present The Hugo Authors. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package output
+
+import (
+       "testing"
+
+       "github.com/spf13/hugo/media"
+       "github.com/stretchr/testify/require"
+)
+
+func TestDefaultTypes(t *testing.T) {
+       require.Equal(t, "HTML", HTMLType.Name)
+       require.Equal(t, media.HTMLType, HTMLType.MediaType)
+       require.Empty(t, HTMLType.Path)
+       require.False(t, HTMLType.IsPlainText)
+
+       require.Equal(t, "RSS", RSSType.Name)
+       require.Equal(t, media.RSSType, RSSType.MediaType)
+       require.Empty(t, RSSType.Path)
+       require.False(t, RSSType.IsPlainText)
+}