ruby-core

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

Brian Candler wrote:
> http://svn.ruby-lang.org/repos/ruby/trunk/lib/logger.rb
> 
> I have come across some strangeness in Logger::Application.
> 
> (1) attr_reader :logdev is declared - but @logdev is never initialised.

Sure.  Something wrong.

> (2) the actual logger is @log, but is not exposed via an accessor.

Yes.

> This means that:
> 
> (a) if you wish to change the format of logging from outside the app, it
>     gets messy:
> 
>     worker = MyApp.new			# subclass of Logger::Application
>     worker.log = "/tmp/worker.log"	# this is fine
>     worker.level = Logger::INFO		# so is this
>     worker.instance_variable_get(:@log).formatter = Logger::Formatter.new # Ugh!
> 
>     This is a useful pattern when using dependency injection to prepare
>     the application.

Agreed.  It should be easily doable.

> (b) if you wish to use the "logger.info" syntax within your application,
>     then you have to refer to the instance variable, i.e.
> 
>     @log.info "hello"
> 
> or else define your own accessor, e.g.
> 
>     def logger; @log; end
>     ...
>     logger.info "hello"

Right.

> (c) if a Logger::Application wishes to pass its logger to another object,
>     it has to refer to @log explicitly rather than using an accessor
>     (which seems a little fragile)

Agreed.

In summary, you are completely right and I cannot remember why I do it
like this...  It must be a bug and should be fixed.

> I expect this is unintentional, and perhaps the attr_reader :logdev was
> intended to expose the underlying logger object - or maybe the LogDevice
> object it contains. But either way, it always returns nil at present.
> 
> I'm not sure of the best way to improve this. At minimum, the useless
> attr_reader :logdev can be removed.
> 
> Maybe
> 
>     def logger
>       @log
>     end
> 
> is the easiest solution (unfortunately you can't make attr_reader :log
> because method 'log' has been used to call @log.add).

Attached is a patch created along to your suggestion.  I'll commit if
you don't have any trouble with this.

Regards,
// NaHi

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.5 (Cygwin)

iQEVAwUBRkMkNx9L2jg5EEGlAQJxpwgAm7oQRjudBOKURzxzCSacnMK9kICuf/Pb
HZWF+Z/Fr6rXbDRFHA4TPDC72nNxNH058tw4l9zgBuPA9jUK2lXlMm2ERHRpSnoX
0ttKfP1aP52dqkneCuBKsFuoJdibd8NUp1nVthgkaryJolkefgmAS/HsAi29nYGS
KNHEANE1Hw0haD+zpPRKAsbg+wZ6NvEr3XTD7WuqeQqgH6VNsyl5IP6xGKfXeJdv
hx+jHBstiDyc3r8XOGau7b5JMM/YELYr6v48SW/dSfkfNT+EGJ2wiypJvR6qWglR
AWIndmv+5+UY6NBNPPdkljUm6GT2SvENx/WygM3w2+sTclo7SYUG2Q==
=SCoL
-----END PGP SIGNATURE-----

Attachments (1)

logger.diff (2.51 KB, text/x-diff)

Index: lib/logger.rb
===================================================================
--- lib/logger.rb	(revision 12272)
+++ lib/logger.rb	(working copy)
@@ -1,8 +1,9 @@
 # logger.rb - saimple logging utility
 # Copyright (C) 2000-2003, 2005  NAKAMURA, Hiroshi <nakahiro@sarion.co.jp>.
 
-require 'monitor'
 
+# = logger.rb
+#
 # Simple logging utility.
 #
 # Author:: NAKAMURA, Hiroshi  <nakahiro@sarion.co.jp>
@@ -12,6 +13,11 @@
 #   license; either the dual license version in 2003, or any later version.
 # Revision:: $Id$
 #
+# See Logger for documentation.
+#
+
+
+#
 # == Description
 #
 # The Logger class provides a simple but sophisticated logging utility that
@@ -149,8 +155,8 @@
 #
 # == Format
 #
-# Log messages are rendered in the output stream in a certain format.  The
-# default format and a sample are shown below:
+# Log messages are rendered in the output stream in a certain format by
+# default.  The default format and a sample are shown below:
 #
 # Log format:
 #   SeverityID, [Date Time mSec #pid] SeverityLabel -- ProgName: message
@@ -163,11 +169,18 @@
 #   logger.datetime_format = "%Y-%m-%d %H:%M:%S"
 #         # e.g. "2004-01-03 00:54:26"
 #
