Merge pull request #272 from joyofrails/chore/erb-lint

rossta · web-flow · commit cfba2564c9db · 2024-11-08T17:40:09.000-05:00
Adds Rubocop checks to ERB lint
diff --git a/.erb_lint.yml b/.erb_lint.yml
@@ -1,20 +1,27 @@
 ---
 EnableDefaultLinters: true
-
+glob: "**/*.{html}{+*,}.erb"
 exclude:
-  - '**/vendor/**/*'
-  - '**/node_modules/**/*'
+  - vendor/bundle/**/*
+  - node_modules/**/*
+  - tmp/**/*
+  - log/**/*
 
 linters:
-  AllowedScriptType:
+  ErbSafety:
+    enabled: true
+  PartialInstanceVariable:
+    enabled: true
+
+  Rubocop:
     enabled: true
-    allowed_types:
-      - 'application/json'
-      - 'application/ld+json'
-      - 'module'
-      - 'text/html'
-      - 'text/javascript'
-      - 'text/ruby'
-      - 'text/template'
-    allow_blank: false
-    disallow_inline_scripts: false
+    rubocop_config:
+      require: standard
+      inherit_gem:
+        standard: config/base.yml
+      Layout/InitialIndentation:
+        Enabled: false
+      Layout/TrailingEmptyLines:
+        Enabled: false
+      Lint/UselessAssignment:
+        Enabled: false
diff --git a/app/content/layouts/article.html.erb b/app/content/layouts/article.html.erb
@@ -1,25 +1,25 @@
 <% set_meta_tags(
-  title: current_page.data.title!,
-  description: current_page.data.description,
-  keywords: %w[rails hotwire],
-  og: {
-    type: "article",
-    url: current_page.url,
-    image: current_page.data.meta_image && asset_url(current_page.data.meta_image)
-  },
-  twitter: {
-    card: "summary"
-  }
-) %>
+     title: current_page.data.title!,
+     description: current_page.data.description,
+     keywords: %w[rails hotwire],
+     og: {
+       type: "article",
+       url: current_page.url,
+       image: current_page.data.meta_image && asset_url(current_page.data.meta_image)
+     },
+     twitter: {
+       card: "summary"
+     }
+   ) %>
 <%= render "application/skip_to_content" %>
 <%= render_layout "application" do %>
   <article itemscope itemtype="http://schema.org/Article">
     <%= render Pages::Header.new(
-      title: current_page.data.title!,
-      description: current_page.data.description,
-      published_on: current_page.data.published&.to_date,
-      updated_on: current_page.data.updated&.to_date
-    ) %>
+          title: current_page.data.title!,
+          description: current_page.data.description,
+          published_on: current_page.data.published&.to_date,
+          updated_on: current_page.data.updated&.to_date
+        ) %>
     <%- if current_page.data.toc -%>
       <aside>
         <h2 class="font-semibold mb-4 text-sm leading-6 uppercase tracking-widest">Table of Contents</h2>
diff --git a/app/content/pages/articles.html.erb b/app/content/pages/articles.html.erb
@@ -5,9 +5,9 @@ description: Read the latest articles from Joy of Rails
 
 <section style="min-height: 51vh">
   <%= render Pages::Header.new(
-    title: "Articles",
-    description: "Read the latest articles from Joy of Rails"
-  ) %>
+        title: "Articles",
+        description: "Read the latest articles from Joy of Rails"
+      ) %>
   <div class="main-content container py-gap">
     <%= render Pages::List.new(SitepressArticle.published(params)) %>
   </div>
diff --git a/app/controllers/admin/home_controller.rb b/app/controllers/admin/home_controller.rb
@@ -1,4 +1,11 @@
 class Admin::HomeController < Admin::BaseController
   def index
+    @nav = {
+      "Rails Admin" => "/admin/data",
+      "Newsletters" => admin_newsletters_path,
+      "Flipper" => "/admin/flipper",
+      "Mission Control Jobs" => "/admin/jobs",
+      "Litestream" => "/admin/litestream"
+    }
   end
 end
diff --git a/app/views/admin/home/index.html.erb b/app/views/admin/home/index.html.erb
@@ -1,17 +1,8 @@
-<%
-nav = {
-  "Rails Admin" => "/admin/data",
-  "Newsletters" => admin_newsletters_path,
-  "Flipper" => "/admin/flipper",
-  "Mission Control Jobs" => "/admin/jobs",
-  "Litestream" => "/admin/litestream",
-}
-%>
 <article>
   <%= render Pages::Header.new(title: "Admin") %>
   <div class="section-content container py-gap mb-3xl">
     <ul>
