voucherifyio/voucherify-ruby-sdk

View on GitHub
lib/VoucherifySdk/models/campaign_base.rb

Summary

Maintainability
F
5 days
Test Coverage

Method initialize has a Cognitive Complexity of 49 (exceeds 5 allowed). Consider refactoring.
Open

    def initialize(attributes = {})
      if (!attributes.is_a?(Hash))
        fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::CampaignBase` initialize method"
      end

Severity: Minor
Found in lib/VoucherifySdk/models/campaign_base.rb - About 7 hrs 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

File campaign_base.rb has 471 lines of code (exceeds 250 allowed). Consider refactoring.
Open

require 'date'
require 'time'

module VoucherifySdk
  # This is an object representing a campaign.
Severity: Minor
Found in lib/VoucherifySdk/models/campaign_base.rb - About 7 hrs to fix

    Method initialize has 125 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        def initialize(attributes = {})
          if (!attributes.is_a?(Hash))
            fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::CampaignBase` initialize method"
          end
    
    
    Severity: Major
    Found in lib/VoucherifySdk/models/campaign_base.rb - About 5 hrs to fix

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

          def valid?
            warn '[DEPRECATED] the `valid?` method is obsolete'
            return false if @id.nil?
            return false if @name.nil?
            return false if @campaign_type.nil?
      Severity: Minor
      Found in lib/VoucherifySdk/models/campaign_base.rb - About 2 hrs 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 list_invalid_properties has 42 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          def list_invalid_properties
            warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
            invalid_properties = Array.new
            if @id.nil?
              invalid_properties.push('invalid value for "id", id cannot be nil.')
      Severity: Minor
      Found in lib/VoucherifySdk/models/campaign_base.rb - About 1 hr to fix

        Method list_invalid_properties has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
        Open

            def list_invalid_properties
              warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
              invalid_properties = Array.new
              if @id.nil?
                invalid_properties.push('invalid value for "id", id cannot be nil.')
        Severity: Minor
        Found in lib/VoucherifySdk/models/campaign_base.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 _deserialize has 34 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            def self._deserialize(type, value)
              case type.to_sym
              when :Time
                Time.parse(value)
              when :Date
        Severity: Minor
        Found in lib/VoucherifySdk/models/campaign_base.rb - About 1 hr to fix

          Method attribute_map has 30 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

              def self.attribute_map
                {
                  :'id' => :'id',
                  :'name' => :'name',
                  :'description' => :'description',
          Severity: Minor
          Found in lib/VoucherifySdk/models/campaign_base.rb - About 1 hr to fix

            Method openapi_types has 30 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                def self.openapi_types
                  {
                    :'id' => :'String',
                    :'name' => :'String',
                    :'description' => :'String',
            Severity: Minor
            Found in lib/VoucherifySdk/models/campaign_base.rb - About 1 hr to fix

              Method == has 30 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  def ==(o)
                    return true if self.equal?(o)
                    self.class == o.class &&
                        id == o.id &&
                        name == o.name &&
              Severity: Minor
              Found in lib/VoucherifySdk/models/campaign_base.rb - About 1 hr to fix

                Method build_from_hash has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                    def self.build_from_hash(attributes)
                      return nil unless attributes.is_a?(Hash)
                      attributes = attributes.transform_keys(&:to_sym)
                      transformed_hash = {}
                      openapi_types.each_pair do |key, type|
                Severity: Minor
                Found in lib/VoucherifySdk/models/campaign_base.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 _deserialize has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                    def self._deserialize(type, value)
                      case type.to_sym
                      when :Time
                        Time.parse(value)
                      when :Date
                Severity: Minor
                Found in lib/VoucherifySdk/models/campaign_base.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 to_hash has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                    def to_hash
                      hash = {}
                      self.class.attribute_map.each_pair do |attr, param|
                        value = self.send(attr)
                        if value.nil?
                Severity: Minor
                Found in lib/VoucherifySdk/models/campaign_base.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

                Avoid too many return statements within this method.
                Open

                      return false if @creation_status.nil?
                Severity: Major
                Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                        return false unless vouchers_generation_status_validator.valid?(@vouchers_generation_status)
                  Severity: Major
                  Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                          return false if @type.nil?
                    Severity: Major
                    Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                            return false if @created_at.nil?
                      Severity: Major
                      Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                        Avoid too many return statements within this method.
                        Open

                              return false unless creation_status_validator.valid?(@creation_status)
                        Severity: Major
                        Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                          Avoid too many return statements within this method.
                          Open

                                return false if @auto_join.nil?
                          Severity: Major
                          Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                            Avoid too many return statements within this method.
                            Open

                                  return false if @join_once.nil?
                            Severity: Major
                            Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                              Avoid too many return statements within this method.
                              Open

                                    return false if @vouchers_generation_status.nil?
                              Severity: Major
                              Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                                Avoid too many return statements within this method.
                                Open

                                      return false if @object.nil?
                                Severity: Major
                                Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                                  Avoid too many return statements within this method.
                                  Open

                                        return false if @use_voucher_metadata_schema.nil?
                                  Severity: Major
                                  Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                                    Avoid too many return statements within this method.
                                    Open

                                          return false unless type_validator.valid?(@type)
                                    Severity: Major
                                    Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                                      Avoid too many return statements within this method.
                                      Open

                                            return false if @protected.nil?
                                      Severity: Major
                                      Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

                                        Avoid too many return statements within this method.
                                        Open

                                              return false if @categories.nil?
                                        Severity: Major
                                        Found in lib/VoucherifySdk/models/campaign_base.rb - About 30 mins to fix

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

                                              def _to_hash(value)
                                                if value.is_a?(Array)
                                                  value.compact.map { |v| _to_hash(v) }
                                                elsif value.is_a?(Hash)
                                                  {}.tap do |hash|
                                          Severity: Minor
                                          Found in lib/VoucherifySdk/models/campaign_base.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.openapi_types
                                                {
                                                  :'id' => :'String',
                                                  :'name' => :'String',
                                                  :'description' => :'String',
                                          Severity: Major
                                          Found in lib/VoucherifySdk/models/campaign_base.rb and 1 other location - About 1 hr to fix
                                          lib/VoucherifySdk/models/campaign_base.rb on lines 122..151

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

                                          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

                                              def self.attribute_map
                                                {
                                                  :'id' => :'id',
                                                  :'name' => :'name',
                                                  :'description' => :'description',
                                          Severity: Major
                                          Found in lib/VoucherifySdk/models/campaign_base.rb and 1 other location - About 1 hr to fix
                                          lib/VoucherifySdk/models/campaign_base.rb on lines 161..190

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

                                          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