Merge pull request #2827 from SamantazFox/more-code-cleanup

More code cleanup

Author: SamantazFox

scripts/git/pre-commit

@@ -15,9 +15,3 @@ if [ ! -z "$changed_cr_files" ]; then
 
   git add $changed_cr_files
 fi
-
-# Locale equalizer 
-if [ ! -z $(git diff --name-only --cached -- locales/) ]; then
-  crystal run scripts/propagate-new-locale-keys.cr
-  git add locales > /dev/null
-fi

scripts/propagate-new-locale-keys.cr

@@ -96,7 +96,7 @@ def get_about_info(ucid, locale) : AboutChannel
         total_views = channel_about_meta["viewCountText"]?.try &.["simpleText"]?.try &.as_s.gsub(/\D/, "").to_i64? || 0_i64
 
         # The joined text is split to several sub strings. The reduce joins those strings before parsing the date.
-        joined = channel_about_meta["joinedDateText"]?.try &.["runs"]?.try &.as_a.reduce("") { |acc, node| acc + node["text"].as_s }
+        joined = channel_about_meta["joinedDateText"]?.try &.["runs"]?.try &.as_a.reduce("") { |acc, nd| acc + nd["text"].as_s }
           .try { |text| Time.parse(text, "Joined %b %-d, %Y", Time::Location.local) } || Time.unix(0)
 
         # Normal Auto-generated channels
@@ -136,7 +136,8 @@ def fetch_related_channels(about_channel : AboutChannel) : Array(AboutRelatedCha
   channels = YoutubeAPI.browse(browse_id: about_channel.ucid, params: "EghjaGFubmVscw%3D%3D")
 
   tabs = channels.dig?("contents", "twoColumnBrowseResultsRenderer", "tabs").try(&.as_a?) || [] of JSON::Any
-  tab = tabs.find { |tab| tab.dig?("tabRenderer", "title").try(&.as_s?) == "Channels" }
+  tab = tabs.find(&.dig?("tabRenderer", "title").try(&.as_s?).try(&.== "Channels"))
+
   return [] of AboutRelatedChannel if tab.nil?
 
   items = tab.dig?("tabRenderer", "content", "sectionListRenderer", "contents", 0, "itemSectionRenderer", "contents", 0, "gridRenderer", "items").try(&.as_a?) || [] of JSON::Any

src/invidious/channels/about.cr

@@ -44,13 +44,9 @@ struct ChannelVideo
     end
   end
 
-  def to_json(locale, json : JSON::Builder | Nil = nil)
-    if json
+  def to_json(locale, _json : Nil = nil)
+    JSON.build do |json|
       to_json(locale, json)
-    else
-      JSON.build do |json|
-        to_json(locale, json)
-      end
     end
   end
 
@@ -88,13 +84,9 @@ struct ChannelVideo
     end
   end
 
-  def to_xml(locale, xml : XML::Builder | Nil = nil)
-    if xml
+  def to_xml(locale, _xml : Nil = nil)
+    XML.build do |xml|
       to_xml(locale, xml)
-    else
-      XML.build do |xml|
-        to_xml(locale, xml)
-      end
     end
   end
 

src/invidious/channels/channels.cr

@@ -93,10 +93,6 @@ def fetch_youtube_comments(id, cursor, format, locale, thin_mode, region, sort_b
     end
     contents = body["contents"]?
     header = body["header"]?
-    if body["continuations"]?
-      # Removable? Doesn't seem like this is used.
-      more_replies_continuation = body["continuations"][0]["nextContinuationData"]["continuation"].as_s
-    end
   else
     raise InfoException.new("Could not fetch comments")
   end

src/invidious/comments.cr

@@ -6,8 +6,12 @@
 class InfoException < Exception
 end
 
+# -------------------
+#  Issue template
+# -------------------
+
 macro error_template(*args)
-  error_template_helper(env, locale, {{*args}})
+  error_template_helper(env, {{*args}})
 end
 
 def github_details(summary : String, content : String)
@@ -22,11 +26,13 @@ def github_details(summary : String, content : String)
   return HTML.escape(details)
 end
 
-def error_template_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, exception : Exception)
+def error_template_helper(env : HTTP::Server::Context, status_code : Int32, exception : Exception)
   if exception.is_a?(InfoException)
-    return error_template_helper(env, locale, status_code, exception.message || "")
+    return error_template_helper(env, status_code, exception.message || "")
   end
 
+  locale = env.get("preferences").as(Preferences).locale
+
   env.response.content_type = "text/html"
   env.response.status_code = status_code
 
@@ -77,71 +83,101 @@ def error_template_helper(env : HTTP::Server::Context, locale : String?, status_
   return templated "error"
 end
 
-def error_template_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, message : String)
+def error_template_helper(env : HTTP::Server::Context, status_code : Int32, message : String)
   env.response.content_type = "text/html"
   env.response.status_code = status_code
+
+  locale = env.get("preferences").as(Preferences).locale
+
   error_message = translate(locale, message)
-  next_steps = error_redirect_helper(env, locale)
+  next_steps = error_redirect_helper(env)
+
   return templated "error"
 end
 
+# -------------------
+#  Atom feeds
+# -------------------
+
 macro error_atom(*args)
-  error_atom_helper(env, locale, {{*args}})
+  error_atom_helper(env, {{*args}})
 end
 
-def error_atom_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, exception : Exception)
+def error_atom_helper(env : HTTP::Server::Context, status_code : Int32, exception : Exception)
   if exception.is_a?(InfoException)
