module Gitdocs

rubocop:disable LineLength, ClassLength

@!attribute path

@return [String]

@!attribute polling_interval

@return [Double] defaults to 15.0

@!attribute notification

@return [Boolean] default to true

@!attribute remote_name

@return [String] default to 'origin'

@!attribute remote_branch

@return [String] default to 'master'

@attribute sync_type

@return ['full','fetch']

Notifications about git specific operations

Wrapper for the UI notifier

Wrapper for accessing the shared git repositories. Rugged or Grit will be used, in that order of preference, depending upon the features which are available with each option.

@note If a repository is invalid then query methods will return nil, and

command methods will raise exceptions.

Class for executing File and Git operations on a specific path in the repository.

Constants

Restart
VERSION

Public Class Methods

log_debug(message) click to toggle source

@param [String] message @return [void]

# File lib/gitdocs.rb, line 38
def self.log_debug(message)
  init_log
  Celluloid.logger.debug(message)
end
log_error(message) click to toggle source

@param [String] message @return [void]

# File lib/gitdocs.rb, line 59
def self.log_error(message)
  init_log
  Celluloid.logger.error(message)
end
log_info(message) click to toggle source

@param [String] message @return [void]

# File lib/gitdocs.rb, line 45
def self.log_info(message)
  init_log
  Celluloid.logger.info(message)
end
log_path() click to toggle source

@return [String]

# File lib/gitdocs.rb, line 32
def self.log_path
  File.expand_path('log', Initializer.root_dirname)
end
log_warn(message) click to toggle source

@param [String] message @return [void]

# File lib/gitdocs.rb, line 52
def self.log_warn(message)
  init_log
  Celluloid.logger.warn(message)
end

Private Class Methods

init_log() click to toggle source

@return [void]

# File lib/gitdocs.rb, line 69
def self.init_log
  return if @initialized

  # Initialize the logger
  log_output = Initializer.foreground ? STDOUT : log_path
  Celluloid.logger = Logger.new(log_output)
  Celluloid.logger.level = Initializer.verbose ? Logger::DEBUG : Logger::INFO
  @initialized = true
end