omoteura-core 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2973f2f5bef98037f08e636f77e98886acbe82496b5db1997673d524ec550ba1
-  data.tar.gz: fa0ec2892824e5e61ce9b70affddf842ddc016be43c822e50df51c343b7d4ea5
+  metadata.gz: e172672c45474fc44869d70f9e0812ff21f47462d83cd93c9961e30c18cee160
+  data.tar.gz: 41798125dd13656c98913fa30eb2749ead7a2789db8cdd37b17c062cc0126587
 SHA512:
-  metadata.gz: b050f681961086f47a2a5470590fa128a850a80c9eb2cde00f8ce4b0086188a800aae5f2a32c1481d681ac1f98b431a4ff882c2f49bc1a5bb8650b15e69f5c1a
-  data.tar.gz: cbe4f109d8a72330214e0923356cbc07af84b4246ad27338aa8fed71887e2af79a62347ec5a33f220298b928d640bccf69de9a81d245e20e4f3b6a539119e16a
+  metadata.gz: 2b42bd503d9a835faf6570bb70880e384ab7b9321a99df4429cf77286ddf8c980e4645cfaf502e1762f09db7ffe18f4d934a42cd102eed9d33c64baa534fe91d
+  data.tar.gz: e00f1732c0972ce1aff13cb897500656b7ff3c6401f2e5449e98e8095ad79ad52ddd52e0b4c5500ce4647bc1e22c1dd585f4167fcac65371beead57868bae4ea

data/lib/omoteura/core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Omoteura
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/omoteura/coverage_report.rb

@@ -5,6 +5,7 @@ module Omoteura
   # for the editor's coverage panel. Separate from diagrams: it works on any
   # file and needs none.
   #
+  # The examples are RSpec's or Minitest's, from the file's spec or test.
   # An item counts as covered by an example that names it, in the example's
   # description or its code: "validates :email" by an example mentioning
   # email, "def display_name" by one inside describe "#display_name". The
@@ -40,16 +41,19 @@ module Omoteura
     Example = Data.define(:path, :line, :label, :description, :source, :status)
     private_constant :ONE_LINER, :Example
 
-    # The specs for a file by RSpec's conventions: app/models/user.rb is
-    # tested in spec/models/user_spec.rb, lib/a/b.rb in spec/a/b_spec.rb or
-    # spec/lib/a/b_spec.rb.
+    # The tests for a file by RSpec's and Rails' conventions:
+    # app/models/user.rb is tested in spec/models/user_spec.rb or
+    # test/models/user_test.rb, lib/a/b.rb in spec/a/b_spec.rb,
+    # spec/lib/a/b_spec.rb, test/a/b_test.rb or test/lib/a/b_test.rb. A
+    # project with both kinds gets both.
     def spec_paths(code_path)
       base = code_path.delete_suffix(File.extname(code_path))
-      candidates =
-        if base.start_with?("app/") then ["spec/#{base.delete_prefix("app/")}_spec.rb"]
-        elsif base.start_with?("lib/") then ["spec/#{base.delete_prefix("lib/")}_spec.rb", "spec/#{base}_spec.rb"]
-        else ["spec/#{base}_spec.rb"]
+      names =
+        if base.start_with?("app/") then [base.delete_prefix("app/")]
+        elsif base.start_with?("lib/") then [base.delete_prefix("lib/"), base]
+        else [base]
         end
+      candidates = names.map { |name| "spec/#{name}_spec.rb" } + names.map { |name| "test/#{name}_test.rb" }
       candidates.select { |path| (full = @config.expand(path)) && File.file?(full) }
     end
 
@@ -66,7 +70,9 @@ module Omoteura
       (described + undescribed).sort_by(&:start_line).map do |entry|
         result = recorded[entry.start_line]
         static = (entry.kind == :spec) ? entry.name : nil
-        description = [static, result&.full_description].compact.uniq.join("\n")
+        # A Minitest test method, such as test_total, names what it tests
+        # between underscores.
+        description = [static, static&.tr("_", " "), result&.full_description].compact.uniq.join("\n")
         Example.new(path: spec_path, line: entry.start_line, label: static || result&.full_description || entry.name, description: description,
           source: lines[(entry.start_line - 1)...entry.end_line].join, status: result&.status)
       end

