structured_warnings 0.1.3 → 0.1.4

data/lib/structured_warnings.rb

@@ -1,14 +1,11 @@
-$:.unshift File.dirname(__FILE__)
-
 require "structured_warnings/dynamic"
 require "structured_warnings/kernel"
 require "structured_warnings/warner"
 require "structured_warnings/warning"
 
-
 module StructuredWarnings
-  # If you <code>require "test/unit"</code> after +structured_warnings+ you 
-  # have to <code>require "structured_warnings/test"</code> manually, 
+  # If you <code>require "test/unit"</code> after +structured_warnings+ you
+  # have to <code>require "structured_warnings/test"</code> manually,
   # otherwise the test extensions will be added automatically.
   module ClassMethods
     # Executes a block using the given warner. This may be used to suppress
@@ -28,14 +25,14 @@ module StructuredWarnings
     end
 
     #:stopdoc:
-    # Sets a new warner 
+    # Sets a new warner
     def warner=(new_warner)
       Dynamic[:warner] = new_warner
     end
 
     # returns an Array of all currently disabled warnings.
     #
-    # *Note*: Everyday users are supposed to use the methods in 
+    # *Note*: Everyday users are supposed to use the methods in
     # Warning::ClassMethods
     def disabled_warnings
       Dynamic[:disabled_warnings]
@@ -44,7 +41,7 @@ module StructuredWarnings
     # sets an array of all currently disabled warnings. It is expected that this
     # array consists only of the Warning class and its subclasses.
     #
-    # *Note*: Everyday users are supposed to use the methods in 
+    # *Note*: Everyday users are supposed to use the methods in
     # Warning::ClassMethods
     def disabled_warnings=(new_disabled_warnings)
       Dynamic[:disabled_warnings] = new_disabled_warnings
@@ -52,7 +49,7 @@ module StructuredWarnings
 
     # Executes a block with the given set of disabled instances.
     #
-    # *Note*: Everyday users are supposed to use the methods in 
+    # *Note*: Everyday users are supposed to use the methods in
     # Warning::ClassMethods
     def with_disabled_warnings(disabled_warnings)
       Dynamic.let(:disabled_warnings => disabled_warnings) do

data/lib/structured_warnings/dynamic.rb

@@ -1,8 +1,8 @@
-# This library was created by Christian Neukirchen in the context of 
+# This library was created by Christian Neukirchen in the context of
 # EuRuKo 2005 and is licensed under the same terms as Ruby.
 #
-# It provides dynamically scoped variables. It is used within 
-# +structured_warnings+ to store the current, thread-wide disabled warning 
+# It provides dynamically scoped variables. It is used within
+# +structured_warnings+ to store the current, thread-wide disabled warning
 # classes.
 #
 # For more information see the corresponding slides at
@@ -24,7 +24,7 @@ module Dynamic
     def variables
       Thread.current[:DYNAMIC] or here!
     end
-    
+
     def variable(definition)
       case definition
       when Symbol
@@ -44,11 +44,11 @@ module Dynamic
         "can't create a new dynamic variable from #{definition.class}"
       end
     end
-    
+
     def [](key)
       variables[key]
     end
-    
+
     def []=(key, value)
       variables[key] = value
     end

data/lib/structured_warnings/kernel.rb

@@ -8,13 +8,13 @@ module StructuredWarnings
     #   warn(warning_class, message)
     #   warn(warning_instance)
     #
-    # This method provides a +raise+-like interface. It extends the default 
+    # This method provides a +raise+-like interface. It extends the default
     # warn in ::Kernel to allow the use of structured warnings.
     #
     # Internally it uses the StructuredWarnings::warner to format a message
     # based on the given warning class, the message and a stack frame.
     # The return value is passed to super, which is likely the implementation
-    # in ::Kernel. That way, it is less likely, that structured_warnings 
+    # in ::Kernel. That way, it is less likely, that structured_warnings
     # interferes with other extensions.
     #
     # It the warner return nil or an empty string the underlying warn will not
@@ -28,7 +28,7 @@ module StructuredWarnings
     #   warn "This is an old-style warning" # This will emit a StandardWarning
     #
     #   class Foo
-    #     def bar 
+    #     def bar
     #       warn DeprecationWarning, "Never use bar again, use beer"
     #     end
     #     def beer
@@ -36,12 +36,12 @@ module StructuredWarnings
     #     end
     #   end
     #
-    #   warn Warning.new("The least specific warning you can get") 
+    #   warn Warning.new("The least specific warning you can get")
     #
     def warn(*args)
       first = args.shift
       if first.is_a? Class and first <= Warning
-        warning = first 
+        warning = first
         message = args.shift
 
       elsif first.is_a? Warning
@@ -50,17 +50,17 @@ module StructuredWarnings
 
       else
         warning = StandardWarning
-        message = first.to_s 
+        message = first.to_s
       end
 
       unless args.empty?
-        raise ArgumentError, 
-              "wrong number of arguments (#{args.size + 2} for 2)" 
+        raise ArgumentError,
+              "wrong number of arguments (#{args.size + 2} for 2)"
       end
 
       if warning.active?
         output = StructuredWarnings.warner.format(warning, message, caller(1))
-        super(output) unless output.nil? or output.to_s.empty? 
+        super(output) unless output.nil? or output.to_s.empty?
       end
     end
   end

data/lib/structured_warnings/test.rb

@@ -1,6 +1,5 @@
-require "structured_warnings"
-require "structured_warnings/test/warner.rb"
-require "structured_warnings/test/assertions.rb"
+require "structured_warnings/test/warner"
+require "structured_warnings/test/assertions"
 
 Test::Unit::TestCase.class_eval do
   include StructuredWarnings::Test::Assertions

data/lib/structured_warnings/test/assertions.rb

@@ -21,14 +21,18 @@ module StructuredWarnings
       #   assert_no_warn() { foo }                   # fails
       #
       # See assert_warn for more examples.
+      #
+      # *Note*: It is currently not possible to add a custom failure message.
       def assert_no_warn(*args)
         warning, message = parse_arguments(args)
 
         w = StructuredWarnings::Test::Warner.new
-        StructuredWarnings::with_warner(w) do 
+        StructuredWarnings::with_warner(w) do
           yield
         end
-        assert !w.warned?(warning, message), "#{warning} has been emitted."
+        assert_block("<#{args_inspect(args)}> has been emitted.") do
+          !w.warned?(warning, message)
+        end
       end
 
       # :call-seq:
@@ -45,9 +49,9 @@ module StructuredWarnings
       #   end
       #
       #   # passes
-      #   assert_warn(DeprecatedMethodWarning) { foo }      
-      #   assert_warn(DeprecationWarning) { foo }           
-      #   assert_warn() { foo }                             
+      #   assert_warn(DeprecatedMethodWarning) { foo }
+      #   assert_warn(DeprecationWarning) { foo }
+      #   assert_warn() { foo }
       #   assert_warn(Warning, "used foo, use bar instead") { foo }
       #   assert_warn(Warning, /use bar/) { foo }
       #   assert_warn(Warning.new("used foo, use bar instead")) { foo }
@@ -57,18 +61,22 @@ module StructuredWarnings
       #   assert_warn(Warning, /deprecated/) { foo }
       #   assert_warn(Warning.new) { foo }
       #
+      # *Note*: It is currently not possible to add a custom failure message.
       def assert_warn(*args)
         warning, message = parse_arguments(args)
 
         w = StructuredWarnings::Test::Warner.new
-        StructuredWarnings::with_warner(w) do 
+        StructuredWarnings::with_warner(w) do
           yield
         end
-        assert w.warned?(warning, message), "#{warning} has not been emitted."
+        assert_block("<#{args_inspect(args)}> has not been emitted.") do
+          w.warned?(warning, message)
+        end
       end
 
     private
       def parse_arguments(args)
+        args = args.clone
         first = args.shift
         if first.is_a? Class and first <= Warning
           warning = first
@@ -88,12 +96,16 @@ module StructuredWarnings
         end
 
         unless args.empty?
-          raise ArgumentError, 
-                "wrong number of arguments (#{args.size + 2} for 2)" 
+          raise ArgumentError,
+                "wrong number of arguments (#{args.size + 2} for 2)"
         end
 
         return warning, message
       end
+
+      def args_inspect(args)
+        args.map { |a| a.inspect }.join(", ")
+      end
     end
   end
 end

data/lib/structured_warnings/test/warner.rb

@@ -1,7 +1,7 @@
 module StructuredWarnings
   module Test
-    # This warner is used in Assertions#assert_warn and 
-    # Assertions#assert_no_warn blocks. It captures all warnings in format and 
+    # This warner is used in Assertions#assert_warn and
+    # Assertions#assert_no_warn blocks. It captures all warnings in format and
     # provides access to them using the warned? method.
     class Warner < StructuredWarnings::Warner
       # Overrides the public interface of StructuredWarnings::Warner. This

data/lib/structured_warnings/warner.rb

@@ -5,7 +5,7 @@ module StructuredWarnings
   # the place where the "thing that caused the warning" resides.
   class Warner
     #  Warner.new.format(DeprecationWarning, "more info..", caller)
-    #     # => "demo.rb:5 : more info.. (DeprecationWarning)" 
+    #     # => "demo.rb:5 : more info.. (DeprecationWarning)"
     def format(warning, message, stack)
       "#{stack.shift} : #{message} (#{warning})"
     end

data/lib/structured_warnings/warning.rb

@@ -1,9 +1,9 @@
-# Descendents of class Warning are used to  raise structured warnings. They 
+# Descendents of class Warning are used to  raise structured warnings. They
 # programmers to explicitly supress certain kinds of warnings and provide
 # additional information in contrast to the plain warn method. They
 # implement an Exception-like interface and carry information about the
-# warning -- its type (the warning's class name), an optional descriptive 
-# string, and optional traceback information. Programs may subclass Warning 
+# warning -- its type (the warning's class name), an optional descriptive
+# string, and optional traceback information. Programs may subclass Warning
 # to add additional information.
 #
 # Large portions of this class's documentation are taken from the Exception
@@ -18,7 +18,7 @@ class Warning
 
   # call-seq:
   #    warning.backtrace    => array
-  # 
+  #
   # Returns any backtrace associated with the warning. The backtrace
   # is an array of strings, each containing either ``filename:lineNo: in
   # `method''' or ``filename:lineNo.''
@@ -26,11 +26,11 @@ class Warning
     @backtrace
   end
 
-  # Sets the backtrace information associated with warning. The argument must 
-  # be an array of String objects in the format described in 
+  # Sets the backtrace information associated with warning. The argument must
+  # be an array of String objects in the format described in
   # Exception#backtrace.
   def set_backtrace(backtrace)
-    @backtrace = backtrace 
+    @backtrace = backtrace
   end
 
   # Returns warning's message (or the name of the warning if no message is set).
@@ -115,15 +115,15 @@ end
 # This warning is used when calling #Kernel.warn without arguments.
 class StandardWarning < Warning; end
 
-# This is a general warning used to mark certain actions as deprecated. We 
+# This is a general warning used to mark certain actions as deprecated. We
 # recommend to add a useful warning message, which alternative to use instead.
 class DeprecationWarning < Warning; end
 
-# This warning marks single methods as deprecated. We 
+# This warning marks single methods as deprecated. We
 # recommend to add a useful warning message, which alternative to use instead.
 class DeprecatedMethodWarning < DeprecationWarning; end
 
-# This warning marks the given parameters for a certain methods as 
-# deprecated. We recommend to add a useful warning message, which 
+# This warning marks the given parameters for a certain methods as
+# deprecated. We recommend to add a useful warning message, which
 # alternative to use instead.
 class DeprecatedSignatureWarning < DeprecationWarning; end

data/structured_warnings.gemspec

@@ -1,63 +1,20 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+require 'rubygems'
 
 Gem::Specification.new do |s|
-  s.name = %q{structured_warnings}
-  s.version = "0.1.3"
+  s.name       = 'structured_warnings'
+  s.version    = '0.1.4'
+  s.author     = 'Gregor Schmidt'
+  s.email      = 'ruby@schmidtwisser.de'
+  s.homepage   = 'http://github.com/schmidt/structured_warnings'
+  s.summary    = 'Provides structured warnings for Ruby, using an exception-like interface and hierarchy'
+  s.files      = Dir['**/*'].reject{ |f| f.include?('git') }
+  s.test_files = Dir['test/*.rb']
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Gregor Schmidt"]
-  s.date = %q{2009-11-28}
-  s.description = %q{This is an implementation of Daniel Berger's proposal of structured warnings for Ruby.}
-  s.email = %q{ruby@schmidtwisser.de}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "History.txt",
-     "License.txt",
-     "README.rdoc",
-     "Rakefile",
-     "lib/structured_warnings.rb",
-     "lib/structured_warnings/dynamic.rb",
-     "lib/structured_warnings/kernel.rb",
-     "lib/structured_warnings/test.rb",
-     "lib/structured_warnings/test/assertions.rb",
-     "lib/structured_warnings/test/warner.rb",
-     "lib/structured_warnings/warner.rb",
-     "lib/structured_warnings/warning.rb",
-     "structured_warnings.gemspec",
-     "test/structured_warnings_test.rb",
-     "test/test_helper.rb",
-     "version.yml"
-  ]
-  s.homepage = %q{http://github.com/schmidt/structured_warnings}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Provides structured warnings for Ruby, using an exception-like interface and hierarchy.}
-  s.test_files = [
-    "test/structured_warnings_test.rb",
-     "test/test_helper.rb"
-  ]
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.rdoc']
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rake>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 1.4.0"])
-    else
-      s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 1.4.0"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 1.4.0"])
-  end
+  s.description = %Q{
+    This is an implementation of Daniel Berger's proposal of structured
+    warnings for Ruby.
+  }
 end
