debuglog 1.0.0 → 1.0.1

data/test/debuglog-auto.rb

@@ -1,66 +1,79 @@
-D "Debuglog auto configuration" do
-  D.<< {
-    DebugLog.send :wipe_slate_clean_for_testing
-    DebugLog.autoconfigure
-  }
-
-  D "Debuglog and DebugLog are the same thing" do
-    Id Debuglog, DebugLog
-  end
-  D "Methods are defined in Kernel" do
-    kernel_methods = Kernel.instance_methods
-    T { kernel_methods.include? :debug }
-    T { kernel_methods.include? :trace }
-    T { kernel_methods.include? :time }
-  end
-  D "debug" do
-    debug "abc123"
-    T :debuglog, /abc123/, "debug.log"
-    debug -189
-    T :debuglog, /-189/, "debug.log"
-    D "multiple arguments" do
-      x = 5
-      debug "The value of x is ", x, "!"
-      T :debuglog, /The value of x is 5!/, "debug.log"
-    end
-    D "multi-line text" do
-      text = "I must go down to the seas again\nTo the lonely sea and the sky\nAnd all I want is a tall ship\nAnd a star to steer her by\n     -- John Masefield"
-      debug text
-      log_text_lines = File.read("debug.log").split("\n").last(5)
-      # The text in the log file should be indented to look good.
-      Mt log_text_lines.shift, /\[\d\d\.\d\] I must go down to the seas again$/
-      Eq log_text_lines.shift, "       To the lonely sea and the sky"
-      Eq log_text_lines.shift, "       And all I want is a tall ship"
-      Eq log_text_lines.shift, "       And a star to steer her by"
-      Eq log_text_lines.shift, "            -- John Masefield"
-    end
-  end
-  D "trace" do
-    D "array" do
-      foo = [1,2,3]
-      trace :foo, binding
-      T :debuglog, /foo == \[1, 2, 3\]/, "debug.log"
-    end
-    D "string" do
-      str = "blah"
-      trace :str, binding
-      T :debuglog, /str == "blah"/, "debug.log"
-    end
-    D "truncate output" do
-      str = "x" * 100
-      trace :str, binding, 30
-      T :debuglog, /str == "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx\.\.\./, "debug.log"
-    end
-    D "different formats" do
-      # not really interested in this feature at the moment
-    end
-  end
-  D "time" do
-    time('sum to 10') { 1+2+3+4+5+6+7+8+9+10 }
-    T :debuglog, /sum to 10: .* sec/, "debug.log"
-    D "return value of block is accessible" do
-      sum = time('sum') { 1 + 1 }
-      Eq sum, 2
-    end
-  end
-end
+D "Debuglog auto configuration" do
+
+  D.<< {
+    DebugLog.send :wipe_slate_clean_for_testing
+    DebugLog.autoconfigure
+  }
+
+  D "Debuglog and DebugLog are the same thing" do
+    Id Debuglog, DebugLog
+  end
+
+  D "Methods are defined in Kernel" do
+    kernel_methods = Kernel.instance_methods
+    T { kernel_methods.include? :debug }
+    T { kernel_methods.include? :trace }
+    T { kernel_methods.include? :time }
+  end
+
+  D "debug" do
+    debug "abc123"
+    T :debuglog, /abc123/, "debug.log"
+    debug -189
+    T :debuglog, /-189/, "debug.log"
+    D "multiple arguments" do
+      x = 5
+      debug "The value of x is ", x, "!"
+      T :debuglog, /The value of x is 5!/, "debug.log"
+    end
+    D "multi-line text" do
+      text = "I must go down to the seas again\nTo the lonely sea and the sky\nAnd all I want is a tall ship\nAnd a star to steer her by\n     -- John Masefield"
+      debug text
+      log_text_lines = File.read("debug.log").split("\n").last(5)
+      # The text in the log file should be indented to look good.
+      Mt log_text_lines.shift, /\[\d\d\.\d\] I must go down to the seas again$/
+      Eq log_text_lines.shift, "       To the lonely sea and the sky"
+      Eq log_text_lines.shift, "       And all I want is a tall ship"
+      Eq log_text_lines.shift, "       And a star to steer her by"
+      Eq log_text_lines.shift, "            -- John Masefield"
+    end
+  end
+
+  D "trace" do
+    D "array" do
+      foo = [1,2,3]
+      trace :foo, binding
+      T :debuglog, /foo == \[1, 2, 3\]/, "debug.log"
+    end
+    D "string" do
+      str = "blah"
+      trace :str, binding
+      T :debuglog, /str == "blah"/, "debug.log"
+    end
+    D "truncate output" do
+      D "output that is too long" do
+        str = "x" * 100
+        trace :str, binding, 30
+        T :debuglog, /str == "xxxxxxxxxxxxxxxxxxxxxxxxxxxxx\.\.\./, "debug.log"
+      end
+      D "output that is not too long" do
+        str = "x" * 10
+        trace :str, binding, 30
+        T :debuglog, /str == "xxxxxxxxxx"$/, "debug.log"
+      end
+    end
+    D "different formats" do
+      # not really interested in this feature at the moment
+    end
+  end
+
+  D "time" do
+    time('sum to 10') { 1+2+3+4+5+6+7+8+9+10 }
+    T :debuglog, /sum to 10: .* sec/, "debug.log"
+    D "return value of block is accessible" do
+      sum = time('sum') { 1 + 1 }
+      Eq sum, 2
+    end
+  end
+
+end

