perron 0.17.0 → 1.0.0

data/lib/generators/rails/content/content_generator.rb

@@ -13,6 +13,7 @@ module Rails
         desc: "Create a new content file from template instead of generating scaffold"
       class_option :data, type: :array, default: [], banner: "source1(.ext) source2(.ext)",
         desc: "Specify data sources with optional extensions (defaults to .yml)"
+      class_option :inline, type: :boolean, default: false, desc: "Render show action inline instead of using a view template"
 
       argument :actions, type: :array, default: %w[index show], banner: "actions", desc: "Specify which actions to generate (index/show)"
 
@@ -53,6 +54,8 @@ module Rails
         empty_directory view_directory
 
         actions.each do |action|
+          next if action == "show" && options[:inline]
+
           template "#{action}.html.erb.tt", File.join(view_directory, "#{action}.html.erb")
         end
       end
@@ -76,7 +79,7 @@ module Rails
         options[:data].each do |source|
           name, extension = source.split(".", 2)
 
-          create_file File.join(content_directory, "#{name}.#{extension || "yml"}"), ""
+          create_file File.join("app", "content", "data", "#{name}.#{extension || "yml"}"), ""
         end
       end
 
@@ -84,16 +87,12 @@ module Rails
         return if @content_mode
         return unless should_include_root?
 
-        inject_into_class "app/controllers/content/#{plural_file_name}_controller.rb", "Content::#{plural_class_name}Controller" do
-          <<-RUBY
+        controller_file = "app/controllers/content/#{plural_file_name}_controller.rb"
+        return unless File.exist?(File.join(destination_root, controller_file))
 
-        def root
-          @resource = Content::#{class_name}.root
+        root_action = "  def root\n    @resource = Content::#{class_name}.root\n\n    render :show\n  end\n\n"
 
-          render :show
-        end
-          RUBY
-        end
+        inject_into_file controller_file, root_action, after: "class Content::#{plural_class_name}Controller < ApplicationController\n"
       end
 
       def create_root_content_file
@@ -130,16 +129,20 @@ module Rails
       def pages_controller? = plural_file_name == "pages"
 
       def template_file
-        @template_file ||= Dir.glob(File.join(content_directory, "{YYYY-MM-DD-,}template.*.tt")).first
+        @template_file ||= Dir.glob(File.join(content_directory, "*.tt")).first
       end
 
       def filename_from_template
         @filename_from_template ||= begin
           return "untitled.md" unless template_file
 
-          File.basename(template_file, ".tt").tap do |name|
-            name.gsub!("YYYY-MM-DD", Time.current.strftime("%Y-%m-%d"))
-            name.sub!("template", @content_title ? @content_title.parameterize : "untitled")
+          name = File.basename(template_file, ".tt")
+          name = Time.current.strftime(name)
+
+          if name.include?("title")
+            name.sub("title", @content_title ? @content_title.parameterize : "untitled")
+          else
+            name
           end
         end
       end

data/lib/generators/rails/content/templates/controller.rb.tt

@@ -1,17 +1,19 @@
 class Content::<%= plural_class_name %>Controller < ApplicationController
-<%- if pages_controller? -%>
-  include Perron::Root
-<%- end -%>
-
 <%- if actions.include?("index") -%>
   def index
     @resources = Content::<%= class_name %>.all
   end
+<%- if actions.include?("show") -%>
 
+<%- end -%>
 <%- end -%>
 <%- if actions.include?("show") -%>
   def show
-    @resource = Content::<%= class_name %>.find(params[:id])
+    @resource = Content::<%= class_name %>.find!(params[:id])
+<%- if options[:inline] -%>
+
+    render @resource.inline
+<%- end -%>
   end
 <%- end -%>
 end

data/lib/generators/rails/content/templates/model.rb.tt

@@ -1,13 +1,13 @@
 class Content::<%= class_name %> < Perron::Resource
 <% if data_sources? -%>
-
   sources <%= data_sources.map { ":#{it}" }.join(", ") %>
 
-  def self.source_template(sources)
-    <<~TEMPLATE
+  def self.source_template(source)
+    <<~MARKDOWN
     ---
     ---
-    TEMPLATE
+
+    MARKDOWN
   end
 <% end -%>
 end

