abrt 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,6 +1,32 @@
 = abrt
 
-Description goes here.
+Provides ABRT reporting support for libraries/applications written using Ruby.
+
+Please note that ABRT will be able to report errors only for applications which are already RPM packaged. Errors in other applications are ignored.
+
+== Installation
+
+<tt>
+$ gem install abrt
+</tt>
+
+or if you're using Bundler, put
+
+<tt>
+gem "mocha", :require => false
+</tt>
+
+line into your <em>Gemfile</em>.
+
+== Usage
+
+There are several ways how to run any application with ABRT handler enabled.
+
+1. Use <tt>require 'abrt'</tt> at the beginning of your application.
+2. If you can't modify the application and you still want to use ABRT support, then you need to define <tt>RUBYOPT="-rabrt"</tt> environment variable. This will ensure that ABRT support gets loaded and the exception handler hooks are installed.
+3. If you want to ensure, that ABRT handler is always used, add <tt>RUBYOPT="-rabrt"</tt> into your <em>.bashrc</em> file. This will ensure, that Ruby loads ABRT handler every time its starts.
+
+Now, everytime the unhandled exception is captured, ABRT handler prepares bugreport, which can be submitted into http://bugzilla.redhat.com component later using standard ABRT tools.
 
 == Contributing to abrt
  

data/lib/abrt.rb

@@ -1,5 +1,8 @@
 at_exit do
-  if $!
+  # Do not report every exception:
+  #   SystemExit - raised by Kernel#exit call
+  #   Interrupt - typically issued because the user pressed Ctrl+C
+  if $! and ![SystemExit, Interrupt].include?($!.class)
     require 'abrt/handler'
     ABRT.handle_exception($!)
   end

data/lib/abrt/exception.rb

@@ -1,9 +1,11 @@
+# This might be removed if http://bugs.ruby-lang.org/issues/6286 gets accepted.
+
 module ABRT
   module Exception
     def format
-      backtrace = self.backtrace.dup
-      backtrace[0] += ": #{self.message} (#{self.class.name})"
-      backtrace.join "\n\tfrom "
+      backtrace = self.backtrace.collect { |line| "\tfrom #{line}" }
+      backtrace[0] = "#{self.backtrace.first}: #{self.message} (#{self.class.name})"
+      backtrace
     end
   end
 end

data/lib/abrt/handler.rb

@@ -1,65 +1,68 @@
+require 'socket'
+require 'syslog'
+require 'abrt/exception.rb'
+
 module ABRT
 
   def self.handle_exception(exception)
-    last_exception = $!
-
     syslog.notice "detected unhandled Ruby exception in '#{$0}'"
 
-    require 'abrt/exception.rb'
-    last_exception.extend(ABRT::Exception)
+    exception.extend(ABRT::Exception)
 
     # TODO: Report only scripts with absolute path.
 
-    write_dump last_exception.format
+    write_dump exception.format
   end
 
 private
 
   def self.syslog
-    return @syslog if @syslog
-
-    require 'syslog'
-    @syslog = Syslog.open 'abrt'
+    @syslog ||= Syslog.open 'abrt'
   end
 
-  def self.write_dump(backtrace)
-    begin
-      require 'socket'
-
-      # TODO: Get var_run from ABRT configuration.
-      var_run = "/var/run"
-      socket = UNIXSocket.new "#{var_run}/abrt/abrt.socket"
-
-      socket.write "PUT / HTTP/1.1\r\n\r\n"
-      socket.write "PID=#{Process.pid}\0"
-      socket.write "EXECUTABLE=#{$PROGRAM_NAME}\0"
-      # TODO: Do we need specialized Ruby analyzer?
-      # socket.write "ANALYZER=Ruby\0"
-      socket.write "ANALYZER=Python\0"
-      socket.write "BASENAME=rbhook\0"
-      socket.write "REASON=#{backtrace.first}\0"
-      socket.write "BACKTRACE=#{backtrace}\0"
-      socket.close_write
+  def self.report(backtrace, io = abrt_socket)
+    io.write "PUT / HTTP/1.1\r\n\r\n"
+    io.write "PID=#{Process.pid}\0"
+    io.write "EXECUTABLE=#{$PROGRAM_NAME}\0"
+    # TODO: Do we need specialized Ruby analyzer?
+    # io.write "ANALYZER=Ruby\0"
+    io.write "ANALYZER=Python\0"
+    io.write "BASENAME=rbhook\0"
+    io.write "REASON=#{backtrace.first}\0"
+    io.write "BACKTRACE=#{backtrace.join("\n")}\0"
+    io.close_write
 
-      response = socket.read
+    yield io.read
 
-      socket.close
+    io.close
+  rescue StandardError => e
+    syslog.err "can't communicate with ABRT daemon, is it running? #{e.message}"
+  end
 
-      parts = response.split
-      code = Integer(parts[1]) rescue false
-      if (parts.size < 2) or
-        (not parts[0] =~ %r{^HTTP/}) or
-        (not code) or
-        (code >= 400)
-      then
-        if response.empty?
-          syslog.err "error sending data to ABRT daemon. Empty response received"
-        else
+  def self.write_dump(backtrace)
+    report backtrace do |response|
+      if response.empty?
+        syslog.err "error sending data to ABRT daemon. Empty response received"
+      else
+        parts = response.split
+        code = Integer(parts[1]) rescue false
+        if (parts.size < 2) or
+          (not parts[0] =~ %r{^HTTP/}) or
+          (not code) or
+          (code >= 400)
+        then
           syslog.err "error sending data to ABRT daemon: #{response}"
         end
       end
-    rescue StandardError => e
-      syslog.err "can't communicate with ABRT daemon, is it running? #{e.message}"
     end
   end
+
+  # TODO: Get VAR_RUN from ABRT configuration.
+  VAR_RUN = '/var/run'
+  ABRT_SOCKET_PATH = File.join VAR_RUN, 'abrt/abrt.socket'
+
+  def self.abrt_socket
+    UNIXSocket.new ABRT_SOCKET_PATH
+  end
+
 end

metadata

@@ -1,48 +1,40 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: abrt
-version: !ruby/object:Gem::Version 
-  hash: 29
+version: !ruby/object:Gem::Version
+  version: 0.0.2
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
 platform: ruby
-authors: 
-- "V\xC3\xADt Ondruch"
+authors:
+- Vít Ondruch
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-04-16 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 47
-        segments: 
-        - 2
-        - 8
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.8.0
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
 description: Provides ABRT reporting support for applications written using Ruby.
 email: v.ondruch@tiscali.cz
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
@@ -50,37 +42,28 @@ files:
 - lib/abrt/handler.rb
 - lib/abrt.rb
 homepage: http://github.com/voxik/abrt-ruby
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ABRT support for Ruby MRI.
 test_files: []
-