Merge pull request rails#52626 from p8/guides/add-digests-to-assets

Add digests to guide assets

Author: rafaelfranca

guides/rails_guides/generator.rb

@@ -4,6 +4,7 @@
 require "fileutils"
 require "nokogiri"
 require "securerandom"
+require "digest"
 
 require "active_support/core_ext/string/output_safety"
 require "active_support/core_ext/object/blank"
@@ -19,15 +20,16 @@ class Generator
     GUIDES_RE = /\.(?:erb|md)\z/
 
     def initialize(edge:, version:, all:, only:, epub:, language:, direction: nil, lint:)
-      @edge      = edge
-      @version   = version
-      @all       = all
-      @only      = only
-      @epub      = epub
-      @language  = language
-      @direction = direction || "ltr"
-      @lint = lint
-      @warnings = []
+      @edge         = edge
+      @version      = version
+      @all          = all
+      @only         = only
+      @epub         = epub
+      @language     = language
+      @direction    = direction || "ltr"
+      @digest_paths = {}
+      @lint         = lint
+      @warnings     = []
 
       if @epub
         register_special_mime_types
@@ -39,6 +41,14 @@ def initialize(edge:, version:, all:, only:, epub:, language:, direction: nil, l
     end
 
     def generate
+      if !dry_run?
+        # First copy assets and add digests to make sure digest_paths are
+        # present in generate_guides.
+        process_scss
+        copy_assets
+        add_digests
+      end
+
       generate_guides
 
       if @lint && @warnings.any?
@@ -47,8 +57,6 @@ def generate
       end
 
       if !dry_run?
-        process_scss
-        copy_assets
         generate_epub if @epub
       end
     end
@@ -122,16 +130,33 @@ def select_only(guides)
 
       def process_scss
         system "bundle exec dartsass \
-          #{@guides_dir}/assets/stylesrc/style.scss:#{@output_dir}/stylesheets/style-v2.css \
-          #{@guides_dir}/assets/stylesrc/highlight.scss:#{@output_dir}/stylesheets/highlight-v2.css \
-          #{@guides_dir}/assets/stylesrc/print.scss:#{@output_dir}/stylesheets/print-v2.css"
+          #{@guides_dir}/assets/stylesrc/style.scss:#{@output_dir}/stylesheets/style.css \
+          #{@guides_dir}/assets/stylesrc/highlight.scss:#{@output_dir}/stylesheets/highlight.css \
+          #{@guides_dir}/assets/stylesrc/print.scss:#{@output_dir}/stylesheets/print.css"
       end
 
       def copy_assets
         source_files = Dir.glob("#{@guides_dir}/assets/*").reject { |name| name.include?("stylesrc") }
         FileUtils.cp_r(source_files, @output_dir)
       end
 
+      def add_digests
+        assets_files = Dir.glob("{javascripts,stylesheets}/**/*", base: @output_dir)
+        # Add the MD5 digest to the asset names.
+        assets_files.each do |asset|
+          asset_path = File.join(@output_dir, asset)
+          if File.file?(asset_path)
+            digest = Digest::MD5.file(asset_path).hexdigest
+            ext = File.extname(asset)
+            basename = File.basename(asset, ext)
+            dirname = File.dirname(asset)
+            digest_path = "#{dirname}/#{basename}-#{digest}#{ext}"
+            FileUtils.mv(asset_path, "#{@output_dir}/#{digest_path}")
+            @digest_paths[asset] = digest_path
+          end
+        end
+      end
+
       def output_file_for(guide)
         if guide.end_with?(".md")
           guide.sub(/md\z/, "html")
@@ -157,12 +182,13 @@ def generate_guide(guide, output_file)
 
         view = ActionView::Base.with_empty_template_cache.with_view_paths(
           [@source_dir],
-          edge:     @edge,
-          version:  @version,
-          epub:     "epub/#{epub_filename}",
-          language: @language,
-          direction: @direction,
-          uuid:      SecureRandom.uuid
+          edge:         @edge,
+          version:      @version,
+          epub:         "epub/#{epub_filename}",
+          language:     @language,
+          direction:    @direction,
+          uuid:         SecureRandom.uuid,
+          digest_paths: @digest_paths
         )
         view.extend(Helpers)
 

guides/rails_guides/helpers.rb

@@ -51,5 +51,9 @@ def code(&block)
       c = capture(&block)
       content_tag(:code, c)
     end
+
+    def digest_path(original_filename)
+      @digest_paths[original_filename] || original_filename
+    end
   end
 end

guides/source/epub/layout.html.erb

@@ -2,7 +2,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta>
-<link rel="stylesheet" type="text/css" href="stylesheets/epub.css"></link>
+<link rel="stylesheet" type="text/css" href="<%= digest_path('stylesheets/epub.css') %>"></link>
 <title><%= yield(:page_title) || 'Ruby on Rails Guides' %></title>
 </head>
 <body class="guide">

guides/source/layout.html.erb

@@ -5,17 +5,17 @@
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title><%= yield(:page_title) %></title>
-  <link rel="stylesheet" type="text/css" href="stylesheets/style-v2.css" data-turbo-track="reload">
-  <link rel="stylesheet" type="text/css" href="stylesheets/print-v2.css" media="print">
-  <link rel="stylesheet" type="text/css" href="stylesheets/highlight-v2.css" data-turbo-track="reload">
+  <link rel="stylesheet" type="text/css" href="<%= digest_path('stylesheets/style.css') %>" data-turbo-track="reload">
+  <link rel="stylesheet" type="text/css" href="<%= digest_path('stylesheets/print.css') %>" media="print">
+  <link rel="stylesheet" type="text/css" href="<%= digest_path('stylesheets/highlight.css') %>" data-turbo-track="reload">
 
   <link rel="icon" href="images/favicon.ico" sizes="any">
 
   <link rel="apple-touch-icon" href="images/icon.png">
 
-  <script src="javascripts/@hotwired--turbo.js" data-turbo-track="reload"></script>
-  <script src="javascripts/clipboard.js" data-turbo-track="reload"></script>
-  <script src="javascripts/guides.js" data-turbo-track="reload"></script>
+  <script src="<%= digest_path('javascripts/@hotwired--turbo.js') %>" data-turbo-track="reload"></script>
+  <script src="<%= digest_path('javascripts/clipboard.js') %>" data-turbo-track="reload"></script>
+  <script src="<%= digest_path('javascripts/guides.js') %>" data-turbo-track="reload"></script>
 
   <meta property="og:title" content="<%= yield(:page_title) %>" />
   <meta name="description" content="<%= yield(:description) %>" />