jekyll-favicon 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 348c5ecbd6ff6959ef000b7ed5e303247c54ab62
-  data.tar.gz: 3115c60efdc82f1d9963f7abdff6b250a1deaa79
+SHA256:
+  metadata.gz: caf32655a87cfda4b33b8a7c71d9b88767a37f6586fc0daf264f46dec0d1720d
+  data.tar.gz: c7fa97ebcffd2808026f049efabbb5b80e2fcd20254d840e9825f3bdb943811c
 SHA512:
-  metadata.gz: 0e81924b776ed34b9d7b0772dd9052fb9ddfb1e53fae3865860a07661e031a3d86a229d6d08e2d68d760e576a5620d38f560c0255b1286b09c34feb99d1658a6
-  data.tar.gz: bd14abae772e7a03abaa2223a6cc93bcac8bdc5f102b27848ead37adff996c0bff2b0ddbf6a06a4f1616d9e89839d28fa6c5cdf5878a1cc9e9753bf60ec346e5
+  metadata.gz: 5a8de79c35b12649cf20a8f83c706ca1447862a4271b1071216ceb830a7193cd998892ff82277ffc0f93d7932d325cef2841819414bfd5cc12e3f3bee9bc928d
+  data.tar.gz: a9b0a7bf04a3a13f28b42607cc83845900afb669f636842eff2d22aa7cf37861ec771397f1447cc144b1c72f6c54d5a90af1a26888498791873880b8b4e4f0ec

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+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
+
+**Expected behavior**
+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]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+# PR Template
+
+Include at least this concepts:
+
+- Explain what you wanted to achieve
+
+- Explain what you did
+
+  - use markdown
+  - include screenshots if helps to explain
+ 
+- Explain how to test it
+
+Thanks for contrubuting!

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+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]
+
+## [0.2.3] - 2015-03-27
+### Added
+- Changelog
+- Contributing guide
+- Issue and Pull Request templates
+- Improve Readme usage
+
+### Fixed
+- Missing baseurl in links from `favicon` tag
+
+## [0.2.2] - 2015-03-27
+### Fixed
+- Missing png template
+
+## [0.2.1] - 2015-03-27
+### Fixed
+- Jekyll gem version dependency
+
+## [0.2.0] - 2015-03-27
+### Added
+- Jekyll generator with ImageMagick dependency
+- Configuration file options
+- Rubocop (and changes suggested by it)
+
+### Changed
+- Templates structure
+
+## [0.1.2] - 2015-03-17
+### Fixed
+- Fix gem version
+
+## [0.1.1] - 2015-03-17
+### Changed
+- Replace heredoc for ruby >=2.1 compatibility
+
+## [0.1.0] - 2018-01-30
+### Added
+- Jekyll tag `favicon`

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing to Jekyll Favicon
+
+Want to contribute? Be polite and use words like hello and thanks.
+
+Also check the [Code of Conduct](CODE_OF_CONDUCT.md).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-favicon (0.2.1)
+    jekyll-favicon (0.2.3)
       jekyll (~> 3.0)
       mini_magick (~> 4.5)
 
@@ -16,13 +16,13 @@ GEM
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.5)
-    ffi (1.9.23)
+    eventmachine (1.2.7)
+    ffi (1.9.25)
     forwardable-extended (2.6.0)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.7.3)
+    jekyll (3.8.3)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -39,27 +39,30 @@ GEM
       sass (~> 3.4)
     jekyll-watch (2.0.0)
       listen (~> 3.0)
-    kramdown (1.16.2)
+    kramdown (1.17.0)
     liquid (4.0.0)
     listen (3.0.8)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
     mercenary (0.3.6)
     mini_magick (4.8.0)
+    mini_portile2 (2.3.0)
     minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
     parser (2.5.0.5)
       ast (~> 2.4.0)
     pathutil (0.16.1)
       forwardable-extended (~> 2.6)
     powerpack (0.1.1)
-    public_suffix (3.0.2)
+    public_suffix (3.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
-    rouge (3.1.1)
+    rouge (3.2.1)
     rubocop (0.54.0)
       parallel (~> 1.10)
       parser (>= 2.5)
@@ -69,7 +72,7 @@ GEM
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.9.0)
     safe_yaml (1.0.4)
-    sass (3.5.6)
+    sass (3.5.7)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -83,6 +86,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   jekyll-favicon!
   minitest (~> 5.0)
+  nokogiri (~> 1.8)
   rake (~> 10.0)
   rubocop (~> 0.54.0, >= 0.54.0)
 

data/README.md

