sutty-archives 2.2.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 504d81958bc2f61213d04212cd3988a17131869a0dff5e294f0782e353515f43
-  data.tar.gz: cb58a0438cdd6bbf51c33ac2bea2f33e5862498039d81d74c9bb56d94fe48c44
+  metadata.gz: 3918e23c7f0f639664eed1261c58a5973db93970f24e1af22ec7d030cf1496b6
+  data.tar.gz: 4711190c26d0aa7f9faed300fac83a95f9539c32a688f7f80debbf5785c8a4fe
 SHA512:
-  metadata.gz: b25f4cc57b9b894980af8c95a65d3e6c35b5ef68de2c91c983d11a7c53300f96116592f20a364e7aae34c71aa028ac98ebcbe421324a9b43b2f5cbf851889f26
-  data.tar.gz: 4259f6adafecb055f17404b46b1ba0a2033bc68905a174bca902dfdd09151ab9eb5f293d35ad37ae190e04de6c740b71107389a43734ac31c30180d64acc6a8b
+  metadata.gz: 6b4afccab4860c41e8e8114384ab24c3f0046d0d26200a91f4525198e6e21e20c123585442377ac96fa78fc7bffc1f75c87be5a8158360a5bf129704865da592
+  data.tar.gz: b70a075de1cf8488000c3de90ec38ed3bb2c932bf62d49076a6aeec84fc150f4bdb648c2cd1e079b397263aec7185b3c327cd41f4c872e51698b182cbe8a11e1

data/lib/jekyll-archives.rb

@@ -18,15 +18,18 @@ module Jekyll
 
       DEFAULTS = {
         "layout"     => "archive",
+        "group"      => false,
         "enabled"    => [],
+        "titles"     => {},
+        "replace"    => false,
         "permalinks" => {
           "year"     => "/:year/",
           "month"    => "/:year/:month/",
           "day"      => "/:year/:month/:day/",
           "tag"      => "/tag/:name/",
           "category" => "/category/:name/",
-          "category-tag" => "/category/:category/tag/:tag/"
-        },
+          "category-tag" => "/category/:category/tag/:tag/",
+        }
       }.freeze
 
       def initialize(config = {})
@@ -54,14 +57,15 @@ module Jekyll
         read
         @site.pages.concat(@archives)
 
-        @site.config["archives"] = @archives
+        @site.config["archives"] = @archives unless group?
       end
 
       # Read archive data from posts
       def read
+        read_combined if combined?
         read_attrs
-        read_categories_tags
         read_dates
+        read_types if group?
       end
 
       # Read and group by attributes, using the legacy names when
@@ -74,6 +78,12 @@ module Jekyll
             next unless attr_title_enabled? attr, title
 
             @archives << Archive.new(@site, title, attr, posts)
+
+            next unless group?
+
+            @site.config['archives'] ||= {}
+            @site.config['archives'][attr] ||= []
+            @site.config['archives'][attr] << @archives.last
           end
         end
       end
@@ -90,17 +100,57 @@ module Jekyll
         end
       end
 
-      def read_categories_tags
-        if enabled? "categories-tags"
-          @site.categories.each do |category, posts|
-            posts.map { |post| post.data['tags'] }.flatten.uniq.compact.each do |tag|
-              category_tag_posts = posts.select do |post|
-                post.data['categories'].include?(category) &&
-                  post.data['tags'].include?(tag)
-              end
-
-              @archives << Archive.new(@site, { category: category, tag: tag }, "category-tag", category_tag_posts)
+      # Archive posts by a combination of attributes.
+      def read_combined
+        # We can have many combination archives
+        @config['combined'].each do |type, combined|
+          # This is an empty map so we can have all keys on the result
+          empty_combination = Hash[combined.map{|k| [k,nil]}]
+
+          # We collect all posts
+          @posts.docs.map do |post|
+            # Array of Jekyll::Document and Hash of values, some may be
+            # empty.
+            [ post, empty_combination.merge(**post.data.slice(*combined)) ]
+          end.select do |combination|
+            # We skip Documents that don't have any of the attributes
+            combination.last.none? do |_, e|
+              # TODO: Move to its own method
+              e.nil? || (e.respond_to?(:empty?) && e.empty?) || (e.respond_to?(:blank?) && e.blank?) || (e.respond_to?(:zero?) && e.zero?)
+            end
+          end.map do |post, data|
+            # Since the values can be Arrays, we'll generate all
+            # combinations
+            data.values.reduce do |memo, value|
+              # XXX: Ensure value is an Array, it could be a String or other
+              # value.
+              (memo.is_a?(Array) ? memo : [memo]).product([value].flatten)
+            end.map(&:flatten).map do |v|
+              # Recreate a Hash of attribute and single value for each
+              # combination
+              data.keys.zip(v)
+            end.map do |hash|
+              # Recreate the first collection of Document and Hash for
+              # each combination.
+              [ post, Hash[hash] ]
+            end
+          end.flatten(1).group_by(&:last).transform_values(&:flatten).transform_values do |v|
+            # Create groups by value combinations and select only
+            # Documents
+            v.select do |p|
+              p.is_a? Jekyll::Document
             end
