perron 0.0.1 → 0.6.0

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/class_methods.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module ClassMethods
+      extend ActiveSupport::Concern
+
+      class_methods do
+        def find(slug) = collection.find(slug, name.constantize)
+
+        def all = collection.all(self)
+
+        def count = all.size
+
+        def first = all[0]
+
+        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 collection = Collection.new(collection_name)
+
+        def model_name
+          @model_name ||= ActiveModel::Name.new(self, nil, name.demodulize.to_s)
+        end
+
+        private
+
+        def collection_name = name.demodulize.underscore.pluralize
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Core
+      extend ActiveSupport::Concern
+
+      def persisted? = true
+
+      def to_model = self
+
+      def model_name = self.class.model_name
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Publishable
+      extend ActiveSupport::Concern
+
+      included do
+        def published?
+          return true if Rails.env.development?
+
+          return false if metadata.draft == true
+          return false if metadata.published == false
+          return false if publication_date&.after?(Time.current)
+
+          true
+        end
+
+        def scheduled? = publication_date&.after?(Time.current)
+
+        def publication_date
+          @publication_date ||= begin
+            from_meta = metadata.published_at.present? ? begin
+              Time.zone.parse(metadata.published_at.to_s)
+            rescue
+              nil
+            end : nil
+
+            from_meta || date_from_filename
+          end
+        end
+        alias_method :published_at, :publication_date
+
+        def scheduled_at
+          publication_date if scheduled?
+        end
+      end
+
+      private
+
+      DATE_REGEX = /^(?<year>\d{4})-(?<month>\d{2})-(?<day>\d{2})-/
+
+      def date_from_filename
+        return @date_from_filename if defined?(@date_from_filename)
+
+        match = File.basename(file_path).match(DATE_REGEX)
+        @date_from_filename = match ? Date.new(match[:year].to_i, match[:month].to_i, match[:day].to_i).in_time_zone : nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    class Separator
+      attr_reader :content
+
+      def initialize(content)
+        parsed(content)
+      end
+
+      def metadata
+        @metadata_with_dot_access ||= ActiveSupport::OrderedOptions.new.tap do |options|
+          @metadata.each { |key, value| options[key] = value }
+        end
+      end
+
+      private
+
+      def parsed(content)
+        if content =~ /\A---\s*(.*?)\s*---\s*(.*)/m
+          @metadata = YAML.safe_load($1, permitted_classes: [Date, Time]) || {}
+          @content = $2.strip
+        else
+          @metadata = {}
+          @content = content
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "perron/refinements/delete_suffixes"
+
+module Perron
+  class Resource
+    class Slug
+      using Perron::SuffixStripping
+
+      def initialize(resource)
+        @resource = resource
+        @metadata = resource.metadata
+      end
+
+      def create
+        @metadata.slug.presence || @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(Perron.configuration.allowed_extensions)
+      end
+    end
+  end
+end

data/lib/perron/site/resource.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+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/separator"
+
+module Perron
+  class Resource
+    ID_LENGTH = 8
+
+    include Perron::Resource::Core
+    include Perron::Resource::ClassMethods
+    include Perron::Resource::Publishable
+
+    attr_reader :file_path, :id
+
+    def initialize(file_path)
+      @file_path = file_path
+      @id = generate_id
+
+      raise Errors::FileNotFoundError, "No such file: #{file_path}" unless File.exist?(file_path)
+    end
+
+    def filename = File.basename(@file_path)
+
+    def slug = Perron::Resource::Slug.new(self).create
+    alias_method :path, :slug
+    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}
+        )
+    end
+
+    def metadata = Perron::Resource::Separator.new(raw_content).metadata
+
+    def raw_content = File.read(@file_path)
+    alias_method :raw, :raw_content
+
+    def collection = Collection.new(self.class.model_name.collection)
+
+    private
+
+    def processable?
+      @file_path.ends_with?(".erb") || metadata.erb == true
+    end
+
+    def generate_id
+      Digest::SHA1.hexdigest(
+        @file_path.delete_prefix(Perron.configuration.input).parameterize
+      ).first(ID_LENGTH)
+    end
+  end
+end

data/lib/perron/site.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "perron/site/builder"
+require "perron/site/collection"
+require "perron/site/resource"
+require "perron/site/data"
+
+module Perron
+  module Site
+    module_function
+
+    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)) }
+        .map { Collection.new(it) }
+    end
+
+    def collection(name)
+      Collection.new(name)
+    end
+  end
+end

data/lib/perron/tasks/perron.rake

@@ -0,0 +1,12 @@
+namespace :perron do
+  desc "Generate static HTML files from Perron collections"
+  task build: :environment do
+    Perron::Site.build
+  end
+end
+
+Rake::Task["assets:precompile"].enhance do
+  next if Perron.configuration.mode.standalone?
+
+  Perron::Site.build
+end

data/lib/perron/version.rb

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

data/lib/perron.rb

@@ -1,3 +1,13 @@
+# frozen_string_literal: true
+
+require "perron/version"
+require "perron/configuration"
+require "perron/errors"
+require "perron/root"
+require "perron/site"
+require "perron/markdown"
+require "perron/metatags"
+require "perron/engine"
+
 module Perron
-  # TBD
 end

data/perron.gemspec

@@ -0,0 +1,26 @@
+require_relative "lib/perron/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "perron"
+  spec.version = Perron::VERSION
+  spec.authors = ["Rails Designer Developers"]
+  spec.email = "devs@railsdeigner.com"
+
+  spec.summary = "Rails-based static site generator"
+  spec.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 Rails knowledge with familiar patterns and minimal configuration."
+  spec.homepage = "https://github.com/Rails-Designer/perron"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Rails-Designer/perron/"
+
+  spec.files = Dir["{bin,app,lib}/**/*", "Rakefile", "README.md", "perron.gemspec", "Gemfile", "Gemfile.lock"]
+
+  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,25 +1,131 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Rails Designer Developers
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: Coming soon. Turn your Rails app to a static site.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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
+  Rails knowledge with familiar patterns and minimal configuration.
 email: devs@railsdeigner.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- app/helpers/meta_tags_helper.rb
+- app/helpers/perron/markdown_helper.rb
+- bin/console
+- bin/rails
+- bin/release
+- bin/setup
+- lib/generators/content/content_generator.rb
+- lib/generators/content/templates/controller.rb.tt
+- lib/generators/content/templates/index.html.erb.tt
+- lib/generators/content/templates/model.rb.tt
+- 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
+- lib/perron/engine.rb
+- lib/perron/errors.rb
+- lib/perron/html_processor.rb
+- lib/perron/html_processor/target_blank.rb
+- lib/perron/markdown.rb
+- lib/perron/metatags.rb
+- lib/perron/refinements/delete_suffixes.rb
+- lib/perron/root.rb
+- lib/perron/site.rb
+- lib/perron/site/builder.rb
+- lib/perron/site/builder/assets.rb
+- lib/perron/site/builder/page.rb
+- 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/core.rb
+- lib/perron/site/resource/publishable.rb
+- lib/perron/site/resource/separator.rb
+- lib/perron/site/resource/slug.rb
+- lib/perron/tasks/perron.rake
+- lib/perron/version.rb
+- perron.gemspec
 homepage: https://github.com/Rails-Designer/perron
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/Rails-Designer/perron
+  source_code_uri: https://github.com/Rails-Designer/perron/
 rdoc_options: []
 require_paths:
 - lib
@@ -27,7 +133,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -36,5 +142,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Rails-bases Static Site Generator
+summary: Rails-based static site generator
 test_files: []