jekyll-favicon 0.2.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9a26244efba01eb17a573ec4a428b4e1bed2973e669badf94564859ef697d37
-  data.tar.gz: ed93b2721f0e43049e0278c5aead9341f7b70dfaf4a9ec7d808d3e05147b2504
+  metadata.gz: 24f6bd5b0b3ce385c2ba309344e5852a5e0766121fd7b8e5b5692b2fbf57a719
+  data.tar.gz: fb9071c07d3a9319454ff68f1bf4203971ac56e0abfc51890269647e1f6b6500
 SHA512:
-  metadata.gz: 7d3a3aa37c9cebdf52c449086327975cc174cafa992e4d2ccd8d92a26deb7e1d788719745100117583773e41de68de724813ad9548d053884eeb6c606478183f
-  data.tar.gz: 93deb56d63effb0547b32f534d65a6e2fd385eb602ed626dbd52ec2faaefacd211dccd2decde87bf92478ff10c88a03176007edd4bb35d859ebadf676e7d178c
+  metadata.gz: 8959b2b93e8d89f97ea4b62a307e700d74fa60e75f8a807886cb0b3d9f607aed3d8a876181039bec09e30ad78dda561a715d4c7c1ce3222141d145b28d51cdbe
+  data.tar.gz: 8c45c622de3aa0b7beb0d2d2680e9c2539028901a5e73d1ca9d42c09b509132679cf1af9576a83e0ba1db9fc16918de0c44f0c375b7f8ec59ea876f051dba07a

data/.devcontainer/Dockerfile

@@ -0,0 +1,22 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6, 2.5
+ARG VARIANT="3"
+FROM mcr.microsoft.com/vscode/devcontainers/ruby:0-${VARIANT}
+
+# [Option] Install Node.js
+ARG INSTALL_NODE="true"
+ARG NODE_VERSION="lts/*"
+RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
+
+# [Optional] Uncomment this section to install additional OS packages.
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+    && 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
+
+# [Optional] Uncomment this line to install global node packages.
+# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

data/.devcontainer/devcontainer.json

@@ -0,0 +1,42 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.162.0/containers/ruby
+{
+	"name": "Ruby",
+	"build": {
+		"dockerfile": "Dockerfile",
+		"args": { 
+			// Update 'VARIANT' to pick a Ruby version: 3, 3.0, 2, 2.7, 2.6, 2.5
+			"VARIANT": "3",
+			// Options
+			"INSTALL_NODE": "false",
+			"NODE_VERSION": "lts/*"
+		}
+	},
+
+	// Set *default* container specific settings.json values on container create.
+	"settings": {
+		"terminal.integrated.profiles.linux": {
+			"zsh (login)": {
+				"path": "zsh",
+				"args": [
+					"-l"
+				]
+			}
+		}
+	},
+
+	// Add the IDs of extensions you want installed when the container is created.
+	"extensions": [
+		"rebornix.Ruby"
+	],
+	
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "bundle install",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -5,12 +5,12 @@
   - how you did it (use Markdown and screenshots if needed)
 
 - Did you...
-  - [ ] update the Readme? (if needed)
-  - [ ] update the Changelog? (if needed)
+  - [ ] update the README? (if needed)
+  - [ ] update the CHANGELOG? (if needed)
   - [ ] update the tests?
   - [ ] run the tests?
-  - [ ] check rubocop?
+  - [ ] check with Rubocop?
 
-Don't forget to visit [travis-ci](https://travis-ci.org/afaundez/jekyll-favicon/pull_requests) after creating the PR.
+Don't forget to visit the [GitHub Action workflows](https://github.com/afaundez/jekyll-favicon/actions) after creating the PR.
 
 Thanks for contributing!

data/.github/workflows/gem-push.yml

@@ -1,4 +1,4 @@
-name: Ruby Gem
+name: Gem Push
 
 on:
   release:
@@ -11,10 +11,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby 2.5
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.5.x
 
     - name: Publish to GPR
       run: |

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  push:
+    branches: [ main, next, update-ci ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    env:
+      BUNDLE_GEMFILE: test/gemfiles/${{ matrix.gemfile }}.gemfile
+    
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Run tests with ${{ matrix.gemfile }}
+      run: bundle exec rake
+
+    strategy:
+      matrix:
+        exclude:
+        - ruby-version: '3.0'
+          gemfile: jekyll36
+        - ruby-version: '3.0'
+          gemfile: jekyll37
+
+        gemfile: [ jekyll36, jekyll37, jekyll38, jekyll39, jekyll40, jekyll41, jekyll42 ]
+        os: [ ubuntu-latest ]
+        ruby-version: [ 2.6, 2.7, '3.0' ]

data/.gitignore

@@ -6,4 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+.jekyll-cache
+.ruby-version
 *.gem
+Gemfile.lock
+*.gemfile.lock
+.DS_Store

data/.reek.yml

@@ -0,0 +1,25 @@
+---
+detectors:
+  ControlParameter:
+    exclude:
+      - "Jekyll::Favicon::StaticFile::Convertible#write" # overrides Jekyll::StaticFile method
+  UtilityFunction:
+    exclude:
+      - "Jekyll::Favicon::Generator#generate" # overrides Jekyll::Generator method
+      - "Jekyll::Favicon::Tag#render" # overrides Liquid::Tag method
+      - "Jekyll::Favicon::Utils::Configuration::Compact::ClassMethods#compact" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Configuration::Merge::ClassMethods#merge" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Configuration::Patch::ClassMethods#patch" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Convert::ClassMethods#convert" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Tag::ClassMethods#build_element" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Tag::ClassMethods#build_tag" # TODO: refactor
+      - "Jekyll::Favicon::Utils::Tag::ClassMethods#mutate_element" # TODO: refactor
+  NestedIterators:
+    exclude:
+      - "fixture"
+directories:
+  "test/unit":
+    InstanceVariableAssumption:
+      enabled: false
+    TooManyMethods:
+      enabled: false

data/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+
+        {
+            "name": "jekyll serve",
+            "type": "Ruby",
+            "cwd": "${workspaceRoot}",
+            "request": "launch",
+            "program": "bin/debug"
+        }
+    ]
+}

data/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "ruby.lint": {
+        "reek": true,
+        "standard": true
+    },
+    "ruby.useLanguageServer": true
+}

data/.vscode/tasks.json

@@ -0,0 +1,15 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "rake",
+			"task": "test",
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"problemMatcher": [],
+			"label": "rake: test"
+		}
+	]
+}

data/CHANGELOG.md

@@ -4,7 +4,29 @@ 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.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
+- fix SVG to PNG quality
+### Removed
+- Delete Gemfile.lock
+- Delete .ruby-version
+- Remove unsupported versions from travis config
+- Remove bundler and rubocop gemspec's development dependencies
+- Remove graphicmagick from travis config
+- Remove travis-ci config
+- Remove nokogiri gemspec development dependency
 
 ## [0.2.9] - 2021-02-10
 ### Added

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/README.md

@@ -2,61 +2,64 @@
 
 This [Jekyll](https://jekyllrb.com) plugin adds:
 
-- a generator for
-  - a `favicon.ico`
-  - multiple `favicon-[width]x[height].png`
-  - 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.0
 
 ## Prerequisites
 
-Before using this plugin your system must have installed [ImageMagick](http://www.imagemagick.org) ~~(or [GraphicsMagick](http://www.graphicsmagick.org/))~~.
+### [ImageMagick](http://www.imagemagick.org)
 
 Check if it is already installed by running:
 
 ```sh
-$ convert --version
+$ convert --version | grep Version
 Version: ImageMagick 7.0.8-46 Q16 x86_64 2019-05-19 https://imagemagick.org
-Copyright: © 1999-2019 ImageMagick Studio LLC
-License: https://imagemagick.org/script/license.php
-Features: Cipher DPC HDRI Modules OpenMP(3.1)
-Delegates (built-in): bzlib freetype heic jng jp2 jpeg lcms ltdl lzma openexr png tiff webp xml zlib
 ```
 
-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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jekyll-favicon', '~> 0.2.9', group: :jekyll_plugins
+gem 'jekyll-favicon', '~> 1.0.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/).
+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.
+
+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).
 
-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).
 
 ### Generator
 
-By installing the plugin, it will be automatically activated. It will search for the file `/favicon.svg` and generate a set of files in `/assets/images` and few more items at the site's root. It also will exclude the original sources from being copied as a regular static file.
+By installing the plugin, it will be automatically activated without further configurations.
 
