perron 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebff05f1548f6e133cde9cdfc40ba692d65a52d548cdf47df78b16b52d072b49
-  data.tar.gz: 8fcf6d0a11a8ed4b7426c11473d1d8d791a329cd47417d072434b8a1d28e8c6c
+  metadata.gz: '080352c09efb475419f74de6ee7cf01a491d4cc349f6cf0d6e23d35132c83953'
+  data.tar.gz: 156c0419afc4c3aa77411ac7f7508cbea56de584d164624be86b4d2615baf7f5
 SHA512:
-  metadata.gz: fcb6b264a9d159852991f67803bf9f8e666d535a87dc8f12cd82e87362ce326ec3cfa47c0681bfa13e83889e7374fbfe3289d86674b7f8c120971c34969928a0
-  data.tar.gz: 45f0d1fd94a3152d396e64ef8178639fffdd527d8a7fc3c50318578cc71684587fa4622aa99f8b3cc347cf8729460d0d6853e22e0d07122c3b88de01c18c444d
+  metadata.gz: c75e1453c34bf8a8b8a4345d9167110745c1c47d8094aea3345e85fb46de51b0d326c904a7132c20e058ae89156c48dac5b9311121fc0359ad1d348ccde7d27f
+  data.tar.gz: a3acd15ee6f0224c032b31dac7272539e6ed6e6c9451a4b22d47c83c108f8fa374f5b6b7ceab97ae7bf4d6cc1296bbac8cd9c8788b28c7187f50c29c4621ee01

data/Gemfile.lock

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

data/README.md

@@ -1,6 +1,6 @@
 # Perron
 
