perron 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa4c7af63f95aef3bc25c9ef97a4da02d75486ec3ee975f69a980f66cb34557
-  data.tar.gz: f1c62fff6d0ba6c121da85f463dc32fd5656c884d059d0f2955c6a95a4c0bf3a
+  metadata.gz: 1757232a5830a600f00f1517b0aa26c0f95cc55005c32cdb7865282b522cefec
+  data.tar.gz: ba9a09ab06d80c8cc266c210d51770c5577d079dbfab6226f058c1f39a974505
 SHA512:
-  metadata.gz: 175ecbdc5dc5468e28e0abe13926b578fb6669d078b594da1dea91ab8cce68c3a7f63f12d3be4f0de757d270c5d3a95ce96db925ea9c3cbe238e1dd72069aaa1
-  data.tar.gz: b65f95000da601c8ea2f6dcea2e1cf9edb907d366ff783b3ba37e4b2c2d0ff0222cf98821f7537690895087c39ad0c902397c6325e309e27019914101072b6df
+  metadata.gz: 82e81dbe7b346d47d539ab50b098c1b2542241d8864e3ed0cddf3e565b39785ae6710718a3db158cacaa27e67ea436960b88b012851ec5e85d7c91d3d0baa718
+  data.tar.gz: bdc619b82756afede00259a7f89970bac482a2e7204f2b8a66ad80b798467604b934462fe69d93e9d70e359abc298b0f72fcbf6842dde0258b7aaabe14a5042c

data/Gemfile

@@ -14,4 +14,5 @@ group :development, :test do
   gem "rake", "~> 13.3.0"
   gem "minitest", "~> 5.25", ">= 5.25.5"
   gem "debug", "~> 1.11.0"
+  gem "rouge", "~> 4.6.0"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    perron (0.10.0)
+    perron (0.11.0)
       csv
       json
       psych
@@ -204,6 +204,7 @@ GEM
     regexp_parser (2.10.0)
     reline (0.6.1)
       io-console (~> 0.5)
+    rouge (4.6.0)
     rubocop (1.75.8)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
@@ -267,6 +268,7 @@ DEPENDENCIES
   perron!
   rails (~> 7.2.0)
   rake (~> 13.3.0)
+  rouge (~> 4.6.0)
   standard (~> 1.50.0)
 
 BUNDLED WITH

data/README.md

@@ -13,7 +13,7 @@ A Rails-based static site generator.
 </a>
 
 
-## Getting Started
+## Getting started
 
 ### Installation
 
@@ -47,14 +47,14 @@ Perron can operate in two modes, configured via `config.mode`. This allows you t
 | **Asset Handling** | Via Perron | Via Asset Pipeline |
 
 
-## Creating Content
+## Collections
 
-Perron is, just like Rails, designed with convention over configuration in mind. Content is stored in `app/content/*/*.{erb,md}`. Content is backed by a class, located in `app/models/content/` that inherits from `Perron::Resource`.
+Perron is, just like Rails, designed with convention over configuration in mind. Content is stored in `app/content/*/*.{erb,md,*}` and backed by a class, located in `app/models/content/` that inherits from `Perron::Resource`.
 
 The controllers are located in `app/controllers/content/`. To make them available, create a route: `resources :posts, module: :content, only: %w[index show]`.
 
 
-### Collections
+### Create content
 
 ```bash
 bin/rails generate content Post
@@ -69,29 +69,52 @@ This will create the following files:
 * Adds route: `resources :posts, module: :content, only: %w[index show]`
 
 
-### Setting a Root Page
+### Setting a root page
 
-To set a root page, include `Perron::Root` in your `Content::PagesController` and add a `app/content/pages/root.[md,erb]` file (make sure to set `slug: "/"` in its frontmatter).
+To set a root page, include `Perron::Root` in your `Content::PagesController` and add a `app/content/pages/root.{md,erb,*}` file. This is automatically added for you when you create a `Page` collection.
 
-This is automatically added when you create a `Page` collection.
 
-
-## Markdown Support
+## Markdown support
 
 Perron supports markdown with the `markdownify` helper.
 
-There are no markdown gems bundled by default, so you'll need to add one of these:
+There are no markdown gems bundled by default, so you'll need to add one of these to your `Gemfile`:
 
-- CommonMarker
-- Kramdown
-- Redcarpet
+- `commonmarker`
+- `kramdown`
+- `redcarpet`
 
 ```bash
 bundle add {commonmarker,kramdown,redcarpet}
 ```
 
+### Configuration
+
+To pass options to the parser, set `markdown_options` in `config/initializers/perron.rb`. The options hash is passed directly to the chosen library.
+
+**Commonmarker**
+```ruby
+# Options are passed as keyword arguments.
+Perron.configuration.markdown_options = { options: [:HARDBREAKS], extensions: [:table] }
+```
+
+**Kramdown**
+```ruby
+# Options are passed as a standard hash.
+Perron.configuration.markdown_options = { input: "GFM", smart_quotes: "apos,quot" }
+```
+
+**Redcarpet**
+```ruby
+# Options are nested under :renderer_options and :markdown_options.
+Perron.configuration.markdown_options = {
+  renderer_options: { hard_wrap: true },
+  markdown_options: { tables: true, autolink: true }
+}
+```
+
 
-## HTML Transformations
+## HTML transformations
 
 Perron can post-process the HTML generated from your Markdown content.
 
@@ -100,19 +123,20 @@ Perron can post-process the HTML generated from your Markdown content.
 
 Apply transformations by passing an array of processor names or classes to the `markdownify` helper via the `process` option.
 ```erb
