jekyll-strapi-4 1.0.1 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9c394936bf2f39c7240b27096421aebc65b84fe06d4b3c887716f539b25113
-  data.tar.gz: cc306d55554ed95f37286bae64dab6b303605682aff64bdbe7fbb4d317dde04e
+  metadata.gz: 890a4e54e493d7dad0427c788818ff0cc0910cbab5a1a3b78e552186ca2a9a22
+  data.tar.gz: b1d97a5db3865c4f07f1f190efd46babde09dd0af0ba55980b5e631939bbaeaf
 SHA512:
-  metadata.gz: d52f60e22d0c05a1cf949901c3f1e370724ea5ce1601688f7becdbb29523202c32abe0467792683d36e6b62890ae01c7685cfcd52bc6adf66c50a0dd192f0fba
-  data.tar.gz: 80b309439d826fae07014725b66682a8c88dd8e19fafd15290c30bef6cd75448f6e01869b495c7da1deabf03259c3244baad3d087bc651f84f0a50519912a463
+  metadata.gz: bcd4f926386f979f6753abdffaca1ca070dd9d1eb79c246699aae169b6cf97e1742bfb9e1ec7c5329b6ad3c38448625be6834849590616d351bcf4017362127c
+  data.tar.gz: f3d93f08761299ea162dd7dcc72ba4e5488a18253ba78203ea842f9add1dd3be3be23746cb63259d61e640807e78b9e1a808ccfde541871f058e61bfb20227e3

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
@@ -13,17 +19,17 @@ This plugin is based on the [jekyll-strapi](https://github.com/strapi-community/
 
 ## Install
 
-Add the "jekyll-strapi" gem to your Gemfile:
+Add the "jekyll-strapi-4" gem to your Gemfile:
 
 ```
-gem "jekyll-strapi"
+gem "jekyll-strapi-4"
 ```
 
-Then add "jekyll-strapi" to your plugins in `_config.yml`:
+Then add "jekyll-strapi-4" to your plugins in `_config.yml`:
 
 ```
 plugins:
-    - jekyll-strapi
+    - jekyll-strapi-4
 ```
 
 ## Configuration
@@ -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 → strapi4}/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/strapi4/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 → strapi4}/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 → strapi4}/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 → strapi4}/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Strapi
-    VERSION = "1.0.1"
+    VERSION = "1.0.7"
   end
 end

data/lib/jekyll-strapi-4.rb

@@ -0,0 +1,9 @@
+require 'jekyll/strapi4/strapihttp'
+require 'jekyll/strapi4/collection_permalink'
+require 'jekyll/strapi4/collection'
+require 'jekyll/strapi4/drops'
+require 'jekyll/strapi4/generator'
+require 'jekyll/strapi4/hooks'
+require 'jekyll/strapi4/site'
+require 'jekyll/strapi4/version'
+require 'jekyll/tags/strapiimagefilter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-strapi-4
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.7
 platform: ruby
 authors:
 - Strapi Solutions
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2022-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: down
@@ -77,14 +77,15 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- lib/jekyll-strapi.rb
-- lib/jekyll/strapi/collection.rb
-- lib/jekyll/strapi/drops.rb
-- lib/jekyll/strapi/generator.rb
-- lib/jekyll/strapi/hooks.rb
-- lib/jekyll/strapi/site.rb
-- lib/jekyll/strapi/strapihttp.rb
-- lib/jekyll/strapi/version.rb
+- lib/jekyll-strapi-4.rb
+- lib/jekyll/strapi4/collection.rb
+- lib/jekyll/strapi4/collection_permalink.rb
+- lib/jekyll/strapi4/drops.rb
+- lib/jekyll/strapi4/generator.rb
+- lib/jekyll/strapi4/hooks.rb
+- lib/jekyll/strapi4/site.rb
+- lib/jekyll/strapi4/strapihttp.rb
+- lib/jekyll/strapi4/version.rb
 - lib/jekyll/tags/strapiimagefilter.rb
 homepage: https://github.com/bluszcz/jekyll-strapi-4
 licenses:

data/lib/jekyll-strapi.rb

@@ -1,8 +0,0 @@
-require 'jekyll/strapi/strapihttp'
-require 'jekyll/strapi/collection'
-require 'jekyll/strapi/drops'
-require 'jekyll/strapi/generator'
-require 'jekyll/strapi/hooks'
-require 'jekyll/strapi/site'
-require 'jekyll/strapi/version'
-require 'jekyll/tags/strapiimagefilter'