bridgetown_directus 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3625cab0b39f5374ad7a3647e5b6e369bed783f05412cb38e15e8f10208908
-  data.tar.gz: a99f097216b2c9239188563a288b0df5752709782c29bfe15673edd73fd6c80d
+  metadata.gz: 6834fa39c0868873782728053787ca9fbcbd0defb231b70621c8737ba6e996ee
+  data.tar.gz: 9dfb896e01a1a7e48d0a6db38b41c12a092195650ea8945083b417d34a76bda6
 SHA512:
-  metadata.gz: d70b609eab2f9c4015c4e8898324fe046f8a62673c51d11057ec166372cceb7dfc3cba9793b1a37e3dd175f150d1d2dbc2c7c371427e740b61303630228793f0
-  data.tar.gz: 1dafe4be86342c4196ca93700035ad75f99b0a6a7d0ab78f0592f8ec0a76e51a223b7b63a7f46bf1b0568593b8322b0428f95e5329f38788c55d0a9b07907a9a
+  metadata.gz: e2394537291cd18e7887344e9d37c21973eafc19ec2b89dfc38d7c6796011ac8d22ca4777bacf052cf5f4e5cd2ba1dd26019a897cf0a0d26a901fec4aaafba5e
+  data.tar.gz: a72244a4b1bf68e1e4d8834c5c0548c4a2a3287267a040f3133b5b5cca2a67432948adbc8c0abaf2bb577d852023300aa7dd80c765c374e8c17f72771ed63625

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test

data/.github/workflows/release-please.yml

@@ -0,0 +1,20 @@
+name: Release Please
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        with:
+          config-file: .release-please-config.json
+          manifest-file: .release-please-manifest.json

data/.github/workflows/release.yml

@@ -0,0 +1,28 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake test
+      - name: Build gem
+        run: bundle exec rake build
+      - name: Push gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+        run: gem push pkg/*.gem

data/.gitignore

@@ -38,3 +38,6 @@ test/dest
 .bridgetown-webpack
 
 .env
+
+# MacOS
+.DS_Store

data/.release-please-config.json

@@ -0,0 +1,10 @@
+{
+  "packages": {
+    ".": {
+      "release-type": "ruby",
+      "package-name": "bridgetown_directus",
+      "changelog-path": "CHANGELOG.md",
+      "include-v-in-tag": true
+    }
+  }
+}

data/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.3.0"
+}

data/CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0](https://github.com/Munkun-Estudio/bridgetown_directus/compare/bridgetown_directus-v0.2.0...bridgetown_directus/v0.3.0) (2026-01-27)
+
+
+### Features
+
+* improve builder mapping and release automation ([b87c719](https://github.com/Munkun-Estudio/bridgetown_directus/commit/b87c719cfec175a86bc1f9388c308c496035d2cf))
+
 ## [Unreleased]
 
 - ...

data/README.md

@@ -26,7 +26,7 @@ Before installing the plugin, make sure you have an [Auth Token](https://docs.di
 
    This will:
    - Prompt for your Directus API URL, token, Directus collection name, and Bridgetown collection name
-   - Generate a minimal `config/initializers/bridgetown_directus.rb`
+   - Generate a minimal `config/initializers.rb`
    - All further customization is done in Ruby, not YAML
 
 ### Manual Installation
@@ -38,7 +38,7 @@ Before installing the plugin, make sure you have an [Auth Token](https://docs.di
    ```
 
 2. Run `bundle install` to install the gem.
-3. Create `config/initializers/bridgetown_directus.rb` (see below for configuration).
+3. Create `config/initializers.rb` (see below for configuration).
 
 ## Configuration
 
@@ -66,10 +66,19 @@ For custom collections, create a layout file at `src/_layouts/[singular].erb` (e
 
 **By default, all Directus fields will be written to the front matter of generated Markdown files.**
 You only need to declare fields with `c.field` if you want to:
+
 - Rename a field in the output
 - Transform/convert a field value (e.g., format a date, generate a slug, etc.)
 - Set a default value if a field is missing
 
+Mapped fields are merged into the full Directus payload, so you still retain access to original fields unless you override them.
+
+### Environment Variables
+
+- `DIRECTUS_API_URL` (required unless you set `directus.api_url` in config)
+- `DIRECTUS_API_TOKEN` (required unless you set `directus.token` in config)
+- `DIRECTUS_TOKEN` (legacy fallback; supported for backward compatibility)
+
 #### Example: Customizing a Field
 
 ```ruby
@@ -93,10 +102,16 @@ c.enable_translations([:title, :content])
 
 - **Generated files**: The plugin writes Markdown files to `src/_[bridgetown_collection]/` (e.g., `src/_staff_members/`).
 - **Safety**: Only files with the `directus_generated: true` flag in their front matter are deleted during cleanup. User-authored files are never removed.
+- **Posts**: If `date` or `published_at` is present, filenames are generated as `YYYY-MM-DD-slug.md` to preserve date-based permalinks.
+
+### Debug Logging
+
+Set `BRIDGETOWN_DIRECTUS_LOG=1` to print per-collection activity logs during builds.
 
 ### Advanced Configuration
 
 See the plugin source and inline documentation for advanced features such as:
+
 - Multiple collections
 - Custom layouts per collection
 - Filtering, sorting, and pagination via `c.default_query` (**experimental**; not fully tested in production—see notes below)
@@ -106,7 +121,7 @@ See the plugin source and inline documentation for advanced features such as:
 
 ### Migrating from 0.1.x
 
-- **YAML config is no longer used.** All configuration is now in Ruby in `config/initializers/bridgetown_directus.rb`.
+- **YAML config is no longer used.** All configuration is now in Ruby in `config/initializers.rb`.
 - Field mapping, transformation, and translations are handled in the initializer.
 - All Directus fields are output by default; use `c.field` for customization.
 - **Upgrading?** The `resource_type` option is no longer required. Use the Bridgetown collection name and layout instead. See the [CHANGELOG](CHANGELOG.md) for details.

data/lib/bridgetown_directus/builder.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "date"
+require "fileutils"
 require "yaml"
 
 module BridgetownDirectus
@@ -35,23 +37,84 @@ module BridgetownDirectus
       end
     end
 
-    # Write a Directus item as a Markdown file in the correct Bridgetown collection directory
-    def write_directus_file(item, collection_dir, layout = nil, api_url = nil)
-      require "fileutils"
-      FileUtils.mkdir_p(collection_dir)
-      slug = item["slug"] || item["id"].to_s
-      filename = build_filename(collection_dir, slug)
-      item = transform_item_fields(item, api_url, layout)
-      item["directus_generated"] = true # Add flag to front matter
-      content = item.delete("body") || ""
-      front_matter = generate_front_matter(item)
-      write_markdown_file(filename, front_matter, content)
+    def build_directus_payload(item, collection_dir, collection_config, api_url = nil)
+      mapped_item = apply_data_mapping(item, collection_config)
+      slug = normalize_slug(mapped_item)
+      mapped_item["slug"] = slug
+      filename = build_filename(collection_dir, collection_config, mapped_item, slug)
+      mapped_item = transform_item_fields(mapped_item, api_url, collection_config.layout)
+      mapped_item["directus_generated"] = true # Add flag to front matter
+      content = mapped_item.delete("body") || ""
+      front_matter = generate_front_matter(mapped_item)
+      payload = render_markdown(front_matter, content)
+      [filename, payload]
     end
 
-    def build_filename(collection_dir, slug)
+    def build_filename(collection_dir, collection_config, item, slug)
+      if collection_config.resource_type == :posts || collection_config.name.to_s == "posts"
+        post_date = extract_post_date(item)
+        if post_date
+          return File.join(collection_dir, "#{post_date.strftime("%Y-%m-%d")}-#{slug}.md")
+        end
+      end
+
       File.join(collection_dir, "#{slug}.md")
     end
 
+    def normalize_slug(item)
+      slug = item["slug"] || item[:slug]
+      slug = slug.to_s.strip
+      return slug unless slug.empty?
+
+      title = item["title"] || item[:title]
+      if title && defined?(Bridgetown::Utils) && Bridgetown::Utils.respond_to?(:slugify)
+        slug = Bridgetown::Utils.slugify(title.to_s)
+      else
+        slug = title.to_s.downcase.gsub(/[^a-z0-9]+/, "-").gsub(/^-|-$/, "")
+      end
+
+      slug = slug.strip
+      return slug unless slug.empty?
+
+      id = item["id"] || item[:id]
+      id.to_s
+    end
+
+    def apply_data_mapping(item, collection_config)
+      mapped_item = item.dup
+      return mapped_item unless collection_config.fields.any? || collection_config.translations_enabled
+
+      mapped_fields = if collection_config.translations_enabled
+                        DataMapper.map_translations(collection_config, item, resolve_locale)
+                      else
+                        DataMapper.map(collection_config, item)
+                      end
+
+      mapped_item.merge!(mapped_fields)
+      mapped_item
+    end
+
+    def resolve_locale
+      return site.locale if site.respond_to?(:locale) && site.locale
+
+      config_locale = site.config["locale"] || site.config[:locale]
+      return config_locale.to_sym if config_locale
+
+      :en
+    end
+
+    def extract_post_date(item)
+      raw = item["date"] || item[:date] || item["published_at"] || item[:published_at] || item["date_created"]
+      item["date"] ||= item["published_at"] if item["published_at"] && !item["date"]
+      return nil unless raw
+
+      return raw.to_date if raw.respond_to?(:to_date)
+
+      Date.parse(raw.to_s)
+    rescue ArgumentError
+      nil
+    end
+
     def transform_item_fields(item, api_url, layout)
       item = item.dup
       if item["image"] && api_url && !item["image"].to_s.start_with?("http://", "https://")
@@ -66,19 +129,41 @@ module BridgetownDirectus
       yaml.sub(%r{^---\s*\n}, "") # Remove leading --- if present
     end
 
-    def write_markdown_file(filename, front_matter, content)
-      File.write(filename, "---\n#{front_matter}---\n\n#{content}")
+    def render_markdown(front_matter, content)
+      "---\n#{front_matter}---\n\n#{content}"
+    end
+
+    def write_markdown_file(filename, payload)
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.write(filename, payload)
+    end
+
+    def file_unchanged?(filename, payload)
+      return false unless File.exist?(filename)
+
+      File.read(filename) == payload
+    rescue StandardError
+      false
     end
 
     # Remove only plugin-generated Markdown files in the target directory before writing new ones
-    def clean_collection_directory(collection_dir)
-      require "yaml"
+    def clean_collection_directory(collection_dir, keep_files: [])
+      keep_set = keep_files.map { |file| File.expand_path(file) }.to_h { |file| [file, true] }
+
+      deleted = 0
       Dir.glob(File.join(collection_dir, "*.md")).each do |file|
+        next if keep_set[File.expand_path(file)]
+
         fm = File.read(file)[%r{\A---.*?---}m]
-        File.delete(file) if fm && YAML.safe_load(fm)["directus_generated"]
+        if fm && YAML.safe_load(fm, permitted_classes: [Date, Time, DateTime])["directus_generated"]
+          File.delete(file)
+          deleted += 1
+        end
       rescue StandardError => e
         warn "[BridgetownDirectus] Could not check/delete #{file}: #{e.message}"
       end
+
+      deleted
     end
 
     def process_collection(client:, collection_config:)
@@ -90,12 +175,41 @@ module BridgetownDirectus
         return
       end
       collection_dir = collection_directory(collection_config.name)
-      clean_collection_directory(collection_dir)
+      FileUtils.mkdir_p(collection_dir)
       api_url = site.config.bridgetown_directus.api_url
       sanitized_response = sanitize_keys(response)
-      sanitized_response.each do |item|
-        write_directus_file(item, collection_dir, collection_config.layout, api_url)
+      payloads = sanitized_response.to_h do |item|
+        build_directus_payload(item, collection_dir, collection_config, api_url)
       end
+      log_directus("Generating #{collection_label(collection_config)} (#{payloads.size} items)")
+      deleted = clean_collection_directory(collection_dir, keep_files: payloads.keys)
+      written = 0
+      skipped = 0
+      payloads.each do |filename, payload|
+        if file_unchanged?(filename, payload)
+          skipped += 1
+          next
+        end
+
+        write_markdown_file(filename, payload)
+        written += 1
+      end
+      log_directus("Updated #{collection_label(collection_config)}: wrote #{written}, skipped #{skipped}, deleted #{deleted}")
+    end
+
+    def log_directus(message)
+      return unless directus_logging_enabled?
+
+      Utils.log_directus(message)
+    end
+
+    def directus_logging_enabled?
+      flag = ENV["BRIDGETOWN_DIRECTUS_LOG"]
+      flag && !flag.to_s.strip.empty? && flag.to_s != "0"
+    end
+
+    def collection_label(collection_config)
+      collection_config.name.to_s.tr("_", " ").split.map(&:capitalize).join(" ")
     end
 
     # Recursively sanitize keys to avoid illegal instance variable names (Ruby 3.4+)

data/lib/bridgetown_directus/data_mapper.rb

@@ -113,7 +113,15 @@ module BridgetownDirectus
           # Get the Directus field name for this Bridgetown field
           field_config = collection_config.fields[field]
 
-          directus_field = field_config.is_a?(Hash) ? field_config[:directus_field] : field_config.to_s
+          directus_field = if field_config.nil?
+                             field.to_s
+                           elsif field_config.is_a?(Hash)
+                             field_config[:directus_field]
+                           else
+                             field_config.to_s
+                           end
+
+          directus_field = field.to_s if directus_field.to_s.empty?
 
           # Check if the translation has this field
           next unless translation[directus_field]

data/lib/bridgetown_directus/version.rb

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

data/lib/bridgetown_directus.rb

@@ -14,8 +14,8 @@ module BridgetownDirectus
     config.bridgetown_directus ||= Configuration.new
 
     # Set up configuration directly (leave to user initializer if possible)
-    config.bridgetown_directus.api_url ||= ENV["DIRECTUS_API_URL"] || "[https://studio.munkun.com](https://studio.munkun.com)"
-    config.bridgetown_directus.token ||= ENV["DIRECTUS_TOKEN"] || "t1P6YstcUslmf-KJFbc6Kyg0bomMxkXY"
+    config.bridgetown_directus.api_url ||= ENV["DIRECTUS_API_URL"]
+    config.bridgetown_directus.token ||= ENV["DIRECTUS_API_TOKEN"] || ENV["DIRECTUS_TOKEN"]
 
     # Register the builder
     config.builder BridgetownDirectus::Builder

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_directus
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Munkun
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -160,7 +160,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/release-please.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
+- ".release-please-config.json"
+- ".release-please-manifest.json"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -201,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Use Directus as headless CMS for Bridgetown
 test_files: []