request_id_logging 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36731647d62a626d9fa3006fed3bdcad57c0fd03
-  data.tar.gz: 050638faabbc82a4143f94e105d1c45f7a3f87c4
+  metadata.gz: '0894cbd1ed7b5fe6213e45ea870cf96c4f3f2309'
+  data.tar.gz: 44ab371aa34316395193f8fda741d36d644b9b6a
 SHA512:
-  metadata.gz: 61072d856d4ebe017931b627fabc530d5a3c778c7b745cf0674a102338be52efb16c0178fc2a71f2a183ab1d60b0d75c8b66ca9b39bba23066fde268ef375563
-  data.tar.gz: e9f9a553c43f194e83ffdacfc380af350b9e647eee2e00db063f5dc972304a6193eaa92eb4872cf3b3c81cbd73c26d5f7f9171f22b4d3368b8fed74283ef30c0
+  metadata.gz: d201cd4b3dd828d1d5d4c9006219ad5aeabac70d714bd9096e0c1ef0747d0949c151cf56ba4a0fa8729f9996baf1cb0d8dde753f95c649aac786f6c06dec7bcd
+  data.tar.gz: 7e689492b480bdb00b2faf1561026457043e81ba0f8487760a12584b94d756fc04b395bdbfdb2be5aa51afd60942971f99de20c2026db8c8a44d3fbe8e724812

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/

data/.rubocop.yml

@@ -0,0 +1,53 @@
+##################### Linting #############################
+
+##################### Metrics #############################
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+##################### Performance #############################
+
+Performance/FlatMap:
+  EnabledForFlattenWithoutParams: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+##################### Rails ##################################
+
+Rails/SafeNavigation:
+  ConvertTry: true
+
+Rails/SaveBang:
+  Enabled: true
+
+##################### Security ##################################
+
+##################### Style #################################
+
+Style/AutoResourceCleanup:
+  Enabled: true
+
+Style/Encoding:
+  Enabled: true
+  EnforcedStyle: never
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  Enabled: false
+
+##################### Bundler #################################
+Bundler/OrderedGems:
+  Enabled: false

data/.travis.yml

@@ -1,6 +1,19 @@
-sudo: false
 language: ruby
+
 rvm:
+  - 2.0.0-p648
+  - 2.1.10
+  - 2.2.6
   - 2.3.3
-before_install: gem install bundler -v 1.13.6
-script: rake spec
+  - 2.4.0
+
+sudo: false
+
+before_install:
+  - gem install bundler --no-document
+script:
+  - 'bundle exec rspec'
+after_success:
+  - 'bundle exec codeclimate-test-reporter'
+
+cache: bundler

data/Gemfile

@@ -1,4 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in request_id_logging.gemspec
+group :test do
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+end
+
 gemspec

data/README.md

@@ -1,10 +1,13 @@
 # RequestIdLogging
 