data/test/debuglog-manual-1.rb

@@ -1,39 +1,41 @@
-D "DebugLog manual configuration (successful)" do
-  D.< { DebugLog.send :wipe_slate_clean_for_testing }
-
-  D ":debug => :my_debug, :filename => 'xyz.txt'" do
-    Debuglog.configure(:debug => :my_debug, :filename => 'xyz.txt')
-    D "my_debug method works" do
-      my_debug "abc123"
-      T :debuglog, /abc123/, "xyz.txt"
-    end
-    D "debug, trace and time methods are not defined" do
-      E(NoMethodError) { debug "abc123" }
-      E(NoMethodError) { trace :x, binding }
-      E(NoMethodError) { time('task') { :foo } }
-    end
-  end
-
-  D ":trace => :my_trace, :time => :my_time" do
-    Debuglog.configure(:trace => :my_trace, :time => :my_time)
-    D "my_trace and my_time methods work" do
-      foo = :chorus
-      my_trace "foo", binding
-      xT :debuglog, /foo == :chorus/, "debug.log"
-      my_time('blah') { :dotdotdot }
-      T :debuglog, /blah: .* sec/, "debug.log"
-    end
-    D "debug method not defined" do
-      E(NoMethodError) { debug "..." }
-    end
-  end
-
-  D "empty configuration" do
-    Debuglog.configure({})
-    D "debug, trace and time methods don't work" do
-      E(NoMethodError) { debug "abc123" }
-      E(NoMethodError) { trace :x, binding }
-      E(NoMethodError) { time('task') { :foo } }
-    end
-  end
-end
+D "DebugLog manual configuration (successful)" do
+
+  D.< { DebugLog.send :wipe_slate_clean_for_testing }
+
+  D ":debug => :my_debug, :filename => 'xyz.txt'" do
+    Debuglog.configure(:debug => :my_debug, :filename => 'xyz.txt')
+    D "my_debug method works" do
+      my_debug "abc123"
+      T :debuglog, /abc123/, "xyz.txt"
+    end
+    D "debug, trace and time methods are not defined" do
+      E(NoMethodError) { debug "abc123" }
+      E(NoMethodError) { trace :x, binding }
+      E(NoMethodError) { time('task') { :foo } }
+    end
+  end
+
+  D ":trace => :my_trace, :time => :my_time" do
+    Debuglog.configure(:trace => :my_trace, :time => :my_time)
+    D "my_trace and my_time methods work" do
+      foo = :chorus
+      my_trace "foo", binding
+      xT :debuglog, /foo == :chorus/, "debug.log"
+      my_time('blah') { :dotdotdot }
+      T :debuglog, /blah: .* sec/, "debug.log"
+    end
+    D "debug method not defined" do
+      E(NoMethodError) { debug "..." }
+    end
+  end
+
+  D "empty configuration" do
+    Debuglog.configure({})
+    D "debug, trace and time methods don't work" do
+      E(NoMethodError) { debug "abc123" }
+      E(NoMethodError) { trace :x, binding }
+      E(NoMethodError) { time('task') { :foo } }
+    end
+  end
+
+end

data/test/debuglog-manual-2.rb

