spec for lookup module

gistfile1.rb

require 'spec_helper'

describe Lookup do

  # in theory this should work with an active record query or whatever code returning an appropriate array
  # of hashes in the result in the block passed, but not going this far to test right now
  describe 'with an object for lookup data' do

    class MyClass
      include Lookup

      # this could be AR attribute or other
      attr_accessor :record_type_id

      # the second param could be from anywhere - just an array of hashes with the right values
      # in theory this could be an executable AR query
      # also note that we dont have an :order attribute, as we leave leeway for the developer to change the
      # order of the array of hashes as desired
      # also note that the reference in the second param must be coded to the root of app class structure and not
      # refer implicitly to self as self can mean different things when the code in this module is executed
      # note that the lookup name must be singular
      lookup_for :record_type do
        [
          { id: 1, value: :first_value, friendly: 'something friendly', notes: 'notes are here' },
          { id: 2, value: :second_value, friendly: 'something friendly', notes: 'notes are here' },
          { id: 3, value: :third_value, friendly: 'something friendly', notes: 'notes are here' }
        ]
      end

    end

    let(:my_class_instance) { MyClass.new }

    describe 'created instance methods' do

      describe 'setter attribute' do

        it 'creates instance method on class' do
          expect(my_class_instance.respond_to?(:record_type=)).to eq true
        end

        it 'assigns the set value to the [lookup]_id attribute' do
          expect(my_class_instance.record_type).to eq nil
          my_class_instance.record_type = :second_value
          expect(my_class_instance.record_type).to eq :second_value
        end

        it 'assigns string' do
          my_class_instance.record_type = 'third_value'
          expect(my_class_instance.record_type).to eq :third_value
        end

        it 'can clear the value' do
          my_class_instance.record_type = :second_value
          expect(my_class_instance.record_type_id).to eq 2
          my_class_instance.record_type = nil
          expect(my_class_instance.record_type).to eq nil
        end

      end

      describe 'getter attribute' do

        it 'creates instance method on class' do
          expect(my_class_instance.respond_to?(:record_type)).to eq true
        end

        it 'returns the set value from the [lookup]_id attribute' do
          my_class_instance.record_type_id = 3
          expect(my_class_instance.record_type).to eq :third_value
        end

      end

    end

    describe 'create class methods' do

      describe 'lookup list' do

        it 'creates class method on class' do
          expect(MyClass.respond_to?(:record_types)).to eq true
        end

        it 'returns the results as an array of hashes' do
          record_types = MyClass.record_types
          expect(record_types.class).to eq Array
          expect(record_types[0].class).to eq Hash
        end

      end

      it 'has lookup shortcut for finding data' do
        expect(MyClass.get_record_type_by(:value, :third_value)).to eq MyClass.record_types[2]
      end

    end

    describe 'implements rspec matcher for expect and shoulda' do

      describe MyClass do
        it { MyClass.should implement_lookup_for(:record_type) }

        it 'do it in a bigger block' do
          MyClass.should implement_lookup_for(:record_type)
        end

      end

      it { expect(MyClass).to implement_lookup_for(:record_type) }

    end

  end

end