insta 0.2.9 → 0.3.0

data/lib/insta/snapshot_file.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "fileutils"
+
+module Insta
+  class SnapshotFile
+    attr_reader :base_path #: Pathname
+    attr_reader :extension #: String
+
+    #: (String, String, String, ?String?) -> void
+    def initialize(base_path, test_class, test_name, extension = nil)
+      directory_resolver = Insta.configuration.snapshot_directory
+      directory = if directory_resolver
+                    directory_resolver.call(test_class: test_class)
+                  else
+                    SnapshotName.underscore(test_class)
+                  end
+      @base_path = Pathname.new(base_path) / directory
+      @test_name = test_name
+      @extension = extension || Insta.configuration.snapshot_extension
+      @counter = 0
+    end
+
+    #: (?Hash[Symbol, untyped]) -> Pathname
+    def path_for(options = {})
+      @counter += 1
+      filename_resolver = Insta.configuration.snapshot_filename
+
+      derived = if filename_resolver
+                  filename_resolver.call(test_name: @test_name, counter: @counter, options: options)
+                else
+                  SnapshotName.derive(@test_name, counter: @counter, options: options)
+                end
+
+      @base_path / "#{derived}#{@extension}"
+    end
+
+    #: (String) -> Pathname
+    def named_path(name)
+      @base_path / "#{SnapshotName.sanitize(name)}#{@extension}"
+    end
+
+    #: (Pathname) -> Pathname
+    def pending_path(path)
+      Pathname.new("#{path}.new")
+    end
+
+    #: (Pathname, String, Snapshot::snapshot_metadata) -> void
+    def write(path, content, metadata = {})
+      FileUtils.mkdir_p(path.dirname)
+      snapshot = Snapshot.new(content, metadata)
+
+      path.write(snapshot.serialize)
+    end
+
+    #: (Pathname) -> Snapshot?
+    def read(path)
+      return nil unless path.exist?
+
+      Snapshot.parse(path.read)
+    end
+  end
+end

data/lib/insta/snapshot_mismatch_handler.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Insta
+  module SnapshotMismatchHandler
+    # Returns :updated, :force_passed, or :failed
+    #: (SnapshotFile, Pathname, String, Snapshot::snapshot_metadata, String, ?caller_line: String?) -> Symbol
+    def self.handle(snapshot_file, path, content, metadata, expected, caller_line: nil)
+      coordinator = UpdateCoordinator.new(Insta.configuration.resolved_update_mode)
+      decision = coordinator.resolve(expected, content)
+
+      case decision
+      when :update
+        snapshot_file.write(path, content, metadata)
+        :updated
+      when :pending
+        pending_path = snapshot_file.pending_path(path)
+        snapshot_file.write(pending_path, content, metadata)
+        PendingLocations.add(pending_path.to_s, caller_line) if caller_line
+
+        ENV["INSTA_FORCE_PASS"] ? :force_passed : :failed
+      else
+        :failed
+      end
+    end
+
+    #: (String, String, String, Pathname, ?caller_line: String?) -> String
+    def self.failure_message(expected, content, label, path, caller_line: nil)
+      Diff.failure_message(
+        expected, content, label, path.to_s, caller_line,
+        file_extension: File.extname(path.to_s).delete_prefix(".")
+      )
+    end
+  end
+end

data/lib/insta/snapshot_name.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module Insta
+  module SnapshotName
+    #: (String) -> String
+    def self.sanitize(name)
+      sanitizer = Insta.configuration.snapshot_sanitizer
+
+      if sanitizer
+        sanitizer.call(name)
+      else
+        name
+          .gsub(/[^a-zA-Z0-9_\-.]/, "_")
+          .gsub(/_+/, "_")
+          .gsub(/\A_|_\z/, "")
+      end
+    end
+
+    #: (String) -> String
+    def self.underscore(string)
+      string
+        .gsub("::", "/")
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr("-", "_")
+        .tr(" ", "_")
+        .downcase
+    end
+
+    #: (String) -> String
+    def self.strip_test_prefix(name)
+      name.sub(/\Atest_(\d+_)?/, "")
+    end
+
+    #: (String, ?counter: Integer, ?options: Hash[Symbol, untyped]) -> String
+    def self.derive(test_name, counter: 1, options: {})
+      stripped = strip_test_prefix(test_name)
+      clean_name = sanitize(stripped)
+      suffix = counter > 1 ? "-#{counter}" : ""
+
+      if options && !options.empty?
+        options_hash = Digest::MD5.hexdigest(options.inspect)
+        "#{clean_name}#{suffix}-#{options_hash}"
+      else
+        "#{clean_name}#{suffix}"
+      end
+    end
+  end
+end

data/lib/insta/syntax_highlight.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+begin
+  require "irb/color"
+rescue LoadError
+  # irb not available, syntax highlighting will be skipped
+end
+
+module Insta
+  class SyntaxHighlight
+    #: (String, ?colorable: bool) -> String
+    def self.highlight(code, colorable: true)
+      return code unless colorable && defined?(IRB::Color)
+
+      IRB::Color.colorize_code(code, complete: false, colorable: true)
+    rescue StandardError
+      code
+    end
+  end
+end

data/lib/insta/update_coordinator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Insta
+  class UpdateCoordinator
+    #: (Symbol) -> void
+    def initialize(mode)
+      @mode = mode
+    end
+
+    #: (String, String) -> Symbol
+    def resolve(expected, actual)
+      return :keep if expected == actual
+
+      case @mode
+      when :force then :update
+      when :new then expected.empty? ? :update : :fail
+      when :no then :fail
+      else :pending # :auto, :pending => default to creating .snap.new
+      end
+    end
+  end
+end

data/lib/insta/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Insta
-  VERSION = '0.2.9'.freeze
+  VERSION = "0.3.0" #: String
 end

data/lib/insta.rb

@@ -1,10 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "insta/version"
+require_relative "insta/ci"
+require_relative "insta/configuration"
+require_relative "insta/snapshot"
+require_relative "insta/snapshot_content"
+require_relative "insta/snapshot_name"
+require_relative "insta/snapshot_file"
+require_relative "insta/diff"
+require_relative "insta/update_coordinator"
+require_relative "insta/snapshot_mismatch_handler"
+require_relative "insta/serializers/base"
+require_relative "insta/serializers/string"
+require_relative "insta/serializers/inspect"
+require_relative "insta/serializers/json"
+require_relative "insta/serializers/yaml"
+require_relative "insta/redaction/selector"
+require_relative "insta/redaction/applicator"
+require_relative "insta/inline/call_finder"
+require_relative "insta/inline/edit"
+require_relative "insta/inline/file_patcher"
+require_relative "insta/inline/pending_registry"
+require_relative "insta/inline/pending_store"
+require_relative "insta/pending_locations"
+require_relative "insta/pending_reporter"
+require_relative "insta/config_manifest"
+
 module Insta
-  # Your code goes here...
-end
+  #: () -> Configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 
-require 'insta/version'
-require 'insta/api'
-require 'insta/constants'
-require 'insta/device'
-require 'insta/user'
-require 'insta/proxy_manager'
+  #: () { (Configuration) -> void } -> void
+  def self.configure(&block)
+    block.call(configuration)
+  end
+
+  #: () -> void
+  def self.reset_configuration!
+    @configuration = Configuration.new
+  end
+end

data/lib/minitest/insta_plugin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "insta"
+require "insta/minitest/assertions"
+require "insta/minitest/lifecycle"
+
+module Minitest
+  #: (Hash[Symbol, untyped]) -> void
+  def self.plugin_insta_init(_options)
+    Minitest::Test.include(Insta::Minitest::Assertions)
+    Minitest::Test.include(Insta::Minitest::Lifecycle)
+  end
+end
+
+Minitest.after_run do
+  Insta::PendingReporter.flush_and_report!
+end

data/sig/insta/ansi.rbs

@@ -0,0 +1,28 @@
+# Generated from lib/insta/ansi.rb with RBS::Inline
+
+module Insta
+  module ANSI
+    private
+
+    # : () -> bool
+    def color?: () -> bool
+
+    # : (String) -> String
+    def bold: (String) -> String
+
+    # : (String) -> String
+    def dim: (String) -> String
+
+    # : (String) -> String
+    def red: (String) -> String
+
+    # : (String) -> String
+    def green: (String) -> String
+
+    # : (String) -> String
+    def yellow: (String) -> String
+
+    # : (String) -> String
+    def cyan: (String) -> String
+  end
+end

data/sig/insta/ci.rbs

@@ -0,0 +1,10 @@
+# Generated from lib/insta/ci.rb with RBS::Inline
+
+module Insta
+  module CI
+    CI_ENV_VARS: Array[String]
+
+    # : () -> bool
+    def self.ci?: () -> bool
+  end
+end

data/sig/insta/cli.rbs

@@ -0,0 +1,150 @@
+# Generated from lib/insta/cli.rb with RBS::Inline
+
+module Insta
+  class CLI
+    include ANSI
+
+    COMMANDS: untyped
+
+    MIN_GAP: Integer
+
+    # : (Array[String]) -> void
+    def initialize: (Array[String]) -> void
+
+    # : () -> void
+    def run: () -> void
+
+    private
+
+    def pluralize: (untyped count, untyped singular, ?untyped plural) -> untyped
+
+    # : () -> void
+    def review: () -> void
+
+    # : (Array[String]) -> void
+    def review_files: (Array[String]) -> void
+
+    # : (String) -> Symbol
+    def review_single_file: (String) -> Symbol
+
+    # : () -> String
+    def prompt_review_action: () -> String
+
+    # : () -> String
+    def review_prompt_line: () -> String
+
+    # : (String) -> void
+    def display_source_context: (String) -> void
+
+    # : (String) -> String?
+    def find_test_file: (String) -> String?
+
+    # : (String, String) -> Integer?
+    def find_test_line: (String, String) -> Integer?
+
+    # : (String) -> void
+    def display_caller_context: (String) -> void
+
+    # : (String, String) -> void
+    def display_snapshot_paths: (String, String) -> void
+
+    # : () -> void
+    def print_review_help: () -> void
+
+    # : (String, Integer) -> void
+    def print_source_lines: (String, Integer) -> void
+
+    # : (Array[String], Integer, Integer) -> Array[String]
+    def highlight_lines: (Array[String], Integer, Integer) -> Array[String]
+
+    # : (String, String) -> void
+    def display_diff: (String, String) -> void
+
+    # : (String, String) -> Symbol
+    def process_review_response: (String, String) -> Symbol
+
+    # : (Array[Inline::pending_store_entry]) -> void
+    def review_inline_entries: (Array[Inline::pending_store_entry]) -> void
+
+    # : (Inline::pending_store_entry) -> Symbol
+    def review_single_inline_entry: (Inline::pending_store_entry) -> Symbol
+
+    # : (String, Inline::pending_store_entry) -> Symbol
+    def process_inline_review_response: (String, Inline::pending_store_entry) -> Symbol
+
+    # : (Inline::pending_store_entry) -> void
+    def accept_inline_entry: (Inline::pending_store_entry) -> void
+
+    # : (Inline::pending_store_entry) -> void
+    def reject_inline_entry: (Inline::pending_store_entry) -> void
+
+    # : () -> void
+    def accept: () -> void
+
+    # : () -> void
+    def reject: () -> void
+
+    # : () -> void
+    def pending_list: () -> void
+
+    # : (Array[String]) -> void
+    def print_pending_files: (Array[String]) -> void
+
+    # : (Array[Inline::pending_store_entry]) -> void
+    def print_pending_inline: (Array[Inline::pending_store_entry]) -> void
+
+    # : () -> void
+    def status: () -> void
+
+    # : (String, String) -> void
+    def print_status_config: (String, String) -> void
+
+    # : (Array[String], Array[String], Array[Inline::pending_store_entry], Array[String]) -> void
+    def print_status_counts: (Array[String], Array[String], Array[Inline::pending_store_entry], Array[String]) -> void
+
+    # : (Array[String], Array[Inline::pending_store_entry]) -> void
+    def print_status_pending: (Array[String], Array[Inline::pending_store_entry]) -> void
+
+    # : (Array[[String, String]]) -> void
+    def print_status_entries: (Array[[ String, String ]]) -> void
+
+    # : () -> void
+    def clean: () -> void
+
+    # : () -> void
+    def help: () -> void
+
+    # : () -> void
+    def print_usage: () -> void
+
+    # : (String, Array[[String, String]]) -> void
+    def print_section: (String, Array[[ String, String ]]) -> void
+
+    # : () -> String
+    def header: () -> String
+
+    # : () -> void
+    def version: () -> void
+
+    # : () -> Array[[String, String]]
+    def help_commands: () -> Array[[ String, String ]]
+
+    # : () -> Array[[String, String]]
+    def help_options: () -> Array[[ String, String ]]
+
+    # : () -> Array[[String, String]]
+    def help_environment: () -> Array[[ String, String ]]
+
+    # : () -> Array[String]
+    def find_pending_files: () -> Array[String]
+
+    # : (String) -> void
+    def accept_file: (String) -> void
+
+    # : (String) -> void
+    def reject_file: (String) -> void
+
+    # : () -> void
+    def print_review_summary: () -> void
+  end
+end

data/sig/insta/config_manifest.rbs

@@ -0,0 +1,27 @@
+# Generated from lib/insta/config_manifest.rb with RBS::Inline
+
+module Insta
+  # Bridges configuration from the test process to the standalone CLI.
+  #
+  # `Insta.configure` runs inside the test process (usually from the test
+  # helper), which the CLI never loads. Instead of asking users to maintain
+  # a separate config file, the test run serializes the CLI-relevant
+  # settings next to the snapshots at flush time, and the CLI applies them
+  # on startup. Machine-written state, like the pending manifests.
+  module ConfigManifest
+    FILENAME: ::String
+
+    SYMBOL_KEYS: Array[Symbol]
+
+    RAW_KEYS: Array[Symbol]
+
+    # : () -> void
+    def self.write!: () -> void
+
+    # : () -> void
+    def self.apply!: () -> void
+
+    # : () -> String
+    def self.path: () -> String
+  end
+end

data/sig/insta/configuration.rbs

@@ -0,0 +1,48 @@
+# Generated from lib/insta/configuration.rb with RBS::Inline
+
+module Insta
+  class Configuration
+    type snapshot_filename_resolver = ^(test_name: String, counter: Integer, options: Hash[Symbol, untyped]) -> String
+
+    attr_accessor snapshot_path: String
+
+    attr_accessor diff_display: Symbol
+
+    attr_accessor diff_width: Integer?
+
+    attr_accessor diff_color: Symbol
+
+    attr_accessor update_mode: Symbol
+
+    attr_accessor default_serializer: Symbol
+
+    attr_accessor heredoc_identifier: String
+
+    attr_accessor ci_mode: Symbol
+
+    attr_accessor snapshot_extension: String
+
+    attr_accessor snapshot_sanitizer: (^(String) -> String)?
+
+    attr_accessor snapshot_filename: snapshot_filename_resolver?
+
+    attr_accessor snapshot_directory: (^(test_class: String) -> String)?
+
+    attr_accessor new_snapshot: Symbol
+
+    # : () -> void
+    def initialize: () -> void
+
+    # : () -> Symbol
+    def resolved_update_mode: () -> Symbol
+
+    # : () -> bool
+    def resolved_ci_mode?: () -> bool
+
+    # : () -> String
+    def resolved_diff_color: () -> String
+
+    # : () -> String
+    def resolved_diff_display: () -> String
+  end
+end

data/sig/insta/diff.rbs

@@ -0,0 +1,38 @@
+# Generated from lib/insta/diff.rb with RBS::Inline
+
+module Insta
+  class Diff
+    # : () -> Difftastic::Differ
+    def self.differ: () -> Difftastic::Differ
+
+    # : (String, String) -> String
+    def self.diff: (String, String) -> String
+
+    # : (String, String, ?file_extension: String?) -> String
+    def self.diff_with_language: (String, String, ?file_extension: String?) -> String
+
+    # : (String, String, String, ?String?, ?String?, ?file_extension: String?) -> String
+    def self.failure_message: (String, String, String, ?String?, ?String?, ?file_extension: String?) -> String
+
+    # : (String) -> String
+    def self.caller_file_location: (String) -> String
+
+    # : (String) -> String
+    def self.run_test_command: (String) -> String
+
+    # : () -> bool
+    def self.rspec?: () -> bool
+
+    # : () -> bool
+    def self.rails?: () -> bool
+
+    # : () -> bool
+    def self.minitest_cli?: () -> bool
+
+    # : () -> bool
+    def self.mtest?: () -> bool
+
+    # : () -> Integer
+    def self.terminal_width: () -> Integer
+  end
+end

