[Ruby] RuboCop 0.35.0: Analizador estático de código Ruby

RuboCop es un analizador estático de código Ruby. Por defecto hace cumplir varias de las directrices que de la Guía de Estilo Ruby de la comunidad. Se pueden configurar varios aspectos de su comportamiento a través de opciones de configuración.

Instalación

La instalación es sencilla en la línea de comandos:

Código:

$ gem install rubocop

Y ya nos queda disponible. También podemos agregar la gema a nuestro Gemfile:

Código:

gem 'rubocop', require: false

Si ejecutamos rubocop desde la línea de comandos, va a revisar todo los archivos de código Ruby del directorio desde donde lo ejecutemos. También le podemos pasar como parámetro uno o más archivos específicos para revisar. Con rubocop -h vemos las opciones entre las cuales están -R para proyectos Rails, especificar un archivo de configuración en particular, un formato para la salida y más.

En estos días salió la versión 0.35 de RuboCop con correcciones, mejoras, nuevos “cops” (los chequeos que hace RuboCop) y una funcionalidad de cacheo. Esto hace que al volver a correr RuboCop sobre el mismo código el proceso sea mucho mas rápido. También ahora el proyecto cuenta con una campaña de crowdfunding para financiar su desarrollo. Si les gusta o usan RuboCop, pueden colaborar con el proyecto y ayudar a que se siga manteniendo desde este enlace.

Empecé a usar RuboCop por la línea de comando. Al crear código nuevo, antes de agregarlo a control de versiones, lo revisaba con RuboCob y corregía los atentados a la guía de estilo de Ruby. Pero desde hace un tiempo uso la integración con Emacs. RuboCop tiene su propio modo rubocop-emacs (creado y mantenido por el mismo autor de RuboCop) pero además flycheck (un modo de chequeo de sintaxis para Emacs) soporta RuboCop y lo usa por defecto cuando está disponible:

Como ven señala las líneas que tienen algún tipo de atentado a las guías de estilo, y en el minibuffer nos explica qué tenemos mal.

Además de Emacs, RuboCop tiene integración con Vim, Sublime, Atom, RubyMine y otros editores más. Cada proyecto puede tener sus propias convenciones de código, pero eso se podría especificar en un archivo de configuración de RuboCop para ese proyecto.

Codigo Fuente

Modulo Rubocop

Código:

# encoding: utf-8



module RuboCop

  # The CLI is a class responsible of handling all the command line interface

  # logic.

  class CLI

    include Formatter::TextUtil



    attr_reader :options, :config_store



    def initialize

      @options = {}

      @config_store = ConfigStore.new

    end



    # Entry point for the application logic. Here we

    # do the command line arguments processing and inspect

    # the target files

    # @return [Fixnum] UNIX exit code

    def run(args = ARGV)

      @options, paths = Options.new.parse(args)

      act_on_options



      runner = Runner.new(@options, @config_store)

      trap_interrupt(runner)

      all_passed = runner.run(paths)

      display_warning_summary(runner.warnings)

      display_error_summary(runner.errors)



      all_passed && !runner.aborting? && runner.errors.empty? ? 0 : 1

    rescue Cop::AmbiguousCopName => e

      $stderr.puts "Ambiguous cop name #{e.message} needs namespace " \

                   'qualifier.'

      return 1

    rescue StandardError, SyntaxError => e

      $stderr.puts e.message

      $stderr.puts e.backtrace

      return 1

    end



    def trap_interrupt(runner)

      Signal.trap('INT') do

        exit!(1) if runner.aborting?

        runner.abort

        $stderr.puts

        $stderr.puts 'Exiting... Interrupt again to exit immediately.'

      end

    end



    private



    def act_on_options

      handle_exiting_options



      ConfigLoader.debug = @options[:debug]

      ConfigLoader.auto_gen_config = @options[:auto_gen_config]

      ConfigLoader.exclude_limit = @options[:exclude_limit]



      @config_store.options_config = @options[:config] if @options[:config]



      Rainbow.enabled = false unless @options[:color]

    end



    def handle_exiting_options

      return unless Options::EXITING_OPTIONS.any? { |o| @options.key? o }



      puts RuboCop::Version.version(false) if @options[:version]

      puts RuboCop::Version.version(true) if @options[:verbose_version]

      print_available_cops if @options[:show_cops]

      exit(0)

    end



    def print_available_cops

      cops = Cop::Cop.all

      show_all = @options[:show_cops].empty?



      if show_all

        puts "# Available cops (#{cops.length}) + config for #{Dir.pwd}: "

      end



      cops.types.sort!.each { |type| print_cops_of_type(cops, type, show_all) }

    end



    def print_cops_of_type(cops, type, show_all)

      cops_of_this_type = cops.with_type(type).sort_by!(&:cop_name)



      if show_all

        puts "# Type '#{type.to_s.capitalize}' (#{cops_of_this_type.size}):"

      end



      selected_cops = cops_of_this_type.select do |cop|

        show_all || @options[:show_cops].include?(cop.cop_name)

      end



      selected_cops.each do |cop|

        puts '# Supports --auto-correct' if cop.new.support_autocorrect?

        puts "#{cop.cop_name}:"

        cnf = @config_store.for(Dir.pwd.to_s).for_cop(cop)

        puts cnf.to_yaml.lines.to_a[1..-1].map { |line| '  ' + line }

        puts

      end

    end



    def display_warning_summary(warnings)

      return if warnings.empty?



      warn Rainbow("\n#{pluralize(warnings.size, 'warning')}:").yellow



      warnings.each { |warning| warn warning }

    end



    def display_error_summary(errors)

      return if errors.empty?



      warn Rainbow("\n#{pluralize(errors.size, 'error')} occurred:").red



      errors.each { |error| warn error }



      warn <<-END.strip_indent

        Errors are usually caused by RuboCop bugs.

        Please, report your problems to RuboCop's issue tracker.

        Mention the following information in the issue report:

        #{RuboCop::Version.version(true)}

      END

    end

  end

end

Librerias Rubocop

Código:

# encoding: utf-8



require 'parser/current'

require 'rainbow'



require 'English'

require 'set'

require 'ast/sexp'

require 'powerpack/enumerable/drop_last'

require 'powerpack/hash/symbolize_keys'

require 'powerpack/string/blank'

require 'powerpack/string/strip_indent'



require 'rubocop/version'



require 'rubocop/path_util'

require 'rubocop/string_util'

require 'rubocop/node_pattern'

require 'rubocop/ast_node'



require 'rubocop/cop/util'

require 'rubocop/cop/offense'

require 'rubocop/cop/ignored_node'

require 'rubocop/cop/autocorrect_logic'

require 'rubocop/cop/cop'

require 'rubocop/cop/commissioner'

require 'rubocop/cop/corrector'

require 'rubocop/cop/force'

require 'rubocop/cop/team'

require 'rubocop/cop/severity'



require 'rubocop/cop/variable_force'

require 'rubocop/cop/variable_force/locatable'

require 'rubocop/cop/variable_force/variable'

require 'rubocop/cop/variable_force/assignment'

require 'rubocop/cop/variable_force/reference'

require 'rubocop/cop/variable_force/scope'

require 'rubocop/cop/variable_force/variable_table'



require 'rubocop/cop/mixin/access_modifier_node'

require 'rubocop/cop/mixin/annotation_comment'

require 'rubocop/cop/mixin/array_syntax'

require 'rubocop/cop/mixin/autocorrect_alignment'

require 'rubocop/cop/mixin/autocorrect_unless_changing_ast'

require 'rubocop/cop/mixin/check_assignment'

require 'rubocop/cop/mixin/configurable_max'

require 'rubocop/cop/mixin/code_length'

require 'rubocop/cop/mixin/classish_length'

require 'rubocop/cop/mixin/configurable_enforced_style'

require 'rubocop/cop/mixin/configurable_naming'

require 'rubocop/cop/mixin/empty_lines_around_body'

require 'rubocop/cop/mixin/end_keyword_alignment'

require 'rubocop/cop/mixin/first_element_line_break'

require 'rubocop/cop/mixin/if_node'

require 'rubocop/cop/mixin/negative_conditional'

require 'rubocop/cop/mixin/on_method_def'

require 'rubocop/cop/mixin/method_complexity'

require 'rubocop/cop/mixin/method_preference'

require 'rubocop/cop/mixin/min_body_length'

