gem 'cmdx-rspec'

it "returns success" do
  result = SomeTask.execute

  expect(result).to be_successful
end

it "returns skipped" do
  result = SomeTask.execute

  # Default result
  expect(result).to have_skipped

  # Custom result
  expect(result).to have_skipped(
    reason: "Skipping for a custom reason",
    cause: be_a(CMDx::SkipFault)
    # Other members of `result.to_h`...
  )
end

it "returns failure" do
  result = SomeTask.execute

  # Default result
  expect(result).to have_failed

  # Custom result
  expect(result).to have_failed(
    reason: "Failed for a custom reason",
    cause: be_a(NoMethodError)
    # Other members of `result.to_h`...
  )
end

it "returns empty metadata" do
  result = SomeTask.execute

  expect(result).to have_empty_metadata
end

it "returns matching metadata" do
  result = SomeTask.execute

  expect(result).to have_matching_metadata(status_code: 500)
end

it "returns empty context" do
  result = SomeTask.execute

  expect(result).to have_empty_context
end

it "returns matching context" do
  result = SomeTask.execute

  expect(result).to have_matching_context(stored_result: 123)
end

it "returns deprecated" do
  expect(SomeTask).to be_deprecated
end

RSpec.configure do |config|
  config.include CMDx::RSpec::Helpers
end

describe MyFeature do
  include CMDx::RSpec::Helpers

  # Your specs...
end

it "stubs task executions by type" do
  # eg: SomeTask.execute
  stub_task_success(SomeTask)
  stub_task_skip(SomeTask)
  stub_task_fail(SomeTask)

  # eg: SomeTask.execute!
  stub_task_success!(SomeTask)
  stub_task_skip!(SomeTask)
  stub_task_fail!(SomeTask)

  # Your specs...
end

it "stubs task with arguments" do
  # eg: SomeTask.execute(some: "value")
  stub_task_success(SomeTask, some: "value")

  # eg: SomeTask.execute!(some: "value")
  stub_task_skip!(SomeTask, some: "value")

  # Your specs...
end

it "stubs task with metadata" do
  stub_task_success(SomeTask, metadata: { some: "value" })

  # Your specs...
end

it "stubs task with a custom reason" do
  stub_task_skip!(SomeTask, reason: "Skipping for a custom reason")

  # Your specs...
end

it "stubs task with a custom cause" do
  stub_task_fail!(SomeTask, cause: NoMethodError.new("just blow it up"))

  # Your specs...
end

it "unstubs task executions by type" do
  # eg: SomeTask.execute
  unstub_task(SomeTask)

  # eg: SomeTask.execute!
  unstub_task!(SomeTask)

  # Your specs...
end

it "unstubs task with arguments" do
  # eg: SomeTask.execute(some: "value")
  unstub_task(SomeTask, some: "value")

  # eg: SomeTask.execute!(some: "value")
  unstub_task!(SomeTask, some: "value")

  # Your specs...
end

it "mocks task executions by type" do
  # eg: SomeTask.execute
  expect_task_execution(SomeTask)
  expect_no_task_execution(SomeTask)

  # eg: SomeTask.execute!
  expect_task_execution!(BangCommand)
  expect_no_task_execution!(SomeTask)

  # Your specs...
end

it "mocks task with arguments" do
  # eg: SomeTask.execute(some: "value")
  expect_task_execution(SomeTask, some: "value")
  expect_no_task_execution(SomeTask, some: "value")

  # eg: SomeTask.execute!(some: "value")
  expect_task_execution!(SomeTask, some: "value")
  expect_no_task_execution!(SomeTask, some: "value")

  # Your specs...
end