sinatra-log 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d330d9392783361671201bbfd7edd7896a428038
-  data.tar.gz: fe9491f7f176995b96ead97d92fb817430d2018c
+  metadata.gz: 4d659d2f552791227ac04e85055643571dd55165
+  data.tar.gz: 1aee0bd7348a25ad784cad47d3a2cc55f119e474
 SHA512:
-  metadata.gz: 98a409b0fa7bbc3f053ecb42572ab353c13825df433a4564b33ee1ec67e96da9ef7248e7909beea08d753622e6252a58ed9539f81d8362e2dc7b31fc0bf2c007
-  data.tar.gz: 8058cd7f3c28ebf9083cc0a90227ccdc46b9c7e0deff7309ceafe02ee9c196339a14222ee5a55b7dcee02673c7ed3d80faa6d44d7891e8b4af1e0bcda8326015
+  metadata.gz: 10896c174b8bd6b1742f59f6f96e67db3b846e87a5105f5ebd3208c44453b804508a0369516666e14d34d23f57d7c62a91f322ef82d7cc0ea0c0997844201ac3
+  data.tar.gz: 0c93f7e05bc8f3360203c3a0b4d74a1ec2f5b2c588d3c9fb3c7bc25623e38d5c6c097827282143f1b76877932a98e2cd82a66d5e51245aa9bd6e066bde0ec222

data/.gitignore

@@ -16,4 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-log
+rspec-test.log

data/README.md

@@ -1,22 +1,62 @@
-# A Sinatra Logger ![Build Status][1]
+# Sinatra::Log ![Build Status][1]
 
-### History
+A simple file logger written for use by Sinatra apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-log'
+
+And then execute:
+
+    $ bundle install
+
+Or install it globally:
+
+    $ gem install sinatra-log
+
+## Usage
+
+```
+class MyProject
+  def self.log
+    @logger ||= Sinatra::Log.new(:logger_name => 'myproject',
+                                 :log_filename => '/var/log/development.log',
+  				 :loglevel => 'WARN',
+  				 :enabled => true,
+  				 :project_dir => '/var/opt/myproj')
+  end
+end
+
+MyProject.log.error "Error level log" 	# You will see this
+MyProject.log.warn "Warning level log"  # You will see this
+MyProject.log.info "Info level log"     # But not this
+MyProject.log.debug "Debug level log"   # or this
+
+```
+
+This will configure the logger to output messages at WARN level or higher to
+be directed to the location /var/log/development.log. Logging is enabled and
+the log4r logger is named 'myproject'.
+
+Each log messages that is generated by log4r will contain the full path and
+filename of the origin of the log message. Specifying the project root
+directory in :project_dir, will cause that directory to be removed from each
+log message.
+
+## History
 
 I wrote this wrapper around log4r in 2014 for a small Sinatra project at
 [Lookout][4]. As the project ended, the code was pulled out
 and open sourced by [ismith][3] and included in [lookout-rack-utils][2].
 
-### Changes
-
-It is mostly unchanged here, though configuration is done through the logging
-constructor, not through configatron. Graphite logging was also thrown out,
-though that could be re-added if desired. And of course there was a namespace
-change.
-
-### Purpose
+## Changes
 
-This was written for usage in Sinatra -- as logging isn't provide outside of
-request context. But it could be used in any Ruby project.
+The changes here remove the Lookout specific bits of the logging - the use of
+specific configatron values that may not match your project or style.
+Graphite logging was also thrown out, though that could be re-added if
+desired. And of course there was a namespace change.
 
 [1]: https://api.travis-ci.org/svrana/sinatra-log.svg?branch=master
 [2]: https://github.com/lookout/lookout-rack-utils.git

data/lib/sinatra/log.rb

@@ -1,118 +1,2 @@
 require 'rubygems'
