jekyll-strapi-4 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b60b83febefc6dfb99cc3f9d41cc0e4e2f82bce56e1e166ca6a04045357794f9
-  data.tar.gz: a7a6f9c335cb714d7c52dc06ffd240eb70e18d3918c2b3eef0f9f8ab24dfb055
+  metadata.gz: 4887f2576e671600cbba2f9d2243c5d5da9750233fc587b0fc925cd951188e2c
+  data.tar.gz: f4511e5d6e3d2965abb98abd9b22b1792298878c7f64f663d1e570cb3dd4a4db
 SHA512:
-  metadata.gz: 47db6f927bd95d671ca094db0dd4d0ca591401b2b3a1b3ae141097ae43fa7bef1530355cc8192f6d63803b58f8f53c97a584b045fb9fac90b57e1bc16382d66d
-  data.tar.gz: 59e61272e81d10fff14524436f6a57cdee50518d3e9f699bdafdc486f001c62495c2c611c25d59fa7375edaf33651571978c019f13ae427b519b3c3079ff5523
+  metadata.gz: 4497758093430c168cc01674e7c9d3a270a82e29ef4dbb0162fb5f59d3e7004fccc193f0999bf7bc66767d506637c5d5f079f952815696d06ed8feebf2ec7462
+  data.tar.gz: ab120a2d4a43877a9c447e18296448e82cd60ec8f4daa3ba710cb32d8283a7bce56ad18e754d906a62a0f1cf5c01137b2637a10c10064ca362e8cee8f91c3a82

data/README.md

