omoteura-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 934b8861409e26c228eb9f4644637078de2e9526c83c935f209db204ff527e86
+  data.tar.gz: 69aa7c639adc67f991013cd40728d346c5d95b80cdc5a9a4ad49f26b0fe8a735
+SHA512:
+  metadata.gz: 2d759a5621411ef3bede239c38d030db87b7dbc95ddd48c38ff0f89cfbb3987878a089a3ea07bd3d2d5a2e90a435d653605efa7c9d77cbeece3971bf2cc5a575
+  data.tar.gz: ca823d019e86da98da3f37403ee12e600f12d8da1110b7726cdfc3e47215985cb70ad572a05dcdd581d88f91d694ba53933d28d86dc8e1d5f7f72fb76f26b2eb

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KAIBYAKU K.K
+
+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/lib/omoteura/rspec/formatter.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require "coverage"
+require "json"
+require "time"
+require "rspec/core"
+
+module Omoteura
+  module RSpec
+    # Writes every example's result as JSON for the editor to color linked
+    # shapes with. Use it next to a normal formatter:
+    #
+    #   --format progress
+    #   --format Omoteura::RSpec::Formatter --out tmp/omoteura/results.json
+    #
+    # RSpec loads this file from the class name by itself, so .rspec needs
+    # no --require line.
+    #
+    # When something already measures coverage, as SimpleCov does, the lines
+    # of the project's own code that ran are recorded too, so the editor can
+    # tell which methods the tests called. The formatter never starts
+    # coverage itself: a coverage tool starting after it would fail.
+    class Formatter
+      FORMAT_VERSION = 1
+      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)/}
+
+      ::RSpec::Core::Formatters.register self, :example_passed, :example_failed, :example_pending, :close
+
+      def initialize(output)
+        @output = output
+        @examples = []
+      end
+
+      def example_passed(notification)
+        @examples << example_data(notification.example, "passed")
+      end
+
+      def example_failed(notification)
+        exception = notification.example.execution_result.exception
+        @examples << example_data(notification.example, "failed", message: exception && plain(exception.message))
+      end
+
+      def example_pending(notification)
+        @examples << example_data(notification.example, "pending", message: notification.example.execution_result.pending_message)
+      end
+
+      def close(_notification)
+        data = {version: FORMAT_VERSION, generated_at: Time.now.utc.iso8601, summary: summary, examples: @examples}
+        executed = executed_lines
+        data[:executed_lines] = executed if executed
+        @output.write(JSON.pretty_generate(data))
+        @output.write("\n")
+      end
+
+      private
+
+      def example_data(example, status, message: nil)
+        {
+          id: example.id,
+          file_path: example.metadata[:file_path].delete_prefix("./"),
+          line_number: example.metadata[:line_number],
+          full_description: example.full_description,
+          status: status,
+          message: message
+        }
+      end
+
+      # Line numbers that ran, by file relative to the working directory, or
+      # nil when coverage is not being measured.
+      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
+
+      def summary
+        counts = @examples.map { |e| e[:status] }.tally
+        {examples: @examples.size, failures: counts.fetch("failed", 0), pending: counts.fetch("pending", 0)}
+      end
+
+      def plain(text)
+        text.gsub(ANSI_ESCAPE, "")
+      end
+    end
+  end
+end

data/lib/omoteura/rspec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "omoteura/core"
+
+module Omoteura
+  module RSpec
+  end
+end
+
+require "omoteura/rspec/formatter"

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: omoteura-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- KAIBYAKU K.K
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omoteura-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.12'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/omoteura/rspec.rb
+- lib/omoteura/rspec/formatter.rb
+homepage: https://github.com/kaibyaku-jp/omoteura
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/kaibyaku-jp/omoteura
+  changelog_uri: https://github.com/kaibyaku-jp/omoteura/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: RSpec spec analysis and result formatter for Omoteura
+test_files: []