mkbrut 0.1.0

data/templates/segments/BareBones/specs/front_end/js/Example.spec.js.erb

@@ -0,0 +1,38 @@
+import { withHTML } from "./SpecHelper.js"
+
+// Autonomouse custom element support is very basic.
+// In this spec, we use `withHTML` which was defined in SpecHelper.js,
+// which ultimately uses `createTestBasedOnHTML` from BrutJS.
+// This will configure JSDom with the HTML you provide, then execute
+// your test as if that HTML is the document.
+describe("<<%= prefix %>-example>", () => {
+
+  // The example custom element will transform its contents to 
+  // either upper or lower case. In this test, we assert that, by
+  // default, it transforms to upper case. To do that,
+  // create an HTML document you can see below.  The element
+  // will have been connected (connectedCallback will have been 
+  // called) by the time the test executes.  Thus, 
+  // document.querySelector(...) will find the element and its
+  // .textContent will have already been transformed.
+  withHTML(`
+  <<%= prefix %>-example>This is some Text</<%= prefix %>-example>
+  `).test("upper case by default", ({document,assert}) => {
+    const element = document.querySelector("<%= prefix %>-example")
+    assert.equal(element.textContent,"THIS IS SOME TEXT")
+  })
+
+  withHTML(`
+  <<%= prefix %>-example transform="lower">This is some Text</<%= prefix %>-example>
+  `).test("lower case when asked", ({document,assert}) => {
+    const element = document.querySelector("<%= prefix %>-example")
+    assert.equal(element.textContent,"this is some text")
+    // Remember that setAttribute is synchronous, so by the time
+    // its done executing, attributeChangedCallback will have been called,
+    // and thus the element's `update()` method will have been called and
+    // its textContent transformed.
+    element.setAttribute("transform","upper")
+    assert.equal(element.textContent,"THIS IS SOME TEXT")
+  })
+})
+

data/templates/segments/Demo/app/src/back_end/data_models/db/guestbook_message.rb

@@ -0,0 +1,3 @@
+class DB::GuestbookMessage < AppDataModel
+  has_external_id "gm"
+end

data/templates/segments/Demo/app/src/back_end/data_models/migrations/20250628194124_guestbook.rb

@@ -0,0 +1,15 @@
+Sequel.migration do
+  up do
+    run %{CREATE EXTENSION IF NOT EXISTS citext}
+    create_table :guestbook_messages,
+      comment: "Messages people have left in the guestbook",
+      external_id: true do 
+
+      column :name, :text
+      column :message, :text
+      column :ip_address, :inet
+
+      key [ :ip_address ]
+    end
+  end
+end

data/templates/segments/Demo/app/src/front_end/components/flash_component.rb

@@ -0,0 +1,36 @@
+class FlashComponent < AppComponent
+  def initialize(flash:)
+    @flash = flash
+  end
+
+  CLASSES = [
+    "f-1",
+    "fw-bold",
+    "w-50",
+    "mv-3",
+    "shadow-3",
+    "pa-3",
+    "ba",
+    "br-3",
+    "tc"
+  ]
+  COLORS = [
+    "%{color}-300",
+    "bg-%{color}-800",
+    "bc-%{color}-700",
+  ]
+
+  def view_template
+    if @flash.notice?
+      div(role: "status",
+          class: CLASSES + COLORS.map { it % { color: "blue" } }) do
+        t(@flash.notice)
+      end
+    elsif @flash.alert?
+      div(role: "alert",
+          class: CLASSES + COLORS.map { it % { color: "orange" } }) do
+        t(@flash.alert)
+      end
+    end
+  end
+end

data/templates/segments/Demo/app/src/front_end/css/constraint-violations.css

@@ -0,0 +1,18 @@
+/* Hide <brut-cv> tags so that we don't see
+ * client-side errors before the form is submitted */
+brut-cv {
+  display: none;
+  color: var(--red-400);
+}
+
+/* Server-side errors are always visible */
+brut-cv[server-side] {
+  display: block;
+}
+
+/* Only when a form submission is attempted do 
+ * we show the <brut-cv>s that are not server-side,
+ * and thus client-side */
+brut-form[submitted-invalid] brut-cv {
+  display: block;
+}

data/templates/segments/Demo/app/src/front_end/forms/guestbook_message_form.rb

@@ -0,0 +1,4 @@
+class GuestbookMessageForm < AppForm
+  input :name, minlength: 2
+  input :message, minlength: 10
+end

data/templates/segments/Demo/app/src/front_end/handlers/guestbook_message_handler.rb

@@ -0,0 +1,64 @@
+class GuestbookMessageHandler < AppHandler
+  def initialize(form:, flash:, rack_request_ip:, session:)
+    @form            = form
+    @flash           = flash
+    @rack_request_ip = rack_request_ip
+    @session         = session
+  end
+  def handle
+    # If client-side constraint violation checking was skipped,
+    # but there ARE such violations, the form will be able to check
+    # that server-side and return true for #constraint_violations?
+    if !@form.constraint_violations?
+      save_message
+    end
+
+    if @form.constraint_violations?
+      @flash.alert = :guestbook_not_saved
+      return NewGuestbookMessagePage.new(form: @form,
+                                         session: @session)
+    else
+      @flash.notice = :guestbook_saved
+      redirect_to(
+        GuestbookPage,
+        anchor: @session.guestbook_message&.external_id
+      )
+    end
+  end
+
+private
+
+  def save_message
+    # While we don't recommend business logic be placed
+    # inside handlers, we're leaving it here to avoid
+    # anchoring you on any particular way of managing
+    # the logic in your app.
+    if @form.message.split(/\s+/).length < 2
+      @form.server_side_constraint_violation(
+        input_name: "message",
+        key: :not_enough_words
+      )
+    else
+      if DB::GuestbookMessage.find(ip_address: @rack_request_ip)
+        @form.server_side_constraint_violation(
+          input_name: "name",
+          key: :already_posted
+        )
+      else
+        begin
+          guestbook_message = DB::GuestbookMessage.create(
+            name: @form.name,
+            message: @form.message,
+            ip_address: @rack_request_ip,
+          )
+          @session.signed_guestbook(guestbook_message)
+        rescue Sequel::UniqueConstraintViolation => ex
+          @form.server_side_constraint_violation(
+            input_name: "name",
+            key: :already_posted
+          )
+        end
+      end
+    end
+  end
+end

data/templates/segments/Demo/app/src/front_end/pages/guestbook_page/message_component.rb

@@ -0,0 +1,41 @@
+class GuestbookPage::MessageComponent < AppComponent
+  def initialize(message:, index:, current_visitor_message: false)
+    @message = message
+    @current_visitor_message = current_visitor_message
+    @background_color = [
+      "bg-gray-800",
+      "bg-blue-800",
+      "bg-green-800",
+      "bg-yellow-800",
+    ][index % 4]
+  end
+
+  def view_template
+    div_classes = [
+      "measure",
+      "mh-auto",
+      "pa-3",
+      "br-4",
+      "br-tr-0",
+      "br-bl-0",
+      "mt-3",
+      @background_color,
+    ]
+    border_class = if @current_visitor_message
+                     div_classes << "ba" << "bc-gray-600" << "bw-2"
+                   else
+                     div_classes << "bn"
+                   end
+    div(class: div_classes, id: @message.external_id) do
+      blockquote(class: "ff-cursive p mh-auto i f-4") do
+        @message.message
+      end
+      p(class: "p mh-auto tr f-2") do
+        plain("—")
+        plain(@message.name)
+        plain(" on ")
+        TimeTag(date: @message.created_at, format: :date, class: "gray-400 f-1 ttu")
+      end
+    end
+  end
+end

data/templates/segments/Demo/app/src/front_end/pages/guestbook_page.rb

@@ -0,0 +1,43 @@
+class GuestbookPage < AppPage
+
+  def initialize(session:)
+    @session = session
+  end
+
+  def page_template
+    div(class: "flex flex-column items-center ff-sans") do
+      article(class: "w-50 pv-3 bt bc-gray-700", id: "guestbook") do
+        h2(class: "ff-sans ma-0 lh-title f-4 tc") do
+          "Check out the Guestbook!"
+        end
+        if !@session.signed_guestbook?
+          a(
+            href: NewGuestbookMessagePage.routing,
+            class: "db tc mv-3 f-2 fw-5 blue-300"
+          ) do
+            "Sign it, yourself!"
+          end
+        else
+          a(
+            href: "##{@session.guestbook_message.external_id}",
+            class: "db tc mv-3 f-2 fw-5 blue-300"
+          ) do
+            "Check out your message"
+          end
+
+        end
+        DB::GuestbookMessage.order(
+          Sequel.function(:random)
+        ).each_with_index do |message,index|
+          render(
+            GuestbookPage::MessageComponent.new(
+              message:,
+              index:,
+              current_visitor_message: message == @session.guestbook_message
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/templates/segments/Demo/app/src/front_end/pages/new_guestbook_message_page.rb

@@ -0,0 +1,64 @@
+class NewGuestbookMessagePage < AppPage
+  def initialize(form: nil, session:)
+    @form    = form || GuestbookMessageForm.new
+    @session = session
+  end
+
+  def before_generate
+    if @session.signed_guestbook?
+      redirect_to(GuestbookPage)
+    end
+  end
+
+  def page_template
+    div(class: "flex flex-column items-center ff-sans") do
+      render global_component(FlashComponent)
+      div(class: "w-50 mv-5") do
+        brut_form(class: "w-100") do
+          FormTag(for: @form, class: "flex flex-column gap-3 items-end") do
+            h1(class: "ff-sans ma-0 lh-title f-5 self-start flex items-center gap-3") do
+              img(src: "/static/images/icon.png", class: "w-5")
+              span { "Sign The Guestbook" }
+            end
+            label(class: "flex flex-column gap-1 w-100") do
+              Inputs::InputTag(
+                form: @form,
+                input_name: "name",
+                placeholder: "e.g. Pat",
+                class: "f-3 pa-2 inset-shadow-1 br-2",
+                "data-1p-ignore": true
+              )
+              div(class: "flex items-start gap-3") do
+                span { "Your Message" }
+                ConstraintViolations(
+                  form: @form,
+                  input_name: "name"
+                )
+              end
+
+            end
+            label(class: "flex flex-column gap-1 w-100") do
+              Inputs::TextareaTag(
+                form: @form,
+                input_name: "message",
+                placeholder: "e.g. What a great site!",
+                rows: 6,
+                class: "f-3 pa-2 inset-shadow-1 br-2"
+              )
+              div(class: "flex items-start gap-3") do
+                span { "Your Message" }
+                ConstraintViolations(
+                  form: @form,
+                  input_name: "message"
+                )
+              end
+            end
+            button(class: "bg-green-900 green-300 ph-5 pv-3 f-3 ba bc-green-600 br-pill shadow-1 pointer") do
+              "Sign!"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/templates/segments/Demo/specs/back_end/data_models/db/guestbook_message.spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe DB::GuestbookMessage do
+  implementation_is_trivial
+end

data/templates/segments/Demo/specs/e2e/guest_message.spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+RSpec.describe "You can leave a guestbook message" do
+  it "accepts your message after validation, then shows it with the others" do
+    page.goto(HomePage.routing)
+
+    link = page.locator("a[href='#{NewGuestbookMessagePage.routing}']")
+
+    link.click
+
+    expect(page).to be_page_for(NewGuestbookMessagePage)
+
+    button = page.locator("form button")
+
+    button.click
+    expect(page).to be_page_for(NewGuestbookMessagePage)
+
+    name_error_message    = page.locator("brut-cv-messages[input-name='name']")
+    message_error_message = page.locator("brut-cv-messages[input-name='message']")
+
+    this_field = t("cv.this_field")
+
+    expect(name_error_message).to    have_text(
+      t("cv.fe.valueMissing", field: this_field)
+    )
+    expect(message_error_message).to have_text(
+      t("cv.fe.valueMissing", field: this_field)
+    )
+
+    name_field    = page.locator("form input[name='name']")
+    message_field = page.locator("form textarea[name='message']")
+
+    name_field.fill("Pat")
+    message_field.fill("FIRSTPOST!")
+
+    button.click
+    expect(page).to be_page_for(NewGuestbookMessagePage)
+    
+    flash = page.locator("[role='alert']")
+    expect(flash).to have_text(t(:guestbook_not_saved))
+    expect(message_error_message).to have_text(
+      t("cv.be.not_enough_words", field: this_field)
+    )
+
+    message_field.fill("OK, fine, this site is awesome!")
+    button.click
+
+    expect(page).to be_page_for(GuestbookPage)
+
+    quotes = page.locator("blockquote")
+    expect(quotes).to have_text("OK, fine, this site is awesome!")
+
+  end
+end

data/templates/segments/Demo/specs/factories/db/guestbook_message.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :guestbook_message, class: "DB::GuestbookMessage" do
+    name       { Faker::Name.name }
+    message    { Faker::Lorem.paragraph }
+    ip_address { Faker::Internet.unique.ip_v4_address }
+  end
+end

data/templates/segments/Demo/specs/front_end/components/flash_component.spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe FlashComponent do
+  implementation_is_trivial
+end

data/templates/segments/Demo/specs/front_end/handlers/guestbook_message_handler.spec.rb

@@ -0,0 +1,122 @@
+require "spec_helper"
+
+RSpec.describe GuestbookMessageHandler do
+  describe "#handle!" do
+    context "there are client-side constraint violations" do
+      it "generates the new guestbook message page" do
+        form            = GuestbookMessageForm.new(params: {})
+        flash           = empty_flash
+        session         = empty_session
+        rack_request_ip = Faker::Internet.ip_v4_address
+
+        confidence_check do
+          expect(form).to have_constraint_violation(:name,key: :value_missing)
+        end
+
+        handler = described_class.new(
+          form:,
+          flash:,
+          session:,
+          rack_request_ip:
+        )
+        result = nil
+        expect {
+          result = handler.handle
+        }.not_to change { DB::GuestbookMessage.count }
+
+        expect(result).to have_rendered(NewGuestbookMessagePage)
+        expect(flash.alert).to eq("guestbook_not_saved")
+      end
+    end
+    context "there are server-side constraint violations" do
+      it "indicates a server-side error and generates the new guestbook message page" do
+        form            = GuestbookMessageForm.new(params: {
+          name: "Pat",
+          message: "FIRSTPOST!!!!",
+        })
+        flash           = empty_flash
+        session         = empty_session
+        rack_request_ip = Faker::Internet.ip_v4_address
+
+        handler = described_class.new(
+          form:,
+          flash:,
+          session:,
+          rack_request_ip:
+        )
+        result = nil
+        expect {
+          result = handler.handle
+        }.not_to change { DB::GuestbookMessage.count }
+
+        expect(result).to have_rendered(NewGuestbookMessagePage)
+        expect(form).to have_constraint_violation(:message, key: :not_enough_words)
+        expect(flash.alert).to eq("guestbook_not_saved")
+      end
+    end
+    context "the ip address has already been used" do
+
+      it "indicates a server-side error and generates the new guestbook message page" do
+        existing_message = create(:guestbook_message)
+
+        form            = GuestbookMessageForm.new(params: {
+          name: "Pat",
+          message: "This website is amazing!",
+        })
+        flash           = empty_flash
+        session         = empty_session
+        rack_request_ip = existing_message.ip_address
+
+        handler = described_class.new(
+          form:,
+          flash:,
+          session:,
+          rack_request_ip:
+        )
+        result = nil
+        expect {
+          result = handler.handle
+        }.not_to change { DB::GuestbookMessage.count }
+
+        expect(result).to have_rendered(NewGuestbookMessagePage)
+        expect(form).to have_constraint_violation(:name, key: :already_posted)
+        expect(flash.alert).to eq("guestbook_not_saved")
+      end
+    end
+    context "no constraint violations, unused ip address" do
+      it "saves the message and redirects back to the guestbook page" do
+        form            = GuestbookMessageForm.new(params: {
+          name: "Pat",
+          message: "This website is amazing!",
+        })
+        flash           = empty_flash
+        session         = empty_session
+        rack_request_ip = Faker::Internet.ip_v4_address
+
+        handler = described_class.new(
+          form:,
+          flash:,
+          session:,
+          rack_request_ip:
+        )
+        result = nil
+        expect {
+          result = handler.handle
+        }.to change { DB::GuestbookMessage.count }.by(1)
+
+        message = DB::GuestbookMessage.order(Sequel.desc(:created_at)).first
+
+        expect(message.name).to       eq("Pat")
+        expect(message.message).to    eq("This website is amazing!")
+        expect(message.ip_address).to eq(rack_request_ip)
+
+        expect(result).to       have_redirected_to(GuestbookPage,
+                                                   anchor: message.external_id)
+        expect(form).not_to     have_constraint_violation(:name,
+                                                          key: :already_posted)
+        expect(flash.notice).to eq("guestbook_saved")
+
+      end
+    end
+  end
+end

data/templates/segments/Demo/specs/front_end/pages/guestbook_page/message_component.spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe GuestbookPage::MessageComponent do
+  implementation_is_covered_by_other_tests "e2e tests and page's test"
+end

data/templates/segments/Demo/specs/front_end/pages/guestbook_page.spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+RSpec.describe GuestbookPage do
+  it "shows current guestbook messages" do
+    messages = 5.times.map {
+      create(:guestbook_message)
+    }
+    confidence_check { expect(DB::GuestbookMessage.all.length).to eq(5) }
+
+    result = generate_and_parse(self.described_class.new(session: empty_session))
+
+    message_elements = result.css("div:has(> blockquote)")
+    expect(message_elements.length).to eq(5)
+    messages.each do |message|
+      element = message_elements.select {
+        it.css("blockquote").text.strip == message.message
+      }
+      expect(element.size).to eq(1),
+        "Found #{element.size} blockquotes for message #{message.external_id}, instead of exactly 1" 
+      expect(element[0].css("p").text).to include(message.name)
+    end
+  end
+  context "when you've signed the guestbook" do
+    it "shows a link to view your message and not a link to make one" do
+      message = create(:guestbook_message)
+      session = empty_session
+
+      session.signed_guestbook(message)
+
+      result = generate_and_parse(self.described_class.new(session:))
+
+      add_link = result.e("a[href='#{NewGuestbookMessagePage.routing}']")
+      expect(add_link).to eq(nil)
+
+      view_link = result.e("a[href='##{message.external_id}']")
+      expect(view_link).not_to eq(nil)
+    end
+  end
+  context "when you have not signed the guestbook" do
+    it "shows a link to view your message and not a link to make one" do
+      message = create(:guestbook_message)
+
+      result = generate_and_parse(self.described_class.new(session: empty_session))
+
+      add_link = result.e("a[href='#{NewGuestbookMessagePage.routing}']")
+      expect(add_link).not_to eq(nil)
+
+      view_link = result.e("a[href='##{message.external_id}']")
+      expect(view_link).to eq(nil)
+    end
+  end
+end

data/templates/segments/Demo/specs/front_end/pages/new_guestbook_message_page.spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+RSpec.describe NewGuestbookMessagePage do
+  implementation_is_covered_by_other_tests "e2e tests"
+end