Merge pull request #124 from Financial-Times/feature/UPPSF-6577

add in-numbers section component to content-tree go representation

Author: lokendersinghft

content_tree.go

@@ -81,6 +81,9 @@ const (
 	TimelineType           = "timeline"
 	TimelineEventType      = "timeline-event"
 	TimelineEventChildType = "timeline-event-child"
+
+	DefinitionType = "definition"
+	InNumbersType  = "in-numbers"
 )
 
 var (
@@ -402,6 +405,7 @@ type BodyBlock struct {
 	*CustomCodeComponent
 	*ClipSet
 	*Timeline
+	*InNumbers
 }
 
 func (n *BodyBlock) GetType() string {
@@ -472,6 +476,9 @@ func (n *BodyBlock) GetEmbedded() Node {
 	if n.Timeline != nil {
 		return n.Timeline
 	}
+	if n.InNumbers != nil {
+		return n.InNumbers
+	}
 	return nil
 }
 
@@ -539,6 +546,9 @@ func (n *BodyBlock) GetChildren() []Node {
 	if n.Timeline != nil {
 		return n.Timeline.GetChildren()
 	}
+	if n.InNumbers != nil {
+		return n.InNumbers.GetChildren()
+	}
 	return nil
 }
 
@@ -677,6 +687,12 @@ func (n *BodyBlock) UnmarshalJSON(data []byte) error {
 			return err
 		}
 		n.Timeline = &v
+	case InNumbersType:
+		var v InNumbers
+		if err := json.Unmarshal(data, &v); err != nil {
+			return err
+		}
+		n.InNumbers = &v
 	default:
 		return fmt.Errorf("failed to unmarshal BodyBlock from %s: %w", data, ErrUnmarshalInvalidNode)
 	}
@@ -727,6 +743,8 @@ func (n *BodyBlock) MarshalJSON() ([]byte, error) {
 		return json.Marshal(n.ClipSet)
 	case n.Timeline != nil:
 		return json.Marshal(n.Timeline)
+	case n.InNumbers != nil:
+		return json.Marshal(n.InNumbers)
 	default:
 		return []byte(`{}`), nil
 	}
@@ -777,6 +795,8 @@ func makeBodyBlock(n Node) (*BodyBlock, error) {
 		return &BodyBlock{ClipSet: n.(*ClipSet)}, nil
 	case TimelineType:
 		return &BodyBlock{Timeline: n.(*Timeline)}, nil
+	case InNumbersType:
+		return &BodyBlock{InNumbers: n.(*InNumbers)}, nil
 	default:
 		return nil, ErrInvalidChildType
 	}
@@ -2805,3 +2825,53 @@ func makeTimelineEventChild(n Node) (*TimelineEventChild, error) {
 		return nil, ErrInvalidChildType
 	}
 }
+
+type Definition struct {
+	Type        string `json:"type"`
+	Term        string `json:"term"`
+	Description string `json:"description"`
+}
+
+func (d *Definition) GetType() string {
+	return d.Type
+}
+
+func (d *Definition) GetEmbedded() Node {
+	return nil
+}
+
+func (d *Definition) GetChildren() []Node {
+	return nil
+}
+
+func (n *Definition) AppendChild(_ Node) error { return ErrCannotHaveChildren }
+
+type InNumbers struct {
+	Type     string        `json:"type"`
+	Title    string        `json:"title,omitempty"`
+	Children []*Definition `json:"children"`
+}
+
+func (in *InNumbers) GetType() string {
+	return in.Type
+}
+
+func (in *InNumbers) GetEmbedded() Node {
+	return nil
+}
+
+func (in *InNumbers) GetChildren() []Node {
+	result := make([]Node, len(in.Children))
+	for i, v := range in.Children {
+		result[i] = v
+	}
+	return result
+}
+
+func (in *InNumbers) AppendChild(child Node) error {
+	if child.GetType() != DefinitionType {
+		return ErrInvalidChildType
+	}
+	in.Children = append(in.Children, child.(*Definition))
+	return nil
+}

libraries/from-bodyxml/go/html_transformers.go