-A Rails-based static site generator.
+Static Site Generator for Ruby on Rails. Build with Rails. Deploy static sites.
 
 **Sponsored By [Rails Designer](https://railsdesigner.com/)**
 

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

@@ -1,37 +1,25 @@
 # Data
 
-Perron can consume structured data from YML, JSON, or CSV files, making them available within your templates.
-This is useful for populating features, team members, or any other repeated data structure.
+Perron can consume structured data from YML, JSON, or CSV files, making them available within your templates. This is useful for populating features, team members, or any other repeated data structure.
 
 
 ## Usage
 
-To use a data file, you can access it through the `Perron::Site.data` object followed by the basename of the file:
+To use a data file, instantiate `Perron::Site.data` with the basename of the file and iterate over the result.
 ```erb
 <%% Perron::Site.data.features.each do |feature| %>
   <h4><%%= feature.name %></h4>
-
-  <p><%%= feature.description %></p>
-<%% end %>
-```
-
-This is a convenient shorthand for `Perron::Data.new("features")`, which can also be used directly:
-```ruby
-<%% Perron::Data.new("features").each do |feature| %>
-  <h4><%%= feature.name %></h4>
-
   <p><%%= feature.description %></p>
 <%% end %>
 ```
 
 
-## File Location and Formats
+## File location and formats
 
-By default, Perron looks up `app/content/data/` for files with a `.yml`, `.json`, or `.csv` extension.
-For a `new("features")` call, it would find `features.yml`, `features.json`, or `features.csv`. You can also provide a full, absolute path to any data file, like `Perron::Data.new("path-to-some-data-file")`.
+By default, Perron looks up `app/content/data/` for files with a `.yml`, `.json`, or `.csv` extension. For a `features` call, it would find `features.yml`, `features.json`, or `features.csv`. You can also provide a path to any data file, via `Perron::Data.new("path/to/data.json")`.
 
 
-## Accessing Data
+## Accessing data
 
 The wrapper object provides flexible, read-only access to each record's attributes. Both dot notation and hash-like key access are supported.
 ```ruby

data/lib/generators/perron/templates/initializer.rb.tt

@@ -1,7 +1,7 @@
 Perron.configure do |config|
   # config.output = "output"
 
-  # config.site_name = "Helptail"
+  # config.site_name = "Chirp Form"
 
   # The build mode for Perron. Can be :standalone or :integrated
   # config.mode = :standalone
@@ -16,8 +16,8 @@ Perron.configure do |config|
 
   # Set default meta values
   # Examples:
-  # - `config.metadata.description = "Put your routine tasks on autopilot"`
-  # - `config.metadata.author = "Helptail Team"`
+  # - `config.metadata.description = "Add forms to any static site. Display responses anywhere."`
+  # - `config.metadata.author = "Chirp Form Team"`
 
   # Set meta title suffix
   # config.metadata.title_suffix = nil

data/lib/perron/engine.rb

@@ -9,6 +9,7 @@ module Perron
     rake_tasks do
       load File.expand_path("../tasks/build.rake", __FILE__)
       load File.expand_path("../tasks/validate.rake", __FILE__)
+      load File.expand_path("../tasks/sync_sources.rake", __FILE__)
     end
   end
 end

data/lib/perron/markdown.rb

@@ -17,39 +17,69 @@ module Perron
         @parser ||= markdown_parser
       end
 
-      def markdown_parser
-        if defined?(::Commonmarker)
-          CommonMarkerParser.new
-        elsif defined?(::Kramdown)
-          KramdownParser.new
-        elsif defined?(::Redcarpet)
-          RedcarpetParser.new
+      def configured_parser
+        return unless (parser_name = Perron.configuration.markdown_parser)
+        class_name = parser_name.to_s.camelize
+        class_name += "Parser" unless class_name.end_with?("Parser")
+
+        klass = if const_defined?(class_name)
+          const_get(class_name)
+        elsif Object.const_defined?(class_name)
+          Object.const_get(class_name)
         else
-          PlainTextParser.new
+          raise "Can't find parser #{parser_name} by class name #{class_name}"
+        end
+
+        unless klass.available?
+          raise "Parser #{parser_name} #{class_name} is not available (gem not installed?)"
         end
+
+        klass
       end
-    end
 
-    class CommonMarkerParser
-      def parse(text) = Commonmarker.to_html(text, **Perron.configuration.markdown_options)
+      def available_parser = Parser.descendants.find(&:available?) || Parser
+
+      def markdown_parser
+        (configured_parser || available_parser).new(**Perron.configuration.markdown_options)
+      end
     end
 
-    class KramdownParser
-      def parse(text) = Kramdown::Document.new(text, Perron.configuration.markdown_options).to_html
+    class Parser
+      attr_reader :options
+
+      def initialize(**options)
+        @options = options
+      end
+
+      def parse(text) = text.to_s
+
+      def self.available? = true
     end
 
-    class RedcarpetParser
-      def parse(text)
-        options = Perron.configuration.markdown_options
-        renderer = Redcarpet::Render::HTML.new(options.fetch(:renderer_options, {}))
-        markdown = Redcarpet::Markdown.new(renderer, options.fetch(:markdown_options, {}))
+    class RedcarpetParser < Parser
+      def renderer
+        @renderer ||= Redcarpet::Render::HTML.new(options.fetch(:renderer_options, {}))
+      end
 
-        markdown.render(text)
+      def markdown
+        @markdown ||= Redcarpet::Markdown.new(renderer, options.fetch(:markdown_options, {}))
       end
+
+      def parse(text) = markdown.render(text)
+
+      def self.available? = defined?(::Redcarpet)
     end
 
-    class PlainTextParser
-      def parse(text) = text.to_s
+    class KramdownParser < Parser
+      def parse(text) = Kramdown::Document.new(text, options).to_html
+
+      def self.available? = defined?(::Kramdown)
+    end
+
+    class CommonMarkerParser < Parser
+      def parse(text) = Commonmarker.to_html(text, **options)
+
+      def self.available? = defined?(::Commonmarker)
     end
   end
 end

data/lib/perron/resource/associations.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Associations
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def belongs_to(association_name, **options)
+          define_method(association_name) do
+            cache_belongs_to_association(association_name) do
+              associated_class = association_class_for(association_name, **options)
+              foreign_key = foreign_key_for(association_name, **options)
+              identifier = metadata[foreign_key]
+
+              identifier ? associated_class.find(identifier) : nil
+            end
+          end
+        end
+
+        def has_many(association_name, **options)
+          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)
+
+              associated_class.all.select { |record| record.metadata[foreign_key] == lookup_value }
+            end
+          end
+        end
+      end
+
+      private
+
+      def cache_belongs_to_association(name)
+        @belongs_to_cache ||= {}
+        return @belongs_to_cache[name] if @belongs_to_cache.key?(name)
+
+        @belongs_to_cache[name] = yield
+      end
+
+      def cache_has_many_association(name)
+        @has_many_cache ||= {}
+        return @has_many_cache[name] if @has_many_cache.key?(name)
+
+        @has_many_cache[name] = yield
+      end
+
+      def association_class_for(association_name, singularize: false, **options)
+        class_name = options[:class_name] || begin
+          name = association_name.to_s
+          name = name.singularize if singularize
+
+          "Content::#{name.classify}"
+        end
+
+        class_name.constantize
+      end
+
+      def foreign_key_for(base_name, **options)
+        (options[:foreign_key] || "#{base_name}_id").to_s
+      end
+
+      def inverse_association_name = self.class.name.demodulize.underscore
+    end
+  end
+end

data/lib/perron/resource/metadata.rb

@@ -49,10 +49,14 @@ module Perron
         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,
+        begin
+          Rails.application.routes.url_helpers.polymorphic_url(
+            @resource,
           **Perron.configuration.default_url_options
-        )
+          )
+        rescue
+          false
+        end
       end
 
       def site_data

data/lib/perron/resource/reading_time.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module ReadingTime
+      extend ActiveSupport::Concern
+
+      def estimated_reading_time(wpm: DEFAULT_WORDS_PER_MINUTE, format: DEFAULT_FORMAT)
+        word_count = content.scan(/\b[a-zA-Z]+\b/).size
+        total_minutes = [(word_count.to_f / wpm).ceil, 1].max
+
+        hours = total_minutes / 60
+        minutes = total_minutes % 60
+        seconds = ((word_count.to_f / wpm) * 60).to_i % 60
+
+        return total_minutes if format.blank?
+
+        format % {
+          minutes: minutes,
+          total_minutes: total_minutes,
+          hours: hours,
+          seconds: seconds,
+          min: minutes,
+          h: hours,
+          s: seconds
+        }
+      end
+      alias_method :reading_time, :estimated_reading_time
+
+      private
+
+      DEFAULT_WORDS_PER_MINUTE = 200
+      DEFAULT_FORMAT = "%{minutes} min read"
+    end
+  end
+end

data/lib/perron/resource/sourceable.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Sourceable
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def sources(*arguments)
+          @source_definitions = parsed(*arguments)
+        end
+        alias_method :source, :sources
+
+        def source_definitions
+          @source_definitions || {}
+        end
+
+        def source_names = source_definitions.keys
+
+        def generate_from_sources!
+          return unless source_backed?
+
+          combinations.each do |combo|
+            content = content_with combo
+            filename = filename_with combo
+
+            FileUtils.mkdir_p(output_dir)
+            File.write(output_dir.join("#{filename}.erb"), content)
+          end
+        end
+
+        def source_backed? = source_names.any?
+
+        private
+
+        def parsed(*arguments)
+          return {} if arguments.empty?
+
+          arguments.flat_map { it.is_a?(Hash) ? it.to_a : [[it, {primary_key: :id}]] }.to_h
+        end
+
+        def combinations
+          datasets = source_names.map { Perron::Site.data.public_send(it) }
+
+          datasets.first.product(*datasets[1..])
+        end
+
+        def content_with(combo)
+          data = source_names.each.with_index.to_h { |name, index| [name, combo[index]] }
+          sources = Source.new(data)
+
+          source_template(sources)
+        end
+
+        def filename_with(combo)
+          source_names.each_with_index.map do |name, index|
+            primary_key = source_definitions[name][:primary_key]
+
+            combo[index].public_send(primary_key)
+          end.join("-")
+        end
+
+        def output_dir = Perron.configuration.input.join(model_name.collection)
+      end
+
+      def source_backed? = self.class.source_backed?
+
+      def sources
+        @sources ||= begin
+          data = self.class.source_definitions.each_with_object({}) do |(name, options), hash|
+            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 }
+          end
+
+          Source.new(data)
+        end
+      end
+
+      def source_template(sources)
+        raise NotImplementedError, "#{self.class.name} must implement #source_template"
+      end
+
+      class Source
+        def initialize(data)
+          @data = data
+        end
+
+        def method_missing(name, *arguments, &block)
+          return super if arguments.any? || block
+          return @data[name] if @data.key?(name)
+
+          super
+        end
+
+        def respond_to_missing?(name, _) = @data.key?(name)
+      end
+      private_constant :Source
+    end
+  end
+end

data/lib/perron/resource.rb

@@ -3,12 +3,15 @@
 require "perron/resource/configuration"
 require "perron/resource/core"
 require "perron/resource/class_methods"
+require "perron/resource/associations"
 require "perron/resource/metadata"
 require "perron/resource/publishable"
+require "perron/resource/reading_time"
 require "perron/resource/related"
 require "perron/resource/renderer"
 require "perron/resource/slug"
 require "perron/resource/separator"
+require "perron/resource/sourceable"
 require "perron/resource/table_of_content"
 
 module Perron
@@ -20,6 +23,9 @@ module Perron
     include Perron::Resource::Configuration
     include Perron::Resource::Core
     include Perron::Resource::ClassMethods
+    include Perron::Resource::Associations
+    include Perron::Resource::ReadingTime
+    include Perron::Resource::Sourceable
     include Perron::Resource::Publishable
     include Perron::Resource::TableOfContent
 

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

@@ -25,7 +25,7 @@ module Perron
                 items: resources.map do |resource|
                   {
                     id: resource.id,
-                    url: url.polymorphic_url(resource),
+                    url: url.polymorphic_url(resource, ref: feed_configuration.ref).delete_suffix("?ref="),
                     date_published: resource.published_at&.iso8601,
                     title: resource.metadata.title,
                     content_html: Perron::Markdown.render(resource.content)

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

@@ -27,7 +27,7 @@ module Perron
                     resources.each do |resource|
                       xml.item do
                         xml.guid resource.id
-                        xml.link url.polymorphic_url(resource), isPermaLink: true
+                        xml.link url.polymorphic_url(resource, ref: feed_configuration.ref).delete_suffix("?ref="), isPermaLink: true
                         xml.pubDate(resource.published_at&.rfc822)
                         xml.title resource.metadata.title
                         xml.description { xml.cdata(Perron::Markdown.render(resource.content)) }

data/lib/perron/site/validate.rb

@@ -19,11 +19,13 @@ module Perron
 
         puts [
           "Validation finished",
-          (" with #{@failures.count} failures" if @failures.any?),
+          (" with #{@failures.count} failures" if failed?),
           "."
         ].join
       end
 
+      def failed? = @failures.any?
+
       private
 
       Failure = ::Data.define(:identifier, :errors)

data/lib/perron/tasks/sync_sources.rake

@@ -0,0 +1,12 @@
+namespace :perron do
+  desc "Sync source-backed resources"
+  task :sync_sources, [:name] => :environment do |_, arguments|
+    Rails.application.eager_load!
+
+    resource_classes = arguments.name ? ["Content::#{arguments.name.classify}".constantize] : Perron::Resource.descendants
+
+    resource_classes.compact.each do |resource_class|
+      resource_class.generate_from_sources! if resource_class.source_backed?
+    end
+  end
+end

data/lib/perron/tasks/validate.rake

@@ -1,6 +1,6 @@
 namespace :perron do
   desc "Validate all site resources"
   task validate: :environment do
-    Perron::Site.validate
+    abort if Perron::Site::Validate.new.tap(&:validate).failed?
   end
 end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.13.3"
+  VERSION = "0.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.13.3
+  version: 0.14.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -113,16 +113,19 @@ files:
 - lib/perron/metatags.rb
 - lib/perron/refinements/delete_suffixes.rb
 - lib/perron/resource.rb
+- lib/perron/resource/associations.rb
 - lib/perron/resource/class_methods.rb
 - lib/perron/resource/configuration.rb
 - lib/perron/resource/core.rb
 - lib/perron/resource/metadata.rb
 - lib/perron/resource/publishable.rb
+- lib/perron/resource/reading_time.rb
 - lib/perron/resource/related.rb
 - lib/perron/resource/related/stop_words.rb
 - lib/perron/resource/renderer.rb
 - lib/perron/resource/separator.rb
 - lib/perron/resource/slug.rb
+- lib/perron/resource/sourceable.rb
 - lib/perron/resource/table_of_content.rb
 - lib/perron/root.rb
 - lib/perron/site.rb
@@ -137,6 +140,7 @@ files:
 - lib/perron/site/builder/sitemap.rb
 - lib/perron/site/validate.rb
 - lib/perron/tasks/build.rake
+- lib/perron/tasks/sync_sources.rake
 - lib/perron/tasks/validate.rake
 - lib/perron/version.rb
 - perron.gemspec