Module: Onlylogs

Defined in:
lib/onlylogs.rb,
lib/onlylogs/engine.rb,
lib/onlylogs/logger.rb,
lib/onlylogs/version.rb,
lib/onlylogs/formatter.rb,
app/models/onlylogs/file.rb,
app/models/onlylogs/grep.rb,
lib/onlylogs/configuration.rb,
lib/onlylogs/socket_logger.rb,
app/models/onlylogs/log_line.rb,
app/models/onlylogs/batch_sender.rb,
app/jobs/onlylogs/application_job.rb,
app/channels/onlylogs/logs_channel.rb,
app/models/onlylogs/file_path_parser.rb,
app/models/onlylogs/secure_file_path.rb,
lib/onlylogs/log_silencer_middleware.rb,
app/models/onlylogs/ansi_color_parser.rb,
app/models/onlylogs/application_record.rb,
app/helpers/onlylogs/application_helper.rb,
app/controllers/onlylogs/logs_controller.rb,
app/channels/onlylogs/application_cable/channel.rb,
app/controllers/onlylogs/application_controller.rb

Overview

kudos to github.com/BetterErrors/better_errors for this code!

Defined Under Namespace

Modules: ApplicationCable, ApplicationHelper Classes: AnsiColorParser, ApplicationController, ApplicationJob, ApplicationRecord, BatchSender, Configuration, Engine, Error, File, FilePathParser, Formatter, Grep, LogLine, LogSilencerMiddleware, Logger, LogsChannel, LogsController, SecureFilePath, SocketLogger

Constant Summary collapse

VERSION = 
"0.1.3"

Class Method Summary collapse

Class Method Details

.allowed_file_path?(file_path) ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
82
83
84
85
86
 
# File 'lib/onlylogs/configuration.rb', line 79

def self.allowed_file_path?(file_path)
  path = ::File.expand_path(file_path.to_s)

  configuration.allowed_files.any? do |pattern|
    pat = ::File.expand_path(pattern.to_s)
    ::File.fnmatch?(pat, path, ::File::FNM_PATHNAME | ::File::FNM_DOTMATCH)
  end
end

.basic_auth_configured? ⇒ Boolean

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/onlylogs/configuration.rb', line 108

def self.basic_auth_configured?
  basic_auth_user.present? && basic_auth_password.present?
end

.basic_auth_password ⇒ Object 



96
97
98
 
# File 'lib/onlylogs/configuration.rb', line 96

def self.basic_auth_password
  configuration.basic_auth_password
end

.basic_auth_user ⇒ Object 



92
93
94
 
# File 'lib/onlylogs/configuration.rb', line 92

def self.basic_auth_user
  configuration.basic_auth_user
end

.configuration ⇒ Object 



71
72
73
 
# File 'lib/onlylogs/configuration.rb', line 71

def self.configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yields:



75
76
77
 
# File 'lib/onlylogs/configuration.rb', line 75

def self.configure
  yield configuration
end

.default_log_file_path ⇒ Object 



88
89
90
 
# File 'lib/onlylogs/configuration.rb', line 88

def self.default_log_file_path
  configuration.default_log_file_path
end

.disable_basic_authentication? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/onlylogs/configuration.rb', line 104

def self.disable_basic_authentication?
  configuration.disable_basic_authentication
end

.editor ⇒ Object 



116
117
118
 
# File 'lib/onlylogs/configuration.rb', line 116

def self.editor
  configuration.default_editor
end

.editor=(editor_symbol) ⇒ Object 



120
121
122
123
124
 
# File 'lib/onlylogs/configuration.rb', line 120

def self.editor=(editor_symbol)
  configuration.editor = editor_symbol
  # Clear the cached editor instance when editor changes
  Onlylogs::FilePathParser.clear_editor_cache
end

.max_line_matches ⇒ Object 



126
127
128
 
# File 'lib/onlylogs/configuration.rb', line 126

def self.max_line_matches
  configuration.max_line_matches
end

.parent_controller ⇒ Object 



100
101
102
 
# File 'lib/onlylogs/configuration.rb', line 100

def self.parent_controller
  configuration.parent_controller
end

.ripgrep_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/onlylogs/configuration.rb', line 112

def self.ripgrep_enabled?
  configuration.ripgrep_enabled
end