custom_rails_logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0473180c06ce711214a7ea5f49c4a71837a1993a
+  data.tar.gz: 346e62f0372992f2a8e469f9c925c1988127c893
+SHA512:
+  metadata.gz: 8a4253096b441b10a5c8492ec6b0f4a74decce978987ac21cf18cbe81428902d87e5b35e18f7bf6d5b0aaec47baabcd100f91a8ffd27fab4531ab1533b50316a
+  data.tar.gz: 01aca1ba5e63e5e4d60c18156c4be7b80ef4760a5162b22cbf828e8d680cca768f7a7ce0295903b130d98ac70e2fcca912f20340f64e87c4fd01640932457b4e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Suguru Odai
+
+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/README.md

@@ -0,0 +1,54 @@
+# CustomRailsLogger
+
+# Installation
+
+Add `custom_rails_logger` in the `Gemfile`.
+
+```ruby
+gem 'custom_rails_logger'
+```
+
+Download and install by running.
+
+```ruby
+bundle install
+```
+
+# Configuration
+
+Create an initializer in the `config/initializers/custom_rails_logger.rb`.
+
+That by adding with:
+
+```ruby
+CustomRailsLogger.configure do |config|
+  config.started_request_message_format = 'Started %m "%f" for %a by %u at %t'
+end
+```
+
+When requested to `/session/new`, write the customized log message to `log/*.log`.
+
+```
+Started GET "/session/new" for 128.0.0.1 by Mozilla/5.0 (Windows NT 6.3; rv:36.0) Gecko/20100101 Firefox/36.0 at 2012-09-26 14:51:42 -0700
+```
+
+# Custom Log Formats
+
+```
+Format String
+  %%: The percent sign
+  %a: The request IP-address
+  %{Foobar}C: The contents of cookie Foobar in the request sent to the server.
+  %{Foobar}e: The contents of Foobar: header line(s) in the request sent to the server.
+  %f: The filtered path
+  %h: The request Host
+  %m: The request method
+  %p: The port of the server serving the request
+  %s: The request schema
+  %t: Time the request was received
+  %u: The request user agent
+```
+
+# Get involved
+
+TODO

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/custom_rails_logger.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'custom_rails_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "custom_rails_logger"
+  spec.version       = CustomRailsLogger::VERSION
+  spec.authors       = ["Suguru Odai"]
+  spec.email         = ["ourqwers@gmail.com"]
+  spec.summary       = %q{custom_rails_logger}
+  spec.description   = %q{Custom a access log format for Rails.}
+  spec.homepage      = "https://github.com/odaillyjp/custom_rails_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  #spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/custom_rails_logger/configuration.rb

@@ -0,0 +1,12 @@
+module CustomRailsLogger
+  class Configuration
+    attr_accessor :started_request_message_format
+
+    # Default format
+    #   started request message:
+    #     'Started GET "/session/new" for 127.0.0.1 at 2012-09-26 14:51:42 -0700'
+    def initialize
+      @started_request_message_format = 'Started %m "%f" for %a at %t'
+    end
+  end
+end

data/lib/custom_rails_logger/formatter.rb

@@ -0,0 +1,39 @@
+module CustomRailsLogger
+  module Formatter
+    module_function
+
+    # Format String
+    #   %%: The percent sign
+    #   %a: The request IP-address
+    #   %{Foobar}C: The contents of cookie Foobar in the request sent to the server.
+    #   %{Foobar}e: The contents of Foobar: header line(s) in the request sent to the server.
+    #   %f: The filtered path
+    #   %h: The request Host
+    #   %m: The request method
+    #   %p: The port of the server serving the request
+    #   %s: The request schema
+    #   %t: Time the request was received
+    #   %u: The request user agent
+    def call(message_format, request)
+      tr_maps = message_format.scan(/%(?:{(.+?)})?(.)/)
+        .map do |var_name, format_string|
+          case format_string
+          when '%' then '%'
+          when 'a' then request.ip
+          when 'C' then request.cookies[var_name]
+          when 'e' then request.env[var_name]
+          when 'f' then request.filtered_path
+          when 'h' then request.host
+          when 'm' then request.request_method
+          when 'p' then request.port
+          when 's' then request.scheme
+          when 't' then Time.now.to_s
+          when 'u' then request.user_agent
+          else "%#{format_string}"
+          end
+        end
+
+      message_format.gsub(/%(?:{.+?})?./, '%s') % tr_maps
+    end
+  end
+end

