jekyll_picture_tag 1.6.0 → 1.7.0

data/lib/jekyll_picture_tag/img_uri.rb

@@ -0,0 +1,55 @@
+require 'addressable'
+
+module PictureTag
+  # Represents a link to an image. We use the File library rather than the URI
+  # library to build these because it doesn't like relative URIs.
+  #
+  # Just give it a filename, and pass source_image: true if it's not a generated
+  # 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
+    end
+
+    # https://example.com/my-base-path/assets/generated-images/image.jpg
+    # |     domain       |  baseurl   |       directory       | filename
+    def to_s
+      Addressable::URI.escape(
+        File.join(domain, baseurl, directory, @filename)
+      )
+    end
+
+    private
+
+    # https://example.com/my-base-path/assets/generated-images/image.jpg
+    # ^^^^^^^^^^^^^^^^^^^^
+    # |     domain       |  baseurl   |    j-p-t output dir   | filename
+    def domain
+      if PictureTag.cdn?
+        PictureTag.pconfig['cdn_url']
+      elsif PictureTag.pconfig['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
+    def directory
+      PictureTag.pconfig[
+        @source_image ? 'source' : 'output'
+      ]
+    end
+  end
+end

data/lib/jekyll_picture_tag/instructions.rb

@@ -1,106 +1,5 @@
+require_relative './instructions/set'
 require_relative './instructions/configuration'
 require_relative './instructions/html_attributes'
 require_relative './instructions/preset'
 require_relative './instructions/tag_parser'
-
-# Allows us to access settings as methods on PictureTag itself.
-module PictureTag
-  class << self
-    attr_reader :context, :config, :params, :preset, :html_attributes
-
-    def init(raw_tag_params, context)
-      @context = context
-
-      # Create global config (big picture). Config class loads jekyll
-      # data/config files, and the j-p-t defaults from included yml files.
-      @config = Instructions::Configuration.new
-
-      # Parse tag params. We must do this before setting the preset, because
-      # it's one of the params.
-      @params = Instructions::TagParser.new(raw_tag_params)
-
-      # Create preset. Takes preset name from params, merges associated settings
-      # with default values.
-      @preset = Instructions::Preset.new
-
-      # Create HTML attributes. Depends on both the preset and tag params, so
-      # we must do this after creating both.
-      @html_attributes = Instructions::HTMLAttributeSet.new(
-        @params.html_attributes_raw
-      )
-
-      # Keep our generated files
-      Utils.keep_files
-    end
-
-    # Global site data
-    def site
-      @context.registers[:site]
-    end
-
-    # Page which tag is called from
-    def page
-      @context.registers[:page]
-    end
-
-    # Media query presets. It's really just a hash, and there are no default
-    # values, so extracting it to its own class is overkill.
-    def media_presets
-      site.data.dig('picture', 'media_presets') || {}
-    end
-
-    # The rest of the application doesn't care where the instruction logic
-    # resides. For example, I don't want to use PictureTag.config.source_dir and
-    # PictureTag.params.source_images, I just want to use PictureTag.source_dir
-    # and PictureTag.source_images. The following method definitions accomplish
-    # that.
-
-    # At first I thought I'd do some sweet dynamic metaprogramming here, but it
-    # ended up more complicated and clever than convenient. This way is not
-    # strictly DRY, but it's understandable and readable.
-
-    # Config Forwarding
-    def source_dir
-      @config.source_dir
-    end
-
-    def dest_dir
-      @config.dest_dir
-    end
-
-    def build_url(filename)
-      @config.build_url(filename)
-    end
-
-    def build_source_url(filename)
-      @config.build_source_url(filename)
-    end
-
-    # Preset forwarding
-    def widths(media)
-      @preset.widths(media)
-    end
-
-    def fallback_format
-      @preset.fallback_format
-    end
-
-    def fallback_width
-      @preset.fallback_width
-    end
-
-    def nomarkdown?
-      @preset.nomarkdown?
-    end
-
-
-    # Params forwarding
-    def preset_name
-      @params.preset_name
-    end
-
-    def source_images
-      @params.source_images
-    end
-  end
-end

data/lib/jekyll_picture_tag/instructions/configuration.rb

@@ -3,12 +3,14 @@ module PictureTag
     # Global config (big picture). loads jekyll data/config files, and the j-p-t
     # defaults from included yml files.
     class Configuration
-      def initialize
-        @content = build_config
+      # returns jekyll's configuration (picture is a subset)
+      def [](key)
+        content[key]
       end
 
-      def [](key)
-        @content[key]
+      # picturetag specific configuration
+      def pconfig
+        content['picture']
       end
 
       # Digs into jekyll context, returns current environment
@@ -21,38 +23,22 @@ module PictureTag
       # 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, self['picture']['source']
+        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.dest, self['picture']['output']
-      end
-
-      # Generated images, not source images.
-      # https://example.com/my-base-path/assets/generated-images/image.jpg
-      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      # |     domain       |  baseurl   |    j-p-t output dir   | filename
-      def build_url(filename)
-        File.join url_prefix, self['picture']['output'], filename
-      end
-
-      # For linking source images
-      # https://example.com/my-base-path/assets/source-images/image.jpg
-      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      # |     domain       |  baseurl   |   j-p-t source dir | filename
-      def build_source_url(filename)
-        File.join url_prefix, self['picture']['source'], filename
+        File.join PictureTag.site.dest, pconfig['output']
       end
 
       def nomarkdown?
-        Utils.markdown_page? && self['picture']['nomarkdown']
+        Utils.markdown_page? && pconfig['nomarkdown']
       end
 
       def continue_on_missing?
-        setting = @content['picture']['ignore_missing_images']
+        setting = pconfig['ignore_missing_images']
 
         # Config setting can be a string, an array, or a boolean
         if setting.is_a? Array
@@ -64,64 +50,34 @@ module PictureTag
         end
       end
 
-      private
-
-      def build_config
-        YAML.safe_load(
-          # Jekyll Picture Tag Default settings
-          File.read(
-            File.join(ROOT_PATH, 'jekyll_picture_tag/defaults/global.yml')
-          )
-        ).merge(
-          # _config.yml defined settings
-          PictureTag.site.config
-        ) do |_key, jpt_default, site_value|
-          setting_merge(jpt_default, site_value)
-        end
+      def cdn?
+        pconfig['cdn_url'] && pconfig['cdn_environments'].include?(jekyll_env)
       end
 
-      def setting_merge(jpt_default, site_value)
-        if site_value.nil?
-          # Jekyll baseurl is nil if not configured, which breaks things.
-          # jpt_default is an empty string, which doesn't.
-          jpt_default
-        elsif site_value.is_a? Hash
-          # We'll merge hashes one level deep. If we need true deep merging,
-          # we'll import a gem or do something recursive.
-          jpt_default.merge site_value
-        else
-          site_value
-        end
-      end
+      private
 
-      # Juuust complicated enough to extract to its own function.
-      def cdn?
-        self['picture']['cdn_url'] &&
-          self['picture']['cdn_environments'].include?(jekyll_env)
+      def content
+        @content ||= setting_merge(defaults, PictureTag.site.config)
       end
 
-      # https://example.com/my-base-path/assets/generated-images/image.jpg
-      # ^^^^^^^^^^^^^^^^^^^^
-      # |     domain       |  baseurl   |    j-p-t output dir   | filename
-      def domain
-        if cdn?
-          self['picture']['cdn_url']
-        elsif self['picture']['relative_url']
-          ''
-        else
-          self['url']
+      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
 
-      # https://example.com/my-base-path/assets/generated-images/image.jpg
-      # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-      # |     domain       |  baseurl   |    j-p-t output dir   | filename
-      def url_prefix
-        # We use file.join because the ruby url methods don't like relative
-        # urls.
-        File.join(
-          domain,
-          self['baseurl']
+      def defaults
+        # Jekyll Picture Tag Default settings
+        YAML.safe_load(
+          File.read(
+            File.join(
+              ROOT_PATH, 'jekyll_picture_tag/defaults/global.yml'
+            )
+          )
         )
       end
     end

data/lib/jekyll_picture_tag/instructions/html_attributes.rb

@@ -9,7 +9,7 @@ module PictureTag
         @content = load_preset
 
         parse_params(params) if params
-        handle_url
+        handle_source_url
       end
 
       def [](key)
@@ -24,35 +24,26 @@ module PictureTag
 
       # Syntax this function processes:
       # class="old way" --picture class="new way" --alt Here's my alt text
-      def parse_params(params)
-        params_array = params.split(/\s+--/).map(&:strip)
-
-        # This allows the old tag syntax to work.
-        @content['implicit'] = params_array.shift unless params.strip =~ /^--/
+      def parse_params(words)
+        key = 'implicit'
+
+        words.each do |word|
+          if word.match(/^--/)
+            key = word.delete_prefix('--')
+          elsif @content[key]
+            @content[key] << ' ' + word
+          else
+            @content[key] = word
+          end
+        end
+      end
 
-        # Split function above doesn't take the dashes off the first param.
-        params_array.first.delete_prefix! '--' if params_array.any?
+      def handle_source_url
+        return unless PictureTag.preset['link_source'] && self['link'].nil?
 
-        params_array.each do |param|
-          # Splits on spaces, the first word will be our key.
-          a = param.split
+        target = PictureTag.source_images.first.shortname
 
-          # Supplied tag arguments will overwrite (not append) configured values
-          @content[a.shift] = a.join(' ')
-        end
-      end
-      # Handles anchor tag destination. Can come from 2 places in 2 formats:
-      # Can come from defaults, preset, or tag
-      # Default is false. Preset can specify either true or false
-      # Tag params can be a URL
-
-      # picture test.jpg --url http://example.com
-      def handle_url
-        return unless PictureTag.preset['link_source'] && !self['link']
-
-        @content['link'] = PictureTag.build_source_url(
-          Utils.biggest_source.shortname
-        )
+        @content['link'] = ImgURI.new(target, source_image: true).to_s
       end
     end
   end

data/lib/jekyll_picture_tag/instructions/preset.rb

@@ -3,8 +3,8 @@ module PictureTag
     # Handles the specific tag image set to construct.
     class Preset
       attr_reader :name
-      def initialize
-        @name = PictureTag.preset_name
+      def initialize(name)
+        @name = name
         @content = build_preset
       end
 
@@ -19,8 +19,12 @@ module PictureTag
         width_hash[media]
       end
 
+      def formats
+        @content['formats']
+      end
+
       def fallback_format
-        PictureTag::Utils.process_format(@content['fallback_format'], nil)
+        @content['fallback_format']
       end
 
       def fallback_width
@@ -37,6 +41,13 @@ module PictureTag
         end
       end
 
+      def quality(format = nil)
+        qualities = @content['format_quality'] || {}
+        qualities.default = @content['quality']
+
+        qualities[format]
+      end
+
       private
 
       def build_preset

data/lib/jekyll_picture_tag/instructions/set.rb

@@ -0,0 +1,61 @@
+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 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
+
+      # 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
+    end
+  end
+end