refactor(test) put sprockets helpers in module

rmosolgo · rmosolgo · commit c61e8c923498 · 2017-04-07T14:43:17.000-04:00
diff --git a/test/dummy/app/controllers/pages_controller.rb b/test/dummy/app/controllers/pages_controller.rb
@@ -1,5 +1,5 @@
 class PagesController < ApplicationController
-  if WebpackerHelpers.available? || !SKIP_SPROCKETS
+  if WebpackerHelpers.available? || SprocketsHelpers.available?
     per_request_react_rails_prerenderer
   end
 
diff --git a/test/dummy/app/views/layouts/application.html.erb b/test/dummy/app/views/layouts/application.html.erb
@@ -2,7 +2,7 @@
 <html>
 <head>
   <title>Dummy</title>
-  <% if !SKIP_SPROCKETS %>
+  <% if SprocketsHelpers.available? %>
     <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
   <% end %>
   <%= csrf_meta_tags %>
diff --git a/test/dummy/config/application.rb b/test/dummy/config/application.rb
@@ -6,8 +6,7 @@
 require "action_mailer/railtie"
 
 # Test no-sprockets environment by testing the gemfile name
-SKIP_SPROCKETS = ENV["BUNDLE_GEMFILE"] =~ /no_sprockets/
-if !SKIP_SPROCKETS
+if SprocketsHelpers.available?
   require "sprockets/railtie"
 end
 
@@ -33,7 +32,7 @@ class Application < Rails::Application
     # config.i18n.default_locale = :de
     config.react.variant = :production
     config.react.addons = false
-    if !SKIP_SPROCKETS
+    if SprocketsHelpers.available?
       config.assets.enabled = true
     end
   end
diff --git a/test/dummy/config/environments/test.rb b/test/dummy/config/environments/test.rb
@@ -9,7 +9,7 @@
   # we need this to reload the jsx transformer when different version is dropped in
   config.cache_classes = false
   config.reload_plugins = true
-  if !SKIP_SPROCKETS
+  if SprocketsHelpers.available?
     config.assets.cache_store = :null_store
   end
 
diff --git a/test/react/jsx/jsx_prepocessor_test.rb b/test/react/jsx/jsx_prepocessor_test.rb
@@ -1,13 +1,13 @@
 require 'test_helper'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class JSXPreprocessorTest < ActiveSupport::TestCase
     REQUIRED_JAVASCRIPT = "var requirePlainJavascript = true;"
     REQUIRED_COFFEESCRIPT =  "var requireCoffee; requireCoffee = true;"
     REQUIRED_JSX = "React.createElement(\"div\", { className: \"require-jsx\" });"
     OWN_JSX = "React.createElement(\"div\", { className: \"le-javascript\" });"
     test 'executes //= require directives' do
-      require_parent = fetch_asset_body("require_test/jsx_preprocessor_test.js")
+      require_parent = SprocketsHelpers.fetch_asset_body("require_test/jsx_preprocessor_test.js")
 
       assert_compiled_javascript_includes(require_parent, REQUIRED_JAVASCRIPT)
       assert_compiled_javascript_includes(require_parent, REQUIRED_COFFEESCRIPT)
diff --git a/test/react/jsx/jsx_transformer_test.rb b/test/react/jsx/jsx_transformer_test.rb
@@ -1,24 +1,24 @@
 require 'test_helper'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class JSXTransformerTest < ActionDispatch::IntegrationTest
     setup do
       reset_transformer
       React::JSX.transformer_class = React::JSX::JSXTransformer
-      manually_expire_asset('JSXTransformer.js')
+      SprocketsHelpers.manually_expire_asset('JSXTransformer.js')
     end
 
     teardown do
       reset_transformer
-      manually_expire_asset('JSXTransformer.js')
+      SprocketsHelpers.manually_expire_asset('JSXTransformer.js')
     end
 
     test 'can use dropped-in version of JSX transformer' do
       hidden_path =     Rails.root.join("vendor/assets/react/JSXTransformer__.js")
       replacing_path =  Rails.root.join("vendor/assets/react/JSXTransformer.js")
 
       FileUtils.cp hidden_path, replacing_path
-      manually_expire_asset('example3.js')
+      SprocketsHelpers.manually_expire_asset('example3.js')
 
       get '/assets/example3.js'
       FileUtils.rm replacing_path
@@ -53,7 +53,7 @@ class JSXTransformerTest < ActionDispatch::IntegrationTest
 
       FileUtils.mkdir_p(custom_path)
       FileUtils.cp(hidden_path, replacing_path)
