Skip to content

Fix shifted when format_markdown option enabled and used non-ascii #650

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

Merged
merged 1 commit into from
Nov 9, 2019
Merged

Fix shifted when format_markdown option enabled and used non-ascii #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .rubocop_todo.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -408,7 +408,7 @@ Lint/ShadowingOuterLocalVariable:

# Offense count: 20
Metrics/AbcSize:
Max: 138
Max: 139

# Offense count: 28
# Configuration parameters: CountComments, ExcludedMethods.
Expand Down
6 changes: 5 additions & 1 deletion lib/annotate/annotate_models.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ def get_schema_info(klass, header, options = {})
if options[:format_rdoc]
info << sprintf("# %-#{max_size}.#{max_size}s<tt>%s</tt>", "*#{col_name}*::", attrs.unshift(col_type).join(", ")).rstrip + "\n"
elsif options[:format_markdown]
name_remainder = max_size - col_name.length
name_remainder = max_size - col_name.length - non_ascii_length(col_name)
type_remainder = (md_type_allowance - 2) - col_type.length
info << (sprintf("# **`%s`**%#{name_remainder}s | `%s`%#{type_remainder}s | `%s`", col_name, " ", col_type, " ", attrs.join(", ").rstrip)).gsub('``', ' ').rstrip + "\n"
else
Expand Down Expand Up @@ -932,6 +932,10 @@ def mb_chars_ljust(string, length)
string[0..length-1]
end
end

def non_ascii_length(string)
string.to_s.chars.reject(&:ascii_only?).length
end
end

class BadModelFileError < LoadError
Expand Down
22 changes: 22 additions & 0 deletions spec/lib/annotate/annotate_models_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1046,6 +1046,28 @@ def self.when_called_with(options = {})
EOS
end

it 'should get schema info as Markdown with multibyte comment' do
klass = mock_class(:users,
:id,
[
mock_column(:id, :integer, comment: 'ＩＤ'),
mock_column(:name, :string, limit: 50, comment: 'ＮＡＭＥ')
])
expect(AnnotateModels.get_schema_info(klass, AnnotateModels::PREFIX, format_markdown: true, with_comment: true)).to eql(<<-EOS.strip_heredoc)
# #{AnnotateModels::PREFIX}
#
# Table name: `users`
#
# ### Columns
#
# Name | Type | Attributes
# --------------------- | ------------------ | ---------------------------
# **`id(ＩＤ)`** | `integer` | `not null, primary key`
# **`name(ＮＡＭＥ)`** | `string(50)` | `not null`
#
EOS
end

it 'should get schema info as Markdown' do
klass = mock_class(:users,
:id,
Expand Down