structured_warnings 0.1.3 → 0.1.4

data/History.txt

@@ -1,3 +1,8 @@
+== 0.1.4 2013-01-23
+* Reorganized Rakefile and tasks, removed Jeweler dependency.
+* Updated tests, fixed circular dependency error.
+* Removed version.yml.
+
 == 0.1.3 2009-11-28
 
 * major enhancements

data/License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2008 Gregor Schmidt 
+Copyright (c) 2008 Gregor Schmidt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,4 +1,4 @@
-= Structured Warnings 
+= Structured Warnings
 
 This is an implementation of Daniel Berger's {proposal of structured warnings
 for Ruby}[http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html]. They provide dynamic suppression and activation, as well as, an
@@ -7,14 +7,23 @@ inheritance hierarchy to model their relations. This library preserves the old
 use.
 
 For more information on the usage and benefits of this library have a look at
-the inspiring article at O'Reilly. 
+the inspiring article at O'Reilly.
 
 http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html
 
-== Installation
+== Installation & Compatibility
 
   gem install structured_warnings
 
+structured_warnings works with all interpreters, it was tested with.
+
+* Ruby 1.8.5 and later
+* Ruby 1.9.1 and later
+* JRuby 1.x
+
+Please let me know, of any other compatibilities or file a bug for any
+incompatibilities.
+
 == Example Usage
 
 To get you started - here is a short example
@@ -51,9 +60,9 @@ may add your own types by subclassing Warning if you like.
 Client code of your library will look as follows:
 
   require "foo"
-  
+
   foo = Foo.new
-  foo.old_method # => will print 
+  foo.old_method # => will print
                  # ... `old_method' : This method is deprecated. Use new_method instead (DeprecatedMethodWarning)
 
 But the main difference to the standard warning concept shipped with ruby, is
@@ -61,9 +70,9 @@ that the client is able to selectively disable certain warnings s/he is aware
 of and not willing to fix.
 
   DeprecatedMethodWarning.disable # Globally disable warnings about deprecated methods!
-  
+
   foo.old_method # => will print nothing
-  
+
   DeprecatedMethodWarning.enable # Reenable warnings again.
 
 And there is an even more powerful option for your clients, the can selectively
@@ -81,7 +90,7 @@ block scope) and automatically reset after the block.
 
 == Detailed Documentation
 
-Have closer look at the RDoc of StructuredWarnings::Kernel, Warning and 
+Have closer look at the RDoc of StructuredWarnings::Kernel, Warning and
 Warning::ClassMethods.
 
 Part of this library is a set of different warnings:
@@ -98,8 +107,8 @@ feedback to your users as possible.
 
 == Resources
 
