structured_warnings 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82e448e3265ea35dd71196fb6f3adbc6b629cbb5
-  data.tar.gz: 5ed838c91e79e3d459f10d2cb9c7b596f03b5d98
+SHA256:
+  metadata.gz: a8774c997cadba9d8da089be20d8486231f1b3719cdd0aa3c316950d3e7b8000
+  data.tar.gz: 4fe13678cdbc0151442e8777822090d94204348efa25c479881b5796dff9d0d0
 SHA512:
-  metadata.gz: c784e0acb8c6aa8840ba44a36f5fdd090d7a46d178b4701fc97f1c6203d0f0de41f8d90a8579a53a7064a4df9146a314a936b6c6d290c892d3022840bce58282
-  data.tar.gz: f816ed5e9f249359c9c8108ba65c978140f9c2cef49f7d70202b26537ba4ced18ad1699c76ee9954ea8771bde64da59e98a08f34deee41766b06f76328a836df
+  metadata.gz: 51311c54bb3fe552f48d3b5def0c61708da3051a1b76c3888987085531ad9b260dec4d4d3f6d563d9cb7fcf0f81f15044e8c61023331b41fc9471c6bfe91deb7
+  data.tar.gz: 734fa0958d804c8e7ea308c2a0f35b4c9899761e6552f203e51ad5091e6463bcb52bc519e6f0f9e0a93e894d21b6565a96f42e2d6df4e0214eb125ab81f4b0f0

data/README.md

@@ -1,9 +1,5 @@
 # StructuredWarnings
 