require 'rubocop/cop/mixin/on_normal_if_unless'

require 'rubocop/cop/mixin/parser_diagnostic'

require 'rubocop/cop/mixin/percent_literal'

require 'rubocop/cop/mixin/safe_assignment'

require 'rubocop/cop/mixin/surrounding_space'

require 'rubocop/cop/mixin/space_inside'

require 'rubocop/cop/mixin/space_after_punctuation'

require 'rubocop/cop/mixin/space_before_punctuation'

require 'rubocop/cop/mixin/statement_modifier'

require 'rubocop/cop/mixin/string_help'

require 'rubocop/cop/mixin/string_literals_help'

require 'rubocop/cop/mixin/unused_argument'



require 'rubocop/cop/lint/ambiguous_operator'

require 'rubocop/cop/lint/ambiguous_regexp_literal'

require 'rubocop/cop/lint/assignment_in_condition'

require 'rubocop/cop/lint/block_alignment'

require 'rubocop/cop/lint/circular_argument_reference'

require 'rubocop/cop/lint/condition_position'

require 'rubocop/cop/lint/debugger'

require 'rubocop/cop/lint/def_end_alignment'

require 'rubocop/cop/lint/deprecated_class_methods'

require 'rubocop/cop/lint/duplicate_methods'

require 'rubocop/cop/lint/duplicated_key'

require 'rubocop/cop/lint/each_with_object_argument'

require 'rubocop/cop/lint/else_layout'

require 'rubocop/cop/lint/empty_ensure'

require 'rubocop/cop/lint/empty_interpolation'

require 'rubocop/cop/lint/end_alignment'

require 'rubocop/cop/lint/end_in_method'

require 'rubocop/cop/lint/ensure_return'

require 'rubocop/cop/lint/eval'

require 'rubocop/cop/lint/format_parameter_mismatch'

require 'rubocop/cop/lint/handle_exceptions'

require 'rubocop/cop/lint/invalid_character_literal'

require 'rubocop/cop/lint/literal_in_condition'

require 'rubocop/cop/lint/literal_in_interpolation'

require 'rubocop/cop/lint/loop'

require 'rubocop/cop/lint/nested_method_definition'

require 'rubocop/cop/lint/non_local_exit_from_iterator'

require 'rubocop/cop/lint/parentheses_as_grouped_expression'

require 'rubocop/cop/lint/require_parentheses'

require 'rubocop/cop/lint/rescue_exception'

require 'rubocop/cop/lint/shadowing_outer_local_variable'

require 'rubocop/cop/lint/space_before_first_arg'

require 'rubocop/cop/lint/string_conversion_in_interpolation'

require 'rubocop/cop/lint/syntax'

require 'rubocop/cop/lint/underscore_prefixed_variable_name'

require 'rubocop/cop/lint/unneeded_disable'

require 'rubocop/cop/lint/unreachable_code'

require 'rubocop/cop/lint/unused_block_argument'

require 'rubocop/cop/lint/unused_method_argument'

require 'rubocop/cop/lint/useless_access_modifier'

require 'rubocop/cop/lint/useless_assignment'

require 'rubocop/cop/lint/useless_comparison'

require 'rubocop/cop/lint/useless_else_without_rescue'

require 'rubocop/cop/lint/useless_setter_call'

require 'rubocop/cop/lint/void'



require 'rubocop/cop/metrics/block_nesting'

require 'rubocop/cop/metrics/class_length'

require 'rubocop/cop/metrics/module_length'

require 'rubocop/cop/metrics/cyclomatic_complexity'

require 'rubocop/cop/metrics/abc_size'

require 'rubocop/cop/metrics/line_length'

require 'rubocop/cop/metrics/method_length'

require 'rubocop/cop/metrics/parameter_lists'

require 'rubocop/cop/metrics/perceived_complexity'



require 'rubocop/cop/performance/case_when_splat'

require 'rubocop/cop/performance/count'

require 'rubocop/cop/performance/detect'

require 'rubocop/cop/performance/fixed_size'

require 'rubocop/cop/performance/flat_map'

require 'rubocop/cop/performance/reverse_each'

require 'rubocop/cop/performance/sample'

require 'rubocop/cop/performance/size'

