bullet_log_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d44e398a26b680c801f106de1efba1b73eeb854aedfd204712eb05a8a7fc2770
+  data.tar.gz: 04e5cb8c0c54f5274a415883b34868f8e806978ffd2bcc2b9ca11a00bb241c36
+SHA512:
+  metadata.gz: 2d452a2b730d1ea0d0a3963ee05a47e438ae9c83392f4bbb9f1a3622d57c3d176866a58f59b8ec5b6974362501f1ec512b3c290edb68e02861a30b122a723d03
+  data.tar.gz: 504f4a137bcf5aba63bb1d6876999390d9a8ad9ede26e8547081013edf9e8916eaae47f50e682397a2f686ae1becf30f514041f90acd734c2f60f53961191906

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2020-07-31)
+
+
+### Features
+
+* first release ([5e28e39](https://github.com/satoruk/bullet_log_parser/commit/5e28e39dba70218f4e93de904f53d7018eed4472))

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 satoruk <koyanagi3106@gmail.com>
+
+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,114 @@
+<h1 align="center">bullet log parser</h2>
+
+<p align="center">
+<a href="https://github.com/satoruk/bullet_log_parser/actions?query=workflow%3ACI"><img src="https://github.com/satoruk/bullet_log_parser/workflows/CI/badge.svg" /></a>
+</p>
+
+This parser can help to convert the Bullet logs to prefer format you want.
+
+## Install
+
+```sh
+bundle add bullet_log_parser --group "development, test"
+# or
+gem install bullet_log_parser
+```
+
+## Example
+
+```sh
+cat log/bullet.log | bullet_log_filter.rb
+```
+
+`bullet_log_filter.rb`
+
+```rb
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bullet_log_parser'
+
+if __FILE__ == $PROGRAM_NAME
+  results = BulletLogParser.uniq_log($stdin) do |ast|
+    # skip no call stack
+    next if ast[:stack].empty?
+
+    stack = ast[:stack].last
+    puts "#{stack[:filename]}:#{stack[:lineno]}:#{ast[:level]}"
+    ast[:details].each do |detail|
+      puts "  #{detail}"
+    end
+    puts ''
+  end
+  puts '-- summary ------'
+  puts results
+    .keys
+    .map { |k| "#{k}:#{results[k].size}" }
+    .join("\n")
+end
+
+```
+
+## AST format
+
+<details>
+<summary>ast format example</summary>
+
+```txt
+2020-07-27 02:35:50[WARN] user: root
+GET /posts
+USE eager loading detected
+  Post => [:comments]
+  Add to your query: .includes([:comments])
+Call stack
+  /app/app/views/posts/_post.json.jbuilder:4:in `block in _app_views_posts__post_json_jbuilder__2280256895687227436_47114295576380'
+  /app/app/views/posts/_post.json.jbuilder:3:in `_app_views_posts__post_json_jbuilder__2280256895687227436_47114295576380'
+  /app/app/views/posts/index.json.jbuilder:1:in `_app_views_posts_index_json_jbuilder__4177424529561133656_47114295515920'
+  /app/app/controllers/posts_controller.rb:13:in `index'
+  /app/spec/requests/posts_spec.rb:45:in `block (4 levels) in <main>'
+```
+
+```json
+{
+  "detectedAt": "2020-07-27 02:35:50",
+  "level": "WARN",
+  "user": "root",
+  "request": "GET /posts",
+  "detection": "USE eager loading detected",
+  "details": [
+    "Post => [:comments]",
+    "Add to your query: .includes([:comments])"
+  ],
+  "stack": [
+    {
+      "filename": "/app/app/views/posts/_post.json.jbuilder",
+      "lineno": 4,
+      "message": "in `block in _app_views_posts__post_json_jbuilder__2280256895687227436_47114295576380'"
+    },
+    {
+      "filename": "/app/app/views/posts/_post.json.jbuilder",
+      "lineno": 3,
+      "message": "in `_app_views_posts__post_json_jbuilder__2280256895687227436_47114295576380'"
+    },
+    {
+      "filename": "/app/app/views/posts/index.json.jbuilder",
+      "lineno": 1,
+      "message": "in `_app_views_posts_index_json_jbuilder__4177424529561133656_47114295515920'"
+    },
+    {
+      "filename": "/app/app/controllers/posts_controller.rb",
+      "lineno": 13,
+      "message": "in `index'"
+    },
+    {
+      "filename": "/app/spec/requests/posts_spec.rb",
+      "lineno": 45,
+      "message": "in `block (4 levels) in <main>'"
+    }
+  ]
+}
+```
+
+</details>
+
+[ci badge]: https://github.com/satoruk/bullet_log_parser/workflows/CI/badge.svg

data/bullet_log_parser.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'lib/bullet_log_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bullet_log_parser'
+  spec.version       = BulletLogParser::VERSION
+  spec.authors       = ['satoruk']
+  spec.email         = ['koyanagi3106@gmail.com']
+
+  spec.summary       = 'Bullet log perser.'
+  spec.description   = 'Bullet log perser.'
+  spec.homepage      = 'https://github.com/satoruk/bullet_log_parser/'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  spec.files = %w[CHANGELOG.md LICENSE.txt README.md bullet_log_parser.gemspec]
+  spec.files += Dir.glob('lib/**/*.rb')
+
+  spec.require_paths = ['lib']
+end

data/lib/bullet_log_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'bullet_log_parser/version'
+require 'bullet_log_parser/parser'
+
+module BulletLogParser # :nodoc:
+  def self.generate_bare_ast(ast)
+    bare_ast = ast.reject { |k, _| %i[detectedAt request].include?(k) }
+    bare_ast[:stack] = bare_ast[:stack].map { |stack| stack.reject { |k, _| k == :message } }
+    bare_ast
+  end
+
+  def self.uniq_log(io)
+    memo = Hash.new { |h, k| h[k] = [] }
+    parse(io) do |ast|
+      bare_ast = generate_bare_ast(ast)
+      detection = memo[bare_ast[:detection]]
+      next if detection.include?(bare_ast)
+
+      detection << bare_ast
+      yield ast
+    end
+    memo
+  end
+
+  def self.parse(io)
+    parser = Parser.new
+    loop do
+      str = io.gets
+      break unless str
+
+      parser.puts(str.chomp)
+      next unless parser.terminated?
+
+      yield parser.ast unless parser.failed?
+
+      parser = Parser.new
+    end
+  end
+end

data/lib/bullet_log_parser/parser.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module BulletLogParser # :nodoc:
+  # bullert log persing class
+  class Parser
+    REGEX_CALL_STACK = /\A  (.+):(\d+):(.+)\z/.freeze
+    REGEX_DETAIL = /\A  (.+)\z/.freeze
+    REGEX_LINE1 = /\A(\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\[(\w+)\] user: (.*)\z/.freeze
+
+    def initialize
+      @parse_method = :parse_line1
+      @ast = {}
+      @terminated = false
+      @failed = false
+    end
+
+    attr_reader :ast
+
+    def failed
+      @failed = true
+    end
+
+    def failed?
+      @failed
+    end
+
+    def terminated
+      @terminated = true
+    end
+
+    def terminated?
+      @terminated || @failed
+    end
+
+    def puts(str)
+      perse_proc = method(@parse_method).curry
+      perse_proc.call(str)
+    end
+
+    private
+
+    def parse_line1(str)
+      matched = REGEX_LINE1.match(str)
+      return failed unless matched
+
+      @parse_method = :parse_line2
+      @ast.update({
+                    detectedAt: matched[1],
+                    level: matched[2],
+                    user: matched[3]
+                  })
+    end
+
+    def parse_line2(str)
+      @parse_method = :parse_line_detector
+      return if str.empty?
+
+      @ast.update({ request: str })
+    end
+
+    def parse_line_detector(str)
+      @parse_method = :parse_line_detector_detail
+      return failed if str.empty?
+
+      @ast.update({
+                    detection: str,
+                    details: [],
+                    stack: []
+                  })
+    end
+
+    def parse_line_detector_detail(str)
+      if str == 'Call stack'
+        @parse_method = :parse_line_call_stack_detail
+        return
+      end
+
+      return terminated if str.empty?
+
+      matched = REGEX_DETAIL.match(str)
+      return failed unless matched
+
+      @ast[:details] << matched[1]
+    end
+
+    def parse_line_call_stack_detail(str)
+      return terminated if str.empty?
+
+      matched = REGEX_CALL_STACK.match(str)
+      return failed unless matched
+
+      @ast[:stack] << {
+        filename: matched[1],
+        lineno: matched[2].to_i,
+        message: matched[3]
+      }
+    end
+  end
+end

data/lib/bullet_log_parser/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BulletLogParser
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: bullet_log_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- satoruk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-31 00:00:00.000000000 Z
+dependencies: []
+description: Bullet log perser.
+email:
+- koyanagi3106@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- bullet_log_parser.gemspec
+- lib/bullet_log_parser.rb
+- lib/bullet_log_parser/parser.rb
+- lib/bullet_log_parser/version.rb
+homepage: https://github.com/satoruk/bullet_log_parser/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/satoruk/bullet_log_parser/
+  source_code_uri: https://github.com/satoruk/bullet_log_parser/
+  changelog_uri: https://github.com/satoruk/bullet_log_parser/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Bullet log perser.
+test_files: []