-You can override these settings in your sites's `_config.yml`:
+You can override these settings in your sites's `_config.yml`. The simplest configuration would be this:
 
 ```yaml
 favicon:
   source: custom-favicon-png-or.svg
-  path: /assets/img
 ```
 
-This plugin works best if you use an SVG with a square viewbox as the source, but you can also use a PNG instead (at least 558x588). Check [favicon.svg](/test/fixtures/sites/minimal/favicon.svg) as an example.
+This plugin works best if you use an SVG with a square viewbox as the source, but you can also use a PNG instead (at least 558x588). Check the fixtures [favicon.svg](test/fixtures/favicon.svg) or [favicon.png](test/fixtures/favicon.png) as examples.
 
 ### Favicon tag
 
@@ -71,29 +74,73 @@ To get the links and meta, just add the favicon tag `{% favicon %}`. For example
     {% favicon %}
   </head>
   <body>
-    <h1>Jekyll Favicon</h1>
   </body>
 </html>
 ```
 
-#### Unusual situations
+## Configuration
 
-If your site is deployed in an unusual way, such as behind HTTP Basic Auth, it might be necessary to specify a `crossorigin` attribute for the webmanifest `<link>` tag:
+The plugin customization goes in the `favicon` key in the `_config.yml` file. There are four key parameters:
 
-```yaml
-favicon:
-  chrome:
-    crossorigin: "use-credentials"
-```
+| attribute name | type        | default                                                                                                                                                                                                                 | description                                                                                                              |
+|----------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
+| source         | hash/string | <div class="highlight highlight-source-yaml position-relative"><pre><span class="pl-ent">name</span>: <span class="pl-s">favicon.svg</span><br><span class="pl-ent">dir</span>: <span class="pl-s">.</span></pre></div> | SVG or PNG file relative to site's source. Any favicon without explicit source will use this attribute as default.       |
+| background     | string      | `transparent`                                                                                                                                                                                                           | Color keyword or Hex representation. Any favicon without explicit convert background will use this attribute as default. |
+| dir            | string      | `.`                                                                                                                                                                                                                     | Path relative to site's source. Any favicon without explicit source dir will use this attribute as default.              |
+| assets         | array       | see [defaults](config/jekyll/favicon.yml)                                                                                                                                                                               | Array of asset configuration. Any asset define here will be controlled with this plugin.                                 |
+
+### Assets
+
+The assets is an array of file spec:
+
+| attribute name | type          | default     | description                                |
+|----------------|---------------|-------------|--------------------------------------------|
+| name           | string        |             | file's basename. Required.                 |
+| dir            | string/symbol | `:site_dir` | file's dir, relative to site's destination |
+| source         | hash          |             | file's source. Required.                   |
+| convert        | hash          | `{}`        | see [convert defaults](#convert)           |
+| tags           | array         | `[]`        | see [tags defaults](#tags)                 |
+| refer          | hash          | `[]`        | see [refer defaults](#refer)               |
+
+Symbol values:
+
+- `:background`: favicon's global background
+- `:site_dir`: favicon's global dir
+- `:href`: favicons absolute URL path
+
+#### Convert
+
+The convert configuration is specific for each type of convertion: SVG to ICO/PNG/SVG and PNG to ICO/PNG.
+
+| attribute name | type          | default                                                                 | description                                                                                           |
+|----------------|---------------|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
+| 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)         |      |
+| 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)         |
+| 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:
+
+- `:auto`: if sizes is not a square, then sizes
+- `:max`: 3 times the largest dimension
+
+#### Tags
+
+The tags configuration is a list of hashes with only one key, `link` or `meta`, and only one value, a hash with the HTML attributes associated to the key. See [tags defaults](config/jekyll/favicon/static_file/taggable.yml) for more details.
+
+#### Refer
+
+The refer configuration is a list of hashes with only one key, `webmanifest` or `browserconfig`, and only one value, a hash that will override the associated file. See [refer defaults](config/jekyll/favicon/static_file/referenceable.yml) for more details.
 
 ## Development
 
 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 hard coded 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
 
@@ -101,11 +148,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/afaund
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Jekyll Favicon project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/afaundez/jekyll-favicon/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Jekyll Favicon project’s codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/afaundez/jekyll-favicon/blob/master/CODE_OF_CONDUCT.md).
 
 ## Acknowledgments