jekyll-baserow-headless-cms 0.1.0

data/lib/jekyll_baserow_headless_cms/generator.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'yaml'
+
+module JekyllBaserowHeadlessCMS
+  # Jekyll Generator that fetches data from Baserow tables
+  class Generator < Jekyll::Generator
+    safe true
+    priority :highest
+
+    def generate(site)
+      @site = site
+      @config = site.config['baserow'] || {}
+      @collections_config = @config['collections'] || {}
+
+      unless @config['enabled'] != false
+        Jekyll.logger.info 'BaserowCMS:', 'Plugin disabled in configuration'
+        return
+      end
+
+      unless ENV['BASEROW_TOKEN']
+        Jekyll.logger.info 'BaserowCMS:', 'No BASEROW_TOKEN found, using collections fallback'
+        use_all_collections_fallback
+        return
+      end
+
+      Jekyll.logger.info 'BaserowCMS:', 'Fetching data from Baserow API...'
+
+      begin
+        @client = BaserowClient.new(ENV.fetch('BASEROW_TOKEN', nil), base_url: ENV.fetch('BASEROW_API_URL', nil))
+
+        @collections_config.each do |collection_name, collection_config|
+          fetch_collection_data(collection_name, collection_config)
+        end
+
+        Jekyll.logger.info 'BaserowCMS:', 'All data fetched successfully'
+      rescue StandardError => e
+        Jekyll.logger.error 'BaserowCMS:', "Error fetching data: #{e.message}"
+        Jekyll.logger.warn 'BaserowCMS:', 'Falling back to collections'
+        use_all_collections_fallback
+      end
+    end
+
+    private
+
+    # Fetch data for a single collection
+    def fetch_collection_data(collection_name, config)
+      env_var = config['table_env']
+      data_file = config['data_file']
+
+      table_id = ENV.fetch(env_var, nil)
+      if table_id.nil? || table_id.empty? || table_id.start_with?('example_')
+        Jekyll.logger.info 'BaserowCMS:', "No #{env_var} found, using fallback for #{collection_name}"
+        use_collection_fallback(collection_name, config)
+        return
+      end
+
+      begin
+        baserow_data = @client.query_table(table_id)
+        organized_data = DataOrganizers.organize(baserow_data, config)
+
+        if DataOrganizers.data_present?(organized_data)
+          data_key = data_file.sub('.yml', '').sub('.yaml', '')
+          @site.data[data_key] = organized_data
+          create_data_file(organized_data, data_file, collection_name)
+
+          count = organized_data.is_a?(Hash) ? organized_data.size : organized_data.length
+          Jekyll.logger.info 'BaserowCMS:', "#{collection_name} fetched (#{count} items)"
+        else
+          Jekyll.logger.warn 'BaserowCMS:', "No data found for #{collection_name}, using fallback"
+          use_collection_fallback(collection_name, config)
+        end
+      rescue StandardError => e
+        Jekyll.logger.error 'BaserowCMS:', "Error fetching #{collection_name}: #{e.message}"
+        use_collection_fallback(collection_name, config)
+      end
+    end
+
+    # Create a YAML data file
+    def create_data_file(data, file_name, collection_name)
+      data_dir = File.join(@site.source, '_data')
+      FileUtils.mkdir_p(data_dir)
+
+      data_file = File.join(data_dir, file_name)
+      new_content = data.to_yaml
+
+      # Skip if content unchanged
+      if File.exist?(data_file)
+        existing_content = File.read(data_file)
+        yaml_start = existing_content.index("---\n")
+        if yaml_start
+          existing_yaml = existing_content[yaml_start..]
+          if existing_yaml.strip == new_content.strip
+            Jekyll.logger.info 'BaserowCMS:', "#{collection_name} data unchanged, skipping"
+            return
+          end
+        end
+      end
+
+      File.open(data_file, 'w') do |file|
+        file.write("# #{collection_name.capitalize} data imported from Baserow\n")
+        file.write("# Auto-generated by jekyll-baserow-headless-cms - Do not edit manually\n")
+        file.write("# Last updated: #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}\n\n")
+        file.write(new_content)
+      end
+
+      Jekyll.logger.info 'BaserowCMS:', "#{collection_name} written to _data/#{file_name}"
+    end
+
+    # Use fallback for all collections
+    def use_all_collections_fallback
+      @collections_config.each do |collection_name, config|
+        use_collection_fallback(collection_name, config)
+      end
+    end
+
+    # Use Jekyll collections as fallback
+    def use_collection_fallback(collection_name, config)
+      Jekyll.logger.info 'BaserowCMS:', "Using fallback for #{collection_name}"
+
+      data_file = config['data_file']
+      data_key = data_file.sub('.yml', '').sub('.yaml', '')
+      fields_config = config['fields'] || []
+
+      # Convert Jekyll collection to Baserow-like row format
+      mock_data = { 'results' => [] }
+
+      @site.collections[collection_name]&.docs&.each_with_index do |doc, index|
+        row = { 'id' => "collection_#{index}" }
+        row.merge!(convert_doc_to_fields(doc.data, fields_config))
+        mock_data['results'] << row
+      end
+
+      organized_data = DataOrganizers.organize(mock_data, config)
+      @site.data[data_key] = organized_data
+      create_data_file(organized_data, data_file, collection_name)
+
+      count = organized_data.is_a?(Hash) ? organized_data.size : organized_data.length
+      Jekyll.logger.info 'BaserowCMS:', "#{collection_name} fallback applied (#{count} items)"
+    end
+
+    # Convert Jekyll document data to Baserow-like row fields
+    def convert_doc_to_fields(data, fields_config)
+      fields = {}
+
+      fields_config.each do |field_config|
+        field_name = field_config['name']
+        field_type = field_config['type']
+        field_key = field_config['key'] || FieldExtractors.normalize_key(field_name)
+
+        value = data[field_key] || data[field_name.downcase] || data[field_name]
+        next if value.nil?
+
+        fields[field_name] = convert_value_to_baserow_field(value, field_type)
+      end
+
+      fields
+    end
+
+    # Convert a value to a Baserow field value shape
+    def convert_value_to_baserow_field(value, field_type)
+      case field_type
+      when 'number', 'rating', 'count'
+        value.to_i
+      when 'boolean'
+        !!value
+      when 'single_select'
+        { 'id' => nil, 'value' => value.to_s, 'color' => nil }
+      when 'multi_select'
+        items = value.is_a?(Array) ? value : [value]
+        items.map { |v| { 'id' => nil, 'value' => v.to_s, 'color' => nil } }
+      else
+        value.to_s
+      end
+    end
+  end
+end

data/lib/jekyll_baserow_headless_cms/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JekyllBaserowHeadlessCMS
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-baserow-headless-cms
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maxime Lenne
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: A configurable Jekyll plugin that fetches content from Baserow tables
+  and makes it available as Jekyll data files. Supports multiple collections, various
+  field types, and automatic fallback to Jekyll collections.
+email:
+- hello@maxime-lenne.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".claude/settings.json"
+- ".mcp.json"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docs/EXAMPLES_AND_CONFIGURATION.md
+- docs/architecture.excalidraw
+- docs/architecture.png
+- docs/architecture.svg
+- docs/templates/github-actions_baserow-sync.yml
+- lib/jekyll-baserow-headless-cms.rb
+- lib/jekyll_baserow_headless_cms/baserow_client.rb
+- lib/jekyll_baserow_headless_cms/data_organizers.rb
+- lib/jekyll_baserow_headless_cms/field_extractors.rb
+- lib/jekyll_baserow_headless_cms/generator.rb
+- lib/jekyll_baserow_headless_cms/version.rb
+homepage: https://github.com/maxime-lenne/jekyll-baserow-headless-cms
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/maxime-lenne/jekyll-baserow-headless-cms
+  source_code_uri: https://github.com/maxime-lenne/jekyll-baserow-headless-cms
+  changelog_uri: https://github.com/maxime-lenne/jekyll-baserow-headless-cms/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/maxime-lenne/jekyll-baserow-headless-cms/issues
+  documentation_uri: https://github.com/maxime-lenne/jekyll-baserow-headless-cms#readme
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Jekyll plugin to sync content from Baserow tables
+test_files: []