data/lib/perron/assets/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="400" height="400" fill="none" viewBox="0 0 400 400"><path fill="#f97316" d="M177.101 221.582a8.59 8.59 0 0 1 8.587-8.587h68.524q23.93 0 40.424-16.458 16.728-16.697 16.728-46.99 0-22.66-17.425-40.549-17.424-18.129-39.727-18.128H126.636c-8.836 0-16 7.163-16 16v244.766a8.364 8.364 0 1 1-16.727 0V89.696c0-8.837 7.164-16 16-16h144.303q29.272 0 51.576 23.137 22.303 23.136 22.303 52.714 0 36.495-21.606 58.678-21.606 21.944-52.273 21.944h-68.524a8.587 8.587 0 0 1-8.587-8.587m20 34.348a8.59 8.59 0 0 1 8.587-8.587h48.524q24.162 0 44.606-11.926 20.678-12.165 33.222-34.825 12.778-22.66 12.778-51.045 0-36.733-27.414-64.88-27.182-28.145-63.192-28.145H93.182c-8.837 0-16 7.163-16 16v299.114a8.364 8.364 0 1 1-16.727 0V55.348c0-8.837 7.163-16 16-16h177.757q28.111 0 52.97 15.266t39.495 40.788q14.868 25.522 14.868 54.145 0 32.44-14.868 59.155-14.87 26.477-39.495 41.265-24.394 14.55-52.97 14.55h-48.524a8.59 8.59 0 0 1-8.587-8.587m20 34.348a8.587 8.587 0 0 1 8.587-8.587h28.524q24.86 0 47.626-10.018 22.768-10.257 39.495-27.431 16.96-17.412 26.95-41.981 9.99-24.806 9.99-52.714 0-33.393-16.96-62.732-16.959-29.578-45.768-46.99-28.575-17.65-61.333-17.651H59.727c-8.836 0-16 7.163-16 16v353.462a8.364 8.364 0 0 1-16.727 0V21c0-8.837 7.163-16 16-16h211.212q37.172 0 69.697 20.036 32.526 19.799 51.808 53.192Q395 111.62 395 149.547q0 33.871-11.384 62.494-11.383 28.385-30.667 47.228-19.283 18.844-44.838 29.339-25.555 10.257-53.899 10.257h-28.524a8.59 8.59 0 0 1-8.587-8.587m-73.01 41.358a8.364 8.364 0 0 1-16.727 0V124.043c0-8.836 7.163-16 16-16h110.848q16.495 0 28.344 12.404 12.08 12.404 12.08 29.1 0 46.274-40.424 46.274h-88.524a8.587 8.587 0 1 1 0-17.174h88.524q11.152 0 17.424-6.44t6.273-22.66q0-10.495-6.97-17.412-6.737-6.918-16.727-6.918h-94.121c-8.837 0-16 7.164-16 16z" style="mix-blend-mode:multiply"/></svg>

data/lib/perron/collection.rb

@@ -16,11 +16,20 @@ module Perron
     end
 
     def all(resource_class = "Content::#{name.classify}".safe_constantize)
-      load_resources(resource_class).select(&:published?)
+      Perron::Relation.new(load_resources(resource_class).select(&:published?))
     end
     alias_method :resources, :all
 
     def find(slug, resource_class = Resource)
+      Perron.deprecator.deprecation_warning(
+        :find,
+        "Collection#find will return nil instead of raising in the next major version. Use #find! to raise an error."
+      )
+
+      find!(slug, resource_class)
+    end
+
+    def find!(slug, resource_class = Resource)
       resource = load_resources(resource_class).find { it.slug == slug }
 
       return resource if resource

data/lib/perron/configuration.rb

@@ -13,17 +13,19 @@ module Perron
     def initialize
       @config = ActiveSupport::OrderedOptions.new
 
-      @config.site_name = nil
-      @config.site_description = nil
-
       @config.output = "output"
 
+      @config.output_server_strict = true
+
       @config.mode = :standalone
 
-      @config.allowed_extensions = %w[erb md]
+      @config.live_reload = false
+      @config.live_reload_watch_paths = %w[app/content app/views app/assets]
+      @config.live_reload_skip_paths = %w[app/assets/builds]
 
       @config.exclude_from_public = %w[assets storage]
       @config.excluded_assets = %w[action_cable actioncable actiontext activestorage rails-ujs trix turbo]
+      @config.allowed_extensions = %w[erb md]
 
       @config.view_unpublished = Rails.env.development?
 
@@ -35,11 +37,18 @@ module Perron
 
       @config.markdown_options = {}
 
+      @config.search_scope = []
+
+      @config.cache_data_sources = false
+
       @config.sitemap = ActiveSupport::OrderedOptions.new
       @config.sitemap.enabled = false
       @config.sitemap.priority = 0.5
       @config.sitemap.change_frequency = :monthly
 
+      @config.site_name = nil
+      @config.site_description = nil
+
       @config.metadata = ActiveSupport::OrderedOptions.new
       @config.metadata.title_separator = " — "
     end

data/lib/perron/content/data.rb

@@ -2,9 +2,13 @@
 
 module Content
   module Data
+    def self.new(identifier)
+      Perron::DataSource.new(identifier)
+    end
+
     def self.const_missing(name)
-      klass = Class.new(Perron::Data) do
-        def self.const_missing(nested_name) = const_set(nested_name, Class.new(Perron::Data))
+      klass = Class.new(Perron::DataSource) do
+        def self.const_missing(nested_name) = const_set(nested_name, Class.new(Perron::DataSource))
       end
 
       const_set(name, klass)

data/lib/perron/data_source/class_methods.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Perron
+  class DataSource < SimpleDelegator
+    module ClassMethods
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def all
+          parts = name.to_s.split("::").drop(2)
+          identifier = parts.empty? ? name.demodulize.underscore : parts.map(&:underscore).join("/")
+
+          new(identifier)
+        end
+
+        def find(id)
+          all.find { it[:id] == id || it["id"] == id }
+        end
+
+        def find!(id)
+          data_source = all.find { it[:id] == id || it["id"] == id }
+
+          return data_source if data_source
+
+          raise Errors::DataSourceNotFoundError, "Row not found with id: #{id}"
+        end
+
+        def count = all.size
+
+        def first = all.first
+
+        def second = all[1]
+
+        def third = all[2]
+
+        def fourth = all[3]
+
+        def fifth = all[4]
+
+        def forty_two = all[41]
+
+        def last = all.last
+
+        def take(n) = all.first(n)
+
+        def path_for(identifier)
+          path = Pathname.new(identifier)
+
+          return path.to_s if path.file? && path.absolute?
+
+          base_path = Rails.root.join("app", "content", "data")
+
+          SUPPORTED_EXTENSIONS.lazy.map { base_path.join("#{identifier}#{it}") }.find(&:exist?)&.to_s
+        end
+
+        def path_for!(identifier)
+          path_for(identifier).tap do |path|
+            raise Errors::FileNotFoundError, "No data file found for `#{identifier}`" unless path
+          end
+        end
+
+        def directory?(identifier) = Dir.exist?(Rails.root.join("app", "content", "data", identifier))
+      end
+    end
+  end
+end

data/lib/perron/data_source/helper_context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Perron
+  class DataSource < SimpleDelegator
+    class HelperContext
+      include Singleton
+
+      def initialize
+        self.class.include ActionView::Helpers::AssetUrlHelper
+        self.class.include ActionView::Helpers::DateHelper
+        self.class.include Rails.application.routes.url_helpers
+      end
+
+      def get_binding = binding
+
+      def default_url_options = Perron.configuration.default_url_options || {}
+    end
+    private_constant :HelperContext
+  end
+end

data/lib/perron/data_source/item.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Perron
+  class DataSource < SimpleDelegator
+    class Item
+      def initialize(attributes, identifier:)
+        @attributes = attributes.transform_keys(&:to_sym)
+        @identifier = identifier
+      end
+
+      def [](key) = @attributes[key.to_sym]
+
+      def association_value(key) = self[key]
+
+      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
+
+        @attributes[method_name]
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        @attributes.key?(method_name) || super
+      end
+    end
+    private_constant :Item
+  end
+end

data/lib/perron/{data → data_source}/proxy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Perron
-  class Data
+  class DataSource
     class Proxy
       include Enumerable
 

data/lib/perron/data_source.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require "csv"
+
+require "perron/data_source/class_methods"
+require "perron/data_source/item"
+require "perron/data_source/helper_context"
+
+module Perron
+  class DataSource < SimpleDelegator
+    include Enumerable
+
+    include Perron::DataSource::ClassMethods
+
+    def initialize(identifier)
+      @identifier = identifier
+      @file_path = self.class.path_for!(identifier)
+      @records = records
+
+      super(records)
+    end
+
+    def self.all
+      identifier = name.to_s.split("::").drop(2).map { it.underscore }.join("/")
+      identifier = name.demodulize.underscore if identifier.empty?
+
+      return cached(identifier) if Perron.configuration.cache_data_sources
+
+      new(identifier)
+    end
+
+    def self.cached(identifier)
+      @_data_sources ||= {}
+      @_data_sources[identifier] ||= new(identifier)
+    end
+
+    def each(&block) = @records.each(&block)
+
+    def count = @records.count
+
+    def first(n = nil)
+      n ? @records.first(n) : @records.first
+    end
+
+    def last = @records.last
+
+    def [](index) = @records[index]
+
+    def size = @records.size
+    alias_method :length, :size
+
+    private
+
+    PARSER_METHODS = {
+      ".yml" => :parse_yaml, ".yaml" => :parse_yaml,
+      ".json" => :parse_json, ".csv" => :parse_csv
+    }.freeze
+    SUPPORTED_EXTENSIONS = PARSER_METHODS.keys
+
+    def records
+      content = rendered_from(@file_path)
+      data = parsed_from(content, @file_path)
+
+      unless data.is_a?(Array)
+        raise Errors::DataParseError, "Data in `#{@file_path}` must be an array of objects."
+      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}"
+        end
+
+        Item.new(item, identifier: @identifier)
+      end
+    end
+
+    def rendered_from(path)
+      raw_content = File.read(path)
+
+      render_erb(raw_content)
+    rescue NameError, ArgumentError, SyntaxError => error
+      raise Errors::DataParseError, "Failed to render ERB in `#{path}`: (#{error.class}) #{error.message}"
+    end
+
+    def parsed_from(content, path)
+      extension = File.extname(path)
+      parser_method = PARSER_METHODS.fetch(extension) do
+        raise Errors::UnsupportedDataFormatError, "Unsupported data format: #{extension}. Supported formats: #{SUPPORTED_EXTENSIONS.join(", ")}"
+      end
+
+      send(parser_method, content, path)
+    end
+
+    def render_erb(content) = ERB.new(content).result(HelperContext.instance.get_binding)
+
+    def parse_yaml(content, path)
+      YAML.safe_load(content, permitted_classes: [Symbol, Time], aliases: true)
+    rescue Psych::SyntaxError => error
+      line_info = error.line ? " at line #{error.line}" : ""
+      column_info = error.column ? ", column #{error.column}" : ""
+
+      raise Errors::DataParseError, "Invalid YAML syntax in `#{path}`#{line_info}#{column_info}: #{error.problem}"
+    end
+
+    def parse_json(content, path)
+      JSON.parse(content, symbolize_names: true)
+    rescue JSON::ParserError => error
+      line_match = error.message.match(/at line (\d+)/)
+      line_info = line_match ? " at line #{line_match[1]}" : ""
+
+      raise Errors::DataParseError, "Invalid JSON syntax in `#{path}`#{line_info}: #{error.message}"
+    end
+
+    def parse_csv(content, path)
+      expected_headers = nil
+
+      CSV.new(content, headers: true, header_converters: :symbol).map.with_index do |row, index|
+        expected_headers ||= row.headers
+
+        if row.headers != expected_headers
+          missing = expected_headers - row.headers
+          extra = row.headers - expected_headers
+
+          error_parts = []
+          error_parts << "missing columns: #{missing.join(", ")}" if missing.any?
+          error_parts << "extra columns: #{extra.join(", ")}" if extra.any?
+
+          raise Errors::DataParseError, "Column mismatch in `#{path}` at row #{index + 2} (#{error_parts.join("; ")}). Expected: #{expected_headers.join(", ")}"
+        end
+
+        row.to_h
+      end
+    rescue CSV::MalformedCSVError => error
+      line_match = error.message.match(/line (\d+)/)
+      line_info = line_match ? " at line #{line_match[1]}" : ""
+
+      raise Errors::DataParseError, "Malformed CSV in `#{path}`#{line_info}: #{error.message}"
+    end
+  end
+end

data/lib/perron/development_feed_server.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Perron
+  class DevelopmentFeedServer
+    def initialize(app)
+      @app = app
+    end
+
+    def call(environment)
+      request = Rack::Request.new(environment)
+
+      if build_only_path?(request.path_info)
+        render_message(request.path_info)
+      else
+        @app.call(environment)
+      end
+    end
+
+    private
+
+    def build_only_path?(path)
+      sitemap?(path) || feed?(path)
+    end
+
+    def render_message(path)
+      content_type = path.end_with?(".json") ? "application/json" : "application/xml"
+
+      [
+        200,
+
+        {
+          "Content-Type" => "#{content_type}; charset=utf-8",
+          "Content-Length" => message(path).bytesize.to_s
+        },
+
+        [message(path)]
+      ]
+    end
+
+    def sitemap?(path)
+      path.match?(/\/sitemap\.xml$/)
+    end
+
+    def feed?(path)
+      feed_paths.any? { path.end_with?("/#{it}") || path == "/#{it}" }
+    end
+
+    def message(path)
+      if path.end_with?(".json")
+        "{ \"message\": \"This feed is generated during build\" }"
+      elsif sitemap?(path)
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n  <!-- Sitemap is generated during build -->\n</urlset>"
+      else
+        "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<feed xmlns=\"http://www.w3.org/2005/Atom\">\n  <!-- Feed is generated during build -->\n</feed>"
+      end
+    end
+
+    def feed_paths
+      @feed_paths ||= Perron::Site.collections.flat_map do |collection|
+        config = collection.configuration
+        next [] unless config && config[:feeds]
+
+        config[:feeds].values.filter_map do |feed_config|
+          feed_config[:path] if feed_config[:enabled]
+        end
+      end.compact
+    end
+  end
+end

data/lib/perron/engine.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require "perron/output_server"
+require "perron/development_feed_server"
+require "mata"
 
 module Perron
   class Engine < Rails::Engine
@@ -9,12 +11,50 @@ module Perron
     end
 
     initializer "perron.output_server" do |app|
-      app.middleware.use Perron::OutputServer
+      app.middleware.use Perron::OutputServer if Rails.env.development?
+    end
+
+    initializer "perron.development_feed_server" do |app|
+      app.middleware.use Perron::DevelopmentFeedServer if Rails.env.development?
+    end
+
+    initializer "perron.configure_hmr", after: :load_config_initializers do |app|
+      if Rails.env.development? && Perron.configuration.live_reload
+        app.config.middleware.insert_before(
+          ActionDispatch::Static,
+          Mata,
+          watch: Perron.configuration.live_reload_watch_paths,
+          skip: Perron.configuration.live_reload_skip_paths
+        )
+      end
+    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
+
+          root to: "perron/concierge#show" unless app.routes.named_routes.key?(:root)
+        end
+      end
+
+      app.routes.finalize!
+    end
+
+    initializer "perron.inflections" do
+      ActiveSupport::Inflector.inflections(:en) do |inflect|
+        inflect.acronym "RSS"
+        inflect.acronym "Atom"
+        inflect.acronym "Json"
+      end
     end
 
     rake_tasks do
       load File.expand_path("../tasks/build.rake", __FILE__)
       load File.expand_path("../tasks/clobber.rake", __FILE__)
+      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__)
     end

data/lib/perron/errors.rb

@@ -10,6 +10,8 @@ module Perron
 
     class DataParseError < StandardError; end
 
+    class DataSourceNotFoundError < StandardError; end
+
     class ProcessorNotFoundError < StandardError; end
 
     class InvalidProcessorError < StandardError; end

data/lib/perron/feeds.rb

@@ -19,7 +19,7 @@ module Perron
             next unless feed.enabled && feed.path && MIME_TYPES.key?(type)
 
             absolute_url = URI.join(url.root_url, feed.path).to_s
-            title = "#{collection.name.humanize} #{type.to_s.upcase} Feed"
+            title = "#{collection.name.humanize} #{type.to_s.humanize} Feed"
 
             html_tags << tag(:link, rel: "alternate", type: MIME_TYPES[type], title: title, href: absolute_url)
           end
@@ -32,8 +32,9 @@ module Perron
     private
 
     MIME_TYPES = {
-      rss: "application/rss+xml",
-      json: "application/json"
+      atom: "application/atom+xml",
+      json: "application/json",
+      rss: "application/rss+xml"
     }
   end
 end

data/lib/perron/html_processor/absolute_urls.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Perron
+  class HtmlProcessor
+    class AbsoluteUrls < HtmlProcessor::Base
+      def process
+        @html.css("img").each do |image|
+          src = image["src"]
+
+          next if src.blank? || absolute_url?(src)
+
+          image["src"] = base_url + src
+        end
+      end
+
+      private
+
+      def absolute_url?(src)
+        src.start_with?("http://", "https://", "//")
+      end
+
+      def base_url
+        Perron.configuration.url.delete_suffix("/")
+      end
+    end
+  end
+end

data/lib/perron/html_processor/base.rb

@@ -3,8 +3,8 @@
 module Perron
   class HtmlProcessor
     class Base
-      def initialize(html)
-        @html = html
+      def initialize(html, resource: nil)
+        @html, @resource = html, resource
       end
 
       def process