Module: Spoonerize

Defined in:
lib/spoonerize.rb,
lib/spoonerize.rb,
lib/spoonerize/cli.rb,
lib/spoonerize/log.rb,
lib/spoonerize/web.rb,
lib/spoonerize/bumper.rb,
lib/spoonerize/config.rb,
lib/spoonerize/version.rb,
lib/spoonerize/web/cli.rb,
lib/spoonerize/spoonerism.rb

Overview

The main namespace for the gem.

Defined Under Namespace

Modules: Version Classes: Bumper, Cli, Config, Log, Spoonerism, Web

Constant Summary collapse

CONFIG_FILE =

The config file the user can create to change default runtime options.

Returns:

  • (String) 
File.expand_path(File.join(ENV["HOME"], ".spoonerizerc"))
VERSION =

The version, as a string.

Returns:

  • (String) 
Version.to_s

Class Method Summary collapse

Class Method Details

.config ⇒ Spoonerize::Config

Method for accessing the configuration.

Returns:



33
34
35
 
# File 'lib/spoonerize.rb', line 33

def config
  @config || reset_config
end

.config_file_loaded? ⇒ Boolean

Has a config file been loaded?

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/spoonerize.rb', line 59

def config_file_loaded?
  @config_file_loaded
end

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

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

Examples:

Spoonerize.configure { |s| s.lazy = true }

Yields:



51
52
53
 
# File 'lib/spoonerize.rb', line 51

def configure
  yield config
end

.load_config_file(config_file) ⇒ String

Loads a config file.

Parameters:

  • config_file (String)

Returns:

  • (String) —

    file



69
70
71
72
73
74
75
76
 
# File 'lib/spoonerize.rb', line 69

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 ⇒ Spoonerize::Config

Reset all configuration values to their defaults.

Returns:



41
42
43
44
 
# File 'lib/spoonerize.rb', line 41

def reset_config
  @config_file_loaded = false
  @config = Spoonerize::Config.new
end