perron 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72473e733aa6ec4313dc71e66b2a949dea6497b427e304cb4656be0d0a5fbc86
-  data.tar.gz: 37a57b14891cf3fef0dfb1a4c98b414852fdd1bd3f3e377c674e15673f6d2547
+  metadata.gz: 84ad5823f9409ec7734c3fef06a9d57602e5da59c14e939d2e4acb8f3f2b4e22
+  data.tar.gz: 9e8e47f8706704ec8d8d6efb66ccbb6eb87f815570166f0bd188ce0e6f085b9a
 SHA512:
-  metadata.gz: 478b181f494c2c0ac54e996c0d9f289c7694bedbcd203fd435c9222ecdd07ad6c5a3f5e8baeb497ee2f77499e3580f0f915439d2feba1edf8ab42385285a7e96
-  data.tar.gz: 19750396f542ac909322aa5cd3ed247dc10a03509ab521bdb75dd0ae705c502e80b3431737d5c34eb42bcacda17c0ef0c35889cb65561339646f6eb7a2ee1e58
+  metadata.gz: 766753cd5c6e74d3353ad603015e316f7158a1a79c28ed8b0fbcbd8d9a7c8c0a1a4cb88e372fbe741548a83e0d0a042da44df8c8545cc6973eb768283177dae8
+  data.tar.gz: 605182a711103ad0e0ca07c330290ee2ab1574fcfda9596e042ea7365a4f329485a407692ce4c5e94d5c720e1100bb1c79ef4300ccb04eb4119f989af895e2a5

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    perron (1.0.0)
+    perron (1.2.0)
       csv
       json
-      mata (~> 0.8.0)
+      mata (~> 0.10.0)
       psych
       rails (>= 7.2.0)
 
@@ -136,11 +136,10 @@ GEM
       net-pop
       net-smtp
     marcel (1.0.4)
-    mata (0.8.0)
+    mata (0.10.0)
       listen (~> 3.0)
       rack (>= 3.0)
     mini_mime (1.1.5)
-    mini_portile2 (2.8.9)
     minitest (5.27.0)
     net-imap (0.5.9)
       date
@@ -152,24 +151,21 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
-    nokogiri (1.18.8)
-      mini_portile2 (~> 2.8.2)
+    nokogiri (1.19.3-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-aarch64-linux-gnu)
+    nokogiri (1.19.3-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.8-aarch64-linux-musl)
+    nokogiri (1.19.3-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-gnu)
+    nokogiri (1.19.3-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-musl)
+    nokogiri (1.19.3-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm64-darwin)
+    nokogiri (1.19.3-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-darwin)
+    nokogiri (1.19.3-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-gnu)
-      racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-musl)
+    nokogiri (1.19.3-x86_64-linux-musl)
       racc (~> 1.4)
     parallel (1.27.0)
     parser (3.3.8.0)

data/app/controllers/perron/concierge_controller.rb

@@ -5,8 +5,11 @@ module Perron
     end
 
     def run_command
-      system(params[:command])
+      command = params[:command]
 
+      return redirect_back fallback_location: root_path unless command.start_with?("bin/rails generate content")
+
+      system(command)
       redirect_back fallback_location: root_path
     end
   end

data/app/helpers/perron/markdown_helper.rb

@@ -4,10 +4,11 @@ require "perron/markdown"
 
 module Perron
   module MarkdownHelper
-    def markdownify(content = nil, process: [], resource: nil, &block)
+    def markdownify(content = nil, process: nil, resource: nil, &block)
       text = block_given? ? capture(&block).strip_heredoc : content
+      processors = (process.nil? || process.empty?) ? Perron.configuration.default_processors : process
 
-      Perron::Markdown.render(text, processors: process, resource: resource || @resource)
+      Perron::Markdown.render(text, processors: processors, resource: resource || @resource)
     end
   end
 end

data/app/helpers/perron/meta_tags_helper.rb

@@ -2,16 +2,10 @@
 
 module Perron
   module MetaTagsHelper
-    def meta_tags(options = {}) = Perron::Metatags.new(resource.metadata).render(options)
+    def meta_tags(options = {})
+      metadata = (@metadata || {}).merge(@resource&.metadata || {})
 
-    private
-
-    Resource = Data.define(:path, :collection, :metadata, :published_at)
-
-    def resource
-      return Resource.new(request.path, nil, @metadata, nil) if @metadata.present?
-
-      @resource || Resource.new(request.path, nil, {}, nil)
+      Perron::Metatags.new(metadata).render(options)
     end
   end
 end

data/app/helpers/perron/paginate_helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Perron
+  module PaginateHelper
+    def paginate(scope, page: nil, **options)
+      page ||= (params[:page] || 1).to_i
+      resource_class = scope.model_class
+
+      config = resource_class.configuration.pagination
+      per_page = options[:per_page] || config.per_page
+      page_path_template = options[:path_template] || config.path_template
+
+      route = find_index_route(resource_class)
+      base_path = route_path(route)
+
+      use_query_params = Rails.env.development? || Rails.env.local?
+      paginate = Paginate.new(scope, page: page, per_page: per_page, base_path: base_path, page_path_template: page_path_template, use_query_params: use_query_params)
+
+      [paginate, paginate.items]
+    end
+
+    private
+
+    def find_index_route(resource_class)
+      controller_name = resource_class.name.demodulize.sub("Controller", "").underscore.pluralize
+
+      Rails.application.routes.routes.find do |r|
+        r.defaults[:controller] == "content/#{controller_name}" &&
+          r.defaults[:action] == "index"
+      end
+    end
+
+    def route_path(route)
+      return "/#{route.name}/" unless route
+
+      path_spec = route.path.spec.to_s
+      path_spec.sub(/\(.*?\)/, "").gsub(/:[^\/]+/, "").sub(/\/$/, "") + "/"
+    end
+  end
+end

data/app/views/perron/concierge/show.html.erb

@@ -211,7 +211,7 @@
             <code>bin/rails generate content Post --new "My first post"</code>
 
             <%= form_with url: perron_run_command_path do |form| %>
-              <%= form.hidden_field :command, value: 'bin/rails generate content Post --new "My first post"' %>
+              <%= form.hidden_field :command, value: 'bin/rails generate content Post --new' %>
 
               <% if File.file?("app/content/posts/untitled.md") %>
                 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 256" fill="currentColor"><path d="M128,24A104,104,0,1,0,232,128,104.11,104.11,0,0,0,128,24Zm45.66,85.66-56,56a8,8,0,0,1-11.32,0l-24-24a8,8,0,0,1,11.32-11.32L112,148.69l50.34-50.35a8,8,0,0,1,11.32,11.32Z"/></svg>

data/lib/perron/collection.rb

@@ -16,7 +16,7 @@ module Perron
     end
 
     def all(resource_class = "Content::#{name.classify}".safe_constantize)
-      Perron::Relation.new(load_resources(resource_class).select(&:published?))
+      Perron::Relation.new(load_resources(resource_class).select(&:published?), resource_class)
     end
     alias_method :resources, :all
 
@@ -52,6 +52,7 @@ module Perron
 
       Dir.glob("#{@collection_path}/**/*.*")
         .select { allowed_extensions.include?(File.extname(it)) }
+        .reject { File.basename(it, ".*").downcase == "readme" }
         .map { resource_class.new(it) }
     end
   end

data/lib/perron/configuration.rb

@@ -15,8 +15,6 @@ module Perron
 
       @config.output = "output"
 
-      @config.output_server_strict = true
-
       @config.mode = :standalone
 
       @config.live_reload = false
@@ -37,6 +35,8 @@ module Perron
 
       @config.markdown_options = {}
 
+      @config.default_processors = []
+
       @config.search_scope = []
 
       @config.cache_data_sources = false
@@ -45,12 +45,17 @@ module Perron
       @config.sitemap.enabled = false
       @config.sitemap.priority = 0.5
       @config.sitemap.change_frequency = :monthly
+      @config.sitemap.emit_priority = false
+      @config.sitemap.emit_changefreq = false
 
       @config.site_name = nil
       @config.site_description = nil
 
       @config.metadata = ActiveSupport::OrderedOptions.new
       @config.metadata.title_separator = " — "
+
+      @config.before_build = nil
+      @config.after_build = nil
     end
 
     def input = Rails.root.join("app", "content")
@@ -61,10 +66,30 @@ module Perron
 
     def mode = @config.mode.to_s.inquiry
 
+    def output_server_strict = @config.fetch(:output_server_strict) { mode.standalone? }
+
     def additional_routes
       @additional_routes || (mode.integrated? ? [] : %w[root_path])
     end
 
+    def deploy
+      Perron.deprecator.deprecation_warning(:deploy, "Perron.configuration.deploy is deprecated and its behavior will change in a future 1.x release (target: 1.3.0).")
+
+      @deploy ||= ActiveSupport::OrderedOptions.new.tap do |config|
+        def config.method_missing(method_name, *args, &block)
+          if method_name.to_s.end_with?("=")
+            super
+          else
+            self[method_name] ||= ActiveSupport::OrderedOptions.new
+          end
+        end
+
+        def config.respond_to_missing?(method_name, include_private = false)
+          !method_name.to_s.end_with?("=") || super
+        end
+      end
+    end
+
     attr_writer :additional_routes
 
     def url
@@ -82,8 +107,8 @@ module Perron
       end
     end
 
-    def respond_to_missing?(method_name)
-      @config.respond_to?(method_name) || super
+    def respond_to_missing?(method_name, ...)
+      @config.respond_to?(method_name, ...) || super
     end
   end
 end

data/lib/perron/data_source.rb

@@ -66,11 +66,13 @@ module Perron
       end
 
       data.map.with_index do |item, index|
-        unless item.is_a?(Hash)
-          raise Errors::DataParseError, "Item at index #{index} in `#{@file_path}` must be a hash/object, got #{item.class}"
+        if item.is_a?(Hash)
+          Item.new(item, identifier: @identifier)
+        elsif item.is_a?(String)
+          item
+        else
+          raise Errors::DataParseError, "Item at index #{index} in `#{@file_path}` must be a hash/object or string, got #{item.class}"
         end
-
-        Item.new(item, identifier: @identifier)
       end
     end
 

data/lib/perron/deprecator.rb

@@ -2,6 +2,6 @@
 
 module Perron
   def self.deprecator
-    @deprecator ||= ActiveSupport::Deprecation.new("1.0", "Perron")
+    @deprecator ||= ActiveSupport::Deprecation.new("1.3.0", "Perron")
   end
 end

data/lib/perron/engine.rb

@@ -30,17 +30,19 @@ module Perron
     end
 
     initializer "perron.concierge", before: :add_builtin_route do |app|
-      app.config.after_initialize do
-        app.routes.append do
-          namespace :perron do
-            post :run_command, to: "concierge#run_command"
-          end
+      if Rails.env.development?
+        app.config.after_initialize do
+          app.routes.append do
+            namespace :perron do
+              post :run_command, to: "concierge#run_command"
+            end
 
-          root to: "perron/concierge#show" unless app.routes.named_routes.key?(:root)
+            root to: "perron/concierge#show" unless app.routes.named_routes.key?(:root)
+          end
         end
-      end
 
-      app.routes.finalize!
+        app.routes.finalize!
+      end
     end
 
     initializer "perron.inflections" do
@@ -57,6 +59,7 @@ module Perron
       load File.expand_path("../tasks/install.rake", __FILE__)
       load File.expand_path("../tasks/sync_sources.rake", __FILE__)
       load File.expand_path("../tasks/validate.rake", __FILE__)
+      load File.expand_path("../tasks/deploy.rake", __FILE__)
     end
   end
 end

data/lib/perron/feeds/split.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Perron
+  class Feeds
+    module Split
+      module_function
+
+      def grouped_resources(resources, extractor)
+        resources
+          .flat_map { |resource| extract(resource, extractor).map { [it, resource] } }
+          .group_by(&:first)
+          .transform_values { it.map(&:last) }
+      end
+
+      def split_values(resources, extractor)
+        resources
+          .flat_map { extract(it, extractor) }
+          .uniq
+      end
+
+      def extract(resource, extractor)
+        value = case extractor
+        when Symbol then resource.public_send(extractor)
+        when Proc then extractor.call(resource)
+        end
+
+        Array(value)
+      end
+
+      def split_path_for(type_config, value)
+        split_by = type_config[:split_by]
+
+        if split_by[:path]
+          split_by[:path].gsub(":value", value.to_s.parameterize)
+        else
+          extension = File.extname(type_config.path)
+          base_path = type_config.path.delete_suffix(extension)
+          field = split_by[:extractor]
+          field_name = field.is_a?(Symbol) ? field.to_s : "custom"
+
+          "#{base_path}/#{field_name}/#{value.to_s.parameterize}#{extension}"
+        end
+      end
+    end
+  end
+end

data/lib/perron/feeds.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+require "perron/feeds/split"
+
 module Perron
   class Feeds
     include ActionView::Helpers::TagHelper
+    include Perron::Feeds::Split
 
     def render(options = {})
       html_tags = []
@@ -22,6 +25,20 @@ module Perron
             title = "#{collection.name.humanize} #{type.to_s.humanize} Feed"
 
             html_tags << tag(:link, rel: "alternate", type: MIME_TYPES[type], title: title, href: absolute_url)
+
+            next unless feed[:split_by]
+
+            split_values(collection.resources, feed[:split_by][:extractor]).each do |value|
+              split_path = split_path_for(feed, value)
+              split_url = URI.join(url.root_url, split_path).to_s
+              split_title = if (title_template = feed[:split_by][:title])
+                title_template.gsub(":value", value.to_s.humanize)
+              else
+                "#{collection.name.humanize}: #{value.to_s.humanize} #{type.to_s.humanize} Feed"
+              end
+
+              html_tags << tag(:link, rel: "alternate", type: MIME_TYPES[type], title: split_title, href: split_url)
+            end
           end
         end
       end

data/lib/perron/html_processor/absolute_urls.rb

@@ -9,7 +9,7 @@ module Perron
 
           next if src.blank? || absolute_url?(src)
 
-          image["src"] = base_url + src
+          image["src"] = "#{base_url}/#{src.delete_prefix("/")}"
         end
       end
 

data/lib/perron/install/deploy.yml.erb

@@ -0,0 +1,14 @@
+# Deploy configuration for Perron
+# Requires Beam Up (`bundle add beam_up`)
+# See also: https://perron.railsdesigner.com/docs/deploy/#deploy-task
+
+# Uncomment and configure your provider:
+# provider: seal_static
+
+# seal_static:
+#   api_key: your_key_here
+
+before_actions:
+  - RAILS_ENV=production bundle exec rails perron:build
+after_actions:
+  - bundle exec rails perron:clobber

data/lib/perron/paginate.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Perron
+  class Paginate
+    def initialize(collection, page:, per_page:, base_path: nil, page_path_template: nil, use_query_params: false)
+      @collection = collection
+      @per_page = per_page
+      @base_path = base_path
+      @page_path_template = page_path_template || "/page/:page/"
+      @use_query_params = use_query_params
+
+      @total_items = collection.size
+      @total_pages = total_items.zero? ? 0 : (total_items.to_f / per_page).ceil
+      @current_page = page.clamp(1, total_pages.zero? ? 1 : total_pages)
+    end
+
+    attr_reader :current_page, :total_pages, :total_items, :per_page
+
+    def items
+      offset = (@current_page - 1) * @per_page
+
+      @collection[offset, @per_page] || []
+    end
+
+    def next? = @current_page < @total_pages
+
+    def previous? = @current_page > 1
+
+    def next
+      return unless next?
+
+      page_path(@current_page + 1)
+    end
+
+    def previous
+      return unless previous?
+
+      target = (@current_page == 2) ? 1 : @current_page - 1
+
+      page_path(target)
+    end
+
+    private
+
+    attr_reader :use_query_params
+
+    def page_path(number)
+      return if number < 1
+      return if number > @total_pages && @total_pages > 0
+
+      return @base_path if number <= 1
+
+      return "#{@base_path}?page=#{number}" if @use_query_params
+
+      @base_path.sub(/\/$/, "") + @page_path_template.sub(":page", number.to_s)
+    end
+  end
+end

data/lib/perron/relation.rb

@@ -2,9 +2,12 @@
 
 module Perron
   class Relation < Array
-    def initialize(resources = [])
-      super
+    def initialize(resources = [], model_class = nil)
+      super(resources)
+
+      @model_class = model_class
     end
+    attr_reader :model_class
 
     def where(**conditions)
       filtered = select do |resource|
@@ -19,21 +22,23 @@ module Perron
         end
       end
 
-      Relation.new(filtered)
+      Relation.new(filtered, @model_class)
     end
 
-    def limit(count) = Relation.new(first(count))
+    def limit(count) = Relation.new(first(count), @model_class)
 
-    def offset(count) = Relation.new(drop(count))
+    def offset(count) = Relation.new(drop(count), @model_class)
 
     def order(attribute, direction = :asc)
       if attribute.is_a?(Hash)
         attribute, direction = attribute.first
       end
 
-      sorted = sort_by { it.public_send(attribute) }
+      present, missing = partition { !it.public_send(attribute).nil? }
+      present = present.sort_by { it.public_send(attribute) }
+      present = present.reverse if direction == :desc
 
-      Relation.new((direction == :desc) ? sorted.reverse : sorted)
+      Relation.new(present + missing, @model_class)
     end
 
     def pluck(*attributes)
@@ -47,5 +52,20 @@ module Perron
         end
       end
     end
+
+    def in_order_of(attribute, values, filter: true)
+      return Relation.new([]) if values.empty?
+
+      indexed = values.each_with_index.to_h
+
+      resources = if filter
+        select { indexed.key?(it.public_send(attribute)) }
+          .sort_by { indexed[it.public_send(attribute)] }
+      else
+        sort_by { indexed[it.public_send(attribute)] || Float::INFINITY }
+      end
+
+      Relation.new(resources)
+    end
   end
 end

data/lib/perron/resource/class_methods.rb

@@ -22,6 +22,8 @@ module Perron
 
         def order(attribute, direction = :asc) = all.order(attribute, direction)
 
+        def in_order_of(attribute, values, filter: true) = all.in_order_of(attribute, values, filter:)
+
         def first(n = nil)
           n ? all.first(n) : all[0]
         end
@@ -44,6 +46,10 @@ module Perron
 
         def root = all.find(&:root?)
 
+        def destroy_all
+          all.each(&:destroy)
+        end
+
         def model_name
           @model_name ||= ActiveModel::Name.new(self, nil, name.demodulize.to_s)
         end

data/lib/perron/resource/configuration.rb

@@ -12,17 +12,17 @@ module Perron
 
             config.feeds = Options.new
 
-            config.feeds.atom = ActiveSupport::OrderedOptions.new
+            config.feeds.atom = FeedTypeConfig.new
             config.feeds.atom.enabled = false
             config.feeds.atom.path = "feeds/#{collection.name.demodulize.parameterize}.atom"
             config.feeds.atom.max_items = 20
 
-            config.feeds.json = ActiveSupport::OrderedOptions.new
+            config.feeds.json = FeedTypeConfig.new
             config.feeds.json.enabled = false
             config.feeds.json.path = "feeds/#{collection.name.demodulize.parameterize}.json"
             config.feeds.json.max_items = 20
 
-            config.feeds.rss = ActiveSupport::OrderedOptions.new
+            config.feeds.rss = FeedTypeConfig.new
             config.feeds.rss.enabled = false
             config.feeds.rss.path = "feeds/#{collection.name.demodulize.parameterize}.xml"
             config.feeds.rss.max_items = 20
@@ -31,6 +31,9 @@ module Perron
             config.related_posts.enabled = false
             config.related_posts.max = 5
 
+            config.pagination = ActiveSupport::OrderedOptions.new
+            config.pagination.path_template = "/page/:page/"
+
             config.sitemap = ActiveSupport::OrderedOptions.new
             config.sitemap.exclude = false
           end
@@ -55,6 +58,16 @@ module Perron
         end
       end
       private_constant :Options
+
+      class FeedTypeConfig < ActiveSupport::OrderedOptions
+        def split_by(method_or_lambda = nil, path: nil, title: nil, &block)
+          extractor = method_or_lambda || block
+
+          self[:split_by] = {extractor: extractor}
+          self[:split_by][:path] = path if path
+          self[:split_by][:title] = title if title
+        end
+      end
     end
   end
 end

data/lib/perron/resource/metadata.rb

@@ -3,27 +3,34 @@
 module Perron
   class Resource
     class Metadata
-      def initialize(resource:, frontmatter:, collection:)
+      def initialize(resource:, frontmatter:, collection:, controller_metadata: {})
         @resource = resource
         @frontmatter = frontmatter&.deep_symbolize_keys || {}
         @collection = collection
+        @controller_metadata = controller_metadata
         @config = Perron.configuration
       end
 
       def data
         @data ||= ActiveSupport::OrderedOptions
           .new
-          .merge(apply_fallbacks_and_defaults(to: merged_site_collection_resource_frontmatter))
+          .merge(apply_fallbacks_and_defaults(to: merged_metadata))
       end
 
       private
 
-      def merged_site_collection_resource_frontmatter = site_data.merge(collection_data).merge(@frontmatter)
+      def merged_metadata
+        site_data
+          .merge(collection_data)
+          .merge(@controller_metadata)
+          .merge(@frontmatter)
+      end
 
       def apply_fallbacks_and_defaults(to:)
         to[:title] ||= @config.site_name || Rails.application.name.underscore.camelize
 
         to[:canonical_url] ||= canonical_url
+        to[:explicit_canonical_url] = @frontmatter[:canonical_url]
 
         to[:image] = absolute_url(to[:image]) if to[:image]
 
@@ -65,7 +72,7 @@ module Perron
         return path if path.blank?
         return path if path.start_with?("http://", "https://", "//")
 
-        Perron.configuration.url.delete_suffix("/") + path
+        "#{Perron.configuration.url.delete_suffix("/")}/#{path.delete_prefix("/")}"
       end
 
       def site_data