@@ -2,6 +2,12 @@
 
 This plugin is based on the [jekyll-strapi](https://github.com/strapi-community/jekyll-strapi/) plugin. 
 
+![](deer-jekyll-strapi-4.png?raw=true)
+
+Q: Why the Deer for logo?
+
+A: Every project deserves to have the cute deer as a logo.
+
 ## Features
 
 * Support for Strapi 4
@@ -41,6 +47,9 @@ strapi:
             # type: photos
             # Permalink used to generate the output files (eg. /articles/:id).
             permalink: /photos/:id/
+            # Permalinks defined for different locales
+            permalinks:
+              pl: "/zdjecia/:id"
             # Parameters (optional)
             parameters:
               sort: title:asc
@@ -130,3 +139,29 @@ module Jekyll
   end
 end
 ```
+
+### Permalinks
+
+When you have a multi-language content, you might want generate a proper url based on different patterns, for example:
+| Language | permalink pattern | example |
+| ----------- | ----------- | - |
+| en | /image/:slug |yourdomain.com/image/orange/ |
+| es | /imagen/:slug | yourdomain.com/imagen/naranja/ |
+| pl | /zdjecie/:slug | yourdomain.com/zdjecie/pomarancza/ |
+
+In that case you have to
+1. set locales [on request parameters](#request-parameters),
+2. set permalinks patterns [on _config.yml](#configuration).
+
+When you create permalinks, set default permalink and optionals permalinks.
+
+```yaml
+strapi:
+  collections:
+    photos:
+      permalink: /image/:slug/
+      permalinks:
+        es: /imagen/:slug
+        pl: /zdjecia/:slug
+
+```

data/lib/jekyll/strapi/collection.rb

@@ -60,6 +60,10 @@ module Jekyll
         @config['type'] || @collection_name
       end
 
+      def permalink
+        @permalink ||= StrapiCollectionPermalink.new(collection: self, lang: @site.lang)
+      end
+
       def populate
         @config["populate"] || "*"
       end

data/lib/jekyll/strapi/collection_permalink.rb

@@ -0,0 +1,38 @@
+module Jekyll
+  module Strapi
+    class StrapiCollectionPermalink
+      attr_reader :collection, :lang
+
+      def initialize(collection:, lang: nil)
+        @collection = collection
+        @lang = lang
+      end
+
+      def directory
+        use_different? ? permalinks[lang].split("/")[1] : collection.collection_name
+      end
+
+      def exist?
+        config.key? 'permalink'
+      end
+
+      def to_s
+        use_different? ? permalinks[lang] : config['permalink']
+      end
+
+      private
+
+      def config
+        collection.config
+      end
+
+      def permalinks
+        config['permalinks']
+      end
+
+      def use_different?
+        permalinks && permalinks[lang]
+      end
+    end
+  end
+end

data/lib/jekyll/strapi/generator.rb

@@ -22,15 +22,31 @@ module Jekyll
         @collection = collection
         @document = document
 
-        @dir = @collection.config['output_dir'] || collection.collection_name
+        @site.lang = @document.attributes.locale
+
+        @dir = @collection.config['output_dir'] || collection.permalink.directory
+
+        url = Jekyll::URL.new(
+          :placeholders => {
+            :id => document.id.to_s,
+            :uid => document.uid,
+            :slug => document.attributes.slug,
+            :type => document.attributes.type,
+            :date => document.attributes.date,
+            :title => document.title
+          },
+          permalink: collection.permalink.to_s
+        )
+
         # Default file name, can be overwritten by permalink frontmatter setting
-        @name = "#{document.id}.html"
+        file_name = url.to_s.split("/").last
+        @name = "#{file_name}.html"
         # filename_to_read = File.join(base, "_layouts"), @collection.config['layout']
 
         self.process(@name)
         self.read_yaml(File.join(base, "_layouts"), @collection.config['layout'])
-        if @collection.config.key? 'permalink'
-          self.data['permalink'] = @collection.config['permalink']
+        if @collection.permalink.exist?
+          self.data['permalink'] = @collection.permalink.to_s
         end
 
         self.data['document'] = StrapiDocumentDrop.new(@document)

data/lib/jekyll/strapi/site.rb

@@ -1,6 +1,8 @@
 module Jekyll
   # Add helper methods for dealing with Strapi to the Site class
   class Site
+    attr_accessor :lang
+
     def strapi
       return nil unless has_strapi?
     end
@@ -25,7 +27,7 @@ module Jekyll
     def strapi_link_resolver(collection = nil, document = nil)
       return "/" unless collection != nil and @config['strapi']['collections'][collection]['permalink'] != nil
       url = Jekyll::URL.new(
-        :template => @config['strapi']['collections'][collection]['permalink'],
+        :template => url_template(collection),
         :placeholders => {
           :id => document.id.to_s,
           :uid => document.uid,
@@ -42,5 +44,13 @@ module Jekyll
     def strapi_collection(collection_name)
       strapi_collections[collection_name]
     end
+
+    def url_template(collection)
+      permalink = @config['strapi']['collections'][collection]['permalink']
+      permalinks = @config['strapi']['collections'][collection]['permalinks']
+
+      return permalink unless permalinks && permalinks[lang]
+      "/#{lang}#{permalinks[lang]}"
+    end
   end
 end

data/lib/jekyll/strapi/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Strapi
-    VERSION = "1.0.0"
+    VERSION = "1.0.4"
   end
 end

data/lib/jekyll-strapi.rb

@@ -1,4 +1,5 @@
 require 'jekyll/strapi/strapihttp'
+require 'jekyll/strapi/collection_permalink'
 require 'jekyll/strapi/collection'
 require 'jekyll/strapi/drops'
 require 'jekyll/strapi/generator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-strapi-4
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Strapi Solutions
@@ -79,6 +79,7 @@ files:
 - README.md
 - lib/jekyll-strapi.rb
 - lib/jekyll/strapi/collection.rb
+- lib/jekyll/strapi/collection_permalink.rb
 - lib/jekyll/strapi/drops.rb
 - lib/jekyll/strapi/generator.rb
 - lib/jekyll/strapi/hooks.rb
@@ -86,7 +87,7 @@ files:
 - lib/jekyll/strapi/strapihttp.rb
 - lib/jekyll/strapi/version.rb
 - lib/jekyll/tags/strapiimagefilter.rb
-homepage: https://github.com/strapi/jekyll-strapi
+homepage: https://github.com/bluszcz/jekyll-strapi-4
 licenses:
 - MIT
 metadata: {}