jekyll-favicon 0.2.6 → 1.0.0.pre.2

data/Rakefile

@@ -1,10 +1,12 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+# frozen_string_literal: true
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
+require "rake/testtask"
 
+desc "run tests"
 task default: :test
+
+Rake::TestTask.new do |t|
+  t.libs << ["test", "test/spec", "test/unit"]
+  t.test_files = FileList["test/**/*_spec.rb", "test/**/test_*.rb"]
+  t.warning = false
+end

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'jekyll-favicon'

data/bin/debug

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path("../../lib", __FILE__))
+
+require "pathname"
+require "tmpdir"
+require "jekyll"
+require "jekyll-favicon"
+
+GEM_ROOT = Pathname.new "/workspaces/jekyll-favicon"
+
+Dir.mktmpdir do |source|
+  %w[index.html favicon.svg].each do |basename|
+    template = GEM_ROOT.join "test/fixtures", basename
+    target = File.join source, basename
+    FileUtils.cp template, target
+  end
+  destination = File.join source, "_site"
+  options = {source: source, destination: destination}
+  Jekyll::Commands::Build.process options
+  Jekyll::Commands::Serve.process options
+end

data/config/jekyll/favicon.yml

@@ -0,0 +1,115 @@
+---
+source:
+  name: favicon.svg
+  dir: .
+background: transparent
+dir: .
+assets:
+  - name: favicon.ico
+    convert:
+      define: 'icon:auto-resize=36,24,16'
+      scale: 36x36
+    tag:
+      - link:
+          href: :href
+          rel: shortcut icon
+          type: :mime
+          sizes: :sizes
+  - name: favicon.png
+    convert:
+      scale: 196x196
+    tag:
+      - link:
+          href: :href
+          rel: icon
+          type: :mime
+          sizes: :sizes
+  - name: apple-touch-icon.png
+    convert:
+      scale: 180x180
+  - name: safari-pinned-tab.svg
+    tag:
+      - link:
+          color: :background
+          href: :href
+          rel: mask-icon
+  - name: android-chrome-192x192.png
+    convert:
+      scale: 192x192
+    refer:
+      - webmanifest:
+          icons:
+          - src: :href
+  - name: android-chrome-512x512.png
+    convert:
+      scale: 512x512
+    refer:
+      - webmanifest:
+          icons:
+          - src: :href
+  - name: mstile-icon-128x128.png
+    convert:
+      scale: 128x128
+    refer:
+      - browserconfig:
+          msapplication:
+            tile:
+              TileColor:
+                __text: :background
+              square70x70logo:
+                _src: :href
+    tag:
+      - meta:
+          content: :href
+          name: msapplication-TileImage
+      - meta:
+          content: :background
+          name: msapplication-TileColor
+
+  - name: mstile-icon-270x270.png
+    convert:
+      scale: 270x270
+    refer:
+      - browserconfig:
+          msapplication:
+            tile:
+              TileColor:
+                __text: :background
+              square150x150logo:
+                _src: :href
+  - name: mstile-icon-558x270.png
+    convert:
+      scale: 558x270
+    refer:
+      - browserconfig:
+          msapplication:
+            tile:
+              TileColor:
+                __text: :background
+              wide310x150logo:
+                _src: :href
+  - name: mstile-icon-558x558.png
+    convert:
+      scale: 558x558
+    refer:
+      - browserconfig:
+          msapplication:
+            tile:
+              TileColor:
+                __text: :background
+              square310x310logo:
+                _src: :href
+  - name: manifest.webmanifest
+    source:
+      name: manifest.webmanifest
+    tag:
+      - link:
+          href: :href
+          rel: manifest
+  - name: browserconfig.xml
+    source:
+      name: browserconfig.xml
+    tag:
+      - meta:
+          content: :href
+          name: msapplication-config

data/config/jekyll/favicon/static_file.yml

@@ -0,0 +1,3 @@
+---
+background: transparent
+dir: .

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