data/lib/omoteura/results_file.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "coverage"
+require "json"
+require "time"
+
+module Omoteura
+  # Builds the test results file that the RSpec formatter and the Minitest
+  # reporter write and TestResults reads. Loaded on its own by those, so it
+  # requires nothing else of Omoteura.
+  module ResultsFile
+    FORMAT_VERSION = 1
+    DEFAULT_PATH = "tmp/omoteura/results.json"
+    ANSI_ESCAPE = /\e\[[0-9;]*m/
+    # Code that is not the project's own, or is the tests themselves.
+    NOT_PROJECT_CODE = %r{\A(?:spec|test|vendor|tmp|node_modules)/}
+
+    module_function
+
+    # examples are Hashes with :id, :file_path, :line_number,
+    # :full_description, :status ("passed", "failed" or "pending") and
+    # :message.
+    def generate(examples)
+      counts = examples.map { |e| e[:status] }.tally
+      data = {
+        version: FORMAT_VERSION,
+        generated_at: Time.now.utc.iso8601,
+        summary: {examples: examples.size, failures: counts.fetch("failed", 0), pending: counts.fetch("pending", 0)},
+        examples: examples
+      }
+      executed = executed_lines
+      data[:executed_lines] = executed if executed
+      JSON.pretty_generate(data) + "\n"
+    end
+
+    # A message as a terminal would show it, without the colors.
+    def plain(text)
+      text&.gsub(ANSI_ESCAPE, "")
+    end
+
+    # Line numbers that ran, by file relative to the working directory, or
+    # nil when coverage is not being measured. Something else, such as
+    # SimpleCov, must have started it: a coverage tool starting after the
+    # test framework's integration would fail.
+    def executed_lines
+      return nil unless ::Coverage.running?
+
+      root = File.join(Dir.pwd, "")
+      ::Coverage.peek_result.each_with_object({}) do |(path, counts), executed|
+        next unless path.start_with?(root) && path.end_with?(".rb")
+
+        relative = path.delete_prefix(root)
+        next if relative.match?(NOT_PROJECT_CODE)
+
+        # Hash for Coverage.start(lines: true), as SimpleCov uses; an
+        # Array of line counts for the older Coverage.start.
+        lines = counts.is_a?(Hash) ? counts[:lines] : counts
+        next unless lines
+
+        executed[relative] = lines.each_index.select { |i| lines[i]&.positive? }.map { |i| i + 1 }
+      end
+    end
+  end
+end

data/lib/omoteura/source_index.rb

@@ -36,7 +36,9 @@ module Omoteura
       EXAMPLE_GROUPS = %i[describe context feature example_group xdescribe xcontext xfeature fdescribe fcontext ffeature].freeze
       EXAMPLES = %i[it specify example scenario xit xspecify xexample xscenario fit fspecify fexample fscenario].freeze
 
-      Group = Data.define(:description, :module)
+      # test_class is true for a Minitest test class, where test "…" blocks
+      # are examples.
+      Group = Data.define(:description, :module, :test_class)
 
       attr_reader :entries
 
@@ -57,10 +59,29 @@ module Omoteura
       def visit_def_node(node)
         name = node.receiver.is_a?(Prism::SelfNode) ? "self.#{node.name}" : node.name.name
         add(:method, name, node)
+        # def test_… in a test class is a test as much as test "…" is. A link
+        # by its name finds the example first, at the same line.
+        if node.receiver.nil? && @groups.last&.test_class && name.start_with?("test_")
+          description = full_description(name)
+          add(:spec, description, node) if description
+        end
+        super
+      end
+
+      # A Minitest test class is an example group described by its name, as
+      # "UserTest", so that its tests are examples like RSpec's.
+      def visit_class_node(node)
+        return super unless test_class?(node)
+
+        description = full_description(node.constant_path.slice)
+        add(:spec, description, node, group: true) if description
+        @groups.push(Group.new(description: description, module: true, test_class: true))
         super
+        @groups.pop
       end
 
       def visit_call_node(node)
+        return visit_minitest_test(node) if minitest_test?(node)
         return super unless spec_call?(node)
 
         part, is_module = description_of(node)
@@ -68,7 +89,7 @@ module Omoteura
         add(:spec, description, node, group: EXAMPLE_GROUPS.include?(node.name)) if description
 
         if EXAMPLE_GROUPS.include?(node.name)
-          @groups.push(Group.new(description: description, module: is_module))
+          @groups.push(Group.new(description: description, module: is_module, test_class: false))
           super
           @groups.pop
         else
@@ -78,6 +99,33 @@ module Omoteura
 
       private
 
+      # test "requires an email" do … end, as ActiveSupport::TestCase defines
+      # tests, directly in a test class.
+      def minitest_test?(node)
+        node.name == :test && node.receiver.nil? && node.block && @groups.last&.test_class &&
+          node.arguments&.arguments&.first.is_a?(Prism::StringNode) || false
+      end
+
+      def visit_minitest_test(node)
+        description = full_description(node.arguments.arguments.first.unescaped)
+        add(:spec, description, node) if description
+        # Groups opened inside the test are not examples of the class.
+        @groups.push(Group.new(description: nil, module: false, test_class: false))
+        visit_child_nodes(node)
+        @groups.pop
+      end
+
+      # A class named like UserTest, or one that inherits from a class named
+      # like ActiveSupport::TestCase or Minitest::Test. Symbols are compared
+      # so that ordinary classes cost no allocation.
+      def test_class?(node)
+        return true if node.name.end_with?("Test")
+
+        superclass = node.superclass
+        (superclass.is_a?(Prism::ConstantReadNode) || superclass.is_a?(Prism::ConstantPathNode)) &&
+          superclass.name.end_with?("Test", "TestCase")
+      end
+
       # Cuts the statement's first line out of the source by byte offsets.
       # Slicing the whole statement would copy most of the file for every
       # class or describe block, and again for each level of nesting.

data/lib/omoteura/test_results.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require "json"
+require "omoteura/results_file"
 
 module Omoteura
-  # Test results written by Omoteura::RSpec::Formatter.
+  # Test results written by Omoteura::RSpec::Formatter or the Minitest
+  # reporter; see ResultsFile.
   class TestResults
     class Invalid < Error; end
 
-    DEFAULT_PATH = "tmp/omoteura/results.json"
-    SUPPORTED_VERSION = 1
+    DEFAULT_PATH = ResultsFile::DEFAULT_PATH
+    SUPPORTED_VERSION = ResultsFile::FORMAT_VERSION
 
     Example = Data.define(:file_path, :line_number, :full_description, :status, :message)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omoteura-core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - KAIBYAKU K.K
@@ -35,6 +35,7 @@ files:
 - lib/omoteura/outline.rb
 - lib/omoteura/project.rb
 - lib/omoteura/resolver.rb
+- lib/omoteura/results_file.rb
 - lib/omoteura/source_index.rb
 - lib/omoteura/test_results.rb
 - lib/omoteura/writer.rb