@@ -1,27 +1,29 @@
-D "DebugLog manual configuration (unsuccessful)" do
-  D.< { DebugLog.send :wipe_slate_clean_for_testing }
-
-  D "clash with existing :debug method" do
-    def Kernel.debug() :foo end
-    E(DebugLog::Error) { DebugLog.autoconfigure }
-  end
-
-  D "clash with custom methods" do
-    def Kernel.my_debug() :foo end
-    def Kernel.my_trace() :foo end
-    def Kernel.my_time()  :foo end
-    E(DebugLog::Error) { DebugLog.configure(:debug => :my_debug) }
-    E(DebugLog::Error) { DebugLog.configure(:trace => :my_trace) }
-    E(DebugLog::Error) { DebugLog.configure(:time  => :my_time)  }
-  end
-
-  D "calling methods without having configured -> error" do
-    # At this point DebugLog is not configured.
-    E(NameError) { debug }
-    E(DebugLog::Error) { DebugLog.call_method(:debug, "...") }
-  end
-
-  D "specifying unwritable log file -> error" do
-    E(DebugLog::Error) { DebugLog.configure(:filename => '/fodsfw/fgsg/e/debug.log') }
-  end
-end
+D "DebugLog manual configuration (unsuccessful)" do
+
+  D.< { DebugLog.send :wipe_slate_clean_for_testing }
+
+  D "clash with existing :debug method" do
+    def Kernel.debug() :foo end
+    E(DebugLog::Error) { DebugLog.autoconfigure }
+  end
+
+  D "clash with custom methods" do
+    def Kernel.my_debug() :foo end
+    def Kernel.my_trace() :foo end
+    def Kernel.my_time()  :foo end
+    E(DebugLog::Error) { DebugLog.configure(:debug => :my_debug) }
+    E(DebugLog::Error) { DebugLog.configure(:trace => :my_trace) }
+    E(DebugLog::Error) { DebugLog.configure(:time  => :my_time)  }
+  end
+
+  D "calling methods without having configured -> error" do
+    # At this point DebugLog is not configured.
+    E(NameError) { debug }
+    E(DebugLog::Error) { DebugLog.call_method(:debug, "...") }
+  end
+
+  D "specifying unwritable log file -> error" do
+    E(DebugLog::Error) { DebugLog.configure(:filename => '/fodsfw/fgsg/e/debug.log') }
+  end
+
+end

metadata

@@ -1,75 +1,92 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: debuglog
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Gavin Sinclair
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-12 00:00:00 +11:00
-default_executable: 
-dependencies: []
-
-description: "    require 'debuglog' and record debugging information (including variable traces\n    and timing information) to the file debug.log -- cheap and easy.\n"
-email: gsinclair@gmail.com
+date: 2012-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2169395720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169395720
+- !ruby/object:Gem::Dependency
+  name: whitestone
+  requirement: &2169395240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2169395240
+description: ! "    require 'debuglog' and record debugging information (including
+  variable traces\n    and timing information) to the file debug.log -- cheap and
+  easy.\n"
+email:
+- gsinclair@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- .gitignore
+- Gemfile
+- History.txt
+- LICENCE
+- README.txt
+- Rakefile
+- TODO.txt
+- debuglog.gemspec
+- doc/debuglog.markdown
+- etc/example.rb
+- lib/debuglog.rb
 - lib/debuglog/auto.rb
 - lib/debuglog/manual.rb
-- lib/debuglog.rb
-- README
+- lib/debuglog/version.rb
 - test/_setup.rb
 - test/debuglog-auto.rb
 - test/debuglog-manual-1.rb
 - test/debuglog-manual-2.rb
-- doc/debuglog.markdown
-has_rdoc: true
 homepage: http://gsinclair.github.com/debuglog.html
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: ''
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Zero-conf debug.log file with 'debug', 'trace' and 'time' methods
-test_files: 
+test_files:
 - test/_setup.rb
 - test/debuglog-auto.rb
 - test/debuglog-manual-1.rb
 - test/debuglog-manual-2.rb
+has_rdoc: false

data/README

@@ -1,38 +0,0 @@
-debuglog: zero-conf debug.log file for simple and hassle-free debugging
-
-Synopsis
-
-    Debuglog gives you debug, trace and time  methods that write their output to
-    the file ./debug.log.
-
-        require 'debuglog'     # or require 'debuglog/auto'
-
-        debug "Message..."
-        trace :x, binding
-        time('Task') { action }
-
-    You can change the names of the methods and the filename.
-
-        require 'debuglog/manual'
-
-        DebugLog.configure(
-          :debug => :my_debug,
-          :trace => :my_trace,
-          :time  => :my_time,
-          :filename => 'log/xyz.log'
-        )
-
-        my_debug "Message..."
-        my_trace :x, binding
-        my_time('Task') { action }
-
-    In either case, the log file will look something like this:
-
-    DebugLog -- 2010-07-25 18:58:22 +1000
-    -------------------------------------
-    [00.3] Message...
-    [00.5] x == 5
-    [00.6] Task: 1.0831 sec
-
-
-See http://gsinclair.github.com/debuglog.html for full details.