jekyll_picture_tag 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57fe7741c94cf1511eb8824dec643e9acb953b3251b2714b030e662742d62680
-  data.tar.gz: fcfae3154dcfe87509bc4759171ab6f2a27636ab75d6ec20d24b335f8535dc8c
+  metadata.gz: 46fd8634e4d9eff8493b340560d84e8a398eb77db81a511529f0b670f111de7c
+  data.tar.gz: 103f00baec1839e018094b5c3d3522ecff13849e3bda46353ddde9e70e2040fb
 SHA512:
-  metadata.gz: af9a456fb275f80eedff3c26a1579c3ce95b2385fd66f1a7e203947de2e16deea596f2e6a1334f5cb475e4d61c26803569bd522a84356a574b826cc071961fa3
-  data.tar.gz: a6fb8984f4fe3b02564a60038d77136d15c5fd1625a1e8b5f654b656494eb8e9b1f7f497436145253e8f241d5cb902243df37ff38511a05b742c5c2de1c5730d
+  metadata.gz: 14afd21d6a1cd36bac48b20e79047e1df845b458e763d0eb590125fa45dd2eef431cc27836f22073878d807dc5118787f40fe8b2ffc15579bd6edf4c70f0411b
+  data.tar.gz: bd9131318cd312b340ff337db88127c9b8b14f78c2bfc64ec04dd6f9d27db87a08d36a59bf5aa550f51ede5c2a6b9cdda8554c60f2cecc64db5e914a1f28a84f

data/.rubocop.yml

@@ -1,6 +1,81 @@
+# Disabled
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-AllCops:
-  NewCops: enable
-  
+Style/StringConcatenation:
+  Enabled: false
+
+# New cops, enabled. We aren't using the 'NewCops' setting because then rubocop
+# updates can break our CI.
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true

data/docs/devs/releases.md

@@ -1,6 +1,12 @@
 ---
 ---
 # Release History
+* 1.13.0 November 23, 2020
+  * Add image quality interpolation; allows for variable image quality based on image size.
+  * Bugfix: Perform format, resize, and quality changes simultaneously rather than individually.
+    * Allows for actual lossless webp: simply set quality to 100.
+    * Improves fresh (no cached images) build times by ~15%
+    * Fix problems with poor image quality.
 * 1.12.0 July 30, 2020
   * Documentation overhaul. Now with 87% less scrolling!
   * Rename `markup_presets` and `media_presets` to `presets` and

data/docs/users/liquid_tag/examples.md

@@ -35,6 +35,18 @@
   ```
   {% picture blog_index {{ post.image }} --link {{ post.url }} %}
   ```
+    N.B. If the image path is coming from a liquid variable then you have two problems to guard against.
+    * __Spaces__: you need to wrap the inner tag in "" to stop a path with spaces being interpretted as two or more arguments:
+    ```
+    {% picture blog_index "{{ post.image }}" %}
+    ```
+    * __Nulls & Blanks__: you need to wrap whole tag in a logic block to stop an uncaught Liquid exception:
+    ```
+    {% if post.image && post.image != "" %} 
+      {% picture blog_index "{{ post.image }}" %}
+    {% endif %}
+    ```
+  
 
   * Add arbitrary HTML attributes:
   ```

data/docs/users/presets/cropping.md

@@ -23,10 +23,10 @@ _Format:_
 _Example:_
 
 ```yaml
-    crop: 16:9
+    crop: '16:9'
     media_crop:
-      tablet: 3:2
-      mobile: 1:1
+      tablet: '3:2'
+      mobile: '1:1'
 ```
 
 Crop geometry, given either generally or for specific media presets. The

data/docs/users/presets/image_quality.md

@@ -4,16 +4,61 @@ sort: 6
 
 # Image Quality
 
+Image quality can be as simple as a constant for all images, or can be varied based on image width
+and output format.
+
+```note
+For lossless webp images, set quality to 100.
+```
+
+
 ## Quality
 
+### Constant
+
   _Format:_ `quality: 0 <= integer <= 100`
 
   _Example:_ `quality: 80`
 
   _Default:_ `75`
 
-  Specify an image compression level for all image formats (where it makes
-  sense, anyway).
+  Specify an image compression level for all widths, all image formats.
+
+### Variable
+
+  _Format:_ 
+
+```yaml
+  quality: 
+    (image width): (quality setting)
+    (image width): (quality setting) 
+```
+
+  _Example:_ 
+
+```yaml
+  quality: 
+    1000: 65
+    300: 100
+```
+
+Set a variable image quality, based on image width. Provide exactly 2 image widths and associated
+quality settings. Quality will be calculated as follows:
+
+  * For images smaller than the lowest image width, the setting for the lowest width is used. 
+  * For images larger than the highest image width, the setting for the highest width is used. 
+  * For images in between the 2, the quality setting will be linearly interpolated to some value in
+    between.
+
+  ![](quality_width_graph.png)
+
+Using this setting, you can get away with more compression on high pixel density screens without
+sacrificing image quality for low-density screens. Taking the example settings above:
+
+  * A 1500px image will use a quality of 65.
+  * A 200px image will use a quality of 100.
+  * A 500px image will use a quality of 90.
+
 
 ## Format Quality
 
@@ -25,6 +70,14 @@ sort: 6
     (...)
   ```
 
