perron 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f86f6e49cb1954ed51dc8aa0c2b6cfdaf3f1fcc3c78141b36c837f0eef26a9c8
-  data.tar.gz: efaff555c00579430812ca06e3ee6a87376db403321ab302762b393356d7607a
+  metadata.gz: 709c1a304332c522dd7e425824f2718b1a84994db9695b842cddab07fa2a6c2d
+  data.tar.gz: cd636faddbff65dd1cc27652fb9141a936ce7df7e5f4fca1e156fd7b1ff27522
 SHA512:
-  metadata.gz: c7e7c64d77fac8aadb06e3fc3541db5f8593a571938c12020dcbcb03e3f968dd326eede32b06342843df4b0e84e8722b4beb95b5d202283539b763ba3db01ada
-  data.tar.gz: 1a3f470b3412fa9187bca282ee1ac051cd1674c34a19a761b6cdedf901f0e5e2e6bb2c1a025ffadf1e2f478fcf13b9f8a90ab29579d46ae0cf3594099b13fb5d
+  metadata.gz: 40df8027fb5974b0670a80b4c61e918da1f3dd7cec833e5fab48cdb606ddb9d9e56480cb69ad3c3033c2fdf1deb09e0c105cb15730cb92581e1d57c3db57ce3f
+  data.tar.gz: af0d331538e600ad27d23f9377d6cdabcc1f3142ad7d07de517b002334c0414896edb45d6d0d5d6ab50a6af81be12f4b2bf667c15e8bc50e211a824b6701d1b2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    perron (0.15.0)
+    perron (0.16.0)
       csv
       json
       psych
@@ -120,7 +120,8 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.25.5)
+    mini_portile2 (2.8.9)
+    minitest (5.27.0)
     net-imap (0.5.9)
       date
       net-protocol
@@ -131,6 +132,9 @@ GEM
     net-smtp (0.5.1)
       net-protocol
     nio4r (2.7.4)
+    nokogiri (1.18.8)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     nokogiri (1.18.8-aarch64-linux-gnu)
       racc (~> 1.4)
     nokogiri (1.18.8-aarch64-linux-musl)
@@ -244,7 +248,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
+    unicode-emoji (4.2.0)
     useragent (0.16.11)
     websocket-driver (0.8.0)
       base64

data/lib/perron/configuration.rb

@@ -16,8 +16,6 @@ module Perron
       @config.site_name = nil
       @config.site_description = nil
 
-      @config.site_email = nil
-
       @config.output = "output"
 
       @config.mode = :standalone

data/lib/perron/content/data.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Content
+  module Data
+    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))
+      end
+
+      const_set(name, klass)
+    end
+  end
+end

data/lib/perron/data.rb

@@ -13,6 +13,17 @@ module Perron
     end
 
     class << self
+      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 path_for(identifier)
         path = Pathname.new(identifier)
 
@@ -107,6 +118,8 @@ module Perron
 
       def [](key) = @attributes[key.to_sym]
 
+      def association_value(key) = self[key]
+
       def to_partial_path
         @to_partial_path ||= begin
           identifier = @identifier.to_s

data/lib/perron/deprecator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Perron
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("1.0", "Perron")
+  end
+end

data/lib/perron/engine.rb

@@ -1,15 +1,22 @@
 # frozen_string_literal: true
 
+require "perron/output_server"
+
 module Perron
   class Engine < Rails::Engine
     initializer "perron.default_url_options" do |app|
       app.config.action_controller.default_url_options = Perron.configuration.default_url_options
     end
 
+    initializer "perron.output_server" do |app|
+      app.middleware.use Perron::OutputServer
+    end
+
     rake_tasks do
       load File.expand_path("../tasks/build.rake", __FILE__)
-      load File.expand_path("../tasks/validate.rake", __FILE__)
+      load File.expand_path("../tasks/clobber.rake", __FILE__)
       load File.expand_path("../tasks/sync_sources.rake", __FILE__)
+      load File.expand_path("../tasks/validate.rake", __FILE__)
     end
   end
 end

data/lib/perron/output_server.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Perron
+  class OutputServer
+    def initialize(app)
+      @app = app
+    end
+
+    def call(environment)
+      return @app.call(environment) if disabled?
+
+      static_file(environment).then do |file|
+        file ? serve(file) : @app.call(environment)
+      end
+    end
+
+    private
+
+    def disabled? = !enabled?
+
+    def static_file(environment)
+      request_path = Rack::Request.new(environment).path_info
+      file_path = File.join(output_path, request_path, "index.html")
+
+      File.file?(file_path) ? file_path : nil
+    end
+
+    def serve(file_path)
+      content = File.read(file_path)
+
+      [
+        200,
+
+        {
+          "Content-Type" => "text/html; charset=utf-8",
+          "Content-Length" => content.bytesize.to_s
+        },
+
+        [content]
+      ]
+    end
+
+    def enabled? = Dir.exist?(output_path)
+
+    def output_path
+      @output_path ||= Rails.root.join(Perron.configuration.output)
+    end
+  end
+end

