module Spoonerize
The main namespace for the gem.
The main namespace for the gem.
Constants
- CONFIG_FILE
-
The config file the user can create to change default runtime options.
@return [String]
- VERSION
-
The version, as a string.
@return [String]
Public Instance Methods
Source
# File lib/spoonerize.rb, line 33 def config @config || reset_config end
Method for accessing the configuration.
@return [Spoonerize::Config]
Source
# File lib/spoonerize.rb, line 59 def config_file_loaded? @config_file_loaded end
Has a config file been loaded?
@return [Boolean]
Source
# File lib/spoonerize.rb, line 51 def configure yield config end
Allows for configuration via a block. Useful when making config files.
@example
Spoonerize.configure { |s| s.lazy = true }
Source
# 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
Loads a config file.
@param [String] config_file
@return [String] file
Source
# File lib/spoonerize.rb, line 41 def reset_config @config_file_loaded = false @config = Spoonerize::Config.new end
Reset all configuration values to their defaults.
@return [Spoonerize::Config]