awesome-print/awesome_print

View on GitHub

Showing 387 of 387 total issues

Method has too many lines. [11/10]
Open

      def find_method(name)
        object = array.instance_variable_get('@__awesome_methods__')

        meth = begin
          object.method(name)

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Method has too many lines. [11/10]
Open

      def align(value, width)
        if options[:multiline]
          if options[:indent] > 0
            value.rjust(width)
          elsif options[:indent] == 0

This cop checks if the length of a method exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable.

Assignment Branch Condition size for convert_to_hash is too high. [15.68/15]
Open

    def convert_to_hash(object)
      return nil if has_method_accessor?(object)
      return nil if !object.respond_to?(:to_hash) || object.method(:to_hash).arity != 0

      # ActionController::Parameters will raise if they are not yet permitted
Severity: Minor
Found in lib/awesome_print/formatter.rb by rubocop

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for awesome_mongo_mapper_association is too high. [15.59/15]
Open

    def awesome_mongo_mapper_association(object)
      return object.inspect if !defined?(::ActiveSupport::OrderedHash)
      return awesome_object(object) if @options[:raw]

      association = object.class.name.split('::').last.titleize.downcase.sub(/ association$/, '')

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for printable_keys is too high. [15.07/15]
Open

      def printable_keys
        keys = hash.keys

        keys.sort! { |a, b| a.to_s <=> b.to_s } if options[:sort_keys]

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Assignment Branch Condition size for format is too high. [15.17/15]
Open

      def format
        ls = File.directory?(file) ? `ls -adlF #{file.path.shellescape}` : `ls -alF #{file.path.shellescape}`
        colorize(ls.empty? ? file.inspect : "#{file.inspect}\n#{ls.chop}", :file)
      end

This cop checks that the ABC size of methods is not higher than the configured maximum. The ABC size is based on assignments, branches (method calls), and conditions. See http://c2.com/cgi/wiki?AbcMetric

Method initialize has 41 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    def initialize(options = {})
      @options = {
        indent:        4,      # Number of spaces for indenting.
        index:         true,   # Display array indices.
        html:          false,  # Use ANSI color codes rather than HTML.
Severity: Minor
Found in lib/awesome_print/inspector.rb - About 1 hr to fix

    Method awesome_active_model_error has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        def awesome_active_model_error(object)
          return object.inspect if !defined?(::ActiveSupport::OrderedHash)
          return awesome_object(object) if @options[:raw]
    
          object_dump = object.marshal_dump.first
    Severity: Minor
    Found in lib/awesome_print/ext/active_record.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method awesome_active_record_instance has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
    Open

        def awesome_active_record_instance(object)
          return object.inspect if !defined?(::ActiveSupport::OrderedHash)
          return awesome_object(object) if @options[:raw]
    
          data = if object.class.column_names != object.attributes.keys
    Severity: Minor
    Found in lib/awesome_print/ext/active_record.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method method_tuple has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
    Open

          def method_tuple(method)
            if method.respond_to?(:parameters) # Ruby 1.9.2+
              # See http://readruby.chengguangnan.com/methods#method-objects-parameters
              # (mirror: http://archive.is/XguCA#selection-3381.1-3381.11)
              args = method.parameters.inject([]) do |arr, (type, name)|
    Severity: Minor
    Found in lib/awesome_print/formatters/base_formatter.rb - About 1 hr to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Method format has 33 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def format
            vars = variables.map do |var|
              property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
              accessor = if struct.respond_to?(:"#{property}=")
                struct.respond_to?(property) ? :accessor : :writer
    Severity: Minor
    Found in lib/awesome_print/formatters/struct_formatter.rb - About 1 hr to fix

      Method format has 33 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

            def format
              vars = variables.map do |var|
                property = var.to_s[1..-1].to_sym # to_s because of some monkey patching done by Puppet.
                accessor = if object.respond_to?(:"#{property}=")
                  object.respond_to?(property) ? :accessor : :writer
      Severity: Minor
      Found in lib/awesome_print/formatters/object_formatter.rb - About 1 hr to fix

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

                  key = left_aligned do
                    align(declaration, declaration.size)
                  end
        
                  unless options[:plain]
        Severity: Major
        Found in lib/awesome_print/formatters/object_formatter.rb and 1 other location - About 1 hr to fix
        lib/awesome_print/formatters/struct_formatter.rb on lines 32..45

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 48.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

                  key = left_aligned do
                    align(declaration, declaration.size)
                  end
        
                  unless options[:plain]
        Severity: Major
        Found in lib/awesome_print/formatters/struct_formatter.rb and 1 other location - About 1 hr to fix
        lib/awesome_print/formatters/object_formatter.rb on lines 32..45

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 48.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

              data = if object_dump.class.column_names != object_dump.attributes.keys
                       object_dump.attributes
                     else
                       object_dump.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
                         if object_dump.has_attribute?(name) || object_dump.new_record?
        Severity: Minor
        Found in lib/awesome_print/ext/active_record.rb and 1 other location - About 55 mins to fix
        lib/awesome_print/ext/active_record.rb on lines 47..55

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 46.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Similar blocks of code found in 2 locations. Consider refactoring.
        Open

              data = if object.class.column_names != object.attributes.keys
                       object.attributes
                     else
                       object.class.column_names.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
                         if object.has_attribute?(name) || object.new_record?
        Severity: Minor
        Found in lib/awesome_print/ext/active_record.rb and 1 other location - About 55 mins to fix
        lib/awesome_print/ext/active_record.rb on lines 85..93

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 46.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        Method cast_with_mongoid has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            def cast_with_mongoid(object, type)
              cast = cast_without_mongoid(object, type)
              if defined?(::Mongoid::Document)
                if object.is_a?(Class) && object.ancestors.include?(::Mongoid::Document)
                  cast = :mongoid_class
        Severity: Minor
        Found in lib/awesome_print/ext/mongoid.rb - About 55 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method awesome_mongo_mapper_instance has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

            def awesome_mongo_mapper_instance(object)
              return object.inspect if !defined?(::ActiveSupport::OrderedHash)
              return awesome_object(object) if @options[:raw]
        
              data = object.keys.keys.sort_by { |k| k }.inject(::ActiveSupport::OrderedHash.new) do |hash, name|
        Severity: Minor
        Found in lib/awesome_print/ext/mongo_mapper.rb - About 55 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method cast_with_mongo_mapper has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

            def cast_with_mongo_mapper(object, type)
              apply_default_mongo_mapper_options
              cast = cast_without_mongo_mapper(object, type)
        
              if defined?(::MongoMapper::Document)
        Severity: Minor
        Found in lib/awesome_print/ext/mongo_mapper.rb - About 45 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Method printable_hash has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
        Open

              def printable_hash
                data = printable_keys
                width = left_width(data)
        
                data.map! do |key, value|
        Severity: Minor
        Found in lib/awesome_print/formatters/hash_formatter.rb - About 35 mins to fix

        Cognitive Complexity

        Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

        A method's cognitive complexity is based on a few simple rules:

        • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
        • Code is considered more complex for each "break in the linear flow of the code"
        • Code is considered more complex when "flow breaking structures are nested"

        Further reading

        Severity
        Category
        Status
        Source
        Language