+          end.each do |combination, posts|
+            # Then create Archives for them.
+            archive = Archive.new(@site, combination, type, posts)
+
+            @archives << archive
+
+            next unless group?
+
+            @site.config['archives'] ||= {}
+            @site.config['archives'][type] ||= []
+            @site.config['archives'][type] << archive
           end
         end
       end
@@ -117,6 +167,21 @@ module Jekyll
         end
       end
 
+      # Generates Archives by Archive type
+      def read_types
+        @config['enabled'].each do |type|
+          type = LEGACY_ATTRS[type] if LEGACY_ATTRS[type]
+
+          @archives << Archive.new(@site, type, 'group', @site.config['archives'][type].map(&:posts).flatten.uniq)
+        end
+
+        return unless combined?
+
+        @config['combined'].each do |type, _|
+          @archives << Archive.new(@site, type, 'group', @site.config['archives'][type].map(&:posts).flatten.uniq)
+        end
+      end
+
       # Return the front matter attributes to archive by, using the
       # legacy names unless specified and leaving out the date
       # attributes.
@@ -131,6 +196,16 @@ module Jekyll
         @enabled == true || @enabled == "all" || (@enabled.is_a?(Array) && @enabled.include?(archive))
       end
 
+      # Checks if we want grouped archives
+      def group?
+        @config['group']
+      end
+
+      # Check if we have combined archives
+      def combined?
+        @config['combined'].is_a?(Hash)
+      end
+
       # Custom `post_attr_hash` method for years
       def years
         date_attr_hash(@posts.docs, "%Y")

data/lib/jekyll-archives/archive.rb

@@ -40,10 +40,24 @@ module Jekyll
         @path = relative_path
         @name = File.basename(relative_path, @ext)
 
-        @data = {
-          "layout" => layout,
-        }
+        @data = { "layout" => layout }
+
+        if title.is_a?(Hash) && !date?
+          @data.merge! title
+        end
+
         @content = ""
+
+        # Replace the value with the archive except for date and
+        # category-tag.  For category-tag, do we want to replace the
+        # category or the tag?
+        return unless replace?
+        @posts.each do |post|
+          case post.data[attribute]
+          when Array then post.data[attribute].map!{|v| (v == title) ? self : v }
+          else post.data[attribute] = self
+          end
+        end
       end
 
       # The template of the permalink.
@@ -51,7 +65,7 @@ module Jekyll
       # Returns the template String.
       def template
         t = @config.dig("permalinks", type)
-        t = t.is_a?(Hash) ? t[title] : t
+        t = t.is_a?(Hash) ? t[@title] : t
 
         t || "/#{type}/:name/"
       end
@@ -69,9 +83,9 @@ module Jekyll
         if @title.is_a? Hash
           placeholders = @title.merge(:type => @type)
 
-          if @type == 'category-tag'
-            %i[category tag].each do |k|
-              placeholders[k] = Utils.slugify(@title[k], mode: @config.dig('slug'))
+          unless date?
+            placeholders.transform_values! do |v|
+              Utils.slugify(v, mode: @config.dig('slug'))
             end
           end
 
@@ -104,8 +118,8 @@ module Jekyll
       # date-based archives.
       def title
         if @title.is_a? String
-          @title
-        elsif @type == 'category-tag'
+          @config.dig('titles', @title) || @title
+        elsif !date?
           @title.values.join(@config.fetch('separator', ' / '))
         end
       end
@@ -152,6 +166,18 @@ module Jekyll
 
       private
 
+      def replace?
+        @config['replace'] && !@type.is_a?(Hash)
+      end
+
+      def attribute
+        case type
+        when 'tag' then 'tags'
+        when 'category' then 'categories'
+        else type
+        end
+      end
+
       # Generate slug if @title attribute is a string.
       #
       # Note: mode other than those expected by Jekyll returns the given string after

data/lib/jekyll-archives/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Archives
-    VERSION = "2.2.2"
+    VERSION = "2.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sutty-archives
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Alfred Xing
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Post archives for Jekyll.  Fork of jekyll-archives.