@@ -0,0 +1,42 @@
+---
+defaults: &defaults
+  alpha: null
+  background: null
+  define: null
+  density: null
+  extent: null
+  gravity: null
+  resize: null
+  scale: null
+.svg:
+  .png:
+    <<: *defaults
+    background: :background
+    density: :max
+    extent: :auto
+    gravity: center
+    scale:
+  .ico:
+    <<: *defaults
+    background: :background
+    define:
+    density: :max
+    extent: :auto
+    gravity: center
+    scale:
+  .svg:
+    <<: *defaults
+.png:
+  .ico:
+    <<: *defaults
+    background: :background
+    define:
+    extent: :auto
+    gravity: center
+    resize:
+  .png:
+    <<: *defaults
+    background: :background
+    extent: :auto
+    gravity: center
+    resize:

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

@@ -0,0 +1,22 @@
+---
+defaults:
+  webmanifest:
+    icons:
+      # https://developer.mozilla.org/en-US/docs/Web/Manifest/icons
+    - sizes: null
+      src: null
+      type: null
+      purpose: null
+  browserconfig:
+    browserconfig:
+      msapplication:
+        tile:
+          TileColor: :background
+.json:
+  # https://developer.mozilla.org/en-US/docs/Web/Manifest
+  icons: :references
+.xml:
+  # https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85)?redirectedfrom=MSDN
+  browserconfig:
+    msapplication:
+      tile: :references

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

@@ -0,0 +1,15 @@
+---
+webmanifest: # https://developer.mozilla.org/en-US/docs/Web/Manifest
+  icons: # https://developer.mozilla.org/en-US/docs/Web/Manifest/icons
+  - sizes: :sizes
+    src: :relative_path
+    type: :mime
+    purpose: null
+browserconfig: # https://docs.microsoft.com/en-us/previous-versions/windows/internet-explorer/ie-developer/platform-apis/dn320426(v=vs.85)?redirectedfrom=MSDN
+  browserconfig:
+    msapplication:
+      tile:
+        TileColor: :background
+        ___element:
+          name: :logo
+          _src: :relative_path

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

@@ -0,0 +1,3 @@
+---
+name: :source_name
+dir: :source_dir

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

@@ -0,0 +1,22 @@
+---
+link:
+  as: null
+  color: null
+  crossorigin: null
+  disabled: null
+  href: null
+  hreflang: null
+  imagesizes: null
+  imagesrcset: null
+  media: null
+  prefetch: null
+  rel: null
+  sizes: null
+  title: null
+  type: null
+meta:
+  charset: null
+  content: null
+  http-equiv: null
+  itemprop: null
+  name: null

data/jekyll-favicon.gemspec

@@ -1,36 +1,36 @@
+# frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/favicon/version'
+require "jekyll/favicon/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'jekyll-favicon'
-  spec.version       = Jekyll::Favicon::VERSION
-  spec.authors       = ['Alvaro Faundez']
-  spec.email         = ['alvaro@faundez.net']
+  spec.name = "jekyll-favicon"
+  spec.version = Jekyll::Favicon::VERSION
+  spec.authors = ["Alvaro Faundez"]
+  spec.email = ["alvaro@faundez.net"]
 
-  spec.summary       = 'Jekyll plugin for favicon tag generation.'
-  spec.description   = 'Jekyll-favicon is a jekyll plugin that adds the' \
-                       ' tag favicon, generating html tags for favicon.'
-  spec.homepage      = 'https://github.com/afaundez/jekyll-favicon'
-  spec.license       = 'MIT'
+  spec.summary = "Jekyll plugin for favicon tag generation."
+  spec.description = "Jekyll-favicon is a jekyll plugin that adds the" \
+                       " tag favicon, generating html tags for favicon."
+  spec.homepage = "https://github.com/afaundez/jekyll-favicon"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = ">= 2.5.0"
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'minitest-hooks', '~> 1.4', '>= 1.4.2'
-  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'
+  spec.add_development_dependency "minitest", "~> 5.8"
+  spec.add_development_dependency "minitest-hooks", "~> 1.5"
+  spec.add_development_dependency "minitest-reporters", "~> 1.4.3"
+  spec.add_development_dependency "rake", "~> 12.3"
 
-  spec.add_runtime_dependency 'jekyll', '~> 3.0'
-  spec.add_runtime_dependency 'mini_magick', '~> 4.5'
+  spec.add_runtime_dependency "jekyll", ">= 3.0", "< 5.0"
+  spec.add_runtime_dependency "mini_magick", "~> 4.11"
+  spec.add_runtime_dependency "rexml", "~> 3.2", ">= 3.2.5"
 end

data/lib/jekyll-favicon.rb

