Skip to content

Commit

Permalink
renaming to :condensed
Browse files Browse the repository at this point in the history
  • Loading branch information
Mason McLead committed Jun 2, 2017
1 parent 4276cd6 commit 6546c93
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 25 deletions.
5 changes: 5 additions & 0 deletions .byebug_history
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
exit
c
log_statements.compact.delete_if(&:empty?).each(&:strip!)
log_statements.compact.delete_if(&:empty?).each(&:lstrip)
log_statements.compact.delete_if(&:empty?).each(&:strip)
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Completed 422 in 6.29ms
The middleware logger can be customized with the following options:

* The `:logger` option can be any object that responds to `.info(String)`
* The `:one_line` option configures the log output to be on one line instead of multiple. It accepts `true` or `false`. The default configuration is `false`
* The `:condensed` option configures the log output to be on one line instead of multiple. It accepts `true` or `false`. The default configuration is `false`
* The `:filter` option can be any object that responds to `.filter(Hash)` and returns a hash.
* The `:headers` option can be either `:all` or array of strings.
+ If `:all`, all request headers will be output.
Expand All @@ -63,10 +63,9 @@ For example:
```ruby
insert_after Grape::Middleware::Formatter, Grape::Middleware::Logger, {
logger: Logger.new(STDERR),
one_line: true,
condensed: true,
filter: Class.new { def filter(opts) opts.reject { |k, _| k.to_s == 'password' } end }.new,
headers: %w(version cache-control)
filter: Class.new { def filter(opts) opts.reject { |k, _| k.to_s == 'password' } end }.new
}
```
Expand Down
40 changes: 26 additions & 14 deletions lib/grape/middleware/logger.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class Grape::Middleware::Logger < Grape::Middleware::Globals
attr_reader :logger

class << self
attr_accessor :logger, :filter, :one_line, :headers
attr_accessor :logger, :filter, :headers, :condensed

def default_logger
default = Logger.new(STDOUT)
Expand All @@ -20,27 +20,27 @@ def initialize(_, options = {})
super
@options[:filter] ||= self.class.filter
@options[:headers] ||= self.class.headers
@options[:one_line] ||= false
@options[:condensed] ||= false
@logger = options[:logger] || self.class.logger || self.class.default_logger
end

def before
start_time
# sets env['grape.*']
super
if @options[:one_line]
logger.info %Q(Started #{env[Grape::Env::GRAPE_REQUEST].request_method} "#{env[Grape::Env::GRAPE_REQUEST].path}" at #{start_time.to_s} - Processing by #{processed_by} - Parameters: #{parameters})
else
logger.info ''
logger.info %Q(Started %s "%s" at %s) % [

log_statements = [
'',
%Q(Started %s "%s" at %s) % [
env[Grape::Env::GRAPE_REQUEST].request_method,
env[Grape::Env::GRAPE_REQUEST].path,
start_time.to_s
]
logger.info %Q(Processing by #{processed_by})
logger.info %Q( Parameters: #{parameters})
logger.info %Q( Headers: #{headers}) if @options[:headers]
end
],
%Q(Processing by #{processed_by}),
%Q( Parameters: #{parameters})]

log_statements.append(%Q( Headers: #{headers})) if @options[:headers]
log_info(log_statements)
end

# @note Error and exception handling are required for the +after+ hooks
Expand Down Expand Up @@ -69,8 +69,12 @@ def call!(env)
end

def after(status)
logger.info "Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms"
logger.info '' unless @options[:one_line]
log_info(
[
"Completed #{status} in #{((Time.now - start_time) * 1000).round(2)}ms",
''
]
)
end

#
Expand Down Expand Up @@ -125,6 +129,14 @@ def processed_by
result.concat endpoint.options[:path].map { |path| path.to_s.sub(BACKSLASH, '') }
endpoint.options[:for].to_s << result.join(BACKSLASH)
end

def log_info(log_statements=[])
if @options[:condensed]
logger.info log_statements.compact.delete_if(&:empty?).each(&:strip!).join(" - ")
else
log_statements.each { |log_statement| logger.info log_statement }
end
end
end

require_relative 'logger/railtie' if defined?(Rails)
8 changes: 4 additions & 4 deletions spec/integration/lib/grape/middleware/logger_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
let(:grape_endpoint) { build(:grape_endpoint) }
let(:env) { build(:expected_env, grape_endpoint: grape_endpoint) }

context 'when the option[:one_line] is false' do
let(:options) { { filter: build(:param_filter), logger: Logger.new(Tempfile.new('logger')), one_line: false } }
context 'when the option[:condensed] is false' do
let(:options) { { filter: build(:param_filter), logger: Logger.new(Tempfile.new('logger')), condensed: false } }

it 'logs all parts of the request on multiple lines' do
expect(subject.logger).to receive(:info).with ''
Expand All @@ -25,8 +25,8 @@
end
end

context 'when the options[:one_line is true' do
let(:options) { { filter: build(:param_filter), logger: Logger.new(Tempfile.new('logger')), one_line: true } }
context 'when the options[:condensed is true' do
let(:options) { { filter: build(:param_filter), logger: Logger.new(Tempfile.new('logger')), condensed: true } }

it 'logs all parts of the request on one line' do
expect(subject.logger).to receive(:info).with %Q(Started POST "/api/1.0/users" at #{subject.start_time} - Processing by TestAPI/users - Parameters: {"id"=>"101001", "secret"=>"[FILTERED]", "customer"=>[], "name"=>"foo", "password"=>"[FILTERED]"})
Expand Down
8 changes: 4 additions & 4 deletions spec/integration_rails/lib/grape/middleware/logger_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@
end
end

context 'when the option[:one_line] is false' do
let(:options) { { one_line: false } }
context 'when the option[:condensed] is false' do
let(:options) { { condensed: false } }

it 'logs all parts of the request on multiple lines' do
expect(subject.logger).to receive(:info).with ''
Expand All @@ -56,8 +56,8 @@
end
end

context 'when the option[:one_line] is true' do
let(:options) { { one_line: true } }
context 'when the option[:condensed] is true' do
let(:options) { { condensed: true } }
it 'logs all parts of the request on one line' do
expect(subject.logger).to receive(:info).with %Q(Started POST "/api/1.0/users" at #{subject.start_time} - Processing by TestAPI/users - Parameters: {"id"=>"101001", "secret"=>"key", "customer"=>[], "name"=>"foo", "password"=>"[FILTERED]"})
expect(subject.logger).to receive(:info).with /Completed 200 in \d+.\d+ms/
Expand Down

0 comments on commit 6546c93

Please sign in to comment.