mirror of
https://github.com/kjanat/articulate-parser.git
synced 2026-01-16 21:42:11 +01:00
Kaj Kowalski
b56c9fa29f
Renames the `OriginalUrl` field to `OriginalURL` across media models to adhere to Go's common initialisms convention. The `json` tag is unchanged to maintain API compatibility. Introduces constants for exporter formats (e.g., `FormatMarkdown`, `FormatDocx`) to eliminate the use of magic strings, enhancing type safety and making the code easier to maintain. Additionally, this commit includes several minor code quality improvements: - Wraps file-writing errors in exporters to provide more context. - Removes redundant package-level comments from test files. - Applies various minor linting fixes throughout the codebase.
60 lines
1.8 KiB
Go
60 lines
1.8 KiB
Go
package exporters
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/kjanat/articulate-parser/internal/interfaces"
|
|
"github.com/kjanat/articulate-parser/internal/services"
|
|
)
|
|
|
|
// Format constants for supported export formats.
|
|
const (
|
|
FormatMarkdown = "markdown"
|
|
FormatDocx = "docx"
|
|
FormatHTML = "html"
|
|
)
|
|
|
|
// Factory implements the ExporterFactory interface.
|
|
// It creates appropriate exporter instances based on the requested format.
|
|
type Factory struct {
|
|
// htmlCleaner is used by exporters to convert HTML content to plain text
|
|
htmlCleaner *services.HTMLCleaner
|
|
}
|
|
|
|
// NewFactory creates a new exporter factory.
|
|
// It takes an HTMLCleaner instance that will be passed to the exporters
|
|
// created by this factory.
|
|
//
|
|
// Parameters:
|
|
// - htmlCleaner: Service for cleaning HTML content in course data
|
|
//
|
|
// Returns:
|
|
// - An implementation of the ExporterFactory interface
|
|
func NewFactory(htmlCleaner *services.HTMLCleaner) interfaces.ExporterFactory {
|
|
return &Factory{
|
|
htmlCleaner: htmlCleaner,
|
|
}
|
|
}
|
|
|
|
// CreateExporter creates an exporter for the specified format.
|
|
// Format strings are case-insensitive (e.g., "markdown", "DOCX").
|
|
func (f *Factory) CreateExporter(format string) (interfaces.Exporter, error) {
|
|
switch strings.ToLower(format) {
|
|
case FormatMarkdown, "md":
|
|
return NewMarkdownExporter(f.htmlCleaner), nil
|
|
case FormatDocx, "word":
|
|
return NewDocxExporter(f.htmlCleaner), nil
|
|
case FormatHTML, "htm":
|
|
return NewHTMLExporter(f.htmlCleaner), nil
|
|
default:
|
|
return nil, fmt.Errorf("unsupported export format: %s", format)
|
|
}
|
|
}
|
|
|
|
// SupportedFormats returns a list of all supported export formats,
|
|
// including both primary format names and their aliases.
|
|
func (f *Factory) SupportedFormats() []string {
|
|
return []string{FormatMarkdown, "md", FormatDocx, "word", FormatHTML, "htm"}
|
|
}
|