jekyll_picture_tag 1.10.2 → 2.0.0pre1

data/lib/jekyll_picture_tag/instructions/configuration.rb

@@ -1,121 +0,0 @@
-module PictureTag
-  module Instructions
-    # Global config (big picture). loads jekyll data/config files, and the j-p-t
-    # defaults from included yml files.
-    class Configuration
-      # returns jekyll's configuration (picture is a subset)
-      def [](key)
-        content[key]
-      end
-
-      # picturetag specific configuration
-      def pconfig
-        content['picture']
-      end
-
-      # Digs into jekyll context, returns current environment
-      def jekyll_env
-        # It would be really great if the jekyll devs actually documented
-        # the context object.
-        PictureTag.context.environments.first['jekyll']['environment']
-      end
-
-      # Site.source is the master jekyll source directory
-      # Source dir is the jekyll-picture-tag source directory.
-      def source_dir
-        File.join PictureTag.site.source, pconfig['source']
-      end
-
-      # site.dest is the master jekyll destination directory
-      # source_dest is the jekyll-picture-tag destination directory. (generated
-      # file location setting.)
-      def dest_dir
-        File.join PictureTag.site.config['destination'], pconfig['output']
-      end
-
-      def nomarkdown?
-        Utils.markdown_page? && pconfig['nomarkdown']
-      end
-
-      def continue_on_missing?
-        env_check pconfig['ignore_missing_images']
-      rescue ArgumentError
-        raise ArgumentError,
-              <<~HEREDOC
-                continue_on_missing setting invalid. Must be either a boolean
-                (true/false), an environment name, or an array of environment
-                names.
-              HEREDOC
-      end
-
-      def cdn?
-        pconfig['cdn_url'] && pconfig['cdn_environments'].include?(jekyll_env)
-      end
-
-      def disabled?
-        env_check pconfig['disabled']
-      rescue ArgumentError
-        raise ArgumentError,
-              <<~HEREDOC
-                "disabled" setting invalid. Must be either a boolean
-                (true/false), an environment name, or an array of environment
-                names.
-              HEREDOC
-      end
-
-      def fast_build?
-        env_check pconfig['fast_build']
-      rescue ArgumentError
-        raise ArgumentError,
-              <<~HEREDOC
-                "fast_build" setting invalid. Must be either a boolean
-                (true/false), an environment name, or an array of environment
-                names.
-              HEREDOC
-      end
-
-      private
-
-      def content
-        @content ||= setting_merge(defaults, PictureTag.site.config)
-      end
-
-      # There are a few config settings which can either be booleans,
-      # environment names, or arrays of environment names. This method works it
-      # out and returns a boolean.
-      def env_check(setting)
-        if setting.is_a? Array
-          setting.include? jekyll_env
-        elsif setting.is_a? String
-          setting == jekyll_env
-        elsif [true, false].include? setting
-          setting
-        else
-          raise ArgumentError,
-                "#{setting} must either be a string, an array, or a boolean."
-        end
-      end
-
-      def setting_merge(default, jekyll)
-        jekyll.merge default do |_key, config_setting, default_setting|
-          if default_setting.respond_to? :merge
-            setting_merge(default_setting, config_setting)
-          else
-            config_setting
-          end
-        end
-      end
-
-      def defaults
-        # Jekyll Picture Tag Default settings
-        YAML.safe_load(
-          File.read(
-            File.join(
-              ROOT_PATH, 'jekyll_picture_tag/defaults/global.yml'
-            )
-          )
-        )
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/instructions/preset.rb

@@ -1,102 +0,0 @@
-module PictureTag
-  module Instructions
-    # Handles the specific tag image set to construct.
-    class Preset
-      attr_reader :name
-      def initialize(name)
-        @name = name
-        @content = build_preset
-      end
-
-      def [](key)
-        @content[key]
-      end
-
-      def formats
-        @content['formats']
-      end
-
-      def fallback_format
-        @content['fallback_format']
-      end
-
-      def fallback_width
-        @content['fallback_width']
-      end
-
-      # Allows a per-preset hard override of the global nomarkdown setting and
-      # JPT's feeble attempts at auto-detection.
-      def nomarkdown?
-        if @content['nomarkdown'].nil?
-          PictureTag.config.nomarkdown?
-        else
-          @content['nomarkdown']
-        end
-      end
-
-      # Image widths to generate for a given media query.
-      def widths(media = nil)
-        setting_lookup('widths', 'media', media)
-      end
-
-      # Image quality setting, possibly dependent on format.
-      def quality(format = nil)
-        setting_lookup('quality', 'format', format)
-      end
-
-      # Gravity setting (for imagemagick cropping)
-      def gravity(media = nil)
-        setting_lookup('gravity', 'media', media)
-      end
-
-      # Crop value
-      def crop(media = nil)
-        setting_lookup('crop', 'media', media)
-      end
-
-      private
-
-      # Return arbitrary setting values, taking their defaults into account.
-      # Ex: quality can be set for all image formats, or individually per
-      # format. Per-format settings should override the general setting.
-      def setting_lookup(setting, prefix, lookup)
-        media_values = @content[prefix + '_' + setting] || {}
-        media_values.default = @content[setting]
-
-        media_values[lookup]
-      end
-
-      def build_preset
-        # The _data/picture.yml file is optional.
-        picture_data_file = grab_data_file
-
-        default_preset.merge picture_data_file
-      end
-
-      def default_preset
-        YAML.safe_load File.read(
-          File.join(ROOT_PATH, 'jekyll_picture_tag/defaults/presets.yml')
-        )
-      end
-
-      def grab_data_file
-        PictureTag.site
-                  .data
-                  .dig('picture', 'markup_presets', @name) || no_preset
-      end
-
-      def no_preset
-        unless @name == 'default'
-          Utils.warning(
-            <<~HEREDOC
-              Preset "#{@name}" not found in {PictureTag.config['data_dir']}/picture.yml
-              under markup_presets key. Using default values."
-            HEREDOC
-          )
-        end
-
-        {}
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/instructions/set.rb

@@ -1,71 +0,0 @@
-module PictureTag
-  module Instructions
-    # Supervisor class, which manages all input handling and high level decision
-    # making which depends on it.
-    class Set
-      def initialize(raw_tag_params)
-        @raw_tag_params = raw_tag_params
-      end
-
-      def config
-        @config ||= Configuration.new
-      end
-
-      def params
-        @params ||= TagParser.new @raw_tag_params
-      end
-
-      def preset
-        @preset ||= Preset.new params.preset_name
-      end
-
-      def html_attributes
-        # Depends on both the preset and tag params.
-        @html_attributes ||= HTMLAttributeSet.new params.leftovers
-      end
-
-      # These are our Media Query presets. It's really just a hash, and there
-      # are no default values, so extracting this to its own class is overkill.
-      def media_presets
-        PictureTag.site.data.dig('picture', 'media_presets') || {}
-      end
-
-      def source_images
-        @source_images ||= build_source_images
-      end
-
-      def crop(media = nil)
-        params.geometries[media] || preset.crop(media)
-      end
-
-      def gravity(media = nil)
-        params.gravities[media] || preset.gravity(media)
-      end
-
-      # Returns a class constant for the selected output format, which is used
-      # to dynamically instantiate it.
-      def output_class
-        Object.const_get(
-          'PictureTag::OutputFormats::' + Utils.titleize(preset['markup'])
-        )
-      end
-
-      private
-
-      def build_source_images
-        source_names = params.source_names
-        media_presets = params.media_presets
-
-        sources = [SourceImage.new(source_names.shift)]
-
-        while params.source_names.any?
-          sources << SourceImage.new(
-            source_names.shift, media_presets.shift
-          )
-        end
-
-        sources
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/source_image.rb

@@ -1,87 +0,0 @@
-module PictureTag
-  # Handles a given source image file and its properties. Provides a speed
-  # advantage by storing expensive file reads and writes in instance variables,
-  # to be reused by many different generated images.
-  class SourceImage
-    attr_reader :name, :shortname, :missing, :media_preset
-    attr_accessor :digest_guess
-    include MiniMagick
-
-    def initialize(relative_filename, media_preset = nil)
-      @shortname = relative_filename
-      @name = grab_file relative_filename
-      @media_preset = media_preset
-    end
-
-    def width
-      @width ||= if @missing
-                   999_999
-                 else
-                   image.width
-                 end
-    end
-
-    def digest
-      @digest ||= if @missing
-                    'x' * 6
-                  elsif PictureTag.fast_build? && @digest_guess
-                    # Digest guess will be handed off to this class by the first
-                    # generated image which needs it (via attr_accessor).
-                    @digest_guess
-                  else
-                    Digest::MD5.hexdigest(File.read(@name))[0..5]
-                  end
-    end
-
-    # Includes path relative to default source folder and the original filename.
-    def base_name
-      @shortname.delete_suffix File.extname(@shortname)
-    end
-
-    # File exention
-    def ext
-      # [1..-1] will strip the leading period.
-      @ext ||= File.extname(@name)[1..-1].downcase
-    end
-
-    private
-
-    def image
-      @image ||= Image.open(@name)
-    end
-
-    # Turn a relative filename into an absolute one, and make sure it exists.
-    def grab_file(source_file)
-      source_name = File.join(PictureTag.source_dir, source_file)
-
-      if File.exist? source_name
-        @missing = false
-
-      elsif PictureTag.continue_on_missing?
-        @missing = true
-        Utils.warning missing_image_warning(source_name)
-
-      else
-        raise ArgumentError, missing_image_error(source_name)
-      end
-
-      source_name
-    end
-
-    def missing_image_warning(source_name)
-      <<~HEREDOC
-        Could not find #{source_name}. Your site will have broken images in it.
-        Continuing.
-      HEREDOC
-    end
-
-    def missing_image_error(source_name)
-      <<~HEREDOC
-        Jekyll Picture Tag could not find #{source_name}. You can force the
-        build to continue anyway by setting "picture: ignore_missing_images:
-        true" in "_config.yml". This setting can also accept a jekyll build
-        environment, or an array of environments.
-      HEREDOC
-    end
-  end
-end