bridgetown_directus 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2311ee5e15d9cab7cd7cd04746afd03d17a85982e2cc43cdadcc25ffba3646cb
-  data.tar.gz: 2cce7fa9fe95891b1559968d5e3d1c139752182966160a1fa6ac44933a6b36d3
+  metadata.gz: b86e165473c96ffa32fc96cf04ec0b5564169bcdd53866489c6f806f16235dfe
+  data.tar.gz: c7ea854a2e0263589a31d467b164f061fe15399126a90de273b4c1b8a6366226
 SHA512:
-  metadata.gz: 8aa565c2c68cb96330213ace4efcd99a31948aa7349594004de99018dc9195518ce6620e97f4e6f578d8def0354f4b2519e92f5128b1a57cb6179948f1f3900f
-  data.tar.gz: 91b5f0df720865f92c388a27b2613dfeeed7c4b95190d2dd56699eaec6719f0c495be02f5ccd7504c748615ba7ca41851dd8d437aff089d84f4268712c48d8fd
+  metadata.gz: 80a9bfad8a419d19159a2f0a6f7538afc142837a3baff3737bd9c1c5f127f039d7990432ace15dffea1cf3b474129a23335919e1c9e6fa975e4df653ecf83e67
+  data.tar.gz: '098a9aeb10f146c6a30ee1a60d428390d52998e3bf438735b95f5de0b7fbd0afdfbb61f3982f816c1c12b43224b71afcda6f1783aaf8cb4a52a9b9b1ad545aab'

data/README.md

@@ -1,11 +1,13 @@
 # Bridgetown Directus Plugin
 
-This Bridgetown plugin integrates with the [Directus](https://directus.io/) which is among other things a [headless CMS](https://en.wikipedia.org/wiki/Headless_content_management_system). The plugin allows Bridgetown to pull content from a Directus API during the build process and generate static content in your site. It currently supports fetching published posts, with future plans for more flexibility and features.
+[![Gem Version](https://badge.fury.io/rb/bridgetown_directus.svg)](https://badge.fury.io/rb/bridgetown_directus)
+
+This Bridgetown plugin integrates with [Directus](https://directus.io/), which is among other things a [headless CMS](https://en.wikipedia.org/wiki/Headless_content_management_system). The plugin allows Bridgetown to pull content from a Directus API during the build process and generate static content in your site. It supports both single-language and multilingual content through Directus translations.
 
 ## Features
 
 - Fetch **published posts** from Directus during the build process
-- Simple setup and configuration
+- Support for **multilingual content** through Directus translations
 
 ## Installation
 
@@ -14,81 +16,116 @@ Before installing the plugin make sure you have an [Auth Token](https://docs.dir
 ### Recommended Installation (Bridgetown Automation)
 
 1. Run the plugin's automation setup:
+
    ```bash
    bin/bridgetown apply https://github.com/munkun-estudio/bridgetown_directus
    ```
-2.	The setup will guide you to provide the Directus API URL and Auth Token, and configure the plugin automatically.
+
+2. The setup will guide you through:
+   - Providing the Directus API URL and Auth Token
+   - Specifying your content collection name
+   - Enabling/disabling translations support
+   - Configuring translatable fields (if translations enabled)
 
 ### Manual Installation
 
-1.	Add the gem to your Gemfile:
-```ruby
-bundle add "bridgetown_directus"
-```
-2.	Run bundle install to install the gem.
-3.	Add the plugin configuration to your config/initializers.rb file:
-```ruby
-init :bridgetown_directus do
-  api_url "https://your-directus-instance.com"
-  token ENV['DIRECTUS_AUTH_TOKEN'] || "your_token"
-
-  # Required field mappings
-  mappings do
-    title "title"
-    content "content"
-    slug "slug"
-    date "date"
-    category "category"
-    excerpt "excerpt"
-    image "image"
-  end
-end
-```
+1. Add the gem to your Gemfile:
+
+   ```ruby
+   bundle add "bridgetown_directus"
+   ```
+
+2. Run bundle install to install the gem.
+3. Add the plugin configuration to your config/initializers.rb file:
+
+   ```ruby
+   init :"bridgetown_directus" do
+     api_url "https://your-directus-instance.com"
+     token ENV['DIRECTUS_AUTH_TOKEN'] || "your_token"
+     collection config.directus["collection"]
+     mappings config.directus["mappings"]
+   end
+   ```
+
+4. Configure your bridgetown.config.yml:
+
+   ```yaml
+   directus:
+     collection: "posts"
+     mappings:
+       title: "title"           # Required field
+       content: "body"          # Required field
+       slug: "slug"             # Optional, will be auto-generated if not provided
+       date: "date"             # Optional, defaults to current date/time if not provided
+       category: "category"     # Optional
+       excerpt: "excerpt"       # Optional, defaults to content excerpt if not provided
+       image: "image"           # Optional, URL for the image associated with the post
+     translations:
+       enabled: false          # Set to true for multilingual support
+       fields:                 # Only required if translations are enabled
+         - title
+         - excerpt
+         - body
+   ```
 
 ## Configuration
 
-To configure the plugin:
-
-1.	You can either use environment variables for the API URL and token:
-```bash
-export DIRECTUS_API_URL="https://your-directus-instance.com"
-export DIRECTUS_AUTH_TOKEN="your-token"
-```
-
-2.	Or hard-code the values directly in your initializer:
-```ruby
-init :bridgetown_directus do
-  api_url "https://your-directus-instance.com"
-  token "your_token"
-
-  # Required field mappings
-  mappings do
-    title "title"
-    content "content"
-    slug "slug"
-    date "date"
-    category "category"
-    excerpt "excerpt"
-    image "image"
-  end
-end
-```
+### Basic Configuration
+
+You can configure the plugin either through environment variables or direct configuration:
+
+1. Using environment variables:
+
+   ```bash
+   export DIRECTUS_API_URL="https://your-directus-instance.com"
+   export DIRECTUS_AUTH_TOKEN="your-token"
+   ```
+
+2. Or through bridgetown.config.yml as shown in the installation section.
+
+### Translations Configuration
+
+To enable multilingual support:
+
+1. In your bridgetown.config.yml, set translations.enabled to true:
+
+   ```yaml
+   directus:
+     # ... other config ...
+     translations:
+       enabled: true
+       fields:
+         - title
+         - excerpt
+         - body
+   ```
+
+2. Ensure your Directus collection has translations enabled and configured for the specified fields.
+
+3. The plugin will automatically:
+
+- Generate posts for each available language
+- Create appropriate URLs based on locale
+- Handle fallback content if translations are missing
+
 ## Usage
 
 Once the plugin is installed and configured, it will fetch posts from your Directus instance during each build. These posts will be generated as in-memory resources, meaning they are not written to disk but are treated as normal posts by Bridgetown.
 
 ### Directus Setup
 
-To use the plugin, ensure that you’ve set up a collection in your Directus instance with the following fields (you can name the collection anything you like):
+#### Basic Collection Setup
+
+Create a collection in your Directus instance with these fields:
 
--	**title**: The title of the post (Text field)
--	**content**: The content of the post (Rich Text or Text field)
--	**slug**: Optional. A unique slug for the post (Text field)
--	**date**: Optional.The publish date (Datetime field)
--	**status**: Optional. The status of the post (Option field with values like “published”, “draft”, etc.)
--	**category**: Optional. The category for the post (Text field)
--	**excerpt**: Optional. A short excerpt (Text field)
--	**image**: Optional. An image associated with the post (File/Media field)
+- **title**: The title of the post (Text field)
+- **body**: The content of the post (Rich Text or Text field)
+- **slug**: Optional. A unique slug for the post (Text field)
+- **date**: Optional. The publish date (Datetime field)
+- **status**: Optional. The status of the post (Option field with values like "published", "draft", etc.)
+- **category**: Optional. The category for the post (Text field)
+- **excerpt**: Optional. A short excerpt (Text field)
+- **image**: Optional. An image associated with the post (File/Media field)
 
 Make sure the **status** field uses `"published"` for posts that you want to be visible on your site.
 
@@ -106,7 +143,6 @@ If your posts contain images, and you want to display them in your Bridgetown si
    - When users upload images to posts, ensure that the images are associated with the **directus_files** collection.
    - By default, Directus will store image URLs, which the plugin can reference directly. Ensure that the **image** field or URL is added to the **body** field (or wherever applicable).
 
-
 ### Fetching Posts
 
 Posts are fetched from Directus during each build and treated as Bridgetown resources. These resources are available in your site just like regular posts, and you can access them through your templates or layouts.
@@ -117,19 +153,19 @@ By default, only posts with a status of "published" are fetched from Directus.
 
 Here are features that are planned for future versions of the plugin:
 
-- [ ]	Support for Additional Content Types: Extend the plugin to handle other Directus collections and custom content types.
-- [ ]	Custom Field Mapping via DSL: Implement a DSL for more advanced field mapping.
-- [ ]	Asset Handling: Add functionality to download and manage images and other assets.
-- [ ]	Caching & Incremental Builds: Implement caching to improve build performance when fetching content.
+- [ ] Support for Additional Content Types: Extend the plugin to handle other Directus collections and custom content types.
+- [ ] Custom Field Mapping via DSL: Implement a DSL for more advanced field mapping.
+- [ ] Asset Handling: Add functionality to download and manage images and other assets.
+- [ ] Caching & Incremental Builds: Implement caching to improve build performance when fetching content.
 - [ ] Draft Previews: Add support for previewing unpublished (draft) posts.
 
 ## Testing
 
-Testing isn’t fully set up yet, but contributions and improvements are welcome.
+Testing isn't fully set up yet, but contributions and improvements are welcome.
 
 ## Contributing
 
-We welcome contributions to this project! To contribute:
+We welcome contributions! To contribute:
 
 1. Fork the repository
 2. Create a new branch (git checkout -b feature-branch)

data/bridgetown.automation.rb

@@ -3,34 +3,60 @@ say_status :directus, "Installing the bridgetown_directus plugin..."
 # Prompt the user for Directus API URL and Auth Token
 api_url = ask("What's your Directus instance URL? (Example: https://your-instance.example.com)")
 auth_token = ask("What's your Directus API auth token? (Leave blank to use ENV['DIRECTUS_AUTH_TOKEN'])")
-collection = ask("What's the name of the collection? (Example: posts")
+collection = ask("What's the name of the collection (Directus Model)? (Example: posts)")
+
+# Ask if translations should be enabled with a default of 'n'
+translations_enabled_input = ask("Do you want to enable translations? (y/n) default:", :yellow, default: "n")
+translations_enabled = translations_enabled_input.strip.downcase.start_with?("y")
+
+# Prepare the translations YAML block based on the user’s response
+translations_yaml = if translations_enabled
+  translatable_fields_input = ask("List the translatable fields separated by commas (e.g., title, excerpt, content)")
+  translatable_fields = translatable_fields_input.split(',').map(&:strip)
+
+  "  translations:\n    enabled: true\n    fields:\n#{translatable_fields.map { |field| "      - #{field}" }.join("\n")}"
+else
+  "  translations:\n    enabled: false"
+end
 
 # Add the bridgetown_directus gem
 add_gem "bridgetown_directus"
 
-# Add Directus configuration to config/initializers.rb using add_initializer method
-add_initializer :"bridgetown_directus" do
+# Add Directus configuration to config/initializers.rb
+add_initializer :bridgetown_directus do
   <<~RUBY
-    do
-      api_url "#{api_url}"
-      token "#{auth_token.present? ? auth_token : "<%= ENV['DIRECTUS_AUTH_TOKEN'] %>"}"
-      collection "#{collection}"
-
-      # Field Mappings (Ensure your Directus collection has these fields)
-      mappings do
-        title "title"           # Required field
-        content "content"       # Required field
-        slug "slug"             # Optional, will be auto-generated if not provided
-        date "date"             # Optional, defaults to the current date/time if not provided
-        category "category"     # Optional
-        excerpt "excerpt"       # Optional, defaults to content excerpt if not provided
-        image "image"           # Optional, URL for the image associated with the post
-      end
-    end
+  do
+    api_url "#{api_url}"
+    token "#{auth_token.present? ? auth_token : "<%= ENV['DIRECTUS_AUTH_TOKEN'] %>"}"
+    collection config.directus["collection"]
+    mappings config.directus["mappings"]
+  end
   RUBY
 end
-# Success message
-say_status :directus, "Directus integration is complete! Please make sure your Directus collection contains the required fields as specified in the initializer."
-say_status :directus, "Check config/initializers.rb for your Directus setup and adjust mappings if necessary."
+
+# Append the configuration to bridgetown.config.yml
+append_to_file "bridgetown.config.yml" do
+  <<~YAML
+
+directus:
+  collection: "#{collection}"
+  mappings:
+    title: "title"           # Required field
+    content: "body"          # Required field
+    slug: "slug"             # Optional, will be auto-generated if not provided
+    date: "date"             # Optional, defaults to the current date/time if not provided
+    category: "category"     # Optional
+    excerpt: "excerpt"       # Optional, defaults to content excerpt if not provided
+    image: "image"           # Optional, URL for the image associated with the post
+#{translations_yaml}
+  YAML
+end
+
+say_status :success, "Bridgetown Directus plugin has been installed!", :green
+say_status :info, "Add your posts to Directus and they will be automatically imported when you build your site.", :yellow
+if translations_enabled
+  say_status :info, "Translations are enabled. Make sure your Directus collection has translations configured.", :yellow
+end
+say_status :directus, "Check config/initializers.rb for your Directus setup and config.bridgetown.yml to adjust fields mappings if necessary."
 say_status :directus, "For usage help visit:"
-say_status :directus, "https://github.com/Munkun-Estudio/bridgetown_directus/blob/main/README.md"
+say_status :directus, "https://github.com/Munkun-Estudio/bridgetown_directus/blob/main/README.md"

data/bridgetown_directus.gemspec

@@ -15,6 +15,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r!^test/!)
   spec.require_paths = ["lib"]
 
+  spec.metadata         = {
+      "source_code_uri" => spec.homepage,
+      "bug_tracker_uri" => "#{spec.homepage}/issues",
+      "changelog_uri"   => "#{spec.homepage}/releases",
+      "homepage_uri"    => spec.homepage
+  }
+
   spec.required_ruby_version = ">= 2.7.0"
 
   spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"

data/lib/bridgetown_directus/api_client.rb

@@ -16,6 +16,7 @@ module BridgetownDirectus
 
       response = connection.get("/items/#{@site.config.bridgetown_directus.collection}") do |req|
         req.params['filter'] = { status: { _eq: "published" } }.to_json
+        req.params['fields'] = '*,translations.*'
       end
 
       if response.success?
@@ -49,7 +50,7 @@ module BridgetownDirectus
       elsif posts_data.is_a?(Array)
         posts_data
       else
-        raise "Unexpected structure of posts_data: #{posts_data.inspect}"
+        raise "Invalid posts data structure: #{posts_data.inspect}"
       end
     end
   end

data/lib/bridgetown_directus/builder.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module BridgetownDirectus
   class Builder < Bridgetown::Builder
     def build
@@ -30,33 +28,76 @@ module BridgetownDirectus
         raise "Unexpected structure of posts_data: #{posts_data.inspect}"
       end
 
-      posts_array.each_with_index do |post, index|
+      created_posts = 0
+      posts_array.each do |post|
+        if translations_enabled?
+          created_posts += create_translated_posts(post)
+        else
+          created_posts += create_single_post(post)
+        end
+      end
+
+      Utils.log_directus "Finished generating #{created_posts} posts."
+    end
+
+    def translations_enabled?
+      site.config.dig("directus", "translations", "enabled") == true
+    end
+
+    def create_single_post(post)
+      slug = post["slug"] || Bridgetown::Utils.slugify(post["title"])
+      api_url = site.config.dig("directus", "api_url")
+
+      begin
+        add_resource :posts, "#{slug}.md" do
+          layout "post"
+          title post["title"]
+          content post["body"]
+          date post["date"] || Time.now.iso8601
+          category post["category"]
+          excerpt post["excerpt"]
+          image post["image"] ? "#{api_url}/assets/#{post['image']}" : nil
+        end
+        1
+      rescue => e
+        Utils.log_directus "Error creating post #{slug}: #{e.message}"
+        0
+      end
+    end
+
+    def create_translated_posts(post)
+      posts_created = 0
+      translations = post["translations"] || []
 
-        # Fallback to slugify if no slug is provided
-        slug = post["slug"] || Bridgetown::Utils.slugify(post["title"])
-        date = post["date"] || Time.now.iso8601
+      translations.each do |translation|
+        lang_code = translation["languages_code"].split("-").first.downcase
+        bridgetown_locale = lang_code.to_sym
+        
+        next unless site.config["available_locales"].include?(bridgetown_locale)
 
-        # Construct the image URL if the image ID is present
-        image = post["image"]
-        image = image ? "#{site.config.bridgetown_directus.api_url}/assets/#{image}" : nil
+        slug = translation["slug"] || Bridgetown::Utils.slugify(translation["title"])
+        api_url = site.config.dig("directus", "api_url")
 
         begin
           add_resource :posts, "#{slug}.md" do
             layout "post"
-            title post["title"]
-            content post["body"] # Make sure content is directly from post["body"]
-            date date
+            title translation["title"]
+            content translation["body"]
+            date post["date"] || Time.now.iso8601
             category post["category"]
-            excerpt post["excerpt"]
-            image image
+            excerpt translation["excerpt"]
+            image post["image"] ? "#{api_url}/assets/#{post['image']}" : nil
+            locale bridgetown_locale
+            translations translations
           end
+
+          posts_created += 1
         rescue => e
-          Utils.log_directus "Error processing post at index #{index}: #{e.message}"
-          raise e
+          Utils.log_directus "Error creating post #{slug} for locale #{bridgetown_locale}: #{e.message}"
         end
       end
 
-      Utils.log_directus "Finished generating #{posts_array.size} posts."
+      posts_created
     end
   end
 end

data/lib/bridgetown_directus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownDirectus
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/bridgetown_directus.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "bridgetown"
-require_relative "bridgetown_directus/version"
 require_relative "bridgetown_directus/utils"
 require_relative "bridgetown_directus/api_client"
 require_relative "bridgetown_directus/builder"
@@ -12,12 +11,23 @@ module BridgetownDirectus
     config.bridgetown_directus ||= {}
     config.bridgetown_directus.api_url ||= api_url || ENV.fetch("DIRECTUS_API_URL")
     config.bridgetown_directus.token ||= token || ENV.fetch("DIRECTUS_API_TOKEN")
-    config.bridgetown_directus.collection ||= collection
-    config.bridgetown_directus.mappings ||= mappings
+
+    # Access collection and mappings from the bridgetown.config.yml
+    config.bridgetown_directus.collection ||= config.directus.collection
+    config.bridgetown_directus.mappings ||= config.directus.mappings
+    config.bridgetown_directus.translations ||= config.directus["translations"]
 
     # Register the builder
     config.builder BridgetownDirectus::Builder
 
+    # Log translations status
+    if config.bridgetown_directus.translations["enabled"]
+      translatable_fields = config.bridgetown_directus.translations["fields"] || []
+      Bridgetown.logger.info "Directus translations enabled for fields: #{translatable_fields.join(', ')}"
+    else
+      Bridgetown.logger.info "Directus translations are disabled"
+    end
+
     # Validate Directus config before proceeding
     unless config.bridgetown_directus.api_url && config.bridgetown_directus.token
       Bridgetown.logger.error "Invalid Directus configuration detected. Please check your API URL and token."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_directus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Munkun
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-15 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -180,7 +180,11 @@ files:
 homepage: https://github.com/munkun-estudio/bridgetown_directus
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/munkun-estudio/bridgetown_directus
+  bug_tracker_uri: https://github.com/munkun-estudio/bridgetown_directus/issues
+  changelog_uri: https://github.com/munkun-estudio/bridgetown_directus/releases
+  homepage_uri: https://github.com/munkun-estudio/bridgetown_directus
 post_install_message:
 rdoc_options: []
 require_paths: