bridgetown-core 1.0.0.alpha1 → 1.0.0.alpha5

data/lib/bridgetown-core/concerns/site/extensible.rb

@@ -40,10 +40,9 @@ class Bridgetown::Site
     #   instance implementing the given `Converter` class.
     def find_converter_instance(klass)
       @find_converter_instance ||= {}
-      @find_converter_instance[klass] ||= begin
-        converters.find { |converter| converter.instance_of?(klass) } || \
-          raise("No Converters found for #{klass}")
-      end
+      @find_converter_instance[klass] ||= converters.find do |converter|
+        converter.instance_of?(klass)
+      end || raise("No Converters found for #{klass}")
     end
 
     # Create an array of instances of the subclasses of the class

data/lib/bridgetown-core/concerns/site/localizable.rb

@@ -7,7 +7,7 @@ class Bridgetown::Site
     def locale
       @locale ||= begin
         locale = ENV.fetch("BRIDGETOWN_LOCALE", config[:default_locale]).to_sym
-        Dir[in_source_dir("_locales") + "/*.yml"].each do |locale_path|
+        Dir["#{in_source_dir("_locales")}/*.yml"].each do |locale_path|
           I18n.load_path << locale_path
         end
         I18n.available_locales = config[:available_locales]

data/lib/bridgetown-core/concerns/site/ssr.rb

@@ -8,7 +8,7 @@ class Bridgetown::Site
 
     module ClassMethods
       # Establish an SSR pipeline for a persistent backend process
-      def start_ssr!
+      def start_ssr! # rubocop:todo Metrics/AbcSize
         if Bridgetown::Current.site
           raise Bridgetown::Errors::FatalException, "Bridgetown SSR already started! " \
                                                     "Check your Rack app for threading issues"

data/lib/bridgetown-core/concerns/site/writable.rb

@@ -25,7 +25,7 @@ class Bridgetown::Site
     # @return [void]
     def each_site_file
       %w(generated_pages static_files_to_write resources_to_write).each do |type|
-        send(type).each do |item|
+        send(type).each do |item| # rubocop:disable Style/ExplicitBlockArgument
           yield item
         end
       end

data/lib/bridgetown-core/configuration.rb

@@ -20,7 +20,6 @@ module Bridgetown
       "layouts_dir"          => "_layouts",
       "data_dir"             => "_data",
       "components_dir"       => "_components",
