akainaa 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6451f71725cda32349ab87402b32e6e132d8185274ba55a930fa2389fdd12279
-  data.tar.gz: 2b40049516aa512d8a89b607d327b1a5571b3c4221e351248d4ac13bbdc31dfd
+  metadata.gz: 423527610c1fbb25d01ddfb555e6ea40f8a943001b04dc399682937353529a23
+  data.tar.gz: 70aab5713abf80fc2dd41783fb56b6e223d2d2549438640ca4916bf2f413cba6
 SHA512:
-  metadata.gz: f3199e1047c1295040cf043154128fcef145da13815f1cf8b69c84ec4a3237e44c525107ccb97abcc115d9d12f810e40623685843e190bb07cb99f95e35b104d
-  data.tar.gz: 74c12cf59e645eef87f2811d95d584a32ed5ec54b6f75019114c8f595fa206e0121cf7413c87a3b53fb4523f62cc7b45ee004aab467594f4dffd2153af00d045
+  metadata.gz: 35978a5f110960e9c5f37e5d025efb6c40307fae6e4979a4e01f368802e230d8d3ae338f4dd1ef0370a8d69d66bbddd96d5860c65e559e49e0f56b52696cf14b
+  data.tar.gz: 92c0ac588743097d660462ee452438cbd3c98ae0933525689e4024b592c815dfc36e7696dffb4d3f33e44505d6d1ea291f7307b103013e29c6d70e066b9262b4

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.1.6] - 2024-09-11
+
+- Feature: Add `clear` flag on first emit
+- Feature: Add `trap_at_exit` option to `Akainaa.start` method
+- Feature: Do not emit regularly if interval is 0 or nil
+
+## [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

data/README.md

@@ -1,4 +1,4 @@
-# Akainaa (赤いなぁ)
+# Akainaa (赤いなぁ、 It's red...)
 
 ![page view](./img/webui-rev02.png)
 
@@ -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,27 @@ 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',
+    trap_at_exit: true,
+  },
+)
+```
+
 ## 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/lib/akainaa/util.rb

@@ -19,6 +19,7 @@ module Akainaa
 
       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?

data/lib/akainaa/version.rb

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

data/lib/akainaa.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'coverage'
+require 'fileutils'
 
 require_relative 'akainaa/version'
 require_relative 'akainaa/call_node_visitor'
@@ -10,24 +11,111 @@ 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
+      @first_emitted = false
 
       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)
+
+        if option[:trap_at_exit]
+          at_exit do
+            write_result(peek_result, option[:path])
+          end
+        end
+      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 write_result(result, path)
+      puts "Writing coverage result to #{path}"
+      unless @first_emitted
+        puts "with clear flag"
+        result['clear'] = true
+      end
+      File.write(path, result.to_json)
+      @first_emitted = true
+    end
+
+    private def default_online_emit
+      {
+        mode: :file,
+        interval: 1,
+        path: 'tmp/coverage.json',
+        trap_at_exit: true,
+      }
+    end
+
+    private def start_multipart_emit(option)
+      return if option[:interval].nil? || option[:interval] <= 0
+
+      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
+
+          write_result(diff, option[:path])
+        end
+      end
     end
   end
 
@@ -48,7 +136,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
@@ -83,6 +171,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' : ''

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: akainaa
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Shia
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Minimum rack middleware for coverage
 email:
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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