nugem 0.8.0 → 0.8.3

data/templates/jekyll/hooks_scaffold/lib/dumpers.rb

@@ -0,0 +1,172 @@
+# Methods to display Jekyll variable contents
+module Dumpers
+  # See https://github.com/jekyll/jekyll/blob/master/lib/jekyll/collection.rb
+  #   attr_reader :site, :label, :metadata
+  #   attr_writer :docs
+  #   Metadata is a hash with at least these keys: output[Boolean], permalink[String]
+  #   selected methods: collection_dir, directory, entries, exists?, files, filtered_entries, relative_directory
+  def collection_as_string(collection, indent_spaces)
+    indent = ' ' * indent_spaces
+    result = <<~END_COLLECTION
+      '#{collection.label}' collection within '#{collection.relative_directory}' subdirectory
+        #{indent}Directory: #{collection.directory}
+        #{indent}Does the directory exist and is it not a symlink if in safe mode? #{collection.exists?}
+        #{indent}Collection_dir: #{collection.collection_dir}
+        #{indent}Metadata: #{collection.metadata}
+        #{indent}Static files: #{collection.files}
+        #{indent}Filtered entries: #{collection.filtered_entries}
+    END_COLLECTION
+    result.chomp
+  end
+
+  def count_lines(string)
+    return string.split("\n").length if string
+
+    0
+  end
+
+  # Calling value.to_s blows up when a Jekyll::Excerpt
+  # Error message is unrelated to the problem, makes it hard to track down
+  # Be careful when converting values to string!
+  def safe_to_s(value)
+    return value.content if value.is_a? Jekyll::Excerpt
+
+    value.to_s
+  rescue StandardError => e
+    e.message
+  end
+
+  # @param msg[String]
+  # @param document[Jekyll:Document] https://github.com/jekyll/jekyll/blob/master/lib/jekyll/document.rb
+  #   attr_reader :path, :extname, :collection, :type; :site is too big to dump here, we already have it anyway
+  #   Selected methods: date
+  def dump_document(logger, msg, document)
+    attributes = attributes_as_string(document, %i[@path @extname @type])
+    data = document.data.map { |k, v| "    #{k} = #{safe_to_s(v)}" }
+    logger.info do
+      <<~END_DOC
+        #{msg}
+          document dated #{document.date.to_date}:
+            relative_path: #{document.relative_path}:
+        #{attributes.join("\n")}
+            Is it a draft? #{document.draft?}
+            collection = #{collection_as_string(document.collection, 4)}
+            content not dumped because it would likely be too long
+            site not dumped also
+            data:
+          #{data.join("\n  ").rstrip.chomp}
+      END_DOC
+    end
+  end
+
+  # @param msg[String]
+  # @param page[Jekyll:Page] https://github.com/jekyll/jekyll/blob/master/lib/jekyll/page.rb
+  #   attr_accessor :basename, :content, :data, :ext, :name, :output, :pager, :site
+  #   Selected methods: dir, excerpt, path, permalink, url
+  def dump_page(logger, msg, page)
+    attributes = attributes_as_string(page, %i[@basename @ext @name])
+    # site = page.site available if you need it
+    data = page.data.map { |k, v| "    #{k} = #{v}" }
+    logger.info do
+      <<~END_PAGE
+        #{msg}\n  page at #{page.dir}:
+        #{attributes.join("\n")}
+            Is it HTML? #{page.html?}; is it an index? #{page.index?}
+            Permalink: #{page.permalink}
+            URL: #{page.url}
+            content not dumped because it would likely be too long
+            site not dumped also
+            Excerpt: "#{page.excerpt}"
+          data:
+        #{data.join("\n")}
+      END_PAGE
+    end
+  end
+
+  # @param msg[String]
+  # @param payload[Jekyll::Drops::UnifiedPayloadDrop] See https://github.com/jekyll/jekyll/blob/master/lib/jekyll/drops/unified_payload_drop.rb
+  #    This is a mutable class.
+  #    attr_accessor :content, :page, :layout, :paginator, :highlighter_prefix, :highlighter_suffix
+  # payload.page is a Jekyll::Drops::DocumentDrop, which contains this payload,
+  # see https://github.com/jekyll/jekyll/blob/master/lib/jekyll/drops/document_drop.rb
+  def dump_payload(logger, msg, payload)
+    result = <<~END_INFO
+      #{msg} payload:
+        content contains #{count_lines(payload.content)} lines.#{first_5_lines(payload.content)}
+        layout = #{payload.layout}
+        highlighter_prefix = #{payload.highlighter_prefix}
+        paginator and site not dumped.
+    END_INFO
+    logger.info { result.chomp }
+  end
+
+  def first_5_lines(string)
+    lines = string ? string.split("\n")[0..4] : []
+    return "\n    first 5 lines:\n    #{lines.join("\n    ")}\n" if lines.length.positive?
+
+    ''
+  end
+
+  # @param msg[String]
+  # @param site[Jekyll::Site] https://github.com/jekyll/jekyll/blob/master/lib/jekyll/site.rb
+  #   attr_accessor :baseurl, :converters, :data, :drafts, :exclude,
+  #     :file_read_opts, :future, :gems, :generators, :highlighter,
+  #     :include, :inclusions, :keep_files, :layouts, :limit_posts,
+  #     :lsi, :pages, :permalink_style, :plugin_manager, :plugins,
+  #     :reader, :safe, :show_drafts, :static_files, :theme, :time,
+  #     :unpublished
+  #   attr_reader :cache_dir, :config, :dest, :filter_cache, :includes_load_paths,
+  #     :liquid_renderer, :profiler, :regenerator, :source
+  def dump_site(logger, msg, site) # rubocop:disable Metrics/AbcSize
+    logger.info do
+      <<~END_INFO
+        #{msg} site
+        site is of type #{site.class}
+        site.time = #{site.time}
+      END_INFO
+    end
+    env = site.config['env']
+    if env
+      mode = env['JEKYLL_ENV']
+      logger.info { "site.config['env']['JEKYLL_ENV'] = #{mode}" }
+    else
+      logger.info { "site.config['env'] is undefined" }
+    end
+    site.collections.each do |key, _|
+      logger.info { "site.collections.#{key}" }
+    end
+
+    # key env contains all environment variables, quite verbose so output is reduced to just the 'env' key
+    logger.info { "site.config has #{site.config.length} entries:" }
+    site.config.sort.each { |key, value| logger.info { "  site.config.#{key} = '#{value}'" unless key == 'env' } }
+
+    logger.info { "site.data has #{site.data.length} entries:" }
+    site.data.sort.each { |key, value| logger.info { "  site.data.#{key} = '#{value}'" } }
+
+    logger.info { "site.documents has #{site.documents.length} entries." }
+    site.documents.each { |key, _value| logger.info "site.documents.#{key}" }
+
+    logger.info do
+      <<~END_INFO
+        site.keep_files has #{site.keep_files.length} entries.
+        site.keep_files: #{site.keep_files.sort}
+        site.pages has #{site.pages.length} entries.
+      END_INFO
+    end
+
+    site.pages.each { |key, _value| logger.info "site.pages.#{key}" }
+
+    logger.info { "site.posts has #{site.posts.docs.length} entries." }
+    site.posts.docs.each { |key, _value| logger.info "site.posts.docs.#{key}" }
+
+    logger.info { "site.tags has #{site.tags.length} entries." }
+    site.tags.sort.each { |key, value| logger.info { "site.tags.#{key} = '#{value}'" } }
+  end
+
+  def attributes_as_string(object, attrs)
+    attrs.map { |attr| "    #{attr.to_s.delete_prefix('@')} = #{object.instance_variable_get(attr)}" }
+  end
+
+  module_function :attributes_as_string, :collection_as_string, :count_lines, :dump_document, :dump_page,
+                  :dump_payload, :dump_site, :first_5_lines, :safe_to_s
+end

