jekyll-favicon 1.0.0.pre.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19375fbd665cb27681d89f590ee75312136a775d623beec4303e42e974f60636
-  data.tar.gz: d72579b9e971436a3774bdcbf6d20bb1457f50f4e6e682648c85d6434efb3326
+  metadata.gz: 5fefe82f2a327fcfc67e7f5fbee4fbdd14d95f00f4f03da72716c5c92fdd8102
+  data.tar.gz: e147f09714c3d78304c9138a3ef15c0720c1bdbf5d1073f3367a72d7ee4bc24d
 SHA512:
-  metadata.gz: efaf8c6a2e8e2a09ef3e52c7e3f128c5fa6cb3326dcc7a439b6aab4514e6e88d5581f218112e69dbe124a0d0434f49e12d9c92d25f892e4760193cbf5a77e30d
-  data.tar.gz: c21ad3577929122b8b83bd9befc63ed9abe58a6c48c949d6203acbe656fecb3303c15502982146bcb341d5a4bad4d14fc673ac1603d0ed723aaa21c792ccd77c
+  metadata.gz: 922f114d55014a2d0bd30973822a43c736d011d641bcdcb3c153e54c350526ea7ac0268a89d608e422d7ce7eeb324442da6b8adb7af82344a32ff58892520b7f
+  data.tar.gz: adb2ccbdf4659c83916e7bb2d00b308b8b700dd9f5cab297491c6d3d88842a6f721c854ba5d648bf83fb6a45265bcd6a1c19f8e42e28cb5b8eadce7243fc8970

data/.devcontainer/Dockerfile

@@ -11,7 +11,9 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l
 
 # [Optional] Uncomment this section to install additional OS packages.
 RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
-    && apt-get -y install --no-install-recommends imagemagick librsvg2-bin
+    && apt-get -y install librsvg2-bin
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && apt-get -y install imagemagick
 
 # [Optional] Uncomment this line to install additional gems.
 RUN gem install reek standard webrick

data/.github/workflows/test.yml

@@ -32,7 +32,11 @@ jobs:
           gemfile: jekyll36
         - ruby-version: '3.0'
           gemfile: jekyll37
+        - ruby-version: '3.1'
+          gemfile: jekyll36
+        - ruby-version: '3.1'
+          gemfile: jekyll37
 
         gemfile: [ jekyll36, jekyll37, jekyll38, jekyll39, jekyll40, jekyll41, jekyll42 ]
         os: [ ubuntu-latest ]
-        ruby-version: [ 2.6, 2.7, '3.0' ]
+        ruby-version: [ 2.6, 2.7, '3.0', '3.1' ]

data/.gitignore

@@ -11,3 +11,4 @@
 *.gem
 Gemfile.lock
 *.gemfile.lock
+.DS_Store

data/CHANGELOG.md

@@ -4,13 +4,27 @@ All notable changes to Jekyll-Favicon will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.1.0] - 2022-07-31
+### Added
+- Enable aliases when loading YAML
+### Fixed
+- Ruby 3.x kwargs compatibility 
 
-## [1.0.0.pre.2] - 2021-06-11
+## [1.0.0] - 2021-08-13
+### Added
+- gitignore Gemfile.lock
+- gitignore .jekyll-cache
+- Add Test github action workflow
+- Regenration
+### Changed
+- Move supported ruby versions to 2.5
+- Update nokogiri, minitest, and minitest-hooks gemspec's development dependencies
+- Update mini_magick gemspec's runtime dependencies
+- Update travis rvm versions
+- Rename Gem Push github action workflow
 ### Fixed
 - mime time error when starting new project
-
-## [1.0.0.pre.1] - 2021-05-26
+- fix SVG to PNG quality
 ### Removed
 - Delete Gemfile.lock
 - Delete .ruby-version
@@ -19,17 +33,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Remove graphicmagick from travis config
 - Remove travis-ci config
 - Remove nokogiri gemspec development dependency
-### Changed
-- Move supported ruby versions to 2.5
-- Update nokogiri, minitest, and minitest-hooks gemspec's development dependencies
-- Update mini_magick gemspec's runtime dependencies
-- Update travis rvm versions
-- Rename Gem Push github action workflow
-### Added
-- gitignore Gemfile.lock
-- gitignore .jekyll-cache
-- Add Test github action workflow
-- Regenration
 
 ## [0.2.9] - 2021-02-10
 ### Added

data/README.md

@@ -2,17 +2,17 @@
 
 This [Jekyll](https://jekyllrb.com) plugin adds:
 
-- a generator for
-  - an ICO favicon
-  - PNG favicons
-  - SVG favicons
-  - a [webmanifest](https://developer.mozilla.org/en-US/docs/Web/Manifest)
-  - a [browser configuration schema](https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426%28v=vs.85%29)
-- a tag to generate all the corresponding links and metadata needed in the head tag
+- a generator for favicons (ICO, PNG, SVG), [webmanifests]((https://developer.mozilla.org/en-US/docs/Web/Manifest)), and [browserconfig]((https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426%28v=vs.85%29)) files
+- a tag for the rendinering of all the corresponding links and metadata needed
+
+Tested with:
+
+- Jekyll 3.6 to 3.7, ruby 2.6 to 2.7
+- Jekyll 3.8 to 4.2, ruby 2.6 to 3.1
 
 ## Prerequisites
 
-This plugin assumes you have [ImageMagick](http://www.imagemagick.org) installed.
+### [ImageMagick](http://www.imagemagick.org)
 
 Check if it is already installed by running:
 
@@ -21,12 +21,16 @@ $ convert --version | grep Version
 Version: ImageMagick 7.0.8-46 Q16 x86_64 2019-05-19 https://imagemagick.org
 ```
 
-If you have a [problem converting SVG files](https://github.com/afaundez/jekyll-favicon/issues/9#issuecomment-473862194), you may need to install the package `librsvg2-bin`. For example, in Ubuntu/Debian systems:
+### [librsvg](https://gitlab.gnome.org/GNOME/librsvg) (optional)
+
+If you are having pixeled icons or if you have a [problem converting SVG files](https://github.com/afaundez/jekyll-favicon/issues/9#issuecomment-473862194), you may need to install the package `librsvg2-bin`. For example, in Ubuntu/Debian systems:
 
 ```sh
 sudo apt install librsvg2-bin
 ```
 
+You may need to install `librsvg` before installing the RSVG renderer.
+
 Check the devcontainer's [Dockerfile](.devcontainer/Dockerfile) for more practical details.
 
 ## Installation
@@ -34,19 +38,15 @@ Check the devcontainer's [Dockerfile](.devcontainer/Dockerfile) for more practic
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jekyll-favicon', '~> 1.0.0.pre.2', group: :jekyll_plugins
+gem 'jekyll-favicon', '~> 1.1.0', group: :jekyll_plugins
 ```
 
 ## Usage
 
-If you are going to use this plugin in a hosted build/service, be sure that they include your plugins as part of the process. You can check [this running example](https://afaundez.gitlab.io/jekyll-favicon-example/) hosted by [GitLab](https://about.gitlab.com/features/pages/).
-
-As [Github Pages](https://pages.github.com) build doesn't load custom plugins, this plugin won't work. As an alternative, you can build your site and push all files (for example, build to `docs`, version it and push it, although this works only for project pages).
+If you are going to use this plugin in a hosted build/service, be sure that they include your plugins as part of the process. You can check [gh-pages](/afaundez/jekyll-favicon/tree/gh-pages) branch for a working example.
 
-Tested with:
+As [Github Pages](https://pages.github.com) doesn't load custom plugins, this plugin won't be included on the build process. As a workaround, you can build your site and push all files (for example, build to `docs`, version it and push it, although this works only for project pages).
 
-- Jekyll 3.6 to 3.7, ruby 2.6 to 2.7
-- Jekyll 3.8 to 4.2, ruby 2.6 to 3.0
 
 ### Generator
 
@@ -116,12 +116,11 @@ The convert configuration is specific for each type of convertion: SVG to ICO/PN
 |----------------|---------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
 | alpha          | string        | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick alpha docs](https://imagemagick.org/script/command-line-options.php#alpha)           |
 | background     | string/symbol | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick background docs](https://imagemagick.org/script/command-line-options.php#background) |
-| define         | string/symbol | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick define docs](https://imagemagick.org/script/command-line-options.php#define)         |
-| density        | string/symbol | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick density docs](https://imagemagick.org/script/command-line-options.php#density)       |
+| define         | string/symbol | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick define docs](https://imagemagick.org/script/command-line-options.php#define)         |      |
 | extent         | string/symbol | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick extent docs](https://imagemagick.org/script/command-line-options.php#extent)         |
 | gravity        | string        | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick gravity docs](https://imagemagick.org/script/command-line-options.php#gravity)       |
 | resize         | string        | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick resize docs](https://imagemagick.org/script/command-line-options.php#resize)         |
-| scale          | string        | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick scale docs](https://imagemagick.org/script/command-line-options.php#scale)           |
+| size          | string        | see [convert config](config/jekyll/favicon/static_file/convertible.yml) | see [imagemagick size docs](https://imagemagick.org/script/command-line-options.php#size)           |
 
 Symbol values:
 
@@ -140,10 +139,8 @@ The refer configuration is a list of hashes with only one key, `webmanifest` or
 
 If you want to add something, just make a PR. There is a lot to do:
 
-- Define and check SVG/PNG attributes before execute
-- Review SVG to PNG conversion, it working as it is, but some parameters are hardcoded and may only work with the samples
-- Encapsulate image conversion
-- Tests everywhere
+- Tests more cases
+- Keep updated the favicons and files needed with modern browsers
 
 ## Contributing
 

data/config/jekyll/favicon/static_file/convertible.yml

@@ -3,27 +3,26 @@ defaults: &defaults
   alpha: null
   background: null
   define: null
-  density: null
   extent: null
   gravity: null
   resize: null
-  scale: null
+  size: null
 .svg:
   .png:
     <<: *defaults
     background: :background
-    density: :max
     extent: :auto
     gravity: center
-    scale:
+    resize:
+    size: :auto
   .ico:
     <<: *defaults
     background: :background
     define:
-    density: :max
     extent: :auto
     gravity: center
-    scale:
+    resize:
+    size: :auto
   .svg:
     <<: *defaults
 .png:

data/config/jekyll/favicon.yml

@@ -8,7 +8,7 @@ assets:
   - name: favicon.ico
     convert:
       define: 'icon:auto-resize=36,24,16'
-      scale: 36x36
+      resize: 36x36
     tag:
       - link:
           href: :href
@@ -17,7 +17,7 @@ assets:
           sizes: :sizes
   - name: favicon.png
     convert:
-      scale: 196x196
+      resize: 196x196
     tag:
       - link:
           href: :href
@@ -26,7 +26,7 @@ assets:
           sizes: :sizes
   - name: apple-touch-icon.png
     convert:
-      scale: 180x180
+      resize: 180x180
   - name: safari-pinned-tab.svg
     tag:
       - link:
@@ -35,21 +35,21 @@ assets:
           rel: mask-icon
   - name: android-chrome-192x192.png
     convert:
-      scale: 192x192
+      resize: 192x192
     refer:
       - webmanifest:
           icons:
           - src: :href
   - name: android-chrome-512x512.png
     convert:
-      scale: 512x512
+      resize: 512x512
     refer:
       - webmanifest:
           icons:
           - src: :href
   - name: mstile-icon-128x128.png
     convert:
-      scale: 128x128
+      resize: 128x128
     refer:
       - browserconfig:
           msapplication:
@@ -68,7 +68,7 @@ assets:
 
   - name: mstile-icon-270x270.png
     convert:
-      scale: 270x270
+      resize: 270x270
     refer:
       - browserconfig:
           msapplication:
@@ -79,7 +79,7 @@ assets:
                 _src: :href
   - name: mstile-icon-558x270.png
     convert:
-      scale: 558x270
+      resize: 558x270
     refer:
       - browserconfig:
           msapplication:
@@ -90,7 +90,7 @@ assets:
                 _src: :href
   - name: mstile-icon-558x558.png
     convert:
-      scale: 558x558
+      resize: 558x558
     refer:
       - browserconfig:
           msapplication:

data/lib/jekyll/favicon/configuration/defaults.rb

@@ -24,11 +24,16 @@ module Jekyll
         def self.load_file(*parts)
           path = Favicon::ROOT.join(*parts).to_s
           path = "#{path}.yml"
-          YAML.load_file path
+          # Handle Psych 3 and 4
+          begin
+            YAML.load_file path, aliases: true
+          rescue ArgumentError
+            YAML.load_file path
+          end
         end
 
         def self.define_defaults(base, method_name, &block)
-          base.define_singleton_method("defaults", &block)
+          base.define_singleton_method(:defaults, &block)
           define_method(method_name, &block)
         end
 

data/lib/jekyll/favicon/static_file/convertible.rb

@@ -30,11 +30,22 @@ module Jekyll
           end
         end
 
+        def convert_odd_source?
+          img = MiniMagick::Image.open path
+          Utils.odd? img.dimensions
+        end
+
+        def convert_size(size, separator = "x")
+          return size unless convert_odd_source? || Utils.odd?(size)
+          min_dimension = size.split(separator).min
+          [min_dimension, min_dimension].join(separator)
+        end
+
         def sizes
           if (match = Utils.name_to_size(name)) then [match[1]]
           elsif (define = Utils.define_to_size(convert_spec["define"])) then define
           elsif (resize = convert_spec["resize"]) then [resize]
-          elsif (scale = convert_spec["scale"]) then [scale]
+          elsif (size = convert_spec["size"]) then [size]
           end
         end
 
@@ -88,20 +99,17 @@ module Jekyll
         end
 
         def convert_patch_options(options)
-          %w[density extent].each_with_object(options) do |name, memo|
+          %w[size extent].each_with_object(options) do |name, memo|
             method = "convert_patch_option_#{name}".to_sym
             memo[name] = send(method, options[name])
           end
         end
 
-        def convert_patch_option_density(density)
-          case density
-          when :max
-            length = sizes.collect { |size| size.split("x").collect(&:to_i) }
-              .flatten
-              .max
-            length * 3
-          else density
+        def convert_patch_option_size(size)
+          case size
+          when :auto
+            convert_size size if (size = sizes.first)
+          else size
           end
         end
 

data/lib/jekyll/favicon/static_file/mutable.rb

@@ -15,11 +15,11 @@ module Jekyll
 
         def mutation
           refers = case @extname
-                   when ".xml"
-                     mutation_refers.select { |refer| refer.key? "browserconfig" }
-                   else
-                     mutation_refers.collect { |refer| refer["webmanifest"] }
-                       .compact
+          when ".xml"
+            mutation_refers.select { |refer| refer.key? "browserconfig" }
+          else
+            mutation_refers.collect { |refer| refer["webmanifest"] }
+              .compact
           end
           patch(Utils.merge(*refers) || {})
         end

data/lib/jekyll/favicon/static_graphic_file.rb

@@ -10,7 +10,7 @@ module Jekyll
       include StaticFile::Convertible
 
       def generable?
-        convertible? && super
+        super && convertible?
       end
 
       def patch(configuration)

data/lib/jekyll/favicon/utils/configuration/patch.rb

@@ -12,10 +12,10 @@ module Jekyll
 
           def self.patch_unknown(value_or_values, &block)
             patch_method = case value_or_values
-                           when Array then :patch_array
-                           when Hash then :patch_hash
-                           when Symbol, String then :patch_value
-                           else return value_or_values
+            when Array then :patch_array
+            when Hash then :patch_hash
+            when Symbol, String then :patch_value
+            else return value_or_values
             end
             send patch_method, value_or_values, &block
           end

data/lib/jekyll/favicon/utils/convert.rb

@@ -18,7 +18,7 @@ module Jekyll
         end
 
         def self.convert_options(convert, options = {})
-          priorities = %w[resize scale]
+          priorities = %w[resize size]
           convert_apply convert, options.slice(*priorities)
           common_options = options.reject { |key| priorities.include? key }
           convert_apply convert, common_options

data/lib/jekyll/favicon/utils/tag.rb

@@ -24,7 +24,8 @@ module Jekyll
         def self.mutate_iterator(key, value, memo)
           if key.start_with? "__" then memo.text = value
           elsif key.start_with? "_" then memo.add_attribute key[1..], value
-          else Tag.mutate_xml Tag.mutate_find_or_create_element(memo, key), value
+          else
+            Tag.mutate_xml Tag.mutate_find_or_create_element(memo, key), value
           end
         end
 
@@ -45,7 +46,8 @@ module Jekyll
           if key.start_with? "__" then memo.text = value
           elsif (child_key = key.match(/^_(.*)$/))
             memo.add_attribute child_key[1], value
-          else build_xml key, memo, value
+          else
+            build_xml key, memo, value
           end
         end
 

data/lib/jekyll/favicon/utils.rb

@@ -38,6 +38,11 @@ module Jekyll
         compactable = hash.slice(*keys)
         Utils.compact compactable
       end
+
+      def self.odd?(size, separator = "x")
+        size = size.split(separator) if size.is_a? String
+        size.uniq.size == 1
+      end
     end
   end
 end

data/lib/jekyll/favicon/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Favicon
-    VERSION = "1.0.0-2"
+    VERSION = "1.1.0"
   end
 end

data/lib/jekyll/favicon.rb

@@ -20,8 +20,8 @@ module Jekyll
 
     def self.build_asset(site, attributes)
       asset_class = case File.extname attributes["name"]
-                    when ".ico", ".png", ".svg" then StaticGraphicFile
-                    when ".webmanifest", ".json", ".xml" then StaticDataFile
+      when ".ico", ".png", ".svg" then StaticGraphicFile
+      when ".webmanifest", ".json", ".xml" then StaticDataFile
       end
       asset_class&.new site, attributes
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-favicon
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Alvaro Faundez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-11 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -195,9 +195,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6.3