Sign upLogin

uruba/FinanCalc

View on GitHub
Star

Showing 109 of 109 total issues

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

<?php

namespace FinanCalc\Calculators\Factories {
Severity: Major
Found in src/Calculators/Factories/BondYTMCalculatorFactory.php and 2 other locations - About 1 day to fix
src/Calculators/Factories/BondDurationCalculatorFactory.php on lines 1..143
src/Calculators/Factories/BondFairValueCalculatorFactory.php on lines 1..122

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

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

<?php

namespace FinanCalc\Calculators\Factories {

    use FinanCalc\Calculators\BondDurationCalculator;
Severity: Major
Found in src/Calculators/Factories/BondDurationCalculatorFactory.php and 2 other locations - About 1 day to fix
src/Calculators/Factories/BondFairValueCalculatorFactory.php on lines 1..122
src/Calculators/Factories/BondYTMCalculatorFactory.php on lines 1..143

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

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

<?php

namespace FinanCalc\Calculators\Factories {

    use FinanCalc\Calculators\BondFairValueCalculator;
Severity: Major
Found in src/Calculators/Factories/BondFairValueCalculatorFactory.php and 2 other locations - About 1 day to fix
src/Calculators/Factories/BondDurationCalculatorFactory.php on lines 1..143
src/Calculators/Factories/BondYTMCalculatorFactory.php on lines 1..143

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

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

The class Helpers has 11 public methods. Consider refactoring Helpers to keep number of public methods under 10.
Open

    class Helpers
    {
        /**
         * @param $checkedVariable
         * @param $nameOfTheExpectedClass
Severity: Minor
Found in src/Utils/Helpers.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

DebtAmortizator has 24 functions (exceeds 20 allowed). Consider refactoring.
Open

    class DebtAmortizator extends CalculatorAbstract
    {
        /** @var  RepaymentInstance[] */
        // list of individual debt's repayments as an array of RepaymentInstance objects
        protected $debtRepayments;
Severity: Minor
Found in src/Calculators/DebtAmortizator.php - About 2 hrs to fix

    AnnuityCalculator has 23 functions (exceeds 20 allowed). Consider refactoring.
    Open

        class AnnuityCalculator extends CalculatorAbstract
    {

        // amount of each individual payment = 'K'
        protected $annuitySinglePaymentAmount;
    Severity: Minor
    Found in src/Calculators/AnnuityCalculator.php - About 2 hrs to fix

      Function populateFactoryClassesArray has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

