Merge pull request #390 from basecamp/markdown-out

Markdown out

Author: dhh

AGENTS.md

@@ -0,0 +1,59 @@
+# Agent Guidelines
+
+## Testing Conventions
+
+### Use Existing Fixtures
+Prefer using existing fixtures over creating new records in tests. For example, use `leaves(:welcome_page)` instead of `books(:handbook).press Page.new(body: "..."), title: "..."`.
+
+### URL Helpers in Tests
+Use `_path` helpers instead of `_url` helpers in controller/integration tests unless you need to test across different hosts or explicitly need the full URL.
+
+**Preferred:**
+```ruby
+get book_slug_path(books(:handbook))
+```
+
+**Avoid:**
+```ruby
+get book_slug_url(books(:handbook))
+```
+
+### Response Body Assertions
+Use `assert_in_body` and `assert_not_in_body` to check if text is present or absent in the response body without DOM manipulation.
+
+**Preferred:**
+```ruby
+assert_in_body "Expected content"
+assert_not_in_body "Unexpected content"
+```
+
+**Avoid:**
+```ruby
+assert_includes response.body, "Expected content"
+assert_not_includes response.body, "Unexpected content"
+```
+
+## Controller Conventions
+
+### Simplified respond_to Blocks
+When using `respond_to` with default rendering, omit the `{ render }` block as it's implied.
+
+**Preferred:**
+```ruby
+def show
+  respond_to do |format|
+    format.html
+    format.md
+  end
+end
+```
+
+**Avoid:**
+```ruby
+def show
+  respond_to do |format|
+    format.html { render }
+    format.md { render }
+  end
+end
+```

app/controllers/books_controller.rb

@@ -23,6 +23,11 @@ def create
 
   def show
     @leaves = @book.leaves.active.with_leafables.positioned
+
+    respond_to do |format|
+      format.html
+      format.md
+    end
   end
 
   def edit

app/controllers/leafables_controller.rb

@@ -16,6 +16,10 @@ def create
   end
 
   def show
+    respond_to do |format|
+      format.html
+      format.md
+    end
   end
 
   def edit

app/models/book.rb

@@ -12,4 +12,8 @@ class Book < ApplicationRecord
   def press(leafable, leaf_params)
     leaves.create! leaf_params.merge(leafable: leafable)
   end
+
+  def markable
+    leaves.active.positioned.map { it.leafable.markable }.join("\n\n")
+  end
 end

app/models/page.rb

@@ -16,6 +16,10 @@ def html_preview
     rendered_html(markdown_source.first(1024))
   end
 
+  def markable
+    body.content.to_s
+  end
+
   private
     def plain_text
       html_body = rendered_html(markdown_source)

app/models/picture.rb

@@ -4,4 +4,8 @@ class Picture < ApplicationRecord
   has_one_attached :image do |attachable|
     attachable.variant :large, resize_to_limit: [ 1500, 1500 ]
   end
+
+  def markable
+    caption
+  end
 end

app/models/section.rb

@@ -4,4 +4,8 @@ class Section < ApplicationRecord
   def searchable_content
     body
   end
+
+  def markable
+    body
+  end
 end

app/views/books/show.html.erb

@@ -2,6 +2,7 @@
 <% @layout_class = "book" %>
 
 <% content_for :head do %>
+  <%= tag.link rel: "alternate", type: "text/markdown", href: book_slug_path(@book, format: :md) %>
   <%= tag.meta property: "og:title", content: @book.title %>
   <%= tag.meta property: "og:description", content: @book.subtitle %>
   <%= tag.meta property: "og:image", content: @book.cover.blank? ? asset_url("covers/cover-#{@book.theme}-og.png") : "#{root_url}#{url_for(@book.cover)}" %>

app/views/books/show.md.erb

@@ -0,0 +1,7 @@
+---
+title: "<%= @book.title %>"
+author: "<%= @book.author %>"
+url: "<%= book_slug_url(@book) %>"
+---
+
+<%= raw @book.markable %>

app/views/leafables/show.html.erb

@@ -1,5 +1,9 @@
 <% content_for(:title) { page_title(@leaf, @book) } %>
 
+<% content_for :head do %>
+  <%= tag.link rel: "alternate", type: "text/markdown", href: leafable_slug_path(@leaf, format: :md) %>
+<% end %>
+
 <% content_for :header do %>
   <%= render "leaves/header", book: @book, leaf: @leaf %>
 <% end %>