turbo-rails 0.5.3 → 0.5.7

data/app/helpers/turbo/includes_helper.rb

@@ -1,4 +1,6 @@
 module Turbo::IncludesHelper
+  # DEPRECATED: Just use <tt>javascript_include_tag "turbo", type: "module"</tt> directly if using Turbo alone, or
+  # javascript_include_tag "turbo", type: "module-shim" if together with Stimulus and importmaps.
   def turbo_include_tags
     javascript_include_tag("turbo", type: "module")
   end

data/app/helpers/turbo/streams_helper.rb

@@ -4,7 +4,7 @@ module Turbo::StreamsHelper
   #
   # When responding to HTTP requests, controllers can declare `turbo_stream` format response templates in that same
   # style as `html` and `json` response formats. For example, consider a `MessagesController` that responds to both
-  # `text/html` and `text/html; turbo-stream=*; charset=utf-8` requests along with a `.turbo_stream.erb` action template:
+  # `text/html` and `text/vnd.turbo-stream.html` requests along with a `.turbo_stream.erb` action template:
   #
   #   def create
   #     @message = Message.create!(params.require(:message).permit(:content))
@@ -22,7 +22,7 @@ module Turbo::StreamsHelper
   #   <% end %>
   #
   # When a `app/views/messages/create.turbo_stream.erb` template exists, the
-  # `MessagesController#create` will respond to `text/html; turbo-stream`
+  # `MessagesController#create` will respond to `text/vnd.turbo-stream.html`
   # requests by rendering the `messages/create.turbo_stream.erb` view template and transmitting the response
   def turbo_stream
     Turbo::Streams::TagBuilder.new(self)

data/app/models/concerns/turbo/broadcastable.rb

@@ -51,18 +51,23 @@ module Turbo::Broadcastable
     #     belongs_to :board
     #     broadcasts_to ->(message) { [ message.board, :messages ] }, inserts_by: :prepend, target: "board_messages"
     #   end
-    def broadcasts_to(stream, inserts_by: :append, target: model_name.plural)
+    def broadcasts_to(stream, inserts_by: :append, target: broadcast_target_default)
       after_create_commit  -> { broadcast_action_later_to stream.try(:call, self) || send(stream), action: inserts_by, target: target }
       after_update_commit  -> { broadcast_replace_later_to stream.try(:call, self) || send(stream) }
       after_destroy_commit -> { broadcast_remove_to stream.try(:call, self) || send(stream) }
     end
 
     # Same as <tt>#broadcasts_to</tt>, but the designated stream is automatically set to the current model.
-    def broadcasts(inserts_by: :append, target: model_name.plural)
+    def broadcasts(inserts_by: :append, target: broadcast_target_default)
       after_create_commit  -> { broadcast_action_later action: inserts_by, target: target }
       after_update_commit  -> { broadcast_replace_later }
       after_destroy_commit -> { broadcast_remove }
     end
+
+    # All default targets will use the return of this method. Overwrite if you want something else than <tt>model_name.plural</tt>.
+    def broadcast_target_default
+      model_name.plural
+    end
   end
 
   # Remove this broadcastable model from the dom for subscribers of the stream name identified by the passed streamables.
@@ -223,7 +228,7 @@ module Turbo::Broadcastable
 
   private
     def broadcast_target_default
-      model_name.plural
+      self.class.broadcast_target_default
     end
 
     def broadcast_rendering_with_defaults(options)

data/lib/install/turbo_with_asset_pipeline.rb

@@ -1,14 +1,30 @@
 APPLICATION_LAYOUT_PATH = Rails.root.join("app/views/layouts/application.html.erb")
+IMPORTMAP_PATH = Rails.root.join("app/assets/javascripts/importmap.json.erb")
 
 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>/
 
-  say "Add Turbo include tags in application layout"
-  insert_into_file APPLICATION_LAYOUT_PATH.to_s, "\n    <%= turbo_include_tags %>", 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 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
 else
   say "Default application.html.erb is missing!", :red
-  say "        Add <%= turbo_include_tags %> and <%= yield :head %> within the <head> tag in your custom layout."
+
+  if APPLICATION_LAYOUT_PATH.read =~ /stimulus/
+    say %(        Add <%= javascript_include_tag("turbo", type: "module-shim") %> and <%= yield :head %> within the <head> tag after Stimulus includes in your custom layout.)
+  else
+    say %(        Add <%= javascript_include_tag("turbo", type: "module") %> and <%= yield :head %> within the <head> tag in your custom layout.)
+  end
 end
 
 say "Enable redis in bundle"

