class Freshen

This class contains the core Freshen functionality

Constants

FRESHENERS_DIR: The directory where fresheners live.
FRESHEN_DIR: The directory where data is stored.
PREFIX: The prefix of where data is stored.
VERSION: The current version of the gem.

Public Class Methods

cli?() click to toggle source

Returns a boolean value of whether or not we are running by the CLI.

# File lib/freshen.rb, line 41
def self.cli?
  defined? FRESHEN_CLI and true == FRESHEN_CLI
end

create_directories!() click to toggle source

This will create all required directories if they don't exist yet.

Example:

>> Freshen.create_directories!
=> nil

# File lib/freshen.rb, line 32
def self.create_directories!
  FileUtils.mkdir_p FRESHENERS_DIR
  
  return nil
end

require_tree!() click to toggle source

This will use the ruby 'require' method to require all freshen files included with this gem.

Example:

>> Freshen.require_tree!
=> nil

# File lib/freshen.rb, line 12
def self.require_tree!
  require 'freshen/helpers'
  require 'freshen/variables'
  require 'freshen/errors'
  require 'freshen/system'
  require 'freshen/executable'
  require 'freshener'
  require 'freshenary/status'
  require 'freshenary'
  
  return nil
end