# Inch CI

troessner/reek Reek

Code smell detector for Ruby

Refresh
#190 (all)
Ruby (change)
67 seconds
over 1 year ago
Build History Evaluation Suggestions 20+   Read the docs

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

Seems really good
A
Reek::Spec::ShouldReekOf N
A
Reek::CLI::Options N
A
Reek::Examiner#initialize N
A
Reek::CodeComment::CodeCommentValidator Ne
A
Reek::SmellDetectors::BaseDetector Ne
Show 264 more ...
Proper documentation present
B
Reek::CodeComment::CodeCommentValidator#initialize N
B
Reek::Report::BaseReport#initialize N
B
Reek::SmellWarning#initialize Ne
B
Reek::AST::Node#each_node Ne
B
Reek::Source::SourceCode#initialize Ne
Show 27 more ...
Please take a look
C
Reek::SmellDetectors::UnusedPrivateMethod#sniff Ne
C
Reek::Context::ModuleContext#node_instance_methods E
C
Reek::Rake::Task#initialize E
Undocumented
U
Reek::Errors::GarbageDetectorConfigurationInCommentError#initialize N
U
Reek::Errors::BadDetectorConfigurationKeyInCommentError#initialize N
U
Reek::Errors::BadDetectorInCommentError#initialize N
U
Reek::SmellWarning#to_hash N
U
Reek::Report Ne
U
Reek::SmellDetectors::ControlParameter::ControlParameterCollector#control_parameters Ne
U
Reek::SmellDetectors::ControlParameter::ControlParameterCollector#initialize Ne
U
Reek::SmellDetectors::ControlParameter::ControlParameterFinder#find_matches Ne
U
Reek::SmellDetectors::ControlParameter::ControlParameterFinder#initialize Ne
U
Reek::SmellDetectors::ControlParameter::FoundControlParameter#initialize Ne
U
Reek::SmellDetectors::NilCheck::NilCallNodeDetector.comparison_methods Ne
U
Reek::SmellDetectors::DuplicateMethodCall::CallCollector#smelly_calls Ne
U
Reek::SmellDetectors::DuplicateMethodCall::CallCollector#initialize Ne
U
Reek::SmellDetectors::ControlParameter::FoundControlParameter#lines Ne
U
Reek::SmellDetectors::ControlParameter::FoundControlParameter#name Ne
U
Reek::SmellDetectors::NilCheck::SafeNavigationNodeDetector.detect Ne
U
Reek::SmellDetectors::DuplicateMethodCall::CallCollector#context Ne
U
Reek::SmellDetectors::DuplicateMethodCall::FoundCall#initialize Ne
U
Reek::SmellDetectors::DuplicateMethodCall::CallCollector#calls Ne
U
Reek::Report::Formatter::HeadingFormatterBase#report_formatter Ne
U
Reek::Report::Formatter::ProgressFormatter::Base#sources_count Ne
U
Reek::SmellDetectors::DuplicateMethodCall::FoundCall#record Ne
U
Reek::Report::Formatter::ProgressFormatter::Base#initialize Ne
U
Reek::Report::Formatter::SingleLineLocationFormatter.format Ne
U
Reek::SmellDetectors::DuplicateMethodCall::FoundCall#occurs Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#name_without_bang Ne
U
Reek::Report::Formatter::SimpleWarningFormatter#initialize Ne
U
Reek::SmellDetectors::NilCheck::NilCallNodeDetector.detect Ne
U
Reek::SmellDetectors::NilCheck::NilWhenNodeDetector.detect Ne
U
Reek::SmellDetectors::DuplicateMethodCall::FoundCall#lines Ne
U
Reek::SmellDetectors::DuplicateMethodCall::FoundCall#call Ne
U
Reek::Report::Formatter::ProgressFormatter::Base#progress Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#parameter_names Ne
U
Reek::SmellDetectors::BaseDetector.todo_configuration_for Ne
U
Reek::SmellDetectors::UnusedPrivateMethod::Hit#initialize Ne
U
Reek::Report::Formatter::DefaultLocationFormatter.format Ne
U
Reek::Report::Formatter::HeadingFormatterBase#initialize Ne
U
Reek::Report::Formatter::ProgressFormatter::Base#footer Ne
U
Reek::SmellDetectors::NilCheck::NodeFinder#smelly_nodes Ne
U
Reek::AST::SexpExtensions::LogicOperatorBase#body_nodes Ne
U
Reek::AST::SexpExtensions::NestedAssignables#components Ne
U
Reek::Report::Formatter::ProgressFormatter::Base#header Ne
U
Reek::SmellDetectors::NestedIterators::Iterator#depth= Ne
U
Reek::Report::Formatter::BlankLocationFormatter.format Ne
U
Reek::AST::SexpExtensions::LogicOperatorBase#condition Ne
U
Reek::Report::Formatter::SimpleWarningFormatter#format Ne
U
Reek::SmellDetectors::NestedIterators::Iterator#depth Ne
U
Reek::Spec::ShouldReekOf#failure_message_when_negated Ne
U
Reek::SmellDetectors::NilCheck::NodeFinder#initialize Ne
U
Reek::Context::ModuleContext#defined_instance_methods Ne
U
Reek::SmellDetectors::Syntax::DummyContext#full_name= Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#parameters Ne
U
Reek::Report::Formatter::HeadingFormatterBase#header Ne
U
Reek::Errors::IncomprehensibleSourceError#initialize Ne
U
Reek::SmellDetectors::Syntax::DummyContext#full_name Ne
U
Reek::AST::SexpExtensions::BlockNode#parameter_names Ne
U
Reek::SmellDetectors::NestedIterators::Iterator#exp= Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#body_nodes Ne
U
Reek::SmellDetectors::NestedIterators::Iterator#exp Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#arguments Ne
U
Reek::Spec::ShouldReek#failure_message_when_negated Ne
U
Reek::Context::CodeContext#apply_current_visibility Ne
U
Reek::AST::SexpExtensions::MethodNodeBase#arg_names Ne
U
Reek::Context::ModuleContext#instance_method_calls Ne
U
Reek::AST::SexpExtensions::WhenNode#condition_list Ne
U
Reek::Context::MethodContext#method_context_class Ne
U
Reek::AST::SexpExtensions::ArgNodeBase#plain_name Ne
U
Reek::AST::SexpExtensions::ArgNodeBase#components Ne
U
Reek::Configuration::AppConfiguration#load_values Ne
U
Reek::AST::SexpExtensions::BlockNode#simple_name Ne
U
Reek::AST::SexpExtensions::SendNode#participants Ne
U
Reek::AST::SexpExtensions::ConstNode#simple_name Ne
U
Reek::Context::MethodContext#default_assignments Ne
U
Reek::AST::SexpExtensions::ClassNode#superclass Ne
U
Reek::Context::CodeContext#number_of_statements Ne
U
Reek::AST::SexpExtensions::BlockNode#parameters Ne
U
Reek::Report::CodeClimateFingerprint#initialize Ne
U
Reek::SmellDetectors::Syntax::DummyContext#exp= Ne
U
Reek::Context::ModuleContext#visibility_tracker Ne
U
Reek::SmellDetectors::Syntax.smells_from_source Ne
U
Reek::AST::ReferenceCollector#num_refs_to_self Ne
U
Reek::AST::SexpExtensions::ConstNode#namespace Ne
U
Reek::AST::SexpExtensions::CaseNode#body_nodes Ne
U
Reek::SmellDetectors::Syntax::DummyContext#exp Ne
U
Reek::AST::SexpExtensions::ModuleNodeBase#name Ne
U
Reek::AST::SexpExtensions::YieldNode#arg_names Ne
U
Reek::SmellDetectors::Syntax::DummyExp#source= Ne
U
Reek::Report::CodeClimateFormatter#initialize Ne
U
Reek::SmellDetectors::BaseDetector#initialize Ne
U
Reek::SmellDetectors::BaseDetector#smell_type Ne
U
Reek::SmellDetectors::Syntax::DummyExp#source Ne
U
Reek::AST::SexpExtensions::CaseNode#condition Ne
U
Reek::AST::SexpExtensions::CaseNode#else_body Ne
U
Reek::SmellDetectors::BaseDetector.smell_type Ne
U
Reek::AST::SexpExtensions::DefsNode#full_name Ne
U
Reek::Configuration::AppConfiguration.default Ne
U
Reek::Context::ModuleContext#track_visibility Ne
U
Reek::Context::CodeContext#record_use_of_self Ne
U
Reek::Report::CodeClimateFingerprint#compute Ne
U
Reek::Context::CodeContext#statement_counter Ne
U
Reek::AST::SexpExtensions::AttrasgnNode#args Ne
U
Reek::AST::SexpExtensions::SendNode#receiver Ne
U
Reek::AST::SexpExtensions::VariableBase#name Ne
U
Reek::AST::SexpExtensions::DefNode#full_name Ne
U
Reek::AST::SexpExtensions::LvarNode#var_name Ne
U
Reek::AST::SexpExtensions::DefsNode#receiver Ne
U
Reek::AST::SexpExtensions::IfNode#body_nodes Ne
U
Reek::AST::SexpExtensions::SymNode#full_name Ne
U
Reek::AST::SexpExtensions::DefsNode#argslist Ne
U
Reek::SmellDetectors::BaseDetector.contexts Ne
U
Reek::Report::CodeClimateConfiguration.load Ne
U
Reek::AST::SexpExtensions::ArgNodeBase#name Ne
U
Reek::Context::AttributeContext#visibility= Ne
U
Reek::AST::SexpExtensions::IfNode#condition Ne
U
Reek::AST::SexpExtensions::DefNode#argslist Ne
U
Reek::Context::StatementCounter#decrease_by Ne
U
Reek::Context::StatementCounter#increase_by Ne
U
Reek::CLI::Command::TodoListCommand#execute Ne
U
Reek::Context::AttributeContext#visibility Ne
U
Reek::AST::SexpExtensions::LambdaNode#name Ne
U
Reek::AST::SexpExtensions::BlockNode#block Ne
U
Reek::CLI::Command::BaseCommand#initialize Ne
U
Reek::AST::SexpExtensions::BlockNode#args Ne
U
Reek::Configuration::DefaultDirective#add Ne
U
Reek::AST::SexpExtensions::CasgnNode#name Ne
U
Reek::AST::SexpExtensions::BlockNode#call Ne
U
Reek::SmellDetectors::BaseDetector#config Ne
U
Reek::AST::SexpExtensions::YieldNode#args Ne
U
Reek::Report::CodeClimateFormatter#render Ne
U
Reek::AST::SexpExtensions::SuperNode#name Ne
U
Reek::CLI::Command::ReportCommand#execute Ne
U
Reek::AST::SexpExtensions::LitNode#value Ne
U
Reek::AST::SexpExtensions::SendNode#args Ne
U
Reek::Spec::ShouldReekOf#failure_message Ne
U
Reek::AST::ReferenceCollector#initialize Ne
U
Reek::AST::ASTNodeClassMap#extension_map Ne
U
Reek::Context::MethodContext#visibility= Ne
U
Reek::AST::SexpExtensions::SelfNode#name Ne
U
Reek::AST::SexpExtensions::DefsNode#body Ne
U
Reek::AST::SexpExtensions::SendNode#name Ne
U
Reek::AST::SexpExtensions::WhenNode#body Ne
U
Reek::AST::SexpExtensions::DefsNode#name Ne
U
Reek::AST::SexpExtensions::DefNode#body Ne
U
Reek::AST::SexpExtensions::DefNode#name Ne
U
Reek::Context::MethodContext#visibility Ne
U
Reek::AST::SexpExtensions::SymNode#name Ne
U
Reek::SmellDetectors::BaseDetector#run Ne
U
Reek::Spec::SmellMatcher#smell_warning Ne
U
Reek::Errors::EncodingError#initialize Ne
U
Reek::Spec::ShouldReek#failure_message Ne
U
Reek::SmellConfiguration#overrides_for Ne
U
Reek::CLI::Options#generate_todo_list= Ne
U
Reek::CLI::Options#failure_exit_code= Ne
U
Reek::CLI::Options#success_exit_code= Ne
U
Reek::Context::CodeContext#config_for Ne
U
Reek::CLI::Options#generate_todo_list Ne
U
Reek::Context::StatementCounter#value Ne
U
Reek::AST::ASTNodeClassMap#klass_for Ne
U
Reek::Source::SourceCode#syntax_tree Ne
U
Reek::Source::SourceCode#diagnostics Ne
U
Reek::CLI::Options#failure_exit_code Ne
U
Reek::Spec::ShouldReekOf#with_config Ne
U
Reek::SmellDetectors::NilCheck#sniff Ne
U
Reek::Context::CodeContext#full_name Ne
U
Reek::CLI::Options#success_exit_code Ne
U
Reek::CLI::Application#configuration Ne
U
Reek::Spec::ShouldReekOf#initialize Ne
U
Reek::Context::CodeContext#children Ne
U
Reek::CLI::Options#smells_to_detect Ne
U
Reek::AST::ObjectRefs#references_to Ne
U
Reek::Report::Formatter.format_list Ne
U
Reek::CLI::Options#location_format= Ne
U
Reek::DetectorRepository#initialize Ne
U
Reek::CLI::Options#progress_format= Ne
U
Reek::Spec::SmellMatcher#initialize Ne
U
Reek::CLI::Options#force_exclusion= Ne
U
Reek::SmellConfiguration#initialize Ne
U
Reek::CLI::Options#location_format Ne
U
Reek::CLI::Options#force_exclusion Ne
U
Reek::CLI::Options#progress_format Ne
U
Reek::Examiner::NullHandler#handle Ne
U
Reek::Spec::ShouldReek#initialize Ne
U
Reek::CLI::Options#report_format= Ne
U
Reek::ContextBuilder#context_tree Ne
U
Reek::Context::CodeContext#parent Ne
U
Reek::CLI::Application#initialize Ne
U
Reek::SmellWarning#smell_detector Ne
U
Reek::LoggingErrorHandler#handle Ne
U
Reek::DetectorRepository#examine Ne
U
Reek::CLI::Options#report_format Ne
U
Reek::Source::SourceCode#origin Ne
U
Reek::Context::RootContext#type Ne
U
Reek::CLI::Options#config_file= Ne
U
Reek::AST::Node#leading_comment Ne
U
Reek::Report::BaseReport#smells Ne
U
Reek::ContextBuilder#initialize Ne
U
Reek::SmellWarning#base_message Ne
U
Reek::Context::SendContext#name Ne
U
Reek::Report::Formatter.header Ne
U
Reek::SmellConfiguration#merge Ne
U
Reek::SmellWarning#smell_class Ne
U
Reek::Context::CodeContext#exp Ne
U
Reek::CLI::Options#show_links= Ne
U
Reek::CLI::Application#execute Ne
U
Reek::CLI::Options#show_empty= Ne
U
Reek::CLI::Options#config_file Ne
U
Reek::Rake::Task#source_files= Ne
U
Reek::CLI::Options#show_empty Ne
U
Reek::CLI::Options#show_links Ne
U
Reek::CLI::Options#initialize Ne
U
Reek::SmellWarning#parameters Ne
U
Reek::AST::Node#full_comment Ne
U
Reek::TreeDresser#initialize Ne
U
Reek::CLI::Options#colored= Ne
U
Reek::CLI::Options#sorting= Ne
U
Reek::CLI::Options#sorting Ne
U
Reek::Overrides#initialize Ne
U
Reek::SmellWarning#context Ne
U
Reek::CLI::Options#colored Ne
U
Reek::AST::Node#initialize Ne
U
Reek::SmellWarning#message Ne
U
Reek::CLI::Options#parser Ne
U
Reek::SmellWarning#source Ne
U
Reek::CodeComment#config Ne
U
Reek::SmellWarning#lines Ne
U
Reek::CLI::Options#parse Ne
U
Reek::CLI::Options#argv Ne
U
Reek::SmellWarning#hash Ne
U
Reek::SmellWarning#<=> Ne
U
Reek::AST::Node#source Ne
U
Reek::AST::Node#line Ne
U
Reek::Report::BaseReport#total_smell_count= E
U
Reek::Report::BaseReport#total_smell_count E
U
Reek::SmellWarning#identifying_values E
U
Reek::AST::SexpExtensions E
U
Reek::Context::SingletonMethodContext#apply_current_visibility E
U
Reek::SmellDetectors::UncommunicativeVariableName.contexts E
U
Reek::Report::Formatter::ProgressFormatter::Quiet#progress E
U
Reek::SmellDetectors::InstanceVariableAssumption.contexts E
U
Reek::Spec::ShouldReekOnlyOf#failure_message_when_negated E
U
Reek::Report::Formatter::ProgressFormatter::Dots#progress E
U
Reek::Report::Formatter::WikiLinkWarningFormatter#format E
U
Reek::SmellDetectors::UncommunicativeModuleName.contexts E
U
Reek::Report::Formatter::ProgressFormatter::Quiet#header E
U
Reek::Report::Formatter::ProgressFormatter::Quiet#footer E
U
Reek::Context::AttributeContext#apply_current_visibility E
U
Reek::SmellDetectors::TooManyInstanceVariables.contexts E
U
Reek::Report::Formatter::ProgressFormatter::Dots#header E
U
Reek::Report::Formatter::ProgressFormatter::Dots#footer E
U
Reek::SmellDetectors::SubclassedFromCoreClass.contexts E
U
Reek::Context::MethodContext#apply_current_visibility E
U
Reek::SmellDetectors::UnusedPrivateMethod.contexts E
U
Reek::SmellDetectors::IrresponsibleModule.contexts E
U
Reek::SmellDetectors::TooManyConstants.contexts E
U
Reek::Context::GhostContext#record_use_of_self E
U
Reek::SmellDetectors::TooManyMethods.contexts E
U
Reek::Context::GhostContext#statement_counter E
U
Reek::Spec::ShouldReekOnlyOf#failure_message E
U
Reek::Context::GhostContext#track_visibility E
U
Reek::Context::AttributeContext#full_comment E
U
Reek::Context::MethodContext#full_comment E
U
Reek::SmellDetectors::Syntax.contexts E
U
Reek::Context::GhostContext#children E
U
Reek::Context::RootContext#full_name E
U
Reek::Context::MethodContext#refs E
U
Reek::CLI::Status E
Everything Inch CI

Let's raise the visibility of documentation in Open Source!

This page is for troessner/reek and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.

Inch CI evaluates your project's inline code documentation and reports grades for each class, module and method.

It is an open source project, created by René Föhring (@rrrene), based on Inch.

Please create an issue if anything seems broken or worthy of improvement.

Sign in with GitHub | Contact | Imprint | Data privacy | Blog