Release - 0.4.0

app/assets/stylesheets/application.scss

@@ -14,5 +14,7 @@
 // Layouts
 
 // Components
+@import './components/search_stat_details';
+@import './components/raw-response-modal';
 
 // Screens

app/assets/stylesheets/components/_raw-response-modal.scss

@@ -0,0 +1,8 @@
+.raw-response-modal {
+  iframe {
+    width: 100%;
+    height: 80vh;
+
+    border: 0;
+  }
+}

app/assets/stylesheets/components/search_stat_details.scss

@@ -0,0 +1,5 @@
+.search-stat-detail {
+  &__title::after {
+    content: ':';
+  }
+}

app/controllers/search_stats_controller.rb

@@ -3,6 +3,10 @@
 class SearchStatsController < ApplicationController
   # GET /search_stats
   def index
-    @pagy, @search_stats = pagy(SearchStat.all)
+    @pagy, @search_stats = pagy(current_user.search_stats)
+  end
+
+  def show
+    @search_stat = current_user.search_stats.includes(:result_links).find(params[:id])
   end
 end

app/models/result_link.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class ResultLink < ApplicationRecord
+  enum link_type: { ads_top: 'ads_top', non_ads: 'non_ads' }
+
+  belongs_to :search_stat, inverse_of: :result_links
+
+  validates :url, presence: true
+end

app/models/search_stat.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 class SearchStat < ApplicationRecord
-  validates :keyword, presence: true
+  has_many :result_links, inverse_of: :search_stat, dependent: :destroy
+  belongs_to :user, inverse_of: :search_stats
+
+  validates :keyword, presence: true, length: { maximum: 255 }
   validates :raw_response, presence: true
 
   enum status: { initialized: 0, running: 1, completed: 2, failed: 3 }

app/models/user.rb

@@ -4,6 +4,8 @@ class User < ApplicationRecord
   include Authenticable
   PASSWORD_PATTERN = /(?=.*[A-Z])(?=.*[a-z])(?=.*\d).{8,}/
 
+  has_many :search_stats, inverse_of: :user, dependent: :destroy
+
   before_validation :password_complexity, on: :create
 
   private

app/views/search_stats/_raw_response_modal.html.erb

@@ -0,0 +1,14 @@
+<div id="rawResponseModal" class="modal fade raw-response-modal" tabindex="-1" aria-labelledby="rawResponseModalLabel" aria-hidden="true">
+  <div class="modal-dialog modal-xl">
+    <div class="modal-content">
+      <div class="modal-header">
+        <h5 class="modal-title" id="rawResponseModalLabel">Raw Response</h5>
+        <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+      </div>
+      <div class="modal-body">
+        <iframe srcdoc="<%= sanitize(@search_stat.raw_response) %>" >
+        </iframe>
+      </div>
+    </div>
+  </div>
+</div>

app/views/search_stats/_search_stat.html.erb

@@ -1,31 +1,9 @@
-<div id="<%= dom_id search_stat %>">
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:keyword) %>:</strong>
-    <%= search_stat.keyword %>
-  </p>
-
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:ad_count) %>:</strong>
-    <%= search_stat.ad_count %>
-  </p>
-
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:link_count) %>:</strong>
-    <%= search_stat.link_count %>
-  </p>
-
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:total_result_count) %>:</strong>
-    <%= search_stat.total_result_count %>
-  </p>
-
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:raw_response) %>:</strong>
-    <%= search_stat.raw_response %>
-  </p>
-
-  <p>
-    <strong><%= SearchStat.human_attribute_name(:user_id) %>:</strong>
-    <%= search_stat.user_id %>
-  </p>
-</div>
+<tr id="<%= dom_id search_stat %>">
+  <td><%= search_stat.keyword %></td>
+  <td><%= search_stat.ad_count %></td>
+  <td><%= search_stat.link_count %></td>
+  <td><%= search_stat.total_result_count %></td>
+  <td>
+    <%= link_to t('links.search_stat_details'), search_stat_path(search_stat), class: 'btn btn-primary' %>
+  </td>
+</tr>

app/views/search_stats/index.html.erb

@@ -1,7 +1,28 @@
-<h1><%= SearchStat.model_name.human %></h1>
+<div class="container mt-4">
+  <h4><%= SearchStat.model_name.human  %></h4>
 
-<div id="search_stats">
-  <%= render @search_stats %>
-</div>
+  <% if @search_stats.any? %>
+    <div id="search_stats" class="table-responsive">
+      <table class="table table-bordered table-striped">
+        <thead class="thead-light">
+          <tr>
+            <th><%= SearchStat.human_attribute_name(:keyword) %></th>
+            <th><%= SearchStat.human_attribute_name(:ad_count) %></th>
+            <th><%= SearchStat.human_attribute_name(:link_count) %></th>
+            <th><%= SearchStat.human_attribute_name(:total_result_count) %></th>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          <%= render @search_stats %>
+        </tbody>
+      </table>
+    </div>
 
-<%== pagy_nav(@pagy) if @pagy.pages > 1 %>
+    <%== pagy_bootstrap_nav(@pagy) %>
+  <% else %>
+    <div class="alert alert-info mt-3">
+      <p class="mb-0"><%= t('titles.no_stats')%></p>
+    </div>
+  <% end %>
+</div>

app/views/search_stats/show.html.erb

@@ -0,0 +1,86 @@
+<div class="container mt-4">
+  <div class="d-flex flex-wrap align-items-center">
+    <div class="mr-auto mb-2">
+      <%= link_to search_stats_path, class: "btn btn-primary m-1" do %>
+        <%= t('buttons.back') %>
+      <% end %>
+    </div>
+  </div>
+
+  <div class="card mt-4 search-stat-detail">
+    <div class="card-body">
+      <h5 class="card-title border-bottom pb-3 mb-4"><%= SearchStat.model_name.human %></h5>
+      <div class="row">
+        <div class="col-md-4">
+          <p class="card-text small">
+            <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:keyword) %></strong>
+            <%= @search_stat.keyword %>
+          </p>
+
+          <p class="card-text small">
+          <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:ad_count_top) %></strong>
+            <%= @search_stat.top_ad_count %>
+          </p>
+
+          <p class="card-text small">
+            <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:ad_count) %></strong>
+            <%= @search_stat.ad_count %>
+          </p>
+        </div>
+        <div class="col-md-4">
+          <p class="card-text small">
+            <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:non_ad_count) %></strong>
+            <%= @search_stat.non_ad_count %>
+          </p>
+
+          <p class="card-text small">
+            <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:link_count) %></strong>
+            <%= @search_stat.link_count %>
+          </p>
+
+          <p class="card-text small">
+            <strong class="search-stat-detail__title"><%= SearchStat.human_attribute_name(:total_result_count) %></strong>
+            <%= @search_stat.total_result_count %>
+          </p>
+        </div>
+        <div class="col-md-4">
+          <button type="button" class="btn btn-primary" data-bs-toggle="modal" data-bs-target="#rawResponseModal">
+            <%= t('buttons.raw_response') %>
+          </button>
+          <p class="card-text small">
+            <strong><%=  SearchStat.human_attribute_name(:total_result_count) %>:</strong>
+            <%= @search_stat.user_id %>
+          </p>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <div class="card mt-4">
+    <div class="card-body">
+      <h5 class="card-title"><%=t('titles.top_ads')%></h5>
+      <ul class="list-group">
+        <% @search_stat.result_links.ads_top.each do |result_link| %>
+          <li class="list-group-item">
+            <%= link_to result_link.url, result_link.url %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+
+  <div class="card mt-4">
+    <div class="card-body">
+      <h5 class="card-title"><%=t('titles.non_ads')%></h5>
+      <ul class="list-group">
+        <% @search_stat.result_links.non_ads.each do |result_link| %>
+          <li class="list-group-item">
+            <%= link_to result_link.url, result_link.url, target: '_blank' %>
+          </li>
+        <% end %>
+      </ul>
+    </div>
+  </div>
+
+  <%= render 'raw_response_modal' %>
+</div>

config/initializers/pagy.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'pagy/extras/bootstrap'
+require 'pagy/extras/overflow'
+
+# Override default options
+Pagy::DEFAULT[:items] = 5
+Pagy::DEFAULT[:size] = [1, 2, 2, 1]
+Pagy::DEFAULT[:overflow] = :last_page

config/locales/en.yml

@@ -37,8 +37,19 @@ en:
   attributes:
     search_stat:
       ad_count: Ad count
+      ad_count_top: Ad count top
       keyword: Keyword
       link_count: Link count
+      non_ad_count: Non ad count
       raw_response: Raw response
       total_result_count: Total result count
       user_id: User
+  buttons:
+    back: Back
+    raw_response: View Raw Response
+  links: 
+    search_stat_details: Show Details
+  titles:
+    no_stats: No search stats found
+    non_ads: List of URLs of Non-AdWords Results on the Page
+    top_ads: List of URLs of AdWords Advertisers in Top Position

config/routes.rb

@@ -8,5 +8,5 @@
   root "home#index"
 
   get "/health_check", to: 'health_check#health_check', as: :rails_health_check
-  resources :search_stats, only: [:index]
+  resources :search_stats, only: [:index, :show]
 end

db/migrate/20230601085414_create_result_links.rb

@@ -0,0 +1,13 @@
+class CreateResultLinks < ActiveRecord::Migration[7.0]
+  def change
+    enable_extension 'citext' unless extension_enabled?('citext')
+
+    create_table :result_links do |t|
+      t.references :search_stat, null: false, foreign_key: true
+      t.integer :link_type, null: false
+      t.citext :url, null: false
+
+      t.timestamps
+    end
+  end
+end

db/migrate/20230608032015_change_url_type_in_result_links.rb

@@ -0,0 +1,9 @@
+class ChangeUrlTypeInResultLinks < ActiveRecord::Migration[7.0]
+  def change
+    remove_index :result_links, :url
+
+    change_column :result_links, :url, :string, null: false
+
+    add_index :result_links, :url
+  end
+end

db/migrate/20230612121926_change_link_type_to_string_in_result_links.rb

@@ -0,0 +1,5 @@
+class ChangeLinkTypeToStringInResultLinks < ActiveRecord::Migration[7.0]
+  def change
+    change_column :result_links, :link_type, :string
+  end
+end

db/seeds.rb

@@ -9,6 +9,11 @@
 require 'fabrication'
 
 # Generate dummy data for SearchStat
-100.times do
-  Fabricate(:search_stat)
+
+user = User.find_or_initialize_by(email: 'user@demo.com') do |user|
+  user.password = 'aaaaaaA1'
+end
+
+10.times do
+  Fabricate.times(100, :search_stat, user: user)
 end

spec/fabricators/result_link_fabricator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Fabricator(:result_link) do
+  link_type { ResultLink.link_types.keys.sample }
+  url { FFaker::Internet.http_url }
+end
+
+Fabricator(:result_link_with_search_stat, from: :result_link) do
+  search_stat { Fabricate(:search_stat) }
+end