shog 0.0.1pre → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c2911552953a643413c7b06c35bf76a64407365
-  data.tar.gz: 1473e2dfc15bc9c0895f60296408715a9125d217
+  metadata.gz: e02b8810b0926489472a9c3ae7172681c903d247
+  data.tar.gz: 82e7c9c7d3fbc7ea093b79f3afd0c638c9bab046
 SHA512:
-  metadata.gz: 53dd0a9a5398dfa7e027a805d1d2ec8a645b13fb54c563cd3de121d271148725626455de4c2502245c7342fab1b6b23cf3934feafdf1d8bfdc6dc16847eca49e
-  data.tar.gz: 50a4677ac5ce8bab418930c97a327e52cadcfeff035140b3c9486ccfc641a6c37fb7369a93fccba9060cd44118f672d9d1d8c8384b71e5b02340f6afd274a092
+  metadata.gz: 3a851ea89f9357838dd1d6b2f31108757b1b846cdcfec47004887a08cf825c4afd086217251c49e403f2589f1697b15d5d1094043e715ba821c2e70258bf25c1
+  data.tar.gz: 515b080f51d3f66fa3d49f48c1a9e6fbc26916c46e27261195c38eb3aa244a384981b229ef3584e8f45314a198be31842cd0a4907b55f35c2f291fae4fe384e6

data/lib/shog.rb

@@ -1,5 +1,11 @@
 require 'shog/version'
+require 'shog/formatter'
+require 'shog/formatters'
+require 'shog/rails'
 require 'pry'
 
 module Shog
+  def self.configure(&block)
+    ::Rails.logger.formatter.configure &block
+  end
 end

data/lib/shog/formatter.rb

@@ -0,0 +1,149 @@
+require 'active_support/tagged_logging'
+require 'colored'
+
+module Shog
+  class Formatter < ::ActiveSupport::Logger::SimpleFormatter
+
+    include ActiveSupport::TaggedLogging::Formatter
+
+    def call( severity, time, progname, msg )
+      return if msg.blank?
+      tagged formatted_severity_tag( severity ) do
+        msg = formatted_message( severity, msg )
+        msg = timestamped_message( time, msg )
+        msg = prognamed_message( progname, msg )
+
+        super severity, time, progname, msg
+      end
+    end
+
+    def initialize
+      reset_config!
+    end
+
+    # Formats the message according to the configured settings.
+    # @param [String] msg to format.
+    def formatted_message( severity, msg )
+      msg = String === msg ? msg : msg.inspect
+
+      if args = matched( msg )
+        args.first.call msg, args.last
+      elsif proc = configuration[:severities][severity]
+        proc.call msg
+      else
+        msg
+      end
+    end
+
+    # Formats the severity indicator prefixed before each line when writing to
+    # the log.
+    # @param [String] the severity of the message (ex DEBUG, WARN, etc.)
+    # @return [String] formatted version of the severity
+    def formatted_severity_tag( severity )
+      length = configuration[:severity_tags][:_length] ||= begin
+        configuration[:severity_tags].reduce(0){ |l,(k,_)| [k.length,l].max }
+      end
+
+      padded_severity = severity.ljust length
+
+      if proc = configuration[:severity_tags][severity]
+        proc.call padded_severity
+      else
+        padded_severity
+      end
+    end
+
+    # Formats a ms time value.
+    def format_time( time, expected = 30 )
+      timef = time.to_f
+      case
+      when timef > expected * 2 then time.to_s.red
+      when timef > expected     then time.to_s.yellow
+      else time
+      end
+    end
+
+
+    # ==========================================================================
+    # @!group Configuration
+
+    # Configure messages formatting for this formatter.
+    def configure( &block )
+      instance_eval( &block )
+      self
+    end
+
+    # Format the severity tagged before each line.
+    def severity_tag( level, &block )
+      configuration[:severity_tags][ level.to_s.upcase ] = block
+    end
+
+    # Provide customized formatting for messages of the given severity when they
+    # a custom matcher cannot be found.
+    # @param [String,Symbol] level to format.
+    def severity( level, &block )
+      configuration[:severities][ level.to_s.upcase ] = block
+    end
+
+    # Resets any previously configured formatting settings.
+    def reset_config!
+      @configuration ||= {
+        severity_tags: {},
+        severities: {},
+        matchers: {}
+      }
+      self
+    end
+
+    # When a log message matches the given pattern, provide a custom format
+    # for it.
+    def match( pattern, &block )
+      configuration[:matchers][pattern] = block
+    end
+
+    # Adds the named matchers to the log
+    def formatter( mod )
+      unless mod.is_a? Module
+        mod = "Shog::Formatters::#{mod.to_s.camelize}".constantize
+      end
+
+      mod.configure self
+    end
+
+    # Include timestamp in logged messages.
+    def timestamp( enabled = true )
+      configuration[:timestamp] = enabled
+    end
+
+    # Include the progname in logged messages.
+    def progname( enabled = true )
+      configuration[:progname] = enabled
+    end
+
+    # @!endgroup
+
+    private
+
+      attr_accessor :configuration
+
+      def matched( msg )
+        if matched =  configuration[:matchers].find do |pattern,_|
+                        pattern === msg
+                      end
+          [matched.last, Regexp.last_match]
+        end
+      end
+
+      def timestamped_message( time, msg )
+        return msg unless configuration[:timestamp]
+
+        "[#{time}] #{msg}"
+      end
+
+      def prognamed_message( progname, msg )
+        return msg unless configuration[:progname]
+
+        "[#{progname}] #{msg}"
+      end
+  end
+end

