Sign upLogin

lujanfernaud/prevy

View on GitHub
Star
app/services/notifiers/events/updated_event_notifier.rb

Summary

Maintainability
A
0 mins
Test Coverage

UpdatedEventNotifier has no descriptive comment
Open

class UpdatedEventNotifier
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by reek

Classes and modules are the units of reuse and release. It is therefore considered good practice to annotate every class and module with a brief comment outlining its responsibilities.

Example

Given

class Dummy
  # Do things...
end

Reek would emit the following warning:

test.rb -- 1 warning:
  [1]:Dummy has no descriptive comment (IrresponsibleModule)

Fixing this is simple - just an explaining comment:

# The Dummy class is responsible for ...
class Dummy
  # Do things...
end

UpdatedEventNotifier#simplified_name_for doesn't depend on instance state (maybe move it to another class?)
Open

    def simplified_name_for(field_name)
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by reek

A Utility Function is any instance method that has no dependency on the state of the instance.

Use tr instead of gsub.
Open

      field_name.remove("updated").gsub("_", " ")
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cop identifies places where gsub can be replaced by tr or delete.

Example:

# bad
'abc'.gsub('b', 'd')
'abc'.gsub('a', '')
'abc'.gsub(/a/, 'd')
'abc'.gsub!('a', 'd')

# good
'abc'.gsub(/.*/, 'a')
'abc'.gsub(/a+/, 'd')
'abc'.tr('b', 'd')
'a b c'.delete(' ')

Inconsistent indentation detected.
Open

    def send_email_to(attendee)
      NotificationMailer.updated_event(attendee, @event, updated_data)
                        .deliver_later
    end
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def no_updated_fields?
      @event.updated_fields.empty?
    end
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Inconsistent indentation detected.
Open

    def attendees
      @event.attendees
    end
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

      field_name.remove("updated").gsub("_", " ")
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Inconsistent indentation detected.
Open

    def simplified_name_for(field_name)
      field_name.remove("updated").gsub("_", " ")
    end
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

Missing top-level class documentation comment.
Open

class UpdatedEventNotifier
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.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

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

      field_name.remove("updated").gsub("_", " ")
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Prefer single-quoted strings when you don't need string interpolation or special symbols.
Open

      field_name.remove("updated").gsub("_", " ")
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

Checks if uses of quotes match the configured preference.

Example: EnforcedStyle: single_quotes (default)

# bad
"No special symbols"
"No string interpolation"
"Just text"

# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"

Example: EnforcedStyle: double_quotes

# bad
'Just some text'
'No special chars or interpolation'

# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"

Inconsistent indentation detected.
Open

    def updated_data
      @_updated_data ||= @event.updated_fields.keys.map do |field_name|
        simplified_name_for field_name
      end
    end
Severity: Minor
Found in app/services/notifiers/events/updated_event_notifier.rb by rubocop

This cops checks for inconsistent indentation.

Example:

class A
  def test
    puts 'hello'
     puts 'world'
  end
end

There are no issues that match your filters.

Category
Status