structured_warnings 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+== 0.1.0 2008-02-21
+
+* 1 major enhancement:
+  * Initial release
+  * No documentation yet

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,32 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+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/version.rb
+lib/structured_warnings/warner.rb
+lib/structured_warnings/warning.rb
+lib/structured_warnings/warnings.rb
+log/debug.log
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_helper.rb
+test/test_structured_warnings.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,4 @@
+= Structured warnings 
+
+See the projects website on http://rug-b.rubyforge.org/structured_warnings or
+the inspiring article at http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'structured_warnings/version'
+
+AUTHOR = 'Gregor Schmidt'  # can also be an array of Authors
+EMAIL = "ruby@schmidtwisser.de"
+DESCRIPTION = "Provides structured warnings"
+GEM_NAME = 'structured_warnings' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rug-b' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org/#{GEM_NAME}"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = StructuredWarnings::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'structured_warnings documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'structured_warnings'

data/lib/structured_warnings.rb

@@ -0,0 +1,23 @@
+$:.unshift File.dirname(__FILE__)
+require "structured_warnings/dynamic"
+require "structured_warnings/kernel"
+require "structured_warnings/warner"
+require "structured_warnings/warning"
+
+module StructuredWarnings
+  def self.init
+    Object.send(:include, Kernel)
+    unless Dynamic.variables.include?(:disabled_warnings)
+      Dynamic[:disabled_warnings] = []
+      Dynamic[:warner] = StructuredWarnings::Warner.new
+    end
+    init_test if defined? ::Test
+  end
+
+  def self.init_test
+    require "structured_warnings/test.rb"
+    ::Test::Unit::TestCase.send(:include, StructuredWarnings::Test::Assertions)
+  end
+end
+
+StructuredWarnings.init

data/lib/structured_warnings/dynamic.rb

@@ -0,0 +1,84 @@
+# 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 ContextR to 
+# store the current, thread-wide activated layers.
+#
+# For more information see the corresponding slides at
+# http://chneukirchen.org/talks/euruko-2005/chneukirchen-euruko2005-contextr.pdf
+#
+# (c) 2005 - Christian Neukirchen - http://chneukirchen.org
+module Dynamic
+  module ClassMethods #:nodoc:
+    Thread.main[:DYNAMIC] = Hash.new { |hash, key|
+      raise NameError, "no such dynamic variable: #{key}"
+    }
+
+    def here!
+      Thread.current[:DYNAMIC] = Hash.new { |hash, key|
+        raise NameError, "no such dynamic variable: #{key}"
+      }.update Thread.main[:DYNAMIC]
+    end
+
+    def variables
+      Thread.current[:DYNAMIC] or here!
+    end
+    
+    def variable(definition)
+      case definition
+      when Symbol
+        if variables.has_key? definition
+          raise NameError, "dynamic variable `#{definition}' already exists"
+        end
+        variables[definition] = nil
+      when Hash
+        definition.each { |key, value|
+          if variables.has_key? key
+            raise NameError, "dynamic variable `#{key}' already exists"
+          end
+          variables[key] = value
+        }
+      else
+        raise ArgumentError,
+        "can't create a new dynamic variable from #{definition.class}"
+      end
+    end
+    
+    def [](key)
+      variables[key]
+    end
+    
+    def []=(key, value)
+      variables[key] = value
+    end
+
+    def undefine(*keys)
+      keys.each { |key|
+        self[key]
+        variables.delete key
+      }
+    end
+
+    def let(bindings, &block)
+      save = {}
+      bindings.to_hash.collect { |key, value|
+        save[key] = self[key]
+        self[key] = value
+      }
+      block.call
+    ensure
+      variables.update save
+    end
+
+    def method_missing(name, *args)
+      if match = /=\Z/.match(name.to_s)    # setter?
+        raise ArgumentError, "invalid setter call"  unless args.size == 1
+        self[match.pre_match.intern] = args.first
+      else
+        raise ArgumentError, "invalid getter call"  unless args.empty?
+        self[name]
+      end
+    end
+  end
+  extend ClassMethods
+end

data/lib/structured_warnings/kernel.rb