-      "includes_dir"         => "_includes",
       "partials_dir"         => "_partials",
       "collections"          => {},
       "taxonomies"           => {
@@ -203,7 +202,7 @@ module Bridgetown
         end
       rescue ArgumentError => e
         Bridgetown.logger.warn "WARNING:", "Error reading configuration. Using defaults" \
-                                " (and options)."
+                                           " (and options)."
         warn e
       end
 

data/lib/bridgetown-core/converter.rb

@@ -20,6 +20,7 @@ module Bridgetown
     #
     # Returns an initialized Converter.
     def initialize(config = {})
+      super
       @config = config
     end
 

data/lib/bridgetown-core/converters/erb_templates.rb

@@ -38,7 +38,7 @@ module Bridgetown
       return if text.empty?
 
       src << bufvar << ".safe_append='"
-      src << text.gsub(%r{['\\]}, '\\\\\&')
+      src << text.gsub(%r{['\\]}, '\\\\\&') # rubocop:disable Style/StringLiterals
       src << "'.freeze;"
     end
 
@@ -110,7 +110,7 @@ module Bridgetown
       #
       # @return [String] The converted content.
       def convert(content, convertible)
-        return content if convertible.data[:template_engine] != "erb"
+        return content if convertible.data[:template_engine].to_s != "erb"
 
         erb_view = Bridgetown::ERBView.new(convertible)
 
@@ -131,10 +131,12 @@ module Bridgetown
         end
       end
 
+      # @param ext [String]
+      # @param convertible [Bridgetown::Resource::Base, Bridgetown::GeneratedPage]
       def matches(ext, convertible)
-        if convertible.data[:template_engine] == "erb" ||
+        if convertible.data[:template_engine].to_s == "erb" ||
             (convertible.data[:template_engine].nil? &&
-              @config[:template_engine] == "erb")
+             @config[:template_engine].to_s == "erb")
           convertible.data[:template_engine] = "erb"
           return true
         end

data/lib/bridgetown-core/converters/liquid_templates.rb

@@ -56,6 +56,8 @@ module Bridgetown
       # rubocop: enable Metrics/MethodLength
       # rubocop: enable Metrics/AbcSize
 
+      # @param ext [String]
+      # @param convertible [Bridgetown::Resource::Base, Bridgetown::GeneratedPage]
       def matches(ext, convertible)
         if convertible.render_with_liquid?
           convertible.data[:template_engine] = "liquid"

data/lib/bridgetown-core/converters/markdown/kramdown_parser.rb

@@ -44,7 +44,7 @@ module Kramdown
       end
     end
 
-    def initialize(source, options = {})
+    def initialize(source, options = {}) # rubocop:disable Lint/MissingSuper
       BridgetownDocument.setup(options)
 
       @options = BridgetownDocument.options

data/lib/bridgetown-core/converters/smartypants.rb

@@ -25,6 +25,7 @@ module Bridgetown
       priority :low
 
       def initialize(config)
+        super
         unless defined?(Kramdown)
           Bridgetown::Utils::RequireGems.require_with_graceful_fail "kramdown"
         end

data/lib/bridgetown-core/drops/drop.rb

@@ -28,7 +28,7 @@ module Bridgetown
       # drop.
       #
       # Returns nothing
-      def initialize(obj)
+      def initialize(obj) # rubocop:disable Lint/MissingSuper
         @obj = obj
       end
 
@@ -69,11 +69,11 @@ module Bridgetown
         if respond_to?(setter)
           public_send(setter, val)
         elsif respond_to?(key.to_s)
-          if self.class.mutable?
-            mutations[key] = val
-          else
+          unless self.class.mutable?
             raise Errors::DropMutationException, "Key #{key} cannot be set in the drop."
           end
+
+          mutations[key] = val
         else
           fallback_data[key] = val
         end

data/lib/bridgetown-core/entry_filter.rb

@@ -3,6 +3,7 @@
 module Bridgetown
   class EntryFilter
     attr_reader :site
+
     SPECIAL_LEADING_CHAR_REGEX = %r!\A#{Regexp.union([".", "_", "#", "~"])}!o.freeze
     SPECIAL_LEADING_CHAR_NO_UNDERSCORES_REGEX = %r!\A#{Regexp.union([".", "#", "~"])}!o.freeze
 

data/lib/bridgetown-core/filters/url_filters.rb

@@ -49,7 +49,7 @@ module Bridgetown
 
       private
 
-      def compute_absolute_url(input) # rubocop:todo Metrics/CyclomaticComplexity
+      def compute_absolute_url(input)
         return if input.nil?
         return input.absolute_url if input.respond_to?(:absolute_url)
 

data/lib/bridgetown-core/filters.rb

@@ -104,7 +104,7 @@ module Bridgetown
     def obfuscate_link(input, prefix = "mailto")
       link = "<a href=\"#{prefix}:#{input}\">#{input}</a>"
       script = "<script type=\"text/javascript\">document.currentScript.insertAdjacentHTML('"
-      script += "beforebegin', '#{rot47(link).gsub(%r!\\!, '\\\\\\')}'.replace(/[!-~]/g,"
+      script += "beforebegin', '#{rot47(link).gsub(%r!\\!, '\\\\\\')}'.replace(/[!-~]/g," # rubocop:disable Style/StringLiteralsInInterpolation
       script += "function(c){{var j=c.charCodeAt(0);if((j>=33)&&(j<=126)){"
       script += "return String.fromCharCode(33+((j+ 14)%94));}"
       script += "else{return String.fromCharCode(j);}}}));</script>"
@@ -180,7 +180,7 @@ module Bridgetown
     #            their `#inspect` string object.
     #
     # Returns the filtered array of objects
-    def where(input, property, value)
+    def where(input, property, value) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       return input if !property || value.is_a?(Array) || value.is_a?(Hash)
       return input unless input.respond_to?(:select)
 
@@ -194,11 +194,9 @@ module Bridgetown
       @where_filter_cache[input_id][property] ||= {}
 
       # stash or retrive results to return
-      @where_filter_cache[input_id][property][value] ||= begin
-        input.select do |object|
-          compare_property_vs_target(item_property(object, property), value)
-        end.to_a
-      end
+      @where_filter_cache[input_id][property][value] ||= input.select do |object|
+        compare_property_vs_target(item_property(object, property), value)
+      end.to_a
     end
 
     # Filters an array of objects against an expression
@@ -247,13 +245,14 @@ module Bridgetown
       if property.nil?
         input.sort
       else
-        if nils == "first"
+        case nils
+        when "first"
           order = - 1
-        elsif nils == "last"
+        when "last"
           order = + 1
         else
           raise ArgumentError, "Invalid nils order: " \
-            "'#{nils}' is not a valid nils order. It must be 'first' or 'last'."
+                               "'#{nils}' is not a valid nils order. It must be 'first' or 'last'."
         end
 
         sort_input(input, property, order)
@@ -327,7 +326,7 @@ module Bridgetown
     # If the property doesn't exist, return the sort order respective of
     # which item doesn't have the property.
     # We also utilize the Schwartzian transform to make this more efficient.
-    def sort_input(input, property, order)
+    def sort_input(input, property, order) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       input.map { |item| [item_property(item, property), item] }
         .sort! do |a_info, b_info|
           a_property = a_info.first
@@ -413,7 +412,7 @@ module Bridgetown
       case item
       when Hash
         pairs = item.map { |k, v| as_liquid([k, v]) }
-        Hash[pairs]
+        Hash[pairs] # rubocop:todo Style/HashConversion
       when Array
         item.map { |i| as_liquid(i) }
       else

data/lib/bridgetown-core/frontmatter_defaults.rb

@@ -166,10 +166,8 @@ module Bridgetown
     def matching_sets(path, collection)
       @matched_set_cache ||= {}
       @matched_set_cache[path] ||= {}
-      @matched_set_cache[path][collection] ||= begin
-        valid_sets.select do |set|
-          !set.key?("scope") || applies?(set["scope"], path, collection)
-        end
+      @matched_set_cache[path][collection] ||= valid_sets.select do |set|
+        !set.key?("scope") || applies?(set["scope"], path, collection)
       end
     end
 
@@ -200,9 +198,9 @@ module Bridgetown
     def massage_scope!(set)
       set["scope"] ||= {}
       set["scope"]["path"] ||= ""
-      if set["scope"]["type"] && !set["scope"]["collection"]
-        set["scope"]["collection"] = set["scope"]["type"]
-      end
+      return unless set["scope"]["type"] && !set["scope"]["collection"]
+
+      set["scope"]["collection"] = set["scope"]["type"]
     end
 
     SANITIZATION_REGEX = %r!\A/|(?<=[^/])\z!.freeze

data/lib/bridgetown-core/generated_page.rb

@@ -7,9 +7,7 @@ module Bridgetown
     include Publishable
 
     attr_writer :dir
-    attr_accessor :site, :paginator
-    attr_accessor :name, :ext, :basename
-    attr_accessor :data, :content, :output
+    attr_accessor :site, :paginator, :name, :ext, :basename, :data, :content, :output
 
     alias_method :extname, :ext
 

data/lib/bridgetown-core/generators/prototype_generator.rb

@@ -44,31 +44,31 @@ module Bridgetown
         page_list.include?(page)
       end
 
-      if prototype_pages.length.positive?
-        ensure_pagination_enabled
+      return unless prototype_pages.length.positive?
 
-        page_list.reject! do |page|
-          prototype_pages.include? page
-        end
+      ensure_pagination_enabled
+
+      page_list.reject! do |page|
+        prototype_pages.include? page
+      end
 
-        prototype_pages.each do |prototype_page|
-          search_term = validate_search_term(prototype_page)
-          next if search_term.nil?
+      prototype_pages.each do |prototype_page|
+        search_term = validate_search_term(prototype_page)
+        next if search_term.nil?
 
-          terms_matching_pages(search_term).each do |term|
-            generate_new_page_from_prototype(prototype_page, search_term, term)
-          end
+        terms_matching_pages(search_term).each do |term|
+          generate_new_page_from_prototype(prototype_page, search_term, term)
         end
       end
     end
 
     def ensure_pagination_enabled
-      unless @site.config.dig(:pagination, :enabled)
-        Bridgetown.logger.warn(
-          "Pagination:",
-          "Must be enabled for prototype pages to contain matches"
-        )
-      end
+      return if @site.config.dig(:pagination, :enabled)
+
+      Bridgetown.logger.warn(
+        "Pagination:",
+        "Must be enabled for prototype pages to contain matches"
+      )
     end
 
     # Check incoming prototype configuration and normalize options.
@@ -125,7 +125,7 @@ module Bridgetown
     # @param collection [Bridgetown::Collection]
     # @param search_term [String]
     # @param term [String]
-    def initialize(prototyped_page, collection, search_term, term)
+    def initialize(prototyped_page, collection, search_term, term) # rubocop:disable Lint/MissingSuper
       @prototyped_page = prototyped_page
       @site = prototyped_page.site
       @url = ""
@@ -160,22 +160,21 @@ module Bridgetown
       slugify_term(term)
     end
 
-    # rubocop:todo Metrics/AbcSize
-    def process_title_data_placeholder(search_term, term)
-      if prototyped_page.data["prototype"]["data"]
-        if data["title"]&.include?(":prototype-data-label")
-          related_data = site.data[prototyped_page.data["prototype"]["data"]].dig(term)
-          if related_data
-            data["#{search_term}_data"] = related_data
-            data_label = related_data[prototyped_page.data["prototype"]["data_label"]]
-            data["title"] = data["title"].gsub(
-              ":prototype-data-label", data_label
-            )
-          end
-        end
+    def process_title_data_placeholder(search_term, term) # rubocop:todo Metrics/AbcSize
+      unless prototyped_page.data["prototype"]["data"] &&
+          data["title"]&.include?(":prototype-data-label")
+        return
       end
+
+      related_data = site.data[prototyped_page.data["prototype"]["data"]][term]
+      return unless related_data
+
+      data["#{search_term}_data"] = related_data
+      data_label = related_data[prototyped_page.data["prototype"]["data_label"]]
+      data["title"] = data["title"].gsub(
+        ":prototype-data-label", data_label
+      )
     end
-    # rubocop:enable Metrics/AbcSize
 
     def process_title_simple_placeholders(term)
       if data["title"]&.include?(":prototype-term-titleize")
@@ -184,11 +183,11 @@ module Bridgetown
         )
       end
 
-      if data["title"]&.include?(":prototype-term")
-        data["title"] = data["title"].gsub(
-          ":prototype-term", term
-        )
-      end
+      return unless data["title"]&.include?(":prototype-term")
+
+      data["title"] = data["title"].gsub(
+        ":prototype-term", term
+      )
     end
 
     def slugify_term(term)

data/lib/bridgetown-core/helpers.rb

@@ -56,7 +56,7 @@ module Bridgetown
       #   `url` or `relative_url`
       # @return [String] the permalink URL for the file
       def url_for(relative_path)
-        if relative_path.respond_to?(:relative_url)
+        if relative_path.respond_to?(:relative_url) # rubocop:disable Style/GuardClause
           return safe(relative_path.relative_url) # new resource engine
         elsif relative_path.respond_to?(:url)
           return safe(relative_url(relative_path.url)) # old legacy engine

data/lib/bridgetown-core/hooks.rb

@@ -72,14 +72,14 @@ module Bridgetown
       @registry[owner].delete_if { |item| item.block == block }
     end
 
-    def self.trigger(owner, event, *args)
+    def self.trigger(owner, event, *args) # rubocop:disable Metrics/CyclomaticComplexity
       # proceed only if there are hooks to call
       hooks = @registry[owner]&.select { |item| item.event == event }
       return if hooks.nil? || hooks.empty?
 
       prioritized_hooks(hooks).each do |hook|
         if ENV["BRIDGETOWN_LOG_LEVEL"] == "debug"
-          hook_info = args[0]&.respond_to?(:url) ? args[0].relative_path : hook.block
+          hook_info = args[0].respond_to?(:url) ? args[0].relative_path : hook.block
           Bridgetown.logger.debug("Triggering hook:", "#{owner}:#{event} for #{hook_info}")
         end
         hook.block.call(*args)

data/lib/bridgetown-core/liquid_renderer.rb

@@ -68,9 +68,7 @@ module Bridgetown
     private
 
     def filename_regex
-      @filename_regex ||= begin
-        %r!\A(#{Regexp.escape(source_dir)}/|/*)(.*)!i
-      end
+      @filename_regex ||= %r!\A(#{Regexp.escape(source_dir)}/|/*)(.*)!i
     end
 
     def new_profile_hash

data/lib/bridgetown-core/log_adapter.rb

@@ -120,7 +120,7 @@ module Bridgetown
     # colon -
     #
     # Returns the formatted topic statement
-    def formatted_topic(topic, colon = false)
+    def formatted_topic(topic, colon = false) # rubocop:disable Style/OptionalBooleanParameter
       "#{topic}#{colon ? ": " : " "}".rjust(20)
     end
 

data/lib/bridgetown-core/log_writer.rb

@@ -2,7 +2,7 @@
 
 module Bridgetown
   class LogWriter < ::Logger
-    def initialize
+    def initialize # rubocop:disable Lint/MissingSuper
       @progname = nil
       @level = DEBUG
       @default_formatter = Formatter.new

data/lib/bridgetown-core/model/base.rb

@@ -122,7 +122,7 @@ module Bridgetown
         attributes.key?(method_name) || method_name.to_s.end_with?("=") || super
       end
 
-      def method_missing(method_name, *args) # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method_name, *args)
         return attributes[method_name] if attributes.key?(method_name)
 
         key = method_name.to_s
@@ -134,7 +134,7 @@ module Bridgetown
         end
 
         Bridgetown.logger.warn "key `#{method_name}' not found in attributes for" \
-                               " #{attributes[:id].presence || ("new " + self.class.to_s)}"
+                               " #{attributes[:id].presence || "new #{self.class}"}"
         nil
       end
 

data/lib/bridgetown-core/model/builder_origin.rb

@@ -15,7 +15,7 @@ module Bridgetown
       end
 
       def initialize(id)
-        self.id = id
+        super
         @relative_path = Pathname.new(url.path.delete_prefix("/"))
       end
 
@@ -38,9 +38,9 @@ module Bridgetown
 
       def read_data_from_builder
         builder = Kernel.const_get(url.host.gsub(".", "::"))
-        raise NameError unless builder.respond_to?(:resource_data_for_id)
+        raise NameError unless builder.instance_methods.include?(:resource_data_for_id)
 
-        builder.resource_data_for_id(id)
+        builder.new.resource_data_for_id(id) || raise(NameError)
       rescue NameError
         raise(
           Bridgetown::Errors::FatalException,

data/lib/bridgetown-core/model/plugin_origin.rb

@@ -14,7 +14,7 @@ module Bridgetown
           manifest_origin = Addressable::URI.unescape(url.path.delete_prefix("/")).split("/").first
           Bridgetown::PluginManager.source_manifests.find do |manifest|
             manifest.origin.to_s == manifest_origin
-          end.tap do |manifest| # rubocop:disable Style/MultilineBlockChain
+          end.tap do |manifest|
             raise "Unable to locate a source manifest for #{manifest_origin}" unless manifest
           end
         end

data/lib/bridgetown-core/plugin_manager.rb

@@ -104,7 +104,7 @@ module Bridgetown
 
       # check matching version number is see if it's already installed
       if package_json["dependencies"]
-        current_version = package_json["dependencies"].dig(yarn_dependency.first)
+        current_version = package_json["dependencies"][yarn_dependency.first]
         package_requires_updating?(current_version, yarn_dependency.last)
       else
         true
@@ -112,7 +112,7 @@ module Bridgetown
     end
 
     def self.package_requires_updating?(current_version, dep_version)
-      current_version.nil? || current_version != dep_version && !current_version.include?("/")
+      current_version.nil? || (current_version != dep_version && !current_version.include?("/"))
     end
 
     # Require all .rb files

data/lib/bridgetown-core/publisher.rb

@@ -15,7 +15,7 @@ module Bridgetown
       return false unless thing.respond_to?(:date)
 
       future_allowed =
-        thing.respond_to?(:collection) && thing.collection.metadata.future || @site.config.future
+        (thing.respond_to?(:collection) && thing.collection.metadata.future) || @site.config.future
       thing_time = thing.date.is_a?(Date) ? thing.date.to_time.to_i : thing.date.to_i
       !future_allowed && thing_time > @site.time.to_i
     end

data/lib/bridgetown-core/rack/boot.rb

@@ -17,6 +17,14 @@ module Bridgetown
     def self.boot
       autoload_server_folder(root: Dir.pwd)
       RodaApp.opts[:bridgetown_preloaded_config] = Bridgetown::Current.preloaded_configuration
+    rescue Roda::RodaError => e
+      if e.message.include?("sessions plugin :secret option")
+        raise Bridgetown::Errors::InvalidConfigurationError,
+              "The Roda sessions plugin can't find a valid secret. Run `bin/bridgetown secret'" \
+              " and put the key in a ENV var you can use to configure the session in `roda_app.rb'"
+      end
+
+      raise e
     end
 
     def self.autoload_server_folder(root:)

data/lib/bridgetown-core/rack/routes.rb

@@ -4,7 +4,7 @@ module Bridgetown
   module Rack
     class Routes
       class << self
-        attr_accessor :tracked_subclasses
+        attr_accessor :tracked_subclasses, :router_block
 
         def inherited(base)
           Bridgetown::Rack::Routes.track_subclass base
@@ -24,8 +24,6 @@ module Bridgetown
           end
         end
 
-        attr_accessor :router_block
-
         def route(&block)
           self.router_block = block
         end
@@ -74,7 +72,6 @@ module Bridgetown
         instance_exec(@_roda_app.request, &self.class.router_block)
       end
 
-      # rubocop:disable Style/MissingRespondToMissing
       ruby2_keywords def method_missing(method_name, *args, &block)
         if @_roda_app.respond_to?(method_name.to_sym)
           @_roda_app.send method_name.to_sym, *args, &block
@@ -86,7 +83,6 @@ module Bridgetown
       def respond_to_missing?(method_name, include_private = false)
         @_roda_app.respond_to?(method_name.to_sym, include_private) || super
       end
-      # rubocop:enable Style/MissingRespondToMissing
     end
   end
 end

data/lib/bridgetown-core/rack/static_indexes.rb

@@ -3,8 +3,8 @@
 require "roda/plugins/public"
 
 Roda::RodaPlugins::Public::RequestMethods.module_eval do
-  SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
-  def public_path_segments(path) # rubocop:disable Metrics/CyclomaticComplexity
+  SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact) # rubocop:disable Lint/ConstantDefinitionInBlock
+  def public_path_segments(path) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
     segments = []
 
     path.split(SPLIT).each do |seg|

data/lib/bridgetown-core/readers/layout_reader.rb

@@ -47,10 +47,10 @@ module Bridgetown
       Layout.label_for_file(file)
     end
 
-    def within(directory)
+    def within(directory, &block)
       return unless File.exist?(directory)
 
-      Dir.chdir(directory) { yield }
+      Dir.chdir(directory, &block)
     end
   end
 end

data/lib/bridgetown-core/renderer.rb

@@ -119,7 +119,7 @@ module Bridgetown
         !(document.is_a? Bridgetown::Excerpt)
 
       Bridgetown.logger.warn "Build Warning:", "Layout '#{document.data["layout"]}' requested " \
-        "in #{document.relative_path} does not exist."
+                                               "in #{document.relative_path} does not exist."
     end
 
     # Render layout content into document.output