-      manually_expire_asset('example3.js')
+      SprocketsHelpers.manually_expire_asset('example3.js')
       get '/assets/example3.js'
 
       FileUtils.rm_rf custom_path
diff --git a/test/react/jsx_test.rb b/test/react/jsx_test.rb
@@ -26,7 +26,7 @@ def transform(code)
   end
 end
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class JSXTransformTest < ActionDispatch::IntegrationTest
     setup do
       reset_transformer
@@ -37,30 +37,30 @@ class JSXTransformTest < ActionDispatch::IntegrationTest
     end
 
     test 'asset pipeline should transform JSX' do
-      manually_expire_asset('example.js')
+      SprocketsHelpers.manually_expire_asset('example.js')
       get '/assets/example.js'
       assert_response :success
       assert_compiled_javascript_matches(EXPECTED_JS, @response.body)
     end
 
     test 'asset pipeline should transform JSX + Coffeescript' do
-      manually_expire_asset('example2.js')
+      SprocketsHelpers.manually_expire_asset('example2.js')
       get '/assets/example2.js'
       assert_response :success
       assert_compiled_javascript_matches(EXPECTED_JS_2, @response.body)
     end
 
     test 'use a custom transformer' do
       React::JSX.transformer_class = NullTransformer
-      manually_expire_asset('example2.js')
+      SprocketsHelpers.manually_expire_asset('example2.js')
       get '/assets/example2.js'
 
       assert_equal "TRANSFORMED CODE!;\n", @response.body
     end
 
     def test_babel_transformer_accepts_babel_transformation_options
       React::JSX.transform_options = {blacklist: ['spec.functionName', 'validation.react', "strict"]}
-      manually_expire_asset('example.js')
+      SprocketsHelpers.manually_expire_asset('example.js')
       get '/assets/example.js'
       assert_response :success
 
diff --git a/test/react/rails/component_mount_test.rb b/test/react/rails/component_mount_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class ComponentMountTest < ActionDispatch::IntegrationTest
     setup do
       WebpackerHelpers.compile_if_missing
diff --git a/test/react/rails/react_rails_ujs_test.rb b/test/react/rails/react_rails_ujs_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class ReactRailsUJSTest < ActionDispatch::IntegrationTest
     include Capybara::DSL
 
diff --git a/test/react/server_rendering/manifest_container_test.rb b/test/react/server_rendering/manifest_container_test.rb
@@ -9,13 +9,13 @@
 
   class ManifestContainerTest < ActiveSupport::TestCase
     def setup
-      precompile_assets
+      SprocketsHelpers.precompile_assets
 
       @manifest_container = React::ServerRendering::ManifestContainer.new
     end
 
     def teardown
-      clear_precompiled_assets
+      SprocketsHelpers.clear_precompiled_assets
     end
 
     def test_find_asset_gets_asset_contents
diff --git a/test/react/server_rendering/sprockets_renderer_test.rb b/test/react/server_rendering/sprockets_renderer_test.rb
@@ -1,6 +1,6 @@
 require 'test_helper'
 
-when_sprockets_available do
+if SprocketsHelpers.available? || WebpackerHelpers.available?
   class SprocketsRendererTest < ActiveSupport::TestCase
     CALLBACKS = [:before_render, :after_render]
 
@@ -113,7 +113,7 @@ class SprocketsRendererTest < ActiveSupport::TestCase
           legacy_rendering_files = ["react-server.js", "react_ujs.js", "components.js"]
           Rails.application.config.assets.precompile += legacy_rendering_files
 
-          precompile_assets
+          SprocketsHelpers.precompile_assets
 
           Rails.application.config.assets.compile = false
 
@@ -125,7 +125,7 @@ class SprocketsRendererTest < ActiveSupport::TestCase
         ensure
           Rails.application.config.assets.compile = true
 
-          clear_precompiled_assets
+          SprocketsHelpers.clear_precompiled_assets
         end
       end
     end
diff --git a/test/react/server_rendering/yaml_manifest_container_test.rb b/test/react/server_rendering/yaml_manifest_container_test.rb
@@ -3,13 +3,13 @@
 if Rails::VERSION::MAJOR == 3
   class YamlManifestContainerTest < ActiveSupport::TestCase
     def setup
-      precompile_assets
+      SprocketsHelpers.precompile_assets
 
       @manifest_container = React::ServerRendering::YamlManifestContainer.new
     end
 
     def teardown
