emoji_log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d56a86c32047fa7df7c1c30e0d6077d693db86ea6410396c840f5b30a7acc97c
+  data.tar.gz: 7e839f2823b5f142a73a70bcb7a882587d24cbbb0b2aab88b3b75417b90477d3
+SHA512:
+  metadata.gz: 42de46414b0ab4526c06ac6431ce6ebe378b4a725e397ebdc4f8d45a73c848c9015a575f5c56e9cdec8ff9f23f9edde2f851f79b14c4a5ef939d4c37e3a12259
+  data.tar.gz: 139c91f6eaa263e09101ca1567102b3723eaeb8ea62c8fe50b51a2b2a9b19e7b2abda189fe184dfc9f66cf31344de5d4e695b571b84256121345b122d31e9562

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 JP Camara
+
+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,50 @@
+# EmojiLog
+
+A LogSubscriber for Rails that modifies controller logs with emojis to represent performance (🐢, 🐇, 🚀) and http status codes (🧠, ✅, 🔁, ❌, 🔥, ❓).
+
+Inspired by an episode of the Syntax podcast.
+
+> I wrote this really nice little handy middleware... that analyzes all my requests as they go, just timing them - and based on how long the request takes it gives me different emoji. So if the request is really fast it's a 🚀, if it's kinda fast it's a 🐇, if it's slow it's a 🐢. ...In my console while I'm just browsing the site I can just see - and it has what type of request, what path it was too, and it's just like at a glance I can see - 'oh I'm in turtle time right now - these requests to this page are all slow for some reason let me take a look'
+>
+> Scott Tolinski
+> Syntax Podcast, Episode 570 - https://syntax.fm/show/570/node-js-cjs-esm
+
+## Usage
+
+```rb
+config.after_initialize do
+  EmojiLog.slow = "🐢"
+  EmojiLog.average = "🐇"
+  EmojiLog.fast = "🚀"
+  EmojiLog.slow_threshold = 1000
+  EmojiLog.average_threshold = 500
+  EmojiLog.fast_threshold = 150
+
+  EmojiLog.info = "🧠"
+  EmojiLog.success = "✅"
+  EmojiLog.redirect = "🔁"
+  EmojiLog.bad = "❌"
+  EmojiLog.error = "🔥"
+  EmojiLog.cancelled = "❓"
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "emoji_log"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install emoji_log
+```
+
+## 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,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/javascripts/emoji_log.js

@@ -0,0 +1,41 @@
+(function () {
+  const origOpen = XMLHttpRequest.prototype.open;
+  XMLHttpRequest.prototype.open = function () {
+    const start = new Date();
+    const url = arguments[1];
+    this.addEventListener(`load`, () => {
+      const end = new Date().getTime() - start.getTime();
+      // logTiming(url, end, this.status);
+    });
+    origOpen.apply(this, arguments);
+  };
+})();
+
+function logTiming(url, end, statusCode) {
+  const status = statusEmoji(statusCode);
+  if (end <= 200) {
+    console.log(url, `🚀`, `${end}ms`, status);
+  } else if (end <= 500) {
+    console.log(url, `🐇`, `${end}ms`, status);
+  } else {
+    console.log(url, `🐢`, `${end}ms`, status);
+  }
+}
+
+// eslint-disable-next-line complexity
+function statusEmoji(status) {
+  if (status < 100) {
+    return `❓`;
+  } else if (status < 200) {
+    return `🧠`;
+  } else if (status < 300) {
+    return `✅`;
+  } else if (status < 400) {
+    return `🔄`;
+  } else if (status < 500) {
+    return `❌`;
+  } else if (status < 600) {
+    return `🔥`;
+  }
+  return ``;
+}

data/lib/emoji_log/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+require 'action_view/log_subscriber'
+require 'action_controller/log_subscriber'
+
+module EmojiLog
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do |app|
+      EmojiLog.setup(app)
+    end
+  end
+end

data/lib/emoji_log/version.rb

@@ -0,0 +1,3 @@
+module EmojiLog
+  VERSION = '0.1.0'
+end

data/lib/emoji_log.rb

@@ -0,0 +1,90 @@
+require "emoji_log/version"
+require "emoji_log/railtie"
+
+module EmojiLog
+  def self.setup(app)
+    # self.application = app
+    EmojiLog.slow = "🐢"
+    EmojiLog.average = "🐇"
+    EmojiLog.fast = "🚀"
+    EmojiLog.slow_threshold = 1000
+    EmojiLog.average_threshold = 500
+    EmojiLog.fast_threshold = 150
+
+    EmojiLog.info = "🧠"
+    EmojiLog.success = "✅"
+    EmojiLog.redirect = "🔁"
+    EmojiLog.bad = "❌"
+    EmojiLog.error = "🔥"
+    EmojiLog.cancelled = "❓"
+
+    ::EmojiLog::ActionController.attach_to :action_controller
+  end
+
+  class << self
+    attr_accessor :slow, :average, :fast, :slow_threshold, :average_threshold, :fast_threshold,
+      :info, :success, :redirect, :bad, :error, :cancelled
+  end
+
+  class ActionController < ActiveSupport::LogSubscriber
+    ONE = 100...199
+    TWO = 200...299
+    THREE = 300...399
+    FOUR = 400...499
+    FIVE = 500...599
+
+    def process_action(event)
+      info do
+        payload = event.payload
+        additions = ::ActionController::Base.log_process_action(payload)
+        status = payload[:status]
+
+        if status.nil? && (exception_class_name = payload[:exception]&.first)
+          status = ::ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+        end
+
+        additions << "Allocations: #{event.allocations}"
+
+        speed_emoji = emoji_speed(event)
+        status_emoji = emoji_status(status)
+        
+        message = +"#{speed_emoji * 3} [#{payload[:path]}] Completed #{status} #{Rack::Utils::HTTP_STATUS_CODES[status]}#{status_emoji} in #{event.duration.round}ms" \
+                   " (#{additions.join(" | ")})"
+        message << "\n\n" if defined?(::Rails.env) && ::Rails.env.development?
+
+        message
+      end
+    end
+
+    def emoji_status(status)
+      case status
+      when ONE
+        " #{EmojiLog.info}"
+      when TWO
+        " #{EmojiLog.success}"
+      when THREE
+        " #{EmojiLog.redirect}"
+      when FOUR
+        " #{EmojiLog.bad}"
+      when FIVE
+        " #{EmojiLog.error}"
+      when 0
+        " #{EmojiLog.cancelled}"
+      else
+        ""
+      end
+    end
+
+    def emoji_speed(event)
+      if event.duration <= EmojiLog.fast_threshold
+        EmojiLog.fast
+      elsif event.duration <= EmojiLog.average_threshold
+        EmojiLog.average
+      else
+        EmojiLog.slow
+      end
+    end
+  end
+end
+
+require 'emoji_log/railtie' if defined?(Rails)

data/lib/tasks/emoji_log_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :emoji_log do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: emoji_log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JP Camara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Quickly scan your logs using the power of emojis.
+email:
+- 48120+jpcamara@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/emoji_log.js
+- lib/emoji_log.rb
+- lib/emoji_log/railtie.rb
+- lib/emoji_log/version.rb
+- lib/tasks/emoji_log_tasks.rake
+homepage: https://github.com/jpcamara/emoji_log
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jpcamara/emoji_log
+  source_code_uri: https://github.com/jpcamara/emoji_log
+  changelog_uri: https://github.com/jpcamara/emoji_log
+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: []
+rubygems_version: 3.4.6
+signing_key:
+specification_version: 4
+summary: Quickly scan your logs using the power of emojis.
+test_files: []