class StandupMD::Config::Cli

The configuration class for StandupMD::Cli

Constants

CONFIG_ATTRIBUTES

Attributes copied into request-scoped config snapshots.

@return [Array<Symbol>]

DEFAULTS

The default options.

@return [Hash]

Attributes

auto_fill_previous [RW]

When writing a new entry, should ‘previous’ be pulled from the last entry?

@param [Boolean] auto_fill_previous

@return [Boolean]

date [RW]

The date to use to find the entry.

@param [Date] date

@return [Date]

edit [RW]

Should the CLI edit?

@param [Boolean] edit

@return [Boolean]

editor [RW]

The editor to use when opening standup files. If one is not set, the first of $VISUAL, $EDITOR, or vim will be used, in that order.

@param [String] editor

@return [String]

post [RW]

Should the CLI post the entry to a chat client?

@param [Boolean] post

@return [Boolean]

post_adapter [RW]

The chat adapter to use for posting.

@param [String, Symbol, nil] post_adapter

@return [String, Symbol, nil]

post_channel [RW]

The channel to use for posting.

@param [String, nil] post_channel

@return [String, nil]

preference_file [RW]

The preference file for Cli.

@param [String] preference

@return [String]

print [RW]

Should the CLI print the entry to the command line?

@param [Boolean] print

@return [Boolean]

verbose [RW]

Should the CLI print verbose output?

@param [Boolean] verbose

@return [Boolean]

write [RW]

Should the CLI automatically write the new entry to the file?

@param [Boolean] write

@return [Boolean]

Public Class Methods

new ()

Source

# File lib/standup_md/config/cli.rb, line 128
def initialize
  reset
end

Initializes the config with default values.

Public Instance Methods

copy_from (config)

Source

# File lib/standup_md/config/cli.rb, line 148
def copy_from(config)
  CONFIG_ATTRIBUTES.each do |attribute|
    instance_variable_set(
      "@#{attribute}",
      copy_default(config.public_send(attribute))
    )
  end
  self
end

Copies values from another CLI config.

@param [StandupMD::Config::Cli] config

@return [StandupMD::Config::Cli]

reset ()

Source

# File lib/standup_md/config/cli.rb, line 136
def reset
  DEFAULTS.each do |key, value|
    instance_variable_set("@#{key}", copy_default(resolve_default(value)))
  end
end

Sets all config values back to their defaults.

@return [Hash]