Module: Cuprum::Collections::RSpec::Contracts::ScopeContracts::ShouldBeAContainerScopeContract Deprecated

Extended by:

RSpec::SleepingKingStudios::Contract

Defined in:

lib/cuprum/collections/rspec/contracts/scope_contracts.rb

Overview

Deprecated.

0.6.0

Contract validating the behavior of a Container scope implementation.

Instance Method Summary

• #apply(example_group, invertible: false) ⇒ Object

  Adds the contract to the example group.

Instance Method Details

#apply(example_group, invertible: false) ⇒ Object

Adds the contract to the example group.

Parameters:

• example_group (RSpec::Core::ExampleGroup) —

  the example group to which the contract is applied.

• invertible (Boolean) (defaults to: false) —

  if true, the scope defines an implementation of the #invert method. Defaults to false.

# File 'lib/cuprum/collections/rspec/contracts/scope_contracts.rb', line 100

contract do |invertible: false|
  message =
    'Use deferred examples "should implement the Scope methods" and ' \
    '"should define child scopes"'
  SleepingKingStudios::Tools::Toolbelt
    .instance
    .core_tools
    .deprecate(
      'ShouldBeADisjunctionScopeContract',
      message:
    )

  shared_context 'with scopes' do
    let(:scopes) do
      [
        build_scope({ 'title'    => 'J.R.R. Tolkien' }),
        build_scope({ 'series'   => 'The Lord of the Rings' }),
        build_scope({ 'category' => 'Science Fiction and Fantasy' })
      ]
    end
  end

  describe '.new' do
    it 'should define the constructor' do
      expect(described_class)
        .to be_constructible
        .with(0).arguments
        .and_keywords(:scopes)
        .and_any_keywords
    end
  end

  include_contract('should be a scope', invertible:)

  describe '#==' do
    describe 'with a scope with the same class' do
      let(:other) { described_class.new(scopes: other_scopes) }

      describe 'with empty scopes' do
        let(:other_scopes) { [] }

        it { expect(subject == other).to be true }
      end

      describe 'with non-matching scopes' do
        let(:other_scopes) do
          Array.new(3) do
            Cuprum::Collections::Scope.new({ 'ok' => true })
          end
        end

        it { expect(subject == other).to be false }
      end

      wrap_context 'with scopes' do
        describe 'with empty scopes' do
          let(:other_scopes) { [] }

          it { expect(subject == other).to be false }
        end

        describe 'with non-matching scopes' do
          let(:other_scopes) do
            Array.new(3) do
              Cuprum::Collections::Scope.new({ 'ok' => true })
            end
          end

          it { expect(subject == other).to be false }
        end

        describe 'with matching scopes' do
          let(:other_scopes) { subject.scopes }

          it { expect(subject == other).to be true }
        end
      end
    end

    describe 'with a scope with the same type' do
      let(:other) { Spec::CustomScope.new(scopes: other_scopes) }

      example_class 'Spec::CustomScope',
        Cuprum::Collections::Scopes::Base \
      do |klass|
        klass.include Cuprum::Collections::Scopes::Container
      end

      before(:example) do
        allow(other).to receive(:type).and_return(scope.type)
      end

      describe 'with empty scopes' do
        let(:other_scopes) { [] }

        it { expect(subject == other).to be true }
      end

      describe 'with non-matching scopes' do
        let(:other_scopes) do
          Array.new(3) do
            Cuprum::Collections::Scope.new({ 'ok' => true })
          end
        end

        it { expect(subject == other).to be false }
      end

      wrap_context 'with scopes' do
        describe 'with empty scopes' do
          let(:other_scopes) { [] }

          it { expect(subject == other).to be false }
        end

        describe 'with non-matching scopes' do
          let(:other_scopes) do
            Array.new(3) do
              Cuprum::Collections::Scope.new({ 'ok' => true })
            end
          end

          it { expect(subject == other).to be false }
        end

        describe 'with matching scopes' do
          let(:other_scopes) { subject.scopes }

          it { expect(subject == other).to be true }
        end
      end
    end
  end

  describe '#as_json' do
    it { expect(subject.as_json['scopes']).to be == [] }

    wrap_context 'with scopes' do
      let(:expected) { subject.scopes.map(&:as_json) }

      it { expect(subject.as_json['scopes']).to be == expected }
    end
  end

  describe '#empty?' do
    it { expect(subject.empty?).to be true }

    wrap_context 'with scopes' do
      it { expect(subject.empty?).to be false }
    end
  end

  describe '#scopes' do
    include_examples 'should define reader', :scopes, -> { scopes }

    wrap_context 'with scopes' do
      it { expect(subject.scopes).to be == scopes }
    end
  end

  describe '#with_scopes' do
    let(:new_scopes) do
      [
        described_class.new(scopes: []),
        described_class.new(scopes: [])
      ]
    end

    it { expect(subject).to respond_to(:with_scopes).with(1).arguments }

    it 'should return a scope' do
      expect(subject.with_scopes(new_scopes)).to be_a described_class
    end

    it "should not change the original scope's child scopes" do
      expect { subject.with_scopes(new_scopes) }
        .not_to change(subject, :scopes)
    end

    it "should set the copied scope's child scopes" do
      expect(subject.with_scopes(new_scopes).scopes)
        .to be == new_scopes
    end

    wrap_context 'with scopes' do
      it "should not change the original scope's child scopes" do
        expect { subject.with_scopes(new_scopes) }
          .not_to change(subject, :scopes)
      end

      it "should set the copied scope's child scopes" do
        expect(subject.with_scopes(new_scopes).scopes)
          .to be == new_scopes
      end
    end
  end
end