jekyll_picture_tag 1.11.0 → 2.0.0

data/docs/releases.md

@@ -1,70 +0,0 @@
----
----
-# Release History
-* 1.11.0 July 27, 2020
-  * **Width and height attribute support!** Begone, page reflow.
-  * Cache image information between builds
-  * Change image naming format. This update will trigger all images to be regenerated, so you may
-    want to delete your generated images folder beforehand.
-* 1.10.2 July 6, 2020
-  * Bugfix for fallback image files not actually getting generated
-* 1.10.1 July 2, 2020
-  * Bugfix for erroneously regenerated images
-* 1.10.0 May 11, 2020
-  * **Image Cropping support!** access the power of ImageMagick's `crop` function.
-  * Don't issue a warning when `default` preset is not found.
-  * Documentation improvements
-* 1.9.0 Feb 2, 2020
-  * Add `fast_build` global setting
-  * Add `disabled` global setting
-  * Reduce unnecessary disk IO; sites with many source images should see build times improve when
-    no new images need to be generated.
-  * Add support for empty attributes; specifically so best-practice for decorative images (`alt=""`)
-    is possible.
-* 1.8.0 Nov 25, 2019
-  * Add `data_sizes` setting for the `data_` family of output formats.
-* 1.7.1 Nov 14, 2019
-  * Fix some HTML attribute related bugs
-  * Add a few items to the FAQ
-* 1.7.0 Aug 12, 2019
-  * Add support for setting generated image quality, either generally or specific to given
-    formats.
-  * Add support for spaces and other url-encoded characters in filenames
-  * Documentation restructure - Moved it out of the wiki, into the `docs` folder.
-  * Bugfix: Fallback image width will now be checked against source image width.
-  * Bugfix: Minor fix to nomarkdown wrapper output
-  * link_source will now target the base source image, rather than finding the biggest one.
-  * Remove fastimage dependency, add addressable dependency.
-  * Moderately significant refactoring and code cleanup 
-  * Decent set of tests added
-* 1.6.0 Jul  2, 2019:
-  * Missing Preset warning respects `data_dir` setting
-  * Add `continue_on_missing` option
-* 1.5.0 Jun 26, 2019: 
-  * better `{::nomarkdown}` necessity detection
-  * allow user to override `{::nomarkdown}` autodetection
-* 1.4.0 Jun 26, 2019:
-  * Rename gem from `jekyll-picture-tag` to `jekyll_picture_tag`, allowing us to use rubygems again.
-  * Add new output format: `naked_srcset`.
-* 1.3.1 Jun 21, 2019: Bugfix
-* 1.3.0 Jun  7, 2019:
-  * Initial compatibility with Jekyll 4.0
-  * bugfixes
-  * change to generated image naming-- The first build after this update will be longer, and you
-    might want to clear out your generated images.
-* 1.2.0 Feb  9, 2019:
-  * Add nomarkdown fix
-  * noscript option
-  * relative url option
-  * anchor tag wrappers
-* 1.1.0 Jan 22, 2019:
-  * Add direct_url markup format,
-  * auto-orient images before stripping metadata
-* 1.0.2 Jan 18, 2019: Fix ruby version specification
-* 1.0.1 Jan 13, 2019: Added ruby version checking
-* **1.0.0** Nov 27, 2018: Rewrite from the ground up. See the [migration guide]({{ site.baseurl }}/migration).
-* 0.2.2 Aug  2, 2013: Bugfixes
-* 0.2.1 Jul 17, 2013: Refactor again, add Liquid parsing.
-* 0.2.0 Jul 14, 2013: Rewrite code base, bring in line with Jekyll Image Tag.
-* 0.1.1 Jul  5, 2013: Quick round of code improvements.
-* 0.1.0 Jul  5, 2013: Initial release.

data/docs/usage.md

@@ -1,157 +0,0 @@
----
----
-
-# How to use the Liquid Tag:
-
-This section describes how to use JPT's liquid tag; what options it takes and what kind of information you can pass through it to influence the form of the final HTML-markup.
-
-## 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.
-
-The `preset` determines the actual HTML code that gets written to your files;
-it is basically a recipy that takes information that you provide in the
-liquid tag and turns it into HTML markup. When the `preset` is omitted
-default settings will be used, in the simplest case resulting in an `img`-tag
-containing an srcset pointing to your newly generated image sizes. You are
-free to override the `default` preset and define your own presets, giving
-full flexibility in what JPT will write to your files. See [markup preset]({{
-site.baseurl }}/presets#markup-presets) for more information on this.
-
-## Examples:
-
-{% raw %}
-`{% picture example.jpg %}`
-
-`{% picture {{ page.example_liquid_picture_var }} %}`
-
-`{% 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 final HTML-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.
-  **Note:** Attributes that are set in the liquid picture tag, but don't occur in the used `preset` will be ignored (e.g. adding `--picture class="cool-css"` with a preset that does not write a html `<picture>` tag).

data/jekyll-picture-tag.gemspec

@@ -1,52 +0,0 @@
-# Why 2 gemspecs?
-#
-# Originally, this gem was named 'jekyll-picture-tag', and published on rubygems
-# under this name. There was a break in development, during which push access to
-# rubygems was lost. Development was later resumed, and as a workaround for that
-# issue the installation instructions were to source the gem from the Github
-# repository.
-#
-# Ultimately, the decision was made to rename it by switching the dashes for
-# underscores, which follows best practice and allows pushing it to rubygems
-# under the new name. The drawback of this situation is that everyone who
-# followed the installaion instructions previously would see their site
-# inexplicably break, as it would be searching for a gemspec that doesn't exist.
-# As a workaround (to the old workaround... sigh) this gemspec lets us print a
-# warning and then require the new version, which keeps old sites working while
-# encouraging people to use rubygems.
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll_picture_tag/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'jekyll-picture-tag'
-  spec.version       = PictureTag::VERSION
-  spec.authors       = ['Robert Wierzbowski', 'Brendan Tobolaski',
-                        'Robert Buchberger']
-  spec.email         = ['robert@buchberger.cc']
-
-  spec.summary       = 'Easy responsive images for Jekyll.'
-  spec.description   = <<~HEREDOC
-     ____                                _           _
-    |  _ \  ___ _ __  _ __ ___  ___ __ _| |_ ___  __| |
-    | | | |/ _ \ '_ \| '__/ _ \/ __/ _` | __/ _ \/ _` |
-    | |_| |  __/ |_) | | |  __/ (_| (_| | ||  __/ (_| |
-    |____/ \___| .__/|_|  \___|\___\__,_|\__\___|\__,_|
-               |_|
-
-    This gem has been renamed! Use jekyll_picture_tag instead, which is now
-    hosted on rubygems.
-  HEREDOC
-  spec.homepage      = 'https://github.com/rbuchberger/jekyll_picture_tag'
-  spec.license       = 'BSD-3-Clause'
-  spec.require_paths = ['lib']
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-
-  spec.required_ruby_version = ['>= 2.5', '< 3']
-
-  spec.add_dependency 'jekyll_picture_tag'
-end

data/lib/jekyll-picture-tag.rb

@@ -1,25 +0,0 @@
-# rubocop:disable Naming/FileName
-puts '-' * 80
-# rubocop:enable Naming/FileName
-
-puts <<~HEREDOC
-  \033[31;1;4m
-  Important message from Jekyll Picture Tag:
-  \033[0m
-  Good news! We're back up on rubygems.
-  Bad news. You need to update your Gemfile. Remove the following line:
-
-  gem 'jekyll-picture-tag', git: 'https://github.com/robwierzbowski/jekyll-picture-tag/'
-
-  and replace it with something like:
-
-  gem 'jekyll_picture_tag', '~> 1.6'
-
-  Sorry about that. For an explanation, see issue #120:
-  https://github.com/rbuchberger/jekyll-picture-tag/issues/120
-
-HEREDOC
-
-puts '-' * 80
-
-require 'jekyll_picture_tag'

data/lib/jekyll_picture_tag/cache/base.rb

@@ -1,59 +0,0 @@
-require 'json'
-
-module PictureTag
-  module Cache
-    # Basic image information cache functionality
-    module Base
-      def initialize(base_name)
-        @base_name = base_name
-      end
-
-      def [](key)
-        data[key]
-      end
-
-      def []=(key, value)
-        raise ArgumentError unless template.keys.include? key
-
-        data[key] = value
-      end
-
-      # Call after updating data.
-      def write
-        FileUtils.mkdir_p(File.join(base_directory, sub_directory))
-
-        File.open(filename, 'w+') do |f|
-          f.write JSON.generate(data)
-        end
-      end
-
-      private
-
-      def data
-        @data ||= if File.exist?(filename)
-                    JSON.parse(File.read(filename)).transform_keys(&:to_sym)
-                  else
-                    template
-                  end
-      end
-
-      # /home/dave/my_blog/.jekyll-cache/jpt/(cache_dir)/assets/myimage.jpg.json
-      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      def base_directory
-        File.join(PictureTag.site.cache_dir, 'jpt', cache_dir)
-      end
-
-      # /home/dave/my_blog/.jekyll-cache/jpt/(cache_dir)/assets/myimage.jpg.json
-      #                                                 ^^^^^^^^
-      def sub_directory
-        File.dirname(@base_name)
-      end
-
-      # /home/dave/my_blog/.jekyll-cache/jpt/somefolder/myimage.jpg.json
-      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      def filename
-        File.join(base_directory, @base_name + '.json')
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/cache/generated.rb

@@ -1,20 +0,0 @@
-module PictureTag
-  module Cache
-    # Caches generated image details, so we can skip expensive operations whenever
-    # possible.
-    # Stored width and height are values for the source image, after cropping.
-    class Generated
-      include Base
-
-      private
-
-      def cache_dir
-        'generated'
-      end
-
-      def template
-        { width: nil, height: nil }
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/cache/source.rb

@@ -1,19 +0,0 @@
-module PictureTag
-  module Cache
-    # Caches source image details, so we can skip expensive operations whenever
-    # possible.
-    class Source
-      include Base
-
-      private
-
-      def template
-        { digest: nil, width: nil, height: nil }
-      end
-
-      def cache_dir
-        'source'
-      end
-    end
-  end
-end

data/lib/jekyll_picture_tag/defaults/global.yml

@@ -1,11 +0,0 @@
-# Default settings for _config.yml
-picture:
-  source: ''
-  output: generated
-  suppress_warnings: false
-  relative_url: true
-  cdn_environments: ['production']
-  nomarkdown: true
-  ignore_missing_images: false
-  disabled: false
-  fast_build: false

data/lib/jekyll_picture_tag/defaults/presets.yml

@@ -1,11 +0,0 @@
-markup: auto
-formats: [original]
-widths: [400, 600, 800, 1000]
-fallback_width: 800
-fallback_format: original
-noscript: false
-link_source: false
-quality: 75
-data_sizes: true
-gravity: center
-dimension_attributes: false

data/lib/jekyll_picture_tag/generated_image.rb

@@ -1,140 +0,0 @@
-require 'mini_magick'
-
-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 ||= "#{@source.base_name}-#{@width}-#{id}.#{@format}"
-    end
-
-    # https://example.com/assets/images/myimage-100-123abc.jpg
-    #                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-    def uri
-      ImgURI.new(name).to_s
-    end
-
-    # Post crop
-    def source_width
-      update_cache unless cache[:width]
-
-      cache[:width]
-    end
-
-    # Post crop
-    def source_height
-      update_cache unless cache[:height]
-
-      cache[:height]
-    end
-
-    private
-
-    # We exclude width and format from the cache name, since it isn't specific to them.
-    def cache
-      @cache ||= Cache::Generated.new("#{@source.base_name}-#{id}")
-    end
-
-    def update_cache
-      return if @source.missing
-
-      # Ensure it's generated:
-      image
-
-      cache[:width] = @source_dimensions[:width]
-      cache[:height] = @source_dimensions[:height]
-
-      cache.write
-    end
-
-    # Hash all inputs and truncate, so we know when they change without getting too long.
-    # /home/dave/my_blog/_site/generated/somefolder/myimage-100-1234abcde.jpg
-    #                                                           ^^^^^^^^^
-    def id
-      @id ||= Digest::MD5.hexdigest([@source.digest, @crop, @gravity, quality].join)[0..8]
-    end
-
-    # Post crop, before resizing and reformatting
-    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
-
-      @source_dimensions = { width: image_base.width, height: image_base.height }
-
-      image_base
-    end
-
-    def generate_image
-      puts 'Generating new image file: ' + name
-      process_image
-      write_image
-    end
-
-    def quality
-      PictureTag.quality(@format)
-    end
-
-    def process_image
-      image.combine_options do |i|
-        i.resize "#{@width}x"
-        i.strip
-      end
-
-      image.format @format
-      image.quality quality
-    end
-
-    def write_image
-      FileUtils.mkdir_p(File.dirname(absolute_filename))
-
-      image.write absolute_filename
-
-      FileUtils.chmod(0o644, absolute_filename)
-    end
-
-    def process_format(format)
-      if format.casecmp('original').zero?
-        @source.ext
-      else
-        format.downcase
-      end
-    end
-  end
-end