Ybrin/chatbot_helper-telegram

View on GitHub

Showing 9 of 9 total issues

Method valid_resource? has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

        def valid_resource?(resource)
          return false if resource.nil?

          # A KeyboardButton can be a simple String.
          # So if it is string like, return true because it
Severity: Minor
Found in lib/chatbot_helper/telegram/keyboard_button.rb - About 1 hr 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

Method valid_resource? has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
Open

        def valid_resource?(resource)
          return false if resource.nil? || !resource.respond_to?('[]')

          required_fields.each do |f|
            return false if resource[f].nil?
Severity: Minor
Found in lib/chatbot_helper/telegram/base_resource.rb - About 1 hr 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

Avoid too many return statements within this method.
Open

              return false unless a[:type].valid_resource?(el)
Severity: Major
Found in lib/chatbot_helper/telegram/keyboard_button.rb - About 30 mins to fix

    Avoid too many return statements within this method.
    Open

                return false unless arr.respond_to?('each')
    Severity: Major
    Found in lib/chatbot_helper/telegram/keyboard_button.rb - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                    return false unless a[:type].valid_resource?(el)
      Severity: Major
      Found in lib/chatbot_helper/telegram/base_resource.rb - About 30 mins to fix

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

                  required_arrays.each do |a|
                    arr = resource[a[:name]]
                    return false unless arr.respond_to?('each')
                    arr.each do |el|
                      return false unless a[:type].valid_resource?(el)
        Severity: Minor
        Found in lib/chatbot_helper/telegram/base_resource.rb and 1 other location - About 25 mins to fix
        lib/chatbot_helper/telegram/keyboard_button.rb on lines 34..38

        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 29.

        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

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

                  required_arrays.each do |a|
                    arr = resource[a[:name]]
                    return false unless arr.respond_to?('each')
                    arr.each do |el|
                      return false unless a[:type].valid_resource?(el)
        Severity: Minor
        Found in lib/chatbot_helper/telegram/keyboard_button.rb and 1 other location - About 25 mins to fix
        lib/chatbot_helper/telegram/base_resource.rb on lines 123..127

        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 29.

        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

          module Telegram
            # The animation resource which represents a Telegram bot API animation
            class Animation < ChatbotHelper::Telegram::BaseResource
              class << self
                def required_fields
        Severity: Minor
        Found in lib/chatbot_helper/telegram/animation.rb and 1 other location - About 20 mins to fix
        lib/chatbot_helper/telegram/document.rb on lines 2..17

        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

          module Telegram
            # The document resource which represents a Telegram bot API document
            class Document < ChatbotHelper::Telegram::BaseResource
              class << self
                def required_fields
        Severity: Minor
        Found in lib/chatbot_helper/telegram/document.rb and 1 other location - About 20 mins to fix
        lib/chatbot_helper/telegram/animation.rb on lines 2..17

        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

        Severity
        Category
        Status
        Source
        Language