jekyll-favicon 0.2.9 → 1.0.0.pre.1

data/lib/jekyll/favicon/hooks.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
+require 'jekyll/hooks'
+
 Jekyll::Hooks.register :site, :after_init do |site|
-  Jekyll::Favicon.merge site.config['favicon']
-  favicon_config = Jekyll::Favicon.config
-  site.config['exclude'] << favicon_config['source']
-  site.config['exclude'] << favicon_config['chrome']['manifest']['source']
-  site.config['exclude'] << favicon_config['ie']['browserconfig']['source']
-end
+  static_files = Jekyll::Favicon.assets(site)
+                                .uniq(&:path)
+  excludes = site.config['exclude']
+  static_files.each do |static_file|
+    source = static_file.source_relative_path
+    excludes << source and next if static_file.generable?
 
-Jekyll::Hooks.register :site, :post_write do |site|
-  favicon_generators = site.generators.select do |generator|
-    generator.is_a? Jekyll::Favicon::Generator
+    Jekyll.logger.warn Jekyll::Favicon,
+                       "Missing #{source}, not generating favicons."
   end
-  favicon_generators.each(&:clean)
 end

data/lib/jekyll/favicon/static_data_file.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/static_file'
+require 'jekyll/favicon/static_file/mutable'
+
+module Jekyll
+  module Favicon
+    # StaticFile extension for data exchange formats
+    class StaticDataFile < StaticFile
+      include StaticFile::Mutable
+
+      def generable?
+        true
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require 'forwardable'
+require 'jekyll/static_file'
+require 'jekyll/favicon/static_file/sourceable'
+require 'jekyll/favicon/static_file/taggable'
+require 'jekyll/favicon/static_file/referenceable'
+require 'jekyll/favicon/utils'
+require 'jekyll/favicon/configuration'
+
+module Jekyll
+  module Favicon
+    # Class for static files from with spec dictionary
+    # Modify source from spec source
+    # Enable tags from spec tags
+    # Enable refer
+    class StaticFile < Jekyll::StaticFile
+      include StaticFile::Sourceable
+      include StaticFile::Taggable
+      include StaticFile::Referenceable
+
+      attr_reader :spec, :site
+
+      def initialize(site, spec = {})
+        raise StandardError unless spec.include? 'name'
+
+        @spec = spec
+        spec_dir, spec_name = File.split spec_relative_path
+        super site, site.source, spec_dir, spec_name
+      end
+
+      def generable?
+        sourceable?
+      end
+
+      def taggable?
+        generable? && super
+      end
+
+      def patch(configuration)
+        taggable_patch spec_patch configuration
+      end
+
+      def href
+        Pathname.new('/')
+                .join(url)
+                .to_s
+      end
+
+      private
+
+      def spec_patch(configuration)
+        Utils.patch configuration do |value|
+          case value
+          when :site_dir then site_dir
+          when :background then site_background
+          when :href then href
+          else value
+          end
+        end
+      end
+
+      def site_dir
+        site_configuration.fetch('dir', '.')
+      end
+
+      def site_background
+        site_configuration.fetch('background', 'transparent')
+      end
+
+      def site_configuration
+        Configuration.merged site
+      end
+
+      def spec_relative_path
+        spec_relative_pathname.cleanpath
+      end
+
+      def spec_relative_pathname
+        return spec_pathname if spec_pathname.relative?
+
+        pathname.relative_path_from '/'
+      end
+
+      def spec_pathname
+        Pathname.new(site_dir)
+                .join(*spec_dir_name)
+      end
+
+      def spec_dir_name
+        spec.values_at('dir', 'name')
+            .compact
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file/convertible.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/configuration/defaults'
+require 'jekyll/favicon/utils'
+
+module Jekyll
+  module Favicon
+    class StaticFile < Jekyll::StaticFile
+      # Create static file based on a source file
+      module Convertible
+        include Configuration::Defaults
+
+        def convertible?
+          convert.any? || convert_allow_empty?
+        end
+
+        def convert
+          convert_defaults = convertible_defaults.dig File.extname(path), @extname
+          convert_normalized = convert_normalize convert_spec
+          convert_consolidated = Utils.merge convert_defaults, convert_normalized
+          patch convert_patch(convert_consolidated || {})
+        end
+
+        def convertible_patch(configuration)
+          Utils.patch configuration do |value|
+            case value
+            when :sizes then sizes.join ' '
+            else value
+            end
+          end
+        end
+
+        def sizes
+          if (match = name.match(/^.*-(\d+x\d+)\..*$/)) then [match[1]]
+          elsif (define = convert_spec['define'])
+            define.split('=').last.split(',').collect { |size| [size, size].join 'x' }
+          elsif (resize = convert_spec['resize']) then [resize]
+          elsif (scale = convert_spec['scale']) then [scale]
+          end
+        end
+
+        # Jekyll::StaticFile method
+        # asks if dest mtime is older than source mtime after original modified?
+        def modified?
+          super || self.class.mtimes[href] < mtime
+        end
+
+        # Jekyll::StaticFile method
+        # adds dest mtime to list after original write
+        # :reek:ControlParameter
+        def write(dest)
+          super(dest) && self.class.mtimes[href] = mtime
+        end
+
+        private
+
+        # Jekyll::StaticFile method
+        # add file creation instead of copying
+        def copy_file(dest_path)
+          case @extname
+          when '.svg' then super(dest_path)
+          when '.ico', '.png'
+            Utils.convert path, dest_path, convert
+          else Jekyll.logger.warn "Jekyll::Favicon: Can't generate " \
+                                  " #{dest_path}. Extension not supported."
+          end
+        end
+
+        def convert_allow_empty?
+          @extname == '.svg' && @extname == File.extname(path)
+        end
+
+        def convert_spec
+          spec.fetch 'convert', {}
+        end
+
+        def convert_normalize(options)
+          return {} unless options
+
+          Utils.compact options.slice(*convertible_defaults['defaults'].keys)
+        end
+
+        def convert_defaults
+          convertible_defaults.dig File.extname(path), @extname
+        end
+
+        # :reek:FeatureEnvy
+        def convert_patch(options)
+          %w[density extent].each do |name|
+            method = "convert_patch_#{name}".to_sym
+            options.merge! name => send(method, options[name])
+          end
+          Utils.compact options.slice(*convertible_defaults['defaults'].keys)
+        end
+
+        def convert_patch_density(density)
+          case density
+          when :max
+            length = sizes.collect { |size| size.split('x').max }.max.to_i
+            length * 3
+          else density
+          end
+        end
+
+        def convert_patch_extent(extent)
+          case extent
+          when :auto
+            if (size = sizes.first)
+              width, height = size.split 'x'
+              size if width != height
+            end
+          else extent
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file/mutable.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+require 'jekyll/favicon/utils'
+require 'jekyll/favicon/static_graphic_file'
+
+module Jekyll
+  module Favicon
+    class StaticFile < Jekyll::StaticFile
+      # Create static file based on a source file
+      module Mutable
+        def mutable?
+          mutation.any? || super
+        end
+
+        def mutation
+          refers = case @extname
+                   when '.xml'
+                     mutation_refers.select { |refer| refer.key? 'browserconfig' }
+                   else
+                     mutation_refers.collect { |refer| refer['webmanifest'] }
+                                    .compact
+                   end
+          patch(Utils.merge(*refers) || {})
+        end
+
+        # overrides Jekyll::StaticFile method
+        def mtime
+          return super if File.file? path
+        end
+
+        private
+
+        # overrides Jekyll::StaticFile method
+        def copy_file(dest_path)
+          # return unless mutable?
+          # return super(dest_path) unless mutation.any?
+
+          File.write dest_path, mutated_content
+        end
+
+        def mutated_content
+          case @extname
+          when '.json', '.webmanifest', '.manifest' then mutated_content_json
+          when '.xml' then mutated_content_xml
+          end
+        end
+
+        def mutated_content_json
+          mutated = Jekyll::Utils.deep_merge_hashes (mutable || {}), mutation
+          JSON.pretty_generate mutated
+        end
+
+        def mutated_content_xml
+          mutated = Utils.mutate_element (mutable || REXML::Document.new), mutation
+          output = String.new
+          mutated.write output
+          output
+        end
+
+        def mutable
+          return unless File.file? path
+
+          content = File.read path
+          case File.extname path
+          when '.xml' then REXML::Document.new content
+          else JSON.parse content
+          end
+        end
+
+        def mutation_refers
+          site.static_files
+              .select { |static_file| static_file.is_a? StaticFile }
+              .select(&:referenceable?)
+              .collect(&:refer)
+              .flatten
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file/referenceable.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/configuration/defaults'
+
+module Jekyll
+  module Favicon
+    class StaticFile < Jekyll::StaticFile
+      # Add reference to a static file
+      module Referenceable
+        include Configuration::Defaults
+
+        def referenceable?
+          refer.any?
+        end
+
+        def refer
+          patch spec.fetch('refer', [])
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file/sourceable.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/configuration/defaults'
+require 'jekyll/favicon/utils'
+
+module Jekyll
+  module Favicon
+    class StaticFile < Jekyll::StaticFile
+      # Add source to a static file
+      module Sourceable
+        include Configuration::Defaults
+
+        def sourceable?
+          source.any? && File.file?(path)
+        end
+
+        def source
+          Utils.merge sourceable_defaults, source_site, source_asset
+        end
+
+        # overrides Jekyll::StaticFile method
+        def path
+          File.join(*[@base, source_relative_path].compact)
+        end
+
+        def source_relative_path
+          source_relative_pathname.to_s
+        end
+
+        def self.source_normalize(options)
+          case options
+          when String
+            source_dir, source_name = File.split options
+            { 'dir' => source_dir, 'name' => source_name }
+          when Hash
+            Utils.compact options
+          else {}
+          end
+        end
+
+        def self.source_filter(options)
+          options.fetch 'source', {}
+        end
+
+        private
+
+        def source_relative_pathname
+          Pathname.new(source['dir'])
+                  .join(source['name'])
+                  .cleanpath
+        end
+
+        def source_defaults
+          sourceable_defaults
+        end
+
+        def source_site
+          site_config = Configuration.merged @site
+          config = Sourceable.source_filter site_config
+          Sourceable.source_normalize config
+        end
+
+        def source_spec
+          Sourceable.source_filter spec
+        end
+
+        def source_asset
+          Sourceable.source_normalize source_spec
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/static_file/taggable.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+require 'jekyll/favicon/configuration/defaults'
+require 'jekyll/favicon/utils'
+
+module Jekyll
+  module Favicon
+    class StaticFile < Jekyll::StaticFile
+      # Add tags to favicon's static files
+      module Taggable
+        include Configuration::Defaults
+
+        def taggable?
+          tags.any?
+        end
+
+        def tags
+          tag_spec.collect do |options|
+            tag_name, tag_options = options.first
+            tag_defaults = taggable_defaults[tag_name]
+            tag_attributes = tag_defaults.merge tag_options
+            tag_build tag_name, patch(tag_attributes)
+          end
+        end
+
+        private
+
+        def tag_spec
+          spec.fetch 'tag', []
+        end
+
+        # :reek:UtilityFunction
+        def tag_build(name, attributes = {})
+          config = attributes.transform_keys { |key| "_#{key}" }
+          Jekyll::Favicon::Utils.build_element name, nil, config
+        end
+
+        def mimetype
+          mappings = {
+            '.ico' => 'image/x-icon',
+            '.png' => 'image/png',
+            '.svg' => 'image/svg+xml'
+          }
+          mappings[extname]
+        end
+
+        def taggable_patch(configuration)
+          Favicon::Utils.patch configuration do |value|
+            case value
+            when :mime then mimetype
+            else value
+            end
+          end
+        end
+      end
+    end
+  end
+end