futurism 1.2.0.pre9 → 1.2.0.pre10

data/test/helper/helper_test.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class Futurism::HelperTest < ActionView::TestCase
+  include Futurism::Helpers
+
+  test "renders html options with data attributes" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post, html_options: {class: "absolute inset-0", data: {controller: "test"}}) {})
+
+    assert_equal "futurism-element", element.children.first.name
+    assert_equal post, GlobalID::Locator.locate_signed(element.children.first["data-sgid"])
+    assert_equal sign_params({data: {controller: "test"}}), element.children.first["data-signed-params"]
+    assert_nil element.children.first["data-eager"]
+    assert_equal "absolute inset-0", element.children.first["class"]
+
+    params = {partial: "posts/card", locals: {post: post}}
+    element = Nokogiri::HTML.fragment(futurize(**params.merge({html_options: {class: "flex justify-center", data: {action: "test#click"}}})) {})
+
+    assert_equal "futurism-element", element.children.first.name
+    assert_nil element.children.first["data-sgid"]
+    assert_nil element.children.first["data-eager"]
+    assert_equal "posts/card", extract_params(element.children.first["data-signed-params"])[:partial]
+    assert_equal post.to_global_id.to_s, extract_params(element.children.first["data-signed-params"])[:locals][:post]
+    assert_equal "test#click", extract_params(element.children.first["data-signed-params"])[:data][:action]
+    assert_equal "flex justify-center", element.children.first["class"]
+  end
+
+  test "renders html options with data attributes with multi-word object" do
+    action_item = ActionItem.create description: "Do this"
+
+    element = Nokogiri::HTML.fragment(futurize(action_item) {})
+
+    assert_equal "futurism-element", element.children.first.name
+    assert_equal action_item, GlobalID::Locator.locate_signed(element.children.first["data-sgid"])
+  end
+
+  test "ensures signed_params and sgid are not overwritable" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post, html_options: {data: {controller: "test", sgid: "test", signed_params: "test"}}) {})
+
+    assert_equal post, GlobalID::Locator.locate_signed(element.children.first["data-sgid"])
+    assert_equal sign_params({data: {controller: "test"}}), element.children.first["data-signed-params"]
+  end
+
+  test "allows to specify a new ActiveRecord record" do
+    post = Post.new
+
+    element = Nokogiri::HTML.fragment(futurize("posts/form", post: post) {})
+
+    assert extract_params(element.children.first["data-signed-params"])[:locals][:post].new_record?
+  end
+
+  test "renders futurism-element by default" do
+    element = Nokogiri::HTML.fragment(futurize("posts/card", post: Post.new) {})
+
+    assert_equal element.children.first.name, "futurism-element"
+  end
+
+  test "renders futurism-table-row or futurism-li if specified via extends option" do
+    element = Nokogiri::HTML.fragment(futurize("posts/card", post: Post.new, extends: :tr) {})
+
+    assert_equal element.children.first.name, "tr"
+    assert_equal element.children.first["is"], "futurism-table-row"
+
+    element = Nokogiri::HTML.fragment(futurize("posts/card", post: Post.new, extends: :li) {})
+
+    assert_equal element.children.first.name, "li"
+    assert_equal element.children.first["is"], "futurism-li"
+  end
+
+  # PORO that is serializable/de-serializable
+  class GlobalIdableEntity
+    include GlobalID::Identification
+
+    def id
+      "fake-id"
+    end
+
+    def self.find(id)
+      new if id == "fake-id"
+    end
+  end
+
+  test "allows to specify any GlobalId-able entity" do
+    entity = GlobalIdableEntity.new
+    element = Nokogiri::HTML.fragment(futurize("posts/form", entity: entity) {})
+
+    assert_equal "gid://dummy/Futurism::HelperTest::GlobalIdableEntity/fake-id", extract_params(element.children.first["data-signed-params"])[:locals][:entity]
+  end
+
+  test "does not render an eager loading data attribute per default" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post) {})
+
+    refute_equal "true", element.children.first["data-eager"]
+
+    element = Nokogiri::HTML.fragment(futurize(partial: "posts/card", locals: {post: post}) {})
+    refute_equal "true", element.children.first["data-eager"]
+  end
+
+  test "renders an eager loading data attribute" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post, eager: true) {})
+
+    assert_equal "true", element.children.first["data-eager"]
+
+    element = Nokogiri::HTML.fragment(futurize(partial: "posts/card", locals: {post: post}, eager: true) {})
+    assert_equal "true", element.children.first["data-eager"]
+  end
+
+  test "renders an eager loading data attribute for an empty placeholder block" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post, eager: true) {})
+
+    assert_equal "true", element.children.first["data-eager"]
+
+    element = Nokogiri::HTML.fragment(futurize(partial: "posts/card", locals: {post: post}))
+    assert_equal "true", element.children.first["data-eager"]
+  end
+
+  test "renders a collection" do
+    Post.create title: "Lorem"
+    Post.create title: "Lorem2"
+
+    element = Nokogiri::HTML.fragment(futurize(collection: Post.all) {})
+
+    assert_equal({post: "gid://dummy/Post/1", post_counter: 0}, Futurism::MessageVerifier.message_verifier.verify(element.children.first["data-signed-params"])[:locals])
+    assert_equal({post: "gid://dummy/Post/2", post_counter: 1}, Futurism::MessageVerifier.message_verifier.verify(element.children.last["data-signed-params"])[:locals])
+  end
+
+  test "renders a collection with multi-word object" do
+    ActionItem.create description: "Do this"
+    ActionItem.create description: "Do that"
+
+    element = Nokogiri::HTML.fragment(futurize(collection: ActionItem.all) {})
+
+    assert_equal({action_item: "gid://dummy/ActionItem/1", action_item_counter: 0}, Futurism::MessageVerifier.message_verifier.verify(element.children.first["data-signed-params"])[:locals])
+    assert_equal({action_item: "gid://dummy/ActionItem/2", action_item_counter: 1}, Futurism::MessageVerifier.message_verifier.verify(element.children.last["data-signed-params"])[:locals])
+  end
+
+  test "renders a collection of items with a broadcast_each attribute" do
+    Post.create title: "Lorem"
+    Post.create title: "Lorem2"
+
+    element = Nokogiri::HTML.fragment(futurize(collection: Post.all, broadcast_each: true) {})
+
+    assert_equal "true", element.children.first["data-broadcast-each"]
+    assert_equal "true", element.children.last["data-broadcast-each"]
+  end
+
+  test "renders contextual placeholder arguments for an ActiveRecord::Base" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post) { |post| post.title })
+
+    assert_equal "Lorem", element.children.first.children.first.text
+  end
+
+  test "renders contextual placeholder arguments for an ActiveRecord::Relation" do
+    Post.create title: "Lorem"
+    Post.create title: "Ipsum"
+
+    element = Nokogiri::HTML.fragment(futurize(Post.all, broadcast_each: true) { |post, index| "#{index + 1}. #{post.title}" })
+
+    assert_equal "1. Lorem", element.children.first.children.first.text
+    assert_equal "2. Ipsum", element.children.last.children.first.text
+  end
+
+  test "renders contextual placeholder arguments for any kind of collection" do
+    Post.create title: "Lorem"
+    Post.create title: "Ipsum"
+
+    element = Nokogiri::HTML.fragment(futurize(collection: Post.all, broadcast_each: true) { |post, index| "#{index + 1}. #{post.title}" })
+
+    assert_equal "1. Lorem", element.children.first.children.first.text
+    assert_equal "2. Ipsum", element.children.last.children.first.text
+  end
+
+  test "allows to bypass futurism operation by specifying an unless option" do
+    post = Post.create title: "Lorem"
+
+    element = Nokogiri::HTML.fragment(futurize(post, extends: :tr, unless: true) {})
+
+    refute_equal "futurism-tr", element.children.first["is"]
+    assert_includes element.children.first.children.first.text, "Lorem"
+  end
+
+  def verifier
+    Futurism::MessageVerifier.message_verifier
+  end
+
+  def extract_params(params)
+    verifier.verify(params)
+  end
+
+  def sign_params(params)
+    verifier.generate(params)
+  end
+end