-# There is currently no supported way to change the overall format, but you may
-# have some luck hacking the Format constant.
+# You may change the overall format with Logger#formatter= method.
 #
+#   logger.formatter = proc { |severity, datetime, progname, msg|
+#     "#{datetime}: #{msg}\n"
+#   }
+#         # e.g. "Thu Sep 22 08:51:08 GMT+9:00 2005: hello world"
+#
 
 
+require 'monitor'
+
+
 class Logger
   VERSION = "1.2.6"
   /: (\S+),v (\S+)/ =~ %q$Id$
@@ -625,8 +638,8 @@
   class Application
     include Logger::Severity
 
+    # Name of the application given at initialize.
     attr_reader :appname
-    attr_reader :logdev
 
     #
     # == Synopsis
@@ -665,10 +678,22 @@
       status
     end
 
+    # Logger for this application.  See the class Logger for an explanation.
+    def logger
+      @log
+    end
+
     #
-    # Sets the log device for this application.  See the class Logger for an
-    # explanation of the arguments.
+    # Sets the logger for this application.  See the class Logger for an explanation.
     #
+    def logger=(logger)
+      @log = logger
+    end
+
+    #
+    # Sets the log device for this application.  See <tt>Logger.new</tt> for an explanation
+    # of the arguments.
+    #
     def set_log(logdev, shift_age = 0, shift_size = 1024000)
       @log = Logger.new(logdev, shift_age, shift_size)
       @log.progname = @appname

Thread

Prev Next

In This Thread

Prev Next

[#11066] question about frame_unique — Paul Brannan <pbrannan@...>

[#11069] High-precision Rationals cannot be converted to Floats — <noreply@...>

[#11070] Re: Welcome to our (ruby-core ML) You are added automatically — "Bunno Lim" <bunno_lim@...>

[#11071] autorunner -n option does not work in trunk — <noreply@...>

[#11073] segfault printing instruction sequence for iterator — <noreply@...>

[#11074] sub! causing unexpected side effect — <noreply@...>

[#11075] Ruby fails to parse valid wsdl — <noreply@...>

[#11076] Windows DEP causes crash — <noreply@...>

[#11077] Submitting an RDoc patch — gga <ggarra@...>

[#11078] sub! causing unexpected side effect — <noreply@...>

[#11079] ruby packer prototype: core dumps ( design review request ) — "Adam Bozanich" <adam.boz@...>

[#11081] sub! causing unexpected side effect — <noreply@...>

[#11082] Understanding code: Kernel#require and blocks. — Hugh Sasse <hgs@...>

[#11088] Net::HTTP encodes parameters improperly. — <noreply@...>

[#11090] parsedate fails — <noreply@...>

[#11092] return from block inside a lambda does not work as expected — <noreply@...>

[#11094] RDoc for Kernel#select same as IO.select — <noreply@...>

[#11095] RDoc for Kernel#select same as IO.select — <noreply@...>

[#11097] TestReadline fails depending on the terminal in which the test is run. — <noreply@...>

[#11098] Short read with readline, popen and timeout - first byte of the line disappears — <noreply@...>

[#11099] Short read with readline, popen and timeout - first byte of the line disappears — <noreply@...>

[#11100] Short read with readline, popen and timeout - first byte of the line disappears — <noreply@...>

[#11102] Net::HTTP encodes parameters improperly. — <noreply@...>

[#11103] irb attempts to escape '\c' inside single quotes — <noreply@...>

[#11104] overriding autoloads with classes and modules — Thomas Enebo <Thomas.Enebo@...>

[#11106] Failure parsing dates returned by WIN32OLE — <noreply@...>

[#11107] unable to build ruby HEAD without previously installed ruby — <noreply@...>

[#11108] pattern for implementation-private constants? — David Flanagan <david@...>

[#11117] BUGS in metaclasses inheritance — <noreply@...>

[#11118] BUGS in metaclasses inheritance — <noreply@...>

[#11121] Weird rounding behavior.. — <noreply@...>

[#11124] IRHG - Found interesting Japanese Document exploring various GC's — Charles Thornton <ceo@...>

[#11125] two fixes for sync.rb: sync_try_lock, Err.Fail — "Dmitry Borodaenko" <angdraug@...>

[#11127] Bugs that can be closed — "Jano Svitok" <jan.svitok@...>

[#11128] Weird rounding behavior.. — <noreply@...>

[#11129] sub! causing unexpected side effect — <noreply@...>

[#11130] :!~ not a symbol — <noreply@...>

[#11131] Documentation for String.scan has a bad example. — <noreply@...>

[#11132] rdoc/usage uses an uninitalized constant — <noreply@...>

[#11133] bug in newton.rb — <noreply@...>

[#11134] each_with_index (Enumerable) does not forward arguments to each — <noreply@...>

[#11135] Ruby Gem installer not playing nice on Ubuntu — <noreply@...>

[#11136] Ruby one-click installer wiped out system PATH environment variable. — <noreply@...>

[#11137] Ruby one-click installer wiped out system PATH environment variable. — <noreply@...>

[#11138] Marshal.dump shouldn't complain about singletons if the _dump method is defined — <noreply@...>

[#11139] exit from within block returns wrong value. — <noreply@...>

[#11140] :!~ not a symbol — <noreply@...>

[#11141] Weird rounding behavior.. — <noreply@...>

[#11143] Logger::Application accessor for logger — Brian Candler <B.Candler@...>

[#11144] Rational comparison to 0 fails when denominator is != 1 — <noreply@...>

[#11145] Rational comparison to 0 fails when denominator is != 1 — <noreply@...>

[#11147] RDoc patch to better support documenting multiple classes/SWIG — <noreply@...>

[#11150] "password" is case sensitive in lib/telnet.rb — <noreply@...>

[#11153] segfault printing instruction sequence for iterator — <noreply@...>

[#11154] Rational comparison to 0 fails when denominator is != 1 — <noreply@...>

[#11155] Class#=== bug — <noreply@...>

[#11156] Class#=== bug — <noreply@...>

[#11157] Class#=== bug — <noreply@...>

[#11158] Class#=== bug — <noreply@...>

[#11159] Rational comparison to 0 fails when denominator is != 1 — <noreply@...>

[#11165] Rational comparison to 0 fails when denominator is != 1 — <noreply@...>

[#11166] rdoc patches — Joel VanderWerf <vjoel@...>

[#11167] Date parsing bug with patch — <noreply@...>

[#11169] Allow back reference with nest level in Oniguruma for Ruby again — =?ISO-8859-15?Q?Wolfgang_N=E1dasi-Donner?= <wonado@...>

[#11171] Loss of precision during iteration. — <noreply@...>

[#11172] "read_nonblock" Problem (Windows and Ruby 1.8) — =?ISO-8859-15?Q?Wolfgang_N=E1dasi-Donner?= <wonado@...>

[#11174] Loss of precision during iteration. — <noreply@...>

[#11175] Loss of precision during iteration. — <noreply@...>

[#11176] FileUtils.rm_rf misfeature? — johan556@...

[#11177] Loss of precision during iteration. — <noreply@...>

[#11187] Garbage collection of Symbols in future release? — Sven Suska <sven716rc@...>

[#11193] IRHG -- Downloadable Files — Charles Thornton <ceo@...>

[#11204] URI Methods Raise Unclear Exceptions When Passed URI Objects — <noreply@...>

[#11206] ri HTML output bug with constants — Chris Thomas <chris@...>

[#11208] How to handle Change Proposals that affect mainly Oniguruma (for Ruby)? — =?ISO-8859-15?Q?Wolfgang_N=E1dasi-Donner?= <wonado@...>

[#11209] eval("0.0025 + 9 * 0.0025") === 0.025 => false — <noreply@...>

[#11210] Pathname ascend and descend inclusive parameter — TRANS <transfire@...>

[#11211] eval("0.0025 + 9 * 0.0025") === 0.025 => false — <noreply@...>

[#11213] eval(&quot;0.0025 + 9 * 0.0025&quot;) === 0.025 =&gt; false — <noreply@...>

[#11214] eval(&quot;0.0025 + 9 * 0.0025&quot;) === 0.025 =&gt; false — <noreply@...>

[#11213] eval("0.0025 + 9 * 0.0025") === 0.025 => false — <noreply@...>

[#11214] eval("0.0025 + 9 * 0.0025") === 0.025 => false — <noreply@...>

[#11216] eval("0.0025 + 9 * 0.0025") === 0.025 => false — <noreply@...>

[#11290] [TINY][PATCH] Array#last is not working for n > 3 — <noreply@...>

[#11291] In a c++ program, when I call "fclose()", or "ofstream::close()" in a file that includes ruby.h, the program crashes — <noreply@...>

[#11318] Problem with Benchmark::Tms#add! - expects &blk but takes no parameters — <noreply@...>