turbo-rails 0.5.0

data/app/models/turbo/streams/tag_builder.rb

@@ -0,0 +1,127 @@
+# This tag builder is used both for inline controller turbo actions (see <tt>Turbo::Streams::TurboStreamsTagBuilder</tt>) and for
+# turbo stream templates. This object plays together with any normal Ruby you'd run in an ERB template, so you can iterate, like:
+#
+#   <% # app/views/postings/destroy.turbo_stream.erb %>
+#   <% @postings.each do |posting| %>
+#     <%= turbo_stream.remove posting %>
+#   <% end %>
+#
+# Or string several separate updates together:
+#
+#   <% # app/views/entries/_entry.turbo_stream.erb %>
+#   <%= turbo_stream.remove entry %>
+#
+#   <%= turbo_stream.append "entries" do %>
+#     <% # format ensures that the _entry.html.erb partial is rendered, not _entry.turbo_stream.erb %>
+#     <%= render partial: "entries/entry", locals: { entry: entry }, formats: [ :html ] %>
+#   <%= end %>
+#
+# Or you can render the HTML that should be part of the update inline:
+#
+#   <% # app/views/topics/merges/_merge.turbo_stream.erb %>
+#   <%= turbo_stream.append dom_id(topic_merge) do %>
+#     <%= link_to topic_merge.topic.name, topic_path(topic_merge.topic) %>
+#   <% end %>
+class Turbo::Streams::TagBuilder
+  include Turbo::Streams::ActionHelper
+
+  def initialize(view_context)
+    @view_context = view_context
+  end
+
+  # Removes the <tt>target</tt> from the dom. The target can either be a dom id string or an object that responds to
+  # <tt>to_key</tt>, which is then called and passed through <tt>ActionView::RecordIdentifier.dom_id</tt> (all Active Records
+  # do). Examples:
+  #
+  #   <%= turbo_stream.remove "clearance_5" %>
+  #   <%= turbo_stream.remove clearance %>
+  def remove(target)
+    action :remove, target, allow_inferred_rendering: false
+  end
+
+  # Replace the <tt>target</tt> in the dom with the either the <tt>content</tt> passed in, a rendering result determined
+  # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the target as a record. Examples:
+  #
+  #   <%= turbo_stream.replace "clearance_5", "<div id='clearance_5'>Replace the dom target identified by clearance_5</div>" %>
+  #   <%= turbo_stream.replace clearance %>
+  #   <%= turbo_stream.replace clearance, partial: "clearances/clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.replace "clearance_5" do %>
+  #     <div id='clearance_5'>Replace the dom target identified by clearance_5</div>
+  #   <% end %>
+  def replace(target, content = nil, **rendering, &block)
+    action :replace, target, content, **rendering, &block
+  end
+
+  # Update the <tt>target</tt> in the dom with the either the <tt>content</tt> passed in or a rendering result determined
+  # by the <tt>rendering</tt> keyword arguments, the content in the block, or the rendering of the target as a record. Examples:
+  #
+  #   <%= turbo_stream.update "clearance_5", "Update the content of the dom target identified by clearance_5" %>
+  #   <%= turbo_stream.update clearance %>
+  #   <%= turbo_stream.update clearance, partial: "clearances/unique_clearance", locals: { title: "Hello" } %>
+  #   <%= turbo_stream.update "clearance_5" do %>
+  #     Update the content of the dom target identified by clearance_5
+  #   <% end %>
+  def update(target, content = nil, **rendering, &block)
+    action :update, target, content, **rendering, &block
+  end
+
+  # Append to the target in the dom identified with <tt>target</tt> either the <tt>content</tt> passed in or a
+  # rendering result determined by the <tt>rendering</tt> keyword arguments, the content in the block,
+  # or the rendering of the content as a record. Examples:
+  #
+  #   <%= turbo_stream.append "clearances", "<div id='clearance_5'>Append this to .clearances</div>" %>
+  #   <%= turbo_stream.append "clearances", clearance %>
+  #   <%= turbo_stream.append "clearances", partial: "clearances/unique_clearance", locals: { clearance: clearance } %>
+  #   <%= turbo_stream.append "clearances" do %>
+  #     <div id='clearance_5'>Append this to .clearances</div>
+  #   <% end %>
+  def append(target, content = nil, **rendering, &block)
+    action :append, target, content, **rendering, &block
+  end
+
+  # Prepend to the target in the dom identified with <tt>target</tt> either the <tt>content</tt> passed in or a
+  # rendering result determined by the <tt>rendering</tt> keyword arguments or the content in the block,
+  # or the rendering of the content as a record. Examples:
+  #
+  #   <%= turbo_stream.prepend "clearances", "<div id='clearance_5'>Prepend this to .clearances</div>" %>
+  #   <%= turbo_stream.prepend "clearances", clearance %>
+  #   <%= turbo_stream.prepend "clearances", partial: "clearances/unique_clearance", locals: { clearance: clearance } %>
+  #   <%= turbo_stream.prepend "clearances" do %>
+  #     <div id='clearance_5'>Prepend this to .clearances</div>
+  #   <% end %>
+  def prepend(target, content = nil, **rendering, &block)
+    action :prepend, target, content, **rendering, &block
+  end
+
+  # Send an action of the type <tt>name</tt>. Options described in the concrete methods.
+  def action(name, target, content = nil, allow_inferred_rendering: true, **rendering, &block)
+    target_name = extract_target_name_from(target)
+
+    case
+    when content
+      turbo_stream_action_tag name, target: target_name, template: (render_record(content) if allow_inferred_rendering) || content
+    when block_given?
+      turbo_stream_action_tag name, target: target_name, template: @view_context.capture(&block)
+    when rendering.any?
+      turbo_stream_action_tag name, target: target_name, template: @view_context.render(formats: [ :html ], **rendering)
+    else
+      turbo_stream_action_tag name, target: target_name, template: (render_record(target) if allow_inferred_rendering)
+    end
+  end
+
+  private
+    def extract_target_name_from(target)
+      if target.respond_to?(:to_key)
+        ActionView::RecordIdentifier.dom_id(target)
+      else
+        target
+      end
+    end
+
+    def render_record(possible_record)
+      if possible_record.respond_to?(:to_partial_path)
+        record = possible_record
+        @view_context.render(partial: record.to_partial_path, locals: { record.model_name.singular.to_sym => record }, formats: [ :html ])
+      end
+    end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# FIXME: Offer flag to opt out of these native routes
+Rails.application.routes.draw do
+  get "recede_historical_location"  => "turbo/native/navigation#recede",  as: :turbo_recede_historical_location
+  get "resume_historical_location"  => "turbo/native/navigation#resume",  as: :turbo_resume_historical_location
+  get "refresh_historical_location" => "turbo/native/navigation#refresh", as: :turbo_refresh_historical_location
+end

