Merge pull request #3751 from ColoredCow/feat/operation_module_code_clean

operation_module_code_clean

Author: rathorevaibhav

.github/workflows/coding-standards.yml

@@ -10,19 +10,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+
       - name: Setup PHP v7.4
         uses: shivammathur/setup-php@v2
         with:
           php-version: "7.4"
+
       - name: Install composer dependencies
         run: composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress --prefer-dist
+
       - name: Setup env file
         run: cp ./.env.example .env
+
       - name: Configure application encryption key
         run: php artisan key:generate
+
       - name: Install NPM Dependencies
         run: npm install
-      - name: clear cache
+
+      - name: Clear cache
         run: php artisan cache:clear
+
       - name: ColoredCowLaravelCI
-        run: "php artisan check:ci --with-tty"
+        run: php artisan check:ci --with-tty

.php-cs-fixer.php

@@ -3,6 +3,7 @@
 use PhpCsFixer\Finder;
 
 $rules = [
+    '@PSR12' => true,
     'array_syntax' => ['syntax' => 'short'],
     'binary_operator_spaces' => [
         'default' => 'single_space',
@@ -13,77 +14,82 @@
     'blank_line_before_statement' => [
         'statements' => ['return'],
     ],
-    'braces' => true,
     'cast_spaces' => true,
-    'class_definition' => true,
     'class_attributes_separation' => [
         'elements' => [
             'trait_import' => 'none',
         ],
     ],
+    'class_definition' => true,
     'concat_space' => [
         'spacing' => 'one',
     ],
+    'control_structure_braces' => true,
+    'control_structure_continuation_position' => true,
     'declare_equal_normalize' => true,
+    'declare_parentheses' => true,
     'elseif' => true,
     'encoding' => true,
     'full_opening_tag' => true,
-    'fully_qualified_strict_types' => true,
+    'fully_qualified_strict_types' => false,
     'function_declaration' => true,
-    'function_typehint_space' => true,
     'heredoc_to_nowdoc' => true,
     'include' => true,
     'increment_style' => ['style' => 'post'],
     'indentation_type' => true,
-    'linebreak_after_opening_tag' => true,
     'line_ending' => true,
+    'linebreak_after_opening_tag' => true,
     'lowercase_cast' => true,
     'lowercase_keywords' => true,
     'lowercase_static_reference' => true,
-    'magic_method_casing' => true,
     'magic_constant_casing' => true,
+    'magic_method_casing' => true,
     'method_argument_space' => true,
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line',
+    ],
     'native_function_casing' => true,
     'no_alias_functions' => true,
-    'no_extra_blank_lines' => [
-        'tokens' => [
-            'extra',
-            'throw',
-            'use',
-        ],
-    ],
     'no_blank_lines_after_class_opening' => true,
     'no_blank_lines_after_phpdoc' => true,
     'no_closing_tag' => true,
     'no_empty_phpdoc' => true,
     'no_empty_statement' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'curly_brace_block',
+        ],
+    ],
     'no_leading_import_slash' => true,
     'no_leading_namespace_whitespace' => true,
     'no_mixed_echo_print' => [
         'use' => 'echo',
     ],
-    'no_multiline_whitespace_around_double_arrow' => true,
-    'multiline_whitespace_before_semicolons' => [
-        'strategy' => 'no_multi_line',
-    ],
+    'no_multiple_statements_per_line' => true,
     'no_short_bool_cast' => true,
     'no_singleline_whitespace_before_semicolons' => true,
     'no_spaces_after_function_name' => true,
     'no_spaces_around_offset' => true,
-    'no_spaces_inside_parenthesis' => true,
     'no_trailing_comma_in_singleline' => true,
     'no_trailing_whitespace' => true,
     'no_trailing_whitespace_in_comment' => true,
     'no_unneeded_control_parentheses' => true,
     'no_unreachable_default_argument_value' => true,
+    'no_unused_imports' => true,
     'no_useless_return' => true,
     'no_whitespace_before_comma_in_array' => true,
     'no_whitespace_in_blank_line' => true,
     'normalize_index_brace' => true,
     'not_operator_with_successor_space' => true,
     'object_operator_without_whitespace' => true,
+    'ordered_class_elements' => true,
+    'ordered_imports' => true,
+    'phpdoc_align' => [
+        'tags' => ['param', 'return', 'throws', 'type'],
+    ],
     'phpdoc_indent' => true,
     'phpdoc_no_access' => true,
