HHRy/prawn-graph

View on GitHub

Showing 12 of 12 total issues

Method has too many lines. [38/30]
Open

        def render_line_chart
          prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
            j = 2
            prawn.save_graphics_state do  
              max_marked = false

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 render_line_chart has a Cognitive Complexity of 19 (exceeds 5 allowed). Consider refactoring.
Open

        def render_line_chart
          prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
            j = 2
            prawn.save_graphics_state do  
              max_marked = false
Severity: Minor
Found in lib/prawn/graph/chart_components/line_chart_renderer.rb - About 2 hrs 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

Cyclomatic complexity for calculate_width_and_height_of_canvas is too high. [7/6]
Open

        def calculate_width_and_height_of_canvas
          if @canvas_width.zero? && @canvas_height.zero?
            @canvas_width   = BigDecimal(bounds[0], 10) 
            @canvas_height  = BigDecimal(bounds[1], 10) 
          elsif !@canvas_width.zero? && @canvas_height.zero?

This cop checks that the cyclomatic complexity of methods is not higher than the configured maximum. The cyclomatic complexity is the number of linearly independent paths through a method. The algorithm counts decision points and adds one.

An if statement (or unless or ?:) increases the complexity by one. An else branch does not, since it doesn't add a decision point. The && operator (or keyword and) can be converted to a nested if statement, and ||/or is shorthand for a sequence of ifs, so they also add one. Loops can be said to have an exit condition, so they add one.

Method render_line_chart has 38 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        def render_line_chart
          prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
            j = 2
            prawn.save_graphics_state do  
              max_marked = false
Severity: Minor
Found in lib/prawn/graph/chart_components/line_chart_renderer.rb - About 1 hr to fix

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

            def initialize(series, canvas, color = '000000')
              if series.is_a?(Array)
                raise ArgumentError.new("series must be a Prawn::Graph::Series") unless series.first.is_a?(Prawn::Graph::Series)
              else
                raise ArgumentError.new("series must be a Prawn::Graph::Series") unless series.is_a?(Prawn::Graph::Series)
    Severity: Minor
    Found in lib/prawn/graph/chart_components/series_renderer.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 mark_minimum_point has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

            def mark_minimum_point(series_index, point, min_marked, x_position, y_position)
    Severity: Minor
    Found in lib/prawn/graph/chart_components/bar_chart_renderer.rb - About 35 mins to fix

      Method apply_marker_to_graph has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

              def apply_marker_to_graph(value_marked, value, x, y, color)
      Severity: Minor
      Found in lib/prawn/graph/chart_components/line_chart_renderer.rb - About 35 mins to fix

        Method mark_maximum_point has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

                def mark_maximum_point(series_index, point, max_marked, x_position, y_position)
        Severity: Minor
        Found in lib/prawn/graph/chart_components/bar_chart_renderer.rb - About 35 mins to fix

          Method min has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                def min
                  if values.empty?
                    0
                  else
                    values.sort.collect{ |x| x unless x.zero? }.compact.first
          Severity: Minor
          Found in lib/prawn/graph/series.rb - About 25 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 verify_series_are_ok! has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                  def verify_series_are_ok!
                    if @series.respond_to?(:each) && @series.respond_to?(:collect)
                      classes = @series.collect{ |c| c.is_a?(Prawn::Graph::Series) }.uniq
                      if classes.size > 1 || classes[0] != true
                        raise RuntimeError.new("All of the items provided must be instances of Prawn::Graph::Series")
          Severity: Minor
          Found in lib/prawn/graph/chart_components/canvas.rb - About 25 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 render_the_chart has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
          Open

                  def render_the_chart
                    prawn.bounding_box [@graph_area.point[0] + 5, @graph_area.point[1] - 20], width: @plot_area_width, height: @plot_area_height do
                   
                      prawn.save_graphics_state do  
                        num_points        = @series[0].size
          Severity: Minor
          Found in lib/prawn/graph/chart_components/bar_chart_renderer.rb - About 25 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

          Unused method argument - block. If it's necessary, use _ or _block as an argument name to indicate that it won't be used.
          Open

                  def initialize(series, prawn, options = {}, &block)

          This cop checks for unused method arguments.

          Example:

          def some_method(used, unused, _unused_but_allowed)
            puts used
          end
          
          Severity
          Category
          Status
          Source