perron 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa3f2904ac098e13aff67d7153df4867f4301a9c273d06963d3ff0330f97fe86
-  data.tar.gz: e53143e80f15e7fd1cf00b789959e2c0399f1f547459a39ecf927f6859bfd8f3
+  metadata.gz: f91a86bc7ff57f28eb58ef9aac6b1d3e94c008a3570df359aca5f5e6b416c7e7
+  data.tar.gz: 53cd0a23ce3fbcd1fe90aa07a26577f34e66be5a8fd018c596498e34c67c5718
 SHA512:
-  metadata.gz: 9e7a6e6594f349a7f6f575d5e7bdc1a54234446846695b848c0ff1e982a2de22898c85749b39af4196f64ba44d991b4d25878f4f8451d5ef4fd8fb9fa093c1e6
-  data.tar.gz: 7055bbf79e0635ce0e2f38c3397f3e20bb76c70dd228ed5482be2fdf9bfe3d38d986e24a1a632420795adbad36cf5019cde704187fd7d9408cd990122fd209fe
+  metadata.gz: dd5f18ac803ece9604f9187047c637e4be0f1ad31fb77bce0d73f97dc633ba60644a4d2638deadc2d2d05e6f5152e8050ecc4823caa1dd2c64d0da487618ee85
+  data.tar.gz: e99ffd6732c726f78f4a5e3f2ce07c571019b43d8028539ea1a5d6ad0d75f52f74d254808e3585f0d0e546b2d453e880f2291b2e088dc8e6fe8e63b496f5990d

data/Gemfile.lock

@@ -1,7 +1,10 @@
 PATH
   remote: .
   specs:
-    perron (0.5.0)
+    perron (0.6.0)
+      csv
+      json
+      psych
       rails (>= 7.2.0)
 
 GEM
@@ -86,6 +89,7 @@ GEM
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crass (1.0.6)
+    csv (3.3.5)
     date (3.4.1)
     debug (1.11.0)
       irb (~> 1.10)

data/README.md

@@ -89,6 +89,35 @@ bundle add {commonmarker,kramdown,redcarpet}
 ```
 
 
+## Data Files
+
+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::Data` with the basename of the file and iterate over the result.
+```erb
+<% 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.
+
+### 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]
+```
+
+
 ## Metatags
 
 The `meta_tags` helper automatically generates SEO and social sharing meta tags for your pages.
@@ -115,7 +144,7 @@ Or exclude certain tags:
 <%= meta_tags except: %w[twitter_card twitter_image] %>
 ```
 
-### Metadata Priority
+### Priority
 
 Values are determined with the following precedence, from highest to lowest:
 
@@ -172,6 +201,16 @@ RAILS_ENV=production rails perron:build
 This will create your static site in the configured output directory (`output` by default).
 
 
+## Sites using Perron
+
+Sites that use Perron.
+
+### Standalone (as a SSG)
+- [AppRefresher](https://apprefresher.com)
+
+### Integrated (part of a Rails app)
+- [Rails Designers (private community for Rails UI engineers](https://railsdesigners.com)
+
 ## Contributing
 
 This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please run `be standardrb` before submitting pull requests. Run tests with `rails test`.

data/lib/generators/perron/install_generator.rb

@@ -5,5 +5,12 @@ module Perron
     def copy_initializer
       template "initializer.rb.tt", "config/initializers/perron.rb"
     end
+
+    def create_data_directory
+      data_directory = Rails.root.join("app", "views", "content", "data")
+      empty_directory data_directory
+
+      template "README.md.tt", File.join(data_directory, "README.md")
+    end
   end
 end

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

@@ -0,0 +1,30 @@
+# 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::Data` with the basename of the file and iterate over the result.
+```erb
+<% 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.
+
+
+## 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]
+```

data/lib/perron/errors.rb

@@ -5,5 +5,9 @@ module Perron
     class FileNotFoundError < StandardError; end
 
     class ResourceNotFoundError < StandardError; end
+
+    class UnsupportedDataFormatError < StandardError; end
+
+    class DataParseError < StandardError; end
   end
 end

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

@@ -30,7 +30,7 @@ module Perron
         private
 
         def paths
-          @paths ||= Dir.glob("#{@public_dir}/*", File::FNM_DOTMATCH).reject do |path|
+          @paths ||= Dir.glob(File.join(@public_dir, "*")).reject do |path|
             Set.new(Perron.configuration.exclude_from_public + %w[. ..]).include?(File.basename(path))
           end
         end

data/lib/perron/site/data.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module Perron
+  class Data < SimpleDelegator
+    def initialize(identifier)
+      @file_path = path_for(identifier)
+      @records = records
+
+      super(records)
+    end
+
+    private
+
+    PARSER_METHODS = {
+      ".yml" => :parse_yaml, ".yaml" => :parse_yaml,
+      ".json" => :parse_json, ".csv" => :parse_csv
+    }.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 = 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)
+
+      unless data.is_a?(Array)
+        raise Errors::DataParseError, "Data in '#{@file_path}' must be an array of objects."
+      end
+
+      data.map { Item.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)
+    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 Item
+      def initialize(attributes)
+        @attributes = attributes.transform_keys(&:to_sym)
+      end
+
+      def [](key) = @attributes[key.to_sym]
+
+      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
+
+# 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.rb

@@ -4,7 +4,6 @@ require "perron/site/resource/core"
 require "perron/site/resource/class_methods"
 require "perron/site/resource/publishable"
 require "perron/site/resource/slug"
-require "perron/site/resource/context"
 require "perron/site/resource/separator"
 
 module Perron
@@ -31,11 +30,14 @@ module Perron
     alias_method :to_param, :slug
 
     def content
-      if processable?
-        ERB.new(Perron::Resource::Separator.new(raw_content).content).result(context.binding)
-      else
-        Perron::Resource::Separator.new(raw_content).content
-      end
+      return Perron::Resource::Separator.new(raw_content).content unless processable?
+
+      ::ApplicationController
+        .renderer
+        .render(
+          inline: Perron::Resource::Separator.new(raw_content).content,
+          assigns: {resource: self}
+        )
     end
 
     def metadata = Perron::Resource::Separator.new(raw_content).metadata
@@ -56,7 +58,5 @@ module Perron
         @file_path.delete_prefix(Perron.configuration.input).parameterize
       ).first(ID_LENGTH)
     end
-
-    def context = Perron::Resource::Context.new(self)
   end
 end

data/lib/perron/site.rb

@@ -3,6 +3,7 @@
 require "perron/site/builder"
 require "perron/site/collection"
 require "perron/site/resource"
+require "perron/site/data"
 
 module Perron
   module Site

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/perron.gemspec

@@ -19,4 +19,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.4.0"
 
   spec.add_dependency "rails", ">= 7.2.0"
+
+  spec.add_runtime_dependency "csv"
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "psych"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -23,6 +23,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.2.0
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Perron is a Rails-based static site generator that follows Rails conventions.
   It allows you to create content collections with markdown or ERB, configure SEO
   metadata, and build production-ready static sites while leveraging your existing
@@ -49,6 +91,7 @@ files:
 - lib/generators/content/templates/root.erb.tt
 - lib/generators/content/templates/show.html.erb.tt
 - lib/generators/perron/install_generator.rb
+- lib/generators/perron/templates/README.md.tt
 - lib/generators/perron/templates/initializer.rb.tt
 - lib/perron.rb
 - lib/perron/configuration.rb
@@ -67,9 +110,9 @@ files:
 - lib/perron/site/builder/paths.rb
 - lib/perron/site/builder/public_files.rb
 - lib/perron/site/collection.rb
+- lib/perron/site/data.rb
 - lib/perron/site/resource.rb
 - lib/perron/site/resource/class_methods.rb
-- lib/perron/site/resource/context.rb
 - lib/perron/site/resource/core.rb
 - lib/perron/site/resource/publishable.rb
 - lib/perron/site/resource/separator.rb

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

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Perron
-  class Resource
-    class Context
-      def initialize(resource)
-        @resource = resource
-      end
-
-      def binding = super
-    end
-  end
-end