require 'rubocop/cop/performance/string_replacement'



require 'rubocop/cop/style/access_modifier_indentation'

require 'rubocop/cop/style/accessor_method_name'

require 'rubocop/cop/style/alias'

require 'rubocop/cop/style/align_array'

require 'rubocop/cop/style/align_hash'

require 'rubocop/cop/style/align_parameters'

require 'rubocop/cop/style/and_or'

require 'rubocop/cop/style/array_join'

require 'rubocop/cop/style/ascii_comments'

require 'rubocop/cop/style/ascii_identifiers'

require 'rubocop/cop/style/attr'

require 'rubocop/cop/style/auto_resource_cleanup'

require 'rubocop/cop/style/bare_percent_literals'

require 'rubocop/cop/style/begin_block'

require 'rubocop/cop/style/block_comments'

require 'rubocop/cop/style/block_end_newline'

require 'rubocop/cop/style/block_delimiters'

require 'rubocop/cop/style/braces_around_hash_parameters'

require 'rubocop/cop/style/case_equality'

require 'rubocop/cop/style/case_indentation'

require 'rubocop/cop/style/character_literal'

require 'rubocop/cop/style/class_and_module_camel_case'

require 'rubocop/cop/style/class_and_module_children'

require 'rubocop/cop/style/class_check'

require 'rubocop/cop/style/class_methods'

require 'rubocop/cop/style/class_vars'

require 'rubocop/cop/style/closing_parenthesis_indentation'

require 'rubocop/cop/style/collection_methods'

require 'rubocop/cop/style/colon_method_call'

require 'rubocop/cop/style/command_literal'

require 'rubocop/cop/style/comment_annotation'

require 'rubocop/cop/style/comment_indentation'

require 'rubocop/cop/style/copyright'

require 'rubocop/cop/style/constant_name'

require 'rubocop/cop/style/def_with_parentheses'

require 'rubocop/cop/style/deprecated_hash_methods'

require 'rubocop/cop/style/documentation'

require 'rubocop/cop/style/dot_position'

require 'rubocop/cop/style/double_negation'

require 'rubocop/cop/style/each_with_object'

require 'rubocop/cop/style/else_alignment'

require 'rubocop/cop/style/empty_else'

require 'rubocop/cop/style/missing_else'

require 'rubocop/cop/style/empty_line_between_defs'

require 'rubocop/cop/style/empty_lines'

require 'rubocop/cop/style/empty_lines_around_access_modifier'

require 'rubocop/cop/style/empty_lines_around_block_body'

require 'rubocop/cop/style/empty_lines_around_class_body'

require 'rubocop/cop/style/empty_lines_around_method_body'

require 'rubocop/cop/style/empty_lines_around_module_body'

require 'rubocop/cop/style/empty_literal'

require 'rubocop/cop/style/encoding'

require 'rubocop/cop/style/end_block'

require 'rubocop/cop/style/end_of_line'

require 'rubocop/cop/style/even_odd'

require 'rubocop/cop/style/extra_spacing'

require 'rubocop/cop/style/file_name'

require 'rubocop/cop/style/first_array_element_line_break'

require 'rubocop/cop/style/first_hash_element_line_break'

require 'rubocop/cop/style/first_method_argument_line_break'

require 'rubocop/cop/style/first_method_parameter_line_break'

require 'rubocop/cop/style/first_parameter_indentation'

require 'rubocop/cop/style/flip_flop'

require 'rubocop/cop/style/for'

require 'rubocop/cop/style/format_string'

require 'rubocop/cop/style/global_vars'

require 'rubocop/cop/style/guard_clause'

require 'rubocop/cop/style/hash_syntax'

require 'rubocop/cop/style/if_unless_modifier'

require 'rubocop/cop/style/if_with_semicolon'

require 'rubocop/cop/style/indent_array'

require 'rubocop/cop/style/indent_hash'

require 'rubocop/cop/style/indentation_consistency'

require 'rubocop/cop/style/indentation_width'

require 'rubocop/cop/style/infinite_loop'

require 'rubocop/cop/style/initial_indentation'

require 'rubocop/cop/style/inline_comment'

require 'rubocop/cop/style/lambda'

require 'rubocop/cop/style/lambda_call'

require 'rubocop/cop/style/leading_comment_space'

