cleanups

Author: ctf0

README.md

@@ -77,15 +77,22 @@ return [
 ### Good Practice
 Ofcourse you are free to code your app the way you want, but just in-case here are the naming convention the package use.
 
-- `title`       > `title_case(some title)`
-- `route_name`  > `str_slug(title)`
-- `action`      > `SomeController\camelCase(title)`
+| column name |                format                |   output   |
+|-------------|--------------------------------------|------------|
+| title       | title_case(some title)               | Some Title |
+| route_name  | str_slug(Some Title)                 | some-title |
+| action      | SomeController\camelCase(Some Title) | someTitle  |
 
 ## Notes
-- for the pages with "action" you can get all the page params like **template, title, body, desc, breadCrump** inside your "action@method" by using `extract(cache('the_route_name'));`
+- you can get any page params like (**template, title, body, desc, breadCrump**) by using `extract(cache('the_route_name'));`
 
 <u>**or**</u>
-- if you followed the naming convention above, you can instead use `extract(cache(kebab_case('TheCurrentMethodName')));`
+
+- if you followed the naming convention above and you are inside the `page action method`, you can instead use `extract(cache(kebab_case('TheCurrentMethodName')));`
+
+    | method name |          format         | output = route_name |
+    |-------------|-------------------------|---------------------|
+    | contactUs   | kebab_case('contactUs') | contact-us          |
 
 # ToDo
 

src/Controller/DummyController.php

@@ -11,11 +11,6 @@ public function handle()
     {
         extract(cache(Route::currentRouteName()));
 
-        return view(config('simpleMenu.templatePath').".$template")->with([
-            'title'      => $title,
-            'body'       => $body,
-            'desc'       => $desc,
-            'breadCrump' => $breadCrump,
-        ]);
+        return view(config('simpleMenu.templatePath').".$template", compact('title', 'body', 'desc', 'breadCrump'));
     }
 }

src/Traits/RoutesTrait.php

@@ -91,21 +91,20 @@ protected function routeGen($routeName, $url, $prefix, $action, $roles, $permiss
             return;
         }
 
+        // cache the page so we pass the page params to the controller@method
+        Cache::forever($routeName, compact('template', 'title', 'body', 'desc', 'breadCrump'));
+
         $route = $this->getRouteUrl($url, $prefix);
 
         // dynamic
         if ($action) {
-            Cache::forever($routeName, compact('template', 'title', 'body', 'desc', 'breadCrump'));
-
             Route::get($route)
             ->uses(config('simpleMenu.pagesControllerNS').'\\'.$action)
             ->name($routeName)
             ->middleware([$roles, $permissions]);
         }
         // static
         else {
-            Cache::forever($routeName, compact('template', 'title', 'body', 'desc', 'breadCrump'));
-
             Route::get($route)
             ->uses('\ctf0\SimpleMenu\Controller\DummyController@handle')
             ->name($routeName)

src/database/seeds/PagesTableSeeder.php

@@ -20,8 +20,8 @@ public function run()
                 'template'  => 'hero',
                 'action'    => 'PageController@'.camel_case($one),
                 'title'     => [
-                    'en' => $one,
-                    'fr' => $one,
+                    'en' => title_case($one),
+                    'fr' => title_case($one),
                 ],
                 'body' => [
                     'en' => $faker->text(),
@@ -44,11 +44,11 @@ public function run()
             $fr = $faker->unique()->city;
 
             Page::create([
-                'template'  => 'hero',
                 'route_name'=> str_slug($en),
+                'template'  => 'hero',
                 'title'     => [
-                     'en' => $en,
-                     'fr' => $fr,
+                     'en' => title_case($en),
+                     'fr' => title_case($fr),
                 ],
                 'body' => [
                     'en' => $faker->text(),