Sign upLogin

brundage/thermostat

View on GitHub
Star

Showing 509 of 509 total issues

Use empty lines between method definitions.
Open

    def start_idle
Severity: Minor
Found in lib/thermostat/simple/controller.rb by rubocop

This cop checks whether method definitions are separated by one empty line.

NumberOfEmptyLines can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

AllowAdjacentOneLineDefs can be used to configure is adjacent one line methods definitions are an offense

Example:

# bad
def a
end
def b
end

Example:

# good
def a
end

def b
end

Line is too long. [115/80]
Open

      logger.controller(:info) { "Initialized #{wires}-wire controller with cooldown #{cooldown_seconds} seconds" }
Severity: Minor
Found in lib/thermostat/simple/controller.rb by rubocop

Missing top-level module documentation comment.
Open

  module Logging
Severity: Minor
Found in lib/thermostat/logging.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Use empty lines between method definitions.
Open

    def sensor(severity=nil, msg=nil, &block)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cop checks whether method definitions are separated by one empty line.

NumberOfEmptyLines can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

AllowAdjacentOneLineDefs can be used to configure is adjacent one line methods definitions are an offense

Example:

# bad
def a
end
def b
end

Example:

# good
def a
end

def b
end

Use empty lines between method definitions.
Open

    def lookup_severity(s)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cop checks whether method definitions are separated by one empty line.

NumberOfEmptyLines can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

AllowAdjacentOneLineDefs can be used to configure is adjacent one line methods definitions are an offense

Example:

# bad
def a
end
def b
end

Example:

# good
def a
end

def b
end

Use empty lines between method definitions.
Open

    def lookup_subsystem(s)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cop checks whether method definitions are separated by one empty line.

NumberOfEmptyLines can be and integer (e.g. 1 by default) or an array (e.g. [1, 2]) to specificy a minimum and a maximum of empty lines.

AllowAdjacentOneLineDefs can be used to configure is adjacent one line methods definitions are an offense

Example:

# bad
def a
end
def b
end

Example:

# good
def a
end

def b
end

Extra blank line detected.
Open


    def format_message(severity, subsystem, time, message)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cops checks for two or more consecutive blank lines.

Example:

# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method

# good
some_method
# one empty line
some_method

Extra blank line detected.
Open


    def lookup_subsystem(s)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cops checks for two or more consecutive blank lines.

Example:

# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method

# good
some_method
# one empty line
some_method

Surrounding space missing in default value assignment.
Open

    def debug(subsystem=nil, msg=nil, &block)
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.

Example:

# bad
def some_method(arg1=:default, arg2=nil, arg3=[])
  # do something...
end

# good
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
  # do something...
end

