jekyll_picture_tag 1.10.2 → 2.0.0pre1

data/lib/jekyll_picture_tag/images/image_file.rb

@@ -0,0 +1,90 @@
+module PictureTag
+  # Basically a wrapper class for vips. Handles image operations.
+  # Vips returns new images for Crop, resize, and autorotate operations.
+  # Quality, metadata stripping, and format are applied on write.
+  class ImageFile
+    def initialize(source, base)
+      @source = source
+      @base = base
+
+      build
+    end
+
+    private
+
+    attr_reader :source, :base
+
+    def build
+      notify
+
+      mkdir
+
+      image = load_image
+
+      image = process(image)
+
+      write(image)
+    end
+
+    # Processing pipeline
+    def process(image)
+      image = crop(image) if source.crop?
+
+      image = resize(image)
+
+      image.autorot
+    end
+
+    def write_opts
+      opts = PictureTag.preset['image_options'][@base.format] || {}
+
+      opts[:strip] = PictureTag.preset['strip_metadata']
+
+      # gifs don't accept a quality setting.
+      opts[:Q] = base.quality unless base.format == 'gif'
+
+      opts.transform_keys(&:to_sym)
+    end
+
+    def load_image
+      Vips::Image.new_from_file source.name
+    end
+
+    def write(image)
+      begin
+        image.write_to_file(base.absolute_filename, **write_opts)
+      rescue Vips::Error
+        # If vips can't handle it, fall back to imagemagick.
+        opts = write_opts.transform_keys do |key|
+          key == :Q ? :quality : key
+        end
+
+        image.magicksave(base.absolute_filename, **opts)
+      end
+
+      # Fix permissions. TODO - still necessary?
+      FileUtils.chmod(0o644, base.absolute_filename)
+    end
+
+    def notify
+      puts 'Generating new image file: ' + base.name
+    end
+
+    def resize(image)
+      image.resize(scale_value)
+    end
+
+    def crop(image)
+      image.smartcrop(*source.dimensions,
+                      interesting: PictureTag.keep(@source.media_preset))
+    end
+
+    def scale_value
+      base.width.to_f / source.width
+    end
+
+    def mkdir
+      FileUtils.mkdir_p(File.dirname(base.absolute_filename))
+    end
+  end
+end

data/lib/jekyll_picture_tag/{img_uri.rb → images/img_uri.rb}

@@ -8,6 +8,7 @@ module PictureTag
   # image. Call to_s on it to get the link.
   class ImgURI
     attr_reader :filename, :source_image
+
     def initialize(filename, source_image: false)
       @source_image = source_image
       @filename = filename
@@ -17,7 +18,7 @@ module PictureTag
     # |     domain       |  baseurl   |       directory       | filename
     def to_s
       Addressable::URI.escape(
-        File.join(domain, baseurl, directory, @filename)
+        File.join(domain, PictureTag.baseurl, directory, @filename)
       )
     end
 
@@ -28,21 +29,14 @@ module PictureTag
     # |     domain       |  baseurl   |    j-p-t output dir   | filename
     def domain
       if PictureTag.cdn?
-        PictureTag.pconfig['cdn_url']
-      elsif PictureTag.pconfig['relative_url']
+        PictureTag.cdn_url
+      elsif PictureTag.relative_url
         ''
       else
         PictureTag.config['url'] || ''
       end
     end
 
-    # https://example.com/my-base-path/assets/generated-images/image.jpg
-    #                     ^^^^^^^^^^^^^
-    # |     domain       |  baseurl   |       directory       | filename
-    def baseurl
-      PictureTag.config['baseurl'] || ''
-    end
-
     # https://example.com/my-base-path/assets/generated-images/image.jpg
     #                                  ^^^^^^^^^^^^^^^^^^^^^^^^
     # |     domain       |  baseurl   |       directory       | filename

data/lib/jekyll_picture_tag/images/source_image.rb

@@ -0,0 +1,138 @@
+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 :shortname, :missing, :media_preset
+
+    # include MiniMagick
+
+    def initialize(relative_filename, media_preset = nil)
+      # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+      #                                  ^^^^^^^^^^^^^^^^^^^^^^
+      @shortname = relative_filename
+      @media_preset = media_preset
+
+      @missing = missing?
+      check_cache
+    end
+
+    def digest
+      @digest ||= cache[:digest] || ''
+    end
+
+    def crop
+      PictureTag.crop(media_preset)
+    end
+
+    def crop?
+      !crop.nil?
+    end
+
+    def keep
+      PictureTag.keep(media_preset)
+    end
+
+    def dimensions
+      [width, height]
+    end
+
+    def width
+      return raw_width unless crop?
+
+      [raw_width, (raw_height * cropped_aspect)].min.round
+    end
+
+    def height
+      return raw_height unless crop?
+
+      [raw_height, (raw_width / cropped_aspect)].min.round
+    end
+
+    def cropped_aspect
+      return Utils.aspect_float(raw_width, raw_height) unless crop?
+
+      Utils.aspect_float(*crop.split(':').map(&:to_f))
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    def name
+      @name ||= File.join(PictureTag.source_dir, @shortname)
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    #                                  ^^^^^^^^^^^^^^^^^^
+    def base_name
+      @shortname.delete_suffix File.extname(@shortname)
+    end
+
+    # /home/dave/my_blog/assets/images/somefolder/myimage.jpg
+    #                                                     ^^^
+    def ext
+      @ext ||= File.extname(name)[1..].downcase
+    end
+
+    private
+
+    # pre-crop
+    def raw_width
+      @raw_width ||= @missing ? 999_999 : image.width
+    end
+
+    # pre-crop
+    def raw_height
+      @raw_height ||= @missing ? 999_999 : image.height
+    end
+
+    def cache
+      @cache ||= Cache.new(@shortname)
+    end
+
+    def missing?
+      if File.exist? name
+        false
+
+      elsif PictureTag.continue_on_missing?
+        Utils.warning(missing_image_warning)
+        true
+
+      else
+        raise ArgumentError, missing_image_error
+      end
+    end
+
+    def check_cache
+      return if @missing
+      return if cache[:digest] && PictureTag.fast_build?
+
+      update_cache if source_digest != cache[:digest]
+    end
+
+    def update_cache
+      cache[:digest] = source_digest
+
+      cache.write
+    end
+
+    def image
+      @image ||= Vips::Image.new_from_file(name)
+    end
+
+    def source_digest
+      @source_digest ||= Digest::MD5.hexdigest(File.read(name))
+    end
+
+    def missing_image_warning
+      "JPT Could not find #{name}. " \
+        'Your site will have broken images. Continuing.'
+    end
+
+    def missing_image_error
+      <<~HEREDOC
+        Could not find #{name}. You can force the build to continue anyway by
+        setting "picture: ignore_missing_images: true" in "_config.yml".
+      HEREDOC
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions.rb

@@ -1,6 +1,70 @@
-require_relative './instructions/set'
-require_relative './instructions/configuration'
-require_relative './instructions/html_attributes'
-require_relative './instructions/preset'
-require_relative './instructions/tag_parser'
-require_relative './instructions/arg_splitter'
+module PictureTag
+  # Instructions obtain, validate, and typecast/coerce input values. These
+  # inputs are either taken directly from jekyll's inputs, or handled by parsers
+  # first.
+  #
+  # Logic which affects only a single setting belongs in Instructions, while
+  # logic which affects multiple settings belongs in Parsers.
+  #
+  # Since instruction classes are so small, we define several per file in the
+  # instructions directory to save on boilerplate. All fall under the
+  # Instructions module namespace.
+  module Instructions
+    # Generic instruction, meant to be inherited. Children of this class must
+    # override the source method, and likely want to override valid?, coerce,
+    # and error_message as applicable.
+    class Instruction
+      # Memoized value of the given instruction. This is the public API.
+      def value
+        return @value if defined?(@value)
+
+        raise ArgumentError, error_message unless valid?
+
+        @value = coerced
+      end
+
+      private
+
+      # Source(s) of truth - where does this setting come from? Logic does not
+      # belong here. If information comes from muliple places, return an array
+      # or a hash.
+      def source
+        raise NotImplementedError
+      end
+
+      # Determine whether or not the input(s) are valid.
+      def valid?
+        true
+      end
+
+      # Convert input(s) to output.
+      def coerce
+        source
+      end
+
+      # Message returned if validation fails. Override this with something more
+      # helpful.
+      def error_message
+        "JPT - #{setting_name} received an invalid argument: #{source}"
+      end
+
+      def coerced
+        return @coerced if defined?(@coerced)
+
+        @coerced = coerce
+      end
+
+      def setting_name
+        Utils.snakeize(self.class.to_s.split('::').last)
+      end
+    end
+  end
+end
+
+# Load Parents
+Dir[File.dirname(__FILE__) + '/instructions/parents/*.rb']
+  .sort.each { |file| require file }
+
+# Load children:
+Dir[File.dirname(__FILE__) + '/instructions/children/*.rb']
+  .sort.each { |file| require file }