require 'rubocop/cop/style/line_end_concatenation'

require 'rubocop/cop/style/method_call_parentheses'

require 'rubocop/cop/style/method_called_on_do_end_block'

require 'rubocop/cop/style/method_def_parentheses'

require 'rubocop/cop/style/method_name'

require 'rubocop/cop/style/module_function'

require 'rubocop/cop/style/multiline_block_chain'

require 'rubocop/cop/style/multiline_block_layout'

require 'rubocop/cop/style/multiline_if_then'

require 'rubocop/cop/style/multiline_operation_indentation'

require 'rubocop/cop/style/multiline_ternary_operator'

require 'rubocop/cop/style/mutable_constant'

require 'rubocop/cop/style/negated_if'

require 'rubocop/cop/style/negated_while'

require 'rubocop/cop/style/nested_modifier'

require 'rubocop/cop/style/nested_ternary_operator'

require 'rubocop/cop/style/next'

require 'rubocop/cop/style/nil_comparison'

require 'rubocop/cop/style/non_nil_check'

require 'rubocop/cop/style/not'

require 'rubocop/cop/style/numeric_literals'

require 'rubocop/cop/style/one_line_conditional'

require 'rubocop/cop/style/op_method'

require 'rubocop/cop/style/optional_arguments'

require 'rubocop/cop/style/option_hash'

require 'rubocop/cop/style/parallel_assignment'

require 'rubocop/cop/style/parentheses_around_condition'

require 'rubocop/cop/style/percent_literal_delimiters'

require 'rubocop/cop/style/percent_q_literals'

require 'rubocop/cop/style/perl_backrefs'

require 'rubocop/cop/style/predicate_name'

require 'rubocop/cop/style/proc'

require 'rubocop/cop/style/raise_args'

require 'rubocop/cop/style/redundant_begin'

require 'rubocop/cop/style/redundant_exception'

require 'rubocop/cop/style/redundant_freeze'

require 'rubocop/cop/style/redundant_return'

require 'rubocop/cop/style/redundant_self'

require 'rubocop/cop/style/regexp_literal'

require 'rubocop/cop/style/rescue_ensure_alignment'

require 'rubocop/cop/style/rescue_modifier'

require 'rubocop/cop/style/self_assignment'

require 'rubocop/cop/style/semicolon'

require 'rubocop/cop/style/send'

require 'rubocop/cop/style/signal_exception'

require 'rubocop/cop/style/single_line_block_params'

require 'rubocop/cop/style/single_line_methods'

require 'rubocop/cop/style/single_space_before_first_arg'

require 'rubocop/cop/style/space_after_colon'

require 'rubocop/cop/style/space_after_comma'

require 'rubocop/cop/style/space_after_control_keyword'

require 'rubocop/cop/style/space_after_method_name'

require 'rubocop/cop/style/space_after_not'

require 'rubocop/cop/style/space_after_semicolon'

require 'rubocop/cop/style/space_around_block_parameters'

require 'rubocop/cop/style/space_around_equals_in_parameter_default'

require 'rubocop/cop/style/space_around_operators'

require 'rubocop/cop/style/space_before_block_braces'

require 'rubocop/cop/style/space_before_comma'

require 'rubocop/cop/style/space_before_comment'

require 'rubocop/cop/style/space_before_modifier_keyword'

require 'rubocop/cop/style/space_before_semicolon'

require 'rubocop/cop/style/space_inside_block_braces'

require 'rubocop/cop/style/space_inside_brackets'

require 'rubocop/cop/style/space_inside_hash_literal_braces'

require 'rubocop/cop/style/space_inside_parens'

require 'rubocop/cop/style/space_inside_range_literal'

require 'rubocop/cop/style/space_inside_string_interpolation'

require 'rubocop/cop/style/special_global_vars'

require 'rubocop/cop/style/stabby_lambda_parentheses'

require 'rubocop/cop/style/string_literals'

require 'rubocop/cop/style/string_literals_in_interpolation'

require 'rubocop/cop/style/string_methods'

require 'rubocop/cop/style/struct_inheritance'

require 'rubocop/cop/style/symbol_array'

require 'rubocop/cop/style/symbol_literal'

require 'rubocop/cop/style/symbol_proc'

