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

Class Method Summary collapse

Class Method Details

.config ⇒ StanupMD::Cli

Method for accessing the configuration.

Returns:

  • (StanupMD::Cli) 


19
20
21
 
# File 'lib/standup_md.rb', line 19

def self.config
  @config || reset_config
end

.config_file_loaded? ⇒ Boolean

Has a config file been loaded?

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/standup_md.rb', line 44

def self.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:



36
37
38
 
# File 'lib/standup_md.rb', line 36

def self.configure
  yield config
end

.load_config_file(file) ⇒ String

Loads a config file.

Parameters:

  • file (String)

Returns:

  • (String) —

    file



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

def self.load_config_file(file)
  ::File.expand_path(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:



27
28
29
 
# File 'lib/standup_md.rb', line 27

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