Allow deprecation flags for component docs

Author: Jeffail

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Ashley Jeffs
+Copyright (c) 2020 Ashley Jeffs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/inputs/README.md

@@ -53,31 +53,6 @@ input:
 30. [`udp_server`](#udp_server)
 31. [`websocket`](#websocket)
 
-## `amqp`
-
-``` yaml
-type: amqp
-amqp:
-  bindings_declare: []
-  consumer_tag: benthos-consumer
-  max_batch_count: 1
-  prefetch_count: 10
-  prefetch_size: 0
-  queue: benthos-queue
-  queue_declare:
-    durable: true
-    enabled: false
-  tls:
-    client_certs: []
-    enabled: false
-    root_cas_file: ""
-    skip_cert_verify: false
-  url: amqp://guest:guest@localhost:5672/
-```
-
-DEPRECATED: This input is deprecated and scheduled for removal in Benthos V4.
-Please use [`amqp_0_9`](#amqp_0_9) instead.
-
 ## `amqp_0_9`
 
 ``` yaml

docs/outputs/README.md

@@ -97,32 +97,6 @@ a [`try`](#try) output.
 38. [`udp`](#udp)
 39. [`websocket`](#websocket)
 
-## `amqp`
-
-``` yaml
-type: amqp
-amqp:
-  exchange: benthos-exchange
-  exchange_declare:
-    durable: true
-    enabled: false
-    type: direct
-  immediate: false
-  key: benthos-key
-  mandatory: false
-  max_in_flight: 1
-  persistent: false
-  tls:
-    client_certs: []
-    enabled: false
-    root_cas_file: ""
-    skip_cert_verify: false
-  url: amqp://guest:guest@localhost:5672/
-```
-
-DEPRECATED: This output is deprecated and scheduled for removal in Benthos V4.
-Please use [`amqp_0_9`](#amqp_0_9) instead.
-
 ## `amqp_0_9`
 
 ``` yaml

docs/processors/README.md

@@ -235,25 +235,6 @@ foo_created_at = "2018-12-18T11:57:32"
 
 Custom functions can also still be used with this codec.
 
-## `batch`
-
-``` yaml
-type: batch
-batch:
-  byte_size: 0
-  condition:
-    type: static
-    static: false
-  count: 0
-  period: ""
-```
-
-DEPRECATED: This processor is no longer supported and has been replaced with
-improved batching mechanisms. For more information about batching in Benthos
-please check out [this document](../batching.md).
-
-This processor is scheduled to be removed in Benthos V4
-
 ## `bounds_check`
 
 ``` yaml

lib/input/amqp.go

@@ -32,9 +32,10 @@ import (
 func init() {
 	Constructors[TypeAMQP] = TypeSpec{
 		constructor: NewAMQP,
-		description: `
+		Description: `
 DEPRECATED: This input is deprecated and scheduled for removal in Benthos V4.
 Please use [` + "`amqp_0_9`" + `](#amqp_0_9) instead.`,
+		Deprecated: true,
 	}
 }
 

lib/input/amqp_0_9.go

@@ -32,7 +32,7 @@ import (
 func init() {
 	Constructors[TypeAMQP09] = TypeSpec{
 		constructor: NewAMQP09,
-		description: `
+		Description: `
 Connects to an AMQP (0.91) queue. AMQP is a messaging protocol used by various
 message brokers, including RabbitMQ.
 

lib/input/async_reader.go

@@ -28,42 +28,15 @@ import (
 
 	"github.com/Jeffail/benthos/v3/lib/input/reader"
 	"github.com/Jeffail/benthos/v3/lib/log"
-	"github.com/Jeffail/benthos/v3/lib/message/batch"
 	"github.com/Jeffail/benthos/v3/lib/message/tracing"
 	"github.com/Jeffail/benthos/v3/lib/metrics"
 	"github.com/Jeffail/benthos/v3/lib/response"
 	"github.com/Jeffail/benthos/v3/lib/types"
 	"github.com/Jeffail/benthos/v3/lib/util/throttle"
-	"gopkg.in/yaml.v3"
 )
 
 //------------------------------------------------------------------------------
 
-func sanitiseWithBatch(
-	componentConfig interface{},
-	batchConfig batch.PolicyConfig,
-) (map[string]interface{}, error) {
-	batchSanit, err := batch.SanitisePolicyConfig(batchConfig)
-	if err != nil {
-		return nil, err
-	}
-
-	cBytes, err := yaml.Marshal(componentConfig)
-	if err != nil {
-		return nil, err
-	}
-
-	hashMap := map[string]interface{}{}
-	if err = yaml.Unmarshal(cBytes, &hashMap); err != nil {
-		return nil, err
-	}
-
-	hashMap["batching"] = batchSanit
-	return hashMap, nil
-}
-
-//------------------------------------------------------------------------------
-
 // AsyncReader is an input implementation that reads messages from a
 // reader.Async component.
 type AsyncReader struct {

lib/input/broker.go

@@ -48,7 +48,7 @@ func init() {
 	Constructors[TypeBroker] = TypeSpec{
 		brokerConstructor:                  NewBroker,
 		brokerConstructorHasBatchProcessor: newBrokerHasBatchProcessor,
-		description: `
+		Description: `
 The broker type allows you to combine multiple inputs, where each input will be
 read in parallel. A broker type is configured with its own list of input
 configurations and a field to specify how many copies of the list of inputs

lib/input/constructor.go

@@ -21,11 +21,8 @@
 package input
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
-	"sort"
-	"strings"
 
 	"github.com/Jeffail/benthos/v3/lib/input/reader"
 	"github.com/Jeffail/benthos/v3/lib/log"
@@ -50,7 +47,6 @@ type TypeSpec struct {
 		pipelineConstructors ...types.PipelineConstructorFunc,
 	) (Type, error)
 	constructor        func(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (Type, error)
-	description        string
 	sanitiseConfigFunc func(conf Config) (interface{}, error)
 
 	// DEPRECATED: This is a hack for until the batch processor is removed.
@@ -70,6 +66,11 @@ type TypeSpec struct {
 		log log.Modular,
 		stats metrics.Type,
 	) (Type, error)
+
+	Description string
+
+	// Deprecated indicates whether this component is deprecated.
+	Deprecated bool
 }
 
 // Constructors is a map of all input types with their specs.
@@ -304,73 +305,6 @@ func (c *Config) UnmarshalYAML(value *yaml.Node) error {
 
 //------------------------------------------------------------------------------
 
-var header = "This document was generated with `benthos --list-inputs`" + `
-
-An input is a source of data piped through an array of optional
-[processors](../processors). Only one input is configured at the root of a
-Benthos config. However, the root input can be a [broker](#broker) which
-combines multiple inputs.
-
-An input config section looks like this:
-
-` + "``` yaml" + `
-input:
-  type: foo
-  foo:
-    bar: baz
-  processors:
-  - type: qux
-` + "```" + ``
-
-// Descriptions returns a formatted string of descriptions for each type.
-func Descriptions() string {
-	// Order our input types alphabetically
-	names := []string{}
-	for name := range Constructors {
-		names = append(names, name)
-	}
-	sort.Strings(names)
-
-	buf := bytes.Buffer{}
-	buf.WriteString("Inputs\n")
-	buf.WriteString(strings.Repeat("=", 6))
-	buf.WriteString("\n\n")
-	buf.WriteString(header)
-	buf.WriteString("\n\n")
-
-	buf.WriteString("### Contents\n\n")
-	for i, name := range names {
-		buf.WriteString(fmt.Sprintf("%v. [`%v`](#%v)\n", i+1, name, name))
-	}
-	buf.WriteString("\n")
-
-	// Append each description
-	for i, name := range names {
-		var confBytes []byte
-
-		conf := NewConfig()
-		conf.Type = name
-		conf.Processors = nil
-		if confSanit, err := SanitiseConfig(conf); err == nil {
-			confBytes, _ = config.MarshalYAML(confSanit)
-		}
-
-		buf.WriteString("## ")
-		buf.WriteString("`" + name + "`")
-		buf.WriteString("\n")
-		if confBytes != nil {
-			buf.WriteString("\n``` yaml\n")
-			buf.Write(confBytes)
-			buf.WriteString("```\n")
-		}
-		buf.WriteString(Constructors[name].description)
-		if i != (len(names) - 1) {
-			buf.WriteString("\n\n")
-		}
-	}
-	return buf.String()
-}
-
 // New creates an input type based on an input configuration.
 func New(
 	conf Config,