-<%= markdownify @resource.content, process: %w[target_blank lazy_load_images] %>
+<%= markdownify @resource.content, process: %w[lazy_load_images syntax_highlight target_blank] %>
 ```
 
 
-### Available Processors
+### Available processors
 
 The following processors are built-in and can be activated by passing their string name:
 
 - `target_blank`: Adds `target="_blank"` to all external links;
 - `lazy_load_images`: Adds `loading="lazy"` to all `<img>` tags.
+- `syntax_highlight`: Applies syntax highlighting to fenced code blocks (e.g., \`\`\`ruby). This requires adding the `rouge` gem to your Gemfile (`bundle add rouge`). You will also need to include a Rouge CSS theme for colors to appear.
 
 
-### Creating Your Own
+### Creating your own processors
 
 You can create your own processor by defining a class that inherits from `Perron::HtmlProcessor::Base` and implements a `process` method.
 Then, pass the class constant directly in the `process` array.
@@ -184,19 +208,8 @@ Check out our amazing features:
 <% end %>
 ```
 
-**Result:**
-```html
-<p>Check out our amazing features:</p>
-<ul>
-  <li>Rails based</li>
-  <li>SEO friendly</li>
-  <li>Markdown first</li>
-  <li>ERB support</li>
-</ul>
-```
-
 
-## Data Files
+## Data files
 
 Perron can consume structured data from YML, JSON, or CSV files, making them available within your templates.
 This is useful for populating features, team members, or any other repeated data structure.
@@ -211,12 +224,12 @@ To use a data file, instantiate `Perron::Site.data` with the basename of the fil
 <% end %>
 ```
 
-### File Location and Formats
+### File location and formats
 
 By default, Perron looks up `app/content/data/` for files with a `.yml`, `.json`, or `.csv` extension.
 For a `features` call, it would find `features.yml`, `features.json`, or `features.csv`. You can also provide a path to any data file, via `Perron::Data.new("path/to/data.json")`.
 
-### Accessing Data
+### Accessing data
 
 The wrapper object provides flexible, read-only access to each record's attributes. Both dot notation and hash-like key access are supported.
 ```ruby
@@ -224,6 +237,22 @@ feature.name
 feature[:name]
 ```
 
+### Rendering
+
+You can render data collections directly using Rails-like partial rendering. When you call `render` on a data collection, Perron will automatically render a partial for each item.
+```erb
+<%= render Perron::Site.data.features %>
+```
+
+This expects a partial at `app/views/features/_feature.html.erb` that will be rendered once for each feature in your data file. The individual record is made available as a local variable matching the singular form of the collection name.
+```erb
+<!-- app/views/features/_feature.html.erb -->
+<div class="feature">
+  <h4><%= feature.name %></h4>
+  <p><%= feature.description %></p>
+</div>
+```
+
 
 ## Feeds
 
@@ -299,7 +328,7 @@ Or exclude certain tags:
 
 Values are determined with the following precedence, from highest to lowest:
 
-#### 1. Controller Action
+#### 1. Controller action
 
 Define a `@metadata` instance variable in your controller:
 ```ruby
@@ -314,10 +343,9 @@ class Content::PostsController < ApplicationController
 end
 ```
 
-#### 2. Page Frontmatter
+#### 2. Page frontmatter
 
 Add values to the YAML frontmatter in content files:
-
 ```yaml
 ---
 title: My Awesome Post
@@ -331,7 +359,7 @@ Your content here…
 
 #### 3. Collection configuration
 
-Set site-wide defaults in the initializer:
+Set collection defaults in the resource model:
 ```ruby
 class Content::Post < Perron::Resource
   # …
@@ -341,7 +369,7 @@ class Content::Post < Perron::Resource
 end
 ```
 
-#### 4. Default Values
+#### 4. Default values
 
 Set site-wide defaults in the initializer:
 ```ruby
@@ -354,13 +382,13 @@ end
 ```
 
 
-## Related Resources
+## Related resources
 
 The `related_resources` method allows to find and display a list of similar resources
-from the same collection. Similarity is calculated using the **TF-IDF** algorithm on the content of each resource.
+from the sme collection. Similarity is calculated using the **[TF-IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf)** algorithm on the content of each resource.
 
 
-### Basic Usage
+### Basic usage
 
 To get a list of the 5 most similar resources, call the method on any resource instance.
 ```ruby
@@ -372,9 +400,9 @@ To get a list of the 5 most similar resources, call the method on any resource i
 ```
 
 
-## XML Sitemap
+## XML sitemap
 
-A sitemap is an XML file that lists all the pages of a website to help search engines discover and index content more efficiently, typically containing URLs, last modification dates, change frequency, and priority values.
+A sitemap is a XML file that lists all the pages of a website to help search engines discover and index content more efficiently, typically containing URLs, last modification dates, change frequency, and priority values.
 
 Enable it with the following line in the Perron configuration:
 ```ruby
@@ -409,7 +437,7 @@ sitemap_change_frequency: :daily
 ```
 
 
-## Building Your Static Site
+## Building your static site
 
 When in `standalone` mode and you're ready to generate your static site, run:
 ```bash

data/app/helpers/meta_tags_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module MetaTagsHelper
-  def meta_tags(options = {}) = Perron::Metatags.new(resource).render(options)
+  def meta_tags(options = {}) = Perron::Metatags.new(resource.metadata).render(options)
 
   private
 

data/lib/generators/content/templates/root.erb.tt

@@ -1,5 +1,4 @@
 ---
-slug: "/"
 ---
 
 Find me in `app/content/pages/root.erb`

data/lib/generators/perron/install_generator.rb

@@ -18,7 +18,8 @@ module Perron
     def add_markdown_gems
       append_to_file "Gemfile", <<~RUBY
 
-        # Perron can use one of the following gems. Uncomment your preferred choice and run `bundle install`
+        # Perron supports Markdown rendering using one of the following gems.
+        # Uncomment your preferred choice and run `bundle install`
         # gem "commonmarker"
         # gem "kramdown"
         # gem "redcarpet"

data/lib/generators/perron/templates/initializer.rb.tt

@@ -3,14 +3,17 @@ Perron.configure do |config|
 
   # config.site_name = "Helptail"
 
-  # The build mode for Perron. Can be :standalone or :integrated.
+  # The build mode for Perron. Can be :standalone or :integrated
   # config.mode = :standalone
 
-  # In `integrated` mode, the root is skipped by default. Set to `true` to enable.
+  # In `integrated` mode, the root is skipped by default. Set to `true` to enable
   # config.include_root = false
 
   # config.default_url_options = {host: "helptail.com", protocol: "https", trailing_slash: true}
 
+  # The options hash is passed directly to the chosen library
+  # config.markdown_options = {}
+
   # Set default meta values
   # Examples:
   # - `config.metadata.description = "Put your routine tasks on autopilot"`

data/lib/perron/{site/collection.rb → collection.rb}

@@ -5,7 +5,7 @@ module Perron
     attr_reader :name
 
     def initialize(name)
-      @name = name
+      @name = name.inquiry
       @collection_path = File.join(Perron.configuration.input, name)
 
       raise Errors::CollectionNotFoundError, "No such collection: #{name}" unless File.exist?(@collection_path) && File.directory?(@collection_path)
@@ -29,5 +29,11 @@ module Perron
 
       raise Errors::ResourceNotFoundError, "Resource not found with slug: #{slug}"
     end
+
+    def find_by_file_name(file_name, resource_class = Resource)
+      resource_class.new(
+        Perron.configuration.allowed_extensions.lazy.map { File.join(@collection_path, [file_name, it].join(".")) }.find { File.exist?(it) }
+      )
+    end
   end
 end

data/lib/perron/configuration.rb

@@ -28,12 +28,16 @@ module Perron
       @config.exclude_from_public = %w[assets storage]
       @config.excluded_assets = %w[action_cable actioncable actiontext activestorage rails-ujs trix turbo]
 
+      @config.view_unpublished = Rails.env.development?
+
       @config.default_url_options = {
         host: ENV.fetch("PERRON_HOST", "localhost:3000"),
         protocol: ENV.fetch("PERRON_PROTOCOL", "http"),
         trailing_slash: ENV.fetch("PERRON_TRAILING_SLASH", "true") == "true"
       }
 
+      @config.markdown_options = {}
+
       @config.sitemap = ActiveSupport::OrderedOptions.new
       @config.sitemap.enabled = false
       @config.sitemap.priority = 0.5

data/lib/perron/{site/data.rb → data.rb}

@@ -5,6 +5,7 @@ require "csv"
 module Perron
   class Data < SimpleDelegator
     def initialize(identifier)
+      @identifier = identifier
       @file_path = self.class.path_for!(identifier)
       @records = records
 
@@ -47,7 +48,7 @@ module Perron
         raise Errors::DataParseError, "Data in `#{@file_path}` must be an array of objects."
       end
 
-      data.map { Item.new(it) }
+      data.map { Item.new(it, identifier: @identifier) }
     end
 
     def rendered_from(path)
@@ -97,12 +98,23 @@ module Perron
     private_constant :HelperContext
 
     class Item
-      def initialize(attributes)
+      def initialize(attributes, identifier:)
         @attributes = attributes.transform_keys(&:to_sym)
+        @identifier = identifier
       end
 
       def [](key) = @attributes[key.to_sym]
 
+      def to_partial_path
+        @to_partial_path ||= begin
+          identifier = @identifier.to_s
+          collection = File.extname(identifier).present? ? File.basename(identifier, ".*") : identifier
+          element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.singularize(File.basename(collection)))
+
+          File.join("content", collection, element)
+        end
+      end
+
       def method_missing(method_name, *arguments, &block)
         return super if !@attributes.key?(method_name) || arguments.any? || block
 

data/lib/perron/html_processor/syntax_highlight.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rouge"
+require "perron/html_processor/base"
+
+module Perron
+  class HtmlProcessor
+    class SyntaxHighlight < HtmlProcessor::Base
+      def process
+        @html.css('pre > code[class*="language-"]').each do |code_block|
+          language = code_block[:class][/(?<=language-)\S+/]
+
+          next if language.blank?
+
+          code_block.parent.replace(
+            highlight(code_block.text, with: language)
+          )
+        end
+      end
+
+      private
+
+      def highlight(code_block, with:)
+        lexer = Rouge::Lexer.find(with) || Rouge::Lexers::PlainText.new
+
+        Rouge::Formatters::HTMLPygments.new(::Rouge::Formatters::HTML.new).format(lexer.lex(code_block))
+      end
+    end
+  end
+end

data/lib/perron/html_processor.rb

@@ -11,11 +11,9 @@ module Perron
     end
 
     def process
-      document = Nokogiri::HTML::DocumentFragment.parse(@html)
-
-      @processors.each { it.new(document).process }
-
-      document.to_html
+      Nokogiri::HTML::DocumentFragment.parse(@html).tap do |document|
+        @processors.each { it.new(document).process }
+      end.to_html
     end
 
     private
@@ -23,7 +21,13 @@ module Perron
     BUILT_IN = {
       "target_blank" => Perron::HtmlProcessor::TargetBlank,
       "lazy_load_images" => Perron::HtmlProcessor::LazyLoadImages
-    }
+    }.tap do |processors|
+      require "rouge"
+      require "perron/html_processor/syntax_highlight"
+
+      processors["syntax_highlight"] = Perron::HtmlProcessor::SyntaxHighlight
+    rescue LoadError
+    end
 
     def find_by(identifier)
       case identifier
@@ -43,8 +47,8 @@ module Perron
 
       return processor if processor
 
-      raise Perron::Errors::ProcessorNotFoundError,
-        "Could not find processor `#{name}`. It is not a Perron-included processor and the constant `#{name.camelize}` could not be found."
+      raise Perron::Errors::ProcessorNotFoundError, "The `syntax_highlight` processor requires `rouge`. Run `bundle add rouge` to add it to your Gemfile." if name.inquiry.syntax_highlight?
+      raise Perron::Errors::ProcessorNotFoundError, "Could not find processor `#{name}`. It is not a Perron-included processor and the constant `#{name.camelize}` could not be found."
     end
   end
 end

data/lib/perron/markdown.rb

@@ -18,7 +18,7 @@ module Perron
       end
 
       def markdown_parser
-        if defined?(::CommonMarker)
+        if defined?(::Commonmarker)
           CommonMarkerParser.new
         elsif defined?(::Kramdown)
           KramdownParser.new
@@ -31,17 +31,18 @@ module Perron
     end
 
     class CommonMarkerParser
-      def parse(text) = CommonMarker.render_html(text, :DEFAULT)
+      def parse(text) = Commonmarker.to_html(text, **Perron.configuration.markdown_options)
     end
 
     class KramdownParser
-      def parse(text) = Kramdown::Document.new(text).to_html
+      def parse(text) = Kramdown::Document.new(text, Perron.configuration.markdown_options).to_html
     end
 
     class RedcarpetParser
       def parse(text)
-        renderer = Redcarpet::Render::HTML.new(filter_html: true)
-        markdown = Redcarpet::Markdown.new(renderer, autolink: true, tables: true)
+        options = Perron.configuration.markdown_options
+        renderer = Redcarpet::Render::HTML.new(options.fetch(:renderer_options, {}))
+        markdown = Redcarpet::Markdown.new(renderer, options.fetch(:markdown_options, {}))
 
         markdown.render(text)
       end

data/lib/perron/metatags.rb

@@ -4,9 +4,8 @@ module Perron
   class Metatags
     include ActionView::Helpers::TagHelper
 
-    def initialize(resource)
-      @resource = resource
-      @config = Perron.configuration
+    def initialize(data)
+      @data = data
     end
 
     def render(options = {})
@@ -19,75 +18,50 @@ module Perron
 
     private
 
-    FRONTMATTER_KEY_MAP = {
-      "locale" => %w[og:locale],
-      "image" => %w[og:image twitter:image],
-      "author" => %w[og:author]
-    }.freeze
-
     def tags
-      @tags ||= begin
-        frontmatter = @resource&.metadata&.stringify_keys || {}
-        collection_config = @resource&.collection&.configuration&.metadata || {}
-        site_config = @config.metadata
-
-        title = frontmatter["title"] || collection_config["title"] || site_config["title"] || @config.site_name || Rails.application.name.underscore.camelize
-        type = frontmatter["type"] || collection_config["type"] || site_config["type"]
-        description = frontmatter["description"] || collection_config["description"] || site_config["description"]
-        logo = frontmatter["logo"] || collection_config["logo"] || site_config["logo"]
-        author = frontmatter["author"] || collection_config["author"] || site_config["author"]
-        locale = frontmatter["locale"] || collection_config["locale"] || site_config["locale"]
-
-        image = frontmatter["image"] || collection_config["image"] || site_config["image"]
-        og_image = frontmatter["og:image"] || collection_config["og:image"] || site_config["og:image"] || image
-        twitter_image = frontmatter["twitter:image"] || collection_config["twitter:image"] || site_config["twitter:image"] || og_image
-
-        {
-          title: title_tag(title),
-          description: meta_tag(name: "description", content: description),
-          article_published: meta_tag(property: "article:published_time", content: @resource&.published_at),
-
-          og_title: meta_tag(property: "og:title", content: frontmatter["og:title"] || title),
-          og_type: meta_tag(property: "og:type", content: frontmatter["og:type"] || type),
-          og_url: meta_tag(property: "og:url", content: canonical_url),
-          og_image: meta_tag(property: "og:image", content: og_image),
-
-          og_description: meta_tag(property: "og:description", content: frontmatter["og:description"] || description),
-          og_site_name: meta_tag(property: "og:site_name", content: @config.site_name),
-          og_logo: meta_tag(property: "og:logo", content: frontmatter["og:logo"] || logo),
-          og_author: meta_tag(property: "og:author", content: frontmatter["og:author"] || author),
-          og_locale: meta_tag(property: "og:locale", content: frontmatter["og:locale"] || locale),
-
-          twitter_card: meta_tag(name: "twitter:card", content: frontmatter["twitter:card"] || "summary_large_image"),
-          twitter_title: meta_tag(name: "twitter:title", content: frontmatter["twitter:title"] || title),
-          twitter_description: meta_tag(name: "twitter:description", content: frontmatter["twitter:description"] || description),
-          twitter_image: meta_tag(name: "twitter:image", content: twitter_image)
-        }
-      end
+      @tags ||= {
+        title: title_tag(@data[:title]),
+        canonical: link_tag(rel: "canonical", href: @data[:canonical_url]),
+
+        description: meta_tag(name: "description", content: @data[:description]),
+        article_published: meta_tag(property: "article:published_time", content: @data[:article_published_time]),
+
+        og_title: meta_tag(property: "og:title", content: @data[:og_title]),
+        og_type: meta_tag(property: "og:type", content: @data[:og_type]),
+        og_url: meta_tag(property: "og:url", content: @data[:og_url]),
+        og_image: meta_tag(property: "og:image", content: @data[:og_image]),
+        og_description: meta_tag(property: "og:description", content: @data[:og_description]),
+        og_site_name: meta_tag(property: "og:site_name", content: @data[:og_site_name]),
+        og_logo: meta_tag(property: "og:logo", content: @data[:og_logo]),
+        og_author: meta_tag(property: "og:author", content: @data[:og_author]),
+        og_locale: meta_tag(property: "og:locale", content: @data[:og_locale]),
+
+        twitter_card: meta_tag(name: "twitter:card", content: @data[:twitter_card]),
+        twitter_title: meta_tag(name: "twitter:title", content: @data[:twitter_title]),
+        twitter_description: meta_tag(name: "twitter:description", content: @data[:twitter_description]),
+        twitter_image: meta_tag(name: "twitter:image", content: @data[:twitter_image])
+      }
     end
 
     def title_tag(content)
+      config = Perron.configuration
       resource_title = content.to_s.strip
-      title_suffix = Perron.configuration.metadata.title_suffix&.strip
-
+      title_suffix = config.metadata.title_suffix&.strip
       suffix = (title_suffix if title_suffix.present? && resource_title != title_suffix)
 
-      tag.title([resource_title, suffix].compact.join(Perron.configuration.metadata.title_separator))
+      tag.title([resource_title, suffix].compact.join(config.metadata.title_separator))
     end
 
-    def meta_tag(attributes)
-      return if attributes[:content].blank?
+    def link_tag(attributes)
+      return if attributes[:href].blank?
 
-      tag.meta(**attributes)
+      tag.link(**attributes)
     end
 
-    def canonical_url
-      url_options = @config.default_url_options
-      base_url = "#{url_options[:protocol]}://#{url_options[:host]}"
-      url = URI.join(base_url, @resource&.path).to_s
-      has_extension = URI(url).path.split("/").last&.include?(".")
+    def meta_tag(attributes)
+      return if attributes[:content].blank?
 
-      url.then { (url_options[:trailing_slash] && !it.end_with?("/") && !has_extension) ? "#{it}/" : it }
+      tag.meta(**attributes)
     end
   end
 end

data/lib/perron/{site/resource → resource}/class_methods.rb

@@ -30,13 +30,17 @@ module Perron
 
         def collection = Collection.new(collection_name)
 
+        def root
+          collection_name.pages? && collection.find_by_file_name("root", name.constantize)
+        end
+
         def model_name
           @model_name ||= ActiveModel::Name.new(self, nil, name.demodulize.to_s)
         end
 
         private
 
-        def collection_name = name.demodulize.underscore.pluralize
+        def collection_name = name.demodulize.underscore.pluralize.inquiry
       end
     end
   end

data/lib/perron/resource/metadata.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    class Metadata
+      def initialize(resource:, frontmatter:, collection:)
+        @resource = resource
+        @frontmatter = frontmatter&.deep_symbolize_keys || {}
+        @collection = collection
+        @config = Perron.configuration
+      end
+
+      def data
+        @data ||= ActiveSupport::OrderedOptions
+          .new
+          .merge(apply_fallbacks_and_defaults(to: merged_site_collection_resource_frontmatter))
+      end
+
+      private
+
+      def merged_site_collection_resource_frontmatter = site_data.merge(collection_data).merge(@frontmatter)
+
+      def apply_fallbacks_and_defaults(to:)
+        to[:title] ||= @config.site_name || Rails.application.name.underscore.camelize
+
+        to[:canonical_url] ||= canonical_url
+
+        to[:og_image] ||= to[:image]
+        to[:twitter_image] ||= to[:og_image]
+
+        to[:og_title] ||= to[:title]
+        to[:twitter_title] ||= to[:title]
+        to[:og_description] ||= to[:description]
+        to[:twitter_description] ||= to[:description]
+        to[:og_type] ||= to[:type]
+        to[:og_logo] ||= to[:logo]
+        to[:og_author] ||= to[:author]
+        to[:og_locale] ||= to[:locale]
+
+        to[:og_site_name] = @config.site_name
+        to[:twitter_card] ||= "summary_large_image"
+        to[:og_url] = canonical_url
+        to[:article_published_time] = @resource.published_at
+
+        to.compact
+      end
+
+      def canonical_url
+        return @frontmatter[:canonical_url] if @frontmatter[:canonical_url]
+        return Rails.application.routes.url_helpers.root_url(**Perron.configuration.default_url_options) if @resource.slug == "/"
+
+        Rails.application.routes.url_helpers.polymorphic_url(
+          @resource,
+          **Perron.configuration.default_url_options
+        )
+      end
+
+      def site_data
+        @config.metadata.except(:title_separator, :title_suffix).deep_symbolize_keys || {}
+      end
+
+      def collection_data
+        @collection&.configuration&.metadata&.deep_symbolize_keys || {}
+      end
+    end
+  end
+end

data/lib/perron/{site/resource → resource}/publishable.rb

@@ -7,10 +7,10 @@ module Perron
 
       included do
         def published?
-          return true if Rails.env.development?
+          return true if Perron.configuration.view_unpublished
 
-          return false if metadata.draft == true
-          return false if metadata.published == false
+          return false if frontmatter.draft == true
+          return false if frontmatter.published == false
           return false if publication_date&.after?(Time.current)
 
           true
@@ -20,8 +20,8 @@ module Perron
 
         def publication_date
           @publication_date ||= begin
-            from_meta = metadata.published_at.present? ? begin
-              Time.zone.parse(metadata.published_at.to_s)
+            from_meta = frontmatter.published_at.present? ? begin
+              Time.zone.parse(frontmatter.published_at.to_s)
             rescue
               nil
             end : nil

data/lib/perron/{site/resource → resource}/related.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "perron/site/resource/related/stop_words"
+require "perron/resource/related/stop_words"
 
 module Perron
   module Site

data/lib/perron/{site/resource → resource}/separator.rb

@@ -9,9 +9,9 @@ module Perron
         parsed(content)
       end
 
-      def metadata
-        @metadata_with_dot_access ||= ActiveSupport::OrderedOptions.new.tap do |options|
-          @metadata.each { |key, value| options[key] = value }
+      def frontmatter
+        @frontmatter_with_dot_access ||= ActiveSupport::OrderedOptions.new.tap do |options|
+          @frontmatter.each { |key, value| options[key] = value }
         end
       end
 
@@ -19,10 +19,10 @@ module Perron
 
       def parsed(content)
         if content =~ /\A---\s*(.*?)\s*---\s*(.*)/m
-          @metadata = YAML.safe_load($1, permitted_classes: [Date, Time]) || {}
+          @frontmatter = YAML.safe_load($1, permitted_classes: [Date, Time]) || {}
           @content = $2.strip
         else
-          @metadata = {}
+          @frontmatter = {}
           @content = content
         end
       end

data/lib/perron/{site/resource → resource}/slug.rb

@@ -7,13 +7,16 @@ module Perron
     class Slug
       using Perron::SuffixStripping
 
-      def initialize(resource)
+      def initialize(resource, frontmatter)
         @resource = resource
-        @metadata = resource.metadata
+        @frontmatter = frontmatter
       end
 
       def create
-        @metadata.slug.presence || @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(dot_prepended_allowed_extensions)
+        return "/" if Perron.configuration.allowed_extensions.any? { @resource.filename == "root.#{it}" }
+
+        @frontmatter.slug.presence ||
+          @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(dot_prepended_allowed_extensions)
       end
 
       private

data/lib/perron/{site/resource.rb → resource.rb}

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
-require "perron/site/resource/configuration"
-require "perron/site/resource/core"
-require "perron/site/resource/class_methods"
-require "perron/site/resource/publishable"
-require "perron/site/resource/related"
-require "perron/site/resource/renderer"
-require "perron/site/resource/slug"
-require "perron/site/resource/separator"
+require "perron/resource/configuration"
+require "perron/resource/core"
+require "perron/resource/class_methods"
+require "perron/resource/metadata"
+require "perron/resource/publishable"
+require "perron/resource/related"
+require "perron/resource/renderer"
+require "perron/resource/slug"
+require "perron/resource/separator"
 
 module Perron
   class Resource
@@ -29,7 +30,7 @@ module Perron
 
     def filename = File.basename(@file_path)
 
-    def slug = Perron::Resource::Slug.new(self).create
+    def slug = Perron::Resource::Slug.new(self, frontmatter).create
     alias_method :path, :slug
     alias_method :to_param, :slug
 
@@ -41,11 +42,30 @@ module Perron
       Perron::Resource::Renderer.erb(page_content, {resource: self})
     end
 
-    def metadata = Perron::Resource::Separator.new(raw_content).metadata
+    def metadata
+      Perron::Resource::Metadata.new(
+        resource: self,
+        frontmatter: frontmatter,
+        collection: collection
+      ).data
+    end
 
     def raw_content = File.read(@file_path)
     alias_method :raw, :raw_content
 
+    def to_partial_path
+      @to_partial_path ||= begin
+        element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(self.class.model_name))
+        collection = ActiveSupport::Inflector.tableize(self.class.model_name)
+
+        File.join("content", collection, element)
+      end
+    end
+
+    def root?
+      collection.name.inquiry.pages? && File.basename(filename) == "root"
+    end
+
     def collection = Collection.new(self.class.model_name.collection)
 
     def related_resources(limit: 5) = Perron::Site::Resource::Related.new(self).find(limit:)
@@ -53,6 +73,10 @@ module Perron
 
     private
 
+    def frontmatter
+      @frontmatter ||= Perron::Resource::Separator.new(raw_content).frontmatter
+    end
+
     def erb_processing?
       @file_path.ends_with?(".erb") || metadata.erb == true
     end

data/lib/perron/root.rb

@@ -5,7 +5,7 @@ module Perron
     include ActiveSupport::Concern
 
     def root
-      @resource = Content::Page.find("/")
+      @resource = Content::Page.root
 
       render :show
     end

data/lib/perron/site.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 require "perron/site/builder"
-require "perron/site/collection"
-require "perron/site/resource"
-require "perron/site/data"
-require "perron/site/data/proxy"
+require "perron/collection"
+require "perron/data"
+require "perron/data/proxy"
 
 module Perron
   module Site

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

data/lib/perron.rb

@@ -5,6 +5,7 @@ require "perron/configuration"
 require "perron/errors"
 require "perron/root"
 require "perron/site"
+require "perron/resource"
 require "perron/markdown"
 require "perron/feeds"
 require "perron/metatags"

data/perron.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Rails-based static site generator"
   spec.description = "Perron is a Rails-based static site generator that follows Rails conventions. It allows you to create content collections with markdown or ERB, configure SEO metadata, and build production-ready static sites while leveraging your existing Rails knowledge with familiar patterns and minimal configuration."
-  spec.homepage = "https://railsdesigner.com/perron/"
+  spec.homepage = "https://perron.railsdesigner.com/"
   spec.license = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -96,17 +96,32 @@ files:
 - lib/generators/perron/templates/README.md.tt
 - lib/generators/perron/templates/initializer.rb.tt
 - lib/perron.rb
+- lib/perron/collection.rb
 - lib/perron/configuration.rb
+- lib/perron/data.rb
+- lib/perron/data/proxy.rb
 - lib/perron/engine.rb
 - lib/perron/errors.rb
 - lib/perron/feeds.rb
 - lib/perron/html_processor.rb
 - lib/perron/html_processor/base.rb
 - lib/perron/html_processor/lazy_load_images.rb
+- lib/perron/html_processor/syntax_highlight.rb
 - lib/perron/html_processor/target_blank.rb
 - lib/perron/markdown.rb
 - lib/perron/metatags.rb
 - lib/perron/refinements/delete_suffixes.rb
+- lib/perron/resource.rb
+- lib/perron/resource/class_methods.rb
+- lib/perron/resource/configuration.rb
+- lib/perron/resource/core.rb
+- lib/perron/resource/metadata.rb
+- lib/perron/resource/publishable.rb
+- lib/perron/resource/related.rb
+- lib/perron/resource/related/stop_words.rb
+- lib/perron/resource/renderer.rb
+- lib/perron/resource/separator.rb
+- lib/perron/resource/slug.rb
 - lib/perron/root.rb
 - lib/perron/site.rb
 - lib/perron/site/builder.rb
@@ -118,27 +133,14 @@ files:
 - lib/perron/site/builder/paths.rb
 - lib/perron/site/builder/public_files.rb
 - lib/perron/site/builder/sitemap.rb
-- lib/perron/site/collection.rb
-- lib/perron/site/data.rb
-- lib/perron/site/data/proxy.rb
-- lib/perron/site/resource.rb
-- lib/perron/site/resource/class_methods.rb
-- lib/perron/site/resource/configuration.rb
-- lib/perron/site/resource/core.rb
-- lib/perron/site/resource/publishable.rb
-- lib/perron/site/resource/related.rb
-- lib/perron/site/resource/related/stop_words.rb
-- lib/perron/site/resource/renderer.rb
-- lib/perron/site/resource/separator.rb
-- lib/perron/site/resource/slug.rb
 - lib/perron/tasks/perron.rake
 - lib/perron/version.rb
 - perron.gemspec
-homepage: https://railsdesigner.com/perron/
+homepage: https://perron.railsdesigner.com/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://railsdesigner.com/perron/
+  homepage_uri: https://perron.railsdesigner.com/
   source_code_uri: https://github.com/Rails-Designer/perron/
 rdoc_options: []
 require_paths: