rule

Documentation

Index

• type Rule
  • func NewAlwaysActive(scheduleID string, tgt assignment.Target) *Rule
  • func (r Rule) AlwaysActive() bool
  • func (r Rule) EndTime(t time.Time) time.Time
  • func (r Rule) IsActive(t time.Time) bool
  • func (r Rule) NeverActive() bool
  • func (r Rule) Normalize() (*Rule, error)
  • func (r Rule) StartTime(t time.Time) time.Time
  • func (r Rule) String() string
• type ScheduleTriggerFunc
• type Store
  • func NewStore(ctx context.Context, db *sql.DB) (*Store, error)
  • func (s *Store) Add(ctx context.Context, r *Rule) (*Rule, error)
  • func (s *Store) CreateRuleTx(ctx context.Context, tx *sql.Tx, r *Rule) (*Rule, error)
  • func (s *Store) Delete(ctx context.Context, ruleID string) error
  • func (s *Store) DeleteByTarget(ctx context.Context, scheduleID string, target assignment.Target) error
  • func (s *Store) DeleteManyTx(ctx context.Context, tx *sql.Tx, ruleIDs []string) error
  • func (s *Store) DeleteTx(ctx context.Context, tx *sql.Tx, ruleID string) error
  • func (s *Store) FindAll(ctx context.Context, scheduleID string) ([]Rule, error)
  • func (s *Store) FindAllTx(ctx context.Context, tx *sql.Tx, scheduleID string) ([]Rule, error)
  • func (s *Store) FindAllWithUsers(ctx context.Context, scheduleID string) ([]Rule, error)
  • func (s *Store) FindByTargetTx(ctx context.Context, tx *sql.Tx, scheduleID string, target assignment.Target) ([]Rule, error)
  • func (s *Store) FindOne(ctx context.Context, ruleID string) (*Rule, error)
  • func (s *Store) FindScheduleID(ctx context.Context, ruleID string) (string, error)
  • func (s *Store) Update(ctx context.Context, r *Rule) error
  • func (s *Store) UpdateTx(ctx context.Context, tx *sql.Tx, r *Rule) error

Types

type Rule

type Rule struct {
	ID         string `json:"id"`
	ScheduleID string `json:"schedule_id"`
	timeutil.WeekdayFilter
	Start     timeutil.Clock `json:"start"`
	End       timeutil.Clock `json:"end"`
	CreatedAt time.Time      `json:"created_at"`
	Target    assignment.Target
}

func NewAlwaysActive

func NewAlwaysActive(scheduleID string, tgt assignment.Target) *Rule

func (Rule) AlwaysActive

func (r Rule) AlwaysActive() bool

AlwaysActive will return true if the rule will always be active.

func (Rule) EndTime

func (r Rule) EndTime(t time.Time) time.Time

EndTime will return the next time the rule would be inactive. If the rule is currently inactive, it will return the end of the next shift.

If the rule is always active, or never active, it returns a zero time.

func (Rule) IsActive

func (r Rule) IsActive(t time.Time) bool

IsActive determines if the rule is active in the given moment in time, in the location of t.

func (Rule) NeverActive

func (r Rule) NeverActive() bool

NeverActive returns true if the rule will never be active.

func (Rule) Normalize

func (r Rule) Normalize() (*Rule, error)

func (Rule) StartTime

func (r Rule) StartTime(t time.Time) time.Time

StartTime will return the next time the rule would be active. If the rule is currently active, it will return the time it became active (in the past).

If the rule is NeverActive or AlwaysActive, zero time is returned.

It may break when processing a timezone where daylight savings repeats or skips ahead at midnight.

func (Rule) String

func (r Rule) String() string

String returns a human-readable string describing the rule

type ScheduleTriggerFunc

type ScheduleTriggerFunc func(string)

type Store

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

func NewStore

func NewStore(ctx context.Context, db *sql.DB) (*Store, error)

func (*Store) Add

func (s *Store) Add(ctx context.Context, r *Rule) (*Rule, error)

func (*Store) CreateRuleTx

func (s *Store) CreateRuleTx(ctx context.Context, tx *sql.Tx, r *Rule) (*Rule, error)

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, ruleID string) error

func (*Store) DeleteByTarget

func (s *Store) DeleteByTarget(ctx context.Context, scheduleID string, target assignment.Target) error

DeleteByTarget removes all rules for a schedule pointing to the specified target.

func (*Store) DeleteManyTx

func (s *Store) DeleteManyTx(ctx context.Context, tx *sql.Tx, ruleIDs []string) error

func (*Store) DeleteTx

func (s *Store) DeleteTx(ctx context.Context, tx *sql.Tx, ruleID string) error

func (*Store) FindAll

func (s *Store) FindAll(ctx context.Context, scheduleID string) ([]Rule, error)

func (*Store) FindAllTx

func (s *Store) FindAllTx(ctx context.Context, tx *sql.Tx, scheduleID string) ([]Rule, error)

func (*Store) FindAllWithUsers

func (s *Store) FindAllWithUsers(ctx context.Context, scheduleID string) ([]Rule, error)

FindAllWithUsers works like FindAll but resolves rotations to the active user. This is reflected in the Target attribute. Rules pointing to inactive rotations (no participants) are omitted.

func (*Store) FindByTargetTx

func (s *Store) FindByTargetTx(ctx context.Context, tx *sql.Tx, scheduleID string, target assignment.Target) ([]Rule, error)

func (*Store) FindOne

func (s *Store) FindOne(ctx context.Context, ruleID string) (*Rule, error)

func (*Store) FindScheduleID

func (s *Store) FindScheduleID(ctx context.Context, ruleID string) (string, error)

func (*Store) Update

func (s *Store) Update(ctx context.Context, r *Rule) error

func (*Store) UpdateTx

func (s *Store) UpdateTx(ctx context.Context, tx *sql.Tx, r *Rule) error