+  ```yaml
+    format_quality: 
+      (format):
+        (image width): (quality setting)
+        (image width): (quality setting) 
+  ```
+
+
   _Example:_
 
   ```yaml
@@ -34,10 +87,19 @@ sort: 6
     webp: 55
   ```
 
+  ```yaml
+    format_quality: 
+      jpg:
+        1000: 65
+        300: 100
+      (...)
+  ```
+
   _Default:_ quality setting
 
-  Specify quality settings for various image formats, allowing you to take
-  advantage of webp's better compression algorithm without trashing your jpg
-  images (for example). If you don't give a setting for a particular format
-  it'll fall back to the `quality` setting above, and if you don't set _that_
-  it'll default to 75.
+  Specify quality settings for various image formats, allowing you to take advantage of webp's
+  better compression algorithm without trashing your jpg images (for example). If you don't give a
+  setting for a particular format it'll fall back to the `quality` setting above, and if you don't
+  set _that_ it'll default to 75. 
+
+  Note that this setting can accept the same variable quality setting format as the basic `quality` setting.

data/jekyll_picture_tag.gemspec

@@ -33,14 +33,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'nokogiri', '~> 1.10'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '~> 0.8'
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'solargraph'
 
   spec.add_dependency 'addressable', '~> 2.6'
-  spec.add_dependency 'mime-types', '~> 3'
-  spec.add_dependency 'mini_magick', '~> 4'
-  spec.add_dependency 'objective_elements', '~> 1.1.2'
+  spec.add_dependency 'mime-types', '~> 3.0'
+  spec.add_dependency 'mini_magick', '~> 4.0'
+  spec.add_dependency 'objective_elements', '~> 1.1'
 
   spec.add_runtime_dependency 'jekyll', '< 5'
 end

data/lib/jekyll_picture_tag.rb

@@ -1,15 +1,13 @@
 require 'jekyll'
 require 'objective_elements'
 
-require_relative 'jekyll_picture_tag/generated_image'
+require_relative 'jekyll_picture_tag/cache'
+require_relative 'jekyll_picture_tag/images'
 require_relative 'jekyll_picture_tag/instructions'
 require_relative 'jekyll_picture_tag/output_formats'
-require_relative 'jekyll_picture_tag/source_image'
+require_relative 'jekyll_picture_tag/router'
 require_relative 'jekyll_picture_tag/srcsets'
 require_relative 'jekyll_picture_tag/utils'
-require_relative 'jekyll_picture_tag/img_uri'
-require_relative 'jekyll_picture_tag/router'
-require_relative 'jekyll_picture_tag/cache'
 
 # Title: Jekyll Picture Tag
 # Authors: Rob Wierzbowski   : @robwierzbowski

data/lib/jekyll_picture_tag/images.rb

@@ -0,0 +1,3 @@
+require_relative 'images/generated_image'
+require_relative 'images/img_uri'
+require_relative 'images/source_image'

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

@@ -35,8 +35,8 @@ module PictureTag
       @name ||= "#{@source.base_name}-#{@width}-#{id}.#{@format}"
     end
 
-    # https://example.com/assets/images/myimage-100-123abc.jpg
-    #                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+    # https://example.com/assets/somefolder/myimage-100-123abc.jpg
+    #                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
     def uri
       ImgURI.new(name).to_s
     end
@@ -103,25 +103,8 @@ module PictureTag
 
     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
+      image.format(@format, 0, { resize: "#{@width}x", quality: quality })
       FileUtils.mkdir_p(File.dirname(absolute_filename))
 
       image.write absolute_filename
@@ -129,6 +112,10 @@ module PictureTag
       FileUtils.chmod(0o644, absolute_filename)
     end
 
+    def quality
+      PictureTag.quality(@format, @width)
+    end
+
     def process_format(format)
       if format.casecmp('original').zero?
         @source.ext

data/lib/jekyll_picture_tag/instructions/preset.rb

@@ -40,9 +40,24 @@ module PictureTag
         setting_lookup('widths', 'media', media)
       end
 
-      # Image quality setting, possibly dependent on format.
-      def quality(format = nil)
-        setting_lookup('quality', 'format', format)
+      # Image quality setting. Surprisingly complicated; can depend on both format and width.
+      def quality(format = nil, width = nil)
+        setting = setting_lookup('quality', 'format', format)
+
+        return setting unless setting.is_a? Hash
+
+        parse_quality_hash(setting, width)
+      end
+
+      def parse_quality_hash(points, width)
+        # The points can be given in any order.
+        low, high = *points.keys.map(&:to_i).sort
+
+        case width
+        when 0..low then points[low]
+        when low..high then Utils.interpolate(points.keys, points.values, width)
+        when high..999_999 then points[high]
+        end
       end
 
       # Gravity setting (for imagemagick cropping)

data/lib/jekyll_picture_tag/router.rb

@@ -108,8 +108,8 @@ module PictureTag
       preset.nomarkdown?
     end
 
-    def quality(format)
-      preset.quality(format)
+    def quality(format, width)
+      preset.quality(format, width)
     end
   end
 end

data/lib/jekyll_picture_tag/utils.rb

@@ -63,6 +63,20 @@ module PictureTag
       def titleize(input)
         input.split('_').map(&:capitalize).join
       end
+
+      # Linear interpolator. Pass it 2 values in the x array, 2 values
+      # in the y array, and an x value, returns a y value.
+      def interpolate(xvals, yvals, xval)
+        xvals.map!(&:to_f)
+        yvals.map!(&:to_f)
+
+        # Slope
+        m = (yvals.last - yvals.first) / (xvals.last - xvals.first)
+        # Value of y when x=0
+        b = yvals.first - (m * xvals.first)
+        # y = mx + b
+        (m * xval) + b
+      end
     end
   end
 end

data/lib/jekyll_picture_tag/version.rb

@@ -1,3 +1,3 @@
 module PictureTag
-  VERSION = '1.12.0'.freeze
+  VERSION = '1.13.0'.freeze
 end

data/readme.md

@@ -39,24 +39,21 @@ https://rbuchberger.github.io/jekyll_picture_tag/
 
 ## Changelog:
 
-https://rbuchberger.github.io/jekyll_picture_tag/releases
+https://rbuchberger.github.io/jekyll_picture_tag/devs/releases
 
 Latest versions: 
 
-* 1.10.1 July 2, 2020
-  * Bugfix for erroneously regenerated images
-* 1.10.2 July 6, 2020
-  * Bugfix for fallback image files not actually getting generated
-* 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.13.0 November 23, 2020
+  * Add image quality interpolation; allows for variable image quality based on image size.
+  * Bugfix: Perform format, resize, and quality changes simultaneously rather than individually.
+    * Allows for actual lossless webp: simply set quality to 100.
+    * Improves fresh (no cached images) build times by ~15%
+    * Fix problems with poor image quality.
 
 ## Help Wanted
 
 Writing code is only part of the job; often the harder part is knowing what needs to be changed. Any
 and all feedback is greatly appreciated, especially in regards to documentation. What are your pain
 points? See the [contributing
-guidelines](https://rbuchberger.github.io/jekyll_picture_tag/contributing), or the
+guidelines](https://rbuchberger.github.io/jekyll_picture_tag/devs/contributing), or the
 [issues](https://github.com/rbuchberger/jekyll_picture_tag/issues) page for more.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_picture_tag
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Robert Wierzbowski
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-29 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,16 +100,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -158,42 +158,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: objective_elements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.2
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -284,6 +284,7 @@ files:
 - docs/users/presets/media_queries.md
 - docs/users/presets/nomarkdown_override.md
 - docs/users/presets/pixel_ratio_srcsets.md
+- docs/users/presets/quality_width_graph.png
 - docs/users/presets/width_height_attributes.md
 - docs/users/presets/width_srcsets.md
 - jekyll-picture-tag.gemspec
@@ -296,8 +297,10 @@ files:
 - lib/jekyll_picture_tag/cache/source.rb
 - lib/jekyll_picture_tag/defaults/global.yml
 - lib/jekyll_picture_tag/defaults/presets.yml
-- lib/jekyll_picture_tag/generated_image.rb
-- lib/jekyll_picture_tag/img_uri.rb
+- lib/jekyll_picture_tag/images.rb
+- lib/jekyll_picture_tag/images/generated_image.rb
+- lib/jekyll_picture_tag/images/img_uri.rb
+- lib/jekyll_picture_tag/images/source_image.rb
 - lib/jekyll_picture_tag/instructions.rb
 - lib/jekyll_picture_tag/instructions/arg_splitter.rb
 - lib/jekyll_picture_tag/instructions/configuration.rb
@@ -318,7 +321,6 @@ files:
 - lib/jekyll_picture_tag/output_formats/picture.rb
 - lib/jekyll_picture_tag/output_formats/readme.md
 - lib/jekyll_picture_tag/router.rb
-- lib/jekyll_picture_tag/source_image.rb
 - lib/jekyll_picture_tag/srcsets.rb
 - lib/jekyll_picture_tag/srcsets/basic.rb
 - lib/jekyll_picture_tag/srcsets/pixel_ratio.rb