data/lib/shog/formatters.rb

@@ -0,0 +1,2 @@
+require 'shog/formatters/defaults'
+require 'shog/formatters/requests'

data/lib/shog/formatters/defaults.rb

@@ -0,0 +1,20 @@
+module Shog
+  module Formatters
+    # Default formatting options
+    module Defaults
+      module_function
+
+      def configure( formatter )
+        formatter.configure do
+          severity_tag( :debug ) { |msg| msg.black.bold }
+          severity_tag( :warn  ) { |msg| msg.yellow }
+          severity_tag( :error ) { |msg| msg.red }
+          severity_tag( :fatal ) { |msg| msg.white_on_red }
+
+          severity( :error ){ |msg| msg.red }
+          severity( :fatal ){ |msg| msg.red }
+        end
+      end
+    end
+  end
+end

data/lib/shog/formatters/requests.rb

@@ -0,0 +1,48 @@
+module Shog
+  module Formatters
+    # Format log messages from the request processing such as controller endpoints and views.
+    module Requests
+      module_function
+
+      def configure( formatter )
+        formatter.configure do
+          match /Started\s+(?<method>PUT|PATCH|GET|POST|DELETE)\s+(?<path>"[^"]*")[^\d\.]+(?<ip>[\d\.]+)(?<time>.*)/ do |msg,match|
+            # http://refiddle.com/ge6
+            "#{match["method"].ljust 6} ".green.bold + " #{match["path"]} ".white.bold + " for " + "#{match["ip"]}".yellow + " #{match["time"]}".black.bold
+          end
+
+          match /\s*Rendered\s+(?<view>[^\s]+)\swithin\s(?<layout>[^\s]+)\s\((?<time>.*)\)/ do |msg,match|
+            # http://refiddle.com/18qr
+            "  Rendered " + match["view"].white.bold + " within " + match["layout"].white + " " + format_time( match['time'] )
+          end
+
+          match /\s*Completed\s(?<code>\d+)\s(?<friendly>.*)\sin\s(?<time>\d+[^\s]*)\s(?<details>.*)/ do |msg,match|
+            # http://refiddle.com/18qq
+            parts = [ "Completed" ]
+            parts <<  case match['code'].to_i
+                      when 200..399 then match['code'].green
+                      when 400..499 then match['code'].yellow
+                      else               match['code'].red
+                      end
+            parts << match['friendly'].yellow
+            parts << 'in'
+            parts << format_time( match['time'], 250 )
+            parts << match['details']
+
+            parts.join(" ")
+          end
+
+          match /Processing by (?<controller>[^\s]*) as (?<format>.*)/ do |msg,match|
+            # http://refiddle.com/18qs
+            "Processing by #{match['controller'].magenta.bold} as #{match['format'].yellow}"
+          end
+
+        end
+      end
+
+
+
+
+    end
+  end
+end

