view_component/test/test_helper.rb

# frozen_string_literal: true

require "simplecov"
require "simplecov-console"

if ENV["MEASURE_COVERAGE"]
  SimpleCov.start do
    command_name "rails#{ENV["RAILS_VERSION"]}-ruby#{ENV["RUBY_VERSION"]}" if ENV["RUBY_VERSION"]

    formatter SimpleCov::Formatter::Console
  end
end

require "bundler/setup"
require "pp"
require "pathname"
require "minitest/autorun"

# Configure Rails Environment
ENV["RAILS_ENV"] = "test"

require "view_component/deprecation"
ViewComponent::Deprecation.behavior = :silence

require File.expand_path("../sandbox/config/environment.rb", __FILE__)
require "rails/test_help"

# Sets custom preview paths in tests.
#
# @param new_value [Array<String>] List of preview paths
# @yield Test code to run
# @return [void]
def with_preview_paths(new_value)
  old_value = Rails.application.config.view_component.preview_paths
  Rails.application.config.view_component.preview_paths = new_value
  yield
  Rails.application.config.view_component.preview_paths = old_value
end

def with_preview_route(new_value)
  old_value = Rails.application.config.view_component.preview_route
  Rails.application.config.view_component.preview_route = new_value
  app.reloader.reload!
  yield
  Rails.application.config.view_component.preview_route = old_value
  app.reloader.reload!
end

def with_preview_controller(new_value)
  old_value = Rails.application.config.view_component.preview_controller
  Rails.application.config.view_component.preview_controller = new_value
  app.reloader.reload!
  yield
  Rails.application.config.view_component.preview_controller = old_value
  app.reloader.reload!
end

def with_custom_component_path(new_value)
  old_value = ViewComponent::Base.view_component_path
  ViewComponent::Base.view_component_path = new_value
  yield
ensure
  ViewComponent::Base.view_component_path = old_value
end

def with_custom_component_parent_class(new_value)
  old_value = ViewComponent::Base.component_parent_class
  ViewComponent::Base.component_parent_class = new_value
  yield
ensure
  ViewComponent::Base.component_parent_class = old_value
end

def with_application_component_class
  Object.const_set("ApplicationComponent", Class.new(Object))
  yield
ensure
  Object.send(:remove_const, :ApplicationComponent)
end

def with_generate_sidecar(enabled)
  old_value = ViewComponent::Base.generate.sidecar
  ViewComponent::Base.generate.sidecar = enabled
  yield
ensure
  ViewComponent::Base.generate.sidecar = old_value
end

def with_new_cache
  begin
    old_cache = ViewComponent::CompileCache.cache
    ViewComponent::CompileCache.cache = Set.new
    old_cache_template_loading = ActionView::Base.cache_template_loading
    ActionView::Base.cache_template_loading = false
    reset_render_template_methods

    yield
  ensure
    ActionView::Base.cache_template_loading = old_cache_template_loading
    ViewComponent::CompileCache.cache = old_cache
    reset_render_template_methods
  end
end

def reset_render_template_methods
  ViewComponent::Base.descendants.each do |klass|
    klass.compiler.reset_render_template_for
  end
end

def without_template_annotations
  if ActionView::Base.respond_to?(:annotate_rendered_view_with_filenames)
    old_value = ActionView::Base.annotate_rendered_view_with_filenames
    ActionView::Base.annotate_rendered_view_with_filenames = false
    app.reloader.reload! if defined?(app)

    with_new_cache do
      yield
    end

    ActionView::Base.annotate_rendered_view_with_filenames = old_value
    app.reloader.reload! if defined?(app)
  else
    yield
  end
end

def modify_file(file, content)
  filename = Rails.root.join(file)
  old_content = File.read(filename)
  begin
    File.open(filename, "wb+") { |f| f.write(content) }
    yield
  ensure
    File.open(filename, "wb+") { |f| f.write(old_content) }
  end
end

def with_default_preview_layout(layout)
  old_value = ViewComponent::Base.default_preview_layout
  ViewComponent::Base.default_preview_layout = layout
  yield
  ViewComponent::Base.default_preview_layout = old_value
end

def with_render_monkey_patch_config(enabled)
  old_default = ViewComponent::Base.render_monkey_patch_enabled
  ViewComponent::Base.render_monkey_patch_enabled = enabled
  yield
ensure
  ViewComponent::Base.render_monkey_patch_enabled = old_default
end

def with_compiler_mode(mode)
  previous_mode = ViewComponent::Compiler.mode
  ViewComponent::Compiler.mode = mode
  yield
ensure
  ViewComponent::Compiler.mode = previous_mode
end