refactor: updated readme, added highlighted search results

Author: Toby Carvan

README.md

@@ -7,9 +7,12 @@ A Ruby command-line application for searching and analyzing client data from JSO
 ## Features
 
 - **Name Search**: Search through all clients and return those with names matching a given query (case-insensitive, supports regex patterns)
+  - TTY output includes **syntax highlighting** to visually highlight matched text
 - **Duplicate Email Detection**: Find clients with duplicate email addresses in the dataset
+- **Rating Filter**: Filter clients by minimum rating threshold
 - **Dataset Generation**: Generate realistic test datasets with customizable size and guaranteed duplicates
 - **Multiple Output Formats**: Support for TTY, CSV, JSON, XML, and YAML output formats
+  - All formats support optional `result` fields (rating and feedback comments)
 - **Flexible Dataset Support**: Specify custom dataset files via command-line options
 - **Robust Error Handling**: Validates file existence and JSON format before processing
 - **Graceful Data Handling**: Safely processes datasets with missing or invalid fields
@@ -55,6 +58,7 @@ challenge duplicates -f data.json
 | `generate` | `g` | Generate test dataset | `challenge generate -f data.json --size 1000` |
 | `search` | `s` | Find clients by name, using regex | `challenge search "John" -f data.json` |
 | `duplicates` | `d` | Find duplicate emails | `challenge duplicates -f data.json` |
+| `filter_by_rating` | - | Filter clients by minimum rating | `challenge filter_by_rating 4.0 -f data.json` |
 | `version` | - | Show version number | `challenge version` |
 
 ### Output Formats
@@ -76,6 +80,10 @@ challenge search "^John" -f data.json          # Names starting with "John"
 challenge search "Miller$" -f data.json        # Names ending with "Miller"
 challenge search "J.*n" -f data.json           # Names starting with J and ending with n
 
+# Filter by rating
+challenge filter_by_rating 3.5 -f data.json    # Clients with rating >= 3.5
+challenge filter_by_rating 4.0 -f data.json --output json
+
 # Short aliases
 challenge s "John" -f data.json                # search
 challenge d -f data.json                       # duplicates
@@ -101,22 +109,45 @@ The application expects JSON files containing an array of client objects with th
   {
     "id": 1,
     "full_name": "John Doe",
-    "email": "john.doe@gmail.com"
+    "email": "john.doe@gmail.com",
+    "result": {
+      "rating": 4.5,
+      "feedback": [
+        {
+          "comment": "Great job on the project!",
+          "date": "2023-10-01"
+        },
+        {
+          "comment": "Excellent communication skills.",
+          "date": "2023-10-15"
+        }
+      ]
+    }
   },
   {
     "id": 2,
     "full_name": "Jane Smith",
-    "email": "jane.smith@yahoo.com"
+    "email": "jane.smith@yahoo.com",
+    "result": {
+      "rating": 3.8,
+      "feedback": []
+    }
   }
 ]
 ```
 
-Required fields:
+**Required fields:**
 
 - `id`: Unique identifier
 - `full_name`: Client's full name
 - `email`: Client's email address
 
+**Optional fields:**
+
+- `result`: Object containing performance data (used by `filter_by_rating` command)
+  - `rating`: Numeric rating value
+  - `feedback`: Array of feedback objects with `comment` and `date` fields (date is optional)
+
 ## Testing
 
 Run the test suite using RSpec:
@@ -249,7 +280,7 @@ Given more time, the following enhancements would be prioritized:
 - **Interactive Mode**: REPL-style interface for multiple queries
 - **Search Suggestions**: Auto-complete and suggestion features
 - **Progress Indicators**: Progress bars for long-running operations
-- **Colored Output**: Syntax highlighting and colored output for better readability
+- ✅ **Colored Output**: Syntax highlighting for search results in TTY format (implemented)
 
 ## Development
 

lib/challenge/formatters/csv_formatter.rb

@@ -10,8 +10,8 @@ def format_search_results(results, query)
         if results.empty?
           "# No clients found matching '#{query}'"
         else
-          lines = ["# Found #{results.size} client(s) matching '#{query}':", csv_header]
-          results.each { |client| lines << format_client_csv(client) }
+          lines = ["# Found #{results.size} client(s) matching '#{query}':", extended_csv_header]
+          results.each { |client| lines << format_extended_client_csv(client) }
           lines.join("\n")
         end
       end
@@ -20,8 +20,8 @@ def format_duplicate_results(duplicates)
         if duplicates.empty?
           '# No duplicate emails found'
         else
-          lines = ['# Found duplicate emails:', csv_header]
-          duplicates.each { |client| lines << format_client_csv(client) }
+          lines = ['# Found duplicate emails:', extended_csv_header]
+          duplicates.each { |client| lines << format_extended_client_csv(client) }
           lines.join("\n")
         end
       end
@@ -54,15 +54,17 @@ def format_client_csv(client)
         CSV.generate_line([client['id'], client['full_name'], client['email']]).strip
       end
 
-      def filtered_csv_header
+      def extended_csv_header
         'id,full_name,email,rating,feedback_comments'
       end
+      alias filtered_csv_header extended_csv_header
 
-      def format_filtered_client_csv(client)
+      def format_extended_client_csv(client)
         rating = client.dig('result', 'rating')
         feedback = feedback_comments(client).join(' | ')
         CSV.generate_line([client['id'], client['full_name'], client['email'], rating, feedback]).strip
       end
+      alias format_filtered_client_csv format_extended_client_csv
 
       def feedback_comments(client)
         Array(client.dig('result', 'feedback')).filter_map do |entry|

lib/challenge/formatters/json_formatter.rb

@@ -10,7 +10,7 @@ def format_search_results(results, query)
         {
           query: query,
           count: results.size,
-          clients: results
+          clients: results.map { |client| serialize_client(client) }
         }.to_json
       end
 
@@ -21,7 +21,7 @@ def format_duplicate_results(duplicates)
           email_groups = duplicates.group_by { |client| client['email'] }
           {
             duplicates: email_groups.map do |email, clients|
-              { email: email, clients: clients }
+              { email: email, clients: clients.map { |client| serialize_client(client) } }
             end,
             count: duplicates.size
           }.to_json
@@ -53,18 +53,27 @@ def format_version(version)
 
       private
 
-      def serialize_filtered_client(client)
-        {
+      def serialize_client(client)
+        result = {
           id: client['id'],
           full_name: client['full_name'],
-          email: client['email'],
-          result: {
+          email: client['email']
+        }
+
+        if client['result']
+          result[:result] = {
             rating: client.dig('result', 'rating'),
             feedback: Array(client.dig('result', 'feedback')).map do |entry|
               entry.is_a?(Hash) ? entry['comment'] : entry
             end.compact
           }
-        }
+        end
+
+        result
+      end
+
+      def serialize_filtered_client(client)
+        serialize_client(client)
       end
     end
   end

lib/challenge/formatters/tty_formatter.rb

@@ -10,7 +10,8 @@ def format_search_results(results, query)
         else
           lines = ["Found #{results.size} client(s) matching '#{query}':"]
           results.each do |client|
-            lines << "- #{format_client(client)}"
+            lines << "- #{format_client(client, query)}"
+            lines.concat(format_client_details(client))
           end
           lines.join("\n")
         end
@@ -26,6 +27,7 @@ def format_duplicate_results(duplicates)
             lines << "\n#{email}:"
             clients.each do |client|
               lines << "  - #{format_client(client)}"
+              format_client_details(client).each { |detail| lines << "    #{detail}" }
             end
           end
           lines.join("\n")
@@ -61,8 +63,32 @@ def format_version(version)
 
       private
 
-      def format_client(client)
-        "#{client['full_name']} <#{client['email']}> \e[90m##{client['id']}\e[0m"
+      def format_client(client, highlight = nil)
+        name = highlight ? highlight_match(client['full_name'], highlight) : client['full_name']
+        email = client['email']
+
+        "#{name} <#{email}> \e[90m##{client['id']}\e[0m"
+      end
+
+      def highlight_match(text, pattern)
+        return text unless pattern
+
+        text.gsub(Regexp.new(pattern, Regexp::IGNORECASE)) do |match|
+          "\e[1;33m#{match}\e[0m"
+        end
+      rescue RegexpError
+        text
+      end
+
+      def format_client_details(client)
+        details = []
+        rating = client.dig('result', 'rating')
+        details << "  Rating: #{rating}" if rating
+
+        feedback_comments = extract_feedback_comments(client)
+        details << "  Feedback: #{feedback_comments.map { |c| "\"#{c}\"" }.join(', ')}" if feedback_comments.any?
+
+        details
       end
 
       def extract_feedback_comments(client)

lib/challenge/formatters/xml_formatter.rb

@@ -7,7 +7,7 @@ class XMLFormatter
       def format_search_results(results, query)
         lines = ['<?xml version="1.0" encoding="UTF-8"?>']
         lines << "<search_results query=\"#{escape_xml(query)}\" count=\"#{results.size}\">"
-        results.each { |client| lines << format_client_xml(client, '  ') }
+        results.each { |client| lines << format_filtered_client_xml(client, '  ') }
         lines << '</search_results>'
         lines.join("\n")
       end
@@ -21,7 +21,7 @@ def format_duplicate_results(duplicates)
           lines << "<duplicate_results count=\"#{duplicates.size}\">"
           email_groups.each do |email, clients|
             lines << "  <duplicate_group email=\"#{escape_xml(email)}\">"
-            clients.each { |client| lines << format_client_xml(client, '    ') }
+            clients.each { |client| lines << format_filtered_client_xml(client, '    ') }
             lines << '  </duplicate_group>'
           end
           lines << '</duplicate_results>'

lib/challenge/formatters/yaml_formatter.rb

@@ -10,7 +10,7 @@ def format_search_results(results, query)
         {
           'query' => query,
           'count' => results.size,
-          'clients' => results
+          'clients' => results.map { |client| serialize_client(client) }
         }.to_yaml
       end
 
@@ -21,7 +21,7 @@ def format_duplicate_results(duplicates)
           email_groups = duplicates.group_by { |client| client['email'] }
           {
             'duplicates' => email_groups.map do |email, clients|
-              { 'email' => email, 'clients' => clients }
+              { 'email' => email, 'clients' => clients.map { |client| serialize_client(client) } }
             end,
             'count' => duplicates.size
           }.to_yaml
@@ -53,18 +53,27 @@ def format_version(version)
 
       private
 
-      def serialize_filtered_client(client)
-        {
+      def serialize_client(client)
+        result = {
           'id' => client['id'],
           'full_name' => client['full_name'],
-          'email' => client['email'],
-          'result' => {
+          'email' => client['email']
+        }
+
+        if client['result']
+          result['result'] = {
             'rating' => client.dig('result', 'rating'),
             'feedback' => Array(client.dig('result', 'feedback')).filter_map do |entry|
               entry.is_a?(Hash) ? entry['comment'] : entry
             end
           }
-        }
+        end
+
+        result
+      end
+
+      def serialize_filtered_client(client)
+        serialize_client(client)
       end
     end
   end

lib/challenge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Challenge
-  VERSION = '1.4'
+  VERSION = '1.4.1'
 end