data/templates/jekyll/hooks_scaffold/lib/hooks.rb.tt

@@ -0,0 +1,238 @@
+require 'jekyll_plugin_logger'
+require_relative 'dumpers'
+
+# See https://www.mslinn.com/jekyll/10200-jekyll-plugin-background.html
+# See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entery into _config.yml, like this:
+# plugin_loggers:
+#   JekyllPluginHooks: debug
+#
+# Jekyll::Hooks.register accepts an optional parameter:
+#   :priority determines the load order for the hook plugins.
+#     Valid values are: :lowest, :low, :normal, :high, and :highest.
+#     Highest priority matches are applied first, lowest priority are applied last.
+#     The default value is :normal
+#
+# Each hook, except the clean hook, can set a boolean flag, called `site.safe`, that informs Jekyll if this plugin may be safely executed in an environment
+# where arbitrary code execution is not allowed. This is used by GitHub Pages to determine which
+# core plugins may be used, and which are unsafe to run. If your plugin does not allow for arbitrary
+# code execution, set this to true. GitHub Pages still will not load your plugin, but if you submit it
+# for inclusion in core, it is best for this to be correct!
+# Default value is false.
+# The hooks for pages, posts and documents access safe via pages.site.safe, posts.site.safe and documents.site.safe, respectively.
+module <%= @class_name %>
+  # PLUGIN_NAME = '<%= @gem_name %>'.freeze unless defined? PLUGIN_NAME
+
+  ########## :site hooks
+  # These hooks influence the entire site
+
+  # Called just after the site resets during regeneration
+  # This is the first hook called, so you might think that this is the best place to define loggers.
+  # However, this hook will not be called unless safe mode is OFF, so define loggers in the :site :after_init hook instead
+  Jekyll::Hooks.register(:site, :after_reset, priority: :normal) do |site|
+    @log_site ||= PluginMetaLogger.instance.new_logger(:SiteHooks, PluginMetaLogger.instance.config)
+    @log_site.info { 'Jekyll::Hooks.register(:site, :after_reset) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :after_reset)', site)
+  end
+
+  # This hook is called just after the site initializes.
+  # It is a good place to modify the configuration of the site.
+  # This hook is triggered once per build / serve session.
+  Jekyll::Hooks.register(:site, :after_init, priority: :normal) do |site|
+    @log_clean = PluginMetaLogger.instance.new_logger(:CleanHook,     PluginMetaLogger.instance.config)
+    @log_docs  = PluginMetaLogger.instance.new_logger(:DocumentHooks, PluginMetaLogger.instance.config)
+    @log_pages = PluginMetaLogger.instance.new_logger(:PageHooks,     PluginMetaLogger.instance.config)
+    @log_posts = PluginMetaLogger.instance.new_logger(:PostHooks,     PluginMetaLogger.instance.config)
+    @log_site  ||= PluginMetaLogger.instance.new_logger(:SiteHooks,   PluginMetaLogger.instance.config)
+
+    @log_site.info { "Loaded #{<%= @plugin_name %>} plugin." }
+    @log_site.info { 'Jekyll::Hooks.register(:site, :after_init) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :after_init)', site)
+  end
+
+  # Called after all source files have been read and loaded from disk.
+  # This is a good hook for enriching posts;
+  # for example, adding links to author pages or adding posts to author pages.
+  Jekyll::Hooks.register(:site, :post_read, priority: :normal) do |site|
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_read) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_read)', site)
+  end
+
+  # Called before rendering the whole site
+  # This is the first hook in the site generation sequence where site['env'] has a value.
+  # Consequently, this is the first hook that defines mode (production, development or test),
+  # because it is derived from site['env']['JEKYLL_ENV']
+  # @param payload [Hash] according to the docs, payload is a hash containing the variables available during rendering; the hash can be modified here.
+  # However, the debugger shows payload has type Jekyll::UnifiedPayloadDrop
+  Jekyll::Hooks.register(:site, :pre_render, priority: :normal) do |site, payload|
+    @log_site.info { 'Jekyll::Hooks.register(:site, :pre_render) invoked.' }
+    @log_site.debug { dump(':site, :pre_render payload', payload) }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :pre_render)', site)
+    Dumpers.dump_payload(@log_site, 'Jekyll::Hooks.register(:site, :pre_render)', payload)
+  end
+
+  # Called after rendering the whole site, but before writing any files.
+  # Functionally, this hook is exactly the same as a Jekyll generator.
+  # This hook is also similar to invoking the same method on the :post_render hooks for :documents and :pages:
+  #   Jekyll::Hooks.register(:documents, :post_render, &my_method)
+  #   Jekyll::Hooks.register(:pages, :post_render, &my_method)
+  # ... with the difference that this hook will be called only once, for the entire site, so you will have to iterate over all of the
+  # :documents and :pages, whereas the :pages and :documents hooks are called once for each page and document.
+  # @param payload [Hash] contains final values of variables after rendering the entire site (useful for sitemaps, feeds, etc).
+  Jekyll::Hooks.register(:site, :post_render, priority: :normal) do |site, payload|
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_render) invoked.' }
+    @log_site.debug { dump(':site, :post_render payload', payload) }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_render)', site)
+    Dumpers.dump_payload(@log_site, 'Jekyll::Hooks.register(:site, :post_render)', payload)
+  end
+
+  # Called after writing all of the rendered files to disk
+  Jekyll::Hooks.register(:site, :post_write, priority: :normal) do |site|
+    @log_site.info { 'Jekyll::Hooks.register(:site, :post_write) invoked.' }
+    Dumpers.dump_site(@log_site, 'Jekyll::Hooks.register(:site, :post_write)', site)
+  end
+
+  ########## :pages hooks
+  # Pages are web pages that do not belong to a collection, such as posts or drafts.
+  # These hooks provide fine-grained control over all pages in the site.
+
+  # Called whenever a page is initialized
+  Jekyll::Hooks.register(:pages, :post_init, priority: :normal) do |page|
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_init) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_init)', page)
+  end
+
+  # Called just before rendering a page
+  Jekyll::Hooks.register(:pages, :pre_render, priority: :normal) do |page, payload|
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :pre_render) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :pre_render)', page)
+    Dumpers.dump_payload(@log_pages, ':pages, :pre_render payload', payload)
+  end
+
+  # Called after converting the page content, but before rendering the page layout
+  Jekyll::Hooks.register(:pages, :post_convert, priority: :normal) do |page|
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_convert) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_convert)', page)
+  end
+
+  # Called after rendering a page, but before writing it to disk
+  Jekyll::Hooks.register(:pages, :post_render, priority: :normal) do |page|
+    page.site.safe = true
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_render) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_render)', page)
+  end
+
+  # Called after writing a page to disk
+  Jekyll::Hooks.register(:pages, :post_write, priority: :normal) do |page|
+    @log_pages.info { 'Jekyll::Hooks.register(:pages, :post_write) invoked.' }
+    Dumpers.dump_page(@log_pages, 'Jekyll::Hooks.register(:pages, :post_write)', page)
+  end
+
+  ########## :documents hooks
+  # Documents are web pages that belong to a collection, for example posts, drafts and custom collections.
+  # These hooks provide fine-grained control over all documents in the site.
+  # If you want to inspect or process all collections in the same way, use these hooks.
+  # If you just want to process a custom collection, use these hooks and filter out the documents
+  # that do not belong to that collection.
+
+  # Called whenever any document is initialized.
+  # Front matter data will not have been assigned yet to documents when this hook is invoked, for example:
+  #   categories, description, last_modified_at, tags, title, and slug;
+  # other document attributes that are not yet ready when this hook is invoked include
+  # excerpt and ext (file extension).
+  # The collection attribute will be set properly for this hook.
+  Jekyll::Hooks.register(:documents, :post_init, priority: :normal) do |document|
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_init) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_init)', document)
+    'stop'
+  end
+
+  # Called just before rendering a document.
+  # Front matter data will have been assigned when this hook is invoked.
+  # Liquid variables are still embedded in the content.
+  # If the document contains markdown (or some other markup),
+  # it will not have been converted to HTML (or whatever the target format is) yet.
+  Jekyll::Hooks.register(:documents, :pre_render, priority: :normal) do |document, payload|
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :pre_render) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :pre_render)', document)
+    Dumpers.dump_payload(@log_docs, ':documents, :pre_render payload', payload)
+  end
+
+  # Called after converting the document content to HTML (or whatever),
+  # but before rendering the document using the layout.
+  Jekyll::Hooks.register(:documents, :post_convert, priority: :normal) do |document|
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_convert) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_convert)', document)
+  end
+
+  # Called after rendering a document using the layout, but before writing it to disk.
+  # This is your last chance to modify the content.
+  Jekyll::Hooks.register(:documents, :post_render, priority: :normal) do |document|
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_render) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_render)', document)
+  end
+
+  # Called after writing a document to disk.
+  # Useful for statistics regarding completed renderings.
+  Jekyll::Hooks.register(:documents, :post_write, priority: :normal) do |document|
+    @log_docs.info { 'Jekyll::Hooks.register(:documents, :post_write) invoked.' }
+    Dumpers.dump_document(@log_docs, 'Jekyll::Hooks.register(:documents, :post_write)', document)
+  end
+
+  ########## :posts hooks
+  # These hooks provide fine-grained control over all posts **and drafts** in the site without affecting
+  # documents in user-defined collections
+
+  # Called whenever any post is initialized
+  Jekyll::Hooks.register(:posts, :post_init, priority: :normal) do |post|
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_init) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_init)', post)
+  end
+
+  # Called just before rendering a post
+  Jekyll::Hooks.register(:posts, :pre_render, priority: :normal) do |post, payload|
+    # post is a Jekyll::Document
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :pre_render) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :pre_render)', post)
+    Dumpers.dump_payload(@log_posts, ':posts, :pre_render payload', payload)
+  end
+
+  # Called after converting the post content, but before rendering the post layout.
+  # This hook can be used to make edits to rendered pages,
+  # regardless of whether they were originally written in markdown or HTML.
+  #
+  # Changes must modify post.output, as shown in this example:
+  #   Jekyll::Hooks.register(:posts, :post_convert) do |post|
+  #     post.output.gsub!('programming PHP', 'banging rocks together')
+  #   end
+  Jekyll::Hooks.register(:posts, :post_convert, priority: :normal) do |post|
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_convert) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_convert)', post)
+  end
+
+  # Called after rendering a post, but before writing it to disk.
+  # Changing `post.conent` has no effect on visible output.
+  Jekyll::Hooks.register(:posts, :post_render, priority: :normal) do |post|
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_render) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_render)', post)
+  end
+
+  # Called after writing a post to disk
+  Jekyll::Hooks.register(:posts, :post_write, priority: :normal) do |post|
+    @log_posts.info { 'Jekyll::Hooks.register(:posts, :post_write) invoked.' }
+    Dumpers.dump_document(@log_posts, 'Jekyll::Hooks.register(:posts, :post_write)', post)
+  end
+
+  ########## :clean hooks
+  # These hooks provide fine-grained control on the list of obsolete files determined
+  # to be deleted during the site's cleanup phase.
+
+  # Called during the cleanup of a site's destination, before the site is built
+  Jekyll::Hooks.register(:clean, :on_obsolete, priority: :normal) do |files|
+    # files has type Array[String]
+    @log_clean.info { "Jekyll::Hooks.register(:clean, :on_obsolete) invoked for #{files}." }
+  end
+end

data/templates/jekyll/tag_no_arg_scaffold/lib/%tag_name%.rb.tt

@@ -0,0 +1,18 @@
+require 'jekyll_plugin_support'
+require_relative '<%= @gem_name %>/version.rb'
+
+module <%= @class_name %>
+  class <%= @jekyll_class_name %> < JekyllTag
+    def initialize(tag_name, argument_string, parse_context)
+      class << self
+        include NoArgParsing
+      end
+
+      super
+      @logger.debug { "#{self.class}: respond_to?(:no_arg_parsing) #{respond_to?(:no_arg_parsing) ? 'yes' : 'no'}." }
+    rescue StandardError => e
+      @logger.error { "#{self.class} died with a #{e.full_message}" }
+      exit 2
+    end
+  end
+end

data/templates/jekyll/tag_scaffold/lib/%tag_name%.rb.tt

@@ -0,0 +1,43 @@
+require 'jekyll_plugin_support'
+require_relative '<%= @gem_name %>/version.rb'
+
+# This Jekyll tag plugin is a minimal example.
+#
+# See https://www.mslinn.com/jekyll/10200-jekyll-plugin-background.html
+# See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
+#
+# @example Heading for this example
+#   {% <%= @tag_name %> param1='value1' %}
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entry into _config.yml, like this:
+# plugin_loggers:
+#   <%= @jekyll_class_name %>: debug
+module <%= class_name %>
+  # This class implements the Jekyll <%= @tag_name %> functionality
+  class <%= @jekyll_class_name %> < JekyllSupport::JekyllTag
+    PLUGIN_NAME = '<%= @tag_name %>'.freeze
+    VERSION = <%= @class_name %>::VERSION
+
+    # Put your plugin logic here.
+    # The following variables are predefined:
+    #   @argument_string, @config, @envs, @helper, @layout, @logger, @mode, @page, @paginator, @site, @tag_name and @theme
+    #
+    # @param tag_name [String] is the name of the tag, which we already know.
+    # @param argument_string [String] the arguments from the web page.
+    # @param tokens [Liquid::ParseContext] tokenized command line
+    # @return [void]
+    def render_impl
+      <%= parse_jekyll_parameters %>
+      <<~END_OUTPUT
+        <pre class="example">
+          <%= dump_jekyll_parameters %>
+          Remaining markup: '#{@helper.remaining_markup}'.
+        </pre>
+      END_OUTPUT
+    end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/templates/rails/engine_scaffold/bin/rails.tt

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/<%= gem_name %>/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup'
+
+require 'rails/all'
+require 'rails/engine/commands'
+
+load Gem.bin_path("rails", "rails")

data/templates/rails/engine_scaffold/config/routes.rb.tt

@@ -0,0 +1,6 @@
+<%- if @mountable -%>
+<%= @class_name %>::Engine.routes.draw do
+<%- else -%>
+Rails.application.routes.draw do
+<%- end -%>
+end

data/templates/rails/engine_scaffold/lib/%gem_name%/engine.rb.tt

@@ -0,0 +1,7 @@
+module <%= @class_name %>
+  class Engine < ::Rails::Engine
+  <%- if @mountable -%>
+    isolate_namespace <%= @class_name %>
+  <%- end %>
+  end
+end

data/templates/rails/engine_scaffold/test/integration/navigation_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class NavigationTest < ActionDispatch::IntegrationTest
+  # test 'the truth' do
+  #   assert true
+  # end
+end

data/templates/rails/mountable_scaffold/app/assets/javascripts/%gem_name%/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/templates/rails/mountable_scaffold/app/assets/stylesheets/%gem_name%/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/templates/rails/mountable_scaffold/app/controllers/%gem_name%/application_controller.rb.tt

@@ -0,0 +1,5 @@
+module <%= @class_name %>
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/templates/rails/mountable_scaffold/app/helpers/%gem_name%/application_helper.rb.tt

@@ -0,0 +1,4 @@
+module <%= @class_name %>
+  module ApplicationHelper
+  end
+end