Freeze mutable objects assigned to constants.
Open

    SUBSYSTEM_MAPPING = { controller:    CONTROLLER,
                          hartware:      HARDWARE,
                          none:          NONE,
                          quiet:         QUIET,
                          sensor:        SENSOR,
Severity: Minor
Found in lib/thermostat/logger.rb by rubocop

This cop checks whether some constant value isn't a mutable literal (e.g. array or hash).

Example:

# bad
CONST = [1, 2, 3]

# good
CONST = [1, 2, 3].freeze

Extra empty line detected at class body end.
Open


  end
Severity: Minor
Found in lib/thermostat/zone.rb by rubocop

This cops checks if empty lines around the bodies of classes match the configuration.

Example: EnforcedStyle: empty_lines

# good

class Foo

  def bar
    # ...
  end

end

Example: EnforcedStyle: emptylinesexcept_namespace

# good

class Foo
  class Bar

    # ...

  end
end

Example: EnforcedStyle: emptylinesspecial

# good
class Foo

  def bar; end

end

Example: EnforcedStyle: noemptylines (default)

# good

class Foo
  def bar
    # ...
  end
end

Extra blank line detected.
Open


    def required_init_args
Severity: Minor
Found in lib/thermostat/zone.rb by rubocop

This cops checks for two or more consecutive blank lines.

Example:

# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method

# good
some_method
# one empty line
some_method

Line is too long. [107/80]
Open

          raise InvalidSetpoint, "Set point (#{s}) should be between #{min_set_point} and #{max_set_point}"
Severity: Minor
Found in lib/thermostat/zone.rb by rubocop

Do not prefix writer method names with set_.
Open

    def set_point=(s)
Severity: Minor
Found in lib/thermostat/zone.rb by rubocop

This cop makes sure that accessor methods are named properly.

Example:

# bad
def set_attribute(value)
end

# good
def attribute=(value)
end

# bad
def get_attribute
end

# good
def attribute
end

Avoid single-line method definitions.
Open

    def min_set_point; config.min_set_point; end
Severity: Minor
Found in lib/thermostat/zone.rb by rubocop

This cop checks for single-line method definitions that contain a body. It will accept single-line methods with no body.

Example:

# bad
def some_method; body end
def link_to(url); {:name => url}; end
def @table.columns; super; end

# good
def no_op; end
def self.resource_class=(klass); end
def @table.columns; end

Line is too long. [86/80]
Open

    autoload :RelativeHumidity, File.join('thermostat', 'sensor', 'relative_humidity')
Severity: Minor
Found in lib/thermostat/sensor.rb by rubocop

Extra blank line detected.
Open


      [ :cooldown, :cooling, :heating, :idle].each do |s|
Severity: Minor
Found in lib/thermostat/simple/state_machine.rb by rubocop

This cops checks for two or more consecutive blank lines.

Example:

# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method

# good
some_method
# one empty line
some_method

Do not use space inside array brackets.
Open

      transition from: :idle,     to: [ :cooling, :fanning, :heating ]
Severity: Minor
Found in lib/thermostat/simple/state_machine.rb by rubocop

Checks that brackets used for array literals have or don't have surrounding space depending on configuration.

Example: EnforcedStyle: space

# The `space` style enforces that array literals have
# surrounding space.

# bad
array = [a, b, c, d]

# good
array = [ a, b, c, d ]

Example: EnforcedStyle: no_space

# The `no_space` style enforces that array literals have
# no surrounding space.

# bad
array = [ a, b, c, d ]

# good
array = [a, b, c, d]

Example: EnforcedStyle: compact

# The `compact` style normally requires a space inside
# array brackets, with the exception that successive left
# or right brackets are collapsed together in nested arrays.

# bad
array = [ a, [ b, c ] ]

# good
array = [ a, [ b, c ]]

Do not use space inside array brackets.
Open

      transition from: :fanning,  to: [ :idle ]
Severity: Minor
Found in lib/thermostat/simple/state_machine.rb by rubocop

Checks that brackets used for array literals have or don't have surrounding space depending on configuration.

Example: EnforcedStyle: space

# The `space` style enforces that array literals have
# surrounding space.

# bad
array = [a, b, c, d]

# good
array = [ a, b, c, d ]

Example: EnforcedStyle: no_space

# The `no_space` style enforces that array literals have
# no surrounding space.

# bad
array = [ a, b, c, d ]

# good
array = [a, b, c, d]

Example: EnforcedStyle: compact

# The `compact` style normally requires a space inside
# array brackets, with the exception that successive left
# or right brackets are collapsed together in nested arrays.

# bad
array = [ a, [ b, c ] ]

# good
array = [ a, [ b, c ]]

Use %i or %I for an array of symbols.
Open

      transition from: :cooldown, to: [ :cooling, :fanning, :heating, :idle ]
Severity: Minor
Found in lib/thermostat/simple/state_machine.rb by rubocop

This cop can check for array literals made up of symbols that are not using the %i() syntax.

Alternatively, it checks for symbol arrays using the %i() syntax on projects which do not want to use that syntax.

Configuration option: MinSize If set, arrays with fewer elements than this value will not trigger the cop. For example, a MinSize of3` will not enforce a style on an array of 2 or fewer elements.

Example: EnforcedStyle: percent (default)

# good
%i[foo bar baz]

# bad
[:foo, :bar, :baz]

Example: EnforcedStyle: brackets

# good
[:foo, :bar, :baz]

# bad
%i[foo bar baz]
Severity
Category
Status
Source
Language