turbo-rails 0.6.0 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42d7a658511c698c83b4e41853f96f5b2534a9ee81b89500044a22d6695a5150
-  data.tar.gz: 46e9abb9a01e4c9b50d2c2b704ff0e522a7231496b58d7acbc78303cdef67486
+  metadata.gz: 2608402a944433e82b78b6aed5ac64e54579566e23a5a3b1a6837a695c7031ff
+  data.tar.gz: b342da8a4a13bc4b9fbbec5ee1a06afff0db881e3ab4103adba4c47188dd351a
 SHA512:
-  metadata.gz: be906021b12ba905c7ce316900cb28db1ec22cbec561c2e009758a58cb059c82984862bae1f045c2f60b1db9fd396ebb2c88ba07c08a2871d1f39556f67cd2b1
-  data.tar.gz: de3c17c9f07971421add4c6038f385b609d465eb939f1860900c635b35b72b65ebbbea030a2d45722bb6bda86b2b38e5d794c005e063698c3ec63478fd3dd083
+  metadata.gz: 9183cb91a6ce9b2bc0b401ec35b7a3ff835b30d2732c96c6ab8db6ef23a3276e80e08ade5648ceb118c00a8cb5b2b07bb87e6ac8451224bf72885d12fcde2204
+  data.tar.gz: 0665d67d6cb734a670c12412588e23359a63204a72d92fce01a940e19b34e3e8a4217acf42e88b61d60b0700b6bc36ed2fba3e533140ea69503a7a047597fea0

data/README.md

@@ -38,7 +38,7 @@ The JavaScript for Turbo can either be run through the asset pipeline, which is
 2. Run `./bin/bundle install`
 3. Run `./bin/rails turbo:install`
 
-Running `turbo:install` will install through NPM if Webpacker is installed in the application. Otherwise the asset pipeline version is used.
+Running `turbo:install` will install through NPM if Webpacker is installed in the application. Otherwise the asset pipeline version is used. To use the asset pipeline version, you must have `importmap-rails` installed first and listed higher in the Gemfile.
 
 If you're using Webpack and need to use the cable consumer, you can import [`cable`](https://github.com/hotwired/turbo-rails/blob/main/app/javascript/turbo/cable.js) (`import { cable } from "@hotwired/turbo-rails"`), but ensure that your application actually *uses* the members it `import`s when using this style (see [turbo-rails#48](https://github.com/hotwired/turbo-rails/issues/48)).
 
@@ -62,7 +62,7 @@ Turbo can coexist with Rails UJS, but you need to take a series of upgrade steps
 
 * To run the Rails tests: `bundle exec rake`.
   * To install dependencies: `bundle install`
-  * To prepare the test database: `cd tests/dummy; RAILS_ENV=test ./bin/rails db:migrate`
+  * To prepare the test database: `cd test/dummy; RAILS_ENV=test ./bin/rails db:migrate`
 * To compile the JavaScript for the asset pipeline: `yarn build`
 
 

data/lib/install/turbo_with_asset_pipeline.rb

@@ -1,26 +1,26 @@
-APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
-IMPORTMAP_PATH = Rails.root.join("app/assets/javascripts/importmap.json.erb")
+APP_JS_PATH = Rails.root.join("app/javascript/application.js")
 CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
+IMPORTMAP_PATH = Rails.root.join("config/importmap.rb")
 
-if APPLICATION_LAYOUT_PATH.exist?
-  say "Yield head in application layout for cache helper"
-  insert_into_file APPLICATION_LAYOUT_PATH.to_s, "\n    <%= yield :head %>", before: /\s*<\/head>/
-
-  if APPLICATION_LAYOUT_PATH.read =~ /stimulus/
-    say "Add Turbo include tags in application layout"
-    insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(\n    <%= javascript_include_tag "turbo", type: "module-shim" %>), after: /<%= stimulus_include_tags %>/
+if APP_JS_PATH.exist?
+  say "Import turbo-rails in existing app/javascript/application.js"
+  append_to_file APP_JS_PATH, %(import "@hotwired/turbo-rails"\n)
+else
+  say <<~INSTRUCTIONS, :red
+    You must import @hotwire/turbo-rails in your application.js.
+  INSTRUCTIONS
+end
 