data/sig/insta/inline/call_finder.rbs

@@ -0,0 +1,22 @@
+# Generated from lib/insta/inline/call_finder.rb with RBS::Inline
+
+module Insta
+  module Inline
+    class CallFinder < Prism::Visitor
+      METHODS: Array[Symbol]
+
+      attr_reader found_call: Prism::CallNode?
+
+      # : (Integer) -> void
+      def initialize: (Integer) -> void
+
+      # : (Prism::CallNode) -> void
+      def visit_call_node: (Prism::CallNode) -> void
+
+      private
+
+      # : (Prism::Node) -> bool
+      def covers_line?: (Prism::Node) -> bool
+    end
+  end
+end

data/sig/insta/inline/edit.rbs

@@ -0,0 +1,18 @@
+# Generated from lib/insta/inline/edit.rb with RBS::Inline
+
+module Insta
+  module Inline
+    type pending_entry = { line: Integer, content: String, type: Symbol }
+
+    class Edit
+      attr_reader start_offset: Integer
+
+      attr_reader end_offset: Integer
+
+      attr_reader replacement: String
+
+      # : (Integer, Integer, String) -> void
+      def initialize: (Integer, Integer, String) -> void
+    end
+  end
+end

data/sig/insta/inline/file_patcher.rbs

@@ -0,0 +1,55 @@
+# Generated from lib/insta/inline/file_patcher.rb with RBS::Inline
+
+module Insta
+  module Inline
+    class FilePatcher
+      # : (String, Array[Inline::pending_entry]) -> String
+      def self.patch: (String, Array[Inline::pending_entry]) -> String
+
+      # : (String, Array[Edit]) -> String
+      def self.apply_edits: (String, Array[Edit]) -> String
+
+      # : (String, Prism::CallNode, String, Symbol) -> Edit?
+      def self.build_edit: (String, Prism::CallNode, String, Symbol) -> Edit?
+
+      # : (Prism::Node) -> bool
+      def self.heredoc_node?: (Prism::Node) -> bool
+
+      # : (Prism::ArgumentsNode) -> Prism::Node?
+      def self.find_snapshot_argument: (Prism::ArgumentsNode) -> Prism::Node?
+
+      # : (Prism::StringNode, String) -> Edit?
+      def self.build_string_edit: (Prism::StringNode, String) -> Edit?
+
+      # : (String, Prism::StringNode | Prism::InterpolatedStringNode, String) -> Edit?
+      def self.build_heredoc_edit: (String, Prism::StringNode | Prism::InterpolatedStringNode, String) -> Edit?
+
+      # : (String, Prism::StringNode | Prism::InterpolatedStringNode, String) -> Edit?
+      def self.build_heredoc_to_string_edit: (String, Prism::StringNode | Prism::InterpolatedStringNode, String) -> Edit?
+
+      # : (String, Prism::CallNode, Prism::StringNode, String) -> Edit?
+      def self.build_string_to_heredoc_edit: (String, Prism::CallNode, Prism::StringNode, String) -> Edit?
+
+      # : (String, Prism::CallNode, String) -> Edit?
+      def self.build_insert_edit: (String, Prism::CallNode, String) -> Edit?
+
+      # : (String, Prism::CallNode, Prism::Location, String) -> Edit
+      def self.build_bare_call_insert_edit: (String, Prism::CallNode, Prism::Location, String) -> Edit
+
+      # : (String) -> bool
+      def self.single_line?: (String) -> bool
+
+      # : (Prism::CallNode, Prism::Location, String) -> Edit
+      def self.build_insert_string_edit: (Prism::CallNode, Prism::Location, String) -> Edit
+
+      # : (String, Prism::CallNode, Prism::Location, String) -> Edit
+      def self.build_insert_heredoc_edit: (String, Prism::CallNode, Prism::Location, String) -> Edit
+
+      # : (String, Integer) -> Integer
+      def self.detect_indent: (String, Integer) -> Integer
+
+      # : (String, String) -> void
+      def self.atomic_write: (String, String) -> void
+    end
+  end
+end