5 Commits

24 changed files with 173 additions and 355 deletions

View File

@ -15,8 +15,8 @@ go get git.streifling.com/jason/atom@latest
## Usage ## Usage
This library provides convenient functions to safely create and extend elements This library provides convenient functions to safely create and extend elements
and attributes of an Atom feed. This is because it can be hard to know all and attributes of Atom feeds. It also provides checks for all constructs'
pitfalls of RFC4287. The intended way of using atom is with these functions. adherence to RFC4287.
```go ```go
package main package main
@ -29,30 +29,28 @@ import (
) )
func main() { func main() {
feed, err := atom.NewFeed("Example Feed") feed := atom.NewFeed("Example Feed")
if err != nil { feed.Title = atom.NewText("text", "Example Feed")
feed.ID = atom.NewID(atom.NewURN())
if err := feed.Check(); err != nil {
log.Fatalln(err) log.Fatalln(err)
} }
author := atom.NewPerson("John Doe") author := atom.NewPerson("John Doe")
author.Email = "john.doe@example.com" author.Email = "john.doe@example.com"
if err := author.Check(); err != nil {
log.Fatalln(err)
}
feed.AddAuthor(author) feed.AddAuthor(author)
entry, err := atom.NewEntry("First Entry") entry := atom.NewEntry("First Entry")
if err != nil { entry.ID = atom.NewID(atom.NewURN())
entry.Content = atom.NewContent(atom.InlineText, "text", "This is the content of the first entry.")
if err := entry.Check(); err != nil {
log.Fatalln(err) log.Fatalln(err)
} }
content, err := atom.NewContent(atom.InlineText, "text", "This is the content of the first entry.")
if err != nil {
log.Fatalln(err)
}
entry.Content = content
feed.AddEntry(entry) feed.AddEntry(entry)
if err := feed.Check(); err != nil {
log.Fatalln(err)
}
feedString, err := feed.ToXML("utf-8") feedString, err := feed.ToXML("utf-8")
if err != nil { if err != nil {
log.Fatalln(err) log.Fatalln(err)
@ -62,7 +60,7 @@ func main() {
``` ```
It is also possible to use this library in a way similar to what other libraries It is also possible to use this library in a way similar to what other libraries
would provide. This is, of course, making it easier to make mistakes. provide.
```go ```go
package main package main
@ -115,7 +113,7 @@ func main() {
} }
``` ```
The output of both ways of using it is an RFC4287 compliant Atom feed: The output of both ways of using it is an RFC4287 compliant Atom feed.
```xml ```xml
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="utf-8"?>

View File

@ -2,6 +2,7 @@ package atom
import ( import (
"fmt" "fmt"
"html"
"mime" "mime"
"regexp" "regexp"
"strings" "strings"
@ -85,3 +86,8 @@ func isValidAttribute(attribute string) bool {
func NewURN() string { func NewURN() string {
return fmt.Sprint("urn:uuid:", uuid.New()) return fmt.Sprint("urn:uuid:", uuid.New())
} }
// Unescape unescapes a string. It returns an IRI.
func Unescape(s string) string {
return html.UnescapeString(s)
}

View File

@ -2,9 +2,7 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors"
"fmt" "fmt"
"html"
) )
type Category struct { type Category struct {
@ -15,43 +13,17 @@ type Category struct {
Label string `xml:"label,attr,omitempty"` Label string `xml:"label,attr,omitempty"`
} }
// NewCategory creates a new Category. It returns a *Category and an error. // NewCategory creates a new Category. It returns a *Category.
func NewCategory(term string) (*Category, error) { func NewCategory(term string) *Category {
if term == "" { return &Category{
return nil, errors.New("error creating new category: term string empty") CommonAttributes: newCommonAttributes(),
Term: term,
} }
return &Category{Term: term}, nil
} }
// SetTerm sets the Term attribute of the Category. It returns an error. // SetLabel sets the Label attribute of the Category.
func (c *Category) SetTerm(t string) error { func (c *Category) SetLabel(label string) {
if t == "" { c.Label = Unescape(label)
return errors.New("error setting term of category: t string empty")
}
c.Term = t
return nil
}
// SetScheme sets the Scheme attribute of the Category. It returns an error.
func (c *Category) SetScheme(s string) error {
if !isValidIRI(s) {
return fmt.Errorf("scheme %v not correctly formatted", s)
}
c.Scheme = s
return nil
}
// SetLabel sets the Label attribute of the Category. It returns an error.
func (c *Category) SetLabel(label string) error {
if label == "" {
return errors.New("error setting label of category: label string empty")
}
c.Label = html.UnescapeString(label)
return nil
} }
// Check checks the Category for incompatibilities with RFC4287. It returns an // Check checks the Category for incompatibilities with RFC4287. It returns an

View File

@ -2,7 +2,7 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors" "fmt"
) )
type CommonAttributes struct { type CommonAttributes struct {
@ -13,25 +13,31 @@ type CommonAttributes struct {
// NewCommonAttributes creates a new set of CommonAttributes. It returns a // NewCommonAttributes creates a new set of CommonAttributes. It returns a
// *CommonAttributes. // *CommonAttributes.
func NewCommonAttributes() *CommonAttributes { func newCommonAttributes() *CommonAttributes {
return new(CommonAttributes) return new(CommonAttributes)
} }
// AddAttribute adds the Attribute to the CommonAttributes. It returns an error. // AddAttribute adds the Attribute to the CommonAttributes.
func (c *CommonAttributes) AddAttribute(name, value string) error { func (c *CommonAttributes) AddAttribute(name, value string) {
if name == "" {
return errors.New("error adding attribute: name string empty")
}
if value == "" {
return errors.New("error adding attribute: value string empty")
}
if c.UndefinedAttributes == nil { if c.UndefinedAttributes == nil {
c.UndefinedAttributes = make([]*xml.Attr, 1) c.UndefinedAttributes = make([]*xml.Attr, 1)
c.UndefinedAttributes[0] = &xml.Attr{Name: xml.Name{Local: name}, Value: value} c.UndefinedAttributes[0] = &xml.Attr{Name: xml.Name{Local: name}, Value: value}
} else { } else {
c.UndefinedAttributes = append(c.UndefinedAttributes, &xml.Attr{Name: xml.Name{Local: name}, Value: value}) c.UndefinedAttributes = append(c.UndefinedAttributes, &xml.Attr{Name: xml.Name{Local: name}, Value: value})
} }
}
// Check checks the CommonAttributes for incompatibilities with RFC4287. It
// returns an error.
func (c *CommonAttributes) Check() error {
for i, u := range c.UndefinedAttributes {
if u.Name.Local == "" {
return fmt.Errorf("xml name of undefined attribute %v empty", i)
}
if u.Value == "" {
return fmt.Errorf("value of undefined attribute %v empty", i)
}
}
return nil return nil
} }

View File

@ -1,7 +1,5 @@
package atom package atom
import "fmt"
const ( const (
InlineText = iota InlineText = iota
InlineXHTML InlineXHTML
@ -17,17 +15,17 @@ type Content interface {
} }
// NewContent creates a new Content. It returns a Content and an error. // NewContent creates a new Content. It returns a Content and an error.
func NewContent(contentType int, mediaType string, content any) (Content, error) { func NewContent(contentType int, mediaType string, content any) Content {
switch contentType { switch contentType {
case 0: case 0:
return newInlineTextContent(mediaType, content) return newInlineTextContent(mediaType, content.(string))
case 1: case 1:
return newInlineXHTMLContent(mediaType, content) return newInlineXHTMLContent(mediaType, content.(*XHTMLDiv))
case 2: case 2:
return newInlineOtherContent(mediaType, content) return newInlineOtherContent(mediaType, content)
case 3: case 3:
return newOutOfLineContent(mediaType, content) return newOutOfLineContent(mediaType, content.(string))
default: default:
return nil, fmt.Errorf("error creating new content: %v is not a valid text type", contentType) return nil
} }
} }

View File

@ -18,7 +18,10 @@ func DateTime(t time.Time) string {
// NewDate creates a new Date. It returns a *Date. // NewDate creates a new Date. It returns a *Date.
func NewDate(t time.Time) *Date { func NewDate(t time.Time) *Date {
return &Date{DateTime: DateTime(t)} return &Date{
CommonAttributes: newCommonAttributes(),
DateTime: DateTime(t),
}
} }
// Check checks the Date for incompatibilities with RFC4287. It returns an // Check checks the Date for incompatibilities with RFC4287. It returns an

View File

@ -2,7 +2,6 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors"
"fmt" "fmt"
"strings" "strings"
"time" "time"
@ -57,31 +56,18 @@ func (e *Entry) checkAuthors(authorInFeed bool) error {
return nil return nil
} }
// NewEntry creates a new Entry. It returns a *Entry and an error. // NewEntry creates a new Entry. It returns a *Entry.
func NewEntry(title string) (*Entry, error) { func NewEntry(title string) *Entry {
text, err := NewText("text", title)
if err != nil {
return nil, fmt.Errorf("error creating new entry: %v", err)
}
id, err := NewID(NewURN())
if err != nil {
return nil, fmt.Errorf("error creating new entry: %v", err)
}
return &Entry{ return &Entry{
ID: id, CommonAttributes: newCommonAttributes(),
Title: text, ID: NewID(NewURN()),
Updated: NewDate(time.Now()), Title: NewText("text", title),
}, nil Updated: NewDate(time.Now()),
}
} }
// AddAuthor adds the Person as an author to the Entry. It returns an error. // AddAuthor adds the Person as an author to the Entry.
func (e *Entry) AddAuthor(p *Person) error { func (e *Entry) AddAuthor(p *Person) {
if p == nil {
return errors.New("error adding author element to entry: *Person is nil")
}
if e.Authors == nil { if e.Authors == nil {
e.Authors = make([]*Person, 1) e.Authors = make([]*Person, 1)
e.Authors[0] = p e.Authors[0] = p
@ -90,15 +76,10 @@ func (e *Entry) AddAuthor(p *Person) error {
} }
e.Updated.DateTime = DateTime(time.Now()) e.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddCategory adds the Category to the Entry. It returns an error. // AddCategory adds the Category to the Entry.
func (e *Entry) AddCategory(c *Category) error { func (e *Entry) AddCategory(c *Category) {
if c == nil {
return errors.New("error adding category element to entry: *Category is nil")
}
if e.Categories == nil { if e.Categories == nil {
e.Categories = make([]*Category, 1) e.Categories = make([]*Category, 1)
e.Categories[0] = c e.Categories[0] = c
@ -107,16 +88,10 @@ func (e *Entry) AddCategory(c *Category) error {
} }
e.Updated.DateTime = DateTime(time.Now()) e.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddContributor adds the Person as a contributor to the Entry. It returns an // AddContributor adds the Person as a contributor to the Entry.
// error. func (e *Entry) AddContributor(c *Person) {
func (e *Entry) AddContributor(c *Person) error {
if c == nil {
return errors.New("error adding contributor element to entry: *Person is nil")
}
if e.Contributors == nil { if e.Contributors == nil {
e.Contributors = make([]*Person, 1) e.Contributors = make([]*Person, 1)
e.Contributors[0] = c e.Contributors[0] = c
@ -125,15 +100,10 @@ func (e *Entry) AddContributor(c *Person) error {
} }
e.Updated.DateTime = DateTime(time.Now()) e.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddLink adds the Link to the Entry. It returns an error. // AddLink adds the Link to the Entry.
func (e *Entry) AddLink(l *Link) error { func (e *Entry) AddLink(l *Link) {
if l == nil {
return errors.New("error adding link element to entry: *Link is nil")
}
if e.Links == nil { if e.Links == nil {
e.Links = make([]*Link, 1) e.Links = make([]*Link, 1)
e.Links[0] = l e.Links[0] = l
@ -142,15 +112,10 @@ func (e *Entry) AddLink(l *Link) error {
} }
e.Updated.DateTime = DateTime(time.Now()) e.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddExtension adds the ExtensionElement to the Entry. It returns an error. // AddExtension adds the ExtensionElement to the Entry.
func (e *Entry) AddExtension(x *ExtensionElement) error { func (e *Entry) AddExtension(x *ExtensionElement) {
if x == nil {
return errors.New("error adding extension element to entry: *ExtensionElement is nil")
}
if e.Extensions == nil { if e.Extensions == nil {
e.Extensions = make([]*ExtensionElement, 1) e.Extensions = make([]*ExtensionElement, 1)
e.Extensions[0] = x e.Extensions[0] = x
@ -159,7 +124,6 @@ func (e *Entry) AddExtension(x *ExtensionElement) error {
} }
e.Updated.DateTime = DateTime(time.Now()) e.Updated.DateTime = DateTime(time.Now())
return nil
} }
// Check checks the Entry for incompatibilities with RFC4287. It returns an // Check checks the Entry for incompatibilities with RFC4287. It returns an

View File

@ -2,7 +2,7 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors" "fmt"
) )
type ExtensionElement struct { type ExtensionElement struct {
@ -11,27 +11,20 @@ type ExtensionElement struct {
} }
// NewExtensionElement creates a new ExtensionElement. It returns a // NewExtensionElement creates a new ExtensionElement. It returns a
// *ExtensionElement and an error. // *ExtensionElement.
func NewExtensionElement(name string, value any) (*ExtensionElement, error) { func NewExtensionElement(name string, value any) *ExtensionElement {
if name == "" { return &ExtensionElement{XMLName: xml.Name{Local: name}, Value: value}
return nil, errors.New("error adding extension attribute: name string empty")
}
if value == "" {
return nil, errors.New("error adding extension attribute: value string empty")
}
return &ExtensionElement{XMLName: xml.Name{Local: name}, Value: value}, nil
} }
// Check checks the ExtensionElement for incompatibilities with RFC4287. It // Check checks the ExtensionElement for incompatibilities with RFC4287. It
// returns an error. // returns an error.
func (e *ExtensionElement) Check() error { func (e *ExtensionElement) Check() error {
if e.XMLName.Local == "" { if e.XMLName.Local == "" {
return errors.New("xml name of extension empty") return fmt.Errorf("xml name of extension %v empty", e)
} }
if e.Value == nil { if e.Value == nil {
return errors.New("value element of extension empty") return fmt.Errorf("value of extension %v empty", e)
} }
return nil return nil

80
feed.go
View File

@ -2,7 +2,6 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors"
"fmt" "fmt"
"time" "time"
) )
@ -26,31 +25,18 @@ type Feed struct {
Entries []*Entry `xml:",omitempty"` Entries []*Entry `xml:",omitempty"`
} }
// NewFeed creates a new Feed. It returns a *Feed and an error. // NewFeed creates a new Feed. It returns a *Feed.
func NewFeed(title string) (*Feed, error) { func NewFeed(title string) *Feed {
text, err := NewText("text", title)
if err != nil {
return nil, fmt.Errorf("error creating new feed: %v", err)
}
id, err := NewID(NewURN())
if err != nil {
return nil, fmt.Errorf("error creating new feed: %v", err)
}
return &Feed{ return &Feed{
ID: id, CommonAttributes: newCommonAttributes(),
Title: text, ID: NewID(NewURN()),
Updated: NewDate(time.Now()), Title: NewText("text", title),
}, nil Updated: NewDate(time.Now()),
}
} }
// AddAuthor adds the Person as an author to the Feed. It returns an error. // AddAuthor adds the Person as an author to the Feed.
func (f *Feed) AddAuthor(p *Person) error { func (f *Feed) AddAuthor(p *Person) {
if p == nil {
return errors.New("error adding author element to feed: *Person is nil")
}
if f.Authors == nil { if f.Authors == nil {
f.Authors = make([]*Person, 1) f.Authors = make([]*Person, 1)
f.Authors[0] = p f.Authors[0] = p
@ -59,15 +45,10 @@ func (f *Feed) AddAuthor(p *Person) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddCategory adds the Category to the Feed. It returns an error. // AddCategory adds the Category to the Feed.
func (f *Feed) AddCategory(c *Category) error { func (f *Feed) AddCategory(c *Category) {
if c == nil {
return errors.New("error adding category element to feed: *Category is nil")
}
if f.Categories == nil { if f.Categories == nil {
f.Categories = make([]*Category, 1) f.Categories = make([]*Category, 1)
f.Categories[0] = c f.Categories[0] = c
@ -76,16 +57,10 @@ func (f *Feed) AddCategory(c *Category) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddContributor adds the Person as a contributor to the Feed. It returns an // AddContributor adds the Person as a contributor to the Feed.
// error. func (f *Feed) AddContributor(c *Person) {
func (f *Feed) AddContributor(c *Person) error {
if c == nil {
return errors.New("error adding contributor element to feed: *Person is nil")
}
if f.Contributors == nil { if f.Contributors == nil {
f.Contributors = make([]*Person, 1) f.Contributors = make([]*Person, 1)
f.Contributors[0] = c f.Contributors[0] = c
@ -94,16 +69,10 @@ func (f *Feed) AddContributor(c *Person) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddLink adds the Link to the Feed. It returns an error. There should be one // AddLink adds the Link to the Feed. There should be one Link with Rel "self".
// Link with Rel "self". func (f *Feed) AddLink(l *Link) {
func (f *Feed) AddLink(l *Link) error {
if l == nil {
return errors.New("error adding link element to feed: *Link is nil")
}
if f.Links == nil { if f.Links == nil {
f.Links = make([]*Link, 1) f.Links = make([]*Link, 1)
f.Links[0] = l f.Links[0] = l
@ -112,15 +81,10 @@ func (f *Feed) AddLink(l *Link) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddExtension adds the Extension to the Feed. It returns an error. // AddExtension adds the Extension to the Feed.
func (f *Feed) AddExtension(e *ExtensionElement) error { func (f *Feed) AddExtension(e *ExtensionElement) {
if e == nil {
return errors.New("error adding extension element to feed: *ExtensionElement is nil")
}
if f.Extensions == nil { if f.Extensions == nil {
f.Extensions = make([]*ExtensionElement, 1) f.Extensions = make([]*ExtensionElement, 1)
f.Extensions[0] = e f.Extensions[0] = e
@ -129,15 +93,10 @@ func (f *Feed) AddExtension(e *ExtensionElement) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// AddEntry adds the Entry to the Feed. It returns an error. // AddEntry adds the Entry to the Feed.
func (f *Feed) AddEntry(e *Entry) error { func (f *Feed) AddEntry(e *Entry) {
if e == nil {
return errors.New("error adding entry element to feed: *Entry is nil")
}
if f.Entries == nil { if f.Entries == nil {
f.Entries = make([]*Entry, 1) f.Entries = make([]*Entry, 1)
f.Entries[0] = e f.Entries[0] = e
@ -146,7 +105,6 @@ func (f *Feed) AddEntry(e *Entry) error {
} }
f.Updated.DateTime = DateTime(time.Now()) f.Updated.DateTime = DateTime(time.Now())
return nil
} }
// Check checks the Feed for incompatibilities with RFC4287. It returns an // Check checks the Feed for incompatibilities with RFC4287. It returns an

View File

@ -2,7 +2,6 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors"
"fmt" "fmt"
"html" "html"
) )
@ -15,22 +14,12 @@ type Generator struct {
Text string `xml:",chardata"` Text string `xml:",chardata"`
} }
// NewGenerator creates a new Generator. It returns a *Generator and an error. // NewGenerator creates a new Generator. It returns a *Generator.
func NewGenerator(text string) (*Generator, error) { func NewGenerator(text string) *Generator {
if text == "" { return &Generator{
return nil, errors.New("error creating new generator: text string empty") CommonAttributes: newCommonAttributes(),
Text: html.UnescapeString(text),
} }
return &Generator{Text: html.UnescapeString(text)}, nil
}
// SetURI sets the URI attribute of the Generator. It returns an error.
func (g *Generator) SetURI(uri string) error {
if !isValidIRI(uri) {
return fmt.Errorf("uri %v not correctly formatted", g)
}
return nil
} }
// Check checks the Generator for incompatibilities with RFC4287. It returns an // Check checks the Generator for incompatibilities with RFC4287. It returns an

11
icon.go
View File

@ -12,13 +12,12 @@ type Icon struct {
URI string `xml:",chardata"` // IRI URI string `xml:",chardata"` // IRI
} }
// NewIcon creates a new Icon. It returns a *Icon and an error. // NewIcon creates a new Icon. It returns a *Icon.
func NewIcon(uri string) (*Icon, error) { func NewIcon(uri string) *Icon {
if !isValidIRI(uri) { return &Icon{
return nil, fmt.Errorf("uri %v not correctly formatted", uri) CommonAttributes: newCommonAttributes(),
URI: uri,
} }
return &Icon{URI: uri}, nil
} }
// Check checks the Icon for incompatibilities with RFC4287. It returns an // Check checks the Icon for incompatibilities with RFC4287. It returns an

11
id.go
View File

@ -12,13 +12,12 @@ type ID struct {
URI string `xml:",chardata"` // IRI URI string `xml:",chardata"` // IRI
} }
// NewID creates a new ID. It returns a *ID and an error. // NewID creates a new ID. It returns a *ID.
func NewID(uri string) (*ID, error) { func NewID(uri string) *ID {
if !isValidIRI(uri) { return &ID{
return nil, fmt.Errorf("uri %v not correctly formatted", uri) CommonAttributes: newCommonAttributes(),
URI: uri,
} }
return &ID{URI: uri}, nil
} }
// Check checks the ID for incompatibilities with RFC4287. It returns an error. // Check checks the ID for incompatibilities with RFC4287. It returns an error.

View File

@ -15,13 +15,14 @@ type InlineOtherContent struct {
// newInlineOtherContent creates a new InlineOtherContent. It returns a // newInlineOtherContent creates a new InlineOtherContent. It returns a
// *InlineOtherContent and an error. // *InlineOtherContent and an error.
func newInlineOtherContent(mediaType string, content any) (*InlineOtherContent, error) { func newInlineOtherContent(mediaType string, content any) *InlineOtherContent {
if !isValidMediaType(mediaType) {
return nil, fmt.Errorf("error creating new inline other content: media type %v invalid", mediaType)
}
mediaType, _, _ = mime.ParseMediaType(mediaType) mediaType, _, _ = mime.ParseMediaType(mediaType)
return &InlineOtherContent{Type: mediaType, AnyElement: content}, nil return &InlineOtherContent{
CommonAttributes: newCommonAttributes(),
Type: mediaType,
AnyElement: content,
}
} }
// isContent checks whether the InlineOtherContent is a Content. It returns a // isContent checks whether the InlineOtherContent is a Content. It returns a

View File

@ -13,18 +13,13 @@ type InlineTextContent struct {
} }
// newInlineTextContent creates a new InlineTextContent. It returns a // newInlineTextContent creates a new InlineTextContent. It returns a
// *InlineTextContent and an error. // *InlineTextContent.
func newInlineTextContent(mediaType string, content any) (*InlineTextContent, error) { func newInlineTextContent(mediaType, text string) *InlineTextContent {
if mediaType != "text" && mediaType != "html" && mediaType != "" { return &InlineTextContent{
return nil, fmt.Errorf("media type %v incompatible with inline text content", mediaType) CommonAttributes: newCommonAttributes(),
Type: mediaType,
Text: text,
} }
text, ok := content.(string)
if !ok {
return nil, fmt.Errorf("content type %T incompatible with inline text content", content)
}
return &InlineTextContent{Type: mediaType, Text: text}, nil
} }
// isContent checks whether the InlineTextContent is a Content. It returns a // isContent checks whether the InlineTextContent is a Content. It returns a

View File

@ -13,18 +13,13 @@ type InlineXHTMLContent struct {
} }
// newInlineXHTMLContent creates a new InlineXHTMLContent. It returns a // newInlineXHTMLContent creates a new InlineXHTMLContent. It returns a
// *InlineXHTMLContent and an error. // *InlineXHTMLContent.
func newInlineXHTMLContent(mediaType string, content any) (*InlineXHTMLContent, error) { func newInlineXHTMLContent(mediaType string, div *XHTMLDiv) *InlineXHTMLContent {
if mediaType != "xhtml" { return &InlineXHTMLContent{
return nil, fmt.Errorf("media type %v incompatible with inline xhtml content", mediaType) CommonAttributes: newCommonAttributes(),
Type: mediaType,
XHTMLDiv: div,
} }
xhtmlDiv, ok := content.(*XHTMLDiv)
if !ok {
return nil, fmt.Errorf("content type %T incompatible with inline xhtml content", content)
}
return &InlineXHTMLContent{Type: mediaType, XHTMLDiv: xhtmlDiv}, nil
} }
// isContent checks whether the InlineXHTMLContent is a Content. It returns a // isContent checks whether the InlineXHTMLContent is a Content. It returns a

29
link.go
View File

@ -17,31 +17,12 @@ type Link struct {
Length uint `xml:"length,attr,omitempty"` Length uint `xml:"length,attr,omitempty"`
} }
// NewLink creates a new Link. It returns a *Link and an error. // NewLink creates a new Link. It returns a *Link.
func NewLink(href string) (*Link, error) { func NewLink(href string) *Link {
if !isValidIRI(href) { return &Link{
return nil, fmt.Errorf("href %v not correctly formatted", href) CommonAttributes: newCommonAttributes(),
Href: href,
} }
return &Link{Href: href}, nil
}
// SetType sets the Type attribute of the Link. It returns an error.
func (l *Link) SetType(t string) error {
if !isValidMediaType(t) {
return fmt.Errorf("type %v invalid media type", l)
}
return nil
}
// SetHrefLang sets the HrefLang attribute of the Link. It returns an error.
func (l *Link) SetHrefLang(h string) error {
if !isValidLanguageTag(h) {
return fmt.Errorf("hreflang %v invalid language tag", l)
}
return nil
} }
// Check checks the Link for incompatibilities with RFC4287. It returns an // Check checks the Link for incompatibilities with RFC4287. It returns an

11
logo.go
View File

@ -11,13 +11,12 @@ type Logo struct {
URI string `xml:",chardata"` // IRI URI string `xml:",chardata"` // IRI
} }
// NewLogo creates a new Logo. It returns a *Logo and an error. // NewLogo creates a new Logo. It returns a *Logo.
func NewLogo(uri string) (*Logo, error) { func NewLogo(uri string) *Logo {
if !isValidIRI(uri) { return &Logo{
return nil, fmt.Errorf("uri %v not correctly formatted", uri) CommonAttributes: newCommonAttributes(),
URI: uri,
} }
return &Logo{URI: uri}, nil
} }
// Check checks the Logo for incompatibilities with RFC4287. It returns an // Check checks the Logo for incompatibilities with RFC4287. It returns an

View File

@ -14,23 +14,15 @@ type OutOfLineContent struct {
} }
// newOutOfLineContent creates a new OutOfLineContent. It returns a // newOutOfLineContent creates a new OutOfLineContent. It returns a
// *OutOfLineContent and an error. // *OutOfLineContent.
func newOutOfLineContent(mediaType string, content any) (*OutOfLineContent, error) { func newOutOfLineContent(mediaType, src string) *OutOfLineContent {
if !isValidMediaType(mediaType) {
return nil, fmt.Errorf("error creating new out of line content: media type %v invalid", mediaType)
}
mediaType, _, _ = mime.ParseMediaType(mediaType) mediaType, _, _ = mime.ParseMediaType(mediaType)
iri, ok := content.(string) return &OutOfLineContent{
if !ok { CommonAttributes: newCommonAttributes(),
return nil, fmt.Errorf("content type %T incompatible with out of line content", content) Type: mediaType,
SRC: src,
} }
if !isValidIRI(iri) {
return nil, fmt.Errorf("content %v not a valid uri", iri)
}
return &OutOfLineContent{Type: mediaType, SRC: iri}, nil
} }
// isContent checks whether the OutOfLineContent is a Content. It returns a // isContent checks whether the OutOfLineContent is a Content. It returns a

View File

@ -1,7 +1,6 @@
package atom package atom
import ( import (
"errors"
"fmt" "fmt"
"net/mail" "net/mail"
) )
@ -14,38 +13,22 @@ type Person struct {
Extensions []*ExtensionElement `xml:",any,omitempty"` Extensions []*ExtensionElement `xml:",any,omitempty"`
} }
// NewPerson creates a new Person. It returns a *Person and an error. // NewPerson creates a new Person. It returns a *Person.
func NewPerson(name string) (*Person, error) { func NewPerson(name string) *Person {
if name == "" { return &Person{
return nil, errors.New("error creating new person: name string empty") CommonAttributes: newCommonAttributes(),
Name: name,
} }
return &Person{Name: name}, nil
} }
// SetURI sets the URI element of the Person. It returns an error. // AddExtension adds the Extension to the Person.
func (l *Link) SetURI(uri string) error { func (p *Person) AddExtension(e *ExtensionElement) {
if !isValidIRI(uri) {
return fmt.Errorf("uri %v not correctly formatted", uri)
}
return nil
}
// AddExtension adds the Extension to the Person. It returns an error.
func (p *Person) AddExtension(e *ExtensionElement) error {
if e == nil {
return errors.New("error adding extension element to person: *ExtensionElement is nil")
}
if p.Extensions == nil { if p.Extensions == nil {
p.Extensions = make([]*ExtensionElement, 1) p.Extensions = make([]*ExtensionElement, 1)
p.Extensions[0] = e p.Extensions[0] = e
} else { } else {
p.Extensions = append(p.Extensions, e) p.Extensions = append(p.Extensions, e)
} }
return nil
} }
// Check checks the Person for incompatibilities with RFC4287. It returns an // Check checks the Person for incompatibilities with RFC4287. It returns an

View File

@ -1,7 +1,6 @@
package atom package atom
import ( import (
"errors"
"fmt" "fmt"
) )
@ -14,13 +13,13 @@ type PlainText struct {
// isText checks whether the PlainText is a Text. It returns a bool. // isText checks whether the PlainText is a Text. It returns a bool.
func (p *PlainText) isText() bool { return true } func (p *PlainText) isText() bool { return true }
// newPlainText creates a new PlainText. It returns a *PlainText and an error. // newPlainText creates a new PlainText. It returns a *PlainText.
func newPlainText(textType, content string) (*PlainText, error) { func newPlainText(textType, content string) *PlainText {
if content == "" { return &PlainText{
return nil, errors.New("error creating new plain text: content string empty") CommonAttributes: newCommonAttributes(),
Type: textType,
Text: content,
} }
return &PlainText{Type: textType, Text: content}, nil
} }
// Check checks the PlainText for incompatibilities with RFC4287. It returns an // Check checks the PlainText for incompatibilities with RFC4287. It returns an

View File

@ -25,7 +25,7 @@ type Source struct {
// NewSource creates a new Source. It returns a *Source. // NewSource creates a new Source. It returns a *Source.
func NewSource() *Source { func NewSource() *Source {
return new(Source) return &Source{CommonAttributes: newCommonAttributes()}
} }
// Check checks the Source for incompatibilities with RFC4287. It returns an // Check checks the Source for incompatibilities with RFC4287. It returns an

11
text.go
View File

@ -1,17 +1,14 @@
package atom package atom
import ( import "html"
"fmt"
"html"
)
type Text interface { type Text interface {
isText() bool isText() bool
Check() error Check() error
} }
// NewText creates a new Text. It returns a Text and an error. // NewText creates a new Text. It returns a Text.
func NewText(textType, content string) (Text, error) { func NewText(textType, content string) Text {
switch textType { switch textType {
case "text", "": case "text", "":
return newPlainText(textType, content) return newPlainText(textType, content)
@ -20,6 +17,6 @@ func NewText(textType, content string) (Text, error) {
case "xhtml": case "xhtml":
return newXHTMLText(textType, content) return newXHTMLText(textType, content)
default: default:
return nil, fmt.Errorf("%v is not a valid text type", textType) return nil
} }
} }

View File

@ -2,7 +2,6 @@ package atom
import ( import (
"encoding/xml" "encoding/xml"
"errors"
"fmt" "fmt"
) )
@ -12,16 +11,12 @@ type XHTMLDiv struct {
Content string `xml:",innerxml"` Content string `xml:",innerxml"`
} }
// NewXHTMLDiv creates a new XHTMLDiv. It returns a *XHTMLDiv and an error. // NewXHTMLDiv creates a new XHTMLDiv. It returns a *XHTMLDiv.
func NewXHTMLDiv(content string) (*XHTMLDiv, error) { func NewXHTMLDiv(content string) *XHTMLDiv {
if content == "" {
return nil, errors.New("error creating new xhtml div: content string empty")
}
return &XHTMLDiv{ return &XHTMLDiv{
XMLNS: "http://www.w3.org/1999/xhtml", XMLNS: "http://www.w3.org/1999/xhtml",
Content: content, Content: content,
}, nil }
} }
// Check checks the XHTMLDiv for incompatibilities with RFC4287. It returns an // Check checks the XHTMLDiv for incompatibilities with RFC4287. It returns an

View File

@ -13,17 +13,13 @@ type XHTMLText struct {
// isText checks whether the XHTMLText is a Text. It returns a bool. // isText checks whether the XHTMLText is a Text. It returns a bool.
func (x *XHTMLText) isText() bool { return true } func (x *XHTMLText) isText() bool { return true }
// newPlainText creates a new PlainText. It returns a *PlainText and an error. // newPlainText creates a new PlainText. It returns a *PlainText.
func newXHTMLText(textType, content string) (*XHTMLText, error) { func newXHTMLText(textType, content string) *XHTMLText {
xhtmlDiv, err := NewXHTMLDiv(content)
if err != nil {
return nil, fmt.Errorf("error creating new xhtml text: %v", err)
}
return &XHTMLText{ return &XHTMLText{
Type: textType, CommonAttributes: newCommonAttributes(),
XHTMLDiv: xhtmlDiv, Type: textType,
}, nil XHTMLDiv: NewXHTMLDiv(content),
}
} }
// Check checks the XHTMLText for incompatibilities with RFC4287. It returns an // Check checks the XHTMLText for incompatibilities with RFC4287. It returns an