perron 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cce790442290a0fedc4e4db328e3358b60a7edafafc6a0c980cec22d6f02fba5
-  data.tar.gz: c0a48eecc48c7a3230de6c36bf3a9180c9125b389282b0f311c02638b2db41cf
+  metadata.gz: 2aa4c7af63f95aef3bc25c9ef97a4da02d75486ec3ee975f69a980f66cb34557
+  data.tar.gz: f1c62fff6d0ba6c121da85f463dc32fd5656c884d059d0f2955c6a95a4c0bf3a
 SHA512:
-  metadata.gz: e3f7bce10120b2feaf667051c8b67efd58adffb83a91d7d853b79b408bfa04cf5e004f40e99357059871c51f42aaf8ee26d32e4b36b776fcb9936309d1a7e94a
-  data.tar.gz: 9324e15f3d236809cf9422da8e8500d302e64a980352c5a9163734d908f8ecd1774cd1350d762487e9795df887d026858e3bd3bcab440c8f9fb1c547913295d9
+  metadata.gz: 175ecbdc5dc5468e28e0abe13926b578fb6669d078b594da1dea91ab8cce68c3a7f63f12d3be4f0de757d270c5d3a95ce96db925ea9c3cbe238e1dd72069aaa1
+  data.tar.gz: b65f95000da601c8ea2f6dcea2e1cf9edb907d366ff783b3ba37e4b2c2d0ff0222cf98821f7537690895087c39ad0c902397c6325e309e27019914101072b6df

data/Gemfile.lock

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

data/README.md

@@ -31,7 +31,7 @@ rails generate perron:install
 This creates an initializer:
 ```ruby
 Perron.configure do |config|
-  config.site_name = "AppRefresher"
+  config.site_name = "Helptail"
 end
 ```
 
@@ -131,6 +131,71 @@ end
 ```
 
 
+### Embed Ruby
+
+Perron provides flexible options for embedding dynamic Ruby code in your content using ERB.
+
+
+#### 1. File extension
+
+Any content file with a `.erb` extension (e.g., `about.erb`) will automatically have its content processed as ERB.
+
+
+#### 2. Frontmatter
+
+You can enable ERB processing on a per-file basis, even for standard `.md` files, by adding `erb: true` to the file's frontmatter.
+```markdown
+---
+title: Dynamic Page
+erb: true
+---
+
+This entire page will be processed by ERB.
+The current time is: <%= Time.current.to_fs(:long_ordinal) %>.
+```
+
+
+#### 3. `erbify` helper
+
+For the most granular control, the `erbify` helper allows to process specific sections of a file as ERB.
+This is ideal for generating dynamic content like lists or tables from your resource's metadata, without needing to enable ERB for the entire file. The `erbify` helper can be used with a string or, more commonly, a block.
+
+**Example:** Generating a list from frontmatter data in a standard `.md` file.
+```markdown
+---
+title: Features
+features:
+  - Rails based
+  - SEO friendly
+  - Markdown first
+  - ERB support
+---
+
+Check out our amazing features:
+
+<%= erbify do %>
+  <ul>
+    <% @resource.metadata.features.each do |feature| %>
+      <li>
+        <%= feature %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+```
+
+**Result:**
+```html
+<p>Check out our amazing features:</p>
+<ul>
+  <li>Rails based</li>
+  <li>SEO friendly</li>
+  <li>Markdown first</li>
+  <li>ERB support</li>
+</ul>
+```
+
+
 ## Data Files
 
 Perron can consume structured data from YML, JSON, or CSV files, making them available within your templates.
@@ -271,8 +336,8 @@ Set site-wide defaults in the initializer:
 class Content::Post < Perron::Resource
   # …
 
-  config.metadata.description = "AI-powered tool to keep your knowledge base articles images/screenshots and content up-to-date"
-  config.metadata.author = "Rails Designer"
+  config.metadata.description = "Put your routine tasks on autopilot"
+  config.metadata.author = "Helptail team"
 end
 ```
 
@@ -283,8 +348,8 @@ Set site-wide defaults in the initializer:
 Perron.configure do |config|
   # …
 
