channels_spec.rb

# encoding: utf-8
require 'spec_helper'

describe Ably::Realtime::Channels do
  let(:connection) { instance_double('Ably::Realtime::Connection', unsafe_on: true) }
  let(:client) do
    instance_double('Ably::Realtime::Client', connection: connection, client_id: 'clientId', logger: double('logger').as_null_object)
  end
  let(:channel_name) { 'unique' }
  let(:options) do
    { params: { bizarre: 'value' } }
  end

  subject { Ably::Realtime::Channels.new(client) }

  context 'creating channels' do
    context '#get' do
      context "when channel doesn't exist" do
        shared_examples 'creates a channel' do
          it 'creates a channel (RTS3a)' do
            expect(Ably::Realtime::Channel).to receive(:new).with(client, channel_name, channel_options)
            subject.get(channel_name, channel_options)
          end
        end

        describe 'hash' do
          let(:channel_options) { options }
          it { expect(channel_options).to be_a(Hash) }

          include_examples 'creates a channel'
        end

        describe 'ChannelOptions object' do
          let(:channel_options) { Ably::Models::ChannelOptions.new(options) }
          it { expect(channel_options).to be_a(Ably::Models::ChannelOptions) }

          include_examples 'creates a channel'
        end
      end

      context 'when an existing channel exists' do
        shared_examples 'reuse a channel object if it exists' do
          it 'will reuse a channel object if it exists (RTS3a)' do
            channel = subject.get(channel_name, channel_options)
            expect(channel).to be_a(Ably::Realtime::Channel)
            expect(subject.get(channel_name, channel_options).object_id).to eql(channel.object_id)
          end
        end

        describe 'hash' do
          let(:channel_options) { options }
          it { expect(channel_options).to be_a(Hash) }

          include_examples 'reuse a channel object if it exists'
        end

        describe 'ChannelOptions object' do
          let(:channel_options) { Ably::Models::ChannelOptions.new(options) }
          it { expect(channel_options).to be_a(Ably::Models::ChannelOptions) }

          include_examples 'reuse a channel object if it exists'
        end

        it 'will update the options on the channel if provided (RSN3c)' do
          channel = subject.get(channel_name, options)
          expect(channel.options.to_h).to eq(options)
          expect(channel.options.to_h).to_not include(:encrypted)
          subject.get(channel_name, encrypted: true)
          expect(channel.options[:encrypted]).to eq(true)
        end

        it 'will leave the options intact on the channel if not provided' do
          channel = subject.get(channel_name, options)
          expect(channel.options.to_h).to eq(options)
          subject.get(channel_name)
          expect(channel.options.to_h).to eq(options)
        end
      end
    end

    it '[] creates a channel' do
      expect(Ably::Realtime::Channel).to receive(:new).with(client, channel_name, options)
      subject.get(channel_name, options)
    end
  end

  context '#fetch' do
    it 'retrieves a channel if it exists' do
      channel = subject.get(channel_name, options)
      expect(subject.fetch(channel_name)).to eql(channel)
    end

    it 'calls the block if channel is missing' do
      block_called = false
      subject.fetch(channel_name) { block_called = true }
      expect(block_called).to eql(true)
    end
  end

  context 'destroying channels' do
    it '#release detaches and then releases the channel resources' do
      released_channel = subject.get(channel_name, options)
      expect(released_channel).to receive(:detach).and_yield
      subject.release(channel_name)
      expect(subject.get(channel_name, options).object_id).to_not eql(released_channel.object_id)
    end
  end

  context 'is Enumerable' do
    let(:channel_count) { 5 }
    let(:mock_channel)  { instance_double('Ably::Realtime::Channel') }

    before do
      allow(Ably::Realtime::Channel).to receive(:new).and_return(mock_channel)
      channel_count.times { |index| subject.get("channel-#{index}") }
    end

    it 'allows enumeration' do
      expect(subject.map.count).to eql(channel_count)
    end

    context '#each' do
      it 'returns an enumerator' do
        expect(subject.each).to be_a(Enumerator)
      end

      it 'yields each channel' do
        subject.each do |channel|
          expect(channel).to eql(mock_channel)
        end
      end
    end

    it 'provides #length' do
      expect(subject.length).to eql(channel_count)
    end
  end
end