domain

type Artifacts ¶ added in v0.2.2

type Artifacts struct {
	Descr       *Description
	Classes     []Class
	Suggestions []Suggestion
}

func UnmarshalArtifacts(msg *protocol.Message) (*Artifacts, error)

func (a *Artifacts) Marshal() *protocol.MessageSendParams

type Class ¶

type Class interface {
	Name() string
	Content() string
	Path() string
	SetContent(content string) error
}

Class represents a code or text entity with a name and content.

func NewInMemoryClass(name, path, content string) Class

func UnmarshalClass(part protocol.Part) (Class, error)

type Critic ¶

type Critic interface {
	Review(job *Job) (*Artifacts, error)
}

Critic represents an interface to review a class and provide suggestions.

type Description ¶ added in v0.2.2

type Description struct {
	Text string
	Meta map[string]any
}

func UnmarshalDescription(part protocol.Part) (*Description, error)

func (d *Description) Marshal() protocol.Part

type FSClass ¶ added in v0.2.2

type FSClass struct {
	// contains filtered or unexported fields
}

FSClass represents a Java class file stored in the filesystem.

func NewFSClass(name, path string) *FSClass

func (c *FSClass) Content() string

func (c *FSClass) Name() string

func (c *FSClass) Path() string

func (c *FSClass) SetContent(content string) error

type FSProj ¶ added in v0.2.2

type FSProj struct {
	// contains filtered or unexported fields
}

FSProj represents a project stored in the filesystem.

func NewFilesystem(path string) *FSProj

func (p *FSProj) Classes() ([]Class, error)

func (p *FSProj) String() string

type Facilitator ¶

type Facilitator interface {
	Refactor(job *Job) (*Artifacts, error)
}

Facilitator represents an interface to refactor tasks into multiple classes.

type Fixer ¶

type Fixer interface {
	Fix(job *Job) (*Artifacts, error)
}

Fixer represents an interface to fix a class based on suggestions and an example.

type InMemoryProject ¶ added in v0.2.2

type InMemoryProject struct {
	// contains filtered or unexported fields
}

InMemoryProject is an implementation of Project that stores its classes in memory.

func (i *InMemoryProject) Classes() ([]Class, error)

func (i *InMemoryProject) String() string

type Job ¶ added in v0.2.2

type Job struct {
	Descr       *Description
	Classes     []Class
	Suggestions []Suggestion
	Examples    []Class
}

func UnmarshalJob(msg *protocol.Message) (*Job, error)

func (j *Job) Marshal() *protocol.MessageSendParams

func (j *Job) Param(key string) (any, bool)

type MirrorProject ¶ added in v0.2.2

type MirrorProject struct {
	// contains filtered or unexported fields
}

MirrorProject decorates FilesystemProject with a mirror location to avoid modifying the original.

func NewMirrorProject(original *FSProj, mirrorPath string) (*MirrorProject, error)

func (m *MirrorProject) Classes() ([]Class, error)

type OldSuggestion ¶ added in v0.2.2

type OldSuggestion interface {
	Text() string
}

OldSuggestion represents a proposed improvement or fix for a class.

func NewOldSuggestion(text string) OldSuggestion

func UnmarshalOldSuggestion(part protocol.Part) (OldSuggestion, error)

type Project ¶ added in v0.2.2

type Project interface {
	// Classes retrieves all Java classes within the project.
	Classes() ([]Class, error)
}

Project represents an interface for managing Java classes within a project.

func NewInMemory(classes ...Class) Project

func NewMock() Project

type Reviewer ¶ added in v0.2.2

type Reviewer interface {
	Review() (*Artifacts, error)
}

Reviewer represents an interface for a reviewer that can review changes made.

type Suggestion ¶

type Suggestion struct {
	ClassPath string
	Text      string
}

func NewSuggestion(text, path string) *Suggestion

func UnmarshalSuggestion(part protocol.Part) (*Suggestion, error)

func (s *Suggestion) Marshal() protocol.Part

func (s *Suggestion) String() string

type Task ¶

type Task interface {
	Description() string
	Classes() []Class
	Param(name string) (string, bool)
}

Task represents a unit of work that contains classes and associated parameters.

func NewTask(description string, classes []Class, parameters map[string]any) Task