Merge pull request #4 from vc-dhavaljoshi/master

Version upgraded

Author: ruchit288

CHANGELOG.md

@@ -4,4 +4,10 @@ All notable changes to `laravel-word-refiner` will be documented in this file.
 
 ## v1.0.0 - 2019-01-08
 
-- Initial Release
+- Initial Release
+
+## V2.0.0 - 2023-04-27
+
+- Version Upgrade
+- Code Structure Improvement
+- ReadMe File Update

README.md

@@ -9,13 +9,13 @@ The Laravel Word Refiner package helps you to refine any words from your collect
 You can install the package via composer:
 
 ```bash
-composer require viitorcloud/laravel-word-refiner
+composer require vcian/laravel-word-refiner
 ```
 
 After installation, You need to publish the config file for this package. This will add the file config/refiner.php, where you can add extra word which you want to deprecate from your collection data.
 
 ```bash
-php artisan vendor:publish --provider="WordRefiner\WordRefinerProvider"
+php artisan vendor:publish
 ```
 
 ### Usage

composer.json

@@ -1,23 +1,26 @@
 {
     "name": "vcian/laravel-word-refiner",
-    "description": "Word refining for laravel collection data",
+    "description": "Word refining from laravel collection data",
     "keywords": [
-        "viitorcloud",
-        "vcian",
-        "viitorcloudtechnologies",
         "laravel",
-        "word-refiner"
+        "abuse word",
+        "moral police",
+        "abuse",
+        "word refiner",
+        "violence word"
     ],
+    "type": "library",
     "license": "MIT",
     "authors": [
         {
-            "name": "Viitor Cloud",
-            "email": "[email protected]"
+            "name":     "Vcian - ViitorCloud",
+            "homepage": "https://github.com/vcian",
+            "role":     "Developer"
         }
     ],
     "autoload": {
         "psr-4": {
-            "WordRefiner\\": "src/"
+            "Vcian\\LaravelWordRefiner\\": "src/"
         },
         "files": [
             "src/helpers.php"
@@ -27,11 +30,11 @@
     "extra": {
         "laravel": {
             "providers": [
-                "WordRefiner\\WordRefinerProvider"
+                "Vcian\\LaravelWordRefiner\\Providers\\WordRefinerProvider"
             ]
         }
     },
     "require": {
-        "php": ">=5.4.0"
+        "php": "^8.0"
     }
 }

config/refiner.php

@@ -0,0 +1,9 @@
+<?php
+// Add all refine words which you would like to refine (eliminate) from the collection data,
+
+return [
+    'offensive',
+    'duck',
+    'shit',
+    'oops',
+];

src/Providers/WordRefinerProvider.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Vcian\LaravelWordRefiner\Providers;
+
+use Illuminate\Support\ServiceProvider;
+
+class WordRefinerProvider extends ServiceProvider
+{
+    /**
+     * @return void
+     */
+    public function boot() : void
+    {
+        require_once __DIR__ .'/../../src/helpers.php';
+        require_once __DIR__ . '/../../config/refiner.php';
+
+        $this->publishes([
+            __DIR__ . '/../../config/refiner.php' => config_path('refiner.php'),
+        ], 'refiner-config');
+    }
+}

src/WordRefinerProvider.php

@@ -1,11 +1,13 @@
 <?php
 
+use Illuminate\Support\Facades\Log;
+
 if (!function_exists('refiner')) {
     /**
      * @param $request
-     * @return \Illuminate\Support\Collection
+     * @return mixed
      */
-    function refiner($request)
+    function refiner($request) : mixed
     {
         try {
             if (is_array($request)) {
@@ -28,7 +30,7 @@ function refiner($request)
                     $detectWords = array_flip($detectWords);
 
                     foreach ($requestedString as $words) {
-                        $filterWords = rtrim(clean($words), '.');
+                        $filterWords = rtrim($words, '.');
 
                         if (!isset($detectWords[$filterWords])) {
                             $filterString[] = $words;
@@ -41,8 +43,9 @@ function refiner($request)
             }
 
             return $request;
-        } catch (\Exception $ex) {
-            \Log::error($ex->getMessage());
+        } catch (Exception $ex) {
+            Log::error($ex->getMessage());
+
             return collect([]);
         }
     }