view json file with hide column and limit option (#33)

Signed-off-by: rahul <rcsofttech85@gmail.com>

Author: rcsofttech85

bin/view-json

@@ -21,6 +21,9 @@ $command = (new SingleCommandApplication())
     ->setCode(function (InputInterface $input, OutputInterface $output): int {
         $io = new SymfonyStyle($input, $output);
         $jsonFile = $input->getArgument('jsonFile');
+        $limit = $input->getOption('limit');
+        $hiddenColumns = $input->getOption('hide-column');
+        $hiddenColumns = $hiddenColumns ? explode(',', $hiddenColumns) : false;
 
         if (!file_exists($jsonFile)) {
             $io->error("{$jsonFile} does not exists");
@@ -31,14 +34,26 @@ $command = (new SingleCommandApplication())
         /** @var JsonFileHandler $jsonFileHandler */
         $jsonFileHandler = $serviceContainer->getContainerBuilder()->get('json_file_handler');
 
+        if (isset($limit) && !is_numeric($limit)) {
+            $io->error("{$limit} is not numeric");
+            return Command::FAILURE;
+        }
+
+        $limit = $limit ? (int)$limit : false;
+        $headers = [];
         try {
-            $data = $jsonFileHandler->toArray($jsonFile);
+            $data = $jsonFileHandler->toArray(
+                filename: $jsonFile,
+                headers: $headers,
+                hideColumns: $hiddenColumns,
+                limit: $limit
+            );
         } catch (FileHandlerException) {
             $io->error('invalid json file');
             return Command::FAILURE;
         }
 
-        $headers = array_keys(reset($data));
+
         $io->title($jsonFile);
         $table = $io->createTable();
         $table->setHeaders($headers);

src/CsvFileHandler.php

@@ -4,9 +4,12 @@
 
 use Generator;
 use rcsofttech85\FileHandler\Exception\FileHandlerException;
+use rcsofttech85\FileHandler\Utilities\RowColumnHelper;
 
 class CsvFileHandler
 {
+    use RowColumnHelper;
+
     public function __construct(
         private readonly TempFileHandler $tempFileHandler
     ) {
@@ -147,26 +150,6 @@ private function isValidCsvFileFormat(array $row): bool
         return true;
     }
 
-    /**
-     * @param array<string> $headers
-     * @param array<string> $hideColumns
-     * @return array<int<0, max>,int>
-     */
-    private function setColumnsToHide(array &$headers, array $hideColumns): array
-    {
-        $indices = [];
-        if (!empty($hideColumns)) {
-            foreach ($hideColumns as $hideColumn) {
-                $index = array_search($hideColumn, $headers);
-                if ($index !== false) {
-                    $indices[] = (int)$index;
-                    unset($headers[$index]);
-                }
-            }
-            $headers = array_values($headers);
-        }
-        return $indices;
-    }
 
     /**
      * @param string $filename
@@ -222,22 +205,6 @@ private function getRows(string $filename, array|false $hideColumns = false, int
     }
 
 
-    /**
-     * @param array<int,string> $row
-     * @param array<int<0, max>, int> $indices
-     * @return void
-     */
-    private function removeElementByIndex(array &$row, array $indices): void
-    {
-        foreach ($indices as $index) {
-            if (isset($row[$index])) {
-                unset($row[$index]);
-            }
-        }
-
-        $row = array_values($row);
-    }
-
     /**
      * @param array<string> $row
      * @param string $keyword

src/JsonFileHandler.php

@@ -4,24 +4,43 @@
 
 use Generator;
 use rcsofttech85\FileHandler\Exception\FileHandlerException;
+use rcsofttech85\FileHandler\Utilities\RowColumnHelper;
 
 readonly class JsonFileHandler
 {
+    use RowColumnHelper;
+
     /**
-     * @return array<int,array<string,string>>
+     * @param string $filename
+     * @param array<string> $headers
+     * @param array<string>|false $hideColumns
+     * @param int|false $limit
+     * @return array<string,string>
      * @throws FileHandlerException
      */
-    public function toArray(string $filename): array
-    {
-        return iterator_to_array($this->getRows($filename));
+    public function toArray(
+        string $filename,
+        array &$headers = [],
+        array|false $hideColumns = false,
+        int|false $limit = false
+    ): array {
+        return iterator_to_array($this->getRows($filename, $headers, $hideColumns, $limit));
     }
 
     /**
+     * @param string $filename
+     * @param array<string> $headers
+     * @param array<string>|false $hideColumns
+     * @param int|false $limit
      * @return Generator
      * @throws FileHandlerException
      */
-    private function getRows(string $filename): Generator
-    {
+    private function getRows(
+        string $filename,
+        array &$headers,
+        array|false $hideColumns = false,
+        int|false $limit = false
+    ): Generator {
         if (!file_exists($filename)) {
             throw new FileHandlerException('file not found');
         }
@@ -36,8 +55,20 @@ private function getRows(string $filename): Generator
             throw new FileHandlerException(json_last_error_msg());
         }
 
+        $count = 0;
+        $headers = array_keys(reset($contents));
+        $indices = is_array($hideColumns) ? $this->setColumnsToHide($headers, $hideColumns) : [];
         foreach ($contents as $content) {
+            if (!empty($indices)) {
+                $content = array_values($content);
+                $this->removeElementByIndex($content, $indices);
+            }
             yield $content;
+            $count++;
+
+            if (is_int($limit) && $limit <= $count) {
+                break;
+            }
         }
     }
 }

src/Utilities/RowColumnHelper.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace rcsofttech85\FileHandler\Utilities;
+
+trait RowColumnHelper
+{
+    /**
+     * @param array<string> $headers
+     * @param array<string> $hideColumns
+     * @return array<int<0, max>,int>
+     */
+    private function setColumnsToHide(array &$headers, array $hideColumns): array
+    {
+        $indices = [];
+        if (!empty($hideColumns)) {
+            foreach ($hideColumns as $hideColumn) {
+                $index = array_search($hideColumn, $headers);
+                if ($index !== false) {
+                    $indices[] = (int)$index;
+                    unset($headers[$index]);
+                }
+            }
+            $headers = array_values($headers);
+        }
+        return $indices;
+    }
+
+    /**
+     * @param array<int,string> $row
+     * @param array<int<0, max>, int> $indices
+     * @return void
+     */
+    private function removeElementByIndex(array &$row, array $indices): void
+    {
+        foreach ($indices as $index) {
+            if (isset($row[$index])) {
+                unset($row[$index]);
+            }
+        }
+
+        $row = array_values($row);
+    }
+}

tests/unit/JsonFileHandlerTest.php

@@ -50,6 +50,7 @@ public static function bookListProvider(): iterable
     {
         yield
         [
+
             [
                 [
                     'title' => 'The Catcher in the Rye',