Skip to content

Fix rubocop violation (extra line added before model definition) #552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Fix rubocop violation (extra line added before model definition) #552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d34a590
Fix rubocop violation
a14m Apr 18, 2018
b5a28c2
Fix the specs after removing the extra \n
Apr 19, 2018
5209eaf
Retain the spaces before and after annotation block
Apr 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions lib/annotate/annotate_models.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -517,11 +517,7 @@ def annotate_one_file(file_name, info_block, position, options = {})
return false
else
# Replace inline the old schema info with the new schema info
new_content = old_content.sub(annotate_pattern(options), info_block + "\n")

if new_content.end_with?(info_block + "\n")
new_content = old_content.sub(annotate_pattern(options), "\n" + info_block)
end
new_content = old_content.sub(annotate_pattern(options), "\n" + info_block + "\n")

wrapper_open = options[:wrapper_open] ? "# #{options[:wrapper_open]}\n" : ""
wrapper_close = options[:wrapper_close] ? "# #{options[:wrapper_close]}\n" : ""
Expand All @@ -535,7 +531,7 @@ def annotate_one_file(file_name, info_block, position, options = {})
new_content = if %w(after bottom).include?(options[position].to_s)
magic_comments_block + (old_content.rstrip + "\n\n" + wrapped_info_block)
else
magic_comments_block + wrapped_info_block + "\n" + old_content
magic_comments_block + wrapped_info_block + old_content
end
end

Expand Down
18 changes: 9 additions & 9 deletions spec/annotate/annotate_models_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1553,7 +1553,7 @@ def magic_comments_list_each
it "should put annotation before class if :position == #{position}" do
annotate_one_file position: position
expect(File.read(@model_file_name))
.to eq("#{@schema_info}\n#{@file_content}")
.to eq("#{@schema_info}#{@file_content}")
end
end

Expand All @@ -1568,7 +1568,7 @@ def magic_comments_list_each
it 'should wrap annotation if wrapper is specified' do
annotate_one_file wrapper_open: 'START', wrapper_close: 'END'
expect(File.read(@model_file_name))
.to eq("# START\n#{@schema_info}# END\n\n#{@file_content}")
.to eq("# START\n#{@schema_info}# END\n#{@file_content}")
end

describe 'with existing annotation => :before' do
Expand All @@ -1580,12 +1580,12 @@ def magic_comments_list_each

it 'should retain current position' do
annotate_one_file
expect(File.read(@model_file_name)).to eq("#{@schema_info}\n#{@file_content}")
expect(File.read(@model_file_name)).to eq("\n#{@schema_info}\n#{@file_content}")
end

it 'should retain current position even when :position is changed to :after' do
annotate_one_file position: :after
expect(File.read(@model_file_name)).to eq("#{@schema_info}\n#{@file_content}")
expect(File.read(@model_file_name)).to eq("\n#{@schema_info}\n#{@file_content}")
end

it 'should change position to :after when force: true' do
Expand All @@ -1603,17 +1603,17 @@ def magic_comments_list_each

it 'should retain current position' do
annotate_one_file
expect(File.read(@model_file_name)).to eq("#{@file_content}\n#{@schema_info}")
expect(File.read(@model_file_name)).to eq("#{@file_content}\n#{@schema_info}\n")
end

it 'should retain current position even when :position is changed to :before' do
annotate_one_file position: :before
expect(File.read(@model_file_name)).to eq("#{@file_content}\n#{@schema_info}")
expect(File.read(@model_file_name)).to eq("#{@file_content}\n#{@schema_info}\n")
end

it 'should change position to :before when force: true' do
annotate_one_file position: :before, force: true
expect(File.read(@model_file_name)).to eq("#{@schema_info}\n#{@file_content}")
expect(File.read(@model_file_name)).to eq("#{@schema_info}#{@file_content}")
end
end

Expand All @@ -1637,7 +1637,7 @@ class Foo::User < ActiveRecord::Base
])
schema_info = AnnotateModels.get_schema_info(klass, '== Schema Info')
AnnotateModels.annotate_one_file(model_file_name, schema_info, position: :before)
expect(File.read(model_file_name)).to eq("#{schema_info}\n#{file_content}")
expect(File.read(model_file_name)).to eq("#{schema_info}#{file_content}")
end

it 'should not touch magic comments' do
Expand Down Expand Up @@ -1667,7 +1667,7 @@ class User < ActiveRecord::Base
annotate_one_file position: :before
schema_info = AnnotateModels.get_schema_info(@klass, '== Schema Info')

expect(File.read(model_file_name)).to eq("#{magic_comment}\n\n#{schema_info}\n#{content}")
expect(File.read(model_file_name)).to eq("#{magic_comment}\n\n#{schema_info}#{content}")
end
end

Expand Down