slow-events 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4b161e8f080cb2423edea1700f15e125532423f3162d763253b80809995793a4
+  data.tar.gz: 9ddff22176cc33e015527e05f62f9e706d47ed9c5d59a49556c2e1f4e600e32d
+SHA512:
+  metadata.gz: d6063b5da94d7818fd3201bbafeacb336f732c226ef8a348c1c6fb576f97af5b97f37e5802aa5d3b5a24af5b83b934e8ebcec9fd5df027f6cf8c3f205c28dfd6
+  data.tar.gz: c64356e7d768f0139ee42097103f0aadd7301762056dbaaaab3340ad6cfa2fc1a49045da06528f0c6c7f4a03df7aba0196e59186b357f6fdbab506167d07dd7f

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_from: .rubocop_todo.yml
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 130
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent

data/.rubocop_todo.yml

@@ -0,0 +1,40 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-06-13 09:20:07 UTC using RuboCop version 0.89.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 122
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/slow/events.rb'
+
+# Offense count: 5
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/generators/slow/events/config_generator.rb'
+    - 'lib/slow/events.rb'
+    - 'lib/slow/events/config.rb'
+    - 'lib/slow/events/format.rb'
+    - 'lib/slow/events/log_subscriber.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 122

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slow-query.gemspec
+gemspec
+
+gem 'rails', '>= 4.0.0'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 0.80'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Khoa Nguyen
+
+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,62 @@
+# Slow::Events
+This GEM will support U to optimizing your Rails app, easy to see the slow events in Rails log.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slow-events'
+```
+
+And then execute:
+```
+$ bundle install
+```
+
+Or install it yourself as:
+```
+$ gem install slow-events
+```
+
+## Usage
+
+- You can custom the setting.
+```
+$ rails generate slow:events:config
+```
+
+And change the your setting in `config/initializers/slow_events.rb` file.
+
+#### Change the Prefix
+- Default is `Slow Event:` and you can change to anything
+```ruby
+config.prefix = 'Bad events:'
+```
+
+#### Change the Duration value
+- Default is `500ms`, and minimum is `50ms`
+```ruby
+config.alert_duration = 300
+```
+
+#### Change the Alert color
+- Default is `YELLOW`
+- Supported colors: `YELLOW`, `RED`, `GREEN`, `BLUE`, `MAGENTA`, `CYAN`, `WHITE`
+```ruby
+config.alert_color = ::Slow::Events::Format::BLUE
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/ThanhKhoaIT/slow-events.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'slow/events'
+
+# 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(__FILE__)

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/lib/generators/slow/events/config_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Slow
+  module Events
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __dir__)
+
+        def copy_initializer
+          template 'config.rb', 'config/initializers/slow_events.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/slow/templates/config.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Slow::Events.config do |config|
+  # config.prefix = 'Slow Event:'
+
+  # config.alert_duration = 300 # Default: 500ms
+
+  # config.alert_color = ::Slow::Events::Format::YELLOW
+  # Color options: YELLOW,RED,GREEN,BLUE,MAGENTA,CYAN,WHITE
+end

data/lib/slow/events/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Slow
+  module Events
+    class Config
+      attr_reader :prefix
+      attr_reader :alert_duration
+      attr_reader :alert_color
+
+      def initialize
+        @prefix = 'Slow Event:'
+        @alert_color = Slow::Events::Format::YELLOW # Default: Red
+        @alert_duration = 500 # Default: 500ms
+      end
+
+      attr_writer :prefix
+
+      def alert_color=(value)
+        @alert_color = value || Slow::Events::Format::YELLOW
+      end
+
+      def alert_duration=(value)
+        @alert_duration = [value, 50].max # Minimum: 50ms
+      end
+    end
+  end
+end

data/lib/slow/events/format.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Slow
+  module Events
+    class Format
+      CLEAR   = "\e[0m"
+      BOLD    = "\e[1m"
+
+      RED     = "\e[31m"
+      GREEN   = "\e[32m"
+      YELLOW  = "\e[33m"
+      BLUE    = "\e[34m"
+      MAGENTA = "\e[35m"
+      CYAN    = "\e[36m"
+      WHITE   = "\e[37m"
+
+      def self.build_message(duration, text)
+        [
+          CLEAR,
+          BOLD,
+          RED,
+          Slow::Events.config.prefix,
+          "(#{duration.round(2)}ms)",
+          Slow::Events.config.alert_color,
+          text,
+          CLEAR
+        ].join(' ')
+      end
+    end
+  end
+end

data/lib/slow/events/log_subscriber.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Slow
+  module Events
+    class LogSubscriber < ::ActiveRecord::LogSubscriber
+      def sql(event)
+        return if event.duration < Slow::Events.config.alert_duration
+
+        debug Slow::Events::Format.build_message(event.duration, event.payload[:name] || event.payload[:sql] || 'Unknown')
+      end
+
+      attach_to :active_record
+    end
+  end
+end

data/lib/slow/events/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Slow
+  module Events
+    VERSION = '0.1.0'
+  end
+end

data/lib/slow/events.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'events/version'
+require_relative 'events/config'
+require_relative 'events/format'
+require_relative 'events/log_subscriber'
+
+module Slow::Events
+  def self.config
+    @config ||= Slow::Events::Config.new
+    yield(@config) if block_given?
+    @config
+  end
+end

data/slow-events.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/slow/events/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'slow-events'
+  spec.version       = Slow::Events::VERSION
+  spec.authors       = ['Khoa Nguyen']
+  spec.email         = ['thanhkhoait@gmail.com']
+
+  spec.summary       = 'Easy to see the Slow events in Rails logs'
+  spec.description   = 'This GEM will support U in optimizing your Rails app, easy to see the slow events in the Rails log.'
+  spec.homepage      = 'https://github.com/ThanhKhoaIT/slow-events'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ThanhKhoaIT/slow-events'
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: slow-events
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Khoa Nguyen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-13 00:00:00.000000000 Z
+dependencies: []
+description: This GEM will support U in optimizing your Rails app, easy to see the
+  slow events in the Rails log.
+email:
+- thanhkhoait@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/slow/events/config_generator.rb
+- lib/generators/slow/templates/config.rb
+- lib/slow/events.rb
+- lib/slow/events/config.rb
+- lib/slow/events/format.rb
+- lib/slow/events/log_subscriber.rb
+- lib/slow/events/version.rb
+- slow-events.gemspec
+homepage: https://github.com/ThanhKhoaIT/slow-events
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ThanhKhoaIT/slow-events
+  source_code_uri: https://github.com/ThanhKhoaIT/slow-events
+  changelog_uri: https://github.com/ThanhKhoaIT/slow-events
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Easy to see the Slow events in Rails logs
+test_files: []