text

Documentation

Index

• func Diff(from, to, originalFileContent, newFileContent string) string
• func IsURL(location string) bool
• func Show(content string) (result string)
• type MockTextRetriever
  • func (mtr *MockTextRetriever) FileExists(location string) bool
  • func (mtr *MockTextRetriever) ReadAll(location string) (string, error)
  • func (mtr *MockTextRetriever) ReadLine(location string, line int) (string, error)
  • func (mtr *MockTextRetriever) WriteLineToFile(lineContent, location string, lineNumber int) error
  • func (mtr *MockTextRetriever) WriteToFile(content string, location string) error
• type Text
  • func (t *Text) FileExists(location string) bool
  • func (t *Text) ReadAll(location string) (string, error)
  • func (t *Text) ReadLine(location string, line int) (string, error)
  • func (t *Text) WriteLineToFile(lineContent, location string, lineNumber int) (err error)
  • func (t *Text) WriteToFile(content string, location string) error
• type TextRetriever

Functions

func Diff

func Diff(from, to, originalFileContent, newFileContent string) string

Diff return a diff like string, comparing string A and string B

func IsURL

func IsURL(location string) bool

IsURL tests if a string is a valid http URL

func Show

func Show(content string) (result string)

Show return a string where each line start with a tabulation to increase visibility

Types

type MockTextRetriever

type MockTextRetriever struct {
	Err      error
	Contents map[string]string
}

MockTextRetriever is a stub implementation of the `TextRetriever` interface to be used in our unit test suites. It stores the expected Content and Err

func (*MockTextRetriever) FileExists

func (mtr *MockTextRetriever) FileExists(location string) bool

func (*MockTextRetriever) ReadAll

func (mtr *MockTextRetriever) ReadAll(location string) (string, error)

func (*MockTextRetriever) ReadLine

func (mtr *MockTextRetriever) ReadLine(location string, line int) (string, error)

func (*MockTextRetriever) WriteLineToFile

func (mtr *MockTextRetriever) WriteLineToFile(lineContent, location string, lineNumber int) error

func (*MockTextRetriever) WriteToFile

func (mtr *MockTextRetriever) WriteToFile(content string, location string) error

type Text

type Text struct{}

func (*Text) FileExists

func (t *Text) FileExists(location string) bool

func (*Text) ReadAll

func (t *Text) ReadAll(location string) (string, error)

ReadAll reads text content from a location (URL or filepath). The location accepts multiple input strings: starting with either "http://", "https://", or file url "file://" or filepath (default)

func (*Text) ReadLine

func (t *Text) ReadLine(location string, line int) (string, error)

ReadLine reads the specified line of text from the specified location (URL or filepath). The location accepts multiple input strings: starting with either "http://", "https://", or file url "file://" or filepath (default)

func (*Text) WriteLineToFile

func (t *Text) WriteLineToFile(lineContent, location string, lineNumber int) (err error)

WriteLineToFile writes 'lineContent' to the line number 'lineNumber' in the file at 'location'

func (*Text) WriteToFile

func (t *Text) WriteToFile(content string, location string) error

WriteToFile write a string to a file

type TextRetriever

type TextRetriever interface {
	ReadLine(location string, line int) (string, error)
	ReadAll(location string) (string, error)
	WriteToFile(content string, location string) error
	WriteLineToFile(lineContent, location string, lineNumber int) error
	FileExists(location string) bool
}