+    'phpdoc_no_alias_tag' => true,
     'phpdoc_no_package' => true,
     'phpdoc_no_useless_inheritdoc' => true,
     'phpdoc_scalar' => true,
@@ -97,31 +103,32 @@
     'short_scalar_cast' => true,
     'simplified_null_return' => true,
     'single_blank_line_at_eof' => true,
-    'single_blank_line_before_namespace' => true,
     'single_class_element_per_statement' => true,
     'single_import_per_statement' => true,
     'single_line_after_imports' => true,
     'single_line_comment_style' => [
         'comment_types' => ['hash'],
     ],
     'single_quote' => true,
+    'single_space_around_construct' => true,
     'space_after_semicolon' => true,
+    'spaces_inside_parentheses' => ['space' => 'none'],
     'standardize_not_equals' => true,
+    'statement_indentation' => true,
     'switch_case_semicolon_to_colon' => true,
     'switch_case_space' => true,
     'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline' => true,
     'trim_array_spaces' => true,
+    'type_declaration_spaces' => true,
     'unary_operator_spaces' => true,
-    'trailing_comma_in_multiline' => true,
-    'ordered_class_elements' => true,
-    'ordered_imports' => true,
     'visibility_required' => [
         'elements' => ['method', 'property'],
     ],
     'whitespace_after_comma_in_array' => true,
-    'no_unused_imports' => true,
 ];
 
+
 $finder = Finder::create()
     ->notPath('bootstrap')
     ->notPath('storage')

Modules/AppointmentSlots/Services/AppointmentSlotsService.php

@@ -199,7 +199,7 @@ private function createCalendarEvent(ApplicationRound $applicationRound)
         $applicationLink = URL::route($route, $applicationRound->application->id);
         $description = "<a href='{$applicationLink}'>Application Link</a> for Job role: <a href='{$applicationRound->application->job->link}'>{$applicationRound->application->job->title}</a>";
 
