jekyll/jekyll-assets

View on GitHub
lib/jekyll/assets/env.rb

Summary

Maintainability
A
1 hr
Test Coverage
# Frozen-string-literal: true
# Copyright: 2012 - 2020 - ISC License
# Encoding: utf-8

require_relative 'reader'

dir = Pathutil.new(__dir__)
dir.join('compressors').children.map(
  &method(
    :require
  )
)

module Jekyll
  module Assets
    class Env < Sprockets::Environment
      extend Forwardable::Extended
      include Utils

      # --
      attr_reader :manifest
      attr_accessor :assets_to_write
      attr_reader :asset_config
      attr_reader :jekyll

      # --
      def initialize(jekyll)
        @asset_config = Config.new(jekyll.config['assets'] ||= {})
        Hook.trigger :env, :before_init do |h|
          instance_eval(&h)
        end

        super()
        @jekyll = jekyll
        @assets_to_write = []
        @manifest = Manifest.new(self, in_dest_dir)
        @jekyll.sprockets = self
        @total_time = 0.000000
        @logger = Logger
        @cache = nil

        setup_sources!
        setup_digesting!
        ignore_caches!
        precompile!

        Hook.trigger :env, :after_init do |h|
          instance_eval(&h)
        end
      end

      # --
      def skip_gzip?
        !asset_config[:gzip]
      end

      # --
      def find_asset(asset, *args)
        msg = "Searched for, and rendered #{asset} in %<time>s"
        out = Logger.with_timed_logging msg do
          super(asset, *args)
        end

        # We keep track.
        @total_time += out[:time]
        out[:result]
      end

      # --
      def find_asset!(asset, *args)
        msg = "Searched for, and rendered #{asset} in %<time>s"
        out = Logger.with_timed_logging msg do
          super(asset, *args)
        end

        # We keep track.
        @total_time += out[:time]
        out[:result]
      end

      # --
      # @note this is configurable with :caching -> :type
      # Create a cache, or a null cache (if no caching) for caching.
      # @note this is configurable with :caching -> :enabled
      # @return [Jekyll::Assets::Cache]
      # --
      def cache
        @cache ||= Cache.new(
          manifest: manifest,
          config: asset_config,
          dir: in_cache_dir
        )
      end

      # --
      # @note this does not find the asset.
      # Takes all user assets and turns them into a drop.
      # @return [Hash]
      # --
      def to_liquid_payload
        each_file&.each_with_object({}) do |k, h|
          skip, path = false, Pathutil.new(strip_paths(k))
          path.descend do |p|
            skip = p.start_with?('_')
            if skip
              break
            end
          end

          next if skip
          h[path.to_s] = Drop.new(path,
            jekyll: jekyll
          )
        end
      end

      # --
      def write_all
        remove_old_assets unless asset_config[:digest]
        manifest.compile(*assets_to_write)
        @asset_to_write = []
        copy_raw!

        Hook.trigger(:env, :after_write) { |h| instance_eval(&h) }
        Logger.debug "took #{format(@total_time.round(2).to_s,
          '%.2f')}s"
      end

      # ---
      def remove_old_assets
        assets_to_write.each do |path|
          asset = find_asset!(path)
          lpath = asset.logical_path
          in_dest_dir(lpath).rm_f
        end
      end

      # --
      private
      def ignore_caches!
        jekyll.config['exclude'] ||= []
        jekyll.config['exclude'].push(asset_config[:caching][:path])
        jekyll.config['exclude'].uniq!
      end

      # --
      def copy_raw!
        raw_precompiles.map do |v|
          v[:full_destination].parent.mkdir_p
          unless v[:source].directory?
            v[:source].cp(
              v.fetch(
                :full_destination
              )
            )
          end
        end
      end

      # --
      private
      def precompile!
        assets = asset_config[:precompile]
        assets.map do |v|
          v !~ %r!\*! ? @assets_to_write |= [v] : glob_paths(v).each do |sv|
            @assets_to_write |= [sv]
          end
        end

        nil
      end

      def setup_digesting!
        self.digest_class = \
          case asset_config[:digest_algorithm]
          when :sha256 then  Digest::SHA256
          when :sha384 then  Digest::SHA384
          when :sha512 then  Digest::SHA512
          else
            raise 'Unknown digest_algorithm given'
          end
      end

      # --
      private
      def setup_sources!
        source_dir, cwd = Pathutil.new(jekyll.in_source_dir), Pathutil.cwd
        asset_config['sources'].each do |v|
          path = source_dir.join(v).expand_path
          next unless path.in_path?(cwd)
          unless paths.include?(path)
            append_path path
          end
        end

        paths
      end

      require_relative 'plugins'
      require_relative 'context'
    end
  end
end