perron 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 709c1a304332c522dd7e425824f2718b1a84994db9695b842cddab07fa2a6c2d
-  data.tar.gz: cd636faddbff65dd1cc27652fb9141a936ce7df7e5f4fca1e156fd7b1ff27522
+  metadata.gz: fbf1b0d5483938df7b88423f3ecd72bffaf938eadcc49a3001a34fcb0156dfb9
+  data.tar.gz: cd8871c7ef91a102a45bcebbcdc8bbf385db3a83ffb34948cd0d3e49c14d8237
 SHA512:
-  metadata.gz: 40df8027fb5974b0670a80b4c61e918da1f3dd7cec833e5fab48cdb606ddb9d9e56480cb69ad3c3033c2fdf1deb09e0c105cb15730cb92581e1d57c3db57ce3f
-  data.tar.gz: af0d331538e600ad27d23f9377d6cdabcc1f3142ad7d07de517b002334c0414896edb45d6d0d5d6ab50a6af81be12f4b2bf667c15e8bc50e211a824b6701d1b2
+  metadata.gz: 4d21cfbf61b54fb704990a23cbbf73285364e37ab722246c0202ecea37616398edcfe3fc9f841bc3cae9100108cb61e37200780c0e0ef667515f6e27319498e4
+  data.tar.gz: bed9e2b68bf2a5697a72a6b3bcb2dfcdb6898b93e31b6bc68b169583462d9e4a4f3e345dec8470077b2566dd31860e8ca97ce83cd82b8a01aff889ad0d5a7d14

data/Gemfile.lock

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

data/lib/generators/perron/templates/initializer.rb.tt

@@ -1,25 +1,21 @@
 Perron.configure do |config|
-  # config.output = "output"
+  # View all options: https://perron.railsdesigner.com/docs/configuration/
 
   # config.site_name = "Chirp Form"
 
-  # The build mode for Perron. Can be :standalone or :integrated
+  # The build mode for Perron. Can be :standalone (SSG) or :integrated (alongside your Rails app)
   # config.mode = :standalone
 
-  # In `integrated` mode, the root is skipped by default. Set to `true` to enable
-  # config.include_root = false
-
-  # config.default_url_options = {host: "helptail.com", protocol: "https", trailing_slash: true}
+  # config.default_url_options = {host: "chirpform.com", protocol: "https", trailing_slash: true}
 
   # The options hash is passed directly to the chosen library
   # config.markdown_options = {}
 
-  # Set default meta values
-  # Examples:
-  # - `config.metadata.description = "Add forms to any static site. Display responses anywhere."`
-  # - `config.metadata.author = "Chirp Form Team"`
-
   # Set meta title suffix
   # config.metadata.title_suffix = nil
   # config.metadata.title_separator = " — "
+
+  # Set default meta values
+  # config.metadata.description = "Add forms to any static site. Display responses anywhere."
+  # config.metadata.author = "Chirp Form Team"
 end

data/lib/generators/rails/content/USAGE

@@ -17,6 +17,27 @@ Examples:
 
     And adds: resources :posts, module: :content, only: %w[index show]
 
+    Generate pages scaffold with root:
+        rails generate content Page
+
+    This will additionally create:
+        app/content/pages/root.erb
+        def root action in Content::PagesController
+        root route in config/routes.rb (if not already defined)
+
+    Skip root generation for pages:
+        rails generate content Page --no-include-root
+
+    Include root for non-pages content:
+        rails generate content Article --include-root
+
+    Generate content scaffold with data sources:
+        rails generate content Product --data countries products
+        rails generate content Product --data countries.json products.yml
+
+    This will additionally create data source files in app/content/products/
+    and add sources/template_source class methods to the model.
+
     Create new content file from template:
         rails generate content Post --new
         rails generate content Post --new "My First Post"
@@ -38,4 +59,6 @@ Arguments:
 
 Options:
     --new [TITLE]: Create new content file instead of scaffold
+    --data [source1(.ext) source2(.ext)]: Create data source files (default extension: .yml)
     --force-plural: Use plural form for model name and class
+    --[no-]include-root: Include root action and route (default: true for pages, false otherwise)

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

@@ -8,8 +8,11 @@ module Rails
       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 :include_root, type: :boolean, default: nil, desc: "Include root action and route (defaults to true for pages)"
       class_option :new, type: :string, default: nil, banner: "TITLE",
         desc: "Create a new content file from template instead of generating scaffold"
+      class_option :data, type: :array, default: [], banner: "source1(.ext) source2(.ext)",
+        desc: "Specify data sources with optional extensions (defaults to .yml)"
 
       argument :actions, type: :array, default: %w[index show], banner: "actions", desc: "Specify which actions to generate (index/show)"
 
@@ -60,25 +63,52 @@ module Rails
         FileUtils.mkdir_p(content_directory)
       end
 
-      def create_pages_root
+      def add_content_route
         return if @content_mode
-        return unless pages_controller?
 
-        template "root.erb.tt", File.join(content_directory, "root.erb")
+        route "resources :#{plural_file_name}, module: :content, only: %w[#{actions.join(" ")}]"
       end
 
-      def add_content_route
+      def create_data_sources
         return if @content_mode
+        return if options[:data].empty?
 
-        route "resources :#{plural_file_name}, module: :content, only: %w[#{actions.join(" ")}]"
+        options[:data].each do |source|
+          name, extension = source.split(".", 2)
+
+          create_file File.join(content_directory, "#{name}.#{extension || "yml"}"), ""
+        end
+      end
+
+      def add_root_action
+        return if @content_mode
+        return unless should_include_root?
+
+        inject_into_class "app/controllers/content/#{plural_file_name}_controller.rb", "Content::#{plural_class_name}Controller" do
+          <<-RUBY
+
+        def root
+          @resource = Content::#{class_name}.root
+
+          render :show
+        end
+          RUBY
+        end
+      end
+
+      def create_root_content_file
+        return if @content_mode
+        return unless should_include_root?
+
+        template "root.erb.tt", File.join(content_directory, "root.erb")
       end
 
       def add_root_route
         return if @content_mode
-        return unless pages_controller?
+        return unless should_include_root?
         return if root_route_exists?
 
-        inject_into_file "config/routes.rb", "  root to: \"content/pages#root\"\n", before: /^\s*end\s*$/
+        route "root to: \"content/#{plural_file_name}#root\""
       end
 
       private
@@ -99,14 +129,6 @@ module Rails
 
       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
@@ -121,6 +143,23 @@ module Rails
           end
         end
       end
+
+      def should_include_root?
+        options[:include_root].nil? ? pages_controller? : options[:include_root]
+      end
+
+      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 data_sources
+        options[:data].map { it.split(".").first }
+      end
+
+      def data_sources? = !options[:data].empty?
     end
   end
 end

data/lib/generators/rails/content/templates/model.rb.tt

@@ -1,2 +1,13 @@
 class Content::<%= class_name %> < Perron::Resource
+<% if data_sources? -%>
+
+  sources <%= data_sources.map { ":#{it}" }.join(", ") %>
+
+  def self.source_template(sources)
+    <<~TEMPLATE
+    ---
+    ---
+    TEMPLATE
+  end
+<% end -%>
 end

data/lib/generators/rails/content/templates/root.erb.tt

@@ -1,4 +1,4 @@
 ---
 ---
 
-Find me in `app/content/pages/root.erb`
+Find me in `app/content/<%= plural_file_name %>/root.erb`

data/lib/generators/rails/content/templates/show.html.erb.tt

@@ -3,5 +3,5 @@
     <%%= @resource.filename %>
   </h1>
 
-  <%%= markdownify @resource.content %>
+  <%%= @resource.content %>
 </article>

data/lib/perron/configuration.rb