@@ -0,0 +1,38 @@
+module StructuredWarnings
+  module Kernel
+    def warn(*args)
+      first = args.shift
+      if first.is_a? Class and first < Warning
+        warning = first 
+        message = args.shift
+
+      elsif first.is_a? Warning
+        warning = first.class
+        message = first.message
+
+      else
+        warning = Warning
+        message = first.to_s 
+      end
+
+      unless args.empty?
+        raise ArgumentError, 
+              "wrong number of arguments (#{args.size + 2} for 2)" 
+      end
+
+      if warning.active?
+        output = Kernel.warner.format(warning, message, caller[1..-1])
+        super(output) unless output.nil? or output.to_s.empty? 
+      end
+    end
+
+    def self.warner
+      Dynamic[:warner]
+    end
+
+  protected
+    def structured_warn(warning, message)
+      nil
+    end
+  end
+end

data/lib/structured_warnings/test.rb

@@ -0,0 +1,2 @@
+require "structured_warnings/test/warner.rb"
+require "structured_warnings/test/assertions.rb"

data/lib/structured_warnings/test/assertions.rb

@@ -0,0 +1,22 @@
+module StructuredWarnings
+  module Test
+    module Assertions
+      def assert_no_warn(warning = Warning)
+        w = StructuredWarnings::Test::Warner.new
+        Dynamic.let(:warner => w) do
+          yield
+        end
+        assert !w.warned?(warning), "#{warning} has been emitted."
+      end
+
+      def assert_warn(warning = Warning)
+        w = StructuredWarnings::Test::Warner.new
+        Dynamic.let(:warner => w) do
+          yield
+        end
+        assert w.warned?(warning), "#{warning} has not been emitted."
+      end
+    end
+  end
+end
+

data/lib/structured_warnings/test/warner.rb

@@ -0,0 +1,18 @@
+module StructuredWarnings
+  module Test
+    class Warner < StructuredWarnings::Warner
+      def format(warning, message, call_stack)
+        given_warnings << warning 
+        nil
+      end
+
+      def warned?(warning)
+        given_warnings.any? {|w| (w <= warning)}
+      end
+
+      def given_warnings
+        @given_warnings ||= []
+      end
+    end
+  end
+end

data/lib/structured_warnings/version.rb

@@ -0,0 +1,9 @@
+module StructuredWarnings #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/structured_warnings/warner.rb

@@ -0,0 +1,12 @@
+module StructuredWarnings
+  class Warner
+    def format(warning, message, stack)
+      "#{stack.shift} : #{message} (#{warning})"
+    end
+
+#    formats an exception like stack frame
+#    def collect_frame(stack)
+#      stack.collect { |frame| "        from #{frame}" }.join("\n")
+#    end
+  end
+end

data/lib/structured_warnings/warning.rb

@@ -0,0 +1,47 @@
+class Warning
+  attr_accessor :message
+
+  def initialize(message)
+    self.message = message
+  end
+
+  module ClassMethods
+    def active?
+      disabled_warnings.all? {|w| !(w >= self)}
+    end
+
+    def disable
+      if block_given?
+        Dynamic.let(:disabled_warnings => disabled_warnings + [self]) do
+          yield
+        end
+      else
+        self.disabled_warnings += [self]
+      end
+    end
+
+    def enable
+      if block_given?
+        Dynamic.let(:disabled_warnings => disabled_warnings - [self]) do
+          yield
+        end
+      else
+        self.disabled_warnings -= [self]
+      end
+    end
+
+  protected
+    def disabled_warnings
+      Dynamic[:disabled_warnings]
+    end
+    def disabled_warnings=(new)
+      Dynamic[:disabled_warnings] = new
+    end
+  end
+
+  extend ClassMethods
+end
+
+class DeprecationWarning < Warning; end
+class DeprecatedMethodWarning < DeprecationWarning; end
+class DeprecatedSignatureWarning < DeprecationWarning; end

data/lib/structured_warnings/warnings.rb

@@ -0,0 +1,3 @@
+class DeprecationWarning < Warning; end
+class DeprecatedMethodWarning < DeprecationWarning; end
+class DeprecatedSignatureWarning < DeprecationWarning; end