jekyll_picture_tag 1.12.0 → 2.0.1

data/.travis.yml

@@ -1,8 +0,0 @@
-services:
-  - docker
-
-before_install:
-  - docker build . -t jpt
-
-script:
-  - docker run -t jpt

data/Dockerfile

@@ -1,9 +0,0 @@
-FROM ruby:alpine
-WORKDIR /root/jekyll_picture_tag
-# Dependencies for nokogiri, eventmachine, and JPT
-RUN apk add git imagemagick g++ musl-dev make libstdc++ zlib build-base
-COPY Gemfile* jekyll_picture_tag.gemspec ./
-COPY lib/jekyll_picture_tag/version.rb ./lib/jekyll_picture_tag/version.rb
-RUN bundle install
-COPY . .
-CMD rake

data/docs/users/configuration/cdn.md

@@ -1,35 +0,0 @@
----
-sort: 5
----
-
-# CDN 
-
-Use for images that are hosted at a different domain or subdomain than the
-Jekyll site root. Overrides `relative_url`. 
-
-## URL
-
-*Format:* `cdn_url: (url)`
-
-*Example:* `cdn_url: https://cdn.example.com`
-
-*Default*: none
-
-## Environments
-
-It's likely that if you're using a CDN, you may not want to use it in your local
-development environment. This allows you to build a site with local images while
-in development, and still push to a CDN when you build for production by
-specifying a different 
-[environment](https://jekyllrb.com/docs/configuration/environments/). 
-
-*Format:* `cdn_environments: (array of strings)`
-
-*Example:* `cdn_environments: ['production', 'staging']`
-
-*Default*: `['production']`
-
-**Note that the default jekyll environment is `development`**, meaning that if
-you only set `cdn_url` and run `jekyll serve` or `jekyll build`, nothing will
-change. Either run `JEKYLL_ENV=production bundle exec jekyll build`, or add
-`development` to this setting.

data/docs/users/configuration/relative_urls.md

@@ -1,15 +0,0 @@
----
-sort: 6
----
-
-# Use Relative Urls
-
-*Format:* `relative_url: (true|false)`
-
-*Example:* `relative_url: false`
-
-*Default*: `true`
-
-Whether to use relative (`/generated/test(...).jpg`) or absolute
-(`https://example.com/generated/test(...).jpg`) urls in your src and srcset
-attributes.

data/docs/users/notes/input_checking.md

@@ -1,6 +0,0 @@
-# Getting cryptic build errors?
-
-  Jekyll Picture Tag is very trusting. It doesn't do much checking of your inputs, and it does not
-  fail gracefully if you for example pass it a string when it expects an array. It's on the to-do
-  list, but for now if you get cryptic errors then double-check your settings and tag arguments.
-

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

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