logplexer 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 768e52baccfd7314fe57214c8a9f919410a22dc5
-  data.tar.gz: 6c48a6944d90e86d816d90f140bd593b5194636a
+  metadata.gz: bcc3206cf4af62b9dd0d52cd06b452bbc0ca550d
+  data.tar.gz: aef3f63f7b25ad59d5295a6605a8cdf2f7efe3b7
 SHA512:
-  metadata.gz: e5c738748eedfaaa3730a283366adab333aa86c2bd2aaae31ff2b4dc85a02dc8bfb0d2fb5ddfa5a4a8f56916a40d498d274ac90d92b96ddc96c37eab59ae300b
-  data.tar.gz: 91ef8277db934f6c6b9848d7c1c766e9594f34247824169b3ff6955be1466e87efc5443cdb40ba35abd3aa47d5d81fbded94ffb1a2ee9416bfb3524a2d0a91b1
+  metadata.gz: f416893ba08525785f5b347e71ab435668249c7e1edd4629027cb88399684487b393427f85c9834d210a250116d05583b5f68d85ef3b0b49d381ec5b48fbfd3a
+  data.tar.gz: 8ad20db7c3fea382781da6b4c73754dab3b701eb550b86c9e7ee953d0464a048ee65c58f9b8ca40f2d30d1521500a6b8392b1a684babcd3ffcc59091207cfee0

data/README.md

@@ -47,7 +47,7 @@ Inputs can be any type, `Exception`, `String`, `Hash`, etc.
 If you are in development and would like to log to a logfile, just specify a logfile in the opts argument like so:
 
 ```ruby
-> Logplexer.info( "Oh hai!", { logfile: '/Users/ryanc/Desktop/log.txt'} )
+> Logplexer.info( "Oh hai!", logfile: '/Users/ryanc/Desktop/log.txt' )
  => true
 ```
 
