Skip to content

Commit

Permalink
Refactor test cases when the result of rake routes is blank
Browse files Browse the repository at this point in the history
  • Loading branch information
@nard-tech
nard-tech committed Feb 21, 2020
1 parent 65b201b commit f5cff71
Showing 1 changed file with 125 additions and 120 deletions.
245 changes: 125 additions & 120 deletions spec/lib/annotate/annotate_routes_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -234,159 +234,164 @@
end
end
end
end
end

describe 'When the result of `rake routes` is blank' do
before(:each) do
expect(File).to receive(:exist?).with(ROUTE_FILE).and_return(true).once
expect(File).to receive(:read).with(ROUTE_FILE).and_return(route_file_content).once
context 'When the result of `rake routes` is blank' do
let :rake_routes_result do
''
end

expect(AnnotateRoutes).to receive(:`).with('rake routes').and_return(rake_routes_result).once
end
context 'When the file does not contain magic comment' do
context 'When the file does not contain annotation yet' do
let :route_file_content do
''
end

let :rake_routes_result do
''
end
context 'When no option is specified' do
let :expected_result do
<<~EOS
context 'When the file does not contain magic comment' do
context 'When the file does not contain annotation yet' do
let :expected_result do
<<~EOS
# == Route Map
#
EOS
end

# == Route Map
#
EOS
end
it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once

let :route_file_content do
''
end
AnnotateRoutes.do_annotations
end
end

context 'When no option is specified' do
it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once
context 'When the option "ignore_routes" is specified' do
let :expected_result do
<<~EOS
AnnotateRoutes.do_annotations
end
end
# == Route Map
#
EOS
end

context 'When the option "ignore_routes" is specified' do
it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once
it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once

AnnotateRoutes.do_annotations(ignore_routes: 'my_route')
end
end
AnnotateRoutes.do_annotations(ignore_routes: 'my_route')
end
end

context 'When the option "position_in_routes" is specified as "top"' do
let :expected_result do
<<~EOS
# == Route Map
#
EOS
end
context 'When the option "position_in_routes" is specified as "top"' do
let :expected_result do
<<~EOS
# == Route Map
#
EOS
end

it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once
it 'inserts annotations' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once

AnnotateRoutes.do_annotations(position_in_routes: 'top')
AnnotateRoutes.do_annotations(position_in_routes: 'top')
end
end
end
end
end

context 'When the file already contains annotation' do
let :route_file_content do
<<~EOS
context 'When the file already contains annotation' do
context 'When no option is specified' do
let :route_file_content do
<<~EOS
# == Route Map
#
EOS
end
# == Route Map
#
EOS
end

it 'should skip annotations if file does already contain annotation' do
expect(File).not_to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
expect(mock_file).not_to receive(:puts)
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED).once
it 'should skip annotations if file does already contain annotation' do
expect(File).not_to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
expect(mock_file).not_to receive(:puts)
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED).once

AnnotateRoutes.do_annotations
AnnotateRoutes.do_annotations
end
end
end
end
end
end

context 'When the file contains magic comments' do
MAGIC_COMMENTS.each do |magic_comment|
describe "magic comment: #{magic_comment.inspect}" do
let :route_file_content do
<<~EOS
#{magic_comment}
Something
EOS
end
context 'When the file contains magic comments' do
MAGIC_COMMENTS.each do |magic_comment|
describe "magic comment: #{magic_comment.inspect}" do
let :route_file_content do
<<~EOS
#{magic_comment}
Something
EOS
end

context 'When the option "position_in_routes" is specified as "top"' do
let :expected_result do
<<~EOS
#{magic_comment}
context 'When the file does not contain annotation yet' do
context 'When the option "position_in_routes" is specified as "top"' do
let :expected_result do
<<~EOS
#{magic_comment}
# == Route Map
#
# == Route Map
#
Something
EOS
end
Something
EOS
end

it 'leaves magic comment on top and adds an empty line between magic comment and annotation' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once
it 'leaves magic comment on top and adds an empty line between magic comment and annotation' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once

AnnotateRoutes.do_annotations(position_in_routes: 'top')
end
end
AnnotateRoutes.do_annotations(position_in_routes: 'top')
end
end

context 'When the option "position_in_routes" is specified as "bottom"' do
let :expected_result do
<<~EOS
#{magic_comment}
Something
context 'When the option "position_in_routes" is specified as "bottom"' do
let :expected_result do
<<~EOS
#{magic_comment}
Something
# == Route Map
#
EOS
end
# == Route Map
#
EOS
end

it 'leaves magic comment on top and adds an empty line between magic comment and annotation' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once
it 'leaves magic comment on top and adds an empty line between magic comment and annotation' do
expect(File).to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file).once
expect(mock_file).to receive(:puts).with(expected_result).once
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_ANNOTATED).once

AnnotateRoutes.do_annotations(position_in_routes: 'bottom')
end
end
AnnotateRoutes.do_annotations(position_in_routes: 'bottom')
end
end
end

context 'When the file already contains annotation' do
let :route_file_content do
<<~EOS
#{magic_comment}
context 'When the file already contains annotation' do
let :route_file_content do
<<~EOS
#{magic_comment}
# == Route Map
#
EOS
end
# == Route Map
#
EOS
end

it 'skips annotations' do
expect(File).not_to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
expect(mock_file).not_to receive(:puts)
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED).once
it 'skips annotations' do
expect(File).not_to receive(:open).with(ROUTE_FILE, 'wb').and_yield(mock_file)
expect(mock_file).not_to receive(:puts)
expect(AnnotateRoutes).to receive(:puts).with(MESSAGE_UNCHANGED).once

AnnotateRoutes.do_annotations
AnnotateRoutes.do_annotations
end
end
end
end
end
Expand Down

0 comments on commit f5cff71

Please sign in to comment.