Sign upLogin

dvmonroe/box-office

View on GitHub
Star

Showing 8 of 8 total issues

Method reserve has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

      def reserve(capacity: self.capacity, block_unlock: true)
        with_connection do |conn|
          booth.first_available_opening(conn) do |opening|
            Janitor.lock(opening.name) if config.lock_reserved?
            conn.rpoplpush(send("#{config.standby}_key"), opening.name) while openings?(opening, capacity)
Severity: Minor
Found in lib/box/office/showing.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

Assignment Branch Condition size for reserve is too high. [22.8/15]
Open

      def reserve(capacity: self.capacity, block_unlock: true)
        with_connection do |conn|
          booth.first_available_opening(conn) do |opening|
            Janitor.lock(opening.name) if config.lock_reserved?
            conn.rpoplpush(send("#{config.standby}_key"), opening.name) while openings?(opening, capacity)
Severity: Minor
Found in lib/box/office/showing.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 first_available_opening is too high. [20.42/15]
Open

      def first_available_opening(conn)
        1.upto(showing.showings) do |idx|
          queue = find_queue(idx)

          Redlock::Client.new([conn]).lock("#{queue.name}-locked", 3000) do |locked|
Severity: Minor
Found in lib/box/office/booth.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

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

      def reserve(capacity: self.capacity, block_unlock: true)
        with_connection do |conn|
          booth.first_available_opening(conn) do |opening|
            Janitor.lock(opening.name) if config.lock_reserved?
            conn.rpoplpush(send("#{config.standby}_key"), opening.name) while openings?(opening, capacity)
Severity: Minor
Found in lib/box/office/showing.rb by rubocop

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.

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

      def reserve(capacity: self.capacity, block_unlock: true)
        with_connection do |conn|
          booth.first_available_opening(conn) do |opening|
            Janitor.lock(opening.name) if config.lock_reserved?
            conn.rpoplpush(send("#{config.standby}_key"), opening.name) while openings?(opening, capacity)
Severity: Minor
Found in lib/box/office/showing.rb by rubocop

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 has too many lines. [11/10]
Open

      def first_available_opening(conn)
        1.upto(showing.showings) do |idx|
          queue = find_queue(idx)

          Redlock::Client.new([conn]).lock("#{queue.name}-locked", 3000) do |locked|
Severity: Minor
Found in lib/box/office/booth.rb by rubocop

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

      def first_available_opening(conn)
        1.upto(showing.showings) do |idx|
          queue = find_queue(idx)

          Redlock::Client.new([conn]).lock("#{queue.name}-locked", 3000) do |locked|
Severity: Minor
Found in lib/box/office/booth.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

Non-local exit from iterator, without return value. next, break, Array#find, Array#any?, etc. is preferred.
Open

              return
Severity: Minor
Found in lib/box/office/booth.rb by rubocop

This cop checks for non-local exits from iterators without a return value. It registers an offense under these conditions:

  • No value is returned,
  • the block is preceded by a method chain,
  • the block has arguments,
  • the method which receives the block is not define_method or define_singleton_method,
  • the return is not contained in an inner scope, e.g. a lambda or a method definition.

Example:

class ItemApi
  rescue_from ValidationError do |e| # non-iteration block with arg
    return { message: 'validation error' } unless e.errors # allowed
    error_array = e.errors.map do |error| # block with method chain
      return if error.suppress? # warned
      return "#{error.param}: invalid" unless error.message # allowed
      "#{error.param}: #{error.message}"
    end
    { message: 'validation error', errors: error_array }
  end

  def update_items
    transaction do # block without arguments
      return unless update_necessary? # allowed
      find_each do |item| # block without method chain
        return if item.stock == 0 # false-negative...
        item.update!(foobar: true)
      end
    end
  end
end
Severity
Category
Status
Source
Language