jekyll-generator-single-source 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d73df7a11546176e1abbb848a3e19abb3f7eb6e19d93eb7279de71eb420319
-  data.tar.gz: e21334cabb7fca2ec15a0a8b477f315a526c061fb7c5f90c6fe174092160c363
+  metadata.gz: ac862876c4b0e34ef850bd8b001b68207f6288c6f224dabd9377a3ea0c759477
+  data.tar.gz: 196a02a6f09e9dab22bfb4a7e2b2f955ca8d8e183a35c3733c64919b127a6ba7
 SHA512:
-  metadata.gz: 27dd0027533708af634579e6f865286344e50081ee7aec99e3e90d180b7b43eeaf5839827517c8c955d9fe2cdbe4ef1736f06fecc5371f1fefe553d4c3a29c9c
-  data.tar.gz: af2050ed5376650c6957c659261cae93076653de7836db13909cefd90e9e1177ec1e7aacfeee26105733e3211d69400cfcb375e5945a6eb518f965d9077b3636
+  metadata.gz: 6143209587a0aed21f1a1a3ed245618e1e8a4b18db273652b50b22f9f50afd30ff3e69b272a44ab2e7cde268be2bd6c29a0c52776b94aabb2f6683a7ffd0e062
+  data.tar.gz: e5a9766a4bc1f9b8727f5961e99cf90d4072d7de57cef73037e84868f231c17feb4c1435612a2e58d431814ebbc8a07198d1debf87e7980482f8a9a9ef1902e9

data/lib/jekyll/generator-single-source/doc_nav_config.rb

@@ -3,13 +3,17 @@
 module Jekyll
   module GeneratorSingleSource
     class DocNavConfig
-      attr_reader :file_path, :site
+      attr_reader :site
 
-      def initialize(file_path, site)
-        @file_path = file_path
+      def initialize(i18n_file:, site:)
+        @i18n_file = i18n_file
         @site      = site
       end
 
+      def missing_translation?
+        @i18n_file.missing_translation?
+      end
+
       def skip_generation?
         # skip if release is not available because it
         # was skipped using an ENV variable
@@ -49,12 +53,24 @@ module Jekyll
 
       def config
         @config ||= begin
-                      config = NavConfig::Base.process(@file_path)
+                      config = NavConfig::Base.process(@i18n_file.full_file_path_in_default_locale)
                       Jekyll.logger.debug("generated config: #{config.to_json}")
                       config
                     end
       end
 
+      def nav_items_in_locale(locale)
+        @nav_items_in_locale ||= Hash.new do |h, key|
+          h[key] = if key == I18n.default_locale.to_s
+                     config
+                   else
+                     NavConfig::Base.process(@i18n_file.full_file_path_in_locale)
+                   end
+
+        end
+        @nav_items_in_locale[locale]
+      end
+
       private
 
       def edition

data/lib/jekyll/generator-single-source/doc_nav_item/base.rb

@@ -17,7 +17,7 @@ module Jekyll
           end
         end
 
-        def_delegators :@top_level_config, :site, :config, :product,
+        def_delegators :@top_level_config, :site, :nav_items_in_locale, :product,
                        :versions, :assume_generated?, :release
 
         def initialize(item_config, top_level_config)
@@ -53,15 +53,45 @@ module Jekyll
         end
 
         def source
-          @source ||= Source::Base.make_for(path: source_path, site: site)
+          @source ||= Source::Base.make_for(
+            path: source_path,
+            site: site,
+            locale: site.config['locale']
+          )
         end
 
         def dest
           @dest ||= OpenStruct.new(file_path: dest_path)
         end
 
+        def translation_fallback?
+          return false if site.config['locale'] == I18n.default_locale.to_s
+
+          missing_translation?
+        end
+
+        def relative_path
+          @relative_path ||= begin
+                               if !site.config['locale'] || site.config['locale'] == I18n.default_locale.to_s
+                                 source.file_path
+                               else
+                                 if translation_fallback?
+                                   source.file_path
+                                 else
+                                   File.join(site.config['translated_content_path'], source.file_path)
+                                 end
+                               end
+                             end
+        end
+
         private
 
+        def missing_translation?
+          return true if @top_level_config.missing_translation?
+
+          source.missing_translation?
+        end
+
         def multiple_products?
           GeneratorConfig.new(site).multiple_products?
         end

data/lib/jekyll/generator-single-source/generator.rb

@@ -1,17 +1,32 @@
 # frozen_string_literal: true
 
+require'pathname'
+
 module Jekyll
   module GeneratorSingleSource
     class Generator < Jekyll::Generator
-      priority :highest
+      priority :high
 
       def generate(site)
         config = GeneratorConfig.new(site)
 
         Dir.glob(File.join(config.docs_nav_folder, 'docs_nav_*.yml')).each do |f|