data/lib/perron/resource/associations.rb

@@ -22,11 +22,11 @@ module Perron
           define_method(association_name) do
             cache_has_many_association(association_name) do
               associated_class = association_class_for(association_name, singularize: true, **options)
-              foreign_key = foreign_key_for(inverse_association_name, **options)
-              primary_key_method = options.fetch(:primary_key, :slug)
-              lookup_value = public_send(primary_key_method)
+              ids_key = "#{association_name}_ids"
 
-              associated_class.all.select { |record| record.metadata[foreign_key] == lookup_value }
+              metadata[ids_key] ?
+                records_for_ids(associated_class, metadata[ids_key]) :
+                records_for_foreign_key(associated_class, association_name, **options)
             end
           end
         end
@@ -41,6 +41,10 @@ module Perron
         @belongs_to_cache[name] = yield
       end
 
+      def foreign_key_for(base_name, **options)
+        (options[:foreign_key] || "#{base_name}_id").to_s
+      end
+
       def cache_has_many_association(name)
         @has_many_cache ||= {}
         return @has_many_cache[name] if @has_many_cache.key?(name)
@@ -49,18 +53,28 @@ module Perron
       end
 
       def association_class_for(association_name, singularize: false, **options)
-        class_name = options[:class_name] || begin
+        if options[:class_name]
+          options[:class_name].to_s.constantize
+        else
           name = association_name.to_s
           name = name.singularize if singularize
 
-          "Content::#{name.classify}"
+          "Content::#{name.classify}".constantize
         end
+      end
 
-        class_name.constantize
+      def records_for_ids(associated_class, ids)
+        ids = Array(ids)
+
+        associated_class.all.select { ids.include?(it[:id]) || ids.include?(it["id"]) }
       end
 
-      def foreign_key_for(base_name, **options)
-        (options[:foreign_key] || "#{base_name}_id").to_s
+      def records_for_foreign_key(associated_class, association_name, **options)
+        foreign_key = foreign_key_for(inverse_association_name, **options)
+        primary_key_method = options.fetch(:primary_key, :slug)
+        lookup_value = public_send(primary_key_method)
+
+        associated_class.all.select { it.association_value(foreign_key) == lookup_value }
       end
 
       def inverse_association_name = self.class.name.demodulize.underscore

data/lib/perron/resource/previewable.rb

@@ -9,6 +9,7 @@ module Perron
         def previewable?
           frontmatter.preview.present? && (draft? || scheduled?)
         end
+        alias_method :preview?, :previewable?
 
         def preview_token
           return nil unless previewable?

data/lib/perron/resource/sourceable.rb

@@ -40,7 +40,7 @@ module Perron
         end
 
         def combinations
-          datasets = source_names.map { Perron::Site.data.public_send(it) }
+          datasets = source_names.map { Perron::Data.new(it.to_s) }
 
           datasets.first.product(*datasets[1..])
         end
@@ -71,7 +71,8 @@ module Perron
             primary_key = options[:primary_key]
             singular_name = name.to_s.singularize
             identifier = frontmatter["#{singular_name}_#{primary_key}"]
-            hash[name] = Perron::Site.data.public_send(name).find { it.public_send(primary_key).to_s == identifier.to_s }
+
+            hash[name] = Perron::Data.new(name.to_s).find { it.public_send(primary_key).to_s == identifier.to_s }
           end
 
           Source.new(data)

data/lib/perron/resource.rb

@@ -66,6 +66,8 @@ module Perron
       render_inline_erb using: page_content
     end
 
+    def association_value(key) = metadata[key]
+
     def to_partial_path
       @to_partial_path ||= begin
         element = ActiveSupport::Inflector.underscore(ActiveSupport::Inflector.demodulize(self.class.model_name))

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Perron
+  module Site
+    class Builder
+      class Feeds
+        module Author
+          private
+
+          def author(resource)
+            author = resource.author || feed_configuration.author
+
+            Author.new(author) if author
+          end
+
+          class Author
+            def initialize(author)
+              @author = author
+            end
+
+            def name
+              @author.respond_to?(:metadata) ? @author.metadata.name : @author[:name]
+            end
+
+            def email
+              @author.respond_to?(:metadata) ? @author.metadata.email : @author[:email]
+            end
+
+            def url
+              @author.respond_to?(:metadata) ? @author.metadata.url : @author[:url]
+            end
+
+            def avatar
+              @author.respond_to?(:metadata) ? @author.metadata.avatar : @author[:avatar]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require "json"
+require "perron/site/builder/feeds/author"
 
 module Perron
   module Site
     class Builder
       class Feeds
         class Json