@@ -162,7 +162,7 @@ var defaultTransformers = map[string]transformer{
 	},
 	"ol": func(ol *etree.Element) contenttree.Node {
 		dataType := attr(ol, "data-type")
-		if dataType == "timeline_events" {
+		if dataType == "timeline-events" {
 			return newLiftChildrenNode()
 		}
 		return &contenttree.List{
@@ -180,7 +180,7 @@ var defaultTransformers = map[string]transformer{
 	},
 	"li": func(li *etree.Element) contenttree.Node {
 		dataType := attr(li, "data-type")
-		if dataType == "timeline_event" {
+		if dataType == "timeline-event" {
 			timelineEventTitle := ""
 			if h4Element := findChild(li, "h4"); h4Element != nil {
 				timelineEventTitle = textContent(h4Element)
@@ -337,6 +337,10 @@ var defaultTransformers = map[string]transformer{
 		}
 	},
 	"div": func(div *etree.Element) contenttree.Node {
+		dataType := attr(div, "data-type")
+		if dataType == "in-numbers-definition" {
+			return newLiftChildrenNode()
+		}
 		switch attr(div, "class") {
 		case "n-content-layout":
 			return &contenttree.Layout{
@@ -357,6 +361,26 @@ var defaultTransformers = map[string]transformer{
 			return newUnknownNode(attr(div, "class"), div)
 		}
 	},
+	"dl": func(el *etree.Element) contenttree.Node {
+		return newLiftChildrenNode()
+	},
+	"dt": func(dt *etree.Element) contenttree.Node {
+		dataType := attr(dt, "data-type")
+		if dataType == "in-numbers-term" {
+			desc := ""
+			ddElement := dt.NextSibling()
+			if ddElement != nil {
+				desc = textContent(ddElement)
+				dt.Parent().RemoveChild(ddElement)
+			}
+			return &contenttree.Definition{
+				Type:        contenttree.DefinitionType,
+				Description: desc,
+				Term:        textContent(dt),
+			}
+		}
+		return newUnknownNode("", dt)
+	},
 	"section": func(section *etree.Element) contenttree.Node {
 		switch attr(section, "data-type") {
 		case "timeline":
@@ -374,6 +398,20 @@ var defaultTransformers = map[string]transformer{
 					Children:    []*contenttree.TimelineEvent{},
 				}
 			}
+		case "in-numbers":
+			{
+				var title string
+				if h3Element := findChild(section, "h3"); h3Element != nil {
+					title = textContent(h3Element)
+					//extract title but don't treat like a child element
+					section.RemoveChild(h3Element)
+				}
+				return &contenttree.InNumbers{
+					Type:     contenttree.InNumbersType,
+					Title:    title,
+					Children: []*contenttree.Definition{},
+				}
+			}
 		}
 		return newUnknownNode("", section)
 	},
@@ -382,14 +420,14 @@ var defaultTransformers = map[string]transformer{
 	},
 }
 
-func transformRecommended(rl *etree.Element) contenttree.Node {
+func transformRecommended(r *etree.Element) contenttree.Node {
 	id := ""
 	teaser := ""
-	if link := findChild(rl, "content"); link != nil {
-		id = attr(link, "id")
-		teaser = textContent(link)
+	if c := findChild(r, "content"); c != nil {
+		id = attr(c, "id")
+		teaser = textContent(c)
 	}
-	heading := findChild(rl, "recommended-title")
+	heading := findChild(r, "recommended-title")
 	return &contenttree.Recommended{
 		Type: contenttree.RecommendedType,
 		ID:   id,

tests/bodyxml-to-content-tree/input/simple-body-section-innumbers.xml

@@ -0,0 +1 @@
+<body><p>Lorell</p><section data-type="in-numbers" data-layout-width="full-width"><h3>Ipsum</h3><dl><div data-type="in-numbers-definition"><dt data-type="in-numbers-term">111</dt><dd data-type="in-numbers-description">Stat one</dd></div><div data-type="in-numbers-definition"><dt data-type="in-numbers-term">222</dt><dd data-type="in-numbers-description">Stat two</dd></div><div data-type="in-numbers-definition"><dt data-type="in-numbers-term">333</dt><dd data-type="in-numbers-description">Stat three</dd></div></dl></section><p>Lorell</p></body>

tests/bodyxml-to-content-tree/input/simple-body-section-timeline.xml

@@ -0,0 +1 @@
+<body><section data-type="timeline" data-layout-width="full-width"><h3>lorem</h3><ol data-type="timeline-events"><li data-type="timeline-event"><h4>ipsum</h4><p>lorem</p><p>ipsum</p><content type="http://www.ft.com/ontology/content/ImageSet" id="a47cfe4c-1f80-4492-9717-93aa65565e37"/></li><li data-type="timeline-event"><h4>lorem</h4><p>ipsum</p></li></ol></section></body>

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

@@ -0,0 +1,48 @@
+{
+  "type": "root",
+  "body": {
+    "type": "body",
+    "children": [
+      {
+        "type": "paragraph",
+        "children": [
+          {
+            "type": "text",
+            "value": "Lorell"
+          }
+        ]
+      },
+      {
+        "type": "in-numbers",
+        "title": "Ipsum",
+        "children": [
+          {
+            "type": "definition",
+            "term": "111",
+            "description": "Stat one"
+          },
+          {
+            "type": "definition",
+            "term": "222",
+            "description": "Stat two"
+          },
+          {
+            "type": "definition",
+            "term": "333",
+            "description": "Stat three"
+          }
+        ]
+      },
+      {
+        "type": "paragraph",
+        "children": [
+          {
+            "type": "text",
+            "value": "Lorell"
+          }
+        ]
+      }
+    ],
+    "version": 1
+  }
+}

tests/bodyxml-to-content-tree/output/simple-body-section-innumbers.json

@@ -56,4 +56,4 @@
     ],
     "version": 1
   }
-}
+}