Sign upLogin

hnhdigital-os/laravel-folder-watcher

View on GitHub
Star
src/FolderWatcherCommand.php

Summary

Maintainability
F
3 days
Test Coverage

getUserHome accesses the super-global variable $_SERVER.
Open

    private function getUserHome()
    {
        // Linux home directory
        $home = getenv('HOME');
Severity: Minor
Found in src/FolderWatcherCommand.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getUserHome accesses the super-global variable $_SERVER.
Open

    private function getUserHome()
    {
        // Linux home directory
        $home = getenv('HOME');
Severity: Minor
Found in src/FolderWatcherCommand.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getWorkingDirectory accesses the super-global variable $_SERVER.
Open

    private function getWorkingDirectory($file_name)
    {
        $path = env('XDG_RUNTIME_DIR') ? env('XDG_RUNTIME_DIR') : $this->getUserHome();
        $path = empty($path) ? $_SERVER['TMPDIR'] : $path;
        $path .= '/'.$file_name;
Severity: Minor
Found in src/FolderWatcherCommand.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getUserHome accesses the super-global variable $_SERVER.
Open

    private function getUserHome()
    {
        // Linux home directory
        $home = getenv('HOME');
Severity: Minor
Found in src/FolderWatcherCommand.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

getUserHome accesses the super-global variable $_SERVER.
Open

    private function getUserHome()
    {
        // Linux home directory
        $home = getenv('HOME');
Severity: Minor
Found in src/FolderWatcherCommand.php by phpmd

Superglobals

Since: 0.2

Accessing a super-global variable directly is considered a bad practice. These variables should be encapsulated in objects that are provided by a framework, for instance.

Example

class Foo {
    public function bar() {
        $name = $_POST['foo'];
    }
}

Source

File FolderWatcherCommand.php has 470 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

namespace Bluora\LaravelFolderWatcher;

use Illuminate\Console\Command;
Severity: Minor
Found in src/FolderWatcherCommand.php - About 7 hrs to fix

    Function processEvent has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
    Open

        private function processEvent($event_detail)
    {
        $is_dir = false;

        // Directory events have a different hex, convert to the same number for a file event.
    Severity: Minor
    Found in src/FolderWatcherCommand.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

    FolderWatcherCommand has 25 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class FolderWatcherCommand extends Command
{
    /**
     * The name and signature of the console command.
     *
    Severity: Minor
    Found in src/FolderWatcherCommand.php - About 2 hrs to fix

      Method processEvent has 50 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private function processEvent($event_detail)
    {
        $is_dir = false;

        // Directory events have a different hex, convert to the same number for a file event.
      Severity: Minor
      Found in src/FolderWatcherCommand.php - About 2 hrs to fix

        Function loadFolderWatchers has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
        Open

            private function loadFolderWatchers($config_file)
    {
        if (!file_exists($config_file_path = $config_file)) {
            $config_file_path = base_path().'/'.$config_file;
        Severity: Minor
        Found in src/FolderWatcherCommand.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

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

            public static function scan($scan_path, $include_folders = true, $include_files = true, $depth = -1)
    {
        $paths = [];

        if (substr($scan_path, -1) != '/') {
        Severity: Minor
        Found in src/FolderWatcherCommand.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 handle has 36 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            public function handle()
    {
        switch ($this->argument('action')) {
            case 'help':
                $this->line('');
        Severity: Minor
        Found in src/FolderWatcherCommand.php - About 1 hr to fix

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

              private function loadFolderWatchers($config_file)
    {
        if (!file_exists($config_file_path = $config_file)) {
            $config_file_path = base_path().'/'.$config_file;
          Severity: Minor
          Found in src/FolderWatcherCommand.php - About 1 hr to fix

            Method listProcesses has 32 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

                private function listProcesses()
    {
        $this->cleanProcessList();
        $data = $this->getProcessList();
            Severity: Minor
            Found in src/FolderWatcherCommand.php - About 1 hr to fix

              Method addWatchPath has 28 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                  private function addWatchPath($original_path, $options = false)
    {
        $path = trim($original_path);

        if ($options === false) {
              Severity: Minor
              Found in src/FolderWatcherCommand.php - About 1 hr to fix

                Function cleanProcessList has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function cleanProcessList()
    {
        $data = $this->getProcessList();

        $sha_to_pid = [];
                Severity: Minor
                Found in src/FolderWatcherCommand.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

                Function logForProcess has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function logForProcess($pid)
    {
        $log_path = $this->logPath();
        $size = 0;
        while (true) {
                Severity: Minor
                Found in src/FolderWatcherCommand.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

                Function killProcess has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function killProcess($pid)
    {
        $data = $this->getProcessList();

        if ($pid === 'all') {
                Severity: Minor
                Found in src/FolderWatcherCommand.php - 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

                Function addWatchPath has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function addWatchPath($original_path, $options = false)
    {
        $path = trim($original_path);

        if ($options === false) {
                Severity: Minor
                Found in src/FolderWatcherCommand.php - 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

                Function listenForEvents has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
                Open

                    private function listenForEvents()
    {
        // As long as we have watches that exist, we keep looping.
        while (count($this->track_watches)) {
            // Check the inotify instance for any change events.
                Severity: Minor
                Found in src/FolderWatcherCommand.php - 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

                Avoid too many return statements within this method.
                Open

                                return $this->listProcesses();
                Severity: Major
                Found in src/FolderWatcherCommand.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return $this->backgroundProcess($this->option('watch-path'), $this->option('binary'), $this->option('script-arguments'));
                  Severity: Major
                  Found in src/FolderWatcherCommand.php - About 30 mins to fix

                    Avoid too many return statements within this method.
                    Open

                                    return $this->runProcess($this->option('watch-path'), $this->option('binary'), $this->option('script-arguments'));
                    Severity: Major
                    Found in src/FolderWatcherCommand.php - About 30 mins to fix

                      Avoid too many return statements within this method.
                      Open

                                      return $this->listProcesses();
                      Severity: Major
                      Found in src/FolderWatcherCommand.php - About 30 mins to fix

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

                            private function listProcesses()
    {
        $this->cleanProcessList();
        $data = $this->getProcessList();
                        Severity: Minor
                        Found in src/FolderWatcherCommand.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

                        The method runCommand has a boolean flag argument $delete, which is a certain sign of a Single Responsibility Principle violation.
                        Open

                            private function runCommand($file_path, $delete = false)
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        BooleanArgumentFlag

                        Since: 1.4.0

                        A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

                        Example

                        class Foo {
    public function bar($flag = true) {
    }
}

                        Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

                        Avoid assigning values to variables in if clauses and the like (line '148', column '26').
                        Open

                            private function loadFolderWatchers($config_file)
    {
        if (!file_exists($config_file_path = $config_file)) {
            $config_file_path = base_path().'/'.$config_file;
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        IfStatementAssignment

                        Since: 2.7.0

                        Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

                        Example

                        class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

                        Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

                        Avoid assigning values to variables in if clauses and the like (line '171', column '30').
                        Open

                            private function loadFolderWatchers($config_file)
    {
        if (!file_exists($config_file_path = $config_file)) {
            $config_file_path = base_path().'/'.$config_file;
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        IfStatementAssignment

                        Since: 2.7.0

                        Assignments in if clauses and the like are considered a code smell. Assignments in PHP return the right operand as their result. In many cases, this is an expected behavior, but can lead to many difficult to spot bugs, especially when the right operand could result in zero, null or an empty string and the like.

                        Example

                        class Foo
{
    public function bar($flag)
    {
        if ($foo = 'bar') { // possible typo
            // ...
        }
        if ($baz = 0) { // always false
            // ...
        }
    }
}

                        Source http://phpmd.org/rules/cleancode.html#ifstatementassignment

                        Avoid unused local variables such as '$hex'.
                        Open

                                $hex = $event_detail['mask'];
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        UnusedLocalVariable

                        Since: 0.2

                        Detects when a local variable is declared and/or assigned, but not used.

                        Example

                        class Foo {
    public function doSomething()
    {
        $i = 5; // Unused
    }
}

                        Source https://phpmd.org/rules/unusedcode.html#unusedlocalvariable

                        Avoid using empty try-catch blocks in removeWatchPath.
                        Open

                                    } catch (\Exception $exception) {
            }
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        EmptyCatchBlock

                        Since: 2.7.0

                        Usually empty try-catch is a bad idea because you are silently swallowing an error condition and then continuing execution. Occasionally this may be the right thing to do, but often it's a sign that a developer saw an exception, didn't know what to do about it, and so used an empty catch to silence the problem.

                        Example

                        class Foo {

  public function bar()
  {
      try {
          // ...
      } catch (Exception $e) {} // empty catch block
  }
}

                        Source https://phpmd.org/rules/design.html#emptycatchblock

                        Avoid using Bluora\LaravelFolderWatcher\count() function in while loops.
                        Open

                                while (count($this->track_watches)) {
            // Check the inotify instance for any change events.
            $events = inotify_read($this->watcher);

            // One or many events occured.
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php by phpmd

                        CountInLoopExpression

                        Since: 2.7.0

                        Using count/sizeof in loops expressions is considered bad practice and is a potential source of many bugs, especially when the loop manipulates an array, as count happens on each iteration.

                        Example

                        class Foo {

  public function bar()
  {
    $array = array();

    for ($i = 0; count($array); $i++) {
      // ...
    }
  }
}

                        Source https://phpmd.org/rules/design.html#countinloopexpression

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

                                    if (!file_exists($folder_path = $folder)) {
                $folder_path = base_path().'/'.$folder;
                if (!file_exists($config_file_path)) {
                    $this->line('');
                    $this->error(sprintf('Folder %s requested to watch does not exist.', $folder));
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php and 1 other location - About 30 mins to fix
                        src/FolderWatcherCommand.php on lines 148..158

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

                        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

                                if (!file_exists($config_file_path = $config_file)) {
            $config_file_path = base_path().'/'.$config_file;

            if (!file_exists($config_file_path)) {
                $this->line('');
                        Severity: Minor
                        Found in src/FolderWatcherCommand.php and 1 other location - About 30 mins to fix
                        src/FolderWatcherCommand.php on lines 171..180

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

                        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