Sign upLogin

rdavid1099/poke-api-v2

View on GitHub
Star

Showing 14 of 14 total issues

Assignment Branch Condition size for initialize is too high. [18.44/15]
Open

      def initialize(data)
        @ailment = MoveAilment.new(data[:ailment])
        @category = MoveCategory.new(data[:category])
        @min_hits = data[:min_hits]
        @max_hits = data[:max_hits]
Severity: Minor
Found in lib/poke_api/move/move_meta_data.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. [12/10]
Open

    def custom_endpoint_object
      {
        attributes: ItemAttribute,
        baby_trigger_for: EvolutionChain,
        category: ItemCategory,
Severity: Minor
Found in lib/poke_api/item.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 has too many lines. [12/10]
Open

      def initialize(data)
        @ailment = MoveAilment.new(data[:ailment])
        @category = MoveCategory.new(data[:category])
        @min_hits = data[:min_hits]
        @max_hits = data[:max_hits]
Severity: Minor
Found in lib/poke_api/move/move_meta_data.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 has too many lines. [12/10]
Open

    def custom_endpoint_object
      {
        color: PokemonColor,
        pokedex_numbers: PokemonSpeciesDexEntry,
        evolves_from_species: PokemonSpecies,
Severity: Minor
Found in lib/poke_api/pokemon_species.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 has too many lines. [11/10]
Open

    def custom_endpoint_object
      {
        abilities: PokemonAbility,
        forms: PokemonForm,
        game_indices: Common::VersionGameIndex,
Severity: Minor
Found in lib/poke_api/pokemon.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 sanitize_query has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
Open

    def sanitize_query(query)
      return query unless query.is_a? Hash

      query[:limit] ||= 20
      query[:offset] = query[:page] ? query[:limit] * (query[:page] - 1) : (query[:offset] || 0)
Severity: Minor
Found in lib/utils/fetcher.rb - About 55 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

Fetcher#sanitize_query has approx 8 statements
Open

    def sanitize_query(query)
Severity: Minor
Found in lib/utils/fetcher.rb by reek

A method with Too Many Statements is any method that has a large number of lines.

Too Many Statements warns about any method that has more than 5 statements. Reek's smell detector for Too Many Statements counts +1 for every simple statement in a method and +1 for every statement within a control structure (if, else, case, when, for, while, until, begin, rescue) but it doesn't count the control structure itself.

So the following method would score +6 in Reek's statement-counting algorithm:

def parse(arg, argv, &error)
  if !(val = arg) and (argv.empty? or /\A-/ =~ (val = argv[0]))
    return nil, block, nil                                         # +1
  end
  opt = (val = parse_arg(val, &error))[1]                          # +2
  val = conv_arg(*val)                                             # +3
  if opt and !arg
    argv.shift                                                     # +4
  else
    val[0] = nil                                                   # +5
  end
  val                                                              # +6
end

(You might argue that the two assigments within the first @if@ should count as statements, and that perhaps the nested assignment should count as +2.)

Fetcher#sanitize_query calls 'query[:limit]' 2 times
Open

      query[:limit] ||= 20
      query[:offset] = query[:page] ? query[:limit] * (query[:page] - 1) : (query[:offset] || 0)
Severity: Minor
Found in lib/utils/fetcher.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Fetcher#sanitize_query calls 'query[:page]' 2 times
Open

      query[:offset] = query[:page] ? query[:limit] * (query[:page] - 1) : (query[:offset] || 0)
Severity: Minor
Found in lib/utils/fetcher.rb by reek

Duplication occurs when two fragments of code look nearly identical, or when two fragments of code have nearly identical effects at some conceptual level.

Reek implements a check for Duplicate Method Call.

Example

Here's a very much simplified and contrived example. The following method will report a warning:

def double_thing()
  @other.thing + @other.thing
end

One quick approach to silence Reek would be to refactor the code thus:

def double_thing()
  thing = @other.thing
  thing + thing
end

A slightly different approach would be to replace all calls of double_thing by calls to @other.double_thing:

class Other
  def double_thing()
    thing + thing
  end
end

The approach you take will depend on balancing other factors in your code.

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  class Stat
    # NatureStatAffectSets object handling all data fetched from /stat for affecting_natures
    class NatureStatAffectSets
      include AssignmentHelpers
Severity: Minor
Found in lib/poke_api/stat/nature_stat_affect_sets.rb and 2 other locations - About 20 mins to fix
lib/poke_api/pokeathlon_stat/nature_pokeathlon_stat_affect_sets.rb on lines 2..19
lib/poke_api/stat/move_stat_affect_sets.rb on lines 2..12

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 27.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  class Stat
    # MoveStatAffectSets object handling all data fetched from /stat for affecting_moves
    class MoveStatAffectSets
      include AssignmentHelpers
Severity: Minor
Found in lib/poke_api/stat/move_stat_affect_sets.rb and 2 other locations - About 20 mins to fix
lib/poke_api/pokeathlon_stat/nature_pokeathlon_stat_affect_sets.rb on lines 2..19
lib/poke_api/stat/nature_stat_affect_sets.rb on lines 2..12

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 27.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 3 locations. Consider refactoring.
Open

  class PokeathlonStat
    # NaturePokeathlonStatAffectSets object handling all data fetched from
    # /pokeathlon-stat affecting_natures
    class NaturePokeathlonStatAffectSets
      include AssignmentHelpers
Severity: Minor
Found in lib/poke_api/pokeathlon_stat/nature_pokeathlon_stat_affect_sets.rb and 2 other locations - About 20 mins to fix
lib/poke_api/stat/move_stat_affect_sets.rb on lines 2..12
lib/poke_api/stat/nature_stat_affect_sets.rb on lines 2..12

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 27.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

  class Move
    # MoveFlavorText object handling all data fetched from /move for flavor_text_entries
    class MoveFlavorText
      attr_reader :flavor_text,
                  :language,
Severity: Minor
Found in lib/poke_api/move/move_flavor_text.rb and 1 other location - About 15 mins to fix
lib/poke_api/ability/ability_flavor_text.rb on lines 2..12

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 25.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

  class Ability
    # AbilityFlavorText object handling all data fetched from /ability flavor_text_entries
    class AbilityFlavorText
      attr_reader :flavor_text,
                  :language,
Severity: Minor
Found in lib/poke_api/ability/ability_flavor_text.rb and 1 other location - About 15 mins to fix
lib/poke_api/move/move_flavor_text.rb on lines 2..12

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 25.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Severity
Category
Status
Source
Language