data/lib/install/turbo_with_webpacker.rb

@@ -5,8 +5,7 @@ abort "❌ Webpacker not found. Exiting." unless defined?(Webpacker::Engine)
 
 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: TURBOLINKS_REGEX
+insert_into_file "#{Webpacker.config.source_entry_path}/application.js", "import \"@hotwired/turbo-rails\"\n", before: /import.*ActiveStorage/
 
 say "Remove Turbolinks"
 gsub_file 'Gemfile', /gem 'turbolinks'.*/, ''

data/lib/turbo/engine.rb

@@ -36,7 +36,7 @@ module Turbo
     end
 
     initializer "turbo.mimetype" do
-      Mime::Type.register "text/html; turbo-stream", :turbo_stream
+      Mime::Type.register "text/vnd.turbo-stream.html", :turbo_stream
     end
 
     initializer "turbo.renderer" do

data/lib/turbo/version.rb

@@ -1,3 +1,3 @@
 module Turbo
-  VERSION = "0.5.3"
+  VERSION = "0.5.7"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: turbo-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.7
 platform: ruby
 authors:
 - Sam Stephenson
 - Javan Mahkmali
 - David Heinemeier Hansson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -26,16 +26,12 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-description:
+description: 
 email: david@loudthinking.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
 - Rakefile
@@ -67,94 +63,11 @@ files:
 - lib/turbo/engine.rb
 - lib/turbo/test_assertions.rb
 - lib/turbo/version.rb
-- package.json
-- rollup.config.js
-- test/drive/drive_helper_test.rb
-- test/dummy/.babelrc
-- test/dummy/.gitignore
-- test/dummy/.postcssrc.yml
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/stylesheets/scaffold.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/messages_controller.rb
-- test/dummy/app/controllers/trays_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailboxes/application_mailbox.rb
-- test/dummy/app/mailboxes/messages_mailbox.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/message.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/messages/_message.html.erb
-- test/dummy/app/views/messages/_message.turbo_stream.erb
-- test/dummy/app/views/messages/show.turbo_stream.erb
-- test/dummy/app/views/trays/index.html.erb
-- test/dummy/app/views/trays/show.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/bin/update
-- test/dummy/bin/yarn
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/spring.rb
-- test/dummy/config/webpack/development.js
-- test/dummy/config/webpack/environment.js
-- test/dummy/config/webpack/production.js
-- test/dummy/config/webpack/test.js
-- test/dummy/config/webpacker.yml
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/frames/frame_request_controller_test.rb
-- test/frames/frames_helper_test.rb
-- test/native/navigation_controller_test.rb
-- test/streams/broadcastable_test.rb
-- test/streams/streams_channel_test.rb
-- test/streams/streams_controller_test.rb
-- test/turbo_test.rb
-- turbo-rails.gemspec
-- yarn.lock
 homepage: https://github.com/hotwired/turbo-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -170,86 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: The speed of a single-page web application without having to write any JavaScript.
-test_files:
-- test/drive/drive_helper_test.rb
-- test/dummy/.babelrc
-- test/dummy/.gitignore
-- test/dummy/.postcssrc.yml
-- test/dummy/Rakefile
-- test/dummy/app/assets/config/manifest.js
-- test/dummy/app/assets/images/.keep
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/stylesheets/scaffold.css
-- test/dummy/app/channels/application_cable/channel.rb
-- test/dummy/app/channels/application_cable/connection.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/controllers/concerns/.keep
-- test/dummy/app/controllers/messages_controller.rb
-- test/dummy/app/controllers/trays_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/javascript/packs/application.js
-- test/dummy/app/jobs/application_job.rb
-- test/dummy/app/mailboxes/application_mailbox.rb
-- test/dummy/app/mailboxes/messages_mailbox.rb
-- test/dummy/app/mailers/application_mailer.rb
-- test/dummy/app/models/application_record.rb
-- test/dummy/app/models/concerns/.keep
-- test/dummy/app/models/message.rb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/layouts/mailer.html.erb
-- test/dummy/app/views/layouts/mailer.text.erb
-- test/dummy/app/views/messages/_message.html.erb
-- test/dummy/app/views/messages/_message.turbo_stream.erb
-- test/dummy/app/views/messages/show.turbo_stream.erb
-- test/dummy/app/views/trays/index.html.erb
-- test/dummy/app/views/trays/show.html.erb
-- test/dummy/bin/bundle
-- test/dummy/bin/rails
-- test/dummy/bin/rake
-- test/dummy/bin/setup
-- test/dummy/bin/update
-- test/dummy/bin/yarn
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/cable.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/application_controller_renderer.rb
-- test/dummy/config/initializers/assets.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/content_security_policy.rb
-- test/dummy/config/initializers/cookies_serializer.rb
-- test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/puma.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/spring.rb
-- test/dummy/config/webpack/development.js
-- test/dummy/config/webpack/environment.js
-- test/dummy/config/webpack/production.js
-- test/dummy/config/webpack/test.js
-- test/dummy/config/webpacker.yml
-- test/dummy/lib/assets/.keep
-- test/dummy/log/.keep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/apple-touch-icon-precomposed.png
-- test/dummy/public/apple-touch-icon.png
-- test/dummy/public/favicon.ico
-- test/frames/frame_request_controller_test.rb
-- test/frames/frames_helper_test.rb
-- test/native/navigation_controller_test.rb
-- test/streams/broadcastable_test.rb
-- test/streams/streams_channel_test.rb
-- test/streams/streams_controller_test.rb
-- test/turbo_test.rb
+test_files: []

