hnhdigital-os/laravel-folder-watcher

View on GitHub

Showing 33 of 33 total issues

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

                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

                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
                      Severity
                      Category
                      Status
                      Source
                      Language