@@ -1,16 +1,7 @@
-# rubocop:disable Naming/FileName
-# rubocop:enable Naming/FileName
-require 'jekyll'
-require 'mini_magick'
-require_relative 'string'
-require_relative 'hash'
-require_relative 'browserconfig'
-require_relative 'webmanifest'
-require_relative 'image'
-require_relative 'jekyll/favicon'
-require_relative 'jekyll/favicon/version'
-require_relative 'jekyll/favicon/hooks'
-require_relative 'jekyll/favicon/metadata'
-require_relative 'jekyll/favicon/icon'
-require_relative 'jekyll/favicon/generator'
-require_relative 'jekyll/favicon/tag'
+# frozen_string_literal: true
+
+require "jekyll/favicon"
+require "jekyll/favicon/generator"
+require "jekyll/favicon/tag"
+require "jekyll/favicon/hooks"
+require "jekyll/favicon/version"

data/lib/jekyll/favicon.rb

@@ -1,26 +1,29 @@
-require 'yaml'
+# frozen_string_literal: true
+
+require "yaml"
+require "jekyll/favicon/configuration/defaults"
+require "jekyll/favicon/configuration"
+require "jekyll/favicon/static_data_file"
+require "jekyll/favicon/static_graphic_file"
 
 module Jekyll
   # Module for custom configurations and defaults
   module Favicon
-    GEM_ROOT = File.dirname File.dirname __dir__
-    PROJECT_LIB = File.join GEM_ROOT, 'lib'
-    PROJECT_ROOT = File.join PROJECT_LIB, 'jekyll', 'favicon'
-    defaults_path = File.join PROJECT_ROOT, 'config', 'defaults.yml'
-    DEFAULTS = YAML.load_file(defaults_path)['favicon']
-
-    # rubocop:disable  Style/ClassVars
-    def self.merge(overrides)
-      @@config = Jekyll::Utils.deep_merge_hashes DEFAULTS, (overrides || {})
-    end
+    include Configuration::Defaults
 
-    def self.config
-      @@config ||= DEFAULTS
+    def self.assets(site)
+      Configuration.merged(site)
+        .fetch("assets", [])
+        .collect { |attributes| build_asset site, attributes }
+        .compact
     end
-    # rubocop:enable  Style/ClassVars
 
-    def self.templates
-      File.join PROJECT_ROOT, 'templates'
+    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
+      end
+      asset_class&.new site, attributes
     end
   end
 end

data/lib/jekyll/favicon/configuration.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "jekyll/utils"
+
+module Jekyll
+  module Favicon
+    # Favicon configuration
+    module Configuration
+      def self.merged(site)
+        return from_defaults unless (user_overrides = from_user site)
+
+        user_overrides = unlegacify user_overrides
+        user_merged = Jekyll::Utils.deep_merge_hashes from_defaults,
+          user_overrides
+        standardize user_merged
+      end
+
+      def self.from_user(site)
+        site&.config&.fetch "favicon", {}
+      end
+
+      def self.from_defaults
+        Favicon.defaults
+      end
+
+      def self.standardize(config)
+        return unless config
+
+        config.merge "source" => standardize_source(config["source"])
+      end
+
+      def self.standardize_source(source)
+        case source
+        when String then standardize_source_string source
+        when Hash then standardize_source_hash source
+        end
+      end
+
+      private_class_method :standardize_source
+
+      def self.standardize_source_string(source)
+        dir, name = File.split source
+        {"name" => name, "dir" => dir}
+      end
+
+      private_class_method :standardize_source_string
+
+      def self.standardize_source_hash(source)
+        name_dir, name = File.split source["name"]
+        dir = source["dir"]
+        source_dir = dir && !dir.empty? ? dir : nil
+        {"name" => name, "dir" => standardize_pathname(source_dir, name_dir)}
+      end
+
+      private_class_method :standardize_source_hash
+
+      def self.standardize_pathname(*paths)
+        Pathname.new(File.join(*paths.compact)).cleanpath.to_s
+      end
+
+      private_class_method :standardize_source_string
+
+      def self.unlegacify(config)
+        options = config.slice "source", "dir", "background", "assets"
+        path = options["path"]
+        options["dir"] ||= path if path
+        options
+      end
+
+      private_class_method :unlegacify
+    end
+  end
+end