require 'rubocop/cop/style/tab'

require 'rubocop/cop/style/trailing_blank_lines'

require 'rubocop/cop/style/trailing_comma'

require 'rubocop/cop/style/trailing_whitespace'

require 'rubocop/cop/style/trivial_accessors'

require 'rubocop/cop/style/unless_else'

require 'rubocop/cop/style/unneeded_capital_w'

require 'rubocop/cop/style/unneeded_percent_q'

require 'rubocop/cop/style/trailing_underscore_variable'

require 'rubocop/cop/style/variable_interpolation'

require 'rubocop/cop/style/variable_name'

require 'rubocop/cop/style/when_then'

require 'rubocop/cop/style/while_until_do'

require 'rubocop/cop/style/while_until_modifier'

require 'rubocop/cop/style/word_array'



require 'rubocop/cop/rails/action_filter'

require 'rubocop/cop/rails/date'

require 'rubocop/cop/rails/default_scope'

require 'rubocop/cop/rails/delegate'

require 'rubocop/cop/rails/find_by'

require 'rubocop/cop/rails/find_each'

require 'rubocop/cop/rails/has_and_belongs_to_many'

require 'rubocop/cop/rails/output'

require 'rubocop/cop/rails/pluralization_grammar'

require 'rubocop/cop/rails/read_write_attribute'

require 'rubocop/cop/rails/scope_args'

require 'rubocop/cop/rails/time_zone'

require 'rubocop/cop/rails/validation'



require 'rubocop/formatter/base_formatter'

require 'rubocop/formatter/simple_text_formatter'

require 'rubocop/formatter/disabled_lines_formatter'

require 'rubocop/formatter/disabled_config_formatter'

require 'rubocop/formatter/emacs_style_formatter'

require 'rubocop/formatter/clang_style_formatter'

require 'rubocop/formatter/progress_formatter'

require 'rubocop/formatter/fuubar_style_formatter'

require 'rubocop/formatter/json_formatter'

require 'rubocop/formatter/html_formatter'

require 'rubocop/formatter/file_list_formatter'

require 'rubocop/formatter/offense_count_formatter'

require 'rubocop/formatter/formatter_set'



require 'rubocop/config'

require 'rubocop/config_loader'

require 'rubocop/config_store'

require 'rubocop/target_finder'

require 'rubocop/token'

require 'rubocop/comment_config'

require 'rubocop/processed_source'

require 'rubocop/result_cache'

require 'rubocop/runner'

require 'rubocop/cli'

require 'rubocop/options'

require 'rubocop/warning'

require 'rubocop/remote_config'

Video Tutorial

uploaded.net - [code] RuboCop 0.35.0

[Ruby] RuboCop 0.35.0: Analizador estático de código Ruby

Trending Articles

Mi 530d no arranca, códigos de avería

Ley Memoria Histórica o Democrática 2022 – Matrimonios con españoles – Cuba...

Coronel de la Guardia Nacional asume dirección de Polibolívar

TELEVISOR KONKA 43 PULG TV5-43K2 - 850.00USD

Silent Hill 2: Revelation (2012) 720p BRRip Dual Español Latino-Inglés

Merluzas en Airfryer con sofrito de pimientos rojos

[Wii] Silent Hill Shattered Memories [NTSC][WBFS][ESPAÑOL][MEGA]

Gobernador de Anzoátegui decreta 14 de noviembre como feriado no laborable

The Cranberries – When You’re Gone-Pronunciación Letra Traducción

QUÉDATE, BUEN JESÚS. Autor: Luis Iruarrízaga

Matan a dos personas en colonia Reparto Lempira, San Pedro Sula

Profetas de la Ciencia Ficción (Serie) Castellano

Fallece en Mérida el empresario Alvaro Juanes Ancona

ACTIVIDAD: El primer milagro de Jesús (para los más chiquitos)

Elodia, ahora en Playboy

Reguetoneros y productores que perdieron la vida

Coche de sustitucion en BMW al pasar campaña EGR

CDG INTERROGA A ZETA SECUESTRADOR DE TAMPICO

Ayuda!!!! Notificacion de Demanda Coppel

"MI VIDA FUE SIGNADA POR LA TRISTEZA Y LA POBREZA"