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.

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

Jump to bottom

Support YARD notation #724

Merged
merged 10 commits into from
Jan 24, 2020
Merged

Support YARD notation #724

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
84e0f49
start to work on format on yard
tvallois Jan 14, 2020
8857ace
add json and jsonb to ruby classes
tvallois Jan 15, 2020
bb4d4f0
map_col_type_to_ruby_classes should not be private
tvallois Jan 17, 2020
32c239b
add YARD Boolean type instead of FalseClass and TrueClass + specs
tvallois Jan 18, 2020
5720c4e
adding array support for yard
tvallois Jan 18, 2020
e3b9cfe
make the ci pass
tvallois Jan 18, 2020
55ce931
Merge branch 'develop' of git://github.com/ctran/annotate_models into…
tvallois Jan 18, 2020
cf303fd
set map_col_type_to_ruby_classes to private
tvallois Jan 22, 2020
3df1e1c
Merge branch 'develop' into develop
tvallois Jan 23, 2020
4f489b8
remove whitespace
tvallois Jan 23, 2020
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: 4 additions & 4 deletions .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: 141
Max: 155

# Offense count: 31
# Configuration parameters: CountComments, ExcludedMethods.
Expand All @@ -423,16 +423,16 @@ Metrics/BlockNesting:

# Offense count: 10
Metrics/CyclomaticComplexity:
Max: 36
Max: 41

# Offense count: 30
# Configuration parameters: CountComments, ExcludedMethods.
Metrics/MethodLength:
Max: 75
Max: 80

# Offense count: 8
Metrics/PerceivedComplexity:
Max: 42
Max: 47

# Offense count: 1
Naming/AccessorMethodName:
Expand Down
19 changes: 18 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 @@ -267,7 +267,7 @@ def get_schema_info(klass, header, options = {})
if col_type == 'decimal'
col_type << "(#{col.precision}, #{col.scale})"
elsif !%w[spatial geometry geography].include?(col_type)
if col.limit
if col.limit && !options[:format_yard]
if col.limit.is_a? Array
attrs << "(#{col.limit.join(', ')})"
else
Expand Down Expand Up @@ -306,6 +306,10 @@ def get_schema_info(klass, header, options = {})
end
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_yard]
info << sprintf("# @!attribute #{col_name}") + "\n"
ruby_class = col.respond_to?(:array) && col.array ? "Array<#{map_col_type_to_ruby_classes(col_type)}>": map_col_type_to_ruby_classes(col_type)
info << sprintf("# @return [#{ruby_class}]") + "\n"
elsif options[:format_markdown]
name_remainder = max_size - col_name.length - non_ascii_length(col_name)
type_remainder = (md_type_allowance - 2) - col_type.length
Expand Down Expand Up @@ -894,6 +898,19 @@ def classified_sort(cols)
([id] << rest_cols << timestamps << associations).flatten.compact
end

def map_col_type_to_ruby_classes(col_type)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just curious - can you elaborate why it should not be private and public instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, my first idea was that it can be reused somewhere else but seems not yet so i'll add it in private

case col_type
when 'integer' then Integer.to_s
when 'float' then Float.to_s
when 'decimal' then BigDecimal.to_s
when 'datetime', 'timestamp', 'time' then Time.to_s
when 'date' then Date.to_s
when 'text', 'string', 'binary', 'inet', 'uuid' then String.to_s
when 'json', 'jsonb' then Hash.to_s
when 'boolean' then 'Boolean'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this change any current behavior?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems not. Boolean is a class that YARD understand quite well. It's better than TrueClass and FalseClass

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you are referring to just the boolean case, Boolean is the string for what YARD expects a boolean type to be in the comments.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha

end
end

private

