dfc_log 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a67d9e10b47bdb3b7a8b211b428fb1626b8b4c21
+  data.tar.gz: 40d0bb50b7ef753dc33f54e11bb2db911b00c394
+SHA512:
+  metadata.gz: 95ca7812aac5e3a8c7703b00e9cc3c20d8e97a5371f41fba7b3ad21b6ab52351903ea721acb8598ca2615ecc5c4cfb21fdbc24f1a9874a78e06e3aa93dc62cc3
+  data.tar.gz: b0b7bd9683595c2a9a07e4d4374515d2afeaa01ed59edda093927b668e108401a29d4a5bdd5aa9f9c64f02216d84bc686c96da399d4cd815b9d33c83ed6ca5d9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/*.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+# DfcLog
+This gem adds logging to your rails application and provides a convienent constant called Log to make log calls.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dfc_log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dfc_log
+
+## Usage
+
+Use Log.debug etc.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/devforce/dfc_log.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rails'
+require 'dfc_log'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dfc_log.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dfc_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dfc_log'
+  spec.version       = DfcLog::VERSION
+  spec.authors       = ['Mike Papper']
+  spec.email         = ['bodaro@gmail.com']
+
+  spec.summary       = 'Sets up Rails logging for Heroku apps.'
+  spec.description   = 'Uses custom Log Formatter, one for development and ' \
+    'one for Heroku. Ensure Heroku request IDs are ' \
+    'in the logs. Limits logs to 2500 bytes per entry. Adds a constant ' \
+    'called Log to ease logging.'
+  spec.homepage      = 'https://github.com/devforce/dfc-log'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/dfc_log/dfc_log_formatter.rb

@@ -0,0 +1,28 @@
+# N.B. we limit log message length to 2500 characters
+class DfcLogFormatter
+  SEVERITY_TO_COLOR_MAP = { 'DEBUG' => '0;37', 'INFO' => '32',
+                            'WARN' => '33', 'ERROR' => '31',
+                            'FATAL' => '31', 'UNKNOWN' => '37' }.freeze
+
+  def call(severity, time, _progname, msg)
+    msg = 'BLANK MESSAGE' if msg.blank?
+    msg = msg.strip
+
+    Rails.env.production? ? log_non_local(severity, msg) : log_local(severity, time, msg)
+  end
+
+  private
+
+  def log_local(severity, time, msg)
+    color = SEVERITY_TO_COLOR_MAP[severity]
+    formatted_severity = format('%-5s', severity)
+    formatted_time = time.strftime('%Y-%m-%d %H:%M:%S.') << time.usec.to_s[0..2].rjust(3)
+    "\033[0;37m#{formatted_time}\033[0m [\033[#{color}m#{formatted_severity}\033[0m] #{msg}\n"
+  end
+
+  def log_non_local(severity, msg)
+    # limit to 2500 characters max for hosted logging (unless $DEBUG is set)
+    msg = msg[0..2500] + (msg.length > 2500 ? '...' : '') unless $DEBUG
+    "DFC-#{format('%-5s', severity)} #{msg}\n"
+  end
+end

data/lib/dfc_log/version.rb

@@ -0,0 +1,3 @@
+module DfcLog
+  VERSION = '0.1.1'.freeze
+end

data/lib/dfc_log.rb

@@ -0,0 +1,12 @@
+require 'dfc_log/version'
+require 'dfc_log/dfc_log_formatter'
+
+# DfcLog main class - sets up the formatter
+module DfcLog
+  mylog = Logger.new(Rails.env.production? ? STDOUT : "log/#{Rails.env}.log")
+  mylog.formatter = DfcLogFormatter.new
+  Rails.logger = ActiveSupport::TaggedLogging.new(mylog)
+end
+
+# define convenieience object so you can do Log.debug('...') easily throughout your code
+Log = Rails.logger

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: dfc_log
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mike Papper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Uses custom Log Formatter, one for development and one for Heroku. Ensure
+  Heroku request IDs are in the logs. Limits logs to 2500 bytes per entry. Adds a
+  constant called Log to ease logging.
+email:
+- bodaro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dfc_log.gemspec
+- lib/dfc_log.rb
+- lib/dfc_log/dfc_log_formatter.rb
+- lib/dfc_log/version.rb
+- log/.keep
+homepage: https://github.com/devforce/dfc-log
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sets up Rails logging for Heroku apps.
+test_files: []