Sign upLogin

decko-commons/decko

View on GitHub
Star

Showing 661 of 695 total issues

Missing top-level class documentation comment.
Open

      class Carousel < Component
Severity: Minor
Found in mod/bootstrap/lib/card/bootstrap/component/carousel.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 let instead of an instance variable.
Open

        @bt.save!
Severity: Minor
Found in mod/content/spec/set/all/templating_spec.rb by rubocop

Empty example group detected.
Open

describe Card::Set::All::States do
Severity: Minor
Found in card/mod/core/spec/set/all/states_spec.rb by rubocop

Missing top-level module documentation comment.
Open

module Cardio
Severity: Minor
Found in card/lib/cardio.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

Replace class var @@variant_aliases with a class instance var.
Open

      @@variant_aliases = { capitalized: :capitalize, singular: :singularize,
Severity: Minor
Found in card/lib/card/name/name_variants.rb by rubocop

This cop checks for uses of class variables. Offenses are signaled only on assignment to class variables to reduce the number of offenses that would be reported.

Rename has_chunk? to chunk?.
Open

    def has_chunk? chunk_type
Severity: Minor
Found in card/lib/card/content.rb by rubocop

This cop makes sure that predicates are named properly.

Example:

# bad
def is_even?(value)
end

# good
def even?(value)
end

# bad
def has_value?
end

# good
def value?
end

Missing top-level class documentation comment.
Open

    class RssFormat < HtmlFormat
Severity: Minor
Found in mod/format/lib/card/format/rss_format.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 snake_case for method names.
Open

      def wrapInner tag=nil, &block
Severity: Minor
Found in mod/bootstrap/lib/card/bootstrap/tag_method.rb by rubocop

This cop makes sure that all methods use the configured style, snake_case or camelCase, for their names.

Example: EnforcedStyle: snake_case (default)

# bad
def fooBar; end

# good
def foo_bar; end

Example: EnforcedStyle: camelCase

# bad
def foo_bar; end

# good
def fooBar; end

Missing top-level module documentation comment.
Open

    module ComponentLoader
Severity: Minor
Found in mod/bootstrap/lib/card/bootstrap/component_loader.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

The second argument to describe should be the method being tested. '#instance' or '.class'.
Open

RSpec.describe Card::Bootstrap, "builder" do
Severity: Minor
Found in mod/bootstrap/spec/bootstrap_builder_spec.rb by rubocop

Avoid the use of double negation (!!).
Open

  !!card.type_id
Severity: Minor
Found in card/mod/core/set_pattern/03_type.rb by rubocop

This cop checks for uses of double negation (!!) to convert something to a boolean value. As this is both cryptic and usually redundant, it should be avoided.

Example:

# bad
!!something

# good
!something.nil?

Please, note that when something is a boolean value !!something and !something.nil? are not the same thing. As you're unlikely to write code that can accept values of any type this is rarely a problem in practice.

Empty example group detected.
Open

describe Card::Format::XmlFormat do
Severity: Minor
Found in mod/format/spec/format/xml_format_spec.rb by rubocop

Missing top-level class documentation comment.
Open

    class ReadRuleCache < Cache
Severity: Minor
Found in card/lib/card/rule/read_rule_cache.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

Missing top-level class documentation comment.
Open

      class EmailUri < Uri
Severity: Minor
Found in mod/content/lib/card/content/chunk/uri.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

Do not suppress exceptions.
Open

        rescue Card::Error::NotFound
Severity: Minor
Found in mod/content/lib/card/content/chunk/reference.rb by rubocop

This cop checks for rescue blocks with no body.

Example:

# bad

def some_method
  do_something
rescue
  # do nothing
end

Example:

# bad

begin
  do_something
rescue
  # do nothing
end

Example:

# good

def some_method
  do_something
rescue
  handle_exception
end

Example:

# good

begin
  do_something
rescue
  handle_exception
end

Start context description with 'when', 'with', or 'without'.
Open

    context "(pointer)" do
Severity: Minor
Found in card/mod/core/spec/set/all/initialize_spec.rb by rubocop

Missing top-level class documentation comment.
Open

  class Record < ActiveRecord::Base
Severity: Minor
Found in card/lib/cardio/record.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

Missing top-level class documentation comment.
Open

    class Value
Severity: Minor
Found in card/lib/card/query/value/match_value.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

When using method_missing, fall back on super.
Open

      def method_missing method_name, *args, &block
        if block_given?
          @format.send(method_name, *args, &block)
        else
          @format.send(method_name, *args)
Severity: Minor
Found in mod/history/lib/card/action/action_renderer.rb by rubocop

This cop checks for the presence of method_missing without also defining respond_to_missing? and falling back on super.

Example:

#bad
def method_missing(name, *args)
  # ...
end

#good
def respond_to_missing?(name, include_private)
  # ...
end

def method_missing(name, *args)
  # ...
  super
end

Missing top-level class documentation comment.
Open

class StandardError
Severity: Minor
Found in card/lib/card/error.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
Severity
Category
Status
Source
Language