RubyGems - perron - Versions diffs - 0.8.0 → 0.9.0 - Mend

perron 0.8.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

checksums.yaml +4 -4
data/Gemfile.lock +1 -1
data/README.md +115 -2
data/app/helpers/feeds_helper.rb +5 -0
data/app/helpers/meta_tags_helper.rb +4 -6
data/lib/generators/perron/install_generator.rb +1 -1
data/lib/generators/perron/templates/README.md.tt +13 -3
data/lib/perron/configuration.rb +8 -0
data/lib/perron/feeds.rb +38 -0
data/lib/perron/metatags.rb +13 -11
data/lib/perron/site/builder/feeds/json.rb +52 -0
data/lib/perron/site/builder/feeds/rss.rb +55 -0
data/lib/perron/site/builder/feeds.rb +41 -0
data/lib/perron/site/builder/sitemap.rb +0 -4
data/lib/perron/site/builder.rb +2 -0
data/lib/perron/site/data.rb +39 -73
data/lib/perron/site/resource/configuration.rb +9 -1
data/lib/perron/site/resource/related/stop_words.rb +34 -0
data/lib/perron/site/resource/related.rb +99 -0
data/lib/perron/site/resource.rb +4 -0
data/lib/perron/version.rb +1 -1
data/lib/perron.rb +1 -0
metadata +8 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9605385eb10b149f1f679d423a2367ed7f35684d381699692d329a1d05a2f6ea
-  data.tar.gz: e3803d65512af0de01c0cee99afdbbd2a8fed6d54afb823a9b64716469ea0fc6
+  metadata.gz: 2f225e6b75be66a9fd394e0c87b3c63c878042664e3acfeaa7ff68cc449af1b1
+  data.tar.gz: a963c546505ffa227310b7e0d8cba7a40446d0a70b86b8491f7baa761bf6e0cb
 SHA512:
-  metadata.gz: '090e644895f9f3fabb0b1ca3839592838864c5c6cb0a1c31acd83dbe2ef8c0ee2cbad5a13308e8986928f660d54c342f494858fcd7eb33038dc57d32834b03f8'
-  data.tar.gz: 1647b01aed3aa31f8aaac047ffe7880f58fe47530d81445077652c15635efdc99eeaedfdc7e12af87ab914ae3e4e80edda0eeec42404bdb5d50813527ac642a0
+  metadata.gz: 3f9926aba1d4c88204131fc61564173334a059bcc832c7457f0c31a276b1e05d1466c196afc8a25f54091402436618bee7ae97c6397fdb0660a1da50dbb80231
+  data.tar.gz: 54f74446e210fb7ac299b0dc5496bcce18676128fdf9af994403513f8f4ddff37aee8933e58cc5d4e3cbf7316667b0b19860863ddaec6da78ca79c9ac81d3fd6

data/Gemfile.lock CHANGED Viewed

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

data/README.md CHANGED Viewed

@@ -160,6 +160,51 @@ feature[:name]
 ```
+## Feeds
+The `feeds` helper automatically generates HTML `<link>` tags for your site's RSS and JSON feeds.
+### Usage
+In your layout (e.g., `app/views/layouts/application.html.erb`), add the helper to the `<head>` section:
+```erb
+<head>
+  …
+  <%= feeds %>
+  …
+</head>
+```
+To render feeds for specific collections, such as `posts`:
+```erb
+<%= feeds only: %w[posts] %>
+```
+Similarly, you can exclude collections:
+```erb
+<%= feeds except: %w[pages] %>
+```
+### Configuration
+Feeds are configured within the `Resource` class corresponding to a collection:
+```ruby
+# app/models/content/post.rb
+class Content::Post < Perron::Resource
+  configure do |config|
+    config.feeds.rss.enabled = true
+    # config.feeds.rss.path = "path-to-feed.xml"
+    # config.feeds.rss.max_items = 25
+    config.feeds.json.enabled = true
+    # config.feeds.json.max_items = 15
+    # config.feeds.json.path = "path-to-feed.json"
+  end
+end
+```
 ## Metatags
 The `meta_tags` helper automatically generates SEO and social sharing meta tags for your pages.
@@ -219,7 +264,19 @@ author: Kendall
 Your content here…
 ```
-#### 3. Default Values
+#### 3. Collection configuration
+Set site-wide defaults in the initializer:
+```ruby
+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"
+end
+```
+#### 4. Default Values
 Set site-wide defaults in the initializer:
 ```ruby
@@ -232,6 +289,61 @@ end
 ```
+## Related Resources
+The `related_resources` method allows to find and display a list of similar resources
+from the same collection. Similarity is calculated using the **TF-IDF** algorithm on the content of each resource.
+### Basic Usage
+To get a list of the 5 most similar resources, call the method on any resource instance.
+```ruby
+# app/views/content/posts/show.html.erb
+@resource.related_resources
+# Just the 3 most similar resources
+@resource.related_resources(limit: 3)
+```
+## XML Sitemap
+A sitemap is an XML file that lists all the pages of a website to help search engines discover and index content more efficiently, typically containing URLs, last modification dates, change frequency, and priority values.
+Enable it with the following line in the Perron configuration:
+```ruby
+Perron.configure do |config|
+  # …
+  config.sitemap.enabled = true
+  # config.sitemap.priority = 0.8
+  # config.sitemap.change_frequency = :monthly
+  # …
+end
+```
+Values can be overridden per collection…
+```ruby
+# app/models/content/post.rb
+class Content::Post < Perron::Resource
+  configure do |config|
+    config.sitemap.enabled = false
+    config.sitemap.priority = 0.5
+    config.sitemap.change_frequency = :weekly
+  end
+end
+```
+…or on a resource basis:
+```ruby
+# app/content/posts/my-first-post.md
+---
+sitemap_priority: 0.25
+sitemap_change_frequency: :daily
+---
+```
 ## Building Your Static Site
 When in `standalone` mode and you're ready to generate your static site, run:
