add recommended-list to the Go content-tree model

Author: lokendersinghft

content_tree.go

@@ -45,6 +45,7 @@ const (
 	PullquoteType           = "pullquote"
 	ImageSetType            = "image-set"
 	RecommendedType         = "recommended"
+	RecommendedListType     = "recommended-list"
 	TweetType               = "tweet"
 	FlourishType            = "flourish"
 	BigNumberType           = "big-number"
@@ -394,6 +395,7 @@ type BodyBlock struct {
 	*Table
 	*Text
 	*Recommended
+	*RecommendedList
 	*Tweet
 	*Video
 	*YoutubeVideo
@@ -449,6 +451,9 @@ func (n *BodyBlock) GetEmbedded() Node {
 	if n.Recommended != nil {
 		return n.Recommended
 	}
+	if n.RecommendedList != nil {
+		return n.RecommendedList
+	}
 	if n.Tweet != nil {
 		return n.Tweet
 	}
@@ -513,6 +518,9 @@ func (n *BodyBlock) GetChildren() []Node {
 	if n.Recommended != nil {
 		return n.Recommended.GetChildren()
 	}
+	if n.RecommendedList != nil {
+		return n.RecommendedList.GetChildren()
+	}
 	if n.Tweet != nil {
 		return n.Tweet.GetChildren()
 	}
@@ -627,6 +635,12 @@ func (n *BodyBlock) UnmarshalJSON(data []byte) error {
 			return err
 		}
 		n.Recommended = &v
+	case RecommendedListType:
+		var v RecommendedList
+		if err := json.Unmarshal(data, &v); err != nil {
+			return err
+		}
+		n.RecommendedList = &v
 	case TweetType:
 		var v Tweet
 		if err := json.Unmarshal(data, &v); err != nil {
@@ -699,6 +713,8 @@ func (n *BodyBlock) MarshalJSON() ([]byte, error) {
 		return json.Marshal(n.Text)
 	case n.Recommended != nil:
 		return json.Marshal(n.Recommended)
+	case n.RecommendedList != nil:
+		return json.Marshal(n.RecommendedList)
 	case n.Tweet != nil:
 		return json.Marshal(n.Tweet)
 	case n.Video != nil:
@@ -747,6 +763,8 @@ func makeBodyBlock(n Node) (*BodyBlock, error) {
 		return &BodyBlock{Text: n.(*Text)}, nil
 	case RecommendedType:
 		return &BodyBlock{Recommended: n.(*Recommended)}, nil
+	case RecommendedListType:
+		return &BodyBlock{RecommendedList: n.(*RecommendedList)}, nil
 	case TweetType:
 		return &BodyBlock{Tweet: n.(*Tweet)}, nil
 	case VideoType:
@@ -1674,6 +1692,37 @@ func (n *Recommended) GetChildren() []Node {
 
 func (n *Recommended) AppendChild(_ Node) error { return ErrCannotHaveChildren }
 
+type RecommendedList struct {
+	Type     string         `json:"type"`
+	Data     interface{}    `json:"data,omitempty"`
+	Heading  string         `json:"heading,omitempty"`
+	Children []*Recommended `json:"children"`
+}
+
+func (n *RecommendedList) GetType() string {
+	return n.Type
+}
+
+func (n *RecommendedList) GetEmbedded() Node {
+	return nil
+}
+
+func (n *RecommendedList) GetChildren() []Node {
+	result := make([]Node, len(n.Children))
+	for i, v := range n.Children {
+		result[i] = v
+	}
+	return result
+}
+
+func (n *RecommendedList) AppendChild(child Node) error {
+	if child.GetType() != RecommendedType {
+		return ErrInvalidChildType
+	}
+	n.Children = append(n.Children, child.(*Recommended))
+	return nil
+}
+
 type ScrollyBlock struct {
 	Type     string            `json:"type"`
 	Children []*ScrollySection `json:"children"`

libraries/from-bodyxml/go/html_transformers.go

@@ -310,24 +310,29 @@ var defaultTransformers = map[string]transformer{
 			Muted:       attr(content, "muted") == "true",
 		}
 	},
-	"recommended": func(rl *etree.Element) contenttree.Node {
-		id := ""
-		teaser := ""
-		if link := findChild(rl, "content"); link != nil {
-			id = attr(link, "id")
-			teaser = textContent(link)
-		}
+	"recommended": transformRecommended,
+	"recommended-list": func(rl *etree.Element) contenttree.Node {
 		heading := findChild(rl, "recommended-title")
-		return &contenttree.Recommended{
-			Type: contenttree.RecommendedType,
-			ID:   id,
+		rl.RemoveChild(heading)
+		ul := findChild(rl, "ul")
+		var children []*contenttree.Recommended
+		if ul != nil {
+			for _, li := range ul.ChildElements() {
+				if r := transformRecommended(li).(*contenttree.Recommended); r != nil {
+					children = append(children, r)
+				}
+			}
+			rl.RemoveChild(ul)
+		}
+		return &contenttree.RecommendedList{
+			Type: contenttree.RecommendedListType,
 			Heading: func() string {
 				if heading != nil {
 					return textContent(heading)
 				}
 				return ""
 			}(),
-			TeaserTitleOverride: teaser,
+			Children: children,
 		}
 	},
 	"div": func(div *etree.Element) contenttree.Node {
@@ -375,3 +380,24 @@ var defaultTransformers = map[string]transformer{
 		return newLiftChildrenNode()
 	},
 }
+
+func transformRecommended(rl *etree.Element) contenttree.Node {
+	id := ""
+	teaser := ""
+	if link := findChild(rl, "content"); link != nil {
+		id = attr(link, "id")
+		teaser = textContent(link)
+	}
+	heading := findChild(rl, "recommended-title")
+	return &contenttree.Recommended{
+		Type: contenttree.RecommendedType,
+		ID:   id,
+		Heading: func() string {
+			if heading != nil {
+				return textContent(heading)
+			}
+			return ""
+		}(),
+		TeaserTitleOverride: teaser,
+	}
+}

tests/bodyxml-to-content-tree/input/simple-body-recommended-list.xml

@@ -0,0 +1 @@
+<body><p>Lorell</p><recommended-list><recommended-title>Recommended</recommended-title><ul><li><content id="70981218-05a4-4685-86e0-a19b7cae7ff9" type="http://www.ft.com/ontology/content/Content">The fight for the future of Chile </content></li></ul></recommended-list><p>Ipsum</p></body>

tests/bodyxml-to-content-tree/output/simple-body-recommended-list.json

@@ -0,0 +1,39 @@
+{
+  "type": "root",
+  "body": {
+    "type": "body",
+    "children": [
+      {
+        "type": "paragraph",
+        "children": [
+          {
+            "type": "text",
+            "value": "Lorell"
+          }
+        ]
+      },
+      {
+        "type": "recommended-list",
+        "heading": "Recommended",
+        "children": [
+          {
+            "type": "recommended",
+            "heading": "",
+            "id": "70981218-05a4-4685-86e0-a19b7cae7ff9",
+            "teaserTitleOverride": "The fight for the future of Chile "
+          }
+        ]
+      },
+      {
+        "type": "paragraph",
+        "children": [
+          {
+            "type": "text",
+            "value": "Ipsum"
+          }
+        ]
+      }
+    ],
+    "version": 1
+  }
+}