-require 'log4r'
-require 'time'
-
-module Sinatra
-  # Logs to specified filename with the format:
-  #
-  #   [Log Level]: [Timestamp (ISO-8601)]: [File:linenum]: [Log Message]
-  #
-  # Access is usually wrapped in a class helper:
-  #
-  # class MyProject
-  #   self.log
-  #     @logger ||= Sinatra::Log.new(:logger_name => 'myproject',
-  #                                  :log_filename => 'myproject/dev.log',
-  #                                  :loglevel => 'WARN',
-  #                                  :enabled => true,
-  #                                  :project_dir => '/var/opt/myproj')
-  #   end
-  # end
-  class Log
-    include Log4r
-
-    REQUIRED_CONFIG_SYMBOLS = [:logger_name, :loglevel, :log_filename,
-                               :enabled].freeze
-
-    # Formatter that include the filename and relative path, and line number in
-    # output of the caller.
-    #
-    # Since all callers go through the methods defined in this class to log, we
-    # look at the second line of the tracer output, removing everything but the
-    # directories after the project directory.
-    class DefaultFormatter < Log4r::Formatter
-      attr_reader :basedir
-
-      # @param [String] basedir   The base project directory; this directory
-      #   will be filtered out from each log entry if specified.
-      def initialize(basedir = nil)
-        super
-        @basedir = basedir
-      end
-
-      # Return a trimmed version of the filename from where a LogEvent occurred
-      #
-      # @param [String] tracer A line from the LogEvent#tracer Array
-      # @return [String] Trimmed and parsed version of the file ane line number
-      def event_filename(tracer)
-        if basedir.nil?
-          parts = tracer.match(/(.*:[0-9]+).*:/)
-        else
-          parts = tracer.match(/#{basedir}\/(.*:[0-9]+).*:/)
-        end
-
-        # If we get no matches back, we're probably in a jar file in which case
-        # the format of the tracer is going to be abbreviated
-        if parts.nil?
-          parts = tracer.match(/(.*:[0-9]+).*:/)
-        end
-        return parts[-1] if parts
-      end
-
-      # Receive the LogEvent and pull out the log message and format it for
-      # display in the logs
-      #
-      # @param [Log4r::LogEvent] event
-      # @return [String] Formatted log message
-      def format(event)
-        filename = event_filename(event.tracer[1])
-        time = Time.now.utc.iso8601
-        return "#{Log4r::LNAMES[event.level]}: #{time}: #{filename}: #{event.data}\n"
-      end
-    end
-
-    attr_reader :outputter
-
-    def initialize(config={})
-      errors = []
-      REQUIRED_CONFIG_SYMBOLS.each do |key|
-        if !config.include?(key)
-          errors << "#{key} required, but not specified in config hash"
-        end
-      end
-      raise ArgumentError, "#{errors}" if errors.count > 0
-
-      logger_name = config[:logger_name].to_s.gsub(/\s+/, '_')
-      @logger = Log4r::Logger.new(logger_name)
-
-      if config[:enabled]
-        index = Log4r::LNAMES.index(config[:loglevel])
-        # if logger.level is not in LNAMES an exception will be thrown
-        @logger.level = index unless index.nil?
-      else
-        @logger.level = Log4r::OFF
-      end
-
-      @outputter = FileOutputter.new("#{logger_name}fileoutput",
-                                     :filename => config[:log_filename],
-                                     :trunc => false)
-      @logger.trace = true
-      @outputter.formatter = DefaultFormatter.new(config[:project_dir])
-      @logger.outputters = @outputter
-    end
-
-
-    [:debug, :info, :warn, :error, :fatal, :level].each do |method|
-      define_method(method) do |*args, &block|
-        @logger.send(method, *args, &block)
-      end
-
-      # Returns true iff the current severity level allows for
-      # the printing of level messages.
-      allow_logging = "#{method}?".to_sym
-      define_method(allow_logging) do |*args|
-        @logger.send(allow_logging, *args)
-      end
-    end
-  end
-end
+require 'sinatra/log/log'

data/lib/sinatra/log/default_formatter.rb

@@ -0,0 +1,53 @@
+require 'time'
+require 'log4r'
+
+module Sinatra
+  class Log
+    # Formatter that include the filename and relative path, and line number in
+    # output of the caller.
+    #
+    # Since all callers go through the methods defined in this class to log, we
+    # look at the second line of the tracer output, removing everything but the
+    # directories after the project directory.
+    class DefaultFormatter < Log4r::Formatter
+      attr_reader :basedir
+
+      # @param [String] basedir   The base project directory; this directory
+      #   will be filtered out from each log entry if specified.
+      def initialize(basedir = nil)
+        super
+        @basedir = basedir
+      end
+
+      # Return a trimmed version of the filename from where a LogEvent occurred
+      #
+      # @param [String] tracer A line from the LogEvent#tracer Array
+      # @return [String] Trimmed and parsed version of the file ane line number
+      def event_filename(tracer)
+        if basedir.nil?
+          parts = tracer.match(/(.*:[0-9]+).*:/)
+        else
+          parts = tracer.match(/#{basedir}\/(.*:[0-9]+).*:/)
+        end
+
+        # If we get no matches back, we're probably in a jar file in which case
+        # the format of the tracer is going to be abbreviated
+        if parts.nil?
+          parts = tracer.match(/(.*:[0-9]+).*:/)
+        end
+        return parts[-1] if parts
+      end
+
+      # Receive the LogEvent and pull out the log message and format it for
+      # display in the logs
+      #
+      # @param [Log4r::LogEvent] event
+      # @return [String] Formatted log message
+      def format(event)
+        filename = event_filename(event.tracer[1])
+        time = Time.now.utc.iso8601
+        return "#{Log4r::LNAMES[event.level]}: #{time}: #{filename}: #{event.data}\n"
+      end
+    end
+  end
+end

data/lib/sinatra/log/log.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'log4r'
+require 'sinatra/log/default_formatter'
+
+module Sinatra
+  # Logs to specified filename with the format:
+  #
+  #   [Log Level]: [Timestamp (ISO-8601)]: [File:linenum]: [Log Message]
+  #
+  class Log
+    include Log4r
+
+    attr_reader :outputter
+
+    REQUIRED_CONFIG_SYMBOLS = [:logger_name, :loglevel, :log_filename,
+                               :enabled].freeze
+
+    def initialize(config={})
+      errors = []
+      REQUIRED_CONFIG_SYMBOLS.each do |key|
+        if !config.include?(key)
+          errors << "#{key} required, but not specified in config hash"
+        end
+      end
+      raise ArgumentError, "#{errors}" if errors.count > 0
+
+      logger_name = config[:logger_name].to_s.gsub(/\s+/, '_')
+      @logger = Log4r::Logger.new(logger_name)
+
+      if config[:enabled]
+        index = Log4r::LNAMES.index(config[:loglevel])
+        # if logger.level is not in LNAMES an exception will be thrown
+        @logger.level = index unless index.nil?
+      else
+        @logger.level = Log4r::OFF
+      end
+
+      @outputter = FileOutputter.new("#{logger_name}fileoutput",
+                                     :filename => config[:log_filename],
+                                     :trunc => false)
+      @logger.trace = true
+      @outputter.formatter = DefaultFormatter.new(config[:project_dir])
+      @logger.outputters = @outputter
+    end
+
+
+    [:debug, :info, :warn, :error, :fatal, :level].each do |method|
+      define_method(method) do |*args, &block|
+        @logger.send(method, *args, &block)
+      end
+
+      # Returns true iff the current severity level allows for
+      # the printing of level messages.
+      allow_logging = "#{method}?".to_sym
+      define_method(allow_logging) do |*args|
+        @logger.send(allow_logging, *args)
+      end
+    end
+  end
+end

data/lib/sinatra/log/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  class Log
+    VERSION = "0.1.2"
+  end
+end

data/sinatra-log.gemspec

@@ -1,14 +1,14 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sinatra/version'
+require 'sinatra/log/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "sinatra-log"
-  spec.version       = Sinatra::Logger::VERSION
+  spec.version       = Sinatra::Log::VERSION
   spec.authors       = ["Shaw Vrana"]
   spec.email         = ["shaw@vranix.com1"]
-  spec.description   = %q{A logger for Sinatra}
+  spec.description   = %q{A logger for Sinatra applications}
   spec.summary       = %q{}
   spec.homepage      = "http://github.com/svrana/sinatra-log"
   spec.license       = "MIT"

data/spec/formatter_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'sinatra/log'
+require 'sinatra/log/default_formatter'
 require 'timecop'
 
 describe Sinatra::Log::DefaultFormatter do

data/spec/log_spec.rb

@@ -7,7 +7,7 @@ describe Sinatra::Log do
       :enabled => true,
       :logger_name => 'mylogger',
       :loglevel => 'DEBUG',
-      :log_filename => 'log'
+      :log_filename => 'rspec-test.log'
     }
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Shaw Vrana
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A logger for Sinatra
+description: A logger for Sinatra applications
 email:
 - shaw@vranix.com1
 executables: []
@@ -109,11 +109,12 @@ files:
 - README.md
 - Rakefile
 - lib/sinatra/log.rb
-- lib/sinatra/version.rb
+- lib/sinatra/log/default_formatter.rb
+- lib/sinatra/log/log.rb
+- lib/sinatra/log/version.rb
 - sinatra-log.gemspec
 - spec/formatter_spec.rb
 - spec/log_spec.rb
-- spec/spec_helper.bak.rb
 - spec/spec_helper.rb
 homepage: http://github.com/svrana/sinatra-log
 licenses:
@@ -142,5 +143,4 @@ summary: ''
 test_files:
 - spec/formatter_spec.rb
 - spec/log_spec.rb
-- spec/spec_helper.bak.rb
 - spec/spec_helper.rb

data/lib/sinatra/version.rb

@@ -1,5 +0,0 @@
-module Sinatra
-  module Logger
-    VERSION = "0.1.1"
-  end
-end

data/spec/spec_helper.bak.rb

@@ -1,6 +0,0 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib/'))
-
-require 'sinatra/logger'
-
-require 'rspec'
-require 'rspec/its'