jekyll-favicon 0.2.9 → 1.0.0.pre.1

data/lib/jekyll/favicon/static_graphic_file.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/static_file'
+require 'jekyll/favicon/static_file/convertible'
+
+module Jekyll
+  module Favicon
+    # Favicon::StaticFile subclass
+    class StaticGraphicFile < StaticFile
+      include StaticFile::Convertible
+
+      def generable?
+        convertible? && super
+      end
+
+      def patch(configuration)
+        convertible_patch super(configuration)
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/tag.rb

@@ -1,23 +1,21 @@
+# frozen_string_literal: true
+
+require 'liquid'
+require 'jekyll/favicon/static_file'
+
 module Jekyll
   module Favicon
-    # New `favicon` tag for favicon include on templates
+    # New `favicon` tag include html tags on templates
     class Tag < Liquid::Tag
-      def initialize(tag_name, text, tokens)
-        super
-        @text = text
-      end
-
+      # :reek:UtilityFunction
       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|
-          template_path = File.join templates_dir, "#{template}.html.erb"
-          ERB.new(File.read(template_path), nil, '-').result(binding).strip
-        end
-        foot = '<!-- End Jekyll Favicon tag -->'
-        [head, body.join("\n"), foot].join("\n")
+        context.registers[:site]
+               .static_files
+               .select { |static_file| static_file.is_a? StaticFile }
+               .select(&:taggable?)
+               .collect(&:tags)
+               .flatten
+               .join("\n")
       end
     end
   end

data/lib/jekyll/favicon/utils.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'jekyll/favicon/utils/configuration/compact'
+require 'jekyll/favicon/utils/configuration/merge'
+require 'jekyll/favicon/utils/configuration/patch'
+require 'jekyll/favicon/utils/convert'
+require 'jekyll/favicon/utils/tag'
+
+module Jekyll
+  module Favicon
+    # Favicon utils functions
+    module Utils
+      include Configuration::Compact
+      include Configuration::Merge
+      include Configuration::Patch
+      include Convert
+      include Tag
+
+      def self.except(hash, *keys)
+        hash.reject { |key, _| keys.include? key }
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/utils/configuration/compact.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Favicon
+    module Utils
+      module Configuration
+        # Favicon configuration compact logic
+        module Compact
+          def self.included(klass)
+            klass.extend(ClassMethods)
+          end
+
+          # Nil and empty remove from configurations
+          module ClassMethods
+            def compact(compactable)
+              case compactable
+              when Hash, Array
+                compact_deep(compactable) || compactable.class[]
+              else
+                compactable
+              end
+            end
+
+            private
+
+            def compact_deep(compactable)
+              case compactable
+              when Hash then compact_hash compactable
+              when Array then compact_array compactable
+              else compactable
+              end
+            end
+
+            def compact_hash(hash)
+              compacted_hash = hash.each_with_object({}) do |(key, value), memo|
+                next unless (compacted = compact_deep(value))
+
+                memo[key] = compacted
+              end
+              compact_shallow compacted_hash
+            end
+
+            def compact_array(array)
+              compacted_array = array.each_with_object([]) do |value, memo|
+                next unless (compacted = compact_deep(value))
+
+                memo << compacted
+              end
+              compact_shallow compacted_array
+            end
+
+            # :reek:UtilityFunction
+            def compact_shallow(compactable)
+              compactable.empty? ? nil : compactable.compact
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/utils/configuration/merge.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Favicon
+    module Utils
+      module Configuration
+        # Favicon configuration merge logic
+        module Merge
+          def self.included(klass)
+            klass.extend(ClassMethods)
+          end
+
+          # Merge configurations
+          module ClassMethods
+            def merge(left = nil, *right_and_or_rest)
+              return left if right_and_or_rest.empty?
+
+              right, *rest = right_and_or_rest
+              merged = merge_pair left, right
+              return merged if rest.empty?
+
+              merge(merged, *rest)
+            end
+
+            private
+
+            def merge_pair(left, right)
+              return right if !left || !right || !left.instance_of?(right.class)
+
+              case right
+              when Hash then merge_pair_hash left, right
+              when Array then merge_pair_array left, right
+              else right
+              end
+            end
+
+            def merge_pair_hash(left_hash, right_hash)
+              left_hash.merge(right_hash) do |_, left_value, right_value|
+                merge left_value, right_value
+              end
+            end
+
+            def merge_pair_array(left_array, right_array)
+              joint_array = left_array + right_array
+              joint_array.group_by { |map| merge_group map }
+                         .collect { |group, values| merge_collect group, values }
+                         .flatten
+            end
+
+            # :reek:UtilityFunction
+            def merge_group(map, keys = %w[name dir])
+              map.is_a?(Hash) ? map.values_at(*keys) : []
+            end
+
+            def merge_collect(group, values)
+              group.first ? merge(*values) : values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/utils/configuration/patch.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Favicon
+    module Utils
+      module Configuration
+        # Favicon configuration patch logic
+        module Patch
+          def self.included(klass)
+            klass.extend(ClassMethods)
+          end
+
+          # Patch configuration with the block provided
+          module ClassMethods
+            def patch(value_or_values, &block)
+              patch_method = case value_or_values
+                             when Array then :patch_array
+                             when Hash then :patch_hash
+                             when Symbol, String then :patch_value
+                             else return value_or_values
+                             end
+              send patch_method, value_or_values, &block
+            end
+
+            private
+
+            def patch_array(values, &block)
+              values.collect { |value| patch value, &block }
+            end
+
+            def patch_hash(values, &block)
+              values.transform_values { |value| patch value, &block }
+            end
+
+            def patch_value(value, &block)
+              block.call patch_value_string_symbol(value)
+            end
+
+            # :reek:UtilityFunction
+            def patch_value_string_symbol(value)
+              value.to_s.start_with?(':') ? value[1..-1].to_sym : value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/utils/convert.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'mini_magick'
+
+module Jekyll
+  module Favicon
+    module Utils
+      # Favicon convert for include
+      module Convert
+        def self.included(klass)
+          klass.extend(ClassMethods)
+        end
+
+        # Favicon convert utils functions
+        module ClassMethods
+          def convert(input, output, options = {})
+            MiniMagick::Tool::Convert.new do |convert|
+              convert.flatten
+              convert_options(convert, options) << input << output
+            end
+          end
+
+          private
+
+          def convert_options(convert, options = {})
+            priorities = %w[resize scale]
+            convert_apply convert, options.slice(*priorities)
+            common_options = options.reject { |key| priorities.include? key }
+            convert_apply convert, common_options
+          end
+
+          # :reek:UtilityFunction
+          def convert_apply(convert, options = {})
+            options.each_with_object(convert) do |(option, value), memo|
+              memo.send option.to_sym, value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/utils/tag.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'rexml/document'
+
+module Jekyll
+  module Favicon
+    module Utils
+      # Favicon rexml for include
+      module Tag
+        def self.included(klass)
+          klass.extend(ClassMethods)
+        end
+
+        # Favicon rexml utils functions
+        module ClassMethods
+          # :reek:FeatureEnvy
+          def mutate_element(parent, changes = {})
+            changes.each_with_object(parent) do |(key, value), memo|
+              if key.start_with? '__' then memo.text = value
+              elsif key.start_with? '_' then memo.add_attribute key[1..-1], value
+              else mutate_element mutate_find_or_create_element(memo, key), value
+              end
+            end
+          end
+
+          def build_element(name, parent = nil, config = {})
+            element = REXML::Element.new name, parent
+            return populate_element element, config if config.is_a? Enumerable
+
+            element.text = config and return element
+          end
+
+          private
+
+          # :reek:UtilityFunction
+          def mutate_find_or_create_element(parent, key)
+            parent.get_elements(key).first || parent.add_element(key)
+          end
+
+          # :reek:FeatureEnvy
+          def populate_element(element, config)
+            config.each_with_object(element) do |(key, value), memo|
+              if key.start_with? '__' then memo.text = value
+              elsif (child_key = key.match(/^_(.*)$/))
+                memo.add_attribute child_key[1], value
+              else build_element key, memo, value
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/favicon/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Favicon
-    VERSION = '0.2.9'.freeze
+    VERSION = '1.0.0-1'
   end
 end

metadata

@@ -1,111 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-favicon
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 1.0.0.pre.1
 platform: ruby
 authors:
 - Alvaro Faundez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-10 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.8'
 - !ruby/object:Gem::Dependency
   name: minitest-hooks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.4.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.4.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.54.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.54.0
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.54.0
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -130,16 +90,36 @@ dependencies:
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.4
+        version: 3.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.4
+        version: 3.2.5
 description: Jekyll-favicon is a jekyll plugin that adds the tag favicon, generating
   html tags for favicon.
 email:
@@ -148,43 +128,60 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- config/jekyll/favicon.yml
+- config/jekyll/favicon/static_file.yml
+- config/jekyll/favicon/static_file/convertible.yml
+- config/jekyll/favicon/static_file/mutable.yml
+- config/jekyll/favicon/static_file/referenceable.yml
+- config/jekyll/favicon/static_file/sourceable.yml
+- config/jekyll/favicon/static_file/taggable.yml
+- gemfiles/jekyll36.gemfile
+- gemfiles/jekyll37.gemfile
+- gemfiles/jekyll38.gemfile
+- gemfiles/jekyll39.gemfile
+- gemfiles/jekyll40.gemfile
+- gemfiles/jekyll41.gemfile
+- gemfiles/jekyll42.gemfile
 - jekyll-favicon.gemspec
-- lib/browserconfig.rb
-- lib/hash.rb
-- lib/image.rb
 - lib/jekyll-favicon.rb
 - lib/jekyll/favicon.rb
-- lib/jekyll/favicon/config/defaults.yml
+- lib/jekyll/favicon/configuration.rb
+- lib/jekyll/favicon/configuration/defaults.rb
 - lib/jekyll/favicon/generator.rb
 - lib/jekyll/favicon/hooks.rb
-- lib/jekyll/favicon/icon.rb
-- lib/jekyll/favicon/metadata.rb
+- lib/jekyll/favicon/static_data_file.rb
+- lib/jekyll/favicon/static_file.rb
+- lib/jekyll/favicon/static_file/convertible.rb
+- lib/jekyll/favicon/static_file/mutable.rb
+- lib/jekyll/favicon/static_file/referenceable.rb
+- lib/jekyll/favicon/static_file/sourceable.rb
+- lib/jekyll/favicon/static_file/taggable.rb
+- lib/jekyll/favicon/static_graphic_file.rb
 - lib/jekyll/favicon/tag.rb
-- lib/jekyll/favicon/templates/chrome.html.erb
-- lib/jekyll/favicon/templates/classic.html.erb
-- lib/jekyll/favicon/templates/ie.html.erb
-- lib/jekyll/favicon/templates/safari.html.erb
+- lib/jekyll/favicon/utils.rb
+- lib/jekyll/favicon/utils/configuration/compact.rb
+- lib/jekyll/favicon/utils/configuration/merge.rb
+- lib/jekyll/favicon/utils/configuration/patch.rb
+- lib/jekyll/favicon/utils/convert.rb
+- lib/jekyll/favicon/utils/tag.rb
 - lib/jekyll/favicon/version.rb
-- lib/string.rb
-- lib/webmanifest.rb
 homepage: https://github.com/afaundez/jekyll-favicon
 licenses:
 - MIT
@@ -197,14 +194,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: Jekyll plugin for favicon tag generation.