def with_comments?(klass, options)
Expand Down
2 changes: 1 addition & 1 deletion lib/annotate/constants.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module Constants
FLAG_OPTIONS = [
:show_indexes, :simple_indexes, :include_version, :exclude_tests,
:exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
:format_bare, :format_rdoc, :format_markdown, :sort, :force, :frozen,
:format_bare, :format_rdoc, :format_yard, :format_markdown, :sort, :force, :frozen,
:trace, :timestamp, :exclude_serializers, :classified_sort,
:show_foreign_keys, :show_complete_foreign_keys,
:exclude_scaffolds, :exclude_controllers, :exclude_helpers,
Expand Down
4 changes: 2 additions & 2 deletions lib/annotate/parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ def self.parse(args, env = {})
ANNOTATION_POSITIONS = %w[before top after bottom].freeze
FILE_TYPE_POSITIONS = %w[position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer].freeze
EXCLUSION_LIST = %w[tests fixtures factories serializers].freeze
FORMAT_TYPES = %w[bare rdoc markdown].freeze
FORMAT_TYPES = %w[bare rdoc yard markdown].freeze

def initialize(args, env)
@args = args
Expand Down Expand Up @@ -196,7 +196,7 @@ def add_options_to_parser(option_parser) # rubocop:disable Metrics/MethodLength
exclusions.each { |exclusion| env["exclude_#{exclusion}"] = 'yes' }
end

option_parser.on('-f', '--format [bare|rdoc|markdown]', FORMAT_TYPES, 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
option_parser.on('-f', '--format [bare|rdoc|yard|markdown]', FORMAT_TYPES, 'Render Schema Infomation as plain/RDoc/Yard/Markdown') do |fmt|
env["format_#{fmt}"] = 'yes'
end

Expand Down
1 change: 1 addition & 0 deletions lib/generators/annotate/templates/auto_annotate_models.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ if Rails.env.development?
'skip_on_db_migrate' => 'false',
'format_bare' => 'true',
'format_rdoc' => 'false',
'format_yard' => 'false',
'format_markdown' => 'false',
'sort' => 'false',
'force' => 'false',
Expand Down
1 change: 1 addition & 0 deletions lib/tasks/annotate_models.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ task annotate_models: :environment do
options[:ignore_model_sub_dir] = Annotate::Helpers.true?(ENV['ignore_model_sub_dir'])
options[:format_bare] = Annotate::Helpers.true?(ENV['format_bare'])
options[:format_rdoc] = Annotate::Helpers.true?(ENV['format_rdoc'])
options[:format_yard] = Annotate::Helpers.true?(ENV['format_yard'])
options[:format_markdown] = Annotate::Helpers.true?(ENV['format_markdown'])
options[:sort] = Annotate::Helpers.true?(ENV['sort'])
options[:force] = Annotate::Helpers.true?(ENV['force'])
Expand Down
1 change: 1 addition & 0 deletions spec/integration/rails_4.1.1/lib/tasks/auto_annotate_models.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ if Rails.env.development?
'skip_on_db_migrate' => "false",
'format_bare' => "true",
'format_rdoc' => "false",
'format_yard' => "false",
'format_markdown' => "false",
'sort' => "false",
'force' => "false",
Expand Down
1 change: 1 addition & 0 deletions spec/integration/rails_4.2.0/lib/tasks/auto_annotate_models.rake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ if Rails.env.development?
'skip_on_db_migrate' => "false",
'format_bare' => "true",
'format_rdoc' => "false",
'format_yard' => "false",
'format_markdown' => "false",
'sort' => "false",
'force' => "false",
Expand Down
20 changes: 20 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 @@ -555,6 +555,26 @@ def mock_column(name, type, options = {})
EOS
end

it 'should get schema info as YARD' do
klass = mock_class(:users,
:id,
[
mock_column(:id, :integer),
mock_column(:name, :string, limit: 50),
])
expect(AnnotateModels.get_schema_info(klass, AnnotateModels::PREFIX, format_yard: true)).to eql(<<-EOS)
# #{AnnotateModels::PREFIX}
#
# Table name: users
#
# @!attribute id
# @return [Integer]
# @!attribute name
# @return [String]
#
EOS
end

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