data/lib/install/turbo.rb

@@ -0,0 +1,11 @@
+say "Yield head in application layout for cache helper"
+insert_into_file Rails.root.join("app/views/layouts/application.html.erb").to_s, "\n    <%= yield :head %>", before: /\s*<\/head>/
+
+say "Add Turbo include tags in application layout"
+insert_into_file Rails.root.join("app/views/layouts/application.html.erb").to_s, "\n    <%= turbo_include_tags %>", before: /\s*<\/head>/
+
+say "Enable redis in bundle"
+uncomment_lines "Gemfile", %(gem 'redis')
+
+say "Switch development cable to use redis"
+gsub_file "config/cable.yml", /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"

data/lib/tasks/turbo_tasks.rake

@@ -0,0 +1,6 @@
+namespace :turbo do
+  desc "Install Turbo into the app"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/turbo.rb", __dir__)}"
+  end
+end

data/lib/turbo-rails.rb

@@ -0,0 +1,17 @@
+require "turbo/engine"
+
+module Turbo
+  extend ActiveSupport::Autoload
+
+  class << self
+    attr_writer :signed_stream_verifier_key
+
+    def signed_stream_verifier
+      @signed_stream_verifier ||= ActiveSupport::MessageVerifier.new(signed_stream_verifier_key, digest: "SHA256", serializer: JSON)
+    end
+
+    def signed_stream_verifier_key
+      @signed_stream_verifier_key or raise ArgumentError, "Turbo requires a signed_stream_verifier_key"
+    end
+  end
+end

data/lib/turbo/engine.rb

@@ -0,0 +1,65 @@
+require "rails/engine"
+require "turbo/test_assertions"
+
+module Turbo
+  class Engine < Rails::Engine
+    isolate_namespace Turbo
+    config.eager_load_namespaces << Turbo
+    config.turbo = ActiveSupport::OrderedOptions.new
+
+    initializer "turbo.assets" do
+      Rails.application.config.assets.precompile += %w( turbo )
+    end
+
+    initializer "turbo.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        include Turbo::Streams::TurboStreamsTagBuilder, Turbo::Frames::FrameRequest, Turbo::Native::Navigation
+        helper Turbo::Engine.helpers
+      end
+    end
+
+    initializer "turbo.broadcastable" do
+      ActiveSupport.on_load(:active_record) do
+        include Turbo::Broadcastable
+      end
+    end
+
+    initializer "turbo.mimetype" do
+      Mime::Type.register "text/html; turbo-stream", :turbo_stream
+    end
+
+    initializer "turbo.renderer" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Renderers.add :turbo_stream do |turbo_streams_html, options|
+          self.content_type = Mime[:turbo_stream] if media_type.nil?
+          turbo_streams_html
+        end
+      end
+    end
+
+    initializer "turbo.signed_stream_verifier_key" do
+      Turbo.signed_stream_verifier_key = config.turbo.signed_stream_verifier_key ||
+        Rails.application.key_generator.generate_key("turbo/signed_stream_verifier_key")
+    end
+
+    initializer "turbo.test_assertions" do
+      ActiveSupport.on_load(:active_support_test_case) do
+        include Turbo::TestAssertions
+      end
+    end
+
+    initializer "turbo.integration_test_request_encoding" do
+      ActiveSupport.on_load(:action_dispatch_integration_test) do
+        # Support `as: :turbo_stream`. Public `register_encoder` API is a little too strict.
+        class ActionDispatch::RequestEncoder
+          class TurboStreamEncoder < IdentityEncoder
+            header = [ Mime[:turbo_stream], Mime[:html] ].join(",")
+            define_method(:accept_header) { header }
+          end
+
+          @encoders[:turbo_stream] = TurboStreamEncoder.new
+        end
+      end
+    end
+  end
+end