-    if IMPORTMAP_PATH.exist?
-      say "Add Turbo to importmap"
-      insert_into_file IMPORTMAP_PATH, %(    "turbo": "<%= asset_path "turbo" %>",\n), after: /  "imports": {\s*\n/
-    end
-  else
-    say "Add Turbo include tags in application layout"
-    insert_into_file APPLICATION_LAYOUT_PATH.to_s, %(\n    <%= javascript_include_tag "turbo", type: "module" %>), before: /\s*<\/head>/
-  end
+if IMPORTMAP_PATH.exist?
+  say "Pin @hotwired/turbo-rails in config/importmap.rb"
+  insert_into_file \
+    IMPORTMAP_PATH.to_s, 
+    %(  pin "@hotwired/turbo-rails", to: "turbo.js"\n\n),
+    after: "Rails.application.config.importmap.draw do\n"
 else
-  say "Default application.html.erb is missing!", :red
-  say %(        Add <%= javascript_include_tag("turbo", type: "module-shim") %> and <%= yield :head %> within the <head> tag after Stimulus includes in your custom layout.)
+  say <<~INSTRUCTIONS, :red
+    You must add @hotwire/turbo-rails to your importmap to reference them via ESM.
+  INSTRUCTIONS
 end
 
 if CABLE_CONFIG_PATH.exist?
@@ -32,5 +32,3 @@ if CABLE_CONFIG_PATH.exist?
 else
   say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
 end
-
-say "Turbo successfully installed ⚡️", :green

data/lib/install/turbo_with_webpacker.rb

@@ -1,20 +1,10 @@
-# Some Rails versions use commonJS(require) others use ESM(import).
-TURBOLINKS_REGEX = /(import .* from "turbolinks".*\n|require\("turbolinks"\).*\n)/.freeze
-ACTIVE_STORAGE_REGEX = /(import.*ActiveStorage|require.*@rails\/activestorage.*)/.freeze
-CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
-
-abort "❌ Webpacker not found. Exiting." unless defined?(Webpacker::Engine)
+say "Appending Turbo setup code to #{Webpacker.config.source_entry_path}/application.js"
+append_to_file "#{Webpacker.config.source_entry_path}/application.js", %(\nimport "@hotwired/turbo-rails"\n)
 
 say "Install Turbo"
 run "yarn add @hotwired/turbo-rails"
-insert_into_file "#{Webpacker.config.source_entry_path}/application.js", "import \"@hotwired/turbo-rails\"\n", before: ACTIVE_STORAGE_REGEX
 
-say "Remove Turbolinks"
-run "#{RbConfig.ruby} bin/bundle remove turbolinks"
-run "#{RbConfig.ruby} bin/bundle", capture: true
-run "#{RbConfig.ruby} bin/yarn remove turbolinks"
-gsub_file "#{Webpacker.config.source_entry_path}/application.js", TURBOLINKS_REGEX, ''
-gsub_file "#{Webpacker.config.source_entry_path}/application.js", /Turbolinks.start.*\n/, ''
+CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
 
 if CABLE_CONFIG_PATH.exist?
   say "Enable redis in bundle"
@@ -25,5 +15,3 @@ if CABLE_CONFIG_PATH.exist?
 else
   say 'ActionCable config file (config/cable.yml) is missing. Uncomment "gem \'redis\'" in your Gemfile and create config/cable.yml to use the Turbo Streams broadcast feature.'
 end
-
-say "Turbo successfully installed ⚡️", :green

data/lib/turbo/engine.rb

@@ -22,7 +22,7 @@ module Turbo
 
     initializer "turbo.assets" do
       if Rails.application.config.respond_to?(:assets)
-        Rails.application.config.assets.precompile += %w( turbo )
+        Rails.application.config.assets.precompile += %w( turbo.js )
       end
     end
 

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.6.0"
+  VERSION = "0.7.4"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.4
 platform: ruby
 authors:
 - Sam Stephenson
 - Javan Mahkmali
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,7 +26,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description:
+description: 
 email: david@loudthinking.com
 executables: []
 extensions: []
@@ -67,7 +67,7 @@ homepage: https://github.com/hotwired/turbo-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key:
+signing_key: 
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.
 test_files: []