perron 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '080352c09efb475419f74de6ee7cf01a491d4cc349f6cf0d6e23d35132c83953'
-  data.tar.gz: 156c0419afc4c3aa77411ac7f7508cbea56de584d164624be86b4d2615baf7f5
+  metadata.gz: f86f6e49cb1954ed51dc8aa0c2b6cfdaf3f1fcc3c78141b36c837f0eef26a9c8
+  data.tar.gz: efaff555c00579430812ca06e3ee6a87376db403321ab302762b393356d7607a
 SHA512:
-  metadata.gz: c75e1453c34bf8a8b8a4345d9167110745c1c47d8094aea3345e85fb46de51b0d326c904a7132c20e058ae89156c48dac5b9311121fc0359ad1d348ccde7d27f
-  data.tar.gz: a3acd15ee6f0224c032b31dac7272539e6ed6e6c9451a4b22d47c83c108f8fa374f5b6b7ceab97ae7bf4d6cc1296bbac8cd9c8788b28c7187f50c29c4621ee01
+  metadata.gz: c7e7c64d77fac8aadb06e3fc3541db5f8593a571938c12020dcbcb03e3f968dd326eede32b06342843df4b0e84e8722b4beb95b5d202283539b763ba3db01ada
+  data.tar.gz: 1a3f470b3412fa9187bca282ee1ac051cd1674c34a19a761b6cdedf901f0e5e2e6bb2c1a025ffadf1e2f478fcf13b9f8a90ab29579d46ae0cf3594099b13fb5d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    perron (0.14.0)
+    perron (0.15.0)
       csv
       json
       psych

data/lib/generators/perron/install_generator.rb

@@ -11,10 +11,7 @@ module Perron
     end
 
     def create_data_directory
-      data_directory = Rails.root.join("app", "content", "data")
-      empty_directory data_directory
-
-      template "README.md.tt", File.join(data_directory, "README.md")
+      template "README.md.tt", "app/content/data/README.md"
     end
 
     def add_markdown_gems

data/lib/generators/rails/content/USAGE

@@ -0,0 +1,41 @@
+Description:
+    Generates content model scaffold (controller, views, routes) or creates
+    new content files from templates.
+
+Examples:
+    Generate content scaffold:
+        rails generate content Post
+        rails generate content Post index
+        rails generate content Post index show
+
+    This will create:
+        app/content/posts/
+        app/models/content/post.rb
+        app/controllers/content/posts_controller.rb
+        app/views/content/posts/index.html.erb
+        app/views/content/posts/show.html.erb
+
+    And adds: resources :posts, module: :content, only: %w[index show]
+
+    Create new content file from template:
+        rails generate content Post --new
+        rails generate content Post --new "My First Post"
+
+    This will create a new content file in app/content/posts/ using:
+        - YYYY-MM-DD-template.*.tt (if exists, with date prefix)
+        - template.*.tt (if exists, without date prefix)
+        - Empty file with frontmatter dashes (if no template)
+
+    Template files support ERB:
+        ---
+        title: <%= @title %>
+        published_at: <%= Time.current %>
+        ---
+
+Arguments:
+    NAME: Name of the content model (singular or plural)
+    actions: Actions to generate (default: index show)
+
+Options:
+    --new [TITLE]: Create new content file instead of scaffold
+    --force-plural: Use plural form for model name and class

data/lib/generators/rails/content/content_generator.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Rails
+  module Generators
+    class ContentGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :force_plural, type: :boolean, default: false, desc: "Forces the use of a plural model name and class"
+      class_option :new, type: :string, default: nil, banner: "TITLE",
+        desc: "Create a new content file from template instead of generating scaffold"
+
+      argument :actions, type: :array, default: %w[index show], banner: "actions", desc: "Specify which actions to generate (index/show)"
+
+      def initialize(*args)
+        super
+
+        @content_mode = !options[:new].nil?
+        @content_title = options[:new].presence
+      end
+
+      def create_content_file
+        return unless @content_mode
+
+        @title = @content_title
+
+        if template_file
+          create_file File.join(content_directory, filename_from_template), ERB.new(File.read(template_file)).result(binding)
+        else
+          create_file File.join(content_directory, filename_from_template), "---\n---\n"
+        end
+      end
+
+      def create_model
+        return if @content_mode
+
+        template "model.rb.tt", File.join("app/models/content", "#{file_name}.rb")
+      end
+
+      def create_controller
+        return if @content_mode
+
+        template "controller.rb.tt", File.join("app/controllers/content", "#{plural_file_name}_controller.rb")
+      end
+
+      def create_views
+        return if @content_mode
+
+        empty_directory view_directory
+
+        actions.each do |action|
+          template "#{action}.html.erb.tt", File.join(view_directory, "#{action}.html.erb")
+        end
+      end
+
+      def create_content_directory
+        return if @content_mode
+
+        FileUtils.mkdir_p(content_directory)
+      end
+
+      def create_pages_root
+        return if @content_mode
+        return unless pages_controller?
+
+        template "root.erb.tt", File.join(content_directory, "root.erb")
+      end
+
+      def add_content_route
+        return if @content_mode
+
+        route "resources :#{plural_file_name}, module: :content, only: %w[#{actions.join(" ")}]"
+      end
+
+      def add_root_route
+        return if @content_mode
+        return unless pages_controller?
+        return if root_route_exists?
+
+        inject_into_file "config/routes.rb", "  root to: \"content/pages#root\"\n", before: /^\s*end\s*$/
+      end
+
+      private
+
+      def file_name
+        options[:force_plural] ? super.pluralize : super.singularize
+      end
+
+      def class_name
+        options[:force_plural] ? super.pluralize : super.singularize
+      end
+
+      def view_directory = File.join(destination_root, "app", "views", "content", plural_file_name)
+
+      def content_directory = File.join(destination_root, "app", "content", plural_file_name)
+
+      def plural_class_name = plural_name.camelize
+
+      def pages_controller? = plural_file_name == "pages"
+
+      def root_route_exists?
+        routes = File.join(destination_root, "config", "routes.rb")
+
+        return false unless File.exist?(routes)
+
+        File.read(routes).match?(/\broot\s+to:/)
+      end
+
+      def template_file
+        @template_file ||= Dir.glob(File.join(content_directory, "{YYYY-MM-DD-,}template.*.tt")).first
+      end
+
+      def filename_from_template
+        @filename_from_template ||= begin
+          return "untitled.md" unless template_file
+
+          File.basename(template_file, ".tt").tap do |name|
+            name.gsub!("YYYY-MM-DD", Time.current.strftime("%Y-%m-%d"))
+            name.sub!("template", @content_title ? @content_title.parameterize : "untitled")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/collection.rb

@@ -16,17 +16,12 @@ module Perron
     end
 
     def all(resource_class = "Content::#{name.classify}".safe_constantize)
-      allowed_extensions = Perron.configuration.allowed_extensions.map { ".#{it}" }.to_set
-
-      Dir.glob("#{@collection_path}/**/*.*")
-        .select { allowed_extensions.include?(File.extname(it)) }
-        .map { resource_class.new(it) }
-        .select(&:published?)
+      load_resources(resource_class).select(&:published?)
     end
     alias_method :resources, :all
 
     def find(slug, resource_class = Resource)
-      resource = all(resource_class).find { it.slug == slug }
+      resource = load_resources(resource_class).find { it.slug == slug }
 
       return resource if resource
 
@@ -40,5 +35,15 @@ module Perron
     end
 
     def validate = Perron::Site::Validate.new(collections: [self]).validate
+
+    private
+
+    def load_resources(resource_class = "Content::#{name.classify}".safe_constantize)
+      allowed_extensions = Perron.configuration.allowed_extensions.map { ".#{it}" }.to_set
+
+      Dir.glob("#{@collection_path}/**/*.*")
+        .select { allowed_extensions.include?(File.extname(it)) }
+        .map { resource_class.new(it) }
+    end
   end
 end

data/lib/perron/resource/previewable.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Perron
+  class Resource
+    module Previewable
+      extend ActiveSupport::Concern
+
+      included do
+        def previewable?
+          frontmatter.preview.present? && (draft? || scheduled?)
+        end
+
+        def preview_token
+          return nil unless previewable?
+
+          @preview_token ||= if frontmatter.preview == true
+            Digest::SHA256.hexdigest(file_path)[0..11]
+          else
+            frontmatter.preview
+          end
+        end
+      end
+    end
+  end
+end

data/lib/perron/resource/publishable.rb

@@ -16,8 +16,16 @@ module Perron
           true
         end
 
+        def buildable?
+          published? || previewable?
+        end
+
         def scheduled? = publication_date&.after?(Time.current)
 
+        def draft?
+          frontmatter.draft == true || frontmatter.published == false
+        end
+
         def publication_date
           @publication_date ||= begin
             from_meta = frontmatter.published_at.present? ? begin

data/lib/perron/resource/slug.rb

@@ -15,8 +15,9 @@ module Perron
       def create
         return "/" if Perron.configuration.allowed_extensions.any? { @resource.filename == "root.#{it}" }
 
-        @frontmatter.slug.presence ||
-          @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(dot_prepended_allowed_extensions)
+        base_slug = @frontmatter.slug.presence || @resource.filename.sub(/^[\d-]+-/, "").delete_suffixes(dot_prepended_allowed_extensions)
+
+        [base_slug, @resource.preview_token].compact.join("-")
       end
 
       private

data/lib/perron/resource.rb

@@ -5,6 +5,7 @@ require "perron/resource/core"
 require "perron/resource/class_methods"
 require "perron/resource/associations"
 require "perron/resource/metadata"
+require "perron/resource/previewable"
 require "perron/resource/publishable"
 require "perron/resource/reading_time"
 require "perron/resource/related"
@@ -27,6 +28,7 @@ module Perron
     include Perron::Resource::ReadingTime
     include Perron::Resource::Sourceable
     include Perron::Resource::Publishable
+    include Perron::Resource::Previewable
     include Perron::Resource::TableOfContent
 
     attr_reader :file_path, :id

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

@@ -12,7 +12,7 @@ module Perron
           @paths << routes.public_send(index_path) if routes.respond_to?(index_path)
 
           if routes.respond_to?(show_path)
-            @collection.all.each do |resource|
+            @collection.send(:load_resources).select(&:buildable?).each do |resource|
               root = resource.slug == "/"
 
               next if skip? root

data/lib/perron/site/builder.rb

@@ -31,6 +31,8 @@ module Perron
         Perron::Site::Builder::Sitemap.new(@output_path).generate
         Perron::Site::Builder::Feeds.new(@output_path).generate
 
+        output_preview_urls
+
         puts "\n✅ Build complete"
       end
 
@@ -43,6 +45,17 @@ module Perron
       end
 
       def render_page(path) = Perron::Site::Builder::Page.new(path).render
+
+      def output_preview_urls
+        previewable_resources = Perron::Site.collections.flat_map { it.send(:load_resources) }.select(&:previewable?)
+
+        if previewable_resources.any?
+          puts "\n🔒 Preview URLs:"
+          previewable_resources.each do |resource|
+            puts "   #{Rails.application.routes.url_helpers.polymorphic_url(resource, **Perron.configuration.default_url_options)}"
+          end
+        end
+      end
     end
   end
 end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -86,16 +86,16 @@ files:
 - bin/rails
 - bin/release
 - bin/setup
-- lib/generators/content/USAGE
-- 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/generators/rails/content/USAGE
+- lib/generators/rails/content/content_generator.rb
+- lib/generators/rails/content/templates/controller.rb.tt
+- lib/generators/rails/content/templates/index.html.erb.tt
+- lib/generators/rails/content/templates/model.rb.tt
+- lib/generators/rails/content/templates/root.erb.tt
+- lib/generators/rails/content/templates/show.html.erb.tt
 - lib/perron.rb
 - lib/perron/collection.rb
 - lib/perron/configuration.rb
@@ -118,6 +118,7 @@ files:
 - lib/perron/resource/configuration.rb
 - lib/perron/resource/core.rb
 - lib/perron/resource/metadata.rb
+- lib/perron/resource/previewable.rb
 - lib/perron/resource/publishable.rb
 - lib/perron/resource/reading_time.rb
 - lib/perron/resource/related.rb
@@ -164,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.1
 specification_version: 4
 summary: Rails-based static site generator
 test_files: []

data/lib/generators/content/USAGE

@@ -1,16 +0,0 @@
-Description:
-    Creates a new content model with specified actions
-
-Example:
-    rails generate content post
-
-    This will create:
-      - app/models/content/post.rb
-      - app/controllers/content/posts_controller.rb
-      - app/views/content/posts/index.html.erb
-      - app/views/content/posts/show.html.erb
-      - …and add `resource :posts, module: :content, only: %w[index show]` to `config/routes.rb`
-
-Arguments:
-    NAME: Name of the content model
-    actions: List of actions to generate (index or show)

data/lib/generators/content/content_generator.rb

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/base"
-
-class ContentGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path("templates", __dir__)
-
-  class_option :force_plural, type: :boolean, default: false, desc: "Forces the use of a plural model name and class"
-
-  argument :actions, type: :array, default: %w[index show], banner: "actions", desc: "Specify which actions to generate (index/show)"
-
-  def create_model
-    template "model.rb.tt", File.join("app/models/content", "#{file_name}.rb")
-  end
-
-  def create_controller
-    template "controller.rb.tt", File.join("app/controllers/content", "#{plural_file_name}_controller.rb")
-  end
-
-  def create_views
-    empty_directory view_directory
-
-    actions.each do |action|
-      template "#{action}.html.erb.tt", File.join(view_directory, "#{action}.html.erb")
-    end
-  end
-
-  def create_content_directory = FileUtils.mkdir_p(content_directory)
-
-  def create_pages_root
-    return unless pages_controller?
-
-    template "root.erb.tt", File.join(content_directory, "root.erb")
-  end
-
-  def add_content_route
-    route "resources :#{plural_file_name}, module: :content, only: %w[#{actions.join(" ")}]"
-  end
-
-  def add_root_route
-    return unless pages_controller?
-    return if root_route_exists?
-
-    inject_into_file "config/routes.rb", "  root to: \"content/pages#root\"\n", before: /^\s*end\s*$/
-  end
-
-  private
-
-  def file_name
-    options[:force_plural] ? super.pluralize : super.singularize
-  end
-
-  def class_name
-    options[:force_plural] ? super.pluralize : super.singularize
-  end
-
-  def view_directory = Rails.root.join("app", "views", "content", plural_file_name)
-
-  def content_directory = Rails.root.join("app", "content", plural_file_name)
-
-  def plural_class_name = plural_name.camelize
-
-  def pages_controller? = plural_file_name == "pages"
-
-  def root_route_exists?
-    routes = Rails.root.join("config", "routes.rb")
-
-    return false unless File.exist?(routes)
-
-    File.read(routes).match?(/\broot\s+to:/)
-  end
-end