rspec/rules/S1694/csharp/rule.adoc

94 lines
1.7 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
The purpose of an abstract class is to provide some heritable behaviors while also defining methods which must be implemented by sub-classes.
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
A ``++class++`` with no abstract methods that was made ``++abstract++`` purely to prevent instantiation should be converted to a concrete ``++class++`` (i.e. remove the ``++abstract++`` keyword) with a ``++protected++`` constructor.
2020-06-30 12:47:33 +02:00
2021-02-02 15:02:10 +01:00
2021-01-27 13:42:22 +01:00
A ``++class++`` with only ``++abstract++`` methods and no inheritable behavior should be converted to an ``++interface++``.
2020-06-30 12:47:33 +02:00
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:47:33 +02:00
----
public abstract class Animal //Noncompliant; should be an interface
{
abstract void Move();
abstract void Feed();
}
public abstract class Color //Noncompliant; should be concrete with a protected constructor
2020-06-30 12:47:33 +02:00
{
private int red = 0;
private int green = 0;
private int blue = 0;
public int GetRed()
{
return red;
}
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:47:33 +02:00
----
public interface Animal
{
void Move();
void Feed();
}
public class Color
{
private int red = 0;
private int green = 0;
private int blue = 0;
protected Color()
{}
public int GetRed()
{
return red;
}
}
public abstract class Lamp
{
private bool switchLamp = false;
public abstract void Glow();
public void FlipSwitch()
{
switchLamp = !switchLamp;
if (switchLamp)
{
Glow();
}
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Convert this "abstract" (class|record) to (an interface|a concrete type with a private constructor).
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]