-      clear_precompiled_assets
+      SprocketsHelpers.clear_precompiled_assets
     end
 
     def test_find_asset_gets_asset_contents
diff --git a/test/react_asset_test.rb b/test/react_asset_test.rb
@@ -1,20 +1,20 @@
 require 'test_helper'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class ReactAssetTest < ActionDispatch::IntegrationTest
     setup do
-      clear_sprockets_cache
+      SprocketsHelpers.clear_sprockets_cache
     end
 
     teardown do
-      clear_sprockets_cache
+      SprocketsHelpers.clear_sprockets_cache
     end
 
     test 'asset pipeline should deliver drop-in react file replacement' do
       app_react_file_path = File.expand_path("../dummy/vendor/assets/javascripts/react.js",  __FILE__)
       react_file_token = "'test_confirmation_token_react_content_non_production';\n"
       File.write(app_react_file_path, react_file_token)
-      manually_expire_asset("react.js")
+      SprocketsHelpers.manually_expire_asset("react.js")
       react_asset = Rails.application.assets['react.js']
 
       get '/assets/react.js'
@@ -28,9 +28,9 @@ class ReactAssetTest < ActionDispatch::IntegrationTest
 
     test 'precompiling assets works' do
       begin
-        precompile_assets
+        SprocketsHelpers.precompile_assets
       ensure
-        clear_precompiled_assets
+        SprocketsHelpers.clear_precompiled_assets
       end
     end
 
diff --git a/test/server_rendered_html_test.rb b/test/server_rendered_html_test.rb
@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'fileutils'
 
-when_sprockets_available do
+SprocketsHelpers.when_available do
   class ServerRenderedHtmlTest  < ActionDispatch::IntegrationTest
     # Rails' asset pipeline has trouble picking up changes to files if they happen too fast.
     # By sleeping for a little bit at certain points, we can make sure that rails notices the
diff --git a/test/support/sprockets_helpers.rb b/test/support/sprockets_helpers.rb
@@ -0,0 +1,71 @@
+module SprocketsHelpers
+  module_function
+  def available?
+    ENV["BUNDLE_GEMFILE"] !~ /no_sprockets/
+  end
+
+  # The block depends on sprockets, don't run it if sprockets is missing
+  def when_available
+    if available?
+      yield
+    end
+  end
+
+  def clear_sprockets_cache
+    # Remove cached files
+    Rails.root.join('tmp/cache').tap do |tmp|
+      tmp.rmtree if tmp.exist?
+      tmp.mkpath
+    end
+  end
+
+  def fetch_asset_body(asset_logical_path)
+    Rails.application.assets[asset_logical_path].to_s
+  end
+
+  # Sprockets 2 doesn't expire this assets well in
+  # this kind of setting,
+  # so override `fresh?` to mark it as expired.
+  def manually_expire_asset(asset_name)
+    asset = Rails.application.assets[asset_name]
+    def asset.fresh?(env); false; end
+  end
+
+  def precompile_assets
+    capture_io do
+      # Changing directories is required because:
+      # - assets:precompile runs webpacker:compile when availabled
+      # - webpacker:compile depends on `./bin/webpack`, so `.` must be the app root
+      Dir.chdir("./test/dummy") do
+
+        ENV['RAILS_GROUPS'] = 'assets' # required for Rails 3.2
+        Rake::Task['assets:precompile'].reenable
+
+        if Rails::VERSION::MAJOR == 3
+          Rake::Task['assets:precompile:all'].reenable
+          Rake::Task['assets:precompile:primary'].reenable
+          Rake::Task['assets:precompile:nondigest'].reenable
+        end
+
+        Rake::Task['assets:precompile'].invoke
+      end
+    end
+
+    if Rails.application.respond_to?(:assets_manifest)
+      # Make a new manifest since assets weren't compiled before
+      config = Rails.application.config
+      path = File.join(config.paths['public'].first, config.assets.prefix)
+      new_manifest = Sprockets::Manifest.new(Rails.application.assets, path)
+      Rails.application.assets_manifest = new_manifest
+    end
+
+    assets_directory = File.expand_path("../../dummy/public/assets", __FILE__)
+    raise "Asset precompilation failed" unless Dir.exists?(assets_directory)
+  end
+
+  def clear_precompiled_assets
+    assets_directory = File.expand_path("../../dummy/public/assets", __FILE__)
+    FileUtils.rm_r(assets_directory)
+    ENV.delete('RAILS_GROUPS')
+  end
+end
diff --git a/test/test_helper.rb b/test/test_helper.rb