@@ -57,6 +57,14 @@ cat ~/Desktop/log.txt
 I, [2015-06-20T15:49:16.040351 #23538]  INFO -- : Oh hai!
 ```
 
+If you're using Rails, you can also specify the logger to be the Rails logger. In fact you can specify any class as the logger
+so long as the instance responds to all the message types: `debug`, `info`, `warn`, `error`, and `fatal` which all instances of
+`Logger` will.
+
+```ruby
+> Logplexer.error( "Log to Rails not STDOUT", logger: Rails.logger )
+```
+
 If you would like to see the whole backtrace, just set `verbose` to true like so:
 
 ```ruby
@@ -64,7 +72,7 @@ def method1
   begin
     raise "Holy errors Batman"
   rescue => e
-    Logplexer.error( e, { verbose: true} )
+    Logplexer.error( e, verbose: true )
   end
 end
 
@@ -86,38 +94,34 @@ E, [2015-06-21T16:04:59.248024 #25737] ERROR -- : > /Users/ryanc/Workspace/test_
 E, [2015-06-21T16:04:59.248041 #25737] ERROR -- : > /Users/ryanc/Workspace/test_logplexer/config/initializers/logplexer.rb:17:in `method3'
 ```
 
-Or if you are in developmet and would like to have all instances of Logplexer be verbose, just set the environment variable `LOG_VERBOSE` to "true" like so:
-
-    ENV["LOG_VERBOSE"] = "true"
-
-and everything that isn't specifically marked as `verbose: false` will print the backtrace. Keep in mind that verbose only works when the input is an Exception type.
-
-
-Likewise, if you are in development or test and would like to quiet all logs ( i.e. don't report any Logplexer errors ), just set `LOG_QUIET` to 'true':
-
-    ENV['LOG_QUIET'] = "true"
-
 ## Configuration
 
-If your `RAILS_ENV` is set to `development` or `test`, Logplexer will set an environment variable called `LOG_TO_HB` as "false" if it is anything else, i.e. `production` or `staging`, `LOG_TO_HB` will be set to "true".
+In most cases specifying logfile, logger, etc at the time of the logger call is fine, but I know there are many who need to fine tune their Logplexing capabilities. Logplexer exposes an array of configuration options that you can add to your `config/initializers/logplexer.rb` file.
 
-Overriding this behavior is as easy as adding an initializer with the line:
+A basic example of a logplexer initializer:
 
-    ENV['LOG_TO_HB'] = "true"
-
-or
-
-    ENV['LOG_TO_HB'] = "false"
-
-### Overriding log level
+```ruby
+Logplexer.configure do |config|
+  # config.logfile = "my_sexy_log.log" # STDOUT by default, but if you set logger, this will be ignored.
+  config.logger = Rails.logger # Logger.new(STDOUT) by default
+  config.verbose = Rails.env == "development" # logs the backtrace as well
+  # quiet = false # if true, nothing will log (helpful for tests)
+  config.honeybadger = false # This tells Logplexer whether or not to log to Honeybadger
+  config.min_log_level = :warn # :error by default. Can be ( :debug, :info, :warn, :error, or :fatal )
+end
+```
 
-By default Logplexer will (as of version 0.2.0) log to Honeybadger only those errors with the log level of `error` or `fatal`. If you would like to adjust this, for example to log errors that are at or above  `warn` for instance, just put this line in your: `config/initializers/logplexer.rb`:
+The default initializer is as follows:
 
-    ENV['LOG_MIN_HB'] = 'warn' # could also be debug, info, error or fatal
+```ruby
+Logplexer.configure do |config|
+  config.honeybadger = !(Rails.env == 'development' or Rails.env == 'test')
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/logplexer.rb

@@ -2,33 +2,50 @@ require "logplexer/version"
 require "honeybadger"
 require 'logplexer/railtie' if defined?(Rails)
 require 'logger'
-module Logplexer
+require 'logplexer/configuration'
+class LogplexerError < StandardError
+end
 
+module Logplexer
   extend self
+  attr_writer :config
+  def config
+    @config ||= Configuration.new
+  end
 
+  def configure(&blk)
+    yield( config )
+  end
   # Dyamically create all the class log methods for Rails logger
   %W(debug info warn error fatal).each do |log_type|
     class_eval  <<-RUBY
-      def #{log_type}(exception, opts = {})
+      def #{log_type}(exception, **opts)
         log( exception, "#{log_type}", opts )
       end
     RUBY
   end
 
-  def log( exception, log_level, opts = {})
+  def log( exception, log_level, **opts)
     # We wrap the Honeybadger notify call so that in development,
     # we actually see the errors. Then we can unwrap the REST errors
     # if need be
+
     return if exception.nil?
-    return if ENV['LOG_QUIET'] == 'true'
+    return if Logplexer.config.quiet?
+
+    # If the user specifies a logfile AND a logger in the call, the logger will win out
+    logfile = opts.delete( :logfile ) || Logplexer.config.logfile
+    logger = opts.delete( :logger ) || Logplexer.config.logger
+    unless is_logger?(logger)
+      raise LogplexerError, "If specified, logger must be able to respond to :debug, :info, :warn, :error, and :fatal"
+    end
 
-    logfile = opts.delete( :logfile )
-    logger = Logger.new( logfile || STDOUT )
+    # Override the verbosity if config.verbose is unset
+    verbose = opts.delete( :verbose )
+    verbose = verbose.nil? ? Logplexer.config.verbose? : verbose
+
+    if Logplexer.config.honeybadger? && above_min_log_level?( log_level )
 
-    # Override the verbosity if LOG_VERBOSE is unset
-    verbose = ENV["LOG_VERBOSE"] == "true" ? true : opts.delete( :verbose )
-    if ENV['LOG_TO_HB'] == "true" && above_min_log_level?( log_level )
-      #TODO: Maybe extend this to include other kinds of notifiers.
       if exception.is_a? String
         exception = { error_class: "Exception",
                       error_message: exception }
@@ -56,8 +73,13 @@ module Logplexer
     end
   end
 
+  def is_logger?(logger)
+    eval( %w(debug info warn error fatal).map do |meth|
+      "logger.respond_to?(:#{meth})"
+    end.join( ' && ' ) )
+  end
   def above_min_log_level?( p )
-    min = ENV["LOG_MIN_HB"] || 'error'
+    min = Logplexer.config.min_log_level || :error
     return priority( p ) >= priority( min )
   end
 

data/lib/logplexer/configuration.rb

@@ -0,0 +1,30 @@
+require 'logger'
+
+module Logplexer
+  class Configuration
+    attr_accessor :logger, :verbose, :quiet, :honeybadger, :min_log_level
+    attr_reader :logfile
+    def initialize
+      @logfile = STDOUT
+      @logger = Logger.new(STDOUT)
+      @verbose = false
+      @quiet = false
+      @honeybadger = false
+      @min_log_level = :error
+    end
+
+    def logfile=( val )
+      @logfile = val
+      @logger = Logger.new( val )
+      @logfile
+    end
+
+    %w(honeybadger quiet verbose).each do |question|
+      class_eval  <<-RUBY
+        def #{question}?
+          #{question}
+        end
+      RUBY
+    end
+  end
+end

data/lib/logplexer/railtie.rb

@@ -1,10 +1,8 @@
 module Logplexer
   class Railtie < Rails::Railtie
     initializer "logplexer.configure_rails_initialization" do
-      if Rails.env == 'development' or Rails.env == 'test'
-        ENV['LOG_TO_HB'] = 'false'
-      else
-        ENV['LOG_TO_HB'] = 'true'
+      Logplexer.configure do |config|
+        config.honeybadger = !(Rails.env == 'development' or Rails.env == 'test')
       end
     end
   end

data/lib/logplexer/version.rb

@@ -1,3 +1,3 @@
 module Logplexer
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logplexer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Canty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,9 +125,12 @@ files:
 - bin/console
 - bin/setup
 - lib/logplexer.rb
+- lib/logplexer/configuration.rb
 - lib/logplexer/railtie.rb
 - lib/logplexer/version.rb
 - logplexer-0.1.0.gem
+- logplexer-0.2.1.gem
+- logplexer-0.3.0.gem
 - logplexer.gemspec
 homepage: ''
 licenses: