perron 0.17.0 → 0.18.0

data/lib/perron/resource/searchable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Searchable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :search_fields_list, default: []
+      end
+
+      class_methods do
+        def search_fields(*fields)
+          self.search_fields_list = fields
+        end
+      end
+    end
+  end
+end

data/lib/perron/resource/sourceable.rb

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

data/lib/perron/resource/sweeper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Sweeper
+      extend ActiveSupport::Concern
+
+      def extracted_headings
+        extract_heading_texts(from: rendered_document)
+      end
+
+      def sweeped_content
+        ActionView::Base.full_sanitizer.sanitize(
+          rendered_document.text.gsub(/\s+/, " ").strip
+        )
+      end
+
+      private
+
+      def rendered_document
+        @rendered_document ||= Nokogiri::HTML::DocumentFragment.parse(Markdown.render(content))
+      end
+
+      def extract_heading_texts(from:, levels: "h1, h2, h3, h4, h5, h6")
+        from.css(levels).map { it.text.strip }.compact_blank
+      end
+
+      def extract_headings(from:, levels:)
+        from.css(levels).each_with_object([]) do |heading, headings|
+          heading_text = heading.text.strip
+          id = heading["id"] || heading.at("a")&.[]("id")
+
+          next if heading_text.empty? || id.blank?
+
+          headings << TableOfContent::Item.new(
+            id: id,
+            text: heading_text,
+            level: heading.name[1..].to_i,
+            children: []
+          )
+        end
+      end
+    end
+  end
+end

data/lib/perron/resource/table_of_content.rb

@@ -20,24 +20,6 @@ module Perron
 
       Item = ::Data.define(:id, :text, :level, :children)
 
-      def extract_headings(from:, levels:)
-        from.css(levels).each_with_object([]) do |heading, headings|
-          heading.tap do |node|
-            heading_text = node.text.strip
-            id = node["id"] || node.at("a")&.[]("id")
-
-            next if heading_text.empty? || id.blank?
-
-            headings << Item.new(
-              id: id,
-              text: heading_text,
-              level: node.name[1..].to_i,
-              children: []
-            )
-          end
-        end
-      end
-
       class Builder
         def build(headings)
           parents = {0 => {children: []}}

data/lib/perron/resource.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "perron/relation"
 require "perron/resource/configuration"
 require "perron/resource/core"
 require "perron/resource/class_methods"
@@ -10,26 +11,30 @@ require "perron/resource/publishable"
 require "perron/resource/reading_time"
 require "perron/resource/related"
 require "perron/resource/renderer"
+require "perron/resource/scopes"
 require "perron/resource/slug"
+require "perron/resource/searchable"
 require "perron/resource/separator"
 require "perron/resource/sourceable"
+require "perron/resource/sweeper"
 require "perron/resource/table_of_content"
 
 module Perron
   class Resource
-    ID_LENGTH = 8
-
     include ActiveModel::Validations
 
-    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::Previewable
-    include Perron::Resource::TableOfContent
+    include Configuration
+    include Core
+    include ClassMethods
+    include Associations
+    include ReadingTime
+    include Searchable
+    include Sourceable
+    include Publishable
+    include Previewable
+    include Scopes
+    include Sweeper
+    include TableOfContent
 
     attr_reader :file_path, :id
 
@@ -41,6 +46,16 @@ module Perron
       raise Errors::FileNotFoundError, "No such file: #{file_path}" unless File.exist?(file_path)
     end
 
+    def pluck(*attributes)
+      raise ArgumentError, "wrong number of arguments (given 0, expected 1+)" if attributes.empty?
+
+      if attributes.size == 1
+        public_send(attributes.first)
+      else
+        attributes.map { |attr| public_send(attr) }
+      end
+    end
+
     def filename = File.basename(@file_path)
 
     def slug = Perron::Resource::Slug.new(self, frontmatter).create
@@ -66,15 +81,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))
-        collection = ActiveSupport::Inflector.tableize(self.class.model_name)
-
-        File.join("content", collection, element)
-      end
+    def inline(layout: "application", **options)
+      {html: content, layout: layout}.merge(options)
     end
 
     def collection = Collection.new(self.class.model_name.collection)
@@ -88,6 +96,8 @@ module Perron
 
     private
 
+    ID_LENGTH = 8
+
     def frontmatter
       @frontmatter ||= Perron::Resource::Separator.new(raw_content).frontmatter
     end