+          include Feeds::Author
+
           def initialize(collection:)
             @collection = collection
             @configuration = Perron.configuration
@@ -27,6 +30,7 @@ module Perron
                     id: resource.id,
                     url: url.polymorphic_url(resource, ref: feed_configuration.ref).delete_suffix("?ref="),
                     date_published: resource.published_at&.iso8601,
+                    authors: authors(resource),
                     title: resource.metadata.title,
                     content_html: Perron::Markdown.render(resource.content)
                   }
@@ -48,6 +52,14 @@ module Perron
           end
 
           def feed_configuration = @collection.configuration.feeds.json
+
+          def authors(resource)
+            author = author(resource)
+
+            return nil unless author&.name
+
+            [{name: author.name, email: author.email, url: author.url, avatar: author.avatar}.compact].presence
+          end
         end
       end
     end

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

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require "nokogiri"
+require "perron/site/builder/feeds/author"
 
 module Perron
   module Site
     class Builder
       class Feeds
         class Rss
+          include Feeds::Author
+
           def initialize(collection:)
             @collection = collection
             @configuration = Perron.configuration
@@ -29,6 +32,9 @@ module Perron
                         xml.guid resource.id
                         xml.link url.polymorphic_url(resource, ref: feed_configuration.ref).delete_suffix("?ref="), isPermaLink: true
                         xml.pubDate(resource.published_at&.rfc822)
+                        if (author = author(resource)) && author.email
+                          xml.author author.name ? "#{author.email} (#{author.name})" : author.email
+                        end
                         xml.title resource.metadata.title
                         xml.description { xml.cdata(Perron::Markdown.render(resource.content)) }
                       end

data/lib/perron/site.rb

@@ -24,6 +24,8 @@ module Perron
     def collection(name) = Collection.new(name)
 
     def data(name = nil)
+      Perron.deprecator.deprecation_warning(:data, "Use Content::Data::ClassName instead, e.g. `Content::Data::Users.all`")
+
       (name && Perron::Data.new(name)) || Perron::Data::Proxy.new
     end
   end

data/lib/perron/tasks/clobber.rake

@@ -0,0 +1,12 @@
+namespace :perron do
+  desc "Remove compiled static output"
+  task clobber: :environment do
+    output_path = Rails.root.join(Perron.configuration.output)
+
+    if Dir.exist?(output_path)
+      FileUtils.rm_rf(output_path)
+
+      puts "Removed #{output_path}"
+    end
+  end
+end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/lib/perron.rb

@@ -2,9 +2,11 @@
 
 require "perron/version"
 require "perron/configuration"
+require "perron/deprecator"
 require "perron/errors"
 require "perron/root"
 require "perron/site"
+require "perron/content/data"
 require "perron/resource"
 require "perron/markdown"
 require "perron/feeds"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -99,8 +99,10 @@ files:
 - lib/perron.rb
 - lib/perron/collection.rb
 - lib/perron/configuration.rb
+- lib/perron/content/data.rb
 - lib/perron/data.rb
 - lib/perron/data/proxy.rb
+- lib/perron/deprecator.rb
 - lib/perron/engine.rb
 - lib/perron/errors.rb
 - lib/perron/feeds.rb
@@ -111,6 +113,7 @@ files:
 - lib/perron/html_processor/target_blank.rb
 - lib/perron/markdown.rb
 - lib/perron/metatags.rb
+- lib/perron/output_server.rb
 - lib/perron/refinements/delete_suffixes.rb
 - lib/perron/resource.rb
 - lib/perron/resource/associations.rb
@@ -133,6 +136,7 @@ files:
 - lib/perron/site/builder.rb
 - lib/perron/site/builder/assets.rb
 - lib/perron/site/builder/feeds.rb
+- lib/perron/site/builder/feeds/author.rb
 - lib/perron/site/builder/feeds/json.rb
 - lib/perron/site/builder/feeds/rss.rb
 - lib/perron/site/builder/page.rb
@@ -141,6 +145,7 @@ files:
 - lib/perron/site/builder/sitemap.rb
 - lib/perron/site/validate.rb
 - lib/perron/tasks/build.rake
+- lib/perron/tasks/clobber.rake
 - lib/perron/tasks/sync_sources.rake
 - lib/perron/tasks/validate.rake
 - lib/perron/version.rb
@@ -165,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.1
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Rails-based static site generator
 test_files: []