-

data/test/structured_warnings_test.rb

@@ -1,15 +1,16 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+require 'test/unit'
+require 'structured_warnings'
 
 class Foo
   def old_method
-    warn DeprecatedMethodWarning, 
+    warn DeprecatedMethodWarning,
          'This method is deprecated. Use new_method instead'
   end
 end
 
 class StructuredWarningsTest < Test::Unit::TestCase
   def test_warn
-    assert_warn(DeprecatedMethodWarning) do 
+    assert_warn(DeprecatedMethodWarning) do
       Foo.new.old_method
     end
   end
@@ -125,8 +126,8 @@ class StructuredWarningsTest < Test::Unit::TestCase
   end
 
   def test_warnings_may_not_be_disabled_twice
-    assert [Warning], Warning.disable
-    assert [Warning], Warning.disable
-    assert [], Warning.enable
+    assert_equal [Warning], Warning.disable
+    assert_equal [Warning], Warning.disable
+    assert_equal [], Warning.enable
   end
 end

metadata

@@ -1,91 +1,114 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: structured_warnings
-version: !ruby/object:Gem::Version 
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Gregor Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-11-28 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rake
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: jeweler
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.4.0
-    version: 
-description: This is an implementation of Daniel Berger's proposal of structured warnings for Ruby.
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies: []
+description: ! "\n    This is an implementation of Daniel Berger's proposal of structured\n
+  \   warnings for Ruby.\n  "
 email: ruby@schmidtwisser.de
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
-- .gitignore
+files:
+- doc/created.rid
+- doc/DeprecatedMethodWarning.html
+- doc/DeprecatedSignatureWarning.html
+- doc/DeprecationWarning.html
+- doc/Dynamic.html
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_green.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/quicksearch.js
+- doc/js/thickbox-compressed.js
+- doc/lib/structured_warnings/dynamic_rb.html
+- doc/lib/structured_warnings/kernel_rb.html
+- doc/lib/structured_warnings/test/assertions_rb.html
+- doc/lib/structured_warnings/test/warner_rb.html
+- doc/lib/structured_warnings/test_rb.html
+- doc/lib/structured_warnings/warner_rb.html
+- doc/lib/structured_warnings/warning_rb.html
+- doc/lib/structured_warnings_rb.html
+- doc/Object.html
+- doc/rdoc.css
+- doc/README_rdoc.html
+- doc/StandardWarning.html
+- doc/StructuredWarnings/ClassMethods.html
+- doc/StructuredWarnings/Kernel.html
+- doc/StructuredWarnings/Test/Assertions.html
+- doc/StructuredWarnings/Test/Warner.html
+- doc/StructuredWarnings/Test.html
+- doc/StructuredWarnings/Warner.html
+- doc/StructuredWarnings.html
+- doc/Warning/ClassMethods.html
+- doc/Warning.html
 - History.txt
-- License.txt
-- README.rdoc
-- Rakefile
-- lib/structured_warnings.rb
 - lib/structured_warnings/dynamic.rb
 - lib/structured_warnings/kernel.rb
-- lib/structured_warnings/test.rb
 - lib/structured_warnings/test/assertions.rb
 - lib/structured_warnings/test/warner.rb
+- lib/structured_warnings/test.rb
 - lib/structured_warnings/warner.rb
 - lib/structured_warnings/warning.rb
+- lib/structured_warnings.rb
+- License.txt
+- Rakefile
+- README.rdoc
 - structured_warnings.gemspec
 - test/structured_warnings_test.rb
-- test/test_helper.rb
-- version.yml
-has_rdoc: true
 homepage: http://github.com/schmidt/structured_warnings
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Provides structured warnings for Ruby, using an exception-like interface and hierarchy.
-test_files: 
+summary: Provides structured warnings for Ruby, using an exception-like interface
+  and hierarchy
+test_files:
 - test/structured_warnings_test.rb
-- test/test_helper.rb