data/lib/jekyll_picture_tag/instructions/children/config.rb

@@ -0,0 +1,128 @@
+module PictureTag
+  module Instructions
+    # PictureTag configuration in _config.yml
+    class Pconfig < Instruction
+      def source
+        PictureTag.config['picture']
+      end
+    end
+
+    # https://example.com/my-base-path/assets/generated-images/image.jpg
+    #                     ^^^^^^^^^^^^^
+    # |     domain       |  baseurl   |       directory       | filename
+    class Baseurl < Instruction
+      def source
+        {
+          ignore: PictureTag.pconfig['ignore_baseurl'],
+          key: PictureTag.pconfig['baseurl_key']
+        }
+      end
+
+      def coerce
+        return '' if source[:ignore]
+
+        PictureTag.config[source[:key]] || ''
+      end
+    end
+
+    # Whether to use relative or absolute URLs for images.
+    class RelativeUrl < EnvInstruction
+      def source
+        PictureTag.pconfig['relative_url']
+      end
+    end
+
+    # Image source directory
+    class SourceDir < Instruction
+      private
+
+      def source
+        [
+          PictureTag.site.source,
+          PictureTag.pconfig['source']
+        ]
+      end
+
+      def coerce
+        File.join(*source.map(&:to_s))
+      end
+
+      def setting_name
+        'source directory'
+      end
+    end
+
+    # Image output directory
+    class DestDir < Instruction
+      private
+
+      def source
+        [
+          PictureTag.site.config['destination'],
+          PictureTag.pconfig['output']
+        ]
+      end
+
+      def coerce
+        File.join(*source.map(&:to_s))
+      end
+    end
+
+    # Whether to continue if a source image is missing
+    class ContinueOnMissing < EnvInstruction
+      def source
+        PictureTag.pconfig['ignore_missing_images']
+      end
+    end
+
+    # Whether to use a CDN
+    class Cdn < EnvInstruction
+      def source
+        {
+          url: PictureTag.pconfig['cdn_url'],
+          setting: PictureTag.pconfig['cdn_environments']
+        }
+      end
+
+      def coerce
+        source[:url] && super
+      end
+    end
+
+    # CDN URL
+    class CdnUrl < Instruction
+      def source
+        PictureTag.pconfig['cdn_url']
+      end
+
+      def valid?
+        require 'uri'
+        uri = URI(source)
+
+        # If the URI library can't parse it, it's not valid.
+        uri.scheme && uri.host
+      end
+
+      def error_message
+        <<~HEREDOC
+          cdn_url must be a valid URI in the following format: https://example.com/
+          current setting: #{source}
+        HEREDOC
+      end
+    end
+
+    # Disable JPT?
+    class Disabled < EnvInstruction
+      def source
+        PictureTag.pconfig['disabled']
+      end
+    end
+
+    # Fast build?
+    class FastBuild < EnvInstruction
+      def source
+        PictureTag.pconfig['fast_build']
+      end
+    end
+  end
+end