-      <% nav.each do |label, url| %>
+      <% @nav.each do |label, url| %>
       <li>
         <p class="font-semibold leading-6">
           <%= link_to url do %>
diff --git a/app/views/admin/newsletters/_form.html.erb b/app/views/admin/newsletters/_form.html.erb
@@ -24,10 +24,10 @@
   <fieldset>
     <%= form.submit class: "button primary" %>
     <%= form.submit "Preview", class: "button secondary",
-      formaction: (newsletter.persisted? ? edit_admin_newsletter_path(newsletter) : new_admin_newsletter_path),
-      formmethod: "get",
-      formnovalidate: true,
-      data: { turbo_frame: dom_id(newsletter, :markdown) } %>
+          formaction: (newsletter.persisted? ? edit_admin_newsletter_path(newsletter) : new_admin_newsletter_path),
+          formmethod: "get",
+          formnovalidate: true,
+          data: {turbo_frame: dom_id(newsletter, :markdown)} %>
   </fieldset>
 
   <%= turbo_frame_tag dom_id(newsletter, :markdown) do %>
diff --git a/app/views/admin/newsletters/_newsletter.html.erb b/app/views/admin/newsletters/_newsletter.html.erb
@@ -1,3 +1,3 @@
 <div id="<%= dom_id(newsletter, :markdown) %>" class="article-content joy-border-subtle p-4 mx--4">
-  <%= basic_markdown (newsletter&.content || "").html_safe %>
+  <%= basic_markdown(newsletter&.content || "") %>
 </div>
diff --git a/app/views/admin_users/sessions/new.html.erb b/app/views/admin_users/sessions/new.html.erb
@@ -16,7 +16,7 @@
 
         <div>
           <div class="flex items-center justify-between">
-            <%= form.label :password, class:"block text-sm font-medium leading-6" %>
+            <%= form.label :password, class: "block text-sm font-medium leading-6" %>
             <!-- <div class="text-sm">
               <a href="#" class="font-semibold">Forgot password?</a>
             </div> -->
diff --git a/app/views/application/theme/_code.html.erb b/app/views/application/theme/_code.html.erb
@@ -1,5 +1,5 @@
 <% if custom_syntax_highlight? %>
-  <%= stylesheet_link_tag find_syntax_highlight.asset_path, media: "all", data: { turbo_track: "reload", syntax_highlight: find_syntax_highlight.name } %>
+  <%= stylesheet_link_tag find_syntax_highlight.asset_path, media: "all", data: {turbo_track: "reload", syntax_highlight: find_syntax_highlight.name} %>
 <% else %>
-  <%= stylesheet_link_tag Settings::SyntaxHighlight.default.asset_path, media: "all", data: { turbo_track: "reload", syntax_highlight: find_syntax_highlight.name } %>
+  <%= stylesheet_link_tag Settings::SyntaxHighlight.default.asset_path, media: "all", data: {turbo_track: "reload", syntax_highlight: find_syntax_highlight.name} %>
 <% end %>
diff --git a/app/views/emails/newsletter_mailer/newsletter.html.erb b/app/views/emails/newsletter_mailer/newsletter.html.erb
@@ -1,4 +1,4 @@
-<%= render Markdown::Base.new(@newsletter.content.html_safe) %>
+<%= render Markdown::Base.new(@newsletter.content) %>
 
 --Ross
 
diff --git a/app/views/examples/counters/_counter.html.erb b/app/views/examples/counters/_counter.html.erb
@@ -3,21 +3,21 @@
   <p class="mt-2 flex font-sans items-baseline gap-x-2">
     <span class="text-4xl font-semibold tracking-tight text-white"><%= counter.count %></span>
   </p>
-  <%= tag.div data: { controller: "analytics", analytics_event_value: "Examples Counter Click" }, class: "flex items-center gap-x-3 mt-3" do %>
+  <%= tag.div data: {controller: "analytics", analytics_event_value: "Examples Counter Click"}, class: "flex items-center gap-x-3 mt-3" do %>
     <%= button_to "Increment",
