sutty-archives 2.3.0 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fef8ed446f2c81a26428e355f7b4c14923fdd56b9367db006f13464f909cac8
-  data.tar.gz: a2a0af5d85a97a779b0ca73f2300612ea333d2c2d99accd12bdc822673ba0874
+  metadata.gz: b8a095196aeb5056b025411ea4903f3f216c17ee98156f6510505b7b13c99d76
+  data.tar.gz: f0de3000044bece4ddc3304a340c4118dfdb72b049ee73fce0903167632e3eb8
 SHA512:
-  metadata.gz: 4933c5145a31350e62411b303ecba29f8b49a50e63baf4412ef02f6bb96f65cc82ac31febf86c459303ead1d1c7ccdcf1ce2586d323b03c53d26c7be2cdc42ab
-  data.tar.gz: 811cf946c59dbd7c297cfe201843f76f87e043a2d964434ae4e380dbb190eec710ee040526ef270d584aafb4df6a1956dd1d392593831d67f5c9a8957f4f1856
+  metadata.gz: 64d92442969a17a69f35af7c89e7496eeb8ff57ea7bf89cd8c8f8225eaeaa62157cbbd78e339cbfa4d87c01dcdf933b2c29ae1bde1b22352891a4d1ff322767d
+  data.tar.gz: 0ca2b534faeb9e035fd7fe95d488e4532732a9c83d4cc5f98ad8b1902ee6f0e2655275dc409e3deff3aea7823f0eede938f24e432a00e57d36b2381cb9b08eca

data/lib/jekyll-archives.rb

@@ -18,6 +18,7 @@ module Jekyll
 
       DEFAULTS = {
         "layout"     => "archive",
+        "group"      => false,
         "enabled"    => [],
         "titles"     => {},
         "replace"    => false,
@@ -56,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
@@ -76,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
@@ -92,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
@@ -119,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.
@@ -133,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

@@ -42,8 +42,16 @@ module Jekyll
 
         @data = { "layout" => layout }
 
+        if title.is_a?(Hash) && !date?
+          @data.merge! title
+        end
+
         @content = ""
 
+        data.default_proc = proc do |_, key|
+          site.frontmatter_defaults.find(relative_path, type, key)
+        end
+
         # 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?
@@ -79,9 +87,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
 
@@ -115,7 +123,7 @@ module Jekyll
       def title
         if @title.is_a? String
           @config.dig('titles', @title) || @title
-        elsif @type == 'category-tag'
+        elsif !date?
           @title.values.join(@config.fetch('separator', ' / '))
         end
       end
@@ -162,8 +170,9 @@ module Jekyll
 
       private
 
+      # Layout is a special attribute that can't be replaced
       def replace?
-        @config['replace'] && !(date? || @type == 'category-tag')
+        @config['replace'] && !@type.is_a?(Hash) && attribute != 'layout'
       end
 
       def attribute

data/lib/jekyll-archives/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Archives
-    VERSION = "2.3.0"
+    VERSION = "2.5.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sutty-archives
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Alfred Xing
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-29 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll