bridgetown-core 1.0.0.alpha1 → 1.0.0.alpha5

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

@@ -53,7 +53,7 @@ module Bridgetown
         @layout = site.layouts[data.layout].tap do |layout|
           unless layout
             Bridgetown.logger.warn "Resource:", "Layout '#{data.layout}' " \
-            "requested via #{relative_path} does not exist."
+                                                "requested via #{relative_path} does not exist."
           end
         end
       end
@@ -267,7 +267,7 @@ module Bridgetown
       # Comparison is a comparison between the 2 dates or paths of the resources.
       #
       # @return [Integer] -1, 0, or +1
-      def <=>(other) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
+      def <=>(other) # rubocop:todo Metrics/AbcSize
         return nil unless other.respond_to?(:data)
 
         cmp = if data.date.respond_to?(:to_datetime) && other.data.date.respond_to?(:to_datetime)
@@ -293,7 +293,7 @@ module Bridgetown
 
       private
 
-      def ensure_default_data
+      def ensure_default_data # rubocop:todo Metrics/AbcSize
         determine_locale
 
         slug = if matches = relative_path.to_s.match(DATE_FILENAME_MATCHER) # rubocop:disable Lint/AssignmentInCondition
@@ -337,14 +337,14 @@ module Bridgetown
         end
       end
 
-      def determine_locale
+      def determine_locale # rubocop:todo Metrics/AbcSize
         unless data.locale
           data.locale = locale_from_alt_data_or_filename.presence || site.config.default_locale
         end
 
-        if data.locale_overrides&.is_a?(Hash) && data.locale_overrides&.key?(data.locale)
-          data.merge!(data.locale_overrides[data.locale])
-        end
+        return unless data.locale_overrides.is_a?(Hash) && data.locale_overrides&.key?(data.locale)
+
+        data.merge!(data.locale_overrides[data.locale])
       end
 
       # Look for alternative front matter or look at the filename pattern: slug.locale.ext

data/lib/bridgetown-core/resource/permalink_processor.rb

@@ -46,9 +46,10 @@ module Bridgetown
         segment = segment.to_sym
         if self.class.placeholder_processors[segment]
           segment_value = self.class.placeholder_processors[segment].(resource)
-          if segment_value.is_a?(Hash)
+          case segment_value
+          when Hash
             segment_value[:raw_value]
-          elsif segment_value.is_a?(Array)
+          when Array
             segment_value.map do |subsegment|
               Utils.slugify(subsegment, mode: slugify_mode)
             end.join("/")

data/lib/bridgetown-core/resource/taxonomy_term.rb

@@ -3,11 +3,7 @@
 module Bridgetown
   module Resource
     class TaxonomyTerm
-      attr_reader :resource
-
-      attr_reader :label
-
-      attr_reader :type
+      attr_reader :resource, :label, :type
 
       def initialize(resource:, label:, type:)
         @resource = resource

data/lib/bridgetown-core/resource/transformer.rb

@@ -103,10 +103,12 @@ module Bridgetown
       end
 
       def warn_on_missing_layout(layout, layout_name)
-        if layout.nil? && layout_name
-          Bridgetown.logger.warn "Build Warning:", "Layout '#{layout_name}' " \
-          "requested via #{resource.relative_path} does not exist."
-        end
+        return unless layout.nil? && layout_name
+
+        Bridgetown.logger.warn(
+          "Build Warning:",
+          "Layout '#{layout_name}' requested via #{resource.relative_path} does not exist."
+        )
       end
 
       ### Transformation Actions
@@ -152,7 +154,7 @@ module Bridgetown
         layout_input = layout.content.dup
 
         layout_converters.inject(layout_input) do |content, converter|
-          next(content) unless [2, -2].include?(converter.method(:convert).arity)
+          next(content) unless [2, -2].include?(converter.method(:convert).arity) # rubocop:disable Performance/CollectionLiteralInLoop
 
           layout.current_document = resource
           layout.current_document_output = output

data/lib/bridgetown-core/ruby_template_view.rb

@@ -61,7 +61,6 @@ module Bridgetown
       @helpers ||= Helpers.new(self, site)
     end
 
-    # rubocop:disable Style/MissingRespondToMissing
     ruby2_keywords def method_missing(method_name, *args, &block)
       if helpers.respond_to?(method_name.to_sym)
         helpers.send method_name.to_sym, *args, &block
@@ -73,7 +72,6 @@ module Bridgetown
     def respond_to_missing?(method_name, include_private = false)
       helpers.respond_to?(method_name.to_sym, include_private) || super
     end
-    # rubocop:enable Style/MissingRespondToMissing
 
     private
 
@@ -84,7 +82,7 @@ module Bridgetown
                            ["{% render \"#{component}\""]
                          end
       unless options.empty?
-        render_statement << ", " + options.keys.map { |k| "#{k}: #{k}" }.join(", ")
+        render_statement << ", #{options.keys.map { |k| "#{k}: #{k}" }.join(", ")}"
       end
       render_statement << " %}"
       if options[:_block_content]

data/lib/bridgetown-core/static_file.rb

@@ -36,7 +36,7 @@ module Bridgetown
       @extname = File.extname(@name)
       @data = @site.frontmatter_defaults.all(relative_path, type).with_dot_access
       data.permalink ||= if collection && !collection.builtin?
-                           collection.default_permalink.chomp("/").chomp(".*") + ".*"
+                           "#{collection.default_permalink.chomp("/").chomp(".*")}.*"
                          else
                            "/:path.*"
                          end
@@ -44,9 +44,7 @@ module Bridgetown
 
     # Returns source file path.
     def path
-      @path ||= begin
-        File.join(*[@base, @dir, @name].compact)
-      end
+      @path ||= File.join(*[@base, @dir, @name].compact)
     end
 
     # Obtain destination path.
@@ -207,9 +205,9 @@ module Bridgetown
     def copy_file(dest_path)
       FileUtils.copy_entry(path, dest_path)
 
-      unless File.symlink?(dest_path)
-        File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
-      end
+      return if File.symlink?(dest_path)
+
+      File.utime(self.class.mtimes[path], self.class.mtimes[path], dest_path)
     end
   end
 end

data/lib/bridgetown-core/tags/find.rb

@@ -11,12 +11,7 @@ module Bridgetown
 
       def initialize(tag_name, markup, tokens)
         super
-        if markup.strip =~ SYNTAX
-          @new_var_name = Regexp.last_match(1).strip
-          @single_or_group = Regexp.last_match(2)
-          @arr_name = Regexp.last_match(3).strip
-          @conditions = process_conditions(Regexp.last_match(4).strip)
-        else
+        unless markup.strip =~ SYNTAX
           raise SyntaxError, <<~MSG
             Syntax Error in tag 'find' while parsing the following markup:
 
@@ -25,6 +20,11 @@ module Bridgetown
             Valid syntax: find <varname> where|in <array>, <condition(s)>
           MSG
         end
+
+        @new_var_name = Regexp.last_match(1).strip
+        @single_or_group = Regexp.last_match(2)
+        @arr_name = Regexp.last_match(3).strip
+        @conditions = process_conditions(Regexp.last_match(4).strip)
       end
 
       def render(context)

data/lib/bridgetown-core/tags/highlight.rb

@@ -14,10 +14,7 @@ module Bridgetown
 
       def initialize(tag_name, markup, tokens)
         super
-        if markup.strip =~ SYNTAX
-          @lang = Regexp.last_match(1).downcase
-          @highlight_options = parse_options(Regexp.last_match(2))
-        else
+        unless markup.strip =~ SYNTAX
           raise SyntaxError, <<~MSG
             Syntax Error in tag 'highlight' while parsing the following markup:
 
@@ -26,6 +23,9 @@ module Bridgetown
             Valid syntax: highlight <lang> [linenos]
           MSG
         end
+
+        @lang = Regexp.last_match(1).downcase
+        @highlight_options = parse_options(Regexp.last_match(2))
       end
 
       LEADING_OR_TRAILING_LINE_TERMINATORS = %r!\A(\n|\r)+|(\n|\r)+\z!.freeze
@@ -89,7 +89,7 @@ module Bridgetown
           "data-lang=\"#{@lang}\"",
         ].join(" ")
         "<figure class=\"highlight\"><pre><code #{code_attributes}>"\
-        "#{code.chomp}</code></pre></figure>"
+          "#{code.chomp}</code></pre></figure>"
       end
     end
   end

data/lib/bridgetown-core/tags/post_url.rb

@@ -74,19 +74,19 @@ module Bridgetown
 
         site.collections.posts.resources.each do |document|
           return relative_url(document) if @post == document
