akainaa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 305e44e37e3cdb6430af4d8bc1135516f8d0fa050af34c84684ec1bc03ace5fd
+  data.tar.gz: 3360375cb4c185139a82c5c3694cb01cd174f3be3a4d45cd58ea7544239bdb09
+SHA512:
+  metadata.gz: a7e609d7142282087b333c4eb842e77c4e8136ec7d90abbed23b4e32afa07541a46c5435ca0402a33c8b1755df1ea99b3aa85edfc8710805dfaf4d3dfbec0ace
+  data.tar.gz: de14f04bbe4c5cf13355311c4550a931128964adf26d8316944adaa8c8e32f6f63bad1a9ae35e73b39489a3c299f8a64d115ae285e4c2ce1b3633d86d1bab63f

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-09
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Shia
+
+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 @@
+# Akainaa (赤いなぁ)
+
+![page view](./img/webui.png)
+
+Akainaa is a gem that employs the Coverage library to record
+the number of executed count of code in a rack application
+and provides a Web UI that shows the recorded status.
+This gem can be used for the following purposes:
+
+- super rough code profiler: The intensity of the red background for each line is proportional to the number of times it has been executed.
+- A tool helps to understand what happened in a request: Akainaa have the reset button on Web UI, so user can easily record code execution for only one request.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add akainaa
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install akainaa
+
+## Usage
+
+call `Akainaa.start` before your application load, and mount middleware.
+Here is example:
+
+```ruby
+require 'akainaa'
+
+Akainaa.start(project_dir: File.expand_path(__dir__))
+
+require_relative 'app'
+
+use Akainaa::Middleware
+run App
+```
+
+Boot up application, do something, and access `/akainaa`.
+It will show Web UI what and how many executed.
+
+## 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/riseshia/akainaa.
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/akainaa.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/akainaa/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "akainaa"
+  spec.version = Akainaa::VERSION
+  spec.authors = ["Shia"]
+  spec.email = ["rise.shia@gmail.com"]
+
+  spec.summary = "Minimum rack middleware for coverage"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/riseshia/akainaa"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  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, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/akainaa/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Akainaa
+  VERSION = "0.1.0"
+end

data/lib/akainaa.rb

@@ -0,0 +1,272 @@
+# frozen_string_literal: true
+
+require 'coverage'
+
+require_relative 'akainaa/version'
+
+module Akainaa
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :project_dir
+
+    def start(project_dir:)
+      @project_dir = project_dir
+      @project_dir += '/' unless @project_dir.end_with?('/')
+
+      Coverage.start(lines: true)
+    end
+
+    def peek_result
+      Coverage
+        .peek_result
+        .select { |k, _v| k.start_with?(project_dir) }
+        .transform_keys { |k| k.sub(project_dir, '') }
+    end
+
+    def reset
+      Coverage.result(stop: false, clear: true)
+    end
+  end
+
+  class Middleware
+    PADDING = 4
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if env['PATH_INFO'] == '/akainaa'
+        path = extract_path_from_query(env)
+        html = render_page(path)
+
+        [200, { 'Content-Type' => 'text/html;charset=utf-8' }, [html]]
+      elsif env['PATH_INFO'] == '/akainaa/reset'
+        path = extract_path_from_query(env)
+        Akainaa.reset
+
+        [302, { 'Location' => "/akainaa?path=#{path}" }, [html]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private def extract_path_from_query(env)
+      matched = env['QUERY_STRING'].match(/path=([^&]+)/)
+      matched ? matched[1] : 'app.rb'
+    end
+
+    private def render_line(lineno, code, count, count_top)
+      <<~HTML
+        <div class="line pure-g count-p#{count_top}">
+          <div class="executed-count pure-u-2-24">
+            <p>#{count}</p>
+          </div>
+          <div class="lineno pure-u-2-24">
+            <p>#{lineno}:</p>
+          </div>
+          <div class="code pure-u-20-24">
+            <pre class="code language-ruby">#{code}</pre>
+            </code>
+          </div>
+        </div>
+      HTML
+    end
+
+    private def render_filelist(coverage_result, current_path:)
+      files = coverage_result.keys
+      max_count_on_proj = coverage_result
+        .values
+        .map { |cv| cv[:lines].reject(&:nil?).sum }
+        .max + 1
+      max_count_witdh = max_count_on_proj.to_s.size
+
+      li_elements = files.sort.map do |file|
+        total_count_on_file = coverage_result[file][:lines].reject(&:nil?).sum
+        count_top = (total_count_on_file * 10 / max_count_on_proj).to_i * 10
+
+        class_suffix = file == current_path ? ' current' : ''
+        <<~HTML
+          <li class="pure-menu-item">
+          <a href="/akainaa?path=#{file}" class="pure-menu-link filepath#{class_suffix} count-p#{count_top}"">(#{total_count_on_file.to_s.rjust(max_count_witdh)}) #{file}</a>
+          </li>
+        HTML
+      end.join
+
+      <<~HTML
+        <div>
+          <div class="pure-menu">
+            <span class="pure-menu-heading">赤いなぁ</span>
+            <ul class="pure-menu-list">
+              <li class="pure-menu-item">
+                <a href="/akainaa/reset" class="pure-button pure-button-primary">Reset</a>
+              </li>
+              <li class="pure-menu-heading">Files</li>
+              #{li_elements}
+            </ul>
+          </div>
+        </div>
+      HTML
+    end
+
+    private def render_page(path)
+      result = Akainaa.peek_result
+
+      path_result = result[path]
+
+      if path_result.nil?
+        return "There is emtpy result for #{path}"
+      end
+
+      unless File.exist?(path)
+        return "<" + "p>#{path} not found.<" + "/p>"
+      end
+
+      coverage_on_line = path_result[:lines]
+      max_count_on_file = coverage_on_line.reject(&:nil?).max + 1
+
+      lines = []
+      File.read(path).each_line.with_index do |line, index|
+        count = coverage_on_line[index].to_i
+        count_top = (count * 10 / max_count_on_file).to_i * 10
+        line = render_line(index + 1, line, coverage_on_line[index], count_top)
+
+        lines << line
+      end
+
+      filelist = render_filelist(result, current_path: path)
+
+      <<~HTML
+        <!DOCTYPE html>
+        <html>
+          <head>
+            <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/purecss@3.0.0/build/pure-min.css" integrity="sha384-X38yfunGUhNzHpBaEBsWLO+A0HDYOQi8ufWDkZ0k9e0eXz/tH3II7uKZ9msv++Ls" crossorigin="anonymous">
+            <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css">
+            <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/styles/a11y-light.min.css">
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
+            <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/ruby.min.js"></script>
+            <style>
+              .sidebar {
+                background-color: #eee;
+              }
+
+              .pure-menu-heading {
+                font-weight: bold;
+              }
+
+              .line {
+                line-height: 20px;
+              }
+
+              .executed-count, .lineno {
+                text-align: right;
+              }
+
+              p {
+                padding: 0 5 0 5;
+                margin: 0px;
+              }
+
+              pre.code {
+                margin: 0px;
+                background: transparent;
+              }
+
+              a.filepath {
+                text-wrap: balance;
+                word-break: break-all;
+                color: #000;
+              }
+              a.filepath.current {
+                font-weight: bold;
+              }
+
+              div.count-p90 {
+                background-color: #ff392e;
+              }
+              div.count-p90:hover {
+                background-color: #fedcda;
+              }
+              div.count-p80 {
+                background-color: #ff5047;
+              }
+              div.count-p80:hover {
+                background-color: #fedcda;
+              }
+              div.count-p70 {
+                background-color: #ff675f;
+              }
+              div.count-p70:hover {
+                background-color: #fedcda;
+              }
+              div.count-p60 {
+                background-color: #ff7f78;
+              }
+              div.count-p50 {
+                background-color: #ff9690;
+              }
+              div.count-p40 {
+                background-color: #ffada9;
+              }
+              div.count-p30 {
+                background-color: #fec4c1;
+              }
+              div.count-p20 {
+                background-color: #fedcda;
+              }
+              div.count-p10, div.count-p0 {
+                background-color: #ffffff;
+              }
+              .pure-menu-item > a.count-p90 {
+                background-color: #ff392e;
+              }
+              .pure-menu-item > a.count-p80 {
+                background-color: #ff5047;
+              }
+              .pure-menu-item > a.count-p70 {
+                background-color: #ff675f;
+              }
+              .pure-menu-item > a.count-p60 {
+                background-color: #ff7f78;
+              }
+              .pure-menu-item > a.count-p50 {
+                background-color: #ff9690;
+              }
+              .pure-menu-item > a.count-p40 {
+                background-color: #ffada9;
+              }
+              .pure-menu-item > a.count-p30 {
+                background-color: #ffffff;
+              }
+              .pure-menu-item > a.count-p20 {
+                background-color: #ffffff;
+              }
+              .pure-menu-item > a.count-p10 {
+                background-color: #ffffff;
+              }
+              .pure-menu-item > a.count-p0 {
+                background-color: #ffffff;
+              }
+            </style>
+          </head>
+          <body>
+            <div id="layout" class="pure-g">
+              <div class="sidebar pure-u-1-4">
+                #{filelist}
+              </div>
+              <div class="content pure-u-3-4">
+                #{lines.join("\n")}
+              </div>
+            </div>
+            <script>
+              document.querySelectorAll('pre.code').forEach(el => {
+                hljs.highlightElement(el);
+              });
+            </script>
+          </body>
+        </html>
+      HTML
+    end
+  end
+end

data/sample/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/sample/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "sinatra", "~> 4.0"
+gem "sinatra-contrib", "~> 4.0"
+
+gem "puma", "~> 6.4"
+
+gem "akainaa", path: "../"

data/sample/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: ..
+  specs:
+    akainaa (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    base64 (0.2.0)
+    multi_json (1.15.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.7.0)
+    puma (6.4.2)
+      nio4r (~> 2.0)
+    rack (3.0.9.1)
+    rack-protection (4.0.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    ruby2_keywords (0.0.5)
+    sinatra (4.0.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.0.0)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
+    sinatra-contrib (4.0.0)
+      multi_json (>= 0.0.2)
+      mustermann (~> 3.0)
+      rack-protection (= 4.0.0)
+      sinatra (= 4.0.0)
+      tilt (~> 2.0)
+    tilt (2.3.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  akainaa!
+  puma (~> 6.4)
+  sinatra (~> 4.0)
+  sinatra-contrib (~> 4.0)
+
+BUNDLED WITH
+   2.5.3

data/sample/app.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+require 'sinatra/json'
+require 'securerandom'
+
+require_relative './user'
+require_relative './notification'
+require_relative './util'
+
+class App < Sinatra::Base
+  enable :logging
+
+  get '/api/me' do
+    1.times { Util.do_something }
+    2.times { Util.do_something }
+    3.times { Util.do_something }
+    4.times { Util.do_something }
+    5.times { Util.do_something }
+    6.times { Util.do_something }
+    7.times { Util.do_something }
+    8.times { Util.do_something }
+    9.times { Util.do_something }
+    10.times { Util.do_something }
+
+    json(
+      name: "riseshia",
+    )
+  end
+end

data/sample/config.ru

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'akainaa'
+
+Akainaa.start(project_dir: File.expand_path(__dir__))
+
+require_relative 'app'
+
+use Akainaa::Middleware
+run App

data/sample/notification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Notification
+  50.times { nil }
+
+  module_function
+
+  def where(id:) = []
+end

data/sample/theme.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Theme
+  40.times { nil }
+  module_function
+
+  def find_by(user_id:)
+    "light"
+  end
+end

data/sample/user.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative './theme'
+
+module User
+  30.times { nil }
+  module_function
+
+  def find(id)
+    {
+      id: id,
+      theme: Theme.find_by(user_id: id),
+    }
+  end
+end

data/sample/util.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Util
+  module_function
+
+  def do_something = []
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: akainaa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-03-14 00:00:00.000000000 Z
+dependencies: []
+description: Minimum rack middleware for coverage
+email:
+- rise.shia@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- akainaa.gemspec
+- img/webui.png
+- lib/akainaa.rb
+- lib/akainaa/version.rb
+- sample/.ruby-version
+- sample/Gemfile
+- sample/Gemfile.lock
+- sample/app.rb
+- sample/config.ru
+- sample/notification.rb
+- sample/theme.rb
+- sample/user.rb
+- sample/util.rb
+homepage: https://github.com/riseshia/akainaa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/riseshia/akainaa
+  source_code_uri: https://github.com/riseshia/akainaa
+  changelog_uri: https://github.com/riseshia/akainaa/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+signing_key: 
+specification_version: 4
+summary: Minimum rack middleware for coverage
+test_files: []