brut 0.5.0 → 0.8.0

data/mkbrut/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/mkbrut/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/mkbrut/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/mkbrut/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/mkbrut/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.cs.valueMissing", field: this_field)
+    )
+    expect(message_error_message).to have_text(
+      t("cv.cs.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.ss.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/mkbrut/templates/segments/Demo/specs/factories/db/guestbook_message.factory.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/mkbrut/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/mkbrut/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: :valueMissing)
+        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_generated(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_generated(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_generated(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/mkbrut/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/mkbrut/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/mkbrut/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

data/mkbrut/templates/segments/Heroku/bin/deploy

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler"
+Bundler.require
+require "pathname"
+require "brut/cli/apps/heroku_container_based_deploy"
+
+exit Brut::CLI.app(
+  Brut::CLI::Apps::HerokuContainerBasedDeploy,
+  project_root: Pathname($0).dirname / ".."
+)

data/mkbrut/templates/segments/Heroku/deploy/Dockerfile

@@ -0,0 +1,125 @@
+# This is a multi-stage build, meaning one image will be built that
+# has necessarily dev tools in it, and that image is used to create artifacts
+# that will be copied into the second build, which will create the image
+# you deploy to production.
+#
+# # Maintaing this file
+#
+# You own this file now.  While there could be a way to create it from
+# the Dockerfile.dx, for now, you'll need to stay on top of it:
+#
+# 1 - ensure the versions of Ruby match
+# 2 - ensure the versions of NodeJS match
+# 3 - ensure that anything you installed in Dockerfile.dx to make 
+#     the app work or to pre-generate assets is set up here as well.
+#     You are advised to make that setup identical.
+#
+# You can test this locally but using the `--plaform` flag to `bin/deploy deploy`
+# and running a container locally.  You'll need all infrastructure available
+# but it can be done to test things before you deploy. If you need to.
+
+# Use Ruby 3.4 as a base.
+FROM docker.io/library/ruby:3.4 AS base
+
+# bin/deploy will inject this value so that your app's GIT SHA1
+# is in the environment in production, thus allowing you to be more
+# sure of what's actually running.
+ARG app_git_sha1
+
+WORKDIR /brut-app
+
+# Install base packages
+#
+# - ca-certificates is needed for other installs 
+# - curl is needed generally for other installs and by Heroku
+# - gnupg is a PGP replacement used in making sure new APT repos work
+# - libjemalloc2 in theory speeds up Ruby
+# - lsb-release is used to generically access information for this OS's version
+# - wget allows us to copy/paste commands from vendors about how to install
+#   software even though it does the same thing as curl
+RUN apt-get update --quiet --yes && \
+    apt-get install --no-install-recommends --quiet --yes \
+      ca-certificates \
+      curl \
+      gnupg \
+      libjemalloc2 \
+      lsb-release \
+      rsync \
+      wget && \
+		rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Install the PostgreSQL client.  The latest version is not available
+# from Debian, so we set up our own. This should match what's in Dockerfile.dx
+# and ideally the version of Postgres used in production.
+#
+# Incancation is based on: https://www.postgresql.org/download/linux/debian/
+RUN sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    apt-get update && \
+    apt-get --yes --quiet install postgresql-client-16 && \
+		rm -rf /var/lib/apt/lists /var/cache/apt/archives
+
+# Set basic env vars for production
+ENV RACK_ENV="production" \
+    BUNDLE_DEPLOYMENT="1" \
+    BUNDLE_PATH="/usr/local/bundle" \
+    BUNDLE_WITHOUT="development" \
+    APP_GIT_SHA1="${app_git_sha1}"
+
+# This makes a new image that we'll throw away after building
+# needed artifacts.
+FROM base AS build
+
+# - build-essential is needed for almost any build tool we have to install
+# - git is needed to install some things
+# - libpq-dev is needed by postgres
+# - pkg-config is, I guess, not considered "essential" (as in build-essential),
+#   but still needed to install downstream stuff
+RUN apt-get update --quiet --yes && \
+    apt-get install --no-install-recommends --quiet --yes \
+			build-essential \
+			git \
+      libpq-dev \
+			pkg-config
+
+# Install NodeJS, per https://nodejs.org/en/download
+RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash && \
+    \. "$HOME/.nvm/nvm.sh" && \
+    nvm install 22 && \
+    node -v && nvm current && npm -v
+
+# Copy the app into the file, excluding the contents of .dockerignore
+COPY . .
+
+# Install RubyGems from app's Gemfile
+RUN bundle install --verbose && \
+    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git
+
+# Install Node Modules from package.json
+RUN \. "$HOME/.nvm/nvm.sh" && \
+    nvm use default && \
+    npm clean-install --no-audit --no-fund --verbose
+
+# Build all assets
+RUN \. "$HOME/.nvm/nvm.sh" && \
+    nvm use default && \
+    bin/build-assets && \
+    rm -rf node_modules
+
+# We are now switching back to building the image that will be deployed.
+
+FROM base
+# Copy built artifacts from the throwaway image: gems, application
+COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
+COPY --from=build /brut-app /brut-app
+
+# For security, set directories that will be written to be owned by non-root
+RUN groupadd --system --gid 1000 brut && \
+    useradd brut --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
+    chown -R brut:brut logs tmp
+USER 1000:1000
+
+# This is used to execute other commands.  When the app is run in production,
+# this script is used to run it.
+ENTRYPOINT ["/brut-app/deploy/docker-entrypoint"]
+

data/mkbrut/templates/segments/Heroku/deploy/docker-entrypoint

@@ -0,0 +1,15 @@
+#!/bin/bash -e
+
+# This is the Docker entrypoint, mean this script is used to execute
+# the command given to the RUN directive.
+#
+# The reason this exists is to load jemalloc. If you don't want to use
+# jemalloc, you can delete this script, as well as the ENTRYPOINT directive
+# in deploy/Dockerfile.
+
+# Enable jemalloc for reduced memory usage and latency.
+if [ -z "${LD_PRELOAD+x}" ] && [ -f /usr/lib/*/libjemalloc.so.2 ]; then
+  export LD_PRELOAD="$(echo /usr/lib/*/libjemalloc.so.2)"
+fi
+
+exec "${@}"

data/mkbrut/templates/segments/Heroku/deploy/heroku_config.rb

@@ -0,0 +1,26 @@
+# This contains settings for your Heroku setup.
+# You own and maintain this file.  It is required by
+# build/deploy
+class HerokuConfig
+
+  # Return a Hash oif additional images to run, beyond "web" and "release".
+  #
+  # The format of this Hash is:
+  #
+  # {
+  #   "«image name» => {
+  #     cmd: "«command line for Dockerfile RUN directive»",
+  #   }
+  # }
+  #
+  # For example, if you have the Sidekiq segment installed, `bin/run-sidekiq`
+  # runs Sidekiq, so you would return this hash:
+  #
+  # {
+  #   "sidekiq" => {
+  #     cmd: "bin/run-sidekiq",
+  #   }
+  # }
+  def self.additional_images = {}
+end
+