-      examples_counters_path(counter: { count: counter.count + 1 }),
-      method: :put,
-      class: "button primary",
-      form: { data: { action: "submit->analytics#send" } } %>
+          examples_counters_path(counter: {count: counter.count + 1}),
+          method: :put,
+          class: "button primary",
+          form: {data: {action: "submit->analytics#send"}} %>
     <%= button_to "Decrement",
-      examples_counters_path(counter: { count: counter.count - 1 }),
-      method: :put,
-      class: "button warn",
-      form: { data: { action: "submit->analytics#send" } } %>
+          examples_counters_path(counter: {count: counter.count - 1}),
+          method: :put,
+          class: "button warn",
+          form: {data: {action: "submit->analytics#send"}} %>
     <%= button_to "Reset",
-      examples_counters_path,
-      method: :delete,
-      class: "button secondary",
-      form: { data: { action: "submit->analytics#send" } } %>
+          examples_counters_path,
+          method: :delete,
+          class: "button secondary",
+          form: {data: {action: "submit->analytics#send"}} %>
   <% end %>
 </div>
diff --git a/app/views/newsletters/_newsletter.html.erb b/app/views/newsletters/_newsletter.html.erb
@@ -1,3 +1,3 @@
 <div id="<%= dom_id newsletter %>" class="article-content">
-  <%= basic_markdown (newsletter&.content || "").html_safe %>
+  <%= basic_markdown(newsletter&.content || "") %>
 </div>
diff --git a/app/views/pwa/installation_instructions/_installation_instructions.html.erb b/app/views/pwa/installation_instructions/_installation_instructions.html.erb
@@ -1,13 +1,14 @@
+<%# locals: (installation_instructions:) %>
 <div class="section-content">
   <h3 class="font-semibold mb-2" style="margin-top: 0;">
     How to Install a Progressive Web App from <%= installation_instructions.browser_name&.titleize %> for <%= installation_instructions.os_name %>
   </h3>
   <%= begin
-    render @installation_instructions.partial_name, installation_instructions: installation_instructions
-  rescue ArgumentError
-    Honeybadger.notify("Unsupported PWA installation instructions for #{installation_instructions.os_name} on #{installation_instructions.browser_name}")
-    render "unsupported", installation_instructions: installation_instructions
-  end %>
+        render installation_instructions.partial_name, installation_instructions:
+      rescue ArgumentError
+        Honeybadger.notify("Unsupported PWA installation instructions for #{installation_instructions.os_name} on #{installation_instructions.browser_name}")
+        render "unsupported", installation_instructions:
+      end %>
 
   <p>
     <strong>Make a selection to view installation instructions for a different browser:</strong>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ios_chrome.html.erb b/app/views/pwa/installation_instructions/user_agents/_ios_chrome.html.erb
@@ -1,4 +1,5 @@
-<p>To add this web app to your home screen on <%= @installation_instructions.os_name %>:</p>
+<%# locals: (installation_instructions:) %>
+<p>To add this web app to your home screen on <%= installation_instructions.os_name %>:</p>
 
 <ol>
   <li>Tap the <strong>Share</strong> button at the bottom of the screen.</li>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ios_edge.html.erb b/app/views/pwa/installation_instructions/user_agents/_ios_edge.html.erb
@@ -1,4 +1,5 @@
-<p>To add this web app to your home screen from Microsoft Edge on <%= @installation_instructions.os_name %>:</p>
+<%# locals: (installation_instructions:) %>
+<p>To add this web app to your home screen from Microsoft Edge on <%= installation_instructions.os_name %>:</p>
 <ol>
   <li>Tap the <strong>Share</strong> button at the bottom of the screen.</li>
   <li>Scroll down and tap <strong>Add to Home Screen</strong>.</li>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ios_firefox.html.erb b/app/views/pwa/installation_instructions/user_agents/_ios_firefox.html.erb
@@ -1,4 +1,4 @@
-<p>To add this web app to your home screen on <%= @installation_instructions.os_name %>:</p>
+<p>To add this web app to your home screen on <%= installation_instructions.os_name %>:</p>
 <ol>
   <li>Tap the <strong>Share</strong> button.</li>
   <li>Scroll down and tap on <strong>Add to Home Screen</strong>.</li>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ios_safari.html.erb b/app/views/pwa/installation_instructions/user_agents/_ios_safari.html.erb
@@ -1,4 +1,5 @@
-<p>To add this web app to your home screen on <%= @installation_instructions.os_name %>:</p>
+<%# locals: (installation_instructions:) %>
+<p>To add this web app to your home screen on <%= installation_instructions.os_name %>:</p>
 <ol>
   <li>Tap the <strong>Share</strong> button.</li>
   <li>Scroll down and tap <strong>Add to Home Screen</strong>.</li>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ipados_chrome.html.erb b/app/views/pwa/installation_instructions/user_agents/_ipados_chrome.html.erb
@@ -1 +1,2 @@
-<%= render "pwa/installation_instructions/user_agents/ios_chrome" %>
+<%# locals: (installation_instructions:) %>
+<%= render "pwa/installation_instructions/user_agents/ios_chrome", installation_instructions: %>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ipados_edge.html.erb b/app/views/pwa/installation_instructions/user_agents/_ipados_edge.html.erb
@@ -1 +1,2 @@
-<%= render "pwa/installation_instructions/user_agents/ios_edge" %>
+<%# locals: (installation_instructions:) %>
+<%= render "pwa/installation_instructions/user_agents/ios_edge", installation_instructions: %>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ipados_firefox.html.erb b/app/views/pwa/installation_instructions/user_agents/_ipados_firefox.html.erb
@@ -1 +1,2 @@
-<%= render "pwa/installation_instructions/user_agents/ios_firefox" %>
+<%# locals: (installation_instructions:) %>
+<%= render "pwa/installation_instructions/user_agents/ios_firefox", installation_instructions: %>
diff --git a/app/views/pwa/installation_instructions/user_agents/_ipados_safari.html.erb b/app/views/pwa/installation_instructions/user_agents/_ipados_safari.html.erb
@@ -1 +1,2 @@
-<%= render "pwa/installation_instructions/user_agents/ios_safari" %>
+<%# locals: (installation_instructions:) %>
+<%= render "pwa/installation_instructions/user_agents/ios_safari", installation_instructions: %>
diff --git a/app/views/share/snippets/index.html.erb b/app/views/share/snippets/index.html.erb
@@ -8,10 +8,10 @@
 
   <% @snippets.each do |snippet| %>
     <%= render Share::Snippets::Snippet.new(
-      snippet,
-      current_user: current_user,
-      href: share_snippet_path(snippet),
-      class: "mb-3xl"
-    ) %>
+          snippet,
+          current_user: current_user,
+          href: share_snippet_path(snippet),
+          class: "mb-3xl"
+        ) %>
   <% end %>
 </div>
diff --git a/app/views/share/snippets/show.html.erb b/app/views/share/snippets/show.html.erb
@@ -1,14 +1,14 @@
 <% set_meta_tags(
-  title: "Joy of Rails Snippet#{@snippet.title.presence && ": " + @snippet.title}",
-  description: "A code snippet from Joy of Rails",
-  keywords: [@snippet.language].compact,
-  og: {
-    image: @snippet.screenshot.attached? && rails_storage_proxy_url(@snippet.screenshot)
-  },
-  twitter: {
-    card: @snippet.screenshot.attached? ? "summary_large_image" : "summary",
-  }
-) %>
+     title: "Joy of Rails Snippet#{@snippet.title.presence && ": " + @snippet.title}",
+     description: "A code snippet from Joy of Rails",
+     keywords: [@snippet.language].compact,
+     og: {
+       image: @snippet.screenshot.attached? && rails_storage_proxy_url(@snippet.screenshot)
+     },
+     twitter: {
+       card: @snippet.screenshot.attached? ? "summary_large_image" : "summary"
+     }
+   ) %>
 
 <%= render Pages::Header.new(title: "Snippet Share") %>
 <div class="section-content container py-gap mb-3xl">
diff --git a/script/highlight/syntax_themes_pygments b/script/highlight/syntax_themes_pygments
@@ -3,7 +3,7 @@
 require "bundler/setup"
 require "httpx"
 require "nokogiri"
-require "debug"
+# require "debug"
 
 # Download the Pygments themes from the StylishThemes repository
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<%= render Markdown::Base.new(@newsletter.content.html_safe) %>`
	`1`	`+<%= render Markdown::Base.new(@newsletter.content) %>`
`2`	`2`
`3`	`3`	`--Ross`
`4`	`4`