ringcentral-ruby/ringcentral-rss-ruby

View on GitHub

Showing 7 of 7 total issues

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

      def build_title(data)
        raise 'Data is not a hash' unless data.is_a? Hash

        parts = []

Severity: Minor
Found in lib/ringcentral-rss/atom_entry.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

The name of this source file (ringcentral-rss.rb) should use snake_case.
Open

require 'ringcentral-rss/atom_entry'
Severity: Minor
Found in lib/ringcentral-rss.rb by rubocop

This cop makes sure that Ruby source files have snake_case names. Ruby scripts (i.e. source files with a shebang in the first line) are ignored.

Example:

# bad
lib/layoutManager.rb

anything/usingCamelCase

# good
lib/layout_manager.rb

anything/using_snake_case.rake

required_ruby_version (2.2, declared in ringcentral-rss.gemspec) and TargetRubyVersion (2.1, declared in .rubocop.yml) should be equal.
Open

  s.required_ruby_version = '>= 2.2.2'
Severity: Minor
Found in ringcentral-rss.gemspec by rubocop

Checks that required_ruby_version of gemspec and TargetRubyVersion of .rubocop.yml are equal. Thereby, RuboCop to perform static analysis working on the version required by gemspec.

Example:

# When `TargetRubyVersion` of .rubocop.yml is `2.3`.

# bad
Gem::Specification.new do |spec|
  spec.required_ruby_version = '>= 2.2.0'
end

# bad
Gem::Specification.new do |spec|
  spec.required_ruby_version = '>= 2.4.0'
end

# good
Gem::Specification.new do |spec|
  spec.required_ruby_version = '>= 2.3.0'
end

# good
Gem::Specification.new do |spec|
  spec.required_ruby_version = '>= 2.3'
end

# good
Gem::Specification.new do |spec|
  spec.required_ruby_version = ['>= 2.3.0', '< 2.5.0']
end

Favor modifier if usage when having a single-line body. Another good alternative is the usage of control flow &&/||.
Open

        if data.key?('from') && !data['from']['phoneNumber'].empty?
Severity: Minor
Found in lib/ringcentral-rss/atom_entry.rb by rubocop

Checks for if and unless statements that would fit on one line if written as a modifier if/unless. The maximum line length is configured in the Metrics/LineLength cop.

Example:

# bad
if condition
  do_stuff(bar)
end

unless qux.empty?
  Foo.do_something
end

# good
do_stuff(bar) if condition
Foo.do_something unless qux.empty?

Avoid the use of Perl-style backrefs.
Open

version = $1
Severity: Minor
Found in ringcentral-rss.gemspec by rubocop

This cop looks for uses of Perl-style regexp match backreferences like $1, $2, etc.

Example:

# bad
puts $1

# good
puts Regexp.last_match(1)

Line is too long. [121/120]
Open

  # puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
Severity: Minor
Found in Rakefile by rubocop

Use the return of the conditional for variable assignment and comparison.
Open

        if opts.key? :feed_name
          @feed_name = opts[:feed_name]
        else
          @feed_name = 'RingCentral Feed'
        end
Severity: Minor
Found in lib/ringcentral-rss/atom_feed.rb by rubocop
Severity
Category
Status
Source
Language