@@ -248,9 +360,10 @@ Sites that use Perron.
 ### Standalone (as a SSG)
 - [AppRefresher](https://apprefresher.com)
+- [Helptail](https://helptail.com)
 ### Integrated (part of a Rails app)
-- [Rails Designers (private community for Rails UI engineers](https://railsdesigners.com)
+- [Rails Designers (private community for Rails UI engineers)](https://railsdesigners.com)
 ## Contributing

data/app/helpers/feeds_helper.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module FeedsHelper
+  def feeds(options = {}) = Perron::Feeds.new.render(options)
+end

data/app/helpers/meta_tags_helper.rb CHANGED Viewed

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 module MetaTagsHelper
-  def meta_tags(options = {})
-    Perron::Metatags.new(source).render(options)
-  end
+  def meta_tags(options = {}) = Perron::Metatags.new(resource).render(options)
   private
-  Source = Data.define(:path, :metadata, :published_at)
+  Resource = Data.define(:path, :metadata, :published_at)
-  def source
+  def resource
     return Source.new(request.path, @metadata, nil) if @metadata.present?
-    @resource || Source.new(request.path, {}, nil)
+    @resource || Resource.new(request.path, {}, nil)
   end
 end

data/lib/generators/perron/install_generator.rb CHANGED Viewed

@@ -7,7 +7,7 @@ module Perron
     end
     def create_data_directory
-      data_directory = Rails.root.join("app", "views", "content", "data")
+      data_directory = Rails.root.join("app", "content", "data")
       empty_directory data_directory
       template "README.md.tt", File.join(data_directory, "README.md")

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

@@ -6,19 +6,29 @@ This is useful for populating features, team members, or any other repeated data
 ## Usage
-To use a data file, instantiate `Perron::Data` with the basename of the file and iterate over the result.
+To use a data file, you can access it through the `Perron::Site.data` object followed by the basename of the file:
 ```erb
-<%% Perron::Data.new("features").each do |feature| %>
+<%% 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
 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.
+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")`.
 ## Accessing Data

data/lib/perron/configuration.rb CHANGED Viewed

@@ -19,6 +19,7 @@ module Perron
       @config.include_root = false
       @config.site_name = nil
+      @config.site_description = nil
       @config.allowed_extensions = [".erb", ".md"]
       @config.exclude_from_public = %w[assets storage]
@@ -49,6 +50,13 @@ module Perron
     def exclude_root? = !@config.include_root
+    def url
+      options = Perron.configuration.default_url_options
+      path = options[:trailing_slash] ? "/" : ""
+      URI.join("#{options[:protocol]}://#{options[:host]}", path).to_s
+    end
     def method_missing(method_name, ...)
       if @config.respond_to?(method_name)
         @config.send(method_name, ...)

data/lib/perron/feeds.rb ADDED Viewed

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+module Perron
+  class Feeds
+    include ActionView::Helpers::TagHelper
+    def render(options = {})
+      html_tags = []
+      Rails.application.routes.url_helpers.with_options(Perron.configuration.default_url_options) do |url|
+        Perron::Site.collections.each do |collection|
+          collection_name = collection.name.to_s
+          next if options[:only]&.map(&:to_s)&.exclude?(collection_name)
+          next if options[:except]&.map(&:to_s)&.include?(collection_name)
+          collection.configuration.feeds.each do |type, feed|
+            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"
+            html_tags << tag(:link, rel: "alternate", type: MIME_TYPES[type], title: title, href: absolute_url)
+          end
+        end
+      end
+      safe_join(html_tags, "\n")
+    end
+    private
+    MIME_TYPES = {
+      rss: "application/rss+xml",
+      json: "application/json"
+    }
+  end
+end

data/lib/perron/metatags.rb CHANGED Viewed

@@ -28,17 +28,19 @@ module Perron
     def tags
       @tags ||= begin
         frontmatter = @resource&.metadata&.stringify_keys || {}
-        defaults = @config.metadata
-        title = frontmatter["title"] || defaults["title"] || @config.site_name || Rails.application.name.underscore.camelize
-        type = frontmatter["type"] || defaults["type"]
-        description = frontmatter["description"] || defaults["description"]
-        logo = frontmatter["logo"] || defaults["logo"]
-        author = frontmatter["author"] || defaults["author"]
-        image = frontmatter["image"] || defaults["image"]
-        locale = frontmatter["locale"] || defaults["locale"]
-        og_image = frontmatter["og:image"] || image
-        twitter_image = frontmatter["twitter:image"] || og_image
+        collection_config = @resource.collection.configuration.metadata
+        site_config = @config.metadata
+        title = frontmatter["title"] || collection_config["title"] || site_config["title"] || @config.site_name || Rails.application.name.underscore.camelize
+        type = frontmatter["type"] || collection_config["type"] || site_config["type"]
+        description = frontmatter["description"] || collection_config["description"] || site_config["description"]
+        logo = frontmatter["logo"] || collection_config["logo"] || site_config["logo"]
+        author = frontmatter["author"] || collection_config["author"] || site_config["author"]
+        locale = frontmatter["locale"] || collection_config["locale"] || site_config["locale"]
+        image = frontmatter["image"] || collection_config["image"] || site_config["image"]
+        og_image = frontmatter["og:image"] || collection_config["og:image"] || site_config["og:image"] || image
+        twitter_image = frontmatter["twitter:image"] || collection_config["twitter:image"] || site_config["twitter:image"] || og_image
         {
           title: title_tag(title),

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require "json"
+module Perron
+  module Site
+    class Builder
+      class Feeds
+        class Json
+          def initialize(collection:)
+            @collection = collection
+            @configuration = Perron.configuration
+          end
+          def generate
+            return nil if resources.empty?
+            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,
+                items: resources.map do |resource|
+                  {
+                    id: resource.id,
+                    url: url.polymorphic_url(resource),
+                    date_published: (resource.metadata.published_at || resource.metadata.updated_at)&.iso8601,
+                    title: resource.metadata.title,
+                    content_html: Perron::Markdown.render(resource.content)
+                  }
+                end
+              }
+            end
+            JSON.pretty_generate hash
+          end
+          private
+          def resources
+            @resources ||= @collection.resources
+              .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)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+require "nokogiri"
+module Perron
+  module Site
+    class Builder
+      class Feeds
+        class Rss
+          def initialize(collection:)
+            @collection = collection
+            @configuration = Perron.configuration
+          end
+          def generate
+            return if resources.empty?
+            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.link @configuration.url
+                  xml.generator "Perron (#{Perron::VERSION})"
+                  Rails.application.routes.url_helpers.with_options(@configuration.default_url_options) do |url|
+                    resources.each do |resource|
+                      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.title resource.metadata.title
+                        xml.description { xml.cdata(Perron::Markdown.render(resource.content)) }
+                      end
+                    end
+                  end
+                end
+              end
+            end.to_xml
+          end
+          private
+          def resources
+            @resource ||= @collection.resources
+              .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)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/site/builder/feeds.rb ADDED Viewed

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "perron/site/builder/feeds/rss"
+require "perron/site/builder/feeds/json"
+module Perron
+  module Site
+    class Builder
+      class Feeds
+        def initialize(output_path)
+          @output_path = output_path
+        end
+        def generate
+          Perron::Site.collections.each do |collection|
+            config = collection.configuration.feeds
+            if config.rss.enabled
+              create_file at: config.rss.path, with: Rss.new(collection: collection).generate
+            end
+            if config.json.enabled
+              create_file at: config.json.path, with: Json.new(collection: collection).generate
+            end
+          end
+        end
+        private
+        def create_file(at:, with:)
+          return if with.blank?
+          path = @output_path.join(at)
+          FileUtils.mkdir_p(File.dirname(path))
+          File.write(path, with)
+        end
+      end
+    end
+  end
+end

data/lib/perron/site/builder/sitemap.rb CHANGED Viewed

@@ -11,8 +11,6 @@ module Perron
         def generate
           return if !Perron.configuration.sitemap.enabled
-          puts "Generating sitemap.xml…"
           xml = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |builder|
             builder.urlset(xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9") do
               Perron::Site.collections.each do |collection|
@@ -22,8 +20,6 @@ module Perron
           end.to_xml
           File.write(@output_path.join("sitemap.xml"), xml)
-          puts "Sitemap generated at `#{@output_path.join("sitemap.xml")}`"
         end
         private

data/lib/perron/site/builder.rb CHANGED Viewed

@@ -2,6 +2,7 @@
 require "perron/site/builder/assets"
 require "perron/site/builder/sitemap"
+require "perron/site/builder/feeds"
 require "perron/site/builder/public_files"
 require "perron/site/builder/paths"
 require "perron/site/builder/page"
@@ -29,6 +30,7 @@ module Perron
         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"

data/lib/perron/site/data.rb CHANGED Viewed

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
+require "erb"
+require "singleton"
 require "csv"
 module Perron
@@ -29,25 +32,39 @@ module Perron
     end
     def records
-      content = File.read(@file_path)
-      extension = File.extname(@file_path)
-      parser = PARSER_METHODS.fetch(extension) do
-        raise Errors::UnsupportedDataFormatError, "Unsupported data format: #{extension}"
-      end
-      data = send(parser, content)
+      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 { Item.new(it) }
+    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}"
+      end
+      send(parser_method, content)
     rescue Psych::SyntaxError, JSON::ParserError, CSV::MalformedCSVError => error
-      raise Errors::DataParseError, "Failed to parse '#{@file_path}': #{error.message}"
+      raise Errors::DataParseError, "Failed to parse data format in `#{path}`: (#{error.class}) #{error.message}"
     end
+    def render_erb(content) = ERB.new(content).result(HelperContext.instance.get_binding)
     def parse_yaml(content)
-      YAML.safe_load(content, permitted_classes: [Symbol], aliases: true)
+      YAML.safe_load(content, permitted_classes: [Symbol, Time], aliases: true)
     end
     def parse_json(content)
@@ -58,6 +75,19 @@ module Perron
       CSV.new(content, headers: true, header_converters: :symbol).to_a.map(&:to_h)
     end
+    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
+    end
+    private_constant :HelperContext
     class Item
       def initialize(attributes)
         @attributes = attributes.transform_keys(&:to_sym)
@@ -78,67 +108,3 @@ module Perron
     private_constant :Item
   end
 end
-# require "csv"
-# module Perron
-#   class Data
-#     include Enumerable
-#     def initialize(resource)
-#       @file_path = path_for(resource)
-#       @data = data
-#     end
-#     def each(&block)
-#       @data.each(&block)
-#     end
-#     private
-#     PARSER_METHODS = {
-#       ".csv" => :parse_csv,
-#       ".json" => :parse_json,
-#       ".yaml" => :parse_yaml,
-#       ".yml" => :parse_yaml
-#     }.freeze
-#     SUPPORTED_EXTENSIONS = PARSER_METHODS.keys.freeze
-#     def path_for(identifier)
-#       path = Pathname.new(identifier)
-#       return path.to_s if path.file? && path.absolute?
-#       found_path = SUPPORTED_EXTENSIONS.lazy.map do |extension|
-#         Rails.root.join("app", "content", "data").join("#{identifier}#{extension}")
-#       end.find(&:exist?)
-#       found_path&.to_s or raise Errors::FileNotFoundError, "No data file found for '#{identifier}'"
-#     end
-#     def data
-#       content = File.read(@file_path)
-#       extension = File.extname(@file_path)
-#       parser = PARSER_METHODS.fetch(extension) do
-#         raise Errors::UnsupportedDataFormatError, "Unsupported data format: #{extension}"
-#       end
-#       raw_data = send(parser, content)
-#       unless raw_data.is_a?(Array)
-#         raise Errors::DataParseError, "Data in '#{@file_path}' must be an array of objects."
-#       end
-#       struct = Struct.new(*raw_data.first.keys, keyword_init: true)
-#       raw_data.map { struct.new(**it) }
-#     rescue Psych::SyntaxError, JSON::ParserError, CSV::MalformedCSVError => error
-#       raise Errors::DataParseError, "Failed to parse '#{@file_path}': #{error.message}"
-#     end
-#     def parse_yaml(content) = YAML.safe_load(content, permitted_classes: [Symbol], aliases: true)
-#     def parse_json(content) = JSON.parse(content, symbolize_names: true)
-#     def parse_csv(content) = CSV.new(content, headers: true, header_converters: :symbol).to_a.map(&:to_h)
-#   end
-# end

data/lib/perron/site/resource/configuration.rb CHANGED Viewed

@@ -8,11 +8,19 @@ module Perron
       class_methods do
         def configuration
           @configuration ||= Options.new.tap do |config|
+            config.metadata = Options.new
             config.feeds = Options.new
             config.feeds.rss = ActiveSupport::OrderedOptions.new
-            config.feeds.atom = ActiveSupport::OrderedOptions.new
+            config.feeds.rss.enabled = false
+            config.feeds.rss.path = "feeds/#{collection.name.demodulize.parameterize}.xml"
+            config.feeds.rss.max_items = 20
             config.feeds.json = ActiveSupport::OrderedOptions.new
+            config.feeds.json.enabled = false
+            config.feeds.json.path = "feeds/#{collection.name.demodulize.parameterize}.json"
+            config.feeds.json.max_items = 20
             config.linked_data = ActiveSupport::OrderedOptions.new

data/lib/perron/site/resource/related/stop_words.rb ADDED Viewed

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+module Perron
+  module Site
+    class Resource
+      class Related
+        module StopWords
+          module_function
+          def all
+            Set[
+              "a", "about", "above", "after", "again", "against", "all", "am",
+              "an", "and", "any", "are", "as", "at", "be", "because", "been",
+              "before", "being", "below", "between", "both", "but", "by", "can",
+              "did", "do", "does", "doing", "down", "during", "each", "few",
+              "for", "from", "further", "had", "has", "have", "having", "he",
+              "her", "here", "hers", "herself", "him", "himself", "his", "how",
+              "i", "if", "in", "into", "is", "it", "its", "itself", "just",
+              "me", "more", "most", "my", "myself", "no", "nor", "not", "now",
+              "of", "off", "on", "once", "only", "or", "other", "our", "ours",
+              "ourselves", "out", "over", "own", "s", "same", "she", "should",
+              "so", "some", "such", "t", "than", "that", "the", "their",
+              "theirs", "them", "themselves", "then", "there", "these", "they",
+              "this", "those", "through", "to", "too", "under", "until", "up",
+              "very", "was", "we", "were", "what", "when", "where", "which",
+              "while", "who", "whom", "why", "will", "with", "you", "your",
+              "yours", "yourself", "yourselves"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/site/resource/related.rb ADDED Viewed

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+require "perron/site/resource/related/stop_words"
+module Perron
+  module Site
+    class Resource
+      class Related
+        def initialize(resource)
+          @resource = resource
+          @collection = resource.collection
+        end
+        def find(limit: 5)
+          @collection.resources
+            .reject { it.slug == @resource.slug }
+            .map { [it, cosine_similarities_for(@resource, it)] }
+            .sort_by { |_, score| -score }
+            .map(&:first)
+            .first(limit)
+        end
+        private
+        def cosine_similarities_for(resource_one, resource_two)
+          first_vector = tfidf_vector_for(resource_one)
+          second_vector = tfidf_vector_for(resource_two)
+          return 0.0 if first_vector.empty? || second_vector.empty?
+          dot_product = 0.0
+          first_vector.each_key { dot_product += first_vector[it] * second_vector[it] if second_vector.key?(it) }
+          first_magnitude = Math.sqrt(first_vector.values.sum { it**2 })
+          second_magnitude = Math.sqrt(second_vector.values.sum { it**2 })
+          denominator = first_magnitude * second_magnitude
+          return 0.0 if denominator.zero?
+          dot_product / denominator
+        end
+        def tfidf_vector_for(target_resource)
+          @tfidf_vectors ||= {}
+          return @tfidf_vectors[target_resource] if @tfidf_vectors.key?(target_resource)
+          tokens = tokenize_content(target_resource)
+          token_count = tokens.size
+          return {} if token_count.zero?
+          term_count = Hash.new(0)
+          tokens.each { |token| term_count[token] += 1 }
+          tfidf_vector = {}
+          term_count.each do |term, count|
+            terms = count.to_f / token_count
+            tfidf_vector[term] = terms * inverse_document_frequency[term]
+          end
+          @tfidf_vectors[target_resource] = tfidf_vector
+        end
+        def tokenize_content(target_resource)
+          @tokenized_content ||= {}
+          return @tokenized_content[target_resource] if @tokenized_content.key?(target_resource)
+          content = target_resource.content.gsub(/<[^>]*>/, " ")
+          tokens = content.downcase.scan(/\w+/).reject { StopWords.all.include?(it) || it.length < 3 }
+          @tokenized_content[target_resource] = tokens
+        end
+        def inverse_document_frequency
+          @inverse_document_frequency ||= begin
+            resource_frequency = Hash.new(0)
+            @collection.resources.each { tokenize_content(it).uniq.each { resource_frequency[it] += 1 } }
+            frequencies = {}
+            total_resources = @collection.resources.size
+            resource_frequency.each do |term, frequency|
+              frequencies[term] = Math.log(total_resources.to_f / (1 + frequency))
+            end
+            frequencies
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/site/resource.rb CHANGED Viewed

@@ -4,6 +4,7 @@ require "perron/site/resource/configuration"
 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/slug"
 require "perron/site/resource/separator"
@@ -49,6 +50,9 @@ module Perron
     def collection = Collection.new(self.class.model_name.collection)
+    def related_resources(limit: 5) = Perron::Site::Resource::Related.new(self).find(limit:)
+    alias_method :related, :related_resources
     private
     def processable?

data/lib/perron/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

data/lib/perron.rb CHANGED Viewed

@@ -6,6 +6,7 @@ require "perron/errors"
 require "perron/root"
 require "perron/site"
 require "perron/markdown"
+require "perron/feeds"
 require "perron/metatags"
 require "perron/engine"

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -78,6 +78,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- app/helpers/feeds_helper.rb
 - app/helpers/meta_tags_helper.rb
 - app/helpers/perron/markdown_helper.rb
 - bin/console
@@ -97,6 +98,7 @@ files:
 - lib/perron/configuration.rb
 - lib/perron/engine.rb
 - lib/perron/errors.rb
+- lib/perron/feeds.rb
 - lib/perron/html_processor.rb
 - lib/perron/html_processor/base.rb
 - lib/perron/html_processor/lazy_load_images.rb
@@ -108,6 +110,9 @@ files:
 - lib/perron/site.rb
 - lib/perron/site/builder.rb
 - lib/perron/site/builder/assets.rb
+- lib/perron/site/builder/feeds.rb
+- lib/perron/site/builder/feeds/json.rb
+- lib/perron/site/builder/feeds/rss.rb
 - lib/perron/site/builder/page.rb
 - lib/perron/site/builder/paths.rb
 - lib/perron/site/builder/public_files.rb
@@ -120,6 +125,8 @@ files:
 - lib/perron/site/resource/configuration.rb
 - lib/perron/site/resource/core.rb
 - lib/perron/site/resource/publishable.rb
+- lib/perron/site/resource/related.rb
+- lib/perron/site/resource/related/stop_words.rb
 - lib/perron/site/resource/separator.rb
 - lib/perron/site/resource/slug.rb
 - lib/perron/tasks/perron.rake