-> **Disclaimer:** This is an experimental reimplementation of structured
-> warnings, based on Ruby 2.4's new warning module. This is not yet ready for
-> prime time.
-
 This is an implementation of Daniel Berger's [proposal of structured warnings
 for Ruby](https://web.archive.org/web/20140328021259/http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html).
 They provide dynamic suppression and activation, as well as, an inheritance
@@ -37,24 +33,9 @@ Or install it yourself as:
 
 ## Compatibility
 
-`structured_warnings` aims to work with all Ruby interpreters. Please file a bug
-for any incompatibilities.
-
-
-Versions of `structured_warnings` before `v0.3.0` are incompatible with Ruby
-2.4+. Please upgrade accordingly, if you need Ruby 2.4 compatibility. Please
-note on the otherhand, that many class names changed in an incompatible way
-with `structured_warnings` `v0.3.0`. This was done to avoid future name clashes.
-
-Here's a table which should ease upgrading.
-
-| v0.2.0 and before            | v0.3.0 and after                                 |
-|------------------------------|--------------------------------------------------|
-| `Warning`                    | `StructuredWarnings::Base`                       |
-| `StandardWarning`            | `StructuredWarnings::StandardWarning`            |
-| `DeprecationWarning`         | `StructuredWarnings::DeprecationWarning`         |
-| `DeprecatedMethodWarning`    | `StructuredWarnings::DeprecatedMethodWarning`    |
-| `DeprecatedSignatureWarning` | `StructuredWarnings::DeprecatedSignatureWarning` |
+`structured_warnings` aims to work with all stable, maintained Ruby versions. At
+the time of this writing this is Ruby 3.2, 3.3, and 3.4. Please file a bug for
+any incompatibilities.
 
 
 ### Test framework support
@@ -173,7 +154,7 @@ give as much feedback to your users as possible.
 * [Implementation Highlights](http://www.nach-vorne.de/2008/2/22/structured_warnings-highlights)
 * [Project's website](https://github.com/schmidt/structured_warnings/)
 * [API doc](http://rdoc.info/projects/schmidt/structured_warnings)
-* [Build status](https://travis-ci.org/schmidt/structured_warnings)
+* [Build status](https://github.com/schmidt/structured_warnings/actions)
 
 
 ## Development

data/lib/structured_warnings/kernel.rb

@@ -1,6 +1,6 @@
 module StructuredWarnings::Kernel
-  def warn(*args)
-    Warning.warn(*args)
+  def warn(*args, **opts)
+    Warning.warn(*args, **opts)
   end
 end
 

data/lib/structured_warnings/test/warner.rb

@@ -5,7 +5,7 @@ class StructuredWarnings::Test::Warner < StructuredWarnings::Warner
   # Overrides the public interface of StructuredWarnings::Warner. This
   # method always returns nil to avoid warnings on stdout during assert_warn
   # and assert_no_warn blocks.
-  def format(warning, message, call_stack)
+  def format(warning, message, options, call_stack)
     given_warnings << warning.new(message)
     nil
   end

data/lib/structured_warnings/version.rb

@@ -1,3 +1,3 @@
 module StructuredWarnings
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/structured_warnings/warner.rb

@@ -5,11 +5,15 @@
 class StructuredWarnings::Warner
   #  Warner.new.format(StructuredWarning::DeprecationWarning, "more info..", caller)
   #     # => "demo.rb:5 : more info.. (StructuredWarning::DeprecationWarning)"
-  def format(warning, message, stack)
+  def format(warning, message, options, stack)
     frame = stack.shift
     # This file contains the backwards compatibility code for Ruby 2.3 and
     # lower, let's skip it
     frame = stack.shift if frame.include? 'lib/structured_warnings/kernel.rb'
-    "#{frame} : #{message} (#{warning})"
+
+    # Handle introduced uplevel introduced in Ruby 2.5
+    frame = stack.shift(options[:uplevel]).last if options[:uplevel]
+
+    "#{frame}: #{message} (#{warning})\n"
   end
 end

data/lib/structured_warnings/warning.rb

@@ -36,7 +36,7 @@ module StructuredWarnings::Warning
   #
   #   warn StructuredWarnings::Base.new("The least specific warning you can get")
   #
-  def warn(*args)
+  def warn(*args, **options)
     first = args.shift
     if first.is_a? Class and first <= StructuredWarnings::Base
       warning = first
@@ -46,14 +46,13 @@ module StructuredWarnings::Warning
       warning = first.class
       message = first.message
 
-    else
-      warning =
-        if caller.shift.include? 'lib/structured_warnings/kernel.rb'
-          StructuredWarnings::StandardWarning
-        else
-          StructuredWarnings::BuiltInWarning
-        end
+    elsif caller.shift.include? 'lib/structured_warnings/kernel.rb'
+      warning = StructuredWarnings::StandardWarning
       message = first.to_s
+
+    else
+      warning = StructuredWarnings::BuiltInWarning
+      message = first.to_s.split(':', 4).last.strip
     end
 
     # If args is not empty, user passed an incompatible set of arguments.
@@ -62,7 +61,7 @@ module StructuredWarnings::Warning
     return super unless args.empty?
 
     if warning.active?
-      output = StructuredWarnings.warner.format(warning, message, caller(1))
+      output = StructuredWarnings.warner.format(warning, message, options, caller(1))
       super(output) unless output.nil? or output.to_s.empty?
     end
   end

data/lib/structured_warnings.rb

@@ -1,8 +1,5 @@
 require 'structured_warnings/version'
 
-# Compatibility layer
-require 'warning' unless defined? ::Warning
-
 require 'dynamic'
 
 module StructuredWarnings

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: structured_warnings
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Gregor Schmidt
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-23 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.0'
 description: This is an implementation of Daniel Berger's proposal of structured warnings
   for Ruby.
 email:
@@ -87,12 +86,10 @@ files:
 - lib/structured_warnings/version.rb
 - lib/structured_warnings/warner.rb
 - lib/structured_warnings/warning.rb
-- lib/warning.rb
 homepage: http://github.com/schmidt/structured_warnings
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -100,16 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Provides structured warnings for Ruby, using an exception-like interface
   and hierarchy

data/lib/warning.rb

@@ -1,9 +0,0 @@
-module Warning
-  KERNEL_WARN = Kernel.instance_method(:warn).bind(self)
-
-  def warn(*args)
-    KERNEL_WARN.call(*args)
-  end
-
-  extend self
-end