README.rdoc @@ -8,3 +8,5 @@ public/system coverage/* rdoc/ tags +.yardoc +doc .gitignore @@ -12,15 +12,6 @@ Rake::TestTask.new(:test) do |t| t.verbose = true end -desc 'Generate documentation for the hoptoad_notifier plugin.' -Rake::RDocTask.new(:rdoc) do |rdoc| - rdoc.rdoc_dir = 'rdoc' - rdoc.title = 'HoptoadNotifier' - rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README') - rdoc.rdoc_files.include('lib/**/*.rb') -end - desc 'Run ginger tests' task :ginger do $LOAD_PATH << File.join(*%w[vendor ginger lib]) @@ -28,3 +19,10 @@ task :ginger do ARGV << 'test' load File.join(*%w[vendor ginger bin ginger]) end + +begin + require 'yard' + YARD::Rake::YardocTask.new do |t| + end +rescue LoadError +end Rakefile @@ -20,40 +20,42 @@ module HoptoadNotifier } class << self - # (Internal) # The sender object is responsible for delivering formatted data to the Hoptoad server. # Must respond to #send_to_hoptoad. See HoptoadNotifier::Sender. attr_accessor :sender - # (Internal) # A Hoptoad configuration object. Must act like a hash and return sensible - # values for all Hoptoad configuration options. See - # HoptoadNotifier::Configuration. + # values for all Hoptoad configuration options. See HoptoadNotifier::Configuration. attr_accessor :configuration + # Tell the log that the Notifier is good to go def report_ready write_verbose_log("Notifier #{VERSION} ready to catch errors") end + # Prints out the environment info to the log for debugging help def report_environment_info write_verbose_log("Environment Info: #{environment_info}") end + # Prints out the response body from Hoptoad for debugging help def report_response_body(response) write_verbose_log("Response from Hoptoad: \n#{response}") end + # Returns the Ruby version, Rails version, and current Rails environment def environment_info info = "[Ruby: #{RUBY_VERSION}]" info << " [Rails: #{::Rails::VERSION::STRING}]" if defined?(Rails) info << " [Env: #{configuration.environment_name}]" end + # Writes out the given message to the #logger def write_verbose_log(message) logger.info LOG_PREFIX + message if logger end - # Checking for the logger in hopes we can get rid of the ugly syntax someday + # Look for the Rails logger currently defined def logger if defined?(Rails.logger) Rails.logger @@ -63,11 +65,11 @@ module HoptoadNotifier end # Call this method to modify defaults in your initializers. - # - # HoptoadNotifier.configure do |config| - # config.api_key = '1234567890abcdef' - # config.secure = false - # end + # @example + # HoptoadNotifier.configure do |config| + # config.api_key = '1234567890abcdef' + # config.secure = false + # end def configure self.configuration ||= Configuration.new yield(configuration) @@ -78,17 +80,21 @@ module HoptoadNotifier # You can send an exception manually using this method, even when you are not in a # controller. You can pass an exception or a hash that contains the attributes that # would be sent to Hoptoad: - # * api_key: The API key for this project. The API key is a unique identifier that Hoptoad - # uses for identification. - # * error_message: The error returned by the exception (or the message you want to log). - # * backtrace: A backtrace, usually obtained with +caller+. - # * request: The controller's request object. - # * session: The contents of the user's session. - # * environment: ENV merged with the contents of the request's environment. + # + # @param [Exception] exception The exception you want to notify Hoptoad about. + # @param [Hash] opts Data that will be sent to Hoptoad. + # @option opts [String] :api_key The API key for this project. The API key is a unique identifier that Hoptoad uses for identification. + # @option opts [String] :error_message The error returned by the exception (or the message you want to log). + # @option opts [String] :backtrace A backtrace, usually obtained with +caller+. + # @option opts [String] :request The controller's request object. + # @option opts [String] :session The contents of the user's session. + # @option opts [String] :environment ENV merged with the contents of the request's environment. def notify(exception, opts = {}) send_notice(build_notice_for(exception, opts)) end + # Sends the notice unless it is one of the default ignored exceptions + # @see HoptoadNotifier.notify def notify_or_ignore(exception, opts = {}) notice = build_notice_for(exception, opts) send_notice(notice) unless notice.ignore? lib/hoptoad_notifier.rb README 72df7d6350e85998dc424131f137286538c77f66 Nick Quaranto nick@quaran.to http://github.com/thoughtbot/hoptoad_notifier/commit/090312cb318b4c7a35de4340e6fb5e844f573520 090312cb318b4c7a35de4340e6fb5e844f573520 2009-08-26T07:29:31-07:00 2009-08-20T13:55:14-07:00 Starting YARD'ing up the plugin ef3580895a5acbe30b890b27ac9bf9f4effc1254 Joe Ferris jferris@metaphor.local