-          DocNavConfig.new(f, site).generate_pages
+          i18n_file = build_i18n_file(site:, file: f, config:)
+
+          # Use docs_nav_files in english as source of truth
+          # to generate the pages
+          DocNavConfig.new(i18n_file:, site:).generate_pages
         end
       end
+
+      def build_i18n_file(site:, file:, config:)
+        I18nFile.new(
+          file: Pathname.new(file).basename.to_s,
+          src_path: config.docs_nav_folder.gsub("#{site.source}/", ''),
+          locale: site.config['locale'],
+          site:
+        )
+      end
     end
   end
 end

data/lib/jekyll/generator-single-source/generator_config.rb

@@ -37,6 +37,18 @@ module Jekyll
         config['base_dest_path']
       end
 
+      def build_docs_nav(edition:, release: nil)
+        file = release.nil? ? "docs_nav_#{edition}.yml" :"docs_nav_#{edition}_#{release}.yml"
+        i18n_file = I18nFile.new(
+          file: file,
+          src_path: config.fetch('docs_nav_folder'),
+          locale: @site.config['locale'],
+          site:
+        )
+
+        DocNavConfig.new(i18n_file: i18n_file, site: @site)
+      end
+
       private
 
       def config

data/lib/jekyll/generator-single-source/i18n_file.rb

@@ -0,0 +1,73 @@
+module Jekyll
+  module GeneratorSingleSource
+    class I18nFile
+      class MissingI18nFile < StandardError; end
+
+      attr_reader :locale, :src_path
+
+      def self.exists?(file:, locale:, src_path:, site:)
+        new(file:, locale:, src_path:, site:).exists?
+      end
+
+      def initialize(file:, locale:, src_path:, site:)
+        @file     = file # unlocalized file format
+        @locale   = locale # locale in which we want the file
+        @src_path = src_path # src_path relative to app
+        @site     = site
+      end
+
+      def full_file_path_in_default_locale
+        @full_file_path_in_default_locale ||= File.join(@site.source, @src_path, @file)
+      end
+
+      def full_file_path_in_locale
+        @full_file_path_in_locale ||= if @locale == I18n.default_locale.to_s
+                                        full_file_path_in_default_locale
+                                      else
+                                        full_file_path_in_locale_with_fallback
+                                      end
+      end
+
+      def missing_translation?
+        !exists_in_locale?
+      end
+
+      def exists?
+        File.exist?(full_file_path_in_locale)
+      end
+
+      def exists_in_locale?
+        if @locale == I18n.default_locale.to_s
+          File.exist?(full_file_path_in_default_locale)
+        else
+          File.exist?(full_file_path_in_locale_folder)
+        end
+      end
+
+      # path to the file relative to src_path including
+      def relative_file_path
+        @relative_file_path ||= if @src_path.to_s.empty?
+                                  @file
+                                else
+                                  File.join(@src_path, @file)
+                                end
+      end
+
+      private
+
+      def full_file_path_in_locale_with_fallback
+        if File.exist?(full_file_path_in_locale_folder)
+          full_file_path_in_locale_folder
+        else
+          full_file_path_in_default_locale
+        end
+      end
+
+      def full_file_path_in_locale_folder
+        @full_file_path_in_locale_folder ||= File.join(
+          File.expand_path(@site.config['translated_content_path'] || '', @site.source), @src_path, @file
+        )
+      end
+    end
+  end
+end

data/lib/jekyll/generator-single-source/nav_config/inherited_config.rb

@@ -22,7 +22,6 @@ module Jekyll
         private
 
         def inherited_nav
