zendesk/zendesk_api_client_rb

View on GitHub
lib/zendesk_api/resources.rb

Summary

Maintainability
D
1 day
Test Coverage

File resources.rb has 699 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module ZendeskAPI
  # @internal The following are redefined later, but needed by some circular resources (e.g. Ticket -> User, User -> Ticket)

  class Ticket < Resource; end
  class Forum < Resource; end
Severity: Major
Found in lib/zendesk_api/resources.rb - About 1 day to fix

    Method _save has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

          def _save(method = :save)
            return self unless @resources
    
            @client.connection.post(path) do |req|
              req.body = { :tags => @resources.reject(&:destroyed?).map(&:id) }
    Severity: Minor
    Found in lib/zendesk_api/resources.rb - About 35 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

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

        class Comment < DataResource
          include Save
    
          has_many :uploads, :class => Attachment, :inline => true
          has :author, :class => User
    Severity: Minor
    Found in lib/zendesk_api/resources.rb and 1 other location - About 20 mins to fix
    lib/zendesk_api/resources.rb on lines 332..347

    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

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

        class Comment < DataResource
          include Save
    
          has_many :uploads, :class => Attachment, :inline => true
          has :author, :class => User
    Severity: Minor
    Found in lib/zendesk_api/resources.rb and 1 other location - About 20 mins to fix
    lib/zendesk_api/resources.rb on lines 408..423

    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

    There are no issues that match your filters.

    Category
    Status