perron 0.17.0 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 1.0.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,17 +92,17 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- app/helpers/feeds_helper.rb
-- app/helpers/meta_tags_helper.rb
+- app/controllers/perron/concierge_controller.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
+- app/views/perron/concierge/show.html.erb
 - bin/console
 - bin/rails
 - bin/release
 - bin/setup
-- lib/generators/perron/install_generator.rb
-- lib/generators/perron/templates/README.md.tt
-- lib/generators/perron/templates/initializer.rb.tt
 - lib/generators/rails/content/USAGE
 - lib/generators/rails/content/content_generator.rb
 - lib/generators/rails/content/templates/controller.rb.tt
@@ -97,25 +111,36 @@ files:
 - lib/generators/rails/content/templates/root.erb.tt
 - lib/generators/rails/content/templates/show.html.erb.tt
 - lib/perron.rb
+- lib/perron/assets/icon.png
+- lib/perron/assets/icon.svg
 - 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/development_feed_server.rb
 - lib/perron/engine.rb
 - lib/perron/errors.rb
 - lib/perron/feeds.rb
 - lib/perron/html_processor.rb
+- lib/perron/html_processor/absolute_urls.rb
 - lib/perron/html_processor/base.rb
 - lib/perron/html_processor/lazy_load_images.rb
-- lib/perron/html_processor/syntax_highlight.rb
 - lib/perron/html_processor/target_blank.rb
+- lib/perron/install.rb
+- lib/perron/install/README.md.tt
+- lib/perron/install/initializer.rb.tt
 - lib/perron/markdown.rb
 - 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/adjacency.rb
 - lib/perron/resource/associations.rb
 - lib/perron/resource/class_methods.rb
 - lib/perron/resource/configuration.rb
@@ -127,25 +152,35 @@ 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
 - lib/perron/site/builder/additional_routes.rb
 - lib/perron/site/builder/assets.rb
 - lib/perron/site/builder/feeds.rb
+- lib/perron/site/builder/feeds/atom.erb
+- lib/perron/site/builder/feeds/atom.rb
 - lib/perron/site/builder/feeds/author.rb
+- lib/perron/site/builder/feeds/json.erb
 - lib/perron/site/builder/feeds/json.rb
+- lib/perron/site/builder/feeds/rss.erb
 - lib/perron/site/builder/feeds/rss.rb
+- lib/perron/site/builder/feeds/template.rb
 - lib/perron/site/builder/page.rb
 - lib/perron/site/builder/paths.rb
 - lib/perron/site/builder/public_files.rb
+- lib/perron/site/builder/route_resources.rb
 - lib/perron/site/builder/sitemap.rb
 - lib/perron/site/validate.rb
 - lib/perron/tasks/build.rake
 - lib/perron/tasks/clobber.rake
+- lib/perron/tasks/install.rake
 - lib/perron/tasks/sync_sources.rake
 - lib/perron/tasks/validate.rake
 - lib/perron/version.rb
@@ -170,7 +205,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/generators/perron/install_generator.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Perron
-  class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("templates", __dir__)
-
-    desc "Install Perron in your Rails app"
-
-    def copy_initializer
-      template "initializer.rb.tt", "config/initializers/perron.rb"
-    end
-
-    def create_data_directory
-      template "README.md.tt", "app/content/data/README.md"
-    end
-
-    def add_markdown_gems
-      append_to_file "Gemfile", <<~RUBY
-
-        # Perron supports Markdown rendering using one of the following gems.
-        # Uncomment your preferred choice and run `bundle install`
-        # gem "commonmarker"
-        # gem "kramdown"
-        # gem "redcarpet"
-      RUBY
-    end
-
-    def gitignore_output_folder
-      append_to_file ".gitignore", "/#{Perron.configuration.output}/\n"
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-# 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.
-
-
-## Usage
-
-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 %>
-```
-
-
-## File location and formats
-
-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
-
-The wrapper object provides flexible, read-only access to each record's attributes. Both dot notation and hash-like key access are supported.
-```ruby
-feature.name
-feature[:name]
-```
-
-
-## Rendering
-
-You can render data collections directly using Rails-like partial rendering. When you call `render` on a data collection, Perron will automatically render a partial for each item.
-```erb
-<%%= render Perron::Site.data.features %>
-```
-
-This expects a partial at `app/views/content/features/_feature.html.erb` that will be rendered once for each feature in your data file. The individual record is made available as a local variable matching the singular form of the collection name.
-```erb
-<!-- app/views/content/features/_feature.html.erb -->
-<div class="feature">
-  <h4><%%= feature.name %></h4>
-  <p><%%= feature.description %></p>
-</div>
-```

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

data/lib/perron/html_processor/syntax_highlight.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "rouge"
-require "perron/html_processor/base"
-
-module Perron
-  class HtmlProcessor
-    class SyntaxHighlight < HtmlProcessor::Base
-      def process
-        @html.css('pre > code[class*="language-"]').each do |code_block|
-          language = code_block[:class][/(?<=language-)\S+/]
-
-          next if language.blank?
-
-          code_block.parent.replace(
-            highlight(code_block.text, with: language)
-          )
-        end
-      end
-
-      private
-
-      def highlight(code_block, with:)
-        lexer = Rouge::Lexer.find(with) || Rouge::Lexers::PlainText.new
-
-        Rouge::Formatters::HTMLPygments.new(::Rouge::Formatters::HTML.new).format(lexer.lex(code_block))
-      end
-    end
-  end
-end