akainaa 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 305e44e37e3cdb6430af4d8bc1135516f8d0fa050af34c84684ec1bc03ace5fd
-  data.tar.gz: 3360375cb4c185139a82c5c3694cb01cd174f3be3a4d45cd58ea7544239bdb09
+  metadata.gz: 6451f71725cda32349ab87402b32e6e132d8185274ba55a930fa2389fdd12279
+  data.tar.gz: 2b40049516aa512d8a89b607d327b1a5571b3c4221e351248d4ac13bbdc31dfd
 SHA512:
-  metadata.gz: a7e609d7142282087b333c4eb842e77c4e8136ec7d90abbed23b4e32afa07541a46c5435ca0402a33c8b1755df1ea99b3aa85edfc8710805dfaf4d3dfbec0ace
-  data.tar.gz: de14f04bbe4c5cf13355311c4550a931128964adf26d8316944adaa8c8e32f6f63bad1a9ae35e73b39489a3c299f8a64d115ae285e4c2ce1b3633d86d1bab63f
+  metadata.gz: f3199e1047c1295040cf043154128fcef145da13815f1cf8b69c84ec4a3237e44c525107ccb97abcc115d9d12f810e40623685843e190bb07cb99f95e35b104d
+  data.tar.gz: 74c12cf59e645eef87f2811d95d584a32ed5ec54b6f75019114c8f595fa206e0121cf7413c87a3b53fb4523f62cc7b45ee004aab467594f4dffd2153af00d045

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.1.2] - 2024-05-06
+
+- Coloring all line of the method which located on multiple lines
+
+## [0.1.1] - 2024-04-28
+
+- Show the most executed file if path query isn't provided
+
 ## [0.1.0] - 2024-03-09
 
 - Initial release

data/README.md

@@ -1,15 +1,15 @@
 # Akainaa (赤いなぁ)
 
-![page view](./img/webui.png)
+![page view](./img/webui-rev02.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.
+Akainaa is a gem to visualize code hotspot based on Coverage.
 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.
 
+You can see actual result view from [here](https://riseshia.github.io/akainaa/isucon13-baseline.html), which recorded on [isucon13](https://github.com/isucon/isucon13/tree/main/webapp/ruby) code in one benchmark run on [ISUNARABE](https://isunarabe.org/). And also [here](https://riseshia.github.io/akainaa/coverage/index.html) is the result of [simplecov-html](https://github.com/simplecov-ruby/simplecov-html)(0.12.3) from same coverage, so you can compare the result.
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:

data/akainaa.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = spec.summary
   spec.homepage = "https://github.com/riseshia/akainaa"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
+  spec.required_ruby_version = ">= 3.2.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   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])
+        f.start_with?(*%w[bin/ test/ sample/ docs/ img/ .git .github Gemfile Rakefile])
     end
   end
   spec.bindir = "exe"

data/lib/akainaa/call_node_visitor.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "prism"
+
+module Akainaa
+  class CallNodeVisitor < Prism::Visitor
+    MethodRange = Data.define(:name, :start_line, :end_line) do
+      def start_line_as_idx
+        start_line - 1
+      end
+
+      def method_row_range_as_idx
+        (start_line - 1)..(end_line - 1)
+      end
+    end
+
+    attr_reader :multiline_method_calls
+
+    def initialize
+      super
+
+      @multiline_method_calls = []
+    end
+
+    def visit_call_node(node)
+      if node.arguments &&
+         node.message_loc.start_line != node.arguments.location&.end_line
+
+        @multiline_method_calls << MethodRange.new(
+          name: node.message,
+          start_line: node.message_loc.start_line,
+          end_line: node.arguments.location.end_line,
+        )
+      end
+
+      super
+    end
+  end
+end

data/lib/akainaa/util.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Akainaa
+  module Util
+    module_function
+
+    # @param [String] source_path
+    # @param [Array<Integer>] lines
+    #
+    # @return [Array<Integer>]
+    def fullfill_multiline_method_calls(source_path, lines)
+      result = Prism.parse_file(source_path)
+      prog_node = result.value
+
+      visitor = ::Akainaa::CallNodeVisitor.new
+      visitor.visit(prog_node)
+
+      fullfilled_lines = lines.dup
+
+      visitor.multiline_method_calls.each do |method_range|
+        call_count = lines[method_range.start_line_as_idx]
+
+        method_range.method_row_range_as_idx.each do |idx|
+          if fullfilled_lines[idx].nil?
+            fullfilled_lines[idx] = call_count
+          elsif fullfilled_lines[idx] < call_count
+            fullfilled_lines[idx] = call_count
+          else
+            # use as it is
+          end
+        end
+      end
+
+      fullfilled_lines
+    end
+  end
+end

data/lib/akainaa/version.rb

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

data/lib/akainaa.rb

@@ -3,6 +3,8 @@
 require 'coverage'
 
 require_relative 'akainaa/version'
+require_relative 'akainaa/call_node_visitor'
+require_relative 'akainaa/util'
 
 module Akainaa
   class Error < StandardError; end
@@ -54,7 +56,7 @@ module Akainaa
 
     private def extract_path_from_query(env)
       matched = env['QUERY_STRING'].match(/path=([^&]+)/)
-      matched ? matched[1] : 'app.rb'
+      matched ? matched[1] : nil
     end
 
     private def render_line(lineno, code, count, count_top)
@@ -74,13 +76,10 @@ module Akainaa
       HTML
     end
 
-    private def render_filelist(coverage_result, current_path:)
+    private def render_filelist(coverage_result, summary:, 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
+      max_count_on_proj = summary.max_count_on_proj
+      max_count_width = 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
@@ -89,7 +88,7 @@ module Akainaa
         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>
+          <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_width)}) #{file}</a>
           </li>
         HTML
       end.join
@@ -110,9 +109,25 @@ module Akainaa
       HTML
     end
 
+    CoverageSummary = Data.define(:file_path_has_max_count, :max_count_on_proj)
+
+    private def generate_summary(coverage_result)
+      file_path_has_max_count = coverage_result.max_by { |_, cv| cv[:lines].reject(&:nil?).sum }.first
+      max_count_on_proj = coverage_result
+        .values
+        .map { |cv| cv[:lines].reject(&:nil?).sum }
+        .max + 1
+
+      CoverageSummary.new(file_path_has_max_count:, max_count_on_proj:)
+    end
+
     private def render_page(path)
       result = Akainaa.peek_result
 
+      summary = generate_summary(result)
+
+      path = summary.file_path_has_max_count if path.nil?
+
       path_result = result[path]
 
       if path_result.nil?
@@ -123,7 +138,7 @@ module Akainaa
         return "<" + "p>#{path} not found.<" + "/p>"
       end
 
-      coverage_on_line = path_result[:lines]
+      coverage_on_line = Akainaa::Util.fullfill_multiline_method_calls(path, path_result[:lines])
       max_count_on_file = coverage_on_line.reject(&:nil?).max + 1
 
       lines = []
@@ -135,7 +150,7 @@ module Akainaa
         lines << line
       end
 
-      filelist = render_filelist(result, current_path: path)
+      filelist = render_filelist(result, summary:, current_path: path)
 
       <<~HTML
         <!DOCTYPE html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akainaa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Shia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-14 00:00:00.000000000 Z
+date: 2024-05-06 00:00:00.000000000 Z
 dependencies: []
 description: Minimum rack middleware for coverage
 email:
@@ -20,20 +20,11 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - akainaa.gemspec
-- img/webui.png
 - lib/akainaa.rb
+- lib/akainaa/call_node_visitor.rb
+- lib/akainaa/util.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
@@ -49,7 +40,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Rakefile

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-task default: %i[]

data/sample/.ruby-version

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

data/sample/Gemfile

@@ -1,10 +0,0 @@
-# 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

@@ -1,48 +0,0 @@
-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

@@ -1,30 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

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

data/sample/theme.rb

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

data/sample/user.rb

@@ -1,15 +0,0 @@
-# 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

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