Back to Repositories

Testing Date Field Integration Features in Rails Admin

This test suite validates date field functionality in Rails Admin, covering filtering, creation, and updating of date fields with timezone considerations. The tests ensure proper date handling and persistence across different server configurations.

Test Coverage Overview

The test suite provides comprehensive coverage of date field operations in Rails Admin.

Key areas tested include:

Date field filtering with various conditions
Date creation and persistence
Date field updates
Timezone handling
Edge cases with empty values

Implementation Analysis

The testing approach utilizes RSpec request specs to validate date field behavior at the integration level. The implementation leverages FactoryBot for test data generation and employs RSpec’s expect syntax for assertions. Time zone manipulation is handled through controlled test environments using around blocks.

Technical Details

Testing tools and configuration:

RSpec for test framework
FactoryBot for test data generation
Page object pattern for UI interaction
ActiveSupport::TimeZone for timezone testing
Rails Admin configuration for field setup

Best Practices Demonstrated

The test suite exemplifies several testing best practices including isolated test contexts, proper setup and teardown, timezone-aware testing, and comprehensive edge case coverage. The code organization follows a clear structure with well-defined contexts and descriptive test cases.

railsadminteam/rails_admin

spec/integration/fields/date_spec.rb

            
# frozen_string_literal: true

require 'spec_helper'

RSpec.describe 'Date field', type: :request do
  subject { page }
  before do
    RailsAdmin.config FieldTest do
      field :id
      field :date_field
    end
  end

  describe 'filtering' do
    let!(:field_tests) do
      [FactoryBot.create(:field_test, date_field: Date.new(2021, 1, 2)),
       FactoryBot.create(:field_test, date_field: Date.new(2021, 1, 3))]
    end

    it 'correctly returns a record' do
      visit index_path(model_name: 'field_test', f: {date_field: {'1' => {v: [nil, '2021-01-03T00:00:00', nil], o: 'between'}}})
      is_expected.to have_content '1 field test'
      is_expected.to have_content field_tests[1].id
    end

    it 'does not break when the condition is not filled' do
      visit index_path(model_name: 'field_test', f: {date_field: {'1' => {v: [nil, '', ''], o: 'between'}}})
      is_expected.to have_content '2 field test'
    end

    context 'with server timezone changed' do
      around do |example|
        original = Time.zone
        Time.zone = ActiveSupport::TimeZone.new('Central Time (US & Canada)')
        example.run
        Time.zone = original
      end

      it 'correctly returns a record' do
        visit index_path(model_name: 'field_test', f: {date_field: {'1' => {v: [nil, '2021-01-03T00:00:00', nil], o: 'between'}}})
        is_expected.to have_content '1 field test'
        is_expected.to have_content field_tests[1].id
      end
    end
  end

  context 'on create' do
    it 'is initially blank' do
      visit new_path(model_name: 'field_test')
      expect(find('[name="field_test[date_field]"]', visible: false).value).to be_blank
    end

    it 'persists the value' do
      visit new_path(model_name: 'field_test')
      find('[name="field_test[date_field]"]', visible: false).set('2021-01-02T00:00:00')
      click_button 'Save'
      expect(FieldTest.count).to eq 1
      expect(FieldTest.first.date_field).to eq Date.new(2021, 1, 2)
    end

    it 'ignores the time part' do
      visit new_path(model_name: 'field_test')
      find('[name="field_test[date_field]"]', visible: false).set('2021-01-02T12:34:00')
      click_button 'Save'
      expect(FieldTest.count).to eq 1
      expect(FieldTest.first.date_field).to eq Date.new(2021, 1, 2)
    end
  end

  context 'on update' do
    let(:field_test) { FactoryBot.create :field_test, date_field: Date.new(2021, 1, 2) }

    it 'updates the value' do
      visit edit_path(model_name: 'field_test', id: field_test.id)
      expect(find('[name="field_test[date_field]"]', visible: false).value).to eq '2021-01-02T00:00:00'
      find('[name="field_test[date_field]"]', visible: false).set('2021-02-03T00:00:00')
      click_button 'Save'
      field_test.reload
      expect(field_test.date_field).to eq Date.new(2021, 2, 3)
    end
  end

  context 'with server timezone changed' do
    let(:field_test) { FactoryBot.create :field_test, date_field: Date.new(2015, 10, 8) }

    around do |example|
      original = Time.zone
      Time.zone = ActiveSupport::TimeZone.new('Central Time (US & Canada)')
      example.run
      Time.zone = original
    end

    it 'is not altered by just saving untouched' do
      visit edit_path(model_name: 'field_test', id: field_test.id)
      expect(find('[name="field_test[date_field]"]', visible: false).value).to eq '2015-10-08T00:00:00'
      click_button 'Save'
      expect { field_test.reload }.not_to change(field_test, :date_field)
    end
  end
end