data/lib/shog/rails.rb

@@ -0,0 +1,14 @@
+require 'rails'
+
+module Shog
+  module Rails
+    class Railtie < ::Rails::Railtie
+      config.before_initialize do
+        ::Rails.logger.formatter = Shog::Formatter.new.configure do
+          formatter :defaults
+          formatter :requests
+        end
+      end
+    end
+  end
+end

data/lib/shog/version.rb

@@ -1,5 +1,5 @@
 module Shog
-  VERSION_NUMBER  = "0.0.1"
-  VERSION_SUFFIX  = "pre"
+  VERSION_NUMBER  = "0.0.2"
+  VERSION_SUFFIX  = ""
   VERSION         = "#{VERSION_NUMBER}#{VERSION_SUFFIX}"
 end

data/shog.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rails', '~> 4.0'
+  spec.add_dependency 'colored', '~> 1.2'
   spec.required_ruby_version = '>= 1.9.2'
 
   spec.add_development_dependency "bundler", "~> 1.6"

data/spec/lib/shog/formatter_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+module Shog::Formatters::Spec
+  module_function
+  def configure( formatter )
+    formatter.configure do
+      severity :test, ->{}
+    end
+  end
+end
+
+describe Shog::Formatter do
+  let(:formatter){ Shog::Formatter.new }
+
+  describe "#formatted_severity_tag" do
+    it "buffers to the same size" do
+      formatter.severity_tag( :warn ){ |msg| msg }
+      formatter.severity_tag( :longer ){ |msg| msg }
+
+      expect( formatter.formatted_severity_tag( "WARN" ) ).to   eq "WARN  "
+      expect( formatter.formatted_severity_tag( "LONGER" ) ).to eq "LONGER"
+    end
+  end
+
+  describe "#match" do
+    it "formats a matched line" do
+      formatter.match /GET/ do |msg,match|
+        "R'DONE"
+      end
+
+      result = formatter.call "INFO", Time.now, nil, "Started GET \"/Home\""
+      expect( result ).to eq "[INFO] R'DONE\n"
+    end
+
+    it "includes the match" do
+      formatter.match /GET/ do |msg,match|
+        expect( match ).to be_present
+      end
+
+      formatter.call "INFO", Time.now, nil, "Started GET \"/Home\""
+    end
+
+    it "doesn't match" do
+      result = formatter.call "INFO", Time.now, nil, "Started GET \"/Home\""
+      expect( result ).to eq "[INFO] Started GET \"/Home\"\n"
+    end
+
+    it "uses default severity when no matcher is found" do
+      formatter.severity( :info ){ |msg| "DEFAULT" }
+
+      result = formatter.call "INFO", Time.now, nil, "Started GET \"/Home\""
+      expect( result ).to eq "[INFO] DEFAULT\n"
+    end
+  end
+
+  describe "#formatters" do
+    it "loads from a symbol" do
+      formatter.should_receive(:severity).with(:test, anything())
+
+      formatter.configure do
+        formatter :spec
+      end
+    end
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shog
 version: !ruby/object:Gem::Version
-  version: 0.0.1pre
+  version: 0.0.2
 platform: ruby
 authors:
 - Paul Alexander
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,8 +101,14 @@ files:
 - README.md
 - Rakefile
 - lib/shog.rb
+- lib/shog/formatter.rb
+- lib/shog/formatters.rb
+- lib/shog/formatters/defaults.rb
+- lib/shog/formatters/requests.rb
+- lib/shog/rails.rb
 - lib/shog/version.rb
 - shog.gemspec
+- spec/lib/shog/formatter_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/phallguy/shog
 licenses:
@@ -105,9 +125,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.3.0
@@ -115,5 +135,6 @@ signing_key:
 specification_version: 4
 summary: Make rails 4.0 log details more colorful
 test_files:
+- spec/lib/shog/formatter_spec.rb
 - spec/spec_helper.rb
 has_rdoc: