Skip to content
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.

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

Fix annotate_one_file to avoid ignoring commented columns #1010

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion lib/annotate/annotate_models.rb
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,9 @@ def annotate_one_file(file_name, info_block, position, options = {})
old_header = old_content.match(header_pattern).to_s
new_header = info_block.match(header_pattern).to_s

column_pattern = /^#[\t ]+[\w\*\.`]+[\t ]+.+$/
column_name_pattern = '[\w\*\.`]+'
comment_pattern = '(?:\(.+\))?'
column_pattern = /^#[\t ]+#{column_name_pattern}#{comment_pattern}[\t ]+.+$/
old_columns = old_header && old_header.scan(column_pattern).sort
new_columns = new_header && new_header.scan(column_pattern).sort

Expand Down
29 changes: 29 additions & 0 deletions spec/lib/annotate/annotate_models_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2922,6 +2922,35 @@ def annotate_one_file(options = {})
expect(File.read(@model_file_name)).to eq("#{@schema_info}#{@file_content}")
end
end

context 'of commented columns' do
before do
klass = mock_class(:users,
:id,
[
mock_column(:id, :integer, comment: 'primary key'),
mock_column(:name, :string, comment: 'with comment')
],
[],
[])
@schema_info = AnnotateModels.get_schema_info(klass, '== Schema Info', with_comment: true)
annotate_one_file
end

it 'should update a commented column' do
klass = mock_class(:users,
:id,
[
mock_column(:id, :integer, comment: 'primary key'),
mock_column(:name, :text, comment: 'with multibyte comment')
],
[],
[])
@schema_info = AnnotateModels.get_schema_info(klass, '== Schema Info', with_comment: true)
annotate_one_file
expect(File.read(@model_file_name)).to eq("#{@schema_info}#{@file_content}")
end
end
end

describe 'with existing annotation => :before' do
Expand Down
Loading