jekyll_picture_tag 1.10.1 → 1.14.0

data/docs/usage.md

@@ -1,143 +0,0 @@
----
----
-
-# How to use the Liquid Tag:
-
-## Format:
-
-{% raw %}
-`{% picture [preset] (image) [crop] [alternate images & crops] [attributes] %}`
-{% endraw %}
-
-The only required argument is the base image. Line breaks and extra spaces are fine, and you can
-use liquid variables anywhere.
-
-## Examples:
-
-{% raw %}
-`{% picture example.jpg %}`
-
-`{% picture thumbnail example.jpg 1:1 --alt Example Image %}`
-
-`{% picture example.jpg 16:9 north --picture class="attribute-demo" %}`
-
-`{% picture blog_index {{ post.image }} --link {{ post.url }} %}`
-
-`{% picture "some example.jpg" mobile: other\ example.jpg %}`
-
-```md
-{% picture
-  hero
-  example.jpg 16:9 east
-  tablet: example_cropped.jpg 3:2 east
-  mobile: example_cropped_more.jpg 1:1-50+0 east
-  --alt Happy Puppy
-  --picture class="hero"
-  --link /
-%}
-```
-
-{% endraw %}
-
-## Argument reference
-
-Given in order:
-
-- **Preset**
-
-  Select a [markup preset]({{ site.baseurl }}/presets#markup-presets), or omit to use the `default` preset. Presets
-  are collections of settings that determine nearly everything about JPT's output, from the image
-  formats used to the exact format your markup will take.
-
-- **Base Image** (Required)
-
-  Can be any raster image (as long as you have the required ImageMagick delegate). Relative to
-  jekyll's root directory, or the `source` [setting]({{ site.baseurl }}/global_configuration) if you've configured it.
-
-  For filenames with spaces, either use double quotes (`"my image.jpg"`) or a backslash (`my\ image.jpg`).
-
-- **Crop**
-
-  **Check the [ installation guide ](installation) before using this feature.**
-
-  Crop an image to a given aspect ratio or size. This argument is given as a `geometry` and
-  (optionally) a `gravity`, which can appear in either order and are thin wrappers around
-  ImageMagick's [geometry](http://www.imagemagick.org/script/command-line-processing.php#geometry)
-  and [gravity](http://www.imagemagick.org/script/command-line-options.php#gravity) settings. The
-  values given here will override the preset settings (if present), can be given after every image,
-  and apply only to the preceding image.
-
-  Geometry can take many forms, but most likely you'll want to set an aspect ratio-- given in the
-  standard `width:height` ratio such as `3:2`. Gravity sets which portion of the image to keep, and
-  is given in compass directions (`north`, `southeast`, etc) or `center` (default). Cropping happens
-  before resizing; the preset `widths` setting is a post-crop value.
-
-  If you'd like more fine-grained control, this can be offset by appending `+|-x` and (optionally)
-  `y` pixel values to the _geometry_ (not the gravity!). Example: `1:1+400 west` means "Crop to a
-  1:1 aspect ratio, starting 400 pixels from the left side.", and `north 3:2+0+100` means "Crop to
-  3:2, starting 100 pixels from the top." These can get a bit persnickety; there's nothing to stop
-  you from running off the side of the image. Pay attention.
-
-  For detailed documentation, see ImageMagick's
-  [crop](http://www.imagemagick.org/script/command-line-options.php#crop) tool.
-
-  _Note:_ If you do a lot of trial and error with these, it's a good idea to manually delete your
-  generated images folder more often as each change will build a new set of images without removing
-  the old ones.
-
-- **Alternate images**
-
-  _Format:_ `(media query preset): (filename) (...)`
-
-  _Example:_ `tablet: img_cropped.jpg mobile: img_cropped_more.jpg`
-
-  Optionally specify any number of alternate base images for given [screen
-  sizes]({{ site.baseurl }}/presets/#media-presets) (specified in `_data/picture.yml`). This is called [art
-  direction](http://usecases.responsiveimages.org/#art-direction), and is one of JPT's strongest
-  features.
-
-  Give your images in order of ascending specificity (The first image is the most general). They will
-  be provided to the browser in reverse order, and it will select the first one with an applicable
-  media query.
-
-- **Attributes**
-
-  Optionally specify any number of HTML attributes, or an href target. These will be added to any
-  attributes you've set in a preset.
-
-  - **`--link`**
-
-    _Format:_ `--link (some url)`
-
-    _Examples_: `--link https://example.com`, `--link /blog/some_post/`
-
-    Wrap the image in an anchor tag, with the `href` attribute set to whatever value you give it.
-    This will override automatic source image linking, if you have enabled it.
-
-    **Note**: If you get either mangled HTML or extra {::nomarkdown} tags when using this, read
-    [here]({{ site.baseurl }}/notes).
-
-  - **`--alt`**
-
-    _Format:_ `--alt (alt text)`
-
-    _Example:_ `--alt Here is my alt text!`
-
-    Convenience shortcut for `--img alt="..."`
-
-  - **`--(element)`**
-
-    _Format:_ `--(picture|img|source|a|parent) (Standard HTML attributes)`
-
-    _Example:_ `--img class="awesome-fade-in" id="coolio" --a data-awesomeness="11"`
-
-    Apply attributes to a given HTML element. Your options are:
-
-    - `picture`
-    - `img`
-    - `source`
-    - `a` (anchor tag)
-    - `parent`
-
-    `--parent` will be applied to the `<picture>` if present, otherwise the `<img>`; useful when
-    using an `auto` output format.

data/lib/jekyll_picture_tag/generated_image.rb

@@ -1,161 +0,0 @@
-require 'mini_magick'
-require 'base32'
-
-module PictureTag
-  # Represents a generated image file.
-  class GeneratedImage
-    attr_reader :width, :format
-    include MiniMagick
-
-    def initialize(source_file:, width:, format:, crop: nil, gravity: '')
-      @source = source_file
-      @width  = width
-      @format = process_format format
-      @crop = crop
-      @gravity = gravity
-    end
-
-    def exists?
-      File.exist?(absolute_filename)
-    end
-
-    def generate
-      generate_image unless @source.missing || exists?
-    end
-
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
-    # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    def absolute_filename
-      @absolute_filename ||= File.join(PictureTag.dest_dir, name)
-    end
-
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
-    #                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    def name
-      name_left + digest + name_right
-    end
-
-    # https://example.com/assets/images/myimage-100-123abc.jpg
-    #                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    def uri
-      ImgURI.new(name).to_s
-    end
-
-    def cropped_source_width
-      image.width
-    end
-
-    private
-
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
-    #                                    ^^^^^^^^^^^^^^^^^^^^^^^
-    def name_left
-      "#{@source.base_name}-#{@width}-"
-    end
-
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
-    #                                                           ^^^^^^
-    def digest
-      guess_digest if !@source.digest_guess && PictureTag.fast_build?
-
-      @source.digest
-    end
-
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-123abc.jpg
-    #                                                                 ^^^^
-    def name_right
-      crop_code + '.' + @format
-    end
-
-    # Hash the crop settings, so we can detect when they change.  We use a
-    # base32 encoding scheme to pack more information into fewer characters,
-    # without dealing with various filesystem naming limitations that would crop
-    # up using base64 (such as NTFS being case insensitive).
-    def crop_code
-      return '' unless @crop
-
-      Base32.encode(
-        Digest::MD5.hexdigest(@crop + @gravity)
-      )[0..2]
-    end
-
-    # Used for the fast build option: look for a file which matches everything
-    # we know about the destination file without calculating a digest on the
-    # source file, and if it exists we assume it's the right one.
-    def guess_digest
-      matches = dest_glob
-      return unless matches.length == 1
-
-      # Start and finish of the destination image's hash value
-      finish = -name_right.length
-      start = finish - 6
-
-      # The source image keeps track of this guess, so we hand it off:
-      @source.digest_guess = matches.first[start...finish]
-    end
-
-    # Returns a list of images which are probably correct.
-    def dest_glob
-      query = File.join(
-        PictureTag.dest_dir,
-        name_left + '?' * 6 + name_right
-      )
-
-      Dir.glob query
-    end
-
-    def generate_image
-      puts 'Generating new image file: ' + name
-      process_image
-      write_image
-    end
-
-    def image
-      @image ||= open_image
-    end
-
-    def open_image
-      image_base = Image.open(@source.name)
-      image_base.combine_options do |i|
-        i.auto_orient
-        if @crop
-          i.gravity @gravity
-          i.crop @crop
-        end
-      end
-
-      image_base
-    end
-
-    def process_image
-      image.combine_options do |i|
-        i.resize "#{@width}x"
-        i.strip
-      end
-
-      image.format @format
-      image.quality PictureTag.quality(@format)
-    end
-
-    def write_image
-      # Make sure destination directory exists:
-      FileUtils.mkdir_p(dest_dir) unless Dir.exist?(dest_dir)
-
-      image.write absolute_filename
-
-      FileUtils.chmod(0o644, absolute_filename)
-    end
-
-    def dest_dir
-      File.dirname absolute_filename
-    end
-
-    def process_format(format)
-      if format.casecmp('original').zero?
-        @source.ext
-      else
-        format.downcase
-      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