sinatra-log 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea5a6692eacff0449ee337af1b84040e18a05b56
+  data.tar.gz: c52e620e1fd30d43fa5b7927fbf13b083fe11a0e
+SHA512:
+  metadata.gz: 9f542c7f43a6bfca43ded5cf63aebe7e2b4e56c65a9e0fd4322197dc4200773ec69d068356bd4f5cd40a832e7c9a0214e5265618f7229593900a1bf11f4a32b5
+  data.tar.gz: bfbbbd41a90a613eeecc14a527dec6838af38433a68411a5ab430273900793b351c60d7384b36fda25ab288a850e5131f8c97fea506d503bd197b3808c2f071e

data/.gitignore

@@ -0,0 +1,19 @@
+.ruby-*
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+- 2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sintra-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Lookout, Inc
+
+MIT License
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '--fail-fast --color --order random'
+end
+
+task :test => :spec
+task :default => :test

data/lib/sinatra/log.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'log4r'
+require 'time'
+
+module Sinatra
+  # Logging.  Logs to log/<project_name>.log with the format:
+  #
+  #   [Log Level]: [Timestamp (ISO-8601)]: [File:linenum]: [Log Message]
+  #
+  # Use through the helper:
+  #   log.warn 'This is my log message'
+  #
+  class Log
+    include Log4r
+
+    # 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
+      # Return the project base directory for filtering to help with
+      # identifiying the filename and line number when formatting the log
+      # message
+      #
+      # @return [String] Base directory for the project
+      def basedir
+        @basedir ||= File.expand_path(File.join(File.dirname(__FILE__), ".."))
+      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)
+        parts = tracer.match(/#{basedir}\/(.*:[0-9]+).*:/)
+
+        # 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 = []
+      [:logger_name, :loglevel, :log_filename, :enabled].each do |key|
+        if !config.include?(key)
+          errors << "#{key} required, but not specified in config hash"
+        end
+        raise ArgumentError, "#{errors}" if errors.count > 0
+      end
+
+      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
+      @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/version.rb

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

data/sinatra-log.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-log"
+  spec.version       = Sinatra::Logger::VERSION
+  spec.authors       = ["Shaw Vrana"]
+  spec.email         = ["shaw@vranix.com1"]
+  spec.description   = %q{A logger for Sinatra}
+  spec.summary       = %q{}
+  spec.homepage      = "http://github.com/svrana/sinatra-log"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "timecop"
+
+  spec.add_dependency "log4r"
+end

data/spec/logger_spec.rb

@@ -0,0 +1,113 @@
+require 'spec_helper'
+require 'sinatra/log'
+require 'timecop'
+
+describe Sinatra::Log do
+  let(:myconfig) do
+    {
+      :enabled => true,
+      :logger_name => 'mylogger',
+      :loglevel => 'DEBUG',
+      :log_filename => 'log'
+    }
+  end
+
+  subject(:log) { Sinatra::Log.new(myconfig) }
+  subject(:log_message) { 'foo' }
+
+  [:debug, :info, :warn, :error, :fatal].each do |method|
+    describe ".#{method}" do
+      it 'should invoke the internal logger object with a given block' do
+        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
+        processed = false
+        b = Proc.new { processed = true }
+        log.send(method, log_message, &b)
+        expect(processed).to be(true)
+      end
+
+      it 'should invoke the internal logger object w/o a given block' do
+        log.instance_variable_get(:@logger).should_receive(method).with(log_message).and_call_original
+        log.send(method, log_message)
+      end
+    end
+  end
+
+  [:debug?, :info?, :warn?, :error?, :fatal?].each do |method|
+    describe ".#{method}" do
+      it 'returns true when level is debug' do
+        expect(log.send(method)).to eq(true)
+      end
+    end
+  end
+end
+
+describe Sinatra::Log::DefaultFormatter do
+  subject(:formatter) { described_class.new }
+  let(:logger) do
+    logger = double('Mock Logger')
+    logger.stub(:name).and_return('RSpec Logger')
+    logger.stub(:fullname).and_return('RSpec Logger')
+    logger
+  end
+  let(:project_name) { 'some_project' }
+  let(:basedir) { "/home/rspec/#{project_name}" }
+  let(:tracer) do
+    [
+        "#{basedir}/log.rb:63:in `warn'",
+        "#{basedir}/spec/log_spec.rb:9:in `block (2 levels) in <top (required)>'"
+    ]
+  end
+
+  before :all do
+    # The root logger creates the log levels, so making sure it's been
+    # created
+    Log4r::RootLogger.instance
+  end
+
+
+  before :each do
+    formatter.stub(:basedir).and_return(basedir)
+  end
+
+
+  describe '#event_filename' do
+    subject(:filename) { formatter.event_filename(tracer[1]) }
+
+    context 'with a normal MRI LogEvent' do
+      it { should eql('spec/log_spec.rb:9') }
+    end
+
+    # We have slightly different log formats under packaged .jar files
+    context 'with a LogEvent from a packaged .jar' do
+      let(:tracer) { [nil, "backend/metrics.rb:52:in `runloop'"] }
+      let(:basedir) { 'file:/home/user/source/projects/stuff.jar!/project' }
+
+      it { should eql('backend/metrics.rb:52') }
+    end
+  end
+
+  describe '#format' do
+    before :each do
+      Timecop.freeze
+    end
+
+    after :each do
+      Timecop.return
+    end
+
+    context 'with a valid LogEvent' do
+      # Level 3 is the Log4r "warn" level
+      let(:level) { 3 }
+      let(:data) { 'rspec' }
+      let(:timestamp) { Time.now.utc.iso8601 }
+
+      let(:event) do
+        event = Log4r::LogEvent.new(level, logger, tracer, data)
+      end
+
+      it 'should be properly formatted' do
+        expect(formatter.format(event)).to eql("WARN: #{timestamp}: spec/log_spec.rb:9: #{data}\n")
+      end
+    end
+  end
+end

data/spec/spec_helper.bak.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-log
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Shaw Vrana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A logger for Sinatra
+email:
+- shaw@vranix.com1
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/sinatra/log.rb
+- lib/sinatra/version.rb
+- sinatra-log.gemspec
+- spec/logger_spec.rb
+- spec/spec_helper.bak.rb
+- spec/spec_helper.rb
+homepage: http://github.com/svrana/sinatra-log
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/logger_spec.rb
+- spec/spec_helper.bak.rb
+- spec/spec_helper.rb