Allow for individual test skiping

Ouverte
#2,130 2 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
ruby
Domaine
testing

Piste de recherche

Commencez par retracer la manière dont les tests RBS traitent les exemples RSpec et dont l’annotation %a{rbs:test:skip} est reconnue. Définissez une exclusion par exemple qui ignore uniquement le cas du nom invalide tout en laissant actives les vérifications des noms valides, puis couvrez les deux comportements avec les scénarios d’exemple de l’issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
Ruby
Étoiles
2.2k
Forks
263
Merge moyen
1 j 20 h
PR mergées (30 j)
64

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de ruby/rbs

Toutes les issues de ruby/rbs

Issues similaires

Plus d'issues Ruby

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.