@@ -9,19 +9,36 @@ This [Jekyll](https://jekyllrb.com) plugin adds:
   - 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
 
-Note: this project depends on [minimagick/minimagick](https://github.com/minimagick/minimagick/), which depends on [ImageMagick](https://imagemagick.org/) or [GraphicsMagick](http://www.graphicsmagick.org/).
+
+
+## Prerequisites
+
+Before using this plugin your system must have installed [ImageMagick](http://www.imagemagick.org) (or [GraphicsMagick](http://www.graphicsmagick.org/)).
+
+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
+```
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jekyll-favicon', '~> 0.2.1', group: :jekyll_plugins
+gem 'jekyll-favicon', '~> 0.2.3', group: :jekyll_plugins
 ```
 
 ## Usage
 
-Note: this plugin does not work with the [github-pages](https://pages.github.com) build, but you can generate the site and push it.
+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/).
+
+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
 

data/jekyll-favicon.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'nokogiri', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.54.0', '>= 0.54.0'
 

data/lib/jekyll/favicon/generator.rb

@@ -4,10 +4,13 @@ module Jekyll
     class Generator < Jekyll::Generator
       priority :high
 
+      attr_accessor :template
+
       def generate(site)
         @site = site
         if File.exist? favicon_source
-          generate_files Favicon.config['sizes'], Favicon.config['path']
+          @template = favicon_tempfile
+          generate_files Favicon.config['path']
         else
           Jekyll.logger.warn 'Jekyll::Favicon: Missing' \
                              " #{Favicon.config['source']}, not generating" \
@@ -15,12 +18,17 @@ module Jekyll
         end
       end
 
+      def clean
+        return unless @tempfile
+        @template.close
+        @template.unlink
+      end
+
       private
 
-      def generate_files(sizes, prefix)
-        favicon_template = favicon_tempfile
-        generate_ico_from favicon_template.path
-        generate_png_from favicon_template.path, prefix, sizes
+      def generate_files(prefix)
+        generate_ico_from @template.path
+        generate_png_from @template.path, prefix
         if File.extname(favicon_source) == '.svg'
           generate_svg_from favicon_source, prefix,
                             'safari-pinned-tab.svg'
@@ -34,7 +42,7 @@ module Jekyll
         @site.static_files << ico_favicon
       end
 
-      def generate_png_from(source, prefix, sizes)
+      def generate_png_from(source, prefix)
         ['classic', 'ie', 'chrome', 'apple-touch-icon'].each do |template|
           Favicon.config[template]['sizes'].each do |size|
             png_favicon = Icon.new(@site, prefix, "favicon-#{size}.png", source)

data/lib/jekyll/favicon/hooks.rb

@@ -2,3 +2,10 @@ Jekyll::Hooks.register :site, :after_init do |site|
   Jekyll::Favicon.merge site.config['favicon']
   site.config['exclude'] << Jekyll::Favicon.config['source']
 end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  favicon_generators = site.generators.select do |generator|
+    generator.is_a? Jekyll::Favicon::Generator
+  end
+  favicon_generators.each(&:clean)
+end

data/lib/jekyll/favicon/metadata.rb

@@ -9,11 +9,10 @@ module Jekyll
         @name = name
 
         process @name
+        prepend_path = @site.baseurl || ''
         template = File.read File.join Favicon.templates, "#{name}.erb"
         self.content = ERB.new(template, nil, '-').result binding
-        self.data = {}
-        data['name'] = name
-        data['layout'] = nil
+        self.data = { 'name' => name, 'layout' => nil }
       end
     end
   end

data/lib/jekyll/favicon/tag.rb

@@ -9,6 +9,7 @@ module Jekyll
 
       def render(context)
         site = context.registers[:site]
+        prepend_path = site.baseurl || ''
         templates_dir = Favicon.templates
         head = "<!-- Begin Jekyll Favicon tag v#{Favicon::VERSION} -->"
         body = %w[classic safari chrome ie].collect do |template|

data/lib/jekyll/favicon/templates/browserconfig.xml.erb

@@ -1,10 +1,11 @@
 <browserconfig>
   <msapplication>
     <tile>
-      <square310x310logo src="<%= File.join Favicon.config['path'], 'favicon-558x558.png' %>" />
-      <wide310x150logo src="<%= File.join Favicon.config['path'], 'favicon-558x270.png' %>" />
-      <square150x150logo src="<%= File.join Favicon.config['path'], 'favicon-270x270.png' %>" />
-      <square70x70logo src="<%= File.join Favicon.config['path'], 'favicon-128x128.png' %>" />
+      <%- favicon_path = File.join prepend_path, Favicon.config['path'] -%>
+      <square310x310logo src="<%= File.join favicon_path, 'favicon-558x558.png' %>" />
+      <wide310x150logo src="<%= File.join favicon_path, 'favicon-558x270.png' %>" />
+      <square150x150logo src="<%= File.join favicon_path, 'favicon-270x270.png' %>" />
+      <square70x70logo src="<%= File.join favicon_path, 'favicon-128x128.png' %>" />
       <TileColor><%= Favicon.config['ie']['tile-color'] %></TileColor>
     </tile>
   </msapplication>

data/lib/jekyll/favicon/templates/chrome.html.erb

@@ -1,5 +1,5 @@
 <!-- Chrome -->
 <%- Favicon.config['chrome']['sizes'].each do |size| -%>
-  <link rel="icon" sizes="<%= size %>" href="<%= File.join Favicon.config['path'], "favicon-#{size}.png" %>">
+  <link rel="icon" sizes="<%= size %>" href="<%= File.join prepend_path, Favicon.config['path'], "favicon-#{size}.png" %>">
 <%- end -%>
-<link rel="manifest" href="<%= File.join Favicon.config['chrome']['manifest-path'], 'manifest.webmanifest' %>">
+<link rel="manifest" href="<%= File.join prepend_path, Favicon.config['chrome']['manifest-path'], 'manifest.webmanifest' %>">

data/lib/jekyll/favicon/templates/classic.html.erb

@@ -1,6 +1,7 @@
 <!-- Classic -->
 <link rel="shortcut icon" href="favicon.ico">
-<link rel="icon" sizes="<%= Favicon.config['ico']['sizes'].collect{|s| "#{s}x#{s}"}.join ' ' %>" href="<%= File.join Favicon.config['ico']['path'], 'favicon.ico' %>">
+<%- favicon_path = File.join prepend_path, Favicon.config['path'] -%>
+<link rel="icon" sizes="<%= Favicon.config['ico']['sizes'].collect{|s| "#{s}x#{s}"}.join ' ' %>" href="<%= File.join favicon_path, 'favicon.ico' %>">
 <%- Favicon.config['classic']['sizes'].each do |size| -%>
-  <link rel="icon" sizes="<%= size %>" type="image/png" href="<%= File.join Favicon.config['path'], "favicon-#{size}.png" %>">
+  <link rel="icon" sizes="<%= size %>" type="image/png" href="<%= File.join favicon_path, "favicon-#{size}.png" %>">
 <%- end -%>

data/lib/jekyll/favicon/templates/ie.html.erb

@@ -1,4 +1,4 @@
 <!-- IE -->
 <meta name="msapplication-TileColor" content="<%= Favicon.config['ie']['tile-color'] %>">
-<meta name="msapplication-TileImage" content="<%= File.join Favicon.config['path'], 'favicon-144x144.png' %>">
-<meta name="msapplication-config" content="<%= File.join Favicon.config['ie']['browserconfig-path'], 'browserconfig.xml' %>">
+<meta name="msapplication-TileImage" content="<%= File.join prepend_path, Favicon.config['path'], 'favicon-144x144.png' %>">
+<meta name="msapplication-config" content="<%= File.join prepend_path, Favicon.config['ie']['browserconfig-path'], 'browserconfig.xml' %>">

data/lib/jekyll/favicon/templates/manifest.webmanifest.erb

@@ -1 +1 @@
-<%= JSON.pretty_generate icons: Favicon.config['chrome']['sizes'].collect{|size| {src: File.join(Favicon.config['path'], "favicon-#{size}.png"), type: 'png', sizes: size}} %>
+<%= JSON.pretty_generate icons: Favicon.config['chrome']['sizes'].collect{|size| {src: File.join(prepend_path, Favicon.config['path'], "favicon-#{size}.png"), type: 'png', sizes: size}} %>

data/lib/jekyll/favicon/templates/safari.html.erb

@@ -1,5 +1,6 @@
 <!-- Safari -->
+<%- favicon_path = File.join prepend_path, Favicon.config['path'] -%>
 <%- Favicon.config['apple-touch-icon']['sizes'].each do |size| -%>
-  <link rel="apple-touch-icon" sizes="<%= size %>" href="<%= File.join Favicon.config['path'], "favicon-#{size}.png" %>">
+  <link rel="apple-touch-icon" sizes="<%= size %>" href="<%= File.join favicon_path, "favicon-#{size}.png" %>">
 <%- end -%>
-<link rel="mask-icon" color="<%= Favicon.config['safari-pinned-tab']['mask-icon-color'] %>" href="<%= File.join Favicon.config['path'], 'safari-pinned-tab.svg' %>">
+<link rel="mask-icon" color="<%= Favicon.config['safari-pinned-tab']['mask-icon-color'] %>" href="<%= File.join favicon_path, 'safari-pinned-tab.svg' %>">

data/lib/jekyll/favicon/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Favicon
-    VERSION = '0.2.1'.freeze
+    VERSION = '0.2.3'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-favicon
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Alvaro Faundez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-27 00:00:00.000000000 Z
+date: 2018-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,10 +122,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -148,7 +167,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin for favicon tag generation.