gonzedge/rambling-trie

View on GitHub
spec/support/shared_examples/a_trie_node.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

shared_examples_for 'a trie node' do
  let(:node_class) { node.class }

  describe '.new' do
    it 'has no letter' do
      expect(node.letter).to be_nil
    end

    it 'has no children' do
      expect(node.children.size).to eq 0
    end

    it 'is not terminal' do
      expect(node).not_to be_terminal
    end

    it 'returns empty string as its word' do
      expect(node.as_word).to be_empty
    end

    context 'with a letter and a parent' do
      let(:parent) { node_class.new }
      # noinspection RubyArgCount
      let(:node_with_parent) { node_class.new :a, parent }

      it 'does not have any letter' do
        expect(node_with_parent.letter).to eq :a
      end

      it 'has no children' do
        expect(node_with_parent.children.size).to eq 0
      end

      it 'is not terminal' do
        expect(node_with_parent).not_to be_terminal
      end
    end
  end

  describe '#root?' do
    context 'when the node has a parent' do
      before { node.parent = node }

      it 'returns false' do
        expect(node).not_to be_root
      end
    end

    context 'when the node does not have a parent' do
      before { node.parent = nil }

      it 'returns true' do
        expect(node).to be_root
      end
    end
  end

  describe '#terminal!' do
    # rubocop:disable RSpec/MultipleExpectations
    it 'forces the node to be terminal' do
      expect(node).not_to be_terminal
      node.terminal!
      expect(node).to be_terminal
    end
    # rubocop:enable RSpec/MultipleExpectations

    it 'returns the node' do
      expect(node.terminal!).to eq node
    end
  end

  describe 'delegates and aliases' do
    let :children_tree do
      instance_double(
        Hash,
        :children_tree,
        :[] => 'value',
        :[]= => nil,
        key?: false,
        delete: true,
      )
    end

    before { node.children_tree = children_tree }

    # rubocop:disable RSpec/MultipleExpectations
    it 'delegates `#[]` to its children tree' do
      expect(node[:key]).to eq 'value'
      expect(children_tree).to have_received(:[]).with :key
    end
    # rubocop:enable RSpec/MultipleExpectations

    it 'delegates `#[]=` to its children tree' do
      node[:key] = 'value'
      expect(children_tree).to have_received(:[]=).with(:key, 'value')
    end

    # rubocop:disable RSpec/MultipleExpectations
    it 'delegates `#key?` to its children tree' do
      allow(children_tree).to receive(:key?)
        .with(:present_key)
        .and_return true

      expect(node).to have_key(:present_key)
      expect(node).not_to have_key(:absent_key)
    end
    # rubocop:enable RSpec/MultipleExpectations

    # rubocop:disable RSpec/MultipleExpectations
    it 'delegates `#delete` to its children tree' do
      expect(node.delete :key).to be true
      expect(children_tree).to have_received(:delete).with :key
    end
    # rubocop:enable RSpec/MultipleExpectations

    # rubocop:disable RSpec/ExampleLength
    it 'delegates `#children` to its children tree values' do
      children = [
        instance_double(Rambling::Trie::Nodes::Node, :child_one),
        instance_double(Rambling::Trie::Nodes::Node, :child_two),
      ]
      allow(children_tree).to receive(:values).and_return children

      expect(node.children).to eq children
    end
    # rubocop:enable RSpec/ExampleLength

    it 'aliases `#has_key?` to `#key?`' do
      node.has_key? :nope
      expect(children_tree).to have_received(:key?).with :nope
    end
  end
end