perron 0.10.0 → 0.12.0

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/refinements/delete_suffixes.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 module Perron
-  module SuffixStripping
-    refine String do
-      def delete_suffixes(suffixes)
-        suffixes
-          .sort_by(&:length)
-          .reverse_each
-          .reduce(self, :delete_suffix)
+  module Refinements
+    module DeleteSuffixes
+      refine String do
+        def delete_suffixes(suffixes)
+          suffixes
+            .sort_by(&:length)
+            .reverse_each
+            .reduce(self, :delete_suffix)
+        end
       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
@@ -70,6 +70,7 @@ module Perron
           @tokenized_content ||= {}
 
           return @tokenized_content[target_resource] if @tokenized_content.key?(target_resource)
+          return [] if target_resource.content.blank?
 
           content = target_resource.content.gsub(/<[^>]*>/, " ")
           tokens = content.downcase.scan(/\w+/).reject { StopWords.all.include?(it) || it.length < 3 }

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/resource/slug.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "perron/refinements/delete_suffixes"
+
+module Perron
+  class Resource
+    class Slug
+      using Perron::Refinements::DeleteSuffixes
+
+      def initialize(resource, frontmatter)
+        @resource = resource
+        @frontmatter = frontmatter
+      end
+
+      def create
+        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
+
+      def dot_prepended_allowed_extensions = Perron.configuration.allowed_extensions.map { ".#{it}" }
+    end
+  end
+end

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,10 +30,21 @@ 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
 
+    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 content
       page_content = Perron::Resource::Separator.new(raw_content).content
 
@@ -41,10 +53,14 @@ module Perron
       Perron::Resource::Renderer.erb(page_content, {resource: self})
     end
 
-    def metadata = Perron::Resource::Separator.new(raw_content).metadata
+    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)
 
-    def raw_content = File.read(@file_path)
-    alias_method :raw, :raw_content
+        File.join("content", collection, element)
+      end
+    end
 
     def collection = Collection.new(self.class.model_name.collection)
 
@@ -53,8 +69,8 @@ module Perron
 
     private
 
-    def erb_processing?
-      @file_path.ends_with?(".erb") || metadata.erb == true
+    def frontmatter
+      @frontmatter ||= Perron::Resource::Separator.new(raw_content).frontmatter
     end
 
     def generate_id
@@ -62,5 +78,13 @@ module Perron
         @file_path.delete_prefix(Perron.configuration.input.to_s).parameterize
       ).first(ID_LENGTH)
     end
+
+    def erb_processing?
+      @file_path.ends_with?(".erb") || metadata.erb == true
+    end
+
+    def root?
+      collection.name.inquiry.pages? && File.basename(filename) == "root"
+    end
   end
 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/builder/assets.rb

@@ -29,7 +29,8 @@ module Perron
           end
 
           FileUtils.mkdir_p(destination)
-          FileUtils.cp_r(Dir.glob("#{source}/*"), destination)
+          FileUtils.move(Dir.glob("#{source}/*"), destination, force: true)
+          FileUtils.remove_dir(source)
 
           puts "   Copied assets to `#{destination.relative_path_from(Rails.root)}`"
 

data/lib/perron/site/builder/feeds/json.rb

@@ -18,14 +18,14 @@ module Perron
             hash = Rails.application.routes.url_helpers.with_options(@configuration.default_url_options) do |url|
               {
                 version: "https://jsonfeed.org/version/1.1",
-                title: @configuration.site_name,
                 home_page_url: @configuration.url,
-                description: @configuration.site_description,
+                title: feed_configuration.title.presence || @configuration.site_name,
+                description: feed_configuration.description.presence || @configuration.site_description,
                 items: resources.map do |resource|
                   {
                     id: resource.id,
                     url: url.polymorphic_url(resource),
-                    date_published: (resource.metadata.published_at || resource.metadata.updated_at)&.iso8601,
+                    date_published: resource.published_at&.iso8601,
                     title: resource.metadata.title,
                     content_html: Perron::Markdown.render(resource.content)
                   }
@@ -43,8 +43,10 @@ module Perron
               .reject { it.metadata.feed == false }
               .sort_by { it.metadata.published_at || it.metadata.updated_at || Time.current }
               .reverse
-              .take(@collection.configuration.feeds.json.max_items)
+              .take(feed_configuration.max_items)
           end
+
+          def feed_configuration = @collection.configuration.feeds.json
         end
       end
     end

data/lib/perron/site/builder/feeds/rss.rb

@@ -18,8 +18,8 @@ module Perron
             Nokogiri::XML::Builder.new(encoding: "UTF-8") do |xml|
               xml.rss(:version => "2.0", "xmlns:atom" => "http://www.w3.org/2005/Atom") do
                 xml.channel do
-                  xml.title @configuration.site_name
-                  xml.description @configuration.site_description
+                  xml.title feed_configuration.title.presence || @configuration.site_name
+                  xml.description feed_configuration.description.presence || @configuration.site_description
                   xml.link @configuration.url
                   xml.generator "Perron (#{Perron::VERSION})"
 
@@ -28,7 +28,7 @@ module Perron
                       xml.item do
                         xml.guid resource.id
                         xml.link url.polymorphic_url(resource), isPermaLink: true
-                        xml.pubDate((resource.metadata.published_at || resource.metadata.updated_at)&.rfc822)
+                        xml.pubDate(resource.published_at&.rfc822)
                         xml.title resource.metadata.title
                         xml.description { xml.cdata(Perron::Markdown.render(resource.content)) }
                       end
@@ -46,8 +46,10 @@ module Perron
               .reject { it.metadata.feed == false }
               .sort_by { it.metadata.published_at || it.metadata.updated_at || Time.current }
               .reverse
-              .take(@collection.configuration.feeds.rss.max_items)
+              .take(feed_configuration.max_items)
           end
+
+          def feed_configuration = @collection.configuration.feeds.rss
         end
       end
     end

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

@@ -13,6 +13,8 @@ module Perron
 
         def generate
           Perron::Site.collections.each do |collection|
+            next if collection.configuration.blank?
+
             config = collection.configuration.feeds
 
             if config.rss.enabled

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

@@ -29,10 +29,12 @@ module Perron
         private
 
         def save_html(html)
-          directory_path = @output_path.join(@path.delete_prefix("/"))
-          file_path = directory_path.join("index.html")
+          prefixless_path = @path.delete_prefix("/")
 
-          FileUtils.mkdir_p(directory_path)
+          file_path = @output_path.join(prefixless_path)
+          file_path = file_path.join("index.html") if File.extname(prefixless_path).empty?
+
+          FileUtils.mkdir_p(file_path.dirname)
           File.write(file_path, html)
 
           print "\e[32m.\e[0m"

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

@@ -25,6 +25,7 @@ module Perron
         private
 
         def add_urls_for(collection, with:)
+          return if collection.configuration.blank?
           return if collection.configuration.sitemap.exclude == true
 
           collection.resources.each do |resource|

data/lib/perron/site/builder.rb

@@ -39,7 +39,7 @@ module Perron
       def paths
         Set.new.tap do |paths|
           Perron::Site.collections.each { Perron::Site::Builder::Paths.new(it, paths).get }
-        end.to_a
+        end
       end
 
       def render_page(path) = Perron::Site::Builder::Page.new(path).render

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.12.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