Allow for individual test skiping
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
Rechercherichtung
Beginne damit nachzuverfolgen, wie RBS-Tests RSpec-Beispiele verarbeiten und wie die Annotation %a{rbs:test:skip} erkannt wird. Definiere einen Opt-out pro Beispiel, der nur den Fall mit ungültigem Namen überspringt, während die Prüfungen für gültige Namen aktiv bleiben, und decke anschließend beide Verhaltensweisen mit den Beispielszenarien im Issue ab.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
It would be awesome if you could turn RBS test on and off for single unit tests.
Given the following example:
class MyClass
attr_reader :name #: Symbol
# @rbs (name: String | Symbol) -> void
def initialize(name:)
validate_name(name)
@name = name.to_sym
end
private
# @rbs (untyped name) -> void
def validate_name(name)
raise ArgumentError, "Invalid name: #{name}" unless name.is_a?(String) || name.is_a?(Symbol)
end
end
and the following test:
RSpec.describe MyClass do
describe '.new' do
subject(:my_class) { described_class.new(name) }
# RBS test needs to skip this context as we're intentionally violating types here.
context 'when given an invalid name' do
let(:name) { 123 }
it { expect { my_class }.to raise_error(ArgumentError, /Invalid name/) }
end
# RBS test should not skip this context
context 'when given a valid name' do
let(:name) { 'foo' }
it { expect { my_class }.not_to raise_error }
it 'is expected to set the name' do
expect(my_class).to have_attributes(name: :foo)
end
end
end
end
While it's great that RBS can catch these type errors its only really beneficial if those who use your gem as a dependency are also using RBS on their project. So we still need to write in protections like this but are unable to test them because the test in this example will raise an RBS TypeError. Additionally we don't want to completely turn off RBS for the initialize method with the %a{rbs:test:skip} annotation as it's just this single test that will raise the error.
The obvious work around here is to have the name argument in the initializer be untyped however that reduces the clarity of the signature making the end user believe they may pass whatever they would like for name to the initializer.
- Vorherrschende Sprache
- Ruby
- Sterne
- 2.2k
- Forks
- 263
- Ø Merge
- 1 T. 20 Std.
- Gemergte PRs (30 T.)
- 64
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Keine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus ruby/rbs
-
InlineParser: `@rbs @ivar` annotation is reported as unused unless it is the first thing in the class bodyEvtl. vergeben @ksss hat das vor 50 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100
Maintainer antworten meist innerhalb von 1 Tag
Ähnliche Issues
-
Update axe-core to v4.14.1Evtl. vergeben @axe-core hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
dequelabs/axe-core-gems#539 ·
-
Pro request form loses all text when the subject is too longEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offenbug f:request-creation professional
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
mysociety/alaveteli#9733 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
needs verification
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
Maintainer antworten meist innerhalb von 13 Tagen
-
🐛 bug 👩💻 équipe CE 🧑🏭 entreprises
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
betagouv/conseillers-entreprises#4808 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100