data/lib/perron/site.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require "perron/collection"
-require "perron/data"
-require "perron/data/proxy"
+require "perron/data_source"
+require "perron/data_source/proxy"
 require "perron/site/builder"
 require "perron/site/validate"
 
@@ -26,7 +26,7 @@ module Perron
     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
+      (name && Perron::DataSource.new(name)) || Perron::DataSource::Proxy.new
     end
   end
 end

data/lib/perron/tasks/build.rake

@@ -1,6 +1,13 @@
 namespace :perron do
+  task :set_production_env do
+    unless ENV["RAILS_ENV"]
+      ENV["RAILS_ENV"] = "production"
+      puts "RAILS_ENV not set, defaulting to production"
+    end
+  end
+
   desc "Generate static HTML files from Perron collections"
-  task build: :environment do
+  task build: [:set_production_env, :environment] do
     Perron::Site.build
   end
 end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.17.0"
+  VERSION = "0.18.0"
 end

data/lib/perron.rb

@@ -5,6 +5,7 @@ require "perron/configuration"
 require "perron/deprecator"
 require "perron/errors"
 require "perron/site"
+require "perron/relation"
 require "perron/content/data"
 require "perron/resource"
 require "perron/markdown"

data/perron.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.4.0"
 
   spec.add_dependency "rails", ">= 7.2.0"
+  spec.add_dependency "mata", "~> 0.8.0"
 
   spec.add_runtime_dependency "csv"
   spec.add_runtime_dependency "json"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -23,6 +23,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.2.0
+- !ruby/object:Gem::Dependency
+  name: mata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -78,10 +92,11 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- app/helpers/feeds_helper.rb
-- app/helpers/meta_tags_helper.rb
+- app/controllers/perron/searches_controller.rb
 - app/helpers/perron/erb_helper.rb
+- app/helpers/perron/feeds_helper.rb
 - app/helpers/perron/markdown_helper.rb
+- app/helpers/perron/meta_tags_helper.rb
 - bin/console
 - bin/rails
 - bin/release
@@ -100,8 +115,11 @@ files:
 - lib/perron/collection.rb
 - lib/perron/configuration.rb
 - lib/perron/content/data.rb
-- lib/perron/data.rb
-- lib/perron/data/proxy.rb
+- lib/perron/data_source.rb
+- lib/perron/data_source/class_methods.rb
+- lib/perron/data_source/helper_context.rb
+- lib/perron/data_source/item.rb
+- lib/perron/data_source/proxy.rb
 - lib/perron/deprecator.rb
 - lib/perron/engine.rb
 - lib/perron/errors.rb
@@ -115,6 +133,7 @@ files:
 - lib/perron/metatags.rb
 - lib/perron/output_server.rb
 - lib/perron/refinements/delete_suffixes.rb
+- lib/perron/relation.rb
 - lib/perron/resource.rb
 - lib/perron/resource/associations.rb
 - lib/perron/resource/class_methods.rb
@@ -127,9 +146,12 @@ files:
 - lib/perron/resource/related.rb
 - lib/perron/resource/related/stop_words.rb
 - lib/perron/resource/renderer.rb
+- lib/perron/resource/scopes.rb
+- lib/perron/resource/searchable.rb
 - lib/perron/resource/separator.rb
 - lib/perron/resource/slug.rb
 - lib/perron/resource/sourceable.rb
+- lib/perron/resource/sweeper.rb
 - lib/perron/resource/table_of_content.rb
 - lib/perron/site.rb
 - lib/perron/site/builder.rb
@@ -170,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Rails-based static site generator
 test_files: []

data/app/helpers/feeds_helper.rb

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

data/app/helpers/meta_tags_helper.rb

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

data/lib/perron/data.rb

@@ -1,180 +0,0 @@
-# frozen_string_literal: true
-
-require "csv"
-
-module Perron
-  class Data < SimpleDelegator
-    include Enumerable
-
-    def initialize(identifier)
-      @identifier = identifier
-      @file_path = self.class.path_for!(identifier)
-      @records = records
-
-      super(records)
-    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
-
-    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 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
-
-    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 { Item.new(it, identifier: @identifier) }
-    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 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, Time], aliases: true)
-    end
-
-    def parse_json(content)
-      JSON.parse(content, symbolize_names: true)
-    end
-
-    def parse_csv(content)
-      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
-
-      def default_url_options = Perron.configuration.default_url_options || {}
-    end
-    private_constant :HelperContext
-
-    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