-  config.metadata.description = "AI-powered tool to keep your knowledge base articles images/screenshots and content up-to-date"
-  config.metadata.author = "Rails Designer"
+  config.metadata.description = "Put your routine tasks on autopilot"
+  config.metadata.author = "Helptail team"
 end
 ```
 

data/app/helpers/perron/erb_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Perron
+  module ErbHelper
+    def erbify(content = nil, options = {}, &block)
+      Perron::Resource::Renderer.erb(content || capture(&block).strip_heredoc, {resource: @resource})
+    end
+  end
+end

data/lib/generators/content/content_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/base"
 
 class ContentGenerator < Rails::Generators::NamedBase

data/lib/generators/perron/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Perron
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("templates", __dir__)
@@ -12,5 +14,15 @@ module Perron
 
       template "README.md.tt", File.join(data_directory, "README.md")
     end
+
+    def add_markdown_gems
+      append_to_file "Gemfile", <<~RUBY
+
+        # Perron can use one of the following gems. Uncomment your preferred choice and run `bundle install`
+        # gem "commonmarker"
+        # gem "kramdown"
+        # gem "redcarpet"
+      RUBY
+    end
   end
 end

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

@@ -1,7 +1,7 @@
 Perron.configure do |config|
   # config.output = "output"
 
-  # config.site_name = "AppRefresher"
+  # config.site_name = "Helptail"
 
   # The build mode for Perron. Can be :standalone or :integrated.
   # config.mode = :standalone
@@ -9,12 +9,12 @@ Perron.configure do |config|
   # In `integrated` mode, the root is skipped by default. Set to `true` to enable.
   # config.include_root = false
 
-  # config.default_url_options = {host: "apprefresher.com", protocol: "https", trailing_slash: true}
+  # config.default_url_options = {host: "helptail.com", protocol: "https", trailing_slash: true}
 
   # Set default meta values
   # Examples:
-  # - `config.metadata.description = "AI-powered tool to keep your knowledge base articles images/screenshots and content up-to-date"`
-  # - `config.metadata.author = "Rails Designer"`
+  # - `config.metadata.description = "Put your routine tasks on autopilot"`
+  # - `config.metadata.author = "Helptail Team"`
 
   # Set meta title suffix
   # config.metadata.title_suffix = nil

data/lib/perron/configuration.rb

@@ -13,15 +13,18 @@ module Perron
     def initialize
       @config = ActiveSupport::OrderedOptions.new
 
+      @config.site_name = nil
+      @config.site_description = nil
+
+      @config.site_email = nil
+
       @config.output = "output"
 
       @config.mode = :standalone
       @config.include_root = false
 
-      @config.site_name = nil
-      @config.site_description = nil
+      @config.allowed_extensions = %w[erb md]
 
-      @config.allowed_extensions = [".erb", ".md"]
       @config.exclude_from_public = %w[assets storage]
       @config.excluded_assets = %w[action_cable actioncable actiontext activestorage rails-ujs trix turbo]
 

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

@@ -31,7 +31,7 @@ module Perron
           FileUtils.mkdir_p(destination)
           FileUtils.cp_r(Dir.glob("#{source}/*"), destination)
 
-          puts "   ✅ Copied assets to `#{destination.relative_path_from(Rails.root)}`"
+          puts "   Copied assets to `#{destination.relative_path_from(Rails.root)}`"
 
           prune_excluded_assets from: destination
         end
@@ -41,7 +41,7 @@ module Perron
         def prune_excluded_assets(from:)
           return if exclusions.empty?
 