-          # Load the base config as a relative path to the current config
           @inherited_nav ||= SafeYAML.load(
             File.read(
               File.join(File.dirname(@file_path), @base_config['inherit']['nav'])

data/lib/jekyll/generator-single-source/single_source_page.rb

@@ -14,7 +14,12 @@ module Jekyll
         # This is the directory that we're going to write the output file to
         @dir = nav_item.dest.file_path
 
-        content = File.read(nav_item.source.full_file_path)
+        file_path = if nav_item.translation_fallback?
+                      nav_item.source.full_file_path_in_default_locale
+                    else
+                      nav_item.source.full_file_path_in_locale
+                    end
+        content = File.read(file_path)
 
         # Load content + frontmatter from the file
         if content =~ Jekyll::Document::YAML_FRONT_MATTER_REGEXP
@@ -22,9 +27,6 @@ module Jekyll
           @data = SafeYAML.load(Regexp.last_match(1))
         end
 
-        # Set the "Edit on GitHub" link url
-        @data['edit_link'] = nav_item.source.file_path
-
         # Make it clear that this content comes from a generated file
         @data['is_dir_index'] = nav_item.source.dir?
 
@@ -35,7 +37,21 @@ module Jekyll
         @data['version'] = release.default_version
         @data['versions'] = release.versions
 
-        @data['nav_items'] = nav_item.config
+        # Set i18n related data
+        # locale in which the page is
+        locale = if nav_item.translation_fallback?
+          I18n.default_locale.to_s
+        else
+          @site.config['locale']
+        end
+        @data['translation_fallback'] = nav_item.translation_fallback?
+        @data['full_file_path_in_locale'] = nav_item.source.full_file_path_in_locale
+        @data['file_path'] = nav_item.source.file_path
+        @data['locale'] = locale
+        @data['nav_items'] = nav_item.nav_items_in_locale(locale)
+
+        # Set the "Edit on GitHub" link url
+        @data['edit_link'] = nav_item.source.file_path unless nav_item.translation_fallback?
 
         # Set the layout if it's not already provided
         @data['layout'] ||= GeneratorConfig.new(@site).layout
@@ -63,7 +79,7 @@ module Jekyll
         # Needed so that regeneration works for single sourced pages
         # It must be set to the source file
         # Also, @path MUST NOT be set, it falls back to @relative_path
-        @relative_path = nav_item.source.file_path
+        @relative_path = nav_item.relative_path
       end
 
       def to_version(input)

data/lib/jekyll/generator-single-source/source/base.rb

@@ -4,38 +4,34 @@ module Jekyll
   module GeneratorSingleSource
     module Source
       class Base
-        PATH = '_src'
+        extend Forwardable
 
-        def self.make_for(path:, site:)
-          # Normalize path
-          file_path = File.join(
-            PATH,
-            path.delete_prefix('/').delete_suffix('/')
-          )
+        SRC_PATH = '_src'
 
-          src_dir = File.expand_path(site.source)
+        def self.make_for(path:, site:, locale:)
+          md_path = "#{path.delete_suffix('/')}.md"
+          dir_path = File.join(path.delete_suffix('/'), "index.md")
 
           # Read the source file, either `<src>.md or <src>/index.md`
-          if File.exist?(File.join(src_dir, "#{file_path}.md"))
-            FileSource.new("#{file_path}.md", src_dir)
-          elsif File.exist?(File.join(src_dir, "#{file_path}/index.md"))
-            DirSource.new("#{file_path}/index.md", src_dir)
+          if I18nFile.exists?(file: md_path, locale:, src_path: SRC_PATH, site:)
+            FileSource.new(I18nFile.new(file: md_path, locale:, src_path: SRC_PATH, site:), site)
+          elsif I18nFile.exists?(file: dir_path, locale:, src_path: SRC_PATH, site:)
+            DirSource.new(I18nFile.new(file: dir_path, locale:, src_path: SRC_PATH, site:), site)
           else
-            raise "Could not find a source file at '#{file_path}.md' or '#{file_path}/index.md'"
+            raise "Could not find a source file at '_src/#{md_path}' or '_src/#{dir_path}'"
           end
         end
 
-        def initialize(path, source_dir)
-          @path       = path
-          @source_dir = source_dir
-        end
+        def_delegators :@i18n_file, :missing_translation?, :full_file_path_in_locale,
+          :full_file_path_in_default_locale
 
-        def file_path
-          @file_path ||= @path
+        def initialize(i18n_file, site)
+          @i18n_file = i18n_file
+          @site = site
         end
 
-        def full_file_path
-          @full_file_path ||= File.expand_path(@path, @source_dir)
+        def file_path
+          @file_path ||= @i18n_file.relative_file_path
         end
       end
     end

data/lib/jekyll/generator-single-source/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module GeneratorSingleSource
-    VERSION = '0.0.14'
+    VERSION = '0.0.15'
   end
 end

data/lib/jekyll/generator-single-source.rb

@@ -8,6 +8,7 @@ require_relative 'generator-single-source/source/base'
 require_relative 'generator-single-source/source/dir_source'
 require_relative 'generator-single-source/source/file_source'
 require_relative 'generator-single-source/doc_nav_config'
+require_relative 'generator-single-source/i18n_file'
 require_relative 'generator-single-source/nav_config/base'
 require_relative 'generator-single-source/nav_config/hash_config'
 require_relative 'generator-single-source/nav_config/inherited_config'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-generator-single-source
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Fabian Rodriguez
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-29 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +107,7 @@ files:
 - lib/jekyll/generator-single-source/generator.rb
 - lib/jekyll/generator-single-source/generator_config.rb
 - lib/jekyll/generator-single-source/hooks/version_is.rb
+- lib/jekyll/generator-single-source/i18n_file.rb
 - lib/jekyll/generator-single-source/liquid/drops/release.rb
 - lib/jekyll/generator-single-source/liquid/tags/version_is.rb
 - lib/jekyll/generator-single-source/nav_config/base.rb