meetup

package

v0.0.6 Latest Latest Go to latest Published: Jan 5, 2024 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/joshmeranda/meetup

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Config
- func DefaultConfig() (Config, error)
type GroupStrategy
type JobFunc
type JobQueue
- func NewJobQueue(n int) *JobQueue
- func (jq *JobQueue) Run(fn JobFunc)
type Manager
- func NewManager(config Config) (Manager, error)
- func (m *Manager) AddTemplate(paths ...string) error
- func (m *Manager) ListMeetings(mw MeetingQuery) ([]Meeting, error)
- func (m *Manager) ListTemplates() ([]string, error)
- func (m *Manager) OpenMeeting(meeting Meeting) error
- func (m *Manager) RemoveMeeting(meeting Meeting) error
- func (m *Manager) RemoveTemplate(names ...string) error
- func (m *Manager) SyncMetadata() error
- func (m *Manager) Tasks(query TaskQuery) ([]Task, error)
- func (m *Manager) UpdateMeetingGroupBy(newGs GroupStrategy) error
type Meeting
- func MeetingFromPath(gs GroupStrategy, p string) (Meeting, error)
- func (m Meeting) GetPath(meetupDir string, gs GroupStrategy) string
- func (m Meeting) String() string
- func (m Meeting) Title() string
type MeetingQuery
- func (mw MeetingQuery) Match(m Meeting) bool
type Metadata
- func DefaultMetadata() Metadata
type Task
type TaskQuery
- func (t TaskQuery) Match(task Task) bool

Constants ¶

View Source

const (
	DefaultTaskPrefix          = "- [ ] "
	DefaultTaskCompletedPrefix = "- [x] "
)

View Source

const (
	TemplateDirName = ".templates"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	RootDir         string   `yaml:"root_dir"`
	Editor          []string `yaml:"editor"`
	DefaultMetadata Metadata `yaml:"default_metadata"`
}

func DefaultConfig ¶

func DefaultConfig() (Config, error)

type GroupStrategy ¶

type GroupStrategy string

const (
	GroupByDomain GroupStrategy = "domain"
	GroupByDate   GroupStrategy = "date"

	MetadataFilename = ".metadata.yaml"
)

type JobFunc ¶ added in v0.0.2

type JobFunc func()

type JobQueue ¶ added in v0.0.2

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

JobQueue is a mindnummingly simple job queue, to support our minimal needs.

func NewJobQueue ¶ added in v0.0.2

func NewJobQueue(n int) *JobQueue

func (*JobQueue) Run ¶ added in v0.0.2

func (jq *JobQueue) Run(fn JobFunc)

type Manager ¶

type Manager struct {
	Config
	// contains filtered or unexported fields
}

func NewManager ¶

func NewManager(config Config) (Manager, error)

func (*Manager) AddTemplate ¶

func (m *Manager) AddTemplate(paths ...string) error

func (*Manager) ListMeetings ¶

func (m *Manager) ListMeetings(mw MeetingQuery) ([]Meeting, error)

func (*Manager) ListTemplates ¶

func (m *Manager) ListTemplates() ([]string, error)

func (*Manager) OpenMeeting ¶

func (m *Manager) OpenMeeting(meeting Meeting) error

OpenMeeting opens a meeting in the editor, and creates it if it doesn't not exist.

func (*Manager) RemoveMeeting ¶

func (m *Manager) RemoveMeeting(meeting Meeting) error

func (*Manager) RemoveTemplate ¶

func (m *Manager) RemoveTemplate(names ...string) error

func (*Manager) SyncMetadata ¶

func (m *Manager) SyncMetadata() error

func (*Manager) Tasks ¶

func (m *Manager) Tasks(query TaskQuery) ([]Task, error)

func (*Manager) UpdateMeetingGroupBy ¶

func (m *Manager) UpdateMeetingGroupBy(newGs GroupStrategy) error

type Meeting ¶

type Meeting struct {
	Name     string
	Date     string
	Domain   string
	Template string
}

func MeetingFromPath ¶

func MeetingFromPath(gs GroupStrategy, p string) (Meeting, error)

MeetingFromPath attemps to construct a Meeting from its path in the meetup dir. todo: misses the Template field

func (Meeting) GetPath ¶ added in v0.0.3

func (m Meeting) GetPath(meetupDir string, gs GroupStrategy) string

GetPath retusn the path to the meeting with meetupDir as the root.

func (Meeting) String ¶

func (m Meeting) String() string

func (Meeting) Title ¶ added in v0.0.6

func (m Meeting) Title() string

type MeetingQuery ¶ added in v0.0.1

type MeetingQuery struct {
	Name   glob.Glob
	Domain glob.Glob
	Date   glob.Glob
}

func (MeetingQuery) Match ¶ added in v0.0.1

func (mw MeetingQuery) Match(m Meeting) bool

type Metadata ¶

type Metadata struct {
	GroupBy         GroupStrategy     `yaml:"group_by"`
	DomainTemplates map[string]string `yaml:"domain_templates"`
}

func DefaultMetadata ¶

func DefaultMetadata() Metadata

type Task ¶

type Task struct {
	Meeting     Meeting
	Complete    bool
	Description string
}

type TaskQuery ¶

type TaskQuery struct {
	Meeting     MeetingQuery
	Complete    *bool
	Description glob.Glob
}

func (TaskQuery) Match ¶ added in v0.0.1

func (t TaskQuery) Match(task Task) bool

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL