perron 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1757232a5830a600f00f1517b0aa26c0f95cc55005c32cdb7865282b522cefec
-  data.tar.gz: ba9a09ab06d80c8cc266c210d51770c5577d079dbfab6226f058c1f39a974505
+  metadata.gz: 70a9d142afefaac54496efbd93312cae38e14525b7f6310be576f74e7f9dfb4d
+  data.tar.gz: fd010ef141b72700120c926a104b8f33f72971d94e58ae01c8c793424d4c5319
 SHA512:
-  metadata.gz: 82e81dbe7b346d47d539ab50b098c1b2542241d8864e3ed0cddf3e565b39785ae6710718a3db158cacaa27e67ea436960b88b012851ec5e85d7c91d3d0baa718
-  data.tar.gz: bdc619b82756afede00259a7f89970bac482a2e7204f2b8a66ad80b798467604b934462fe69d93e9d70e359abc298b0f72fcbf6842dde0258b7aaabe14a5042c
+  metadata.gz: 9ab5c1d522c8645f3470451e74c7a5a3475f1a683d6dc953e88fd8fb123e4477558ae99839f2db4742741663c2957eec9d94696d05d7936aa1df14880a5d59a4
+  data.tar.gz: fb40411ad56556967b82396d1bb540766550e73131b9358f870f441c75bd1538c9ef071b3fcb4a6c371f389ee7a1a031c101c4e24cb76b9875b4841756a68dc7

data/Gemfile.lock

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

data/README.md

@@ -38,7 +38,7 @@ end
 
 ## Mode
 
-Perron can operate in two modes, configured via `config.mode`. This allows you to build either a full static site or integrate pages into a dynamic Rails application.
+Perron can operate in two modes, configured via `config.mode`. This allows a build to be either a full static site or be integrated pages in a dynamic Rails application.
 
 | **Mode** | `:standalone` (default) | `:integrated` |
 | :--- | :--- | :--- |
@@ -54,7 +54,7 @@ Perron is, just like Rails, designed with convention over configuration in mind.
 The controllers are located in `app/controllers/content/`. To make them available, create a route: `resources :posts, module: :content, only: %w[index show]`.
 
 
-### Create content
+### Create a new collection
 
 ```bash
 bin/rails generate content Post
@@ -66,12 +66,39 @@ This will create the following files:
 * `app/controllers/content/posts_controller.rb`
 * `app/views/content/posts/index.html.erb`
 * `app/views/content/posts/show.html.erb`
-* Adds route: `resources :posts, module: :content, only: %w[index show]`
+
+And adds a route: `resources :posts, module: :content, only: %w[index show]`
+
+
+### Routes
+
+Perron uses standard Rails routing, allowing the use of familiar route helpers. For a typical “clean slug”, the filename without extensions serves as the `id` parameter (slug).
+```ruby
+<%# For app/content/pages/about.md %>
+<%= link_to "About Us", page_path("about") # => <a href="/about/">About Us</a> %>
+```
+
+To create files with specific extensions directly (e.g., `pricing.html`), the route must first be configured to treat the entire filename as the ID. In `config/routes.rb`, modify the generated `resources` line by adding a `constraints` option:
+
+```ruby
+# Change from…
+resources :pages, path: "/", module: :content, only: %w[show]
+
+# …to…
+resources :pages, path: "/", module: :content, only: %w[show], constraints: { id: /[^\/]+/ }
+```
+
+With this change, a content file named `app/content/pages/pricing.html.erb` can be linked using the full filename. The builder will then create `pricing.html` in the output directory.
+```ruby
+<%= link_to "View Pricing", page_path("pricing", format: :html) # => <a href="/pricing.html">View Pricing</a> %>
+```
 
 
 ### 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. This is automatically added for you when you create a `Page` collection.
+To set a root page, include `Perron::Root` in your `Content::PagesController` and add a `app/content/pages/root.{md,erb,*}` file. Then add `root to: "content/pages#root"` add the bottom of your `config/routes.erb`.
+
+This is automatically added for you when you create a `Page` collection.
 
 
 ## Markdown support
@@ -244,9 +271,9 @@ You can render data collections directly using Rails-like partial rendering. Whe
 <%= 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.
+This expects a partial at `app/views/content/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 -->
+<!-- app/views/content/features/_feature.html.erb -->
 <div class="feature">
   <h4><%= feature.name %></h4>
   <p><%= feature.description %></p>
@@ -289,9 +316,14 @@ Feeds are configured within the `Resource` class corresponding to a collection:
 class Content::Post < Perron::Resource
   configure do |config|
     config.feeds.rss.enabled = true
+    # config.feeds.rss.title = "My RSS feed" # defaults to configured site_name
+    # config.feeds.rss.description = "My RSS feed description" # defaults to configured site_description
     # config.feeds.rss.path = "path-to-feed.xml"
     # config.feeds.rss.max_items = 25
+    #
     config.feeds.json.enabled = true
+    # config.feeds.json.title = "My JSON feed" # defaults to configured site_name
+    # config.feeds.json.description = "My JSON feed description" # defaults to configured site_description
     # config.feeds.json.max_items = 15
     # config.feeds.json.path = "path-to-feed.json"
   end
@@ -362,10 +394,12 @@ Your content here…
 Set collection defaults in the resource model:
 ```ruby
 class Content::Post < Perron::Resource
-  # …
+  Perron.configure do |config|
+    # …
 
-  config.metadata.description = "Put your routine tasks on autopilot"
-  config.metadata.author = "Helptail team"
+    config.metadata.description = "Put your routine tasks on autopilot"
+    config.metadata.author = "Helptail team"
+  end
 end
 ```
 

data/lib/generators/content/content_generator.rb

@@ -5,6 +5,8 @@ require "rails/generators/base"
 class ContentGenerator < Rails::Generators::NamedBase
   source_root File.expand_path("templates", __dir__)
 
+  class_option :force_plural, type: :boolean, default: false, desc: "Forces the use of a plural model name and class"
+
   argument :actions, type: :array, default: %w[index show], desc: "Specify which actions to generate (index/show)"
 
   def create_model
@@ -35,8 +37,23 @@ class ContentGenerator < Rails::Generators::NamedBase
     route "resources :#{plural_file_name}, module: :content, only: %w[#{actions.join(" ")}]"
   end
 
+  def add_root_route
+    return unless pages_controller?
+    return if root_route_exists?
+
+    inject_into_file "config/routes.rb", "  root to: \"content/pages#show\"\n", before: /^\s*end\s*$/
+  end
+
   private
 
+  def file_name
+    options[:force_plural] ? super.pluralize : super.singularize
+  end
+
+  def class_name
+    options[:force_plural] ? super.pluralize : super.singularize
+  end
+
   def view_directory = Rails.root.join("app", "views", "content", plural_file_name)
 
   def content_directory = Rails.root.join("app", "content", plural_file_name)
@@ -44,4 +61,12 @@ class ContentGenerator < Rails::Generators::NamedBase
   def plural_class_name = plural_name.camelize
 
   def pages_controller? = plural_file_name == "pages"
+
+  def root_route_exists?
+    routes = Rails.root.join("config", "routes.rb")
+
+    return false unless File.exist?(routes)
+
+    File.read(routes).match?(/\broot\s+to:/)
+  end
 end

data/lib/generators/perron/install_generator.rb

@@ -25,5 +25,9 @@ module Perron
         # gem "redcarpet"
       RUBY
     end
+
+    def gitignore_output_folder
+      append_to_file ".gitignore", "/#{Perron.configuration.output}/\n"
+    end
   end
 end

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

@@ -17,7 +17,7 @@ To use a data file, you can access it through the `Perron::Site.data` object fol
 
 This is a convenient shorthand for `Perron::Data.new("features")`, which can also be used directly:
 ```ruby
-
<%% Perron::Data.new("features").each do |feature| %>
+
<%% Perron::Data.new("features").each do |feature| %>
   <h4><%%= feature.name %></h4>
 
   <p><%%= feature.description %></p>
@@ -38,3 +38,20 @@ The wrapper object provides flexible, read-only access to each record's attribut
 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/content/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/content/features/_feature.html.erb -->
+<div class="feature">
+  <h4><%= feature.name %></h4>
+  <p><%= feature.description %></p>
+</div>
+```

data/lib/perron/collection.rb

@@ -12,7 +12,7 @@ module Perron
     end
 
     def configuration(resource_class = "Content::#{name.classify}".safe_constantize)
-      resource_class.configuration
+      resource_class&.configuration
     end
 
     def all(resource_class = "Content::#{name.classify}".safe_constantize)

data/lib/perron/data.rb

@@ -94,6 +94,8 @@ module Perron
       end
 
       def get_binding = binding
+
+      def default_url_options = Perron.configuration.default_url_options || {}
     end
     private_constant :HelperContext
 

data/lib/perron/feeds.rb

@@ -13,6 +13,7 @@ module Perron
 
           next if options[:only]&.map(&:to_s)&.exclude?(collection_name)
           next if options[:except]&.map(&:to_s)&.include?(collection_name)
+          next if collection.configuration.blank?
 
           collection.configuration.feeds.each do |type, feed|
             next unless feed.enabled && feed.path && MIME_TYPES.key?(type)

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

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

@@ -5,7 +5,7 @@ require "perron/refinements/delete_suffixes"
 module Perron
   class Resource
     class Slug
-      using Perron::SuffixStripping
+      using Perron::Refinements::DeleteSuffixes
 
       def initialize(resource, frontmatter)
         @resource = resource

data/lib/perron/resource.rb

@@ -34,14 +34,6 @@ module Perron
     alias_method :path, :slug
     alias_method :to_param, :slug
 
-    def content
-      page_content = Perron::Resource::Separator.new(raw_content).content
-
-      return page_content unless erb_processing?
-
-      Perron::Resource::Renderer.erb(page_content, {resource: self})
-    end
-
     def metadata
       Perron::Resource::Metadata.new(
         resource: self,
@@ -53,6 +45,14 @@ module Perron
     def raw_content = File.read(@file_path)
     alias_method :raw, :raw_content
 
+    def content
+      page_content = Perron::Resource::Separator.new(raw_content).content
+
+      return page_content unless erb_processing?
+
+      Perron::Resource::Renderer.erb(page_content, {resource: self})
+    end
+
     def to_partial_path
       @to_partial_path ||= begin
         element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(self.class.model_name))
@@ -62,10 +62,6 @@ module Perron
       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:)
@@ -77,14 +73,18 @@ module Perron
       @frontmatter ||= Perron::Resource::Separator.new(raw_content).frontmatter
     end
 
-    def erb_processing?
-      @file_path.ends_with?(".erb") || metadata.erb == true
-    end
-
     def generate_id
       Digest::SHA1.hexdigest(
         @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/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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Rails Designer Developers