-        $event = new CalendarEventService;
+        $event = new CalendarEventService();
 
         $event->create([
             'summary' => $summary,

Modules/Client/Entities/Client.php

@@ -18,7 +18,9 @@
 
 class Client extends Model
 {
-    use HasHierarchy, HasFactory, Filters;
+    use HasHierarchy;
+    use HasFactory;
+    use Filters;
 
     protected $fillable = ['name', 'key_account_manager_id', 'status', 'is_channel_partner', 'has_departments', 'channel_partner_id', 'parent_organisation_id', 'client_id', 'is_billable'];
 
@@ -152,6 +154,7 @@ public function getBillableAmountForTerm(int $monthsToSubtract, $projects, $peri
     public function getTaxAmountForTerm(int $monthsToSubtract, $projects, $periodStartDate = null, $periodEndDate = null)
     {
         $monthsToSubtract = $monthsToSubtract ?? 1;
+
         // Todo: Implement tax calculation correctly as per the IGST rules
         return round($this->getBillableAmountForTerm($monthsToSubtract, $projects, $periodStartDate, $periodEndDate) * ($this->country->initials == 'IN' ? config('invoice.tax-details.igst') : 0), 2);
     }
@@ -409,7 +412,7 @@ public function getClientsAttribute()
 
     protected static function booted()
     {
-        static::addGlobalScope(new ClientGlobalScope);
+        static::addGlobalScope(new ClientGlobalScope());
     }
 
     protected static function newFactory()

Modules/Client/Entities/Scopes/ClientGlobalScope.php

@@ -11,8 +11,8 @@ class ClientGlobalScope implements Scope
     /**
      * Apply the scope to a given Eloquent query builder.
      *
-     * @param  \Illuminate\Database\Eloquent\Builder  $builder
-     * @param  \Illuminate\Database\Eloquent\Model  $model
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @param \Illuminate\Database\Eloquent\Model   $model
      *
      * @return \Illuminate\Database\Eloquent\Builder
      */

Modules/Client/Http/Controllers/ModuleBaseController.php

@@ -9,5 +9,7 @@
 
 class ModuleBaseController extends BaseController
 {
-    use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
+    use AuthorizesRequests;
+    use DispatchesJobs;
+    use ValidatesRequests;
 }

Modules/Client/Rules/ClientNameExist.php

@@ -20,8 +20,8 @@ public function __construct()
     /**
      * Determine if the validation rule passes.
      *
-     * @param  string  $attribute
-     * @param  mixed  $value
+     * @param string $attribute
+     * @param mixed  $value
      *
      * @return bool
      */

Modules/CodeTrek/Emails/CodeTrekApplicantRoundMail.php

@@ -8,7 +8,8 @@
 
 class CodeTrekApplicantRoundMail extends Mailable
 {
-    use Queueable, SerializesModels;
+    use Queueable;
+    use SerializesModels;
     public $applicationRound;
     public $codetrekApplicant;
 

Modules/CodeTrek/Emails/CodetrekMailApplicant.php

@@ -8,7 +8,8 @@
 
 class CodetrekMailApplicant extends Mailable
 {
-    use Queueable, SerializesModels;
+    use Queueable;
+    use SerializesModels;
     public $applicant;
 
     /**

Modules/CodeTrek/Entities/CodeTrekApplicant.php

@@ -7,12 +7,12 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Modules\CodeTrek\Database\factories\CodeTrekApplicantFactory;
-use Modules\Operations\Entities\OfficeLocation;
 use Modules\User\Entities\User;
 
 class CodeTrekApplicant extends Model
 {
-    use SoftDeletes, HasFactory;
+    use SoftDeletes;
+    use HasFactory;
     protected $guarded = [];
 
     public function roundDetails()
@@ -25,11 +25,6 @@ public static function factory()
         return new CodeTrekApplicantFactory();
     }
 
-    public function center()
-    {
-        return $this->belongsTo(OfficeLocation::class, 'center_id');
-    }
-
     public function getDaysInCodetrekAttribute()
     {
         $internshipStartDate = Carbon::parse($this->internship_start_date);

Modules/CodeTrek/Http/Controllers/CodeTrekController.php

@@ -8,7 +8,6 @@
 use Modules\CodeTrek\Entities\CodeTrekApplicant;
 use Modules\CodeTrek\Http\Requests\CodeTrekRequest;
 use Modules\CodeTrek\Services\CodeTrekService;
-use Modules\Operations\Entities\OfficeLocation;
 use Modules\User\Entities\User;
 
 class CodeTrekController extends Controller
@@ -28,7 +27,6 @@ public function index(Request $request)
     {
         // $this->authorize('view', $applicant);     There are some issues in the production, which is why these lines are commented out.
 
-        $centres = OfficeLocation::all();
         $mentors = User::all();
         $applicantData = $this->service->getCodeTrekApplicants($request->all());
         $applicants = $applicantData['applicants'];
@@ -41,7 +39,6 @@ public function index(Request $request)
 
         return view('codetrek::index', [
             'applicants' => $applicants,
-            'centres' => $centres,
             'mentors' => $mentors,
             'reportApplicationCounts' => $reportApplicationCounts,
             'statusCounts' => $statusCounts,
@@ -78,12 +75,10 @@ public function edit(CodeTrekApplicant $applicant)
     {
         // $this->authorize('update', $applicant);   There are some issues in the production, which is why these lines are commented out.
 
-        $centres = OfficeLocation::all();
-
         $mentors = User::all();
         $this->service->edit($applicant);
 
-        return view('codetrek::edit', ['applicant' => $applicant, 'centres' => $centres, 'mentors' => $mentors]);
+        return view('codetrek::edit', ['applicant' => $applicant,  'mentors' => $mentors]);
     }
     public function evaluate(CodeTrekApplicant $applicant)
     {

Modules/CodeTrek/Policies/CodetrekApplicantPolicy.php

@@ -12,7 +12,7 @@ class CodeTrekApplicantPolicy
     /**
      * Determine whether the user can view any models.
      *
-     * @param  \Modules\User\Entities\User  $user
+     * @param \Modules\User\Entities\User $user
      *
      * @return mixed
      */
@@ -24,7 +24,7 @@ public function viewAny(User $user)
     /**
      * Determine whether the user can view the model.
      *
-     * @param  \Modules\User\Entities\User  $user
+     * @param \Modules\User\Entities\User $user
      *
      * @return mixed
      */
@@ -36,7 +36,7 @@ public function view(User $user)
     /**
      * Determine whether the user can create models.
      *
-     * @param  \Modules\User\Entities\User  $user
+     * @param \Modules\User\Entities\User $user
      *
      * @return mixed
      */
@@ -48,7 +48,7 @@ public function create(User $user)
     /**
      * Determine whether the user can update the model.
      *
-     * @param  \Modules\User\Entities\User  $user
+     * @param \Modules\User\Entities\User $user
      *
      * @return mixed
      */
@@ -60,7 +60,7 @@ public function update(User $user)
     /**
      * Determine whether the user can delete the model.
      *
-     * @param  \Modules\User\Entities\User  $user
+     * @param \Modules\User\Entities\User $user
      *
      * @return mixed
      */