149 lines
3.9 KiB
Ruby
149 lines
3.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'fast_spec_helper'
|
|
require 'rubocop'
|
|
require_relative '../../../../rubocop/cop/graphql/descriptions'
|
|
|
|
RSpec.describe RuboCop::Cop::Graphql::Descriptions do
|
|
subject(:cop) { described_class.new }
|
|
|
|
context 'fields' do
|
|
it 'adds an offense when there is no description' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
^^^^^^^^^^^^^^^ Please add a `description` property.
|
|
GraphQL::STRING_TYPE,
|
|
null: false
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
|
|
it 'adds an offense when description does not end in a period' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
^^^^^^^^^^^^^^^ `description` strings must end with a `.`.
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'A descriptive description'
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
|
|
it 'does not add an offense when description is correct' do
|
|
expect_no_offenses(<<~TYPE.strip)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'A descriptive description.'
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
end
|
|
|
|
context 'arguments' do
|
|
it 'adds an offense when there is no description' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
argument :a_thing,
|
|
^^^^^^^^^^^^^^^^^^ Please add a `description` property.
|
|
GraphQL::STRING_TYPE,
|
|
null: false
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
|
|
it 'adds an offense when description does not end in a period' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
argument :a_thing,
|
|
^^^^^^^^^^^^^^^^^^ `description` strings must end with a `.`.
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'Behold! A description'
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
|
|
it 'does not add an offense when description is correct' do
|
|
expect_no_offenses(<<~TYPE.strip)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
argument :a_thing,
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'Behold! A description.'
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
end
|
|
|
|
describe 'autocorrecting descriptions without periods' do
|
|
it 'can autocorrect' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
^^^^^^^^^^^^^^^ `description` strings must end with a `.`.
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'Behold! A description'
|
|
end
|
|
end
|
|
TYPE
|
|
|
|
expect_correction(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: 'Behold! A description.'
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
|
|
it 'can autocorrect a heredoc' do
|
|
expect_offense(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
^^^^^^^^^^^^^^^ `description` strings must end with a `.`.
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: <<~DESC
|
|
Behold! A description
|
|
DESC
|
|
end
|
|
end
|
|
TYPE
|
|
|
|
expect_correction(<<~TYPE)
|
|
module Types
|
|
class FakeType < BaseObject
|
|
field :a_thing,
|
|
GraphQL::STRING_TYPE,
|
|
null: false,
|
|
description: <<~DESC
|
|
Behold! A description.
|
|
DESC
|
|
end
|
|
end
|
|
TYPE
|
|
end
|
|
end
|
|
end
|