-        end
-
-        # New matching method did not match, fall back to old method
-        # with deprecation warning if this matches
 
-        site.collections.posts.resources.each do |document|
+          # New matching method did not match, fall back to old method
+          # with deprecation warning if this matches
           next unless @post.deprecated_equality document
 
-          Bridgetown::Deprecator.deprecation_message "A call to "\
+          Bridgetown::Deprecator.deprecation_message(
+            "A call to "\
             "'{% post_url #{@post.name} %}' did not match " \
             "a post using the new matching method of checking name " \
             "(path-date-slug) equality. Please make sure that you " \
             "change this tag to match the post's name exactly."
+          )
+
           return relative_url(document)
         end
 

data/lib/bridgetown-core/tags/render_content.rb

@@ -3,7 +3,7 @@
 module Bridgetown
   module Tags
     class BlockRenderTag < Liquid::Block
-      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       def render(context)
         context.stack({}) do
           # unindent the incoming text
@@ -37,7 +37,7 @@ module Bridgetown
             .render_tag(context, +"")
         end
       end
-      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
 
       private
 

data/lib/bridgetown-core/tasks/bridgetown_tasks.rake

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+desc "Generate a secret key for use in sessions, token generation, and beyond"
+task :secret do
+  require "securerandom"
+  puts SecureRandom.hex(64) # rubocop:disable Bridgetown/NoPutsAllowed
+end
+
 namespace :frontend do
   desc "Run frontend bundler independently"
   task :watcher, :sidecar do |_task, args|
@@ -23,7 +29,7 @@ end
 
 desc "Prerequisite task which loads site and provides automation"
 task :environment do
-  class HammerActions < Thor
+  class HammerActions < Thor # rubocop:disable Lint/ConstantDefinitionInBlock
     include Thor::Actions
     include Bridgetown::Commands::Actions
 

data/lib/bridgetown-core/url.rb

@@ -28,9 +28,9 @@ module Bridgetown
       @placeholders = options[:placeholders] || {}
       @permalink    = options[:permalink]
 
-      if (@template || @permalink).nil?
-        raise ArgumentError, "One of :template or :permalink must be supplied."
-      end
+      return unless (@template || @permalink).nil?
+
+      raise ArgumentError, "One of :template or :permalink must be supplied."
     end
 
     # The generated relative URL of the resource

data/lib/bridgetown-core/utils.rb

@@ -12,7 +12,7 @@ module Bridgetown
 
     # Constants for use in #slugify
     SLUGIFY_MODES = %w(raw default pretty simple ascii latin).freeze
-    SLUGIFY_RAW_REGEXP = Regexp.new('\\s+').freeze
+    SLUGIFY_RAW_REGEXP = Regexp.new("\\s+").freeze
     SLUGIFY_DEFAULT_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}]+").freeze
     SLUGIFY_PRETTY_REGEXP = Regexp.new("[^\\p{M}\\p{L}\\p{Nd}._~!$&'()+,;=@]+").freeze
     SLUGIFY_ASCII_REGEXP = Regexp.new("[^[A-Za-z0-9]]+").freeze
@@ -203,7 +203,7 @@ module Bridgetown
       slug = replace_character_sequence_with_hyphen(string, mode: mode)
 
       # Remove leading/trailing hyphen
-      slug.gsub!(%r!^\-|\-$!i, "")
+      slug.gsub!(%r!^-|-$!i, "")
 
       slug.downcase! unless cased
 
@@ -316,9 +316,7 @@ module Bridgetown
       lines.map do |line|
         continue_processing = !skip_pre_lines
 
-        if skip_pre_lines
-          skip_pre_lines = false if line.include?("</pre>")
-        end
+        skip_pre_lines = false if skip_pre_lines && line.include?("</pre>")
         if line.include?("<pre")
           skip_pre_lines = true
           continue_processing = false
@@ -340,7 +338,7 @@ module Bridgetown
         else
           line
         end
-      end.join("")
+      end.join
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
 
@@ -448,9 +446,9 @@ module Bridgetown
     end
 
     def merge_default_proc(target, overwrite)
-      if target.is_a?(Hash) && overwrite.is_a?(Hash) && target.default_proc.nil?
-        target.default_proc = overwrite.default_proc
-      end
+      return unless target.is_a?(Hash) && overwrite.is_a?(Hash) && target.default_proc.nil?
+
+      target.default_proc = overwrite.default_proc
     end
 
     def duplicate_frozen_values(target)

data/lib/bridgetown-core/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Bridgetown
-  VERSION = "1.0.0.alpha1"
+  VERSION = "1.0.0.alpha5"
   CODE_NAME = "Pearl"
 end

data/lib/bridgetown-core/watcher.rb

@@ -116,7 +116,7 @@ module Bridgetown
         rescue ArgumentError
           # Could not find a relative path
         end
-      end.compact + [%r!^\.bridgetown\-metadata!]
+      end.compact + [%r!^\.bridgetown-metadata!]
     end
 
     def sleep_forever
@@ -132,7 +132,7 @@ module Bridgetown
         site.plugin_manager.reload_component_loaders
         site.process
         Bridgetown.logger.info "Done! 🎉", "#{"Completed".green} in less than" \
-                               " #{(Time.now - time).ceil(2)} seconds."
+                                          " #{(Time.now - time).ceil(2)} seconds."
       rescue Exception => e
         Bridgetown.logger.error "Error:", e.message
 

data/lib/bridgetown-core.rb

@@ -249,12 +249,13 @@ end
 
 module Bridgetown
   module Model; end
+
   module Resource
     def self.register_extension(mod)
       if mod.const_defined?(:LiquidResource)
         Bridgetown::Drops::ResourceDrop.include mod.const_get(:LiquidResource)
       end
-      if mod.const_defined?(:RubyResource)
+      if mod.const_defined?(:RubyResource) # rubocop:disable Style/GuardClause
         Bridgetown::Resource::Base.include mod.const_get(:RubyResource)
       end
     end

data/lib/site_template/src/_layouts/default.liquid

@@ -1,5 +1,5 @@
 <!doctype html>
-<html lang="en">
+<html lang="{{ site.locale }}">
   <head>
     {% render "head", metadata: site.metadata, title: page.title %}
   </head>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha1
+  version: 1.0.0.alpha5
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-16 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -340,6 +340,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - ".yardopts"
 - Rakefile
 - bin/bridgetown
@@ -475,7 +476,6 @@ files:
 - lib/bridgetown-core/tags/class_map.rb
 - lib/bridgetown-core/tags/find.rb
 - lib/bridgetown-core/tags/highlight.rb
-- lib/bridgetown-core/tags/include.rb
 - lib/bridgetown-core/tags/link.rb
 - lib/bridgetown-core/tags/live_reload_dev_js.rb
 - lib/bridgetown-core/tags/post_url.rb

data/lib/bridgetown-core/tags/include.rb

@@ -1,213 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Tags
-    class IncludeTag < Liquid::Tag
-      class << self
-        attr_accessor :deprecation_message_shown
-      end
-
-      VALID_SYNTAX = %r!
-        ([\w-]+)\s*=\s*
-        (?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|([\w\.-]+))
-      !x.freeze
-      VARIABLE_SYNTAX = %r!
-        (?<variable>[^{]*(\{\{\s*[\w\-\.]+\s*(\|.*)?\}\}[^\s{}]*)+)
-        (?<params>.*)
-      !mx.freeze
-
-      FULL_VALID_SYNTAX = %r!\A\s*(?:#{VALID_SYNTAX}(?=\s|\z)\s*)*\z!.freeze
-      VALID_FILENAME_CHARS = %r!^[\w/\.-]+$!.freeze
-      INVALID_SEQUENCES = %r![./]{2,}!.freeze
-
-      def initialize(tag_name, markup, tokens)
-        super
-
-        unless self.class.deprecation_message_shown
-          Bridgetown.logger.warn "NOTICE: the {% include %} tag is deprecated and" \
-                                 " will be removed in Bridgetown 1.0. You should" \
-                                 " use the {% render %} tag instead."
-          self.class.deprecation_message_shown = true
-        end
-
-        matched = markup.strip.match(VARIABLE_SYNTAX)
-        if matched
-          @file = matched["variable"].strip
-          @params = matched["params"].strip
-        else
-          @file, @params = markup.strip.split(%r!\s+!, 2)
-        end
-        validate_params if @params
-        @tag_name = tag_name
-      end
-
-      def syntax_example
-        "{% #{@tag_name} file.ext param='value' param2='value' %}"
-      end
-
-      def parse_params(context)
-        params = {}
-        markup = @params
-
-        while (match = VALID_SYNTAX.match(markup))
-          markup = markup[match.end(0)..-1]
-
-          value = if match[2]
-                    match[2].gsub('\\"', '"')
-                  elsif match[3]
-                    match[3].gsub("\\'", "'")
-                  elsif match[4]
-                    context[match[4]]
-                  end
-
-          params[match[1]] = value
-        end
-        params
-      end
-
-      def validate_file_name(file)
-        if INVALID_SEQUENCES.match?(file) || !VALID_FILENAME_CHARS.match?(file)
-          raise ArgumentError, <<~MSG
-            Invalid syntax for include tag. File contains invalid characters or sequences:
-
-              #{file}
-
-            Valid syntax:
-
-              #{syntax_example}
-
-          MSG
-        end
-      end
-
-      def validate_params
-        unless FULL_VALID_SYNTAX.match?(@params)
-          raise ArgumentError, <<~MSG
-            Invalid syntax for include tag:
-
-            #{@params}
-
-            Valid syntax:
-
-            #{syntax_example}
-
-          MSG
-        end
-      end
-
-      # Grab file read opts in the context
-      def file_read_opts(context)
-        context.registers[:site].file_read_opts
-      end
-
-      # Render the variable if required
-      def render_variable(context)
-        Liquid::Template.parse(@file).render(context) if VARIABLE_SYNTAX.match?(@file)
-      end
-
-      def tag_includes_dirs(context)
-        context.registers[:site].includes_load_paths.freeze
-      end
-
-      def locate_include_file(context, file)
-        includes_dirs = tag_includes_dirs(context)
-        includes_dirs.each do |dir|
-          path = File.join(dir, file)
-          return path if valid_include_file?(path, dir.to_s)
-        end
-        raise IOError, could_not_locate_message(file, includes_dirs)
-      end
-
-      def render(context)
-        file = render_variable(context) || @file
-        validate_file_name(file)
-
-        path = locate_include_file(context, file)
-        return unless path
-
-        partial = load_cached_partial(path, context)
-
-        context.stack do
-          context["include"] = parse_params(context) if @params
-          begin
-            partial.render!(context)
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def load_cached_partial(path, context)
-        context.registers[:cached_partials] ||= {}
-        cached_partial = context.registers[:cached_partials]
-
-        if cached_partial.key?(path)
-          cached_partial[path]
-        else
-          unparsed_file = context.registers[:site]
-            .liquid_renderer
-            .file(path)
-          begin
-            cached_partial[path] = unparsed_file.parse(read_file(path, context))
-          rescue Liquid::Error => e
-            e.template_name = path
-            e.markup_context = "included " if e.markup_context.nil?
-            raise e
-          end
-        end
-      end
-
-      def valid_include_file?(path, _dir)
-        File.file?(path)
-      end
-
-      def realpath_prefixed_with?(path, dir)
-        File.exist?(path) && File.realpath(path).start_with?(dir)
-      rescue StandardError
-        false
-      end
-
-      # This method allows to modify the file content by inheriting from the class.
-      def read_file(file, context)
-        File.read(file, **file_read_opts(context))
-      end
-
-      private
-
-      def could_not_locate_message(file, includes_dirs)
-        "Could not locate the included file '#{file}' in any of #{includes_dirs}." \
-          " Ensure it exists in one of those directories."
-      end
-    end
-
-    class IncludeRelativeTag < IncludeTag
-      def tag_includes_dirs(context)
-        Array(page_path(context)).freeze
-      end
-
-      def page_path(context)
-        if context.registers[:page].nil?
-          context.registers[:site].source
-        else
-          site = context.registers[:site]
-          page_payload = context.registers[:page]
-          resource_path = \
-            if page_payload["collection"].nil?
-              page_payload["path"]
-            else
-              File.join(site.config["collections_dir"], page_payload["path"])
-            end
-          # rubocop:disable Performance/DeleteSuffix
-          resource_path.sub!(%r!/#excerpt\z!, "")
-          # rubocop:enable Performance/DeleteSuffix
-          site.in_source_dir File.dirname(resource_path)
-        end
-      end
-    end
-  end
-end
-
-Liquid::Template.register_tag("include", Bridgetown::Tags::IncludeTag)
-Liquid::Template.register_tag("include_relative", Bridgetown::Tags::IncludeRelativeTag)