perron 0.0.1 → 0.5.0

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/context"
+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
+      if processable?
+        ERB.new(Perron::Resource::Separator.new(raw_content).content).result(context.binding)
+      else
+        Perron::Resource::Separator.new(raw_content).content
+      end
+    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
+
+    def context = Perron::Resource::Context.new(self)
+  end
+end

data/lib/perron/site.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "perron/site/builder"
+require "perron/site/collection"
+require "perron/site/resource"
+
+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.5.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,22 @@
+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"
+end

metadata

@@ -1,25 +1,88 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.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
+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/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/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
+- 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 +90,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 +99,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: []