felixarntz/wp-encrypt

View on GitHub
inc/WPENC/Core/KeyPair.php

Summary

Maintainability
C
1 day
Test Coverage

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

        public function generate() {
            $filesystem = Util::get_filesystem();

            $status = Util::maybe_create_letsencrypt_certificates_dir();
            if ( is_wp_error( $status ) ) {
Severity: Minor
Found in inc/WPENC/Core/KeyPair.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

Method generate has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

        public function generate() {
            $filesystem = Util::get_filesystem();

            $status = Util::maybe_create_letsencrypt_certificates_dir();
            if ( is_wp_error( $status ) ) {
Severity: Minor
Found in inc/WPENC/Core/KeyPair.php - About 1 hr to fix

    Function read_private has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

            public function read_private( $force_refresh = false ) {
                $filesystem = Util::get_filesystem();
    
                if ( null === $this->private_key_resource || $force_refresh ) {
                    $path = $this->path . '/' . self::PRIVATE_NAME;
    Severity: Minor
    Found in inc/WPENC/Core/KeyPair.php - About 55 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

    Function get_private_details has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

            public function get_private_details( $force_refresh = false ) {
                if ( null === $this->private_key_details || $force_refresh ) {
                    $private_key = $this->read_private();
                    if ( is_wp_error( $private_key ) ) {
                        return $private_key;
    Severity: Minor
    Found in inc/WPENC/Core/KeyPair.php - About 55 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 new WP_Error( 'private_key_cannot_write', sprintf( __( 'Could not write private key into file <code>%s</code>. Please check your filesystem permissions.', 'wp-encrypt' ), $this->path . '/' . self::PRIVATE_NAME ) );
    Severity: Major
    Found in inc/WPENC/Core/KeyPair.php - About 30 mins to fix

      Avoid too many return statements within this method.
      Open

                  return true;
      Severity: Major
      Found in inc/WPENC/Core/KeyPair.php - About 30 mins to fix

        Avoid too many return statements within this method.
        Open

                        return new WP_Error( 'public_key_cannot_write', sprintf( __( 'Could not write public key into file <code>%s</code>. Please check your filesystem permissions.', 'wp-encrypt' ), $this->path . '/' . self::PUBLIC_NAME ) );
        Severity: Major
        Found in inc/WPENC/Core/KeyPair.php - About 30 mins to fix

          Avoid too many return statements within this method.
          Open

                              return new WP_Error( 'private_key_cannot_create_dir', sprintf( __( 'Could not create directory <code>%s</code> for private key. Please check your filesystem permissions.', 'wp-encrypt' ), $this->path ) );
          Severity: Major
          Found in inc/WPENC/Core/KeyPair.php - About 30 mins to fix

            Function get_private has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                    public function get_private( $force_refresh = false ) {
                        $filesystem = Util::get_filesystem();
            
                        if ( null === $this->private_key || $force_refresh ) {
                            $path = $this->path . '/' . self::PRIVATE_NAME;
            Severity: Minor
            Found in inc/WPENC/Core/KeyPair.php - 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

            Function get_public has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

                    public function get_public( $force_refresh = false ) {
                        $filesystem = Util::get_filesystem();
            
                        if ( null === $this->public_key || $force_refresh ) {
                            $path = $this->path . '/' . self::PUBLIC_NAME;
            Severity: Minor
            Found in inc/WPENC/Core/KeyPair.php - 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

                    public function get_private( $force_refresh = false ) {
                        $filesystem = Util::get_filesystem();
            
                        if ( null === $this->private_key || $force_refresh ) {
                            $path = $this->path . '/' . self::PRIVATE_NAME;
            Severity: Major
            Found in inc/WPENC/Core/KeyPair.php and 1 other location - About 2 hrs to fix
            inc/WPENC/Core/KeyPair.php on lines 176..187

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

            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

                    public function get_public( $force_refresh = false ) {
                        $filesystem = Util::get_filesystem();
            
                        if ( null === $this->public_key || $force_refresh ) {
                            $path = $this->path . '/' . self::PUBLIC_NAME;
            Severity: Major
            Found in inc/WPENC/Core/KeyPair.php and 1 other location - About 2 hrs to fix
            inc/WPENC/Core/KeyPair.php on lines 198..209

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

            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