Sign upLogin

robertgauld/osm

View on GitHub
Star
lib/osm/invoice.rb

Summary

Maintainability
C
1 day
Test Coverage

File invoice.rb has 268 lines of code (exceeds 250 allowed). Consider refactoring.
Open

module Osm

  class Invoice < Osm::Model
    SORT_BY = [:section_id, :name, :date]
Severity: Minor
Found in lib/osm/invoice.rb - About 2 hrs to fix

    Method update has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
    Open

          def update(api)
        require_ability_to(api, :write, :finance, invoice.section_id)
        raise Osm::ObjectIsInvalid, 'invoice item is invalid' unless valid?

        updated = true
    Severity: Minor
    Found in lib/osm/invoice.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 update has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

          def update(api)
        require_ability_to(api, :write, :finance, invoice.section_id)
        raise Osm::ObjectIsInvalid, 'invoice item is invalid' unless valid?

        updated = true
    Severity: Minor
    Found in lib/osm/invoice.rb - About 1 hr to fix

      Method get_for_section has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def self.get_for_section(api, section, options={})
      require_ability_to(api, :read, :finance, section, options)
      section_id = section.to_i
      cache_key = ['invoice_ids', section_id]
      invoices = nil
      Severity: Minor
      Found in lib/osm/invoice.rb - About 1 hr to fix

        Method create has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

              def create(api)
        raise Osm::Error, 'the invoice item already exists in OSM' unless id.nil?
        raise Osm::ObjectIsInvalid, 'invoice item is invalid' unless valid?
        Osm::Model.require_ability_to(api, :write, :finance, invoice.section_id)
        Severity: Minor
        Found in lib/osm/invoice.rb - About 45 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

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

            def self.get_for_section(api, section, options={})
      require_ability_to(api, :read, :finance, section, options)
      section_id = section.to_i
      cache_key = ['invoice_ids', section_id]
      invoices = nil
        Severity: Minor
        Found in lib/osm/invoice.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

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

            def create(api)
      raise Osm::Error, 'the invoice already exists in OSM' unless id.nil?
      raise Osm::ObjectIsInvalid, 'invoice is invalid' unless valid?
      Osm::Model.require_ability_to(api, :write, :finance, section_id)
        Severity: Minor
        Found in lib/osm/invoice.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

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

            def self.get(api, section, invoice_id, options={})
      require_ability_to(api, :read, :events, section, options)
      section_id = section.to_i
      invoice_id = invoice_id.to_i
      cache_key = ['invoice', invoice_id]
        Severity: Minor
        Found in lib/osm/invoice.rb and 1 other location - About 1 hr to fix
        lib/osm/event.rb on lines 199..210

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

        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