data/templates/rails/mountable_scaffold/app/views/layouts/%gem_name%/application.html.erb.tt

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rplugin</title>
+  <%%= stylesheet_link_tag    "<%= @gem_name %>/application", media: "all" %>
+  <%%= javascript_include_tag "<%= @gem_name %>/application" %>
+  <%%= csrf_meta_tags %>
+</head>
+<body>
+
+<%%= yield %>
+
+</body>
+</html>

data/templates/rails/plugin_scaffold/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/templates/rails/plugin_scaffold/.simplecov.tt

@@ -0,0 +1,18 @@
+SimpleCov.start do
+  coverage_dir 'test/coverage'
+<%- if @engine -%>
+
+  load_profile 'rails'
+
+  add_group 'Controllers', 'app/controllers'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Models', 'app/models'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Libraries', 'lib'
+
+  add_filter 'db'
+  add_filter 'test'
+  add_filter 'config'
+  add_filter 'vendor'
+<%- end -%>
+end

data/templates/rails/plugin_scaffold/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 3.1.3
+before_install: gem install bundler

data/templates/rails/plugin_scaffold/test/dummy/.envrc

@@ -0,0 +1 @@
+PATH_add bin

data/templates/rails/plugin_scaffold/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/templates/rails/plugin_scaffold/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('config/application', __dir__)
+
+Rails.application.load_tasks