warnings 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "Warnings Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,11 @@
+### 0.1.0 / 2011-06-24
+
+* Initial release:
+  * Respects `$VERBOSE` (`ruby -w`) and `$DEBUG` (`ruby -d`)
+  * Search Warning Messages by:
+    * Message
+    * Source File
+    * Source Method
+  * Prints unique Warning messages upon exit.
+  * ANSI Coloring.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hal Brodigan
+
+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/README.md

@@ -0,0 +1,59 @@
+# warnings
+
+* [Source](http://github.com/postmodern/warnings)
+* [Issues](http://github.com/postmodern/warnings/issues)
+* [Documentation](http://rubydoc.info/gems/warnings/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+Warnings provides a searchable and more readable Warning Message
+facility for Ruby. With Warnings, one can save all warning messages
+generated by your code, search through them and print them upon exit.
+
+## Features
+
+* Respects `$VERBOSE` (`ruby -w`) and `$DEBUG` (`ruby -d`)
+* Search Warning Messages by:
+  * Message
+  * Source File
+  * Source Method
+* Prints unique Warning messages upon exit.
+* ANSI Coloring.
+
+## Examples
+
+    require 'warnings'
+
+    def danger!
+      warn "Fire in the disco!"
+    end
+
+    danger!
+    danger!
+
+    Warnings.grep(/fire/)
+    # => [...]
+
+    Warnings.from('foo/bar.rb')
+    # => [...]
+
+    Warnings.from_method('danger!')
+    # => [...]
+
+    exit
+    #
+    # Warnings:
+    #
+    #   fire in the disco!
+    #      lib/foo/bar.rb:42
+
+## Install
+
+    $ gem install warnings
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.4'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.7.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end
+task :doc => :yard

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: warnings
+summary: Provides a better Warning Message facility for Ruby.
+description:
+  Warnings provides a searchable and more readable Warning Message
+  facility for Ruby. With Warnings, one can save all warning messages
+  generated by your code, search through them and print them upon exit.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/warnings
+
+development_dependencies:
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.7.0

data/lib/warnings.rb

@@ -0,0 +1,23 @@
+require 'warnings/version'
+require 'warnings/warnings'
+require 'warnings/mixin'
+
+include Warnings::Mixin
+
+at_exit do
+  if (!$WARNINGS.empty? && ($VERBOSE || $DEBUG))
+    $stderr.puts
+    $stderr.puts "Warnings:"
+    $stderr.puts
+
+    unique_warnings = {}
+
+    $WARNINGS.each do |warning|
+      unique_warnings[warning.source_location] ||= warning
+    end
+
+    unique_warnings.each_value { |warning| warning.print }
+
+    $stderr.puts
+  end
+end

data/lib/warnings/mixin.rb

@@ -0,0 +1,54 @@
+require 'warnings/warning'
+require 'warnings/warnings'
+
+module Warnings
+  module Mixin
+    #
+    # Enables or disables warnings.
+    #
+    # @param [Boolean] mode
+    #   Specifies whether warnings will be enabled or disabled.
+    #
+    # @return [Boolean]
+    #   Specifies whether warnings are enabled.
+    #
+    def warnings=(mode)
+      @warnings = mode
+    end
+
+    #
+    # Determines whether warnings are enabled.
+    #
+    # @return [Boolean]
+    #   Specifies whether warnings are enabled.
+    #
+    # @note
+    #   Enabling `$VERBOSE` (`ruby -w`) or `$DEBUG` (`ruby -d`) will
+    #   enable all warnings by default.
+    #
+    def warnings?
+      ($VERBOSE || $DEBUG) || (@warnings != false)
+    end
+
+    #
+    # Registers a warning.
+    #
+    # @param [String] message
+    #   The warning message.
+    #
+    # @example
+    #   warn "Foo#bar method will be removed in 1.0.0"
+    #
+    # @return [nil]
+    #
+    def warn(message)
+      if warnings?
+        super(message) if $DEBUG
+
+        $WARNINGS << Warning.new(message,caller)
+      end
+
+      return nil
+    end
+  end
+end

data/lib/warnings/version.rb

@@ -0,0 +1,4 @@
+module Warnings
+  # warnings version
+  VERSION = "0.1.0"
+end

data/lib/warnings/warning.rb

@@ -0,0 +1,165 @@
+module Warnings
+  class Warning
+
+    # The warning message
+    attr_reader :message
+
+    # The backtrace to the warning
+    #
+    # @return [Array<String>]
+    #   The raw backtrace.
+    #
+    attr_reader :backtrace
+
+    # The source location of the warning.
+    #
+    # @return [Array<path, line>]
+    #   The path and line number where the warning originated.
+    #
+    attr_reader :source_location
+
+    # The source method of the warning.
+    #
+    # @return [Symbol]
+    #   The method name.
+    #
+    attr_reader :source_method
+
+    #
+    # Creates a new warning.
+    #
+    # @param [String] message
+    #   The warning message.
+    #
+    # @param [Array<String>] backtrace
+    #   The backtrace of the warning.
+    #
+    def initialize(message,backtrace)
+      @message = message
+      @backtrace = backtrace
+
+      file, line, context = @backtrace.first.split(':',3)
+
+      @source_location = [file, line.to_i]
+      @source_method = context[5..-2] if context
+    end
+
+    #
+    # The source file of the warning.
+    #
+    # @return [String]
+    #   The path of the file.
+    #
+    def source_file
+      @source_location[0]
+    end
+
+    #
+    # The source line of the warning.
+    #
+    # @return [Integer]
+    #   The line-number of the warning.
+    #
+    def source_line
+      @source_location[1]
+    end
+
+    #
+    # Compares the warning message to a pattern.
+    #
+    # @param [Regexp] pattern
+    #   The pattern to match against.
+    #
+    # @return [Integer, nil]
+    #   The index of the pattern match within the warning message.
+    #
+    def =~(pattern)
+      @message =~ message
+    end
+
+    #
+    # Compares the warning to another warning.
+    #
+    # @param [Warning] other
+    #   The other warning to compare against.
+    #
+    # @return [Boolean]
+    #   Specifies whether the two warnings represent the same message.
+    #
+    def ==(other)
+      (@message == other.message) &&
+      (@source_location == other.source_location) &&
+      (@source_method == other.source_method)
+    end
+
+    #
+    # Compares the warning to another warning.
+    #
+    # @param [Warning] other
+    #   The other warning to compare against.
+    #
+    # @return [Boolean]
+    #   Specifies whether the two warnings represent the same message.
+    #
+    def ===(other)
+      case other
+      when Warning
+        self == other
+      when Regexp, String
+        !(@message.match(other).nil?)
+      else
+        false
+      end
+    end
+
+    #
+    # Converts the warning to a String.
+    #
+    # @return [String]
+    #   The warning message.
+    #
+    def to_s
+      @message.to_s
+    end
+
+    #
+    # Formats a warning.
+    #
+    # @return [String]
+    #   The printable warning.
+    #
+    # @note
+    #   Will include ANSI color codes, only if `STDOUT` is a TTY Terminal.
+    #
+    def print
+      trace = unless $DEBUG
+                @backtrace[0,5]
+              else
+                @backtrace
+              end
+
+      if $stderr.tty?
+        $stderr.puts "  \e[33m#{@message}:\e[0m"
+        trace.each { |line| $stderr.puts "\t\e[2m#{line}\e[0m" }
+      else
+        $stderr.puts "  #{@message}:"
+        trace.each { |line| $stderr.puts "\t#{line}" }
+      end
+    end
+
+    #
+    # Inspects the warning.
+    #
+    # @return [String]
+    #   The inspected {#source_file}, {#source_line} and {#message}.
+    #
+    def inspect
+      if @source_method
+        "#{source_file}:#{source_line} (#{@source_method}): #{@message}"
+      else
+        "#{source_file}:#{source_line}: #{@message}"
+      end
+    end
+
+  end
+end

data/lib/warnings/warnings.rb

@@ -0,0 +1,50 @@
+module Warnings
+  # The global list of warnings
+  $WARNINGS ||= []
+
+  #
+  # Selects all warnings with a similar message.
+  #
+  # @param [String, Regexp] pattern
+  #   The message pattern to search for.
+  #
+  # @return [Warning]
+  #   The warnings from the sub-path.
+  #
+  def self.grep(pattern)
+    $WARNINGS.select { |warning| warning.message.match(pattern) }
+  end
+
+  #
+  # Selects all warnings originating from a file.
+  #
+  # @param [String] path
+  #   The sub-path to search for.
+  #
+  # @return [Warning]
+  #   The warnings from the sub-path.
+  #
+  def self.from(path)
+    $WARNINGS.select { |warning| warning.source_file.include?(path) }
+  end
+
+  #
+  # Selects all warnings originating from a method.
+  #
+  # @param [Regexp, String] name
+  #   The method name or pattern to search for.
+  #
+  # @return [Warning]
+  #   The warnings from the specified method.
+  #
+  def self.from_method(name)
+    selector = case name
+              when Regexp
+                lambda { |warning| warning.source_method =~ name }
+              else
+                lambda { |warning| warning.source_method == name }
+              end
+
+    $WARNINGS.select(&selector)
+  end
+end

data/spec/mixin_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+require 'warnings/mixin'
+
+describe Warnings::Mixin do
+  subject { Object.new.extend(Warnings::Mixin) }
+
+  it "should allow adding warnings to $WARNINGS" do
+    subject.warn "test1"
+
+    $WARNINGS.last.message.should == "test1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'warnings/version'
+
+include Warnings

data/spec/warning_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'warnings/warning'
+
+describe Warnings::Warning do
+  let(:source_file) { 'foo/bar.rb' }
+  let(:source_line) { 42 }
+  let(:source_method) { 'baz' }
+
+  subject do
+    described_class.new("foo", ["#{source_file}:#{source_line}: in `#{source_method}'"])
+  end
+
+  describe "#initialize" do
+    it "should parse the source-file" do
+      subject.source_file.should be == source_file
+    end
+
+    it "should parse the source-line" do
+      subject.source_line.should be == source_line
+    end
+
+    it "should parse the source-method" do
+      subject.source_method.should be == source_method
+    end
+  end
+
+  it "should provide a source_location method" do
+    subject.source_location.should be == [source_file, source_line]
+  end
+
+  it "should provide a #to_s method" do
+    subject.to_s.should be == subject.message
+  end
+end

data/spec/warnings_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'warnings'
+
+describe Warnings do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+
+  it "should define a $WARNINGS global variable" do
+    $WARNINGS.should_not be_nil
+  end
+
+  it "should use an Array for $WARNINGS" do
+    $WARNINGS.should be_kind_of(Array)
+  end
+end

data/warnings.gemspec

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/warnings/version.rb',
+    :constant => 'Warnings::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: warnings
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.4"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.7.0
+  type: :development
+  version_requirements: *id003
+description: Warnings provides a searchable and more readable Warning Message facility for Ruby. With Warnings, one can save all warning messages generated by your code, search through them and print them upon exit.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/warnings.rb
+- lib/warnings/mixin.rb
+- lib/warnings/version.rb
+- lib/warnings/warning.rb
+- lib/warnings/warnings.rb
+- spec/mixin_spec.rb
+- spec/spec_helper.rb
+- spec/warning_spec.rb
+- spec/warnings_spec.rb
+- warnings.gemspec
+homepage: http://github.com/postmodern/warnings
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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: warnings
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Provides a better Warning Message facility for Ruby.
+test_files: 
+- spec/mixin_spec.rb
+- spec/warning_spec.rb
+- spec/warnings_spec.rb