Module: StandupMD

Defined in:
lib/standup_md.rb,
lib/standup_md/cli.rb,
lib/standup_md/file.rb,
lib/standup_md/entry.rb,
lib/standup_md/config.rb,
lib/standup_md/version.rb,
lib/standup_md/config/cli.rb,
lib/standup_md/entry_list.rb,
lib/standup_md/cli/helpers.rb,
lib/standup_md/config/file.rb,
lib/standup_md/config/entry.rb,
lib/standup_md/file/helpers.rb,
lib/standup_md/config/entry_list.rb

Overview

The main module for the gem. Provides access to configuration classes.

Defined Under Namespace

Modules: Version Classes: Cli, Config, Entry, EntryList, File

Constant Summary collapse

VERSION = 
StandupMD::Version.to_s

Class Method Summary collapse

Class Method Details

.config ⇒ StanupMD::Config

Method for accessing the configuration.

Returns:

  • (StanupMD::Config) 


21
22
23
 
# File 'lib/standup_md.rb', line 21

def config
  @config || reset_config
end

.config_file_loaded? ⇒ Boolean

Has a config file been loaded?

Returns:

  • (Boolean) 


46
47
48
 
# File 'lib/standup_md.rb', line 46

def config_file_loaded?
  @config_file_loaded
end

.configure {|config| ... } ⇒ Object

Allows for configuration via a block. Useful when making config files.

Examples:

StandupMD.configure { |s| s.cli.editor = 'mate' }

Yields:



38
39
40
 
# File 'lib/standup_md.rb', line 38

def configure
  yield config
end

.load_config_file(config_file) ⇒ String

Loads a config file.

Parameters:

  • file (String)

Returns:

  • (String) —

    file



56
57
58
59
60
61
62
63
 
# File 'lib/standup_md.rb', line 56

def load_config_file(config_file)
  ::File.expand_path(config_file).tap do |file|
    raise "File #{file} does not exist." unless ::File.file?(file)

    @config_file_loaded = true
    load file
  end
end

.reset_config ⇒ StandupMD::Config

Reset all configuration values to their defaults.

Returns:



29
30
31
 
# File 'lib/standup_md.rb', line 29

def reset_config
  @config = StandupMD::Config.new
end