-          puts "Pruning excluded assets…"
+          puts "   Pruning excluded assets…"
 
           pattern = /^(#{exclusions.join("|")})(\.esm|\.min)?-[a-f0-9]{8,}/
 

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

@@ -35,7 +35,7 @@ module Perron
           FileUtils.mkdir_p(directory_path)
           File.write(file_path, html)
 
-          puts "✅ Generated: #{@path} -> #{file_path.relative_path_from(@output_path)}"
+          print "\e[32m.\e[0m"
         end
 
         def route_info

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

@@ -23,7 +23,7 @@ module Perron
           paths.each do |path|
             FileUtils.cp_r(path, @output_path)
 
-            puts "   ✅ Copied: #{File.basename(path)}"
+            print "\e[32m.\e[0m"
           end
         end
 

data/lib/perron/site/builder.rb

@@ -24,16 +24,14 @@ module Perron
           Perron::Site::Builder::PublicFiles.new.copy
         end
 
-        puts "🚀 Starting site build…"
-        puts "-" * 15
+        puts "\n📝 Generating collections…"
 
         paths.each { render_page(it) }
 
         Perron::Site::Builder::Sitemap.new(@output_path).generate
         Perron::Site::Builder::Feeds.new(@output_path).generate
 
-        puts "-" * 15
-        puts "✅ Build complete"
+        puts "\n✅ Build complete"
       end
 
       private

data/lib/perron/site/data/proxy.rb

@@ -3,14 +3,44 @@
 module Perron
   class Data
     class Proxy
-      def method_missing(method_name, *arguments, &block)
-        raise ArgumentError, "Data `#{method_name}` does not accept arguments" if arguments.any?
+      include Enumerable
 
-        Perron::Data.new(method_name.to_s)
+      def initialize(parts = [])
+        @parts = parts
+        @data = data_for_proxy
       end
 
-      def respond_to_missing?(method_name, include_private = false)
-        true
+      def each(&block) = @data.each(&block)
+
+      def inspect = @data.inspect
+
+      def respond_to_missing?(name, include_private = false)
+        identifier = File.join(*@parts, name.to_s)
+
+        Perron::Data.directory?(identifier) || Perron::Data.path_for(identifier) || super
+      end
+
+      def method_missing(name, *arguments, &block)
+        raise ArgumentError, "Data access does not accept arguments" if arguments.any? || block
+
+        new_parts = @parts + [name.to_s]
+        identifier = File.join(*new_parts)
+
+        return Proxy.new(new_parts) if Perron::Data.directory?(identifier)
+        return Perron::Data.new(identifier) if Perron::Data.path_for(identifier)
+
+        super
+      end
+
+      private
+
+      def data_for_proxy
+        return [] if @parts.empty?
+
+        identifier = File.join(*@parts)
+        data_path = Perron::Data.path_for(identifier) || Perron::Data.path_for(File.join(identifier, "index"))
+
+        data_path ? Perron::Data.new(data_path) : []
       end
     end
   end

data/lib/perron/site/data.rb

@@ -1,19 +1,36 @@
 # frozen_string_literal: true
 
-require "erb"
-require "singleton"
-
 require "csv"
 
 module Perron
   class Data < SimpleDelegator
     def initialize(identifier)
-      @file_path = path_for(identifier)
+      @file_path = self.class.path_for!(identifier)
       @records = records
 
       super(records)
     end
 
+    class << self
+      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
+
     private
 
     PARSER_METHODS = {
@@ -22,21 +39,12 @@ module Perron
     }.freeze
     SUPPORTED_EXTENSIONS = PARSER_METHODS.keys
 
-    def path_for(identifier)
-      path = Pathname.new(identifier)
-
-      return path.to_s if path.file? && path.absolute?
-
-      path = SUPPORTED_EXTENSIONS.lazy.map { Rails.root.join("app", "content", "data").join("#{identifier}#{it}") }.find(&:exist?)
-      path&.to_s or raise Errors::FileNotFoundError, "No data file found for '#{identifier}'"
-    end
-
     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."
+        raise Errors::DataParseError, "Data in `#{@file_path}` must be an array of objects."
       end
 
       data.map { Item.new(it) }

data/lib/perron/site/resource/renderer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Renderer
+      module_function
+
+      def erb(content, assigns = {})
+        ::ApplicationController
+          .renderer
+          .render(
+            inline: content,
+            assigns: assigns
+          )
+      end
+    end
+  end
+end

data/lib/perron/site/resource/slug.rb

@@ -13,8 +13,12 @@ module Perron
       end
 
       def create
-        @metadata.slug.presence || @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(Perron.configuration.allowed_extensions)
+        @metadata.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

@@ -5,6 +5,7 @@ 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"
 
@@ -33,14 +34,11 @@ module Perron
     alias_method :to_param, :slug
 
     def content
-      return Perron::Resource::Separator.new(raw_content).content unless processable?
-
-      ::ApplicationController
-        .renderer
-        .render(
-          inline: Perron::Resource::Separator.new(raw_content).content,
-          assigns: {resource: self}
-        )
+      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::Separator.new(raw_content).metadata
@@ -55,7 +53,7 @@ module Perron
 
     private
 
-    def processable?
+    def erb_processing?
       @file_path.ends_with?(".erb") || metadata.erb == true
     end
 

data/lib/perron/site.rb

@@ -12,16 +12,6 @@ module Perron
 
     def build = Perron::Site::Builder.new.build
 
-    def name = Perron.configuration.site_name
-
-    def email = Perron.configuration.site_email
-
-    def url
-      options = Perron.configuration.default_url_options
-
-      "#{options[:protocol]}://#{options[:host]}"
-    end
-
     def collections
       @collections ||= Dir.children(Perron.configuration.input)
         .select { File.directory?(File.join(Perron.configuration.input, it)) }

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.9.1"
+  VERSION = "0.10.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -80,6 +80,7 @@ files:
 - Rakefile
 - app/helpers/feeds_helper.rb
 - app/helpers/meta_tags_helper.rb
+- app/helpers/perron/erb_helper.rb
 - app/helpers/perron/markdown_helper.rb
 - bin/console
 - bin/rails
@@ -127,6 +128,7 @@ files:
 - lib/perron/site/resource/publishable.rb
 - lib/perron/site/resource/related.rb
 - lib/perron/site/resource/related/stop_words.rb
+- lib/perron/site/resource/renderer.rb
 - lib/perron/site/resource/separator.rb
 - lib/perron/site/resource/slug.rb
 - lib/perron/tasks/perron.rake