@@ -19,7 +19,6 @@ module Perron
       @config.output = "output"
 
       @config.mode = :standalone
-      @config.include_root = false
 
       @config.allowed_extensions = %w[erb md]
 
@@ -53,7 +52,11 @@ module Perron
 
     def mode = @config.mode.to_s.inquiry
 
-    def exclude_root? = !@config.include_root
+    def additional_routes
+      @additional_routes || (mode.integrated? ? [] : %w[root_path])
+    end
+
+    attr_writer :additional_routes
 
     def url
       options = Perron.configuration.default_url_options

data/lib/perron/data.rb

@@ -4,6 +4,8 @@ require "csv"
 
 module Perron
   class Data < SimpleDelegator
+    include Enumerable
+
     def initialize(identifier)
       @identifier = identifier
       @file_path = self.class.path_for!(identifier)
@@ -12,6 +14,21 @@ module Perron
       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)
@@ -24,6 +41,24 @@ module Perron
         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)
 

data/lib/perron/resource/class_methods.rb

@@ -12,7 +12,9 @@ module Perron
 
         def count = all.size
 
-        def first = all[0]
+        def first(n = nil)
+          n ? all.first(n) : all[0]
+        end
 
         def second = all[1]
 
@@ -30,9 +32,7 @@ module Perron
 
         def collection = Collection.new(collection_name)
 
-        def root
-          collection_name.pages? && collection.find_by_file_name("root", name.constantize)
-        end
+        def root = all.find(&:root?)
 
         def model_name
           @model_name ||= ActiveModel::Name.new(self, nil, name.demodulize.to_s)

data/lib/perron/resource/metadata.rb

@@ -47,7 +47,7 @@ module Perron
 
       def canonical_url
         return @frontmatter[:canonical_url] if @frontmatter[:canonical_url]
-        return Rails.application.routes.url_helpers.root_url(**Perron.configuration.default_url_options) if @resource.slug == "/"
+        return Rails.application.routes.url_helpers.root_url(**Perron.configuration.default_url_options) if @resource.root?
 
         begin
           Rails.application.routes.url_helpers.polymorphic_url(

data/lib/perron/resource.rb

@@ -82,6 +82,10 @@ module Perron
     def related_resources(limit: 5) = Perron::Site::Resource::Related.new(self).find(limit:)
     alias_method :related, :related_resources
 
+    def root?
+      slug == "/"
+    end
+
     private
 
     def frontmatter
@@ -103,9 +107,5 @@ module Perron
     def erb_processing?
       @file_path.ends_with?(".erb") || metadata.erb == true
     end
-
-    def root?
-      collection.name.inquiry.pages? && File.basename(filename) == "root"
-    end
   end
 end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Perron
+  module Site
+    class Builder
+      class AdditionalRoutes
+        def initialize(paths)
+          @paths = paths
+        end
+
+        def get
+          Perron.configuration.additional_routes.each do |route_name|
+            @paths << routes.public_send(route_name) if routes.respond_to?(route_name)
+          end
+        end
+
+        private
+
+        def routes = Rails.application.routes.url_helpers
+      end
+    end
+  end
+end

data/lib/perron/site/builder/feeds/author.rb

@@ -8,7 +8,8 @@ module Perron
           private
 
           def author(resource)
-            author = resource.author || feed_configuration.author
+            author = (resource&.respond_to?(:author) && resource.author) ||
+              feed_configuration.author
 
             Author.new(author) if author
           end

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

@@ -13,11 +13,9 @@ module Perron
 
           if routes.respond_to?(show_path)
             @collection.send(:load_resources).select(&:buildable?).each do |resource|
-              root = resource.slug == "/"
+              next if resource.root?
 
-              next if skip? root
-
-              @paths << (root ? routes.root_path : routes.public_send(show_path, resource))
+              @paths << routes.public_send(show_path, resource)
 
               (resource.class.try(:nested_routes) || []).each do |nested|
                 @paths << routes.polymorphic_path([resource, nested])
@@ -28,11 +26,6 @@ module Perron
 
         private
 
-        def skip?(root)
-          root &&
-            Perron.configuration.mode.integrated? && Perron.configuration.exclude_root?
-        end
-
         def routes = Rails.application.routes.url_helpers
 
         def index_path = "#{@collection.name}_path"

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

@@ -13,6 +13,8 @@ module Perron
 
           xml = Nokogiri::XML::Builder.new(encoding: "UTF-8") do |builder|
             builder.urlset(xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9") do
+              add_additional_routes(with: builder)
+
               Perron::Site.collections.each do |collection|
                 add_urls_for(collection, with: builder)
               end
@@ -24,6 +26,21 @@ module Perron
 
         private
 
+        def add_additional_routes(with:)
+          (Perron.configuration.additional_routes || []).each do |route_name|
+            next unless routes.respond_to?(route_name)
+
+            routes.with_options(Perron.configuration.default_url_options) do |url|
+              with.url do
+                with.loc url.public_send(route_name.to_s.gsub("_path", "_url"))
+                with.priority Perron.configuration.sitemap.priority
+                with.changefreq Perron.configuration.sitemap.change_frequency
+                with.lastmod Time.current.iso8601
+              end
+            end
+          end
+        end
+
         def add_urls_for(collection, with:)
           return if collection.configuration.blank?
           return if collection.configuration.sitemap.exclude == true
@@ -31,13 +48,12 @@ module Perron
           collection.resources.each do |resource|
             next if resource.metadata.sitemap == false
 
-            root = resource.slug == "/"
             priority = resource.metadata.sitemap_priority || collection.configuration.sitemap.priority || Perron.configuration.sitemap.priority
             change_frequency = resource.metadata.sitemap_change_frequency || collection.configuration.sitemap.change_frequency || Perron.configuration.sitemap.change_frequency
 
             Rails.application.routes.url_helpers.with_options(Perron.configuration.default_url_options) do |url|
               with.url do
-                with.loc root ? url.root_url : url.polymorphic_url(resource)
+                with.loc resource.root? ? url.root_url : url.polymorphic_url(resource)
                 with.priority priority
                 with.changefreq change_frequency
                 begin
@@ -49,6 +65,8 @@ module Perron
             end
           end
         end
+
+        def routes = Rails.application.routes.url_helpers
       end
     end
   end

data/lib/perron/site/builder.rb

@@ -5,6 +5,7 @@ require "perron/site/builder/sitemap"
 require "perron/site/builder/feeds"
 require "perron/site/builder/public_files"
 require "perron/site/builder/paths"
+require "perron/site/builder/additional_routes"
 require "perron/site/builder/page"
 
 module Perron
@@ -40,6 +41,7 @@ module Perron
 
       def paths
         Set.new.tap do |paths|
+          Perron::Site::Builder::AdditionalRoutes.new(paths).get
           Perron::Site.collections.each { Perron::Site::Builder::Paths.new(it, paths).get }
         end
       end

data/lib/perron/version.rb

@@ -1,3 +1,3 @@
 module Perron
-  VERSION = "0.16.0"
+  VERSION = "0.17.0"
 end

data/lib/perron.rb

@@ -4,7 +4,6 @@ require "perron/version"
 require "perron/configuration"
 require "perron/deprecator"
 require "perron/errors"
-require "perron/root"
 require "perron/site"
 require "perron/content/data"
 require "perron/resource"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perron
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Rails Designer Developers
@@ -131,9 +131,9 @@ files:
 - lib/perron/resource/slug.rb
 - lib/perron/resource/sourceable.rb
 - lib/perron/resource/table_of_content.rb
-- lib/perron/root.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/author.rb
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Rails-based static site generator
 test_files: []

data/lib/perron/root.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Perron
-  module Root
-    include ActiveSupport::Concern
-
-    def root
-      @resource = Content::Page.root
-
-      render :show
-    end
-  end
-end