data/lib/turbo/test_assertions.rb

@@ -0,0 +1,22 @@
+module Turbo
+  module TestAssertions
+    extend ActiveSupport::Concern
+
+    included do
+      # FIXME: Should happen in Rails at a different level
+      delegate :dom_id, :dom_class, to: ActionView::RecordIdentifier
+    end
+
+    def assert_turbo_stream(action:, target: nil, &block)
+      assert_response :ok
+      assert_equal Mime[:turbo_stream], response.media_type
+      assert_select %(turbo-stream[action="#{action}"][target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]), count: 1, &block
+    end
+
+    def assert_no_turbo_stream(action:, target: nil)
+      assert_response :ok
+      assert_equal Mime[:turbo_stream], response.media_type
+      assert_select %(turbo-stream[action="#{action}"][target="#{target.respond_to?(:to_key) ? dom_id(target) : target}"]), count: 0
+    end
+  end
+end

data/lib/turbo/version.rb

@@ -0,0 +1,3 @@
+module Turbo
+  VERSION = "0.5.0"
+end

data/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@hotwired/turbo-rails",
+  "version": "7.0.0-beta.1",
+  "description": "The speed of a single-page web application without having to write any JavaScript",
+  "module": "app/javascript/turbo/index.js",
+  "main": "app/assets/javascripts/turbo.js",
+  "files": [
+    "app/javascript/turbo"
+  ],
+  "scripts": {
+    "build": "rollup -c"
+  },
+  "dependencies": {
+    "@hotwired/turbo": "^7.0.0-beta.1",
+    "@rails/actioncable": "^6.1.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^11.0.1",
+    "rollup": "^2.35.1",
+    "rollup-plugin-terser": "^7.0.2"
+  },
+  "license": "MIT",
+  "author": "Basecamp, LLC",
+  "contributors": [
+    "David Heinemeier Hansson <david@basecamp.com>",
+    "Javan Makhmali <javan@javan.us>",
+    "Sam Stephenson <sstephenson@gmail.com>"
+  ],
+  "keywords": [
+    "hotwire",
+    "turbo",
+    "rails"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hotwired/turbo-rails.git"
+  },
+  "bugs": {
+    "url": "https://github.com/hotwired/turbo-rails/issues"
+  },
+  "homepage": "https://github.com/hotwired/turbo-rails"
+}

data/rollup.config.js

@@ -0,0 +1,23 @@
+import resolve from "@rollup/plugin-node-resolve"
+import { terser } from "rollup-plugin-terser"
+import pkg from "./package.json"
+
+export default {
+  input: pkg.module,
+  output: {
+    file: pkg.main,
+    format: "es",
+    inlineDynamicImports: true
+  },
+  plugins: [
+    resolve(),
+    terser({
+      mangle: false,
+      compress: false,
+      format: {
+        beautify: true,
+        indent_level: 2
+      }
+    })
+  ]
+}

data/test/drive/drive_helper_test.rb

@@ -0,0 +1,8 @@
+require "turbo_test"
+
+class Turbo::DriveHelperTest < ActionDispatch::IntegrationTest
+  test "opting out of the default cache" do
+    get trays_path
+    assert_select "meta", name: "turbo-cache-control", content: "no-cache"
+  end
+end

data/test/dummy/.babelrc

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    ["env", {
+      "modules": false,
+      "targets": {
+        "browsers": "> 1%",
+        "uglify": true
+      },
+      "useBuiltIns": true
+    }]
+  ],
+
+  "plugins": [
+    "syntax-dynamic-import",
+    "transform-object-rest-spread",
+    ["transform-class-properties", { "spec": true }]
+  ]
+}

data/test/dummy/.gitignore

@@ -0,0 +1,3 @@
+*.log
+*.sqlite3
+tmp/*

data/test/dummy/.postcssrc.yml

@@ -0,0 +1,3 @@
+plugins:
+  postcss-import: {}
+  postcss-cssnext: {}

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,2 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}