-* {Initial announcement}[http://www.nach-vorne.de/2008/2/21/ann-structured_warnings-0-1-0-released]
 * {Inspiring article}[http://www.oreillynet.com/ruby/blog/2008/02/structured_warnings_now.html]
+* {Implementation Highlights}[http://www.nach-vorne.de/2008/2/22/structured_warnings-highlights]
 * {Project's website}[http://github.com/schmidt/structured_warnings/]
 * {API doc}[http://rdoc.info/projects/schmidt/structured_warnings]
 * {Build Status on RunCodeRun}[http://runcoderun.com/schmidt/structured_warnings]
@@ -116,13 +125,13 @@ Bug reports or general feature requests should be added using GitHub Issues.
 
 == Known Issues
 
-Although the library transparently coorperates with Ruby's built-in 
+Although the library transparently coorperates with Ruby's built-in
 <code>Kernel#warn</code>, it may not override +rb_warn+ which is used internally to emit
 "method redefined", "void context", and "parenthesis" warnings. They may not be
 manipulated by structured_warnings.
 
 == License
 
-This code is free to use under the terms of the MIT license. 
+This code is free to use under the terms of the MIT license.
 
   :include: License.txt

data/Rakefile

@@ -1,38 +1,55 @@
 require 'rake'
-require 'rake/rdoctask'
+require 'rake/clean'
+require 'rake/testtask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "structured_warnings"
-    gemspec.summary = "Provides structured warnings for Ruby, using an exception-like interface and hierarchy."
-    gemspec.description = "This is an implementation of Daniel Berger's proposal of structured warnings for Ruby."
-    gemspec.email = "ruby@schmidtwisser.de"
-    gemspec.homepage = "http://github.com/schmidt/structured_warnings"
-    gemspec.authors = ["Gregor Schmidt"]
-
-    gemspec.add_development_dependency('rake')
-    gemspec.add_development_dependency('jeweler', '>= 1.4.0')
-  end
+CLEAN.include('**/*.gem', '**/*.rbx', '**/*.rbc')
 
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
+namespace :gem do
+  desc "Create the structured_warnings gem"
+  task :create => [:clean] do
+    spec = eval(IO.read('structured_warnings.gemspec'))
+    Gem::Builder.new(spec).build
+  end
 
-desc "Run all tests"
-task :test do 
-  require 'rake/runtest'
-  Rake.run_tests 'test/**/*_test.rb'
+  desc "Install the structured_warnings gem"
+  task :install => [:create] do
+    file = Dir['*.gem'].first
+    sh "gem install #{file}"
+  end
 end
 
-desc 'Generate documentation for the structured_warnings gem.'
-Rake::RDocTask.new(:doc) do |doc|
-  doc.rdoc_dir = 'doc'
-  doc.title = 'structured_warnings'
-  doc.options << '--line-numbers' << '--inline-source'
-  doc.rdoc_files.include('README.rdoc')
-  doc.rdoc_files.include('lib/**/*.rb')
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.warning = true
+  t.test_files = Dir['test/*.rb']
 end
 
 task :default => :test
+
+
+
+begin
+  require 'rdoc/task'
+  Rake::RDocTask.new(:doc) do |doc|
+    doc.rdoc_dir = 'doc'
+    doc.title = 'structured_warnings'
+    doc.options << '--line-numbers' << '--inline-source'
+    doc.rdoc_files.include('README.rdoc')
+    doc.rdoc_files.include('lib/**/*.rb')
+  end
+
+rescue LoadError
+  desc 'Remove RDoc HTML files'
+  task :clobber_doc => :rdoc_warning
+
+  desc 'Build RDoc HTML files'
+  task :doc => :rdoc_warning
+
+  desc 'Rebuild RDoc HTML files'
+  task :redoc => :rdoc_warning
+
+  task :rdoc_warning do
+    puts "To run the rdoc task, you need to install the rdoc gem"
+    puts "  gem install rdoc"
+  end
+end

data/doc/DeprecatedMethodWarning.html

@@ -0,0 +1,170 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Class: DeprecatedMethodWarning</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/structured_warnings/warning_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/structured_warnings/warning.rb">lib/structured_warnings/warning.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link"><a href="DeprecationWarning.html">DeprecationWarning</a></p>
+        
+      </div>
+      
+
+      
+
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./StructuredWarnings.html">StructuredWarnings</a></li>
+        
+          <li><a href="./StructuredWarnings/ClassMethods.html">StructuredWarnings::ClassMethods</a></li>
+        
+          <li><a href="./StructuredWarnings/Kernel.html">StructuredWarnings::Kernel</a></li>
+        
+          <li><a href="./StructuredWarnings/Test.html">StructuredWarnings::Test</a></li>
+        
+          <li><a href="./StructuredWarnings/Test/Assertions.html">StructuredWarnings::Test::Assertions</a></li>
+        
+          <li><a href="./StructuredWarnings/Test/Warner.html">StructuredWarnings::Test::Warner</a></li>
+        
+          <li><a href="./StructuredWarnings/Warner.html">StructuredWarnings::Warner</a></li>
+        
+          <li><a href="./Warning.html">Warning</a></li>
+        
+          <li><a href="./Warning/ClassMethods.html">Warning::ClassMethods</a></li>
+        
+          <li><a href="./DeprecatedMethodWarning.html">DeprecatedMethodWarning</a></li>
+        
+          <li><a href="./DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></li>
+        
+          <li><a href="./DeprecationWarning.html">DeprecationWarning</a></li>
+        
+          <li><a href="./Dynamic.html">Dynamic</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+          <li><a href="./StandardWarning.html">StandardWarning</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">DeprecatedMethodWarning</h1>
+
+    <div id="description" class="description">
+      
+<p>This warning marks single methods as deprecated. We recommend to add a
+useful warning message, which alternative to use instead.</p>
+
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/doc/DeprecatedSignatureWarning.html

@@ -0,0 +1,171 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Class: DeprecatedSignatureWarning</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="class">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/structured_warnings/warning_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/structured_warnings/warning.rb">lib/structured_warnings/warning.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+      <!-- Parent Class -->
+      <div id="parent-class-section" class="section">
+        <h3 class="section-header">Parent</h3>
+        
+        <p class="link"><a href="DeprecationWarning.html">DeprecationWarning</a></p>
+        
+      </div>
+      
+
+      
+
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+        
+          <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
+        
+        </ul>
+      </div>
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./StructuredWarnings.html">StructuredWarnings</a></li>
+        
+          <li><a href="./StructuredWarnings/ClassMethods.html">StructuredWarnings::ClassMethods</a></li>
+        
+          <li><a href="./StructuredWarnings/Kernel.html">StructuredWarnings::Kernel</a></li>
+        
+          <li><a href="./StructuredWarnings/Test.html">StructuredWarnings::Test</a></li>
+        
+          <li><a href="./StructuredWarnings/Test/Assertions.html">StructuredWarnings::Test::Assertions</a></li>
+        
+          <li><a href="./StructuredWarnings/Test/Warner.html">StructuredWarnings::Test::Warner</a></li>
+        
+          <li><a href="./StructuredWarnings/Warner.html">StructuredWarnings::Warner</a></li>
+        
+          <li><a href="./Warning.html">Warning</a></li>
+        
+          <li><a href="./Warning/ClassMethods.html">Warning::ClassMethods</a></li>
+        
+          <li><a href="./DeprecatedMethodWarning.html">DeprecatedMethodWarning</a></li>
+        
+          <li><a href="./DeprecatedSignatureWarning.html">DeprecatedSignatureWarning</a></li>
+        
+          <li><a href="./DeprecationWarning.html">DeprecationWarning</a></li>
+        
+          <li><a href="./Dynamic.html">Dynamic</a></li>
+        
+          <li><a href="./Object.html">Object</a></li>
+        
+          <li><a href="./StandardWarning.html">StandardWarning</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="class">DeprecatedSignatureWarning</h1>
+
+    <div id="description" class="description">
+      
+<p>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.</p>
+
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+