perron 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ab1fe5550ba3bfd474381303929b49e9dac552d2d086bcbeb79c0760ad59979
-  data.tar.gz: 4b64af0d6128def66419351d50f74dffc29e8c74b1cf6f00ec004dc122f426cb
+  metadata.gz: 9605385eb10b149f1f679d423a2367ed7f35684d381699692d329a1d05a2f6ea
+  data.tar.gz: e3803d65512af0de01c0cee99afdbbd2a8fed6d54afb823a9b64716469ea0fc6
 SHA512:
-  metadata.gz: a3490ff02b1c8612e99f6403d0db98008b88461dd73b430b3470623a33bd4bd5bdc2945ff61a7bae821e1ff1bbcd3ba9f707be86c28724807300cdf75f476493
-  data.tar.gz: 505b439b20f2dbc5d2310aa56d8b8bcd99b793ddf83395f5652be1814e598c26d3f2154cde99531ad79d621ef7377cb12ddc076677e233a54c96faa875ff4cbf
+  metadata.gz: '090e644895f9f3fabb0b1ca3839592838864c5c6cb0a1c31acd83dbe2ef8c0ee2cbad5a13308e8986928f660d54c342f494858fcd7eb33038dc57d32834b03f8'
+  data.tar.gz: 1647b01aed3aa31f8aaac047ffe7880f58fe47530d81445077652c15635efdc99eeaedfdc7e12af87ab914ae3e4e80edda0eeec42404bdb5d50813527ac642a0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    perron (0.7.0)
+    perron (0.8.0)
       csv
       json
       psych

data/README.md

@@ -17,11 +17,17 @@ A Rails-based static site generator.
 
 ### Installation
 
-Start by generating the configuration file:
+Start by adding Perron:
+```bash
+bundle add perron
+```
+
+Then generate the initializer:
 ```bash
 rails generate perron:install
 ```
 
+
 This creates an initializer:
 ```ruby
 Perron.configure do |config|
@@ -85,6 +91,46 @@ bundle add {commonmarker,kramdown,redcarpet}
 ```
 
 
+## HTML Transformations
+
+Perron can post-process the HTML generated from your Markdown content.
+
+
+### Usage
+
+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] %>
+```
+
+
+### 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.
+
+
+### Creating Your Own
+
+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.
+
+```ruby
+# app/processors/add_nofollow_processor.rb
+class AddNofollowProcessor < Perron::HtmlProcessor::Base
+  def process
+    @html.css("a[target=_blank]").each { it["rel"] = "nofollow" }
+  end
+end
+```
+
+```erb
+<%= markdownify @resource.content, process: ["target_blank", AddNofollowProcessor] %>
+```
+
+
 ## Data Files
 
 Perron can consume structured data from YML, JSON, or CSV files, making them available within your templates.
@@ -92,9 +138,9 @@ This is useful for populating features, team members, or any other repeated data
 
 ### Usage
 
-To use a data file, instantiate `Perron::Data` with the basename of the file and iterate over the result.
+To use a data file, instantiate `Perron::Site.data` with the basename of the file and iterate over the result.
 ```erb
-<% Perron::Data.new("features").each do |feature| %>
+<% Perron::Site.data.features.each do |feature| %>
   <h4><%= feature.name %></h4>
   <p><%= feature.description %></p>
 <% end %>
@@ -103,7 +149,7 @@ To use a data file, instantiate `Perron::Data` with the basename of the file and
 ### File Location and Formats
 
 By default, Perron looks up `app/content/data/` for files with a `.yml`, `.json`, or `.csv` extension.
-For a `new("features")` call, it would find `features.yml`, `features.json`, or `features.csv`. You can also provide a full, absolute path to any data file.
+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
 
@@ -118,7 +164,6 @@ feature[:name]
 
 The `meta_tags` helper automatically generates SEO and social sharing meta tags for your pages.
 
-
 ### Usage
 
 In your layout (e.g., `app/views/layouts/application.html.erb`), add the helper to the `<head>` section:
@@ -207,6 +252,7 @@ Sites that use Perron.
 ### Integrated (part of a Rails app)
 - [Rails Designers (private community for Rails UI engineers](https://railsdesigners.com)
 
+
 ## Contributing
 
 This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please run `be standardrb` before submitting pull requests. Run tests with `rails test`.

data/app/helpers/perron/markdown_helper.rb

@@ -4,6 +4,10 @@ require "perron/markdown"
 
 module Perron
   module MarkdownHelper
-    def markdownify(content = nil, &block) = Perron::Markdown.render(content || capture(&block).strip_heredoc)
+    def markdownify(content = nil, options = {}, &block)
+      processors = options.fetch(:process, [])
+
+      Perron::Markdown.render(content || capture(&block).strip_heredoc, processors: processors)
+    end
   end
 end

data/lib/generators/perron/templates/README.md.tt

@@ -8,11 +8,11 @@ This is useful for populating features, team members, or any other repeated data
 
 To use a data file, instantiate `Perron::Data` with the basename of the file and iterate over the result.
 ```erb
-<% Perron::Data.new("features").each do |feature| %>
-  <h4><%= feature.name %></h4>
+<%% Perron::Data.new("features").each do |feature| %>
+  <h4><%%= feature.name %></h4>
 
-  <p><%= feature.description %></p>
-<% end %>
+  <p><%%= feature.description %></p>
+<%% end %>
 ```
 
 ## File Location and Formats

data/lib/perron/configuration.rb

@@ -9,10 +9,6 @@ module Perron
     yield(configuration)
   end
 
-  def self.reset_configuration!
-    @configuration = Configuration.new
-  end
-
   class Configuration
     def initialize
       @config = ActiveSupport::OrderedOptions.new
@@ -34,11 +30,16 @@ module Perron
         trailing_slash: ENV.fetch("PERRON_TRAILING_SLASH", "true") == "true"
       }
 
+      @config.sitemap = ActiveSupport::OrderedOptions.new
+      @config.sitemap.enabled = false
+      @config.sitemap.priority = 0.5
+      @config.sitemap.change_frequency = :monthly
+
       @config.metadata = ActiveSupport::OrderedOptions.new
       @config.metadata.title_separator = " — "
     end
 
-    def input = "app/content"
+    def input = Rails.root.join("app", "content")
 
     def output
       mode.integrated? ? "public" : @config.output

data/lib/perron/errors.rb

@@ -9,5 +9,9 @@ module Perron
     class UnsupportedDataFormatError < StandardError; end
 
     class DataParseError < StandardError; end
+
+    class ProcessorNotFoundError < StandardError; end
+
+    class InvalidProcessorError < StandardError; end
   end
 end

data/lib/perron/html_processor/base.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Perron
+  class HtmlProcessor
+    class Base
+      def initialize(html)
+        @html = html
+      end
+
+      def process
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/perron/html_processor/lazy_load_images.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Perron
+  class HtmlProcessor
+    class LazyLoadImages < HtmlProcessor::Base
+      def process
+        @html.css("img").each do |image|
+          image["loading"] = "lazy"
+        end
+      end
+    end
+  end
+end

data/lib/perron/html_processor/target_blank.rb

@@ -1,21 +1,17 @@
 # frozen_string_literal: true
 
+require "perron/html_processor/base"
+
 module Perron
   class HtmlProcessor
-    class TargetBlank
-      def initialize(html)
-        @html = html
-      end
-
+    class TargetBlank < HtmlProcessor::Base
       def process
         @html.css("a").each do |link|
           href = link["href"]
 
-          next unless href
-          next if href.start_with?("/", "#", "mailto:")
+          next if href.blank? || href.start_with?("/", "#", "mailto:")
 
           link["target"] = "_blank"
-          link["rel"] = "noopener"
         end
       end
     end

data/lib/perron/html_processor.rb

@@ -1,28 +1,50 @@
 # frozen_string_literal: true
 
 require "perron/html_processor/target_blank"
+require "perron/html_processor/lazy_load_images"
 
 module Perron
   class HtmlProcessor
-    def initialize(html)
+    def initialize(html, processors: [])
       @html = html
+      @processors = processors.map { find_by(it) }
     end
 
     def process
       document = Nokogiri::HTML::DocumentFragment.parse(@html)
 
-      PROCESSORS.each do |processor|
-        processor.new(document).process
-      end
+      @processors.each { it.new(document).process }
 
       document.to_html
     end
 
     private
 
-    # TODO: should be a configuration option
-    PROCESSORS = [
-      Perron::HtmlProcessor::TargetBlank
-    ]
+    BUILT_IN = {
+      "target_blank" => Perron::HtmlProcessor::TargetBlank,
+      "lazy_load_images" => Perron::HtmlProcessor::LazyLoadImages
+    }
+
+    def find_by(identifier)
+      case identifier
+      when String, Symbol
+        key = identifier.to_s
+
+        BUILT_IN[key] || find_class_by(key)
+      when Class
+        identifier
+      else
+        raise Perron::Errors::InvalidProcessorError, "Processor must be a String, Symbol, or Class, but got #{identifier.class.name}."
+      end
+    end
+
+    def find_class_by(name)
+      processor = name.camelize.safe_constantize
+
+      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."
+    end
   end
 end

data/lib/perron/markdown.rb

@@ -5,9 +5,9 @@ require "perron/html_processor"
 module Perron
   class Markdown
     class << self
-      def render(text)
+      def render(text, processors: [])
         parser.parse(text)
-          .then { Perron::HtmlProcessor.new(it).process }
+          .then { Perron::HtmlProcessor.new(it, processors: processors).process }
           .html_safe
       end
 

data/lib/perron/metatags.rb

@@ -20,6 +20,7 @@ module Perron
     private
 
     FRONTMATTER_KEY_MAP = {
+      "locale" => %w[og:locale],
       "image" => %w[og:image twitter:image],
       "author" => %w[og:author]
     }.freeze
@@ -30,30 +31,35 @@ module Perron
         defaults = @config.metadata
 
         title = frontmatter["title"] || defaults["title"] || @config.site_name || Rails.application.name.underscore.camelize
+        type = frontmatter["type"] || defaults["type"]
         description = frontmatter["description"] || defaults["description"]
+        logo = frontmatter["logo"] || defaults["logo"]
         author = frontmatter["author"] || defaults["author"]
         image = frontmatter["image"] || defaults["image"]
+        locale = frontmatter["locale"] || defaults["locale"]
         og_image = frontmatter["og:image"] || image
         twitter_image = frontmatter["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_type: meta_tag(property: "og:type", content: frontmatter["og:type"] || "article"),
           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_image: meta_tag(property: "og:image", content: og_image),
+          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),
-          article_published: meta_tag(property: "article:published_time", content: @resource&.published_at),
-
-          og_url: meta_tag(property: "og:url", content: canonical_url)
+          twitter_image: meta_tag(name: "twitter:image", content: twitter_image)
         }
       end
     end

data/lib/perron/site/builder/sitemap.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Perron
+  module Site
+    class Builder
+      class Sitemap
+        def initialize(output_path)
+          @output_path = output_path
+        end
+
+        def generate
+          return if !Perron.configuration.sitemap.enabled
+
+          puts "Generating sitemap.xml…"
+
+          xml = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |builder|
+            builder.urlset(xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9") do
+              Perron::Site.collections.each do |collection|
+                add_urls_for(collection, with: builder)
+              end
+            end
+          end.to_xml
+
+          File.write(@output_path.join("sitemap.xml"), xml)
+
+          puts "Sitemap generated at `#{@output_path.join("sitemap.xml")}`"
+        end
+
+        private
+
+        def add_urls_for(collection, with:)
+          return if collection.configuration.sitemap.exclude == true
+
+          collection.resources.each do |resource|
+            next if resource.metadata.sitemap == false
+
+            root = resource.slug == "/"
+            priority = resource.metadata.sitemap_priority || collection.configuration.sitemap.priority || Perron.configuration.sitemap.priority
+            change_frequency = resource.metadata.sitemap_change_frequency || collection.configuration.sitemap.change_frequency || Perron.configuration.sitemap.change_frequency
+
+            Rails.application.routes.url_helpers.with_options(Perron.configuration.default_url_options) do |url|
+              with.url do
+                with.loc root ? url.root_url : url.polymorphic_url(resource)
+                with.priority priority
+                with.changefreq change_frequency
+                begin
+                  with.lastmod resource.metadata.updated_at.iso8601
+                rescue
+                  Time.current.iso8601
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/site/builder.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "perron/site/builder/assets"
+require "perron/site/builder/sitemap"
 require "perron/site/builder/public_files"
 require "perron/site/builder/paths"
 require "perron/site/builder/page"
@@ -15,6 +16,7 @@ module Perron
       def build
         if Perron.configuration.mode.standalone?
           puts "🧹 Cleaning previous build…"
+
           FileUtils.rm_rf(Dir.glob("#{@output_path}/*"))
 
           Perron::Site::Builder::Assets.new.prepare
@@ -26,6 +28,8 @@ module Perron
 
         paths.each { render_page(it) }
 
+        Perron::Site::Builder::Sitemap.new(@output_path).generate
+
         puts "-" * 15
         puts "✅ Build complete"
       end

data/lib/perron/site/collection.rb

@@ -6,16 +6,21 @@ module Perron
 
     def initialize(name)
       @name = name
-      @collection_path = File.join(Rails.root, Perron.configuration.input, name)
+      @collection_path = File.join(Perron.configuration.input, name)
 
       raise Errors::CollectionNotFoundError, "No such collection: #{name}" unless File.exist?(@collection_path) && File.directory?(@collection_path)
     end
 
+    def configuration(resource_class = "Content::#{name.classify}".safe_constantize)
+      resource_class.configuration
+    end
+
     def all(resource_class = "Content::#{name.classify}".safe_constantize)
       @all ||= Dir.glob("#{@collection_path}/**/*.*").map do |file_path|
         resource_class.new(file_path)
       end.select(&:published?)
     end
+    alias_method :resources, :all
 
     def find(slug, resource_class = Resource)
       resource = all(resource_class).find { it.slug == slug }

data/lib/perron/site/data/proxy.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Perron
+  class Data
+    class Proxy
+      def method_missing(method_name, *arguments, &block)
+        raise ArgumentError, "Data `#{method_name}` does not accept arguments" if arguments.any?
+
+        Perron::Data.new(method_name.to_s)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
+    end
+  end
+end

data/lib/perron/site/resource/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Configuration
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def configuration
+          @configuration ||= Options.new.tap do |config|
+            config.feeds = Options.new
+
+            config.feeds.rss = ActiveSupport::OrderedOptions.new
+            config.feeds.atom = ActiveSupport::OrderedOptions.new
+            config.feeds.json = ActiveSupport::OrderedOptions.new
+
+            config.linked_data = ActiveSupport::OrderedOptions.new
+
+            config.related_posts = ActiveSupport::OrderedOptions.new
+            config.related_posts.enabled = false
+            config.related_posts.max = 5
+
+            config.sitemap = ActiveSupport::OrderedOptions.new
+            config.sitemap.exclude = false
+          end
+        end
+
+        def configure
+          yield(configuration)
+        end
+      end
+
+      class Options < ActiveSupport::OrderedOptions
+        def method_missing(name, *arguments)
+          if name.to_s.end_with?("=")
+            key = name.to_s.chomp("=").to_sym
+            value = arguments.first
+
+            return self[key].merge!(value) if self[key].is_a?(ActiveSupport::OrderedOptions) && value.is_a?(Hash)
+          end
+
+          super
+        end
+
+        def respond_to_missing?(name, include_private = false) = super
+      end
+      private_constant :Options
+    end
+  end
+end

data/lib/perron/site/resource.rb

@@ -1,5 +1,6 @@
 # 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"
@@ -10,6 +11,7 @@ module Perron
   class Resource
     ID_LENGTH = 8
 
+    include Perron::Resource::Configuration
     include Perron::Resource::Core
     include Perron::Resource::ClassMethods
     include Perron::Resource::Publishable
@@ -55,7 +57,7 @@ module Perron
 
     def generate_id
       Digest::SHA1.hexdigest(
-        @file_path.delete_prefix(Perron.configuration.input).parameterize
+        @file_path.delete_prefix(Perron.configuration.input.to_s).parameterize
       ).first(ID_LENGTH)
     end
   end

data/lib/perron/site.rb

@@ -4,6 +4,7 @@ require "perron/site/builder"
 require "perron/site/collection"
 require "perron/site/resource"
 require "perron/site/data"
+require "perron/site/data/proxy"
 
 module Perron
   module Site
@@ -24,13 +25,14 @@ module Perron
     def collections
       @collections ||= Dir.children(Perron.configuration.input)
         .select { File.directory?(File.join(Perron.configuration.input, it)) }
+        .reject { it == "data" }
         .map { Collection.new(it) }
     end
 
     def collection(name) = Collection.new(name)
 
-    def data(name)
-      Perron::Data.new(name)
+    def data(name = nil)
+      (name && Perron::Data.new(name)) || Perron::Data::Proxy.new
     end
   end
 end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

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://github.com/Rails-Designer/perron"
+  spec.homepage = "https://railsdesigner.com/perron/"
   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.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -98,6 +98,8 @@ files:
 - lib/perron/engine.rb
 - lib/perron/errors.rb
 - lib/perron/html_processor.rb
+- lib/perron/html_processor/base.rb
+- lib/perron/html_processor/lazy_load_images.rb
 - lib/perron/html_processor/target_blank.rb
 - lib/perron/markdown.rb
 - lib/perron/metatags.rb
@@ -109,10 +111,13 @@ files:
 - lib/perron/site/builder/page.rb
 - 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/separator.rb
@@ -120,11 +125,11 @@ files:
 - lib/perron/tasks/perron.rake
 - lib/perron/version.rb
 - perron.gemspec
-homepage: https://github.com/Rails-Designer/perron
+homepage: https://railsdesigner.com/perron/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Rails-Designer/perron
+  homepage_uri: https://railsdesigner.com/perron/
   source_code_uri: https://github.com/Rails-Designer/perron/
 rdoc_options: []
 require_paths:
@@ -140,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.0
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Rails-based static site generator
 test_files: []