hugo/resources/resource/dates.go
Bjørn Erik Pedersen 597e418cb0
Make Page an interface
The main motivation of this commit is to add a `page.Page` interface to replace the very file-oriented `hugolib.Page` struct.
This is all a preparation step for issue  #5074, "pages from other data sources".

But this also fixes a set of annoying limitations, especially related to custom output formats, and shortcodes.

Most notable changes:

* The inner content of shortcodes using the `{{%` as the outer-most delimiter will now be sent to the content renderer, e.g. Blackfriday.
  This means that any markdown will partake in the global ToC and footnote context etc.
* The Custom Output formats are now "fully virtualized". This removes many of the current limitations.
* The taxonomy list type now has a reference to the `Page` object.
  This improves the taxonomy template `.Title` situation and make common template constructs much simpler.

See #5074
Fixes #5763
Fixes #5758
Fixes #5090
Fixes #5204
Fixes #4695
Fixes #5607
Fixes #5707
Fixes #5719
Fixes #3113
Fixes #5706
Fixes #5767
Fixes #5723
Fixes #5769
Fixes #5770
Fixes #5771
Fixes #5759
Fixes #5776
Fixes #5777
Fixes #5778
2019-03-23 18:51:22 +01:00

82 lines
2 KiB
Go

// Copyright 2019 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 resource
import "time"
var _ Dated = Dates{}
// Dated wraps a "dated resource". These are the 4 dates that makes
// the date logic in Hugo.
type Dated interface {
Date() time.Time
Lastmod() time.Time
PublishDate() time.Time
ExpiryDate() time.Time
}
// Dates holds the 4 Hugo dates.
type Dates struct {
FDate time.Time
FLastmod time.Time
FPublishDate time.Time
FExpiryDate time.Time
}
func (d *Dates) UpdateDateAndLastmodIfAfter(in Dated) {
if in.Date().After(d.Date()) {
d.FDate = in.Date()
}
if in.Lastmod().After(d.Lastmod()) {
d.FLastmod = in.Lastmod()
}
}
// IsFuture returns whether the argument represents the future.
func IsFuture(d Dated) bool {
if d.PublishDate().IsZero() {
return false
}
return d.PublishDate().After(time.Now())
}
// IsExpired returns whether the argument is expired.
func IsExpired(d Dated) bool {
if d.ExpiryDate().IsZero() {
return false
}
return d.ExpiryDate().Before(time.Now())
}
// IsZeroDates returns true if all of the dates are zero.
func IsZeroDates(d Dated) bool {
return d.Date().IsZero() && d.Lastmod().IsZero() && d.ExpiryDate().IsZero() && d.PublishDate().IsZero()
}
func (p Dates) Date() time.Time {
return p.FDate
}
func (p Dates) Lastmod() time.Time {
return p.FLastmod
}
func (p Dates) PublishDate() time.Time {
return p.FPublishDate
}
func (p Dates) ExpiryDate() time.Time {
return p.FExpiryDate
}