              private function populateFactoryClassesArray()
        {
            $factoryFiles = glob(FinanCalc::getPath() . Config::getConfigField('factories_relative_path') . '/*.php');
            $factoriesNamespace = Config::getConfigField('factories_namespace');
      Severity: Minor
      Found in src/FinanCalc.php - 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

      TimeSpan has 21 functions (exceeds 20 allowed). Consider refactoring.
      Open

          class TimeSpan
    {
        /** @var  DateTime */
        private $startDate;
        /** @var  DateTime */
      Severity: Minor
      Found in src/Utils/Time/TimeSpan.php - About 2 hrs to fix

        Method getAnnuityValue has 53 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

                public function getAnnuityValue(
            AnnuityPaymentTypes $annuityPaymentType = null,
            AnnuityValueTypes $annuityValueType
        ) {
            // if the number of the annuity's compounding periods
        Severity: Major
        Found in src/Calculators/AnnuityCalculator.php - About 2 hrs to fix

          Method getBondFairValue has 47 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

                  public function getBondFairValue()
        {
            // we need to get the coupon rate per payment period = c/payment frequency
            $couponRateForPeriod = MathFuncs::div(
                $this->bondAnnualCouponRate,
          Severity: Minor
          Found in src/Calculators/BondFairValueCalculator.php - About 1 hr to fix

            Function getResultAsArray has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
            Open

                    final public function getResultAsArray(array $propResultArray = null)
        {
            if ($propResultArray === null) {
                if ($this->propResultArray !== null && is_array($this->propResultArray)) {
                    $propResultArray = $this->propResultArray;
            Severity: Minor
            Found in src/Interfaces/Calculator/CalculatorAbstract.php - 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 excessively long class names like StockDividendDiscountModelCalculatorFactory. Keep class name length under 40.
            Open

                class StockDividendDiscountModelCalculatorFactory extends CalculatorFactoryAbstract
    {
        const MANUFACTURED_CLASS_NAME = 'FinanCalc\\Calculators\\StockDividendDiscountModelCalculator';

        /**
            Severity: Minor
            Found in src/Calculators/Factories/StockDividendDiscountModelCalculatorFactory.php by phpmd

            LongClassName

            Since: 2.9

            Detects when classes or interfaces are declared with excessively long names.

            Example

            class ATooLongClassNameThatHintsAtADesignProblem {

}

interface ATooLongInterfaceNameThatHintsAtADesignProblem {

}

            Source https://phpmd.org/rules/naming.html#longclassname

            Function getAnnuityValue has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
            Open

                    public function getAnnuityValue(
            AnnuityPaymentTypes $annuityPaymentType = null,
            AnnuityValueTypes $annuityValueType
        ) {
            // if the number of the annuity's compounding periods
            Severity: Minor
            Found in src/Calculators/AnnuityCalculator.php - 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 populateFactoryClassesArray has 28 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                    private function populateFactoryClassesArray()
        {
            $factoryFiles = glob(FinanCalc::getPath() . Config::getConfigField('factories_relative_path') . '/*.php');
            $factoriesNamespace = Config::getConfigField('factories_namespace');
            Severity: Minor
            Found in src/FinanCalc.php - About 1 hr to fix

              Method getApproxBondYTM has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                      public function getApproxBondYTM()
        {
            // we need to calculate the coupon payment C = F*(c/payment frequency)
            $couponPayment =
                MathFuncs::mul(
              Severity: Minor
              Found in src/Calculators/BondYTMCalculator.php - About 1 hr to fix

                Method getResultAsArray has 26 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                        final public function getResultAsArray(array $propResultArray = null)
        {
            if ($propResultArray === null) {
                if ($this->propResultArray !== null && is_array($this->propResultArray)) {
                    $propResultArray = $this->propResultArray;
                Severity: Minor
                Found in src/Interfaces/Calculator/CalculatorAbstract.php - About 1 hr to fix

                  Avoid variables with short names like $i. Configured minimum length is 3.
                  Open

                              $i = 1;
                  Severity: Minor
                  Found in src/Calculators/BondDurationCalculator.php by phpmd

                  ShortVariable

                  Since: 0.2

                  Detects when a field, local, or parameter has a very short name.

                  Example

                  class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

                  Source https://phpmd.org/rules/naming.html#shortvariable

                  Avoid variables with short names like $i. Configured minimum length is 3.
                  Open

                              $i = 1;
                  Severity: Minor
                  Found in src/Calculators/BondDurationCalculator.php by phpmd

                  ShortVariable

                  Since: 0.2

                  Detects when a field, local, or parameter has a very short name.

                  Example

                  class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

                  Source https://phpmd.org/rules/naming.html#shortvariable

                  Avoid variables with short names like $i. Configured minimum length is 3.
                  Open

                              $i = 1;
                  Severity: Minor
                  Found in src/Calculators/DebtAmortizator.php by phpmd

                  ShortVariable

                  Since: 0.2

                  Detects when a field, local, or parameter has a very short name.

                  Example

                  class Something {
    private $q = 15; // VIOLATION - Field
    public static function main( array $as ) { // VIOLATION - Formal
        $r = 20 + $this->q; // VIOLATION - Local
        for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
            $r += $this->q;
        }
    }
}

                  Source https://phpmd.org/rules/naming.html#shortvariable

                  Each class must be in a file by itself
                  Open

                      class RepaymentInstance
                  Severity: Minor
                  Found in src/Calculators/DebtAmortizator.php by phpcodesniffer
                  Severity
                  Category
                  Status
                  Source
                  Language