akainaa 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc10c4417757005abc7cd862c8263c8ded74c7e732a36d804e45e5074eec10fa
-  data.tar.gz: fdb9d8e1a6c557ea32c689b6018007946c8aefba079d2d5061ce288f1919ffc8
+  metadata.gz: a6602589d81aa7812d340812b17c6cc253356605aaf40fc3746aa1ab409b0d94
+  data.tar.gz: f4c7d56da714844abb1dc8f8a9977b3cb14065d2eec7c852e9b1aa902f212cff
 SHA512:
-  metadata.gz: 382116ed544283e771041aa23c05d99c3563323fd19fb7ba5e5b44335e14bf129f3064ce1e2654649c6d6c284fe3d8927abe950a6653337ef4ac794d10a48674
-  data.tar.gz: c49f13dc981530dd9c76869f4d6964b8b3bd58f4727628c565c9d1bec13f58bd44f2d2ed9a0ded5b7274d3ca0523167eeea9ab25cdb51b7e5003508bb3a8950c
+  metadata.gz: 21b88780fb3299dc630d3aa83dc0a7fa8cc94d486e908c54c3681c87d3ac619eef2cdf71c646f6aa71d01016b64573de338cbc09f8a8b3367f836902a74571b8
+  data.tar.gz: 7239bd4af6b74ee056ac78959b8220a2bebddadcc4b0bc6a21f58ad7bb5471c44f51810032b56912e3c3c4743baadaf530235b11f10930915fcdeed7bd27dc83

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased]
 
+## [0.1.5] - 2024-09-10
+
+- Bug fix: nested method call won't handled
+- Bug fix: Empty 302 response body on /akainaa/reset
+- Feature: Add `ignore_glob_patterns` option to `Akainaa.start` method
+- Feature: Add `hide_not_executed_files` option to `Akainaa.start` method
+- Feature: Add `online_emit` option to `Akainaa.start` method
+
+## [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,6 +1,6 @@
-# Akainaa (赤いなぁ)
+# Akainaa (赤いなぁ、 It's red...)
 
-![page view](./img/webui.png)
+![page view](./img/webui-rev02.png)
 
 Akainaa is a gem to visualize code hotspot based on Coverage.
 This gem can be used for the following purposes:
@@ -8,7 +8,7 @@ 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/).
+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
 
@@ -28,7 +28,13 @@ Here is example:
 ```ruby
 require 'akainaa'
 
-Akainaa.start(project_dir: File.expand_path(__dir__))
+Akainaa.start(
+  project_dir: File.expand_path(__dir__),
+  ignore_glob_patterns: %w[
+    config/application.rb
+    config/initializers/*_initializer.rb
+  ],
+)
 
 require_relative 'app'
 
@@ -39,6 +45,26 @@ run App
 Boot up application, do something, and access `/akainaa`.
 It will show Web UI what and how many executed.
 
+### Enable online emit mode
+
+Akainaa can emit coverage data which recorded in interval to the file.
+This feature is intended to be used with vscode-akainaa extension.
+
+```ruby
+Akainaa.start(
+  project_dir: File.expand_path(__dir__),
+  ignore_glob_patterns: %w[
+    config/application.rb
+    config/initializers/*_initializer.rb
+  ],
+  online_emit: {
+    mode: :file,
+    interval: 1, # seconds
+    output_path: '/tmp/akainaa.json',
+  },
+)
+```
+
 ## 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.

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,38 @@
+# 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]
+        next if call_count.nil?
+
+        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.1"
+  VERSION = "0.1.5"
 end

data/lib/akainaa.rb

@@ -1,31 +1,100 @@
 # frozen_string_literal: true
 
 require 'coverage'
+require 'fileutils'
 
 require_relative 'akainaa/version'
+require_relative 'akainaa/call_node_visitor'
+require_relative 'akainaa/util'
 
 module Akainaa
   class Error < StandardError; end
 
   class << self
-    attr_accessor :project_dir
-
-    def start(project_dir:)
+    attr_accessor :project_dir, :ignore_files, :hide_not_executed_files
+
+    def start(
+      project_dir:,
+      ignore_glob_patterns: [],
+      hide_not_executed_files: false,
+      online_emit: nil
+    )
       @project_dir = project_dir
       @project_dir += '/' unless @project_dir.end_with?('/')
+      ignore_files = ignore_glob_patterns.flat_map do |pattern|
+        Dir["#{@project_dir}#{pattern}"].to_a
+      end
+      @ignore_files = Set.new(ignore_files)
+      @hide_not_executed_files = hide_not_executed_files
+      @monitor = Monitor.new
 
       Coverage.start(lines: true)
+
+      if online_emit.is_a?(Hash)
+        option = default_online_emit.merge(online_emit)
+        FileUtils.mkdir_p(File.dirname(option[:path]))
+        start_multipart_emit(option)
+      end
     end
 
     def peek_result
       Coverage
         .peek_result
         .select { |k, _v| k.start_with?(project_dir) }
+        .reject { |k, _v| ignore_files.member?(k) }
         .transform_keys { |k| k.sub(project_dir, '') }
     end
 
     def reset
-      Coverage.result(stop: false, clear: true)
+      @monitor.synchronize do
+        Coverage.result(stop: false, clear: true)
+        @previous_result = {}
+      end
+    end
+
+    private def default_online_emit
+      {
+        mode: :file,
+        interval: 1,
+        path: 'tmp/coverage.json',
+      }
+    end
+
+    private def start_multipart_emit(option)
+      Thread.new do
+        @monitor.synchronize do
+          @previous_result = {}
+        end
+
+        loop do
+          sleep option[:interval]
+          current_result = peek_result
+
+          diff = {}
+          current_result.each do |path, path_coverage|
+            previous_path_coverage = @previous_result[path]
+
+            if previous_path_coverage.nil?
+              diff[path] = path_coverage
+            elsif previous_path_coverage[:lines].size != path_coverage[:lines].size
+              diff[path] = path_coverage
+            else
+              diff[path] = { lines: [] }
+
+              path_coverage[:lines].each_with_index do |count, index|
+                val = count ? count - previous_path_coverage[:lines][index] : nil
+
+                diff[path][:lines] << val
+              end
+            end
+          end
+
+          @monitor.synchronize do
+            @previous_result = current_result
+          end
+          File.write(option[:path], diff.to_json)
+        end
+      end
     end
   end
 
@@ -46,7 +115,7 @@ module Akainaa
         path = extract_path_from_query(env)
         Akainaa.reset
 
-        [302, { 'Location' => "/akainaa?path=#{path}" }, [html]]
+        [302, { 'Location' => "/akainaa?path=#{path}" }, []]
       else
         @app.call(env)
       end
@@ -81,6 +150,8 @@ module Akainaa
 
       li_elements = files.sort.map do |file|
         total_count_on_file = coverage_result[file][:lines].reject(&:nil?).sum
+        next '' if Akainaa.hide_not_executed_files && total_count_on_file == 0
+
         count_top = (total_count_on_file * 10 / max_count_on_proj).to_i * 10
 
         class_suffix = file == current_path ? ' current' : ''
@@ -136,7 +207,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 = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akainaa
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Shia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-28 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies: []
 description: Minimum rack middleware for coverage
 email:
@@ -20,21 +20,11 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
-- Rakefile
 - akainaa.gemspec
-- docs/isucon13-baseline.html
-- 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
@@ -50,14 +40,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Minimum rack middleware for coverage

data/Rakefile

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