jekyll-favicon 0.2.5 → 1.0.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0f9e788acfa22c8c2b0142764e25df5af99e5304
-  data.tar.gz: 026774aef1aeae4bdc655dc4d664fde79c96234b
+SHA256:
+  metadata.gz: bce096e0104da6d1dbb0dd00c66798a3f7dbc74ec88e5c1bcc5a84f5fa207341
+  data.tar.gz: eb546cd9559ec82693208ec03e41fd160ed84699c8c1f9794fd0f2a4484233dc
 SHA512:
-  metadata.gz: 384b59a8e14e74763c62ff19852965dbb3887b215769458b53d34c5a67aed74acf04e08173ad055bcbccf274823d08b02a25a0eb9aea96e096a4610e49778514
-  data.tar.gz: 7a96ad07d6411cb2590d993a3808fc970a356db6f50c02423c42c140f453c64c4d3cc85df874a7cf70399d7b7ff0fa822175a75ef7d575998697666458ccdddd
+  metadata.gz: b0581ae84881ec5129f0e0a702a6adcfe5f7b44f3f55679e67fe3530054c018d22d2e1e280a61d190062258279950b8e2306214402bd565c0ec4c0e8cac3e723
+  data.tar.gz: 709e7773c529ea70e875387d0fa5af63f7feba4bba562c8f577f9642b9a1c9eae870834aa2d352efefccbef7e86ab7d7ff25226677261284931eb3f27a24dd9b

data/.devcontainer/Dockerfile

@@ -0,0 +1,20 @@
+# 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 --no-install-recommends imagemagick librsvg2-bin
+
+# [Optional] Uncomment this line to install additional gems.
+RUN gem install rubocop reek
+
+# [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,35 @@
+// 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.shell.linux": "/bin/bash"
+	},
+
+	// 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": "ruby --version",
+
+	// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+
+}

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,9 +10,9 @@ A clear and concise description of what the bug is.
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+2. Create a new project or clone one from '...'
+3. Add gem
+4. Bundle/Run/Test/...
 
 **Expected behavior**
 A clear and concise description of what you expected to happen.
@@ -20,16 +20,13 @@ A clear and concise description of what you expected to happen.
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-**Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
-
-**Smartphone (please complete the following information):**
- - Device: [e.g. iPhone6]
- - OS: [e.g. iOS8.1]
- - Browser [e.g. stock browser, safari]
- - Version [e.g. 22]
+**Environment:**
+ - OS name and version
+ - Ruby manager name and version (if present)
+ - Ruby version
+ - Bundler version
+ - Jekyll version
+ - Jekyll Favicon version
 
 **Additional context**
 Add any other context about the problem here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,16 @@
 # PR Template
 
-Include at least this concepts:
+- Tell us...
+  - what you wanted to achieve
+  - how you did it (use Markdown and screenshots if needed)
 
-- Explain what you wanted to achieve
+- Did you...
+  - [ ] update the README? (if needed)
+  - [ ] update the CHANGELOG? (if needed)
+  - [ ] update the tests?
+  - [ ] run the tests?
+  - [ ] check with Rubocop?
 
-- Explain what you did
+Don't forget to visit the [GitHub Action workflows](https://github.com/afaundez/jekyll-favicon/actions) after creating the PR.
 
-  - use markdown
-  - include screenshots if helps to explain
- 
-- Explain how to test it
-
-Thanks for contrubuting!
+Thanks for contributing!

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

@@ -0,0 +1,40 @@
+name: Gem Push
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.5
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.5.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on:
+  push:
+    branches: [ $default-branch, next, update-ci ]
+  pull_request:
+    branches: [ $default-branch ]
+
+jobs:
+  test:
+    env:
+      BUNDLE_GEMFILE: 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 ]
+        os: [ ubuntu-latest ]
+        ruby-version: [ 2.5, 2.6, 2.7, '3.0' ]

data/.gitignore

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

data/CHANGELOG.md

@@ -6,6 +6,50 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [1.0.0.pre.1] - 2021-05-26
+### 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
+### 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
+- Optional `crossorigin` attribute for Chrome manifest
+
+## [0.2.8] - 2019-09-11
+### Changed
+- Upgrade mini_magick 4.9.4 in gemspec for security fix
+- Update gemspec to support Jekyll 4.0
+
+## [0.2.7] - 2019-05-27
+### Fixed
+- Set default background back to none
+- Restore safari-pinned-tab
+### Changed
+- Update README outdated stuff
+- Correct typos on README
+
+## [0.2.6] - 2019-03-23
+### Added
+- Readme troubleshooting for librsvg2-bin package missing
+### Fixed
+- ICO convert uses background config
+
 ## [0.2.5] - 2019-01-16
 ### Changed
 - Strike GraphicsMagick at Readme because it's compatible a this moment

data/Gemfile

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

data/README.md

@@ -3,58 +3,67 @@
 This [Jekyll](https://jekyllrb.com) plugin adds:
 
 - a generator for
-  - a `favicon.ico`
-  - multiple `favicon-[width]x[height].png`
+  - 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
 
 ## Prerequisites
 
-Before using this plugin your system must have installed [ImageMagick](http://www.imagemagick.org) ~~(or [GraphicsMagick](http://www.graphicsmagick.org/))~~.
+This plugin assumes you have [ImageMagick](http://www.imagemagick.org) installed.
 
 Check if it is already installed by running:
 
 ```sh
-$ convert --version
-Version: ImageMagick 7.0.7-27 Q16 x86_64 2018-03-18 http://www.imagemagick.org
-Copyright: © 1999-2018 ImageMagick Studio LLC
-License: http://www.imagemagick.org/script/license.php
-Features: Cipher DPC HDRI Modules
-Delegates (built-in): bzlib freetype jng jpeg ltdl lzma png tiff xml zlib
+$ 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:
+
+```sh
+sudo apt install librsvg2-bin
+```
+
+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.5', group: :jekyll_plugins
+gem 'jekyll-favicon', '~> 1.0.0.pre.1', 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 [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 [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).
 
+Tested with:
+
+- Jekyll 3.6 to 3.7, ruby 2.5 to 2.7
+- Jekyll 3.8 to 4.2, ruby 2.5 to 3.0
+
 ### Generator
 
-By installing the plugin, it will be automatically active. It will search for the file `/favicon.svg` and generate 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 whit 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
 
-To get the links and meta, just add the favicon tag `{{ favicon }}`. For example, on your `index.html`
+To get the links and meta, just add the favicon tag `{% favicon %}`. For example, on your `index.html`
 
 ```html
 ---
@@ -65,17 +74,74 @@ To get the links and meta, just add the favicon tag `{{ favicon }}`. For example
     {% favicon %}
   </head>
   <body>
-    <h1>Jekyll Favicon</h1>
   </body>
 </html>
 ```
 
+## Configuration
+
+The plugin customization goes in the `favicon` key in the `_config.yml` file. There are four key parameters:
+
+| 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)         |
+| 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)       |
+| 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)           |
+
+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
+- 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
 
@@ -85,11 +151,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