data/test/integration/navigation_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  # test "the truth" do
+  #   assert true
+  # end
+end

data/test/resolver/controller/renderer_test.rb

@@ -0,0 +1,120 @@
+require "test_helper"
+
+class DummyController < ActionController::Base
+  def name_helper
+    "FUTURISM".freeze
+  end
+  helper_method :name_helper
+
+  def controller_and_action_helper
+    [params["controller"], params["action"]].join(":")
+  end
+  helper_method :controller_and_action_helper
+
+  def name_from_params_helper
+    params["name"]
+  end
+  helper_method :name_from_params_helper
+end
+
+def dummy_connection
+  connection = Minitest::Mock.new
+  connection.expect(:env, {"HTTP_VAR" => "HTTP_VAR_VALUE"})
+  connection
+end
+
+class Futurism::Resolver::Controller::RendererTest < ActiveSupport::TestCase
+  include Rails.application.routes.url_helpers
+
+  test ".for controller configures renderer" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: ApplicationController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org?someParam=1234",
+                                                            params: {"SOME" => "SOME_VALUE"})
+    assert_equal renderer.controller, ApplicationController
+
+    assert_equal renderer.render(inline: "<%= request.env['HTTP_VAR'] %>"), "HTTP_VAR_VALUE"
+    assert_equal renderer.render(inline: "<%= params['someParam'] %>"), "1234"
+    assert_equal renderer.render(inline: "<%= params['SOME'] %>"), "SOME_VALUE"
+  end
+
+  test ".for controller configures renderer using the passed in controller" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: DummyController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org?someParam=1234",
+                                                            params: {"SOME" => "SOME_VALUE"})
+    assert_equal renderer.controller, DummyController
+
+    assert_equal renderer.render(inline: "<%= request.env['HTTP_VAR'] %>"), "HTTP_VAR_VALUE"
+    assert_equal renderer.render(inline: "<%= params['someParam'] %>"), "1234"
+    assert_equal renderer.render(inline: "<%= params['SOME'] %>"), "SOME_VALUE"
+  end
+
+  test "renderer.render resolves helper methods" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: DummyController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org?name=the%20future",
+                                                            params: {})
+
+    rendered_html = renderer.render(inline: "Hi <%= name_helper %>")
+
+    assert_equal rendered_html, "Hi FUTURISM"
+  end
+
+  test "renderer.render resolves helper methods that rely on params from controller" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: DummyController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org?name=the%20future!",
+                                                            params: {})
+
+    rendered_html = renderer.render(inline: "Hi <%= controller_and_action_helper %>")
+
+    assert_equal rendered_html, "Hi home:index"
+  end
+
+  test "renderer.render resolves helper methods that rely on params from url" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: DummyController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org?name=the%20future!",
+                                                            params: {})
+    rendered_html = renderer.render(inline: "Hi <%= name_from_params_helper %>")
+
+    assert_equal rendered_html, "Hi the future!"
+  end
+
+  test "renderer.render renders partials that contain a link_to helper" do
+    post = Post.create(title: "Lorem")
+
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: ApplicationController,
+                                                            connection: dummy_connection,
+                                                            url: "http://www.example.org",
+                                                            params: {})
+
+    rendered_html = renderer.render(inline: "<%= link_to post_path(id: #{post.id}) %>")
+
+    assert_equal rendered_html, "<a href=\"/\">/posts/1</a>"
+  end
+
+  ["get", "put", "patch", "post", "delete"].each do |http_method|
+    test "renderer.render handles an #{http_method} route" do
+      renderer = Futurism::Resolver::Controller::Renderer.for(controller: ApplicationController,
+                                                              connection: dummy_connection,
+                                                              url: "http://example.org/known/#{http_method}",
+                                                              params: {})
+
+      rendered_html = renderer.render(inline: "<%= request.url %>")
+      assert_equal rendered_html, "http://example.org/known/#{http_method}"
+    end
+  end
+
+  test "renderer.render handles an umatchable url" do
+    renderer = Futurism::Resolver::Controller::Renderer.for(controller: ApplicationController,
+                                                            connection: dummy_connection,
+                                                            url: "http://example.org/unknown/place",
+                                                            params: {})
+
+    assert_nothing_raised do
+      renderer.render(inline: "<%= request.url %>")
+    end
+  end
+end

data/test/resolver/controller_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class DummyController < ActionController::Base; end
+
+class Futurism::Resolver::ControllerTest < ActiveSupport::TestCase
+  test ".from defaults to ApplicationController" do
+    controller = Futurism::Resolver::Controller.from(signed_string: nil)
+    assert_equal controller, ApplicationController
+  end
+
+  test ".from uses Futurism.default_controller" do
+    Futurism.default_controller = DummyController
+    controller = Futurism::Resolver::Controller.from(signed_string: nil)
+
+    assert_equal controller, DummyController
+
+    Futurism.default_controller = nil
+  end
+
+  test ".from lookups up controller via signed_string:" do
+    signed_controller_string = Futurism::MessageVerifier.message_verifier.generate(DummyController.to_s)
+    controller = Futurism::Resolver::Controller.from(signed_string: signed_controller_string)
+
+    assert_equal controller, DummyController
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require_relative "../test/dummy/config/environment"
+require "rails/test_help"
+require "minitest/mock"
+require "nokogiri"
+require "pry"
+
+# Filter out the backtrace from minitest while preserving the one from other libraries.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+# Turn off logger output as to not have poor test output
+Futurism.logger = Logger.new(IO::NULL)