data/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-name: CI
-on: [push, pull_request]
-jobs:
-  tests:
-    strategy:
-      matrix:
-        ruby-version:
-          - "2.7"
-          - "3.0"
-        continue-on-error: [ false ]
-
-        include:
-          - ruby-version: head
-            continue-on-error: true
-
-    name: ${{ format('Tests (Ruby {0})', matrix.ruby-version) }}
-    runs-on: ubuntu-latest
-    continue-on-error: ${{ matrix.continue-on-error }}
-
-    steps:
-      - uses: actions/checkout@v1
-
-      - name: Install Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-
-      - name: Run tests
-        run: bundle exec rake

data/.gitignore

@@ -1,2 +0,0 @@
-*.gem
-/node_modules

data/Gemfile

@@ -1,6 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'rake'
-gem 'byebug'

data/Gemfile.lock

@@ -1,147 +0,0 @@
-PATH
-  remote: .
-  specs:
-    turbo-rails (0.5.2)
-      rails (>= 6.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actioncable (6.1.0)
-      actionpack (= 6.1.0)
-      activesupport (= 6.1.0)
-      nio4r (~> 2.0)
-      websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.0)
-      actionpack (= 6.1.0)
-      activejob (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
-      mail (>= 2.7.1)
-    actionmailer (6.1.0)
-      actionpack (= 6.1.0)
-      actionview (= 6.1.0)
-      activejob (= 6.1.0)
-      activesupport (= 6.1.0)
-      mail (~> 2.5, >= 2.5.4)
-      rails-dom-testing (~> 2.0)
-    actionpack (6.1.0)
-      actionview (= 6.1.0)
-      activesupport (= 6.1.0)
-      rack (~> 2.0, >= 2.0.9)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.0)
-      actionpack (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
-      nokogiri (>= 1.8.5)
-    actionview (6.1.0)
-      activesupport (= 6.1.0)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.0)
-      activesupport (= 6.1.0)
-      globalid (>= 0.3.6)
-    activemodel (6.1.0)
-      activesupport (= 6.1.0)
-    activerecord (6.1.0)
-      activemodel (= 6.1.0)
-      activesupport (= 6.1.0)
-    activestorage (6.1.0)
-      actionpack (= 6.1.0)
-      activejob (= 6.1.0)
-      activerecord (= 6.1.0)
-      activesupport (= 6.1.0)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    builder (3.2.4)
-    byebug (11.0.1)
-    concurrent-ruby (1.1.7)
-    crass (1.0.6)
-    erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.6)
-      concurrent-ruby (~> 1.0)
-    loofah (2.8.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
-      mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
-    method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (6.1.0)
-      actioncable (= 6.1.0)
-      actionmailbox (= 6.1.0)
-      actionmailer (= 6.1.0)
-      actionpack (= 6.1.0)
-      actiontext (= 6.1.0)
-      actionview (= 6.1.0)
-      activejob (= 6.1.0)
-      activemodel (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
-      bundler (>= 1.15.0)
-      railties (= 6.1.0)
-      sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.1.0)
-      actionpack (= 6.1.0)
-      activesupport (= 6.1.0)
-      method_source
-      rake (>= 0.8.7)
-      thor (~> 1.0)
-    rake (13.0.0)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    thor (1.0.1)
-    tzinfo (2.0.4)
-      concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.3)
-      websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  rake
-  turbo-rails!
-
-BUNDLED WITH
-   2.2.3