data/lib/custom_rails_logger/rails_ext/rack/logger.rb

@@ -0,0 +1,10 @@
+module Rails
+  module Rack
+    class Logger < ActiveSupport::LogSubscriber
+      def started_request_message(request)
+        message_format = CustomRailsLogger.configuration.started_request_message_format
+        CustomRailsLogger::Formatter.call(message_format, request)
+      end
+    end
+  end
+end

data/lib/custom_rails_logger/version.rb

@@ -0,0 +1,3 @@
+module CustomRailsLogger
+  VERSION = '0.0.1'
+end

data/lib/custom_rails_logger.rb

@@ -0,0 +1,15 @@
+require 'custom_rails_logger/configuration'
+require 'custom_rails_logger/formatter'
+require 'custom_rails_logger/version'
+require 'custom_rails_logger/rails_ext/rack/logger'
+
+module CustomRailsLogger
+  def self.configuration
+    @configuration ||= CustomRailsLogger::Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+    configuration.setting
+  end
+end

data/test/custom_rails_logger_test.rb

@@ -0,0 +1,85 @@
+require 'minitest/unit'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.expand_path('../lib/', __dir__))
+require 'custom_rails_logger/formatter'
+
+class DummyRequest
+  attr_accessor :ip,
+    :cookies,
+    :env,
+    :filtered_path,
+    :host,
+    :request_method,
+    :port,
+    :scheme,
+    :user_agent
+end
+
+module CustomRailsLogger
+  class TestFormatter < MiniTest::Unit::TestCase
+    def setup
+      @request = DummyRequest.new.tap do |req|
+        req.ip = '192.168.0.1'
+        req.cookies = { 'foo' => 'foo' }
+        req.env = { 'bar' => 'bar'}
+        req.filtered_path = '/path/to'
+        req.host = 'localhost'
+        req.request_method = 'GET'
+        req.port = '80'
+        req.scheme = 'http'
+        req.user_agent = 'Browser'
+      end
+    end
+
+    def test_call_parcent_pattern
+      result = CustomRailsLogger::Formatter.call('Started % %% %%%', @request)
+      assert_equal 'Started % % %%', result
+    end
+
+    def test_call_ip_pattern
+      result = CustomRailsLogger::Formatter.call('Started %a %%a %%%a', @request)
+      assert_equal 'Started 192.168.0.1 %a %192.168.0.1', result
+    end
+
+    def test_call_cookies_pattern
+      result = CustomRailsLogger::Formatter.call('Started %{foo}C %{hoge}C', @request)
+      assert_equal 'Started foo ', result
+    end
+
+    def test_call_env_pattern
+      result = CustomRailsLogger::Formatter.call('Started %{bar}e %{hoge}e', @request)
+      assert_equal 'Started bar ', result
+    end
+
+    def test_call_path_pattern
+      result = CustomRailsLogger::Formatter.call('Started "%f"', @request)
+      assert_equal 'Started "/path/to"', result
+    end
+
+    def test_call_host_pattern
+      result = CustomRailsLogger::Formatter.call('Started %h', @request)
+      assert_equal 'Started localhost', result
+    end
+
+    def test_call_method_pattern
+      result = CustomRailsLogger::Formatter.call('Started %m', @request)
+      assert_equal 'Started GET', result
+    end
+
+    def test_call_port_pattern
+      result = CustomRailsLogger::Formatter.call('Started %p', @request)
+      assert_equal 'Started 80', result
+    end
+
+    def test_call_scheme_pattern
+      result = CustomRailsLogger::Formatter.call('Started %s', @request)
+      assert_equal 'Started http', result
+    end
+
+    def test_call_agent_pattern
+      result = CustomRailsLogger::Formatter.call('Started %u', @request)
+      assert_equal 'Started Browser', result
+    end
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: custom_rails_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Suguru Odai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Custom a access log format for Rails.
+email:
+- ourqwers@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- custom_rails_logger.gemspec
+- lib/custom_rails_logger.rb
+- lib/custom_rails_logger/configuration.rb
+- lib/custom_rails_logger/formatter.rb
+- lib/custom_rails_logger/rails_ext/rack/logger.rb
+- lib/custom_rails_logger/version.rb
+- test/custom_rails_logger_test.rb
+homepage: https://github.com/odaillyjp/custom_rails_logger
+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.2.2
+signing_key: 
+specification_version: 4
+summary: custom_rails_logger
+test_files:
+- test/custom_rails_logger_test.rb