+[![Gem Version](https://badge.fury.io/rb/request_id_logging.svg)](https://badge.fury.io/rb/request_id_logging)
 [![Build Status](https://travis-ci.org/ryu39/request_id_logging.svg?branch=master)](https://travis-ci.org/ryu39/request_id_logging)
+[![Code Climate](https://codeclimate.com/github/ryu39/request_id_logging/badges/gpa.svg)](https://codeclimate.com/github/ryu39/request_id_logging)
+[![Test Coverage](https://codeclimate.com/github/ryu39/request_id_logging/badges/coverage.svg)](https://codeclimate.com/github/ryu39/request_id_logging/coverage)
+[![Issue Count](https://codeclimate.com/github/ryu39/request_id_logging/badges/issue_count.svg)](https://codeclimate.com/github/ryu39/request_id_logging)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/request_id_logging`. To experiment with that code, run `bin/console` for an interactive prompt.
+RequestIdLogging provides a Rack middleware and a logger formatter to prepend X-Request-Id to log messages in your Rails app.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,22 +25,103 @@ Or install it yourself as:
 
     $ gem install request_id_logging
 
+
 ## Usage
 
-TODO: Write usage instructions here
+First, add RequestIdLogging::Middleware to rack middlewares.
+In your application.rb or environments/xxx.rb, insert RequestIdLogging::Middleware after ActionDispatch::RequestId.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    # some configurations
+    # :
+
+    config.middleware.insert_after ActionDispatch::RequestId, RequestIdLogging::Middleware
+  end
+end
+```
+
+Next, set RequestIdLogging::Formatter instance to your logger's formatter.
+
+```ruby
+module MyApp
+  class Application < Rails::Application
+    # Set to Rails logger.
+    config.logger = ActiveSupport::Logger.new("log/#{Rails.env}.log")
+    config.logger.formatter = RequestIdLogging::Formatter.new
+    config.logger.formatter.datetime_format = '%Y-%m-%d %H:%M:%S.%L '.freeze
+
+    # And/Or set to your original logger's formatter.
+    config.x.my_app_logger = Logger.new('log/my_app.log')
+    config.x.my_app_logger.formatter = RequestIdLogging::Formatter.new
+    config.x.my_app_logger.formatter.datetime_format = '%Y-%m-%d %H:%M:%S.%L '.freeze
+  end
+end
+```
+
+Then, loggers write logs with request id.
+
+```ruby
+Rails.logger.info 'test'
+# => I, [2016-12-03 20:52:59.879 #106]  INFO -- : [aca576f4-f4fa-4c2a-b172-d8fb5cc37681] test
+
+Rails.configuration.x.my_app_logger.info 'test my_app'
+# => I, [2016-12-03 20:53:00.184 #106]  INFO -- : [aca576f4-f4fa-4c2a-b172-d8fb5cc37681] test my_app
+```
+
+### Request id customization
+
+You can customize request id using `:request_id_proc` option.
+
+Following example extracts first 8 characters from request id and uses it as request id.
+
+```ruby
+logger = Logger.new('log/my_app.log')
+logger.formatter = RequestIdLogging::Formatter.new(request_id_proc: ->(id) { id&.first(8) }) # &. operator requires >= Ruby 2.3.0
+
+logger.info 'customize request id'
+# => I, [2016-12-03 20:46:31.399 #83]  INFO -- : [4a966ef6] customize request id
+```
+
+### Formatter delegation
+
+You can use your original formatter using `:formatter` option.
+
+If this option is specified, RequestIdLogging::Formatter prepends request id to `msg` and calls your formatter#call.
+
+```ruby
+original_formatter = Logger::Formatter.new
+def original_formatter.call(severity, time, progname, msg)
+  "MyFormatter: #{severity}, #{time}, #{progname}, #{msg}\n"
+end
+
+logger = Logger.new('log/my_app.log')
+logger.formatter = RequestIdLogging::Formatter.new(formatter: original_formatter)
+
+logger.info 'formatter delegation'
+# => MyFormatter: INFO, 2016-12-04 10:47, , [6a8ef6bb-cf75-4ddf-a111-72c285c3ebda] test my_app
+```
+
 
 ## 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.
+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).
 
-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/[USERNAME]/request_id_logging. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/request_id_logging.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "request_id_logging"
+require 'bundler/setup'
+require 'request_id_logging'
 
 # 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"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/request_id_logging/formatter.rb

@@ -2,6 +2,7 @@ require 'request_id_logging/constants'
 require 'logger'
 
 module RequestIdLogging
+  # A logger formatter which prepends request_id to message.
   class Formatter < Logger::Formatter
     DEFAULT_REQ_ID_PROC = ->(id) { id }
 
@@ -19,7 +20,11 @@ module RequestIdLogging
     end
 
     def call(severity, time, progname, msg)
-      @original_formatter ? @original_formatter.call(severity, time, progname, new_msg(msg)) : super(severity, time, progname, new_msg(msg))
+      if @original_formatter
+        @original_formatter.call(severity, time, progname, new_msg(msg))
+      else
+        super(severity, time, progname, new_msg(msg))
+      end
     end
 
     private

data/lib/request_id_logging/version.rb

@@ -1,3 +1,3 @@
 module RequestIdLogging
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'.freeze
 end

data/request_id_logging.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'request_id_logging/version'
@@ -9,10 +8,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ['ryu39']
   spec.email         = ['dev.ryu39@gmail.com']
 
-  spec.summary       = %q{Logging with request id in your Rails app.}
-  spec.description   = <<EOS.gsub("\n", ' ')
-This gems provide a Rack middleware and a logger formatter for logging with request id in your Rails app.
-EOS
+  spec.summary       = 'Logging with request id in your Rails app.'
+  spec.description   = 'This gems provide a Rack middleware and a logger formatter ' \
+                       'for logging with request id in your Rails app.'
   spec.homepage      = 'https://github.com/ryu39/request_id_logging'
   spec.license       = 'MIT'
 
@@ -26,4 +24,5 @@ EOS
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_id_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ryu39
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-29 00:00:00.000000000 Z
+date: 2017-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,16 +52,32 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 'This gems provide a Rack middleware and a logger formatter for logging
-  with request id in your Rails app. '
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+description: This gems provide a Rack middleware and a logger formatter for logging
+  with request id in your Rails app.
 email:
 - dev.ryu39@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -96,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Logging with request id in your Rails app.