-    return error_atom_helper(env, locale, status_code, exception.message || "")
+    return error_atom_helper(env, status_code, exception.message || "")
   end
+
   env.response.content_type = "application/atom+xml"
   env.response.status_code = status_code
+
   return "<error>#{exception.inspect_with_backtrace}</error>"
 end
 
-def error_atom_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, message : String)
+def error_atom_helper(env : HTTP::Server::Context, status_code : Int32, message : String)
   env.response.content_type = "application/atom+xml"
   env.response.status_code = status_code
+
   return "<error>#{message}</error>"
 end
 
+# -------------------
+#  JSON
+# -------------------
+
 macro error_json(*args)
-  error_json_helper(env, locale, {{*args}})
+  error_json_helper(env, {{*args}})
 end
 
-def error_json_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, exception : Exception, additional_fields : Hash(String, Object) | Nil)
+def error_json_helper(
+  env : HTTP::Server::Context,
+  status_code : Int32,
+  exception : Exception,
+  additional_fields : Hash(String, Object) | Nil = nil
+)
   if exception.is_a?(InfoException)
-    return error_json_helper(env, locale, status_code, exception.message || "", additional_fields)
+    return error_json_helper(env, status_code, exception.message || "", additional_fields)
   end
+
   env.response.content_type = "application/json"
   env.response.status_code = status_code
+
   error_message = {"error" => exception.message, "errorBacktrace" => exception.inspect_with_backtrace}
+
   if additional_fields
     error_message = error_message.merge(additional_fields)
   end
-  return error_message.to_json
-end
 
-def error_json_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, exception : Exception)
-  return error_json_helper(env, locale, status_code, exception, nil)
+  return error_message.to_json
 end
 
-def error_json_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, message : String, additional_fields : Hash(String, Object) | Nil)
+def error_json_helper(
+  env : HTTP::Server::Context,
+  status_code : Int32,
+  message : String,
+  additional_fields : Hash(String, Object) | Nil = nil
+)
   env.response.content_type = "application/json"
   env.response.status_code = status_code
+
   error_message = {"error" => message}
+
   if additional_fields
     error_message = error_message.merge(additional_fields)
   end
+
   return error_message.to_json
 end
 
-def error_json_helper(env : HTTP::Server::Context, locale : String?, status_code : Int32, message : String)
-  error_json_helper(env, locale, status_code, message, nil)
-end
+# -------------------
+#  Redirect
+# -------------------
 
-def error_redirect_helper(env : HTTP::Server::Context, locale : String?)
+def error_redirect_helper(env : HTTP::Server::Context)
   request_path = env.request.path
 
+  locale = env.get("preferences").as(Preferences).locale
+
   if request_path.starts_with?("/search") || request_path.starts_with?("/watch") ||
      request_path.starts_with?("/channel") || request_path.starts_with?("/playlist?list=PL")
     next_steps_text = translate(locale, "next_steps_error_message")

src/invidious/helpers/errors.cr

@@ -94,8 +94,8 @@ def translate(locale : String?, key : String, text : String | Nil = nil) : Strin
     translation = ""
     match_length = 0
 
-    raw_data.as_h.each do |key, value|
-      if md = text.try &.match(/#{key}/)
+    raw_data.as_h.each do |hash_key, value|
+      if md = text.try &.match(/#{hash_key}/)
         if md[0].size >= match_length
           translation = value.as_s
           match_length = md[0].size

src/invidious/helpers/i18n.cr

@@ -98,9 +98,9 @@ module JSONFilter
           end
         end
 
-        group_name.split('/').each do |group_name|
+        group_name.split('/').each do |name|
           nest_stack.push({
-            group_name:            group_name,
+            group_name:            name,
             closing_bracket_index: closing_bracket_index,
           })
         end

src/invidious/helpers/json_filter.cr

@@ -175,9 +175,8 @@ module Kemal
 
           if @cached_files.sum(&.[1][:data].bytesize) + (size = File.size(file_path)) < CACHE_LIMIT
             data = Bytes.new(size)
-            File.open(file_path) do |file|
-              file.read(data)
-            end
+            File.open(file_path, &.read(data))
+
             filestat = File.info(file_path)
 
             @cached_files[file_path] = {data: data, filestat: filestat}

src/invidious/helpers/static_file_handler.cr

@@ -42,6 +42,9 @@ end
 def sign_token(key, hash)
   string_to_sign = [] of String
 
+  # TODO: figure out which "key" variable is used
+  # Ameba reports a warning for "Lint/ShadowingOuterLocalVar" on this
+  # variable, but its preferrable to not touch that (works fine atm).
   hash.each do |key, value|
     next if key == "signature"