jekyll-favicon 0.2.9 → 1.0.0.pre.1

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/gemfiles/jekyll36.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.6.0'
+gemspec path: '..'

data/gemfiles/jekyll37.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.7.0'
+gemspec path: '..'

data/gemfiles/jekyll38.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.8.0'
+gemspec path: '..'

data/gemfiles/jekyll39.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 3.9.0'
+gemspec path: '..'

data/gemfiles/jekyll40.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 4.0.0'
+gemspec path: '..'

data/gemfiles/jekyll41.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 4.1.0'
+gemspec path: '..'

data/gemfiles/jekyll42.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'jekyll', '~> 4.2.0'
+gemspec path: '..'

data/jekyll-favicon.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -22,15 +23,14 @@ 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.required_ruby_version = '>= 2.5.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  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', '< 5.0'
-  spec.add_runtime_dependency 'mini_magick', '>= 4.9.4'
+  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,9 @@
 # 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,32 @@
+# 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']
+    include Configuration::Defaults
 
-    # rubocop:disable  Style/ClassVars
-    def self.merge(overrides)
-      @@config = Jekyll::Utils.deep_merge_hashes DEFAULTS, (overrides || {})
+    def self.configuration(site)
+      Configuration.merged site
     end
 
-    def self.config
-      @@config ||= DEFAULTS
+    def self.assets(site)
+      configuration(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

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Jekyll
+  module Favicon
+    ROOT = Pathname.new File.dirname(File.dirname(File.dirname(File.dirname(__dir__))))
+
+    module Configuration
+      # Create configurable for include
+      module Defaults
+        def self.included(base)
+          *modules, class_or_module_name = base_name_to_parts base.name
+          method_name = "#{class_or_module_name}_defaults"
+          define_defaults base, method_name do
+            Defaults.load_defaults(*modules, class_or_module_name)
+          end
+        end
+
+        def self.load_defaults(*parts)
+          load_file 'config', *parts
+        end
+
+        def self.load_file(*parts)
+          path = Favicon::ROOT.join(*parts).to_s
+          path = "#{path}.yml"
+          YAML.load_file path
+        end
+
+        def self.define_defaults(base, method_name, &block)
+          base.define_singleton_method('defaults', &block)
+          define_method(method_name, &block)
+        end
+
+        def self.base_name_to_parts(name)
+          name.split('::').collect do |module_or_class|
+            camelcase_to_snakecase module_or_class
+          end
+        end
+
+        def self.camelcase_to_snakecase(camelcase)
+          camelcase.gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+                   .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+                   .downcase
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/generator.rb

@@ -1,91 +1,18 @@
+# frozen_string_literal: true
+
+require 'jekyll/plugin'
+require 'jekyll/generator'
+require 'jekyll/favicon'
+
 module Jekyll
   module Favicon
-    # Extended generator that creates all the stastic icons and metadata files
+    # New generator that creates all the stastic icons and metadata files
     class Generator < Jekyll::Generator
-      priority :high
-
-      attr_accessor :template
-
+      # :reek:UtilityFunction
       def generate(site)
-        @site = site
-        if File.file? source_path Favicon.config['source']
-          @template = favicon_tempfile source_path Favicon.config['source']
-          generate_icons && generate_metadata
-        else
-          Jekyll.logger.warn 'Jekyll::Favicon: Missing ' \
-                             "#{Favicon.config['source']}, not generating " \
-                             'favicons.'
-        end
-      end
-
-      def clean
-        return unless @template
-        @template.close
-        @template.unlink
-      end
-
-      private
-
-      def source_path(path = nil)
-        File.join(*[@site.source, path].compact)
-      end
-
-      def favicon_tempfile(source)
-        tempfile = Tempfile.new(['favicon-template', '.png'])
-        options = { background: 'none' }
-        if source.svg?
-          options[:density] = Favicon.config['svg']['density']
-          options[:resize] = Favicon.config['svg']['dimensions']
-        elsif source.png?
-          options[:resize] = Favicon.config['png']['dimensions']
-        end
-        Image.convert source, tempfile.path, options
-        tempfile
-      end
-
-      def generate_icons
-        @site.static_files.push ico_icon
-        @site.static_files.push(*png_icons)
-        @site.static_files.push(*svg_icons)
-      end
-
-      def ico_icon
-        target = Favicon.config['ico']['target']
-        Icon.new @site, Favicon.config['source'], @template.path, target
-      end
-
-      def png_icons
-        Favicon.config.deep_find('sizes').uniq.collect do |size|
-          target = File.join Favicon.config['path'], "favicon-#{size}.png"
-          Icon.new @site, Favicon.config['source'], @template.path, target
-        end
-      end
-
-      def svg_icons
-        return [] unless Favicon.config['source'].svg?
-        source = Favicon.config['source']
-        %w[safari-pinned-tab.svg].collect do |name|
-          target = File.join Favicon.config['path'], name
-          Icon.new @site, source, source_path(source), target
-        end
-      end
-
-      def generate_metadata
-        @site.pages.push metadata Browserconfig.new,
-                                  Favicon.config['ie']['browserconfig']
-        @site.pages.push metadata Webmanifest.new,
-                                  Favicon.config['chrome']['manifest']
-      end
-
-      def metadata(document, config)
-        page = Metadata.new @site, @site.source,
-                            File.dirname(config['target']),
-                            File.basename(config['target'])
-        favicon_path = File.join (@site.baseurl || ''), Favicon.config['path']
-        document.load source_path(config['source']), config, favicon_path
-        page.content = document.dump
-        page.data = { 'layout' => nil }
-        page
+        Favicon.assets(site)
+               .select(&:generable?)
+               .each { |asset| site.static_files << asset }
       end
     end
   end