bridgetown-causeway 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5221e6a7518e22b00f2873eeb5cb6212db4974a2f9c873f56b16c88169da31b
+  data.tar.gz: bda6bae264c4df2615c1a2762072a68f92583a6ef797b13bff0f1199a513ac2f
+SHA512:
+  metadata.gz: 1deda3160351e987c852f7791c3928d6ef7a26cb88a980e99a245caa8a8583640fe3329e1a8e4474260568757b8dc4c80df2b2bd5e8f29a040d6536708b8cba2
+  data.tar.gz: 6c84e84ccffa36efe76fda54b195a769ac4c3dc28ba824eaa5a5a3a7384045357eeaefc8402531d8dd432b9d2230e7d392654c137a78d975a59e0e74135d7e68

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2026-08-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"bridgetown-causeway" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["marc@eternal.co.za"](mailto:"marc@eternal.co.za").

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Marc Heiligers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Bridgetown::Causeway
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add bridgetown-causeway
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install bridgetown-causeway
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FASCINATION-works/bridgetown-causeway. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/FASCINATION-works/bridgetown-causeway/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Bridgetown::Causeway project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/FASCINATION-works/bridgetown-causeway/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/bridgetown/causeway/command.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-core/commands/concerns/configuration_overridable"
+require "json"
+require "reline"
+require "shellwords"
+
+module Bridgetown
+  module Causeway
+    class Command < Bridgetown::Command
+      include Bridgetown::Commands::ConfigurationOverridable
+
+      self.description = "Publish a Bridgetown post and cross-post it via Causeway"
+
+      one :post_path, "Path to the post to publish", required: true
+
+      options do
+        Bridgetown::Commands::ConfigurationOverridable.include_options(self)
+        option "-t/--template <TEXT>",
+               "Social post template ({url} is replaced with the post URL)"
+      end
+
+      def call # rubocop:disable Metrics
+        path = post_path
+
+        unless File.exist?(path)
+          abort "No post found at #{path}"
+        end
+
+        config = configuration_with_overrides(options, Bridgetown::Current.preloaded_configuration)
+        config.run_initializers! context: :static
+
+        content = File.read(path)
+        front_matter, _body = parse_front_matter(content)
+
+        already_published = front_matter["published"] == "true"
+
+        unless already_published
+          # Ask for summaries if summarize_command is present
+          cmd = Bridgetown::Causeway.configuration.summarize_command
+          if cmd
+            summaries = []
+            3.times do |i|
+              puts "Running summary #{i + 1}/3..."
+              eval_cmd = cmd.gsub("%{path}", path.shellescape)
+              output = `#{eval_cmd} 2>/dev/null`
+              begin
+                summaries << JSON.parse(output.split("Summarizing...").last)["result"]
+              rescue StandardError => e
+                puts "Failed to parse summary output: #{e.message}"
+              end
+            end
+
+            # Prompt to choose
+            if summaries.any?
+              desc_values = summaries.map { |s| s["summary"] }
+              tag_values = summaries.map { |s| s["tags"]&.join(" ") }
+              concept_values = summaries.map { |s| s["concepts"] }
+
+              edited_summary = pick_field("Description", desc_values)
+              edited_tags = pick_field("Tags", tag_values)
+              edited_categories = pick_field("Categories", concept_values)
+
+              if edited_summary
+                safe_summary = edited_summary.strip.gsub('"', '\\"')
+                content = update_front_matter_field(content, "description", %("#{safe_summary}"))
+              end
+              content = update_front_matter_field(content, "tags", edited_tags.strip) if edited_tags
+              if edited_categories
+                capitalized_cats = edited_categories.split(',').map(&:strip).map(&:capitalize).join(', ')
+                content = update_front_matter_field(content, "preview_text", capitalized_cats)
+              end
+
+              File.write(path, content)
+              front_matter, _body = parse_front_matter(content)
+            end
+          end
+
+          print "\nType 'publish' to confirm publishing: "
+          confirmation = $stdin.gets.strip
+          abort "Publishing aborted." unless confirmation.downcase == "publish"
+        end
+
+        if already_published
+          url = generate_url(path, front_matter)
+          # check pending
+          pending = []
+          pending << ::Causeway::Publishers::Mastodon.new if front_matter["mastodon_toot_id"].nil? || front_matter["mastodon_toot_id"].to_s.empty?
+          pending << ::Causeway::Publishers::Bluesky.new if front_matter["bluesky_post_uri"].nil? || front_matter["bluesky_post_uri"].to_s.empty?
+
+          if pending.empty?
+            abort "Post is already fully published to all networks: #{path}"
+          end
+          puts "Post already published. Resuming social posts for: #{pending.map(&:name).join(', ')}"
+        else
+          # Rename and update date
+          old_path = path
+          now = Time.now
+          new_date_str = now.strftime("%Y-%m-%d %H:%M:%S %z")
+          new_prefix = now.strftime("%Y-%m-%d")
+
+          if content =~ /^date:.*$/
+            content = content.sub(/^date:.*$/, "date: #{new_date_str}")
+          else
+            content = update_front_matter_field(content, "date", new_date_str)
+          end
+
+          content = update_front_matter_field(content, "published", "true")
+
+          basename = File.basename(path)
+          if basename.match?(/^\d{4}-\d{2}-\d{2}-/)
+            new_basename = basename.sub(/^\d{4}-\d{2}-\d{2}-/, "#{new_prefix}-")
+          else
+            new_basename = "#{new_prefix}-#{basename}"
+          end
+
+          new_path = File.join(File.dirname(path), new_basename)
+
+          if old_path != new_path
+            File.write(old_path, content)
+            File.rename(old_path, new_path)
+            path = new_path
+            git("rm", "--cached", old_path, allow_failure: true) if Bridgetown::Causeway.configuration.git_commit
+            git("add", path) if Bridgetown::Causeway.configuration.git_commit
+          else
+            File.write(path, content)
+            git("add", path) if Bridgetown::Causeway.configuration.git_commit
+          end
+
+          # Re-parse front matter
+          front_matter, _body = parse_front_matter(content)
+          url = generate_url(path, front_matter)
+
+          if Bridgetown::Causeway.configuration.after_publish
+            Bridgetown::Causeway.configuration.after_publish.call(path, front_matter)
+          end
+
+          if Bridgetown::Causeway.configuration.git_commit
+            git("commit", "-m", "Publish #{File.basename(path)}")
+            git("push")
+            puts "Committed and pushed."
+          end
+
+          puts "\nWaiting for deployment..."
+          print "Press Enter when the site is live: "
+          $stdin.gets
+        end
+
+        # Post to networks
+        description = front_matter["description"] || "A handful of things that caught my attention."
+        tags = (front_matter["tags"] || "").split(/\s+/).reject(&:empty?).map { |t| "##{t}" }.join(" ")
+        suffix = "\n\n#{url}\n\n#{tags} #blog".rstrip
+
+        if options[:template]
+          base_text = options[:template].gsub("{url}", url)
+        else
+          base_text = "#{description}#{suffix}"
+        end
+
+        puts "Base social post text (#{base_text.length} chars):\n---\n#{base_text}\n---"
+
+        publishers = [
+          [::Causeway::Publishers::Mastodon.new, "mastodon_toot_id"],
+          [::Causeway::Publishers::Bluesky.new, "bluesky_post_uri"]
+        ]
+
+        posted = []
+        errors = []
+
+        publishers.each do |pub_entry|
+          publisher, fm_key = pub_entry
+          content = File.read(path)
+          front_matter, _ = parse_front_matter(content)
+
+          existing = front_matter[fm_key]
+          if existing && !existing.to_s.empty?
+            puts "#{publisher.name}: already posted (#{existing}), skipping."
+            next
+          end
+
+          publisher_text = base_text
+          if !options[:template] && publisher.name == "Bluesky"
+            max_desc_len = 300 - suffix.grapheme_clusters.size
+            if description.grapheme_clusters.size > max_desc_len
+              puts "\nWarning: Description is too long for Bluesky (#{description.grapheme_clusters.size} graphemes). Truncating."
+              truncated_desc = description.grapheme_clusters[0...(max_desc_len - 3)].join.strip + "..."
+              publisher_text = "#{truncated_desc}#{suffix}"
+            end
+          end
+
+          print "Posting to #{publisher.name}... "
+          result = publisher.post(publisher_text)
+
+          if result[:error]
+            puts "FAILED"
+            puts "  #{result[:error]}"
+            errors << publisher.name
+          else
+            puts "OK"
+            puts "  #{result[:url]}"
+            content = update_front_matter_field(content, fm_key, result[:id])
+            File.write(path, content)
+            posted << publisher.name
+          end
+        end
+
+        if posted.any? && Bridgetown::Causeway.configuration.git_commit
+          git("add", path)
+          git("commit", "-m", "Add social post IDs to #{File.basename(path)}")
+          git("push")
+          puts "\nCommitted and pushed social post IDs (#{posted.join(', ')})."
+        end
+
+        if errors.any?
+          puts "\nFailed to post to: #{errors.join(', ')}"
+          puts "Fix the issue and re-run to resume."
+          exit 1
+        end
+
+        puts "\nDone!"
+      end
+
+      private
+
+      # Values are deliberately kept as strings: YAML would coerce `date:` into a
+      # Time, which breaks url_generator callbacks that expect to `Date.parse` it.
+      def parse_front_matter(content)
+        match = content.match(/\A---\n(.*?\n)---\n(.*)\z/m)
+        abort "Invalid front matter" unless match
+
+        front_matter = {}
+        match[1].each_line do |line|
+          next unless line =~ /\A(\w[\w_]*):\s*(.*)\s*\z/
+
+          key = Regexp.last_match(1)
+          value = Regexp.last_match(2).strip
+          value = value[1..-2] if value.start_with?('"') && value.end_with?('"')
+          front_matter[key] = value
+        end
+
+        [front_matter, match[2]]
+      end
+
+      def update_front_matter_field(content, field, value)
+        if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+          front_matter = $1
+          body = $' || ""
+
+          if front_matter.match?(/^#{field}:/)
+            front_matter = front_matter.sub(/^#{field}:.*$/, "#{field}: #{value}")
+          else
+            front_matter = front_matter + "#{field}: #{value}\n"
+          end
+
+          "#{front_matter}---\n#{body}"
+        else
+          "---\n#{field}: #{value}\n---\n#{content}"
+        end
+      end
+
+      def generate_url(path, front_matter)
+        if Bridgetown::Causeway.configuration.url_generator
+          Bridgetown::Causeway.configuration.url_generator.call(path, front_matter)
+        else
+          "https://example.com/missing-url"
+        end
+      end
+
+      def git(*args, allow_failure: false)
+        success = system("git", *args)
+        abort "Git command failed: git #{args.join(' ')}" if !success && !allow_failure
+      end
+
+      def pick_field(label, values)
+        deduped = values.compact.uniq
+        puts "\n#{label}:"
+        deduped.each_with_index do |v, i|
+          puts "  [#{i + 1}] #{v}"
+        end
+        print "Choose (1-#{deduped.size}, or 0 to skip): "
+        num = $stdin.gets.strip.to_i
+        return nil if num == 0
+        chosen = (num > 0 && num <= deduped.size) ? deduped[num - 1] : deduped[0]
+        ask_with_default("Edit: ", chosen)
+      end
+
+      def ask_with_default(prompt, default)
+        Reline.pre_input_hook = -> {
+          Reline.insert_text(default || "")
+          Reline.redisplay
+          Reline.pre_input_hook = nil
+        }
+        Reline.readline(prompt, false)
+      end
+    end
+  end
+end

data/lib/bridgetown/causeway/configuration.rb

@@ -0,0 +1,24 @@
+module Bridgetown
+  module Causeway
+    class Configuration
+      attr_accessor :summarize_command
+      attr_accessor :url_generator
+      attr_accessor :after_publish
+      attr_accessor :git_commit
+
+      def initialize
+        @git_commit = true
+      end
+    end
+
+    class << self
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+  end
+end

data/lib/bridgetown/causeway/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Causeway
+    VERSION = "0.0.1"
+  end
+end

data/lib/bridgetown/causeway.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "causeway"
+require_relative "causeway/version"
+require_relative "causeway/configuration"
+require_relative "causeway/command"
+
+module Bridgetown
+  module Causeway
+    class Error < StandardError; end
+  end
+end

data/lib/bridgetown/features/bridgetown-causeway.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+# Loaded by Bridgetown's PluginManager at CLI boot (via the `bridgetown_features`
+# gemspec metadata). Registration is deferred so the command file is only required
+# once `bridgetown-core/commands/application` is on the stack.
+Bridgetown::Commands::Registrations.register do
+  require "bridgetown/causeway"
+
+  register Bridgetown::Causeway::Command, :causeway
+end

data/sig/bridgetown/causeway.rbs

@@ -0,0 +1,6 @@
+module Bridgetown
+  module Causeway
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-causeway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Marc Heiligers
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: causeway
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: reline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Publish Bridgetown posts to social media using Causeway.
+email:
+- rubygems@heiligers.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bridgetown/causeway.rb
+- lib/bridgetown/causeway/command.rb
+- lib/bridgetown/causeway/configuration.rb
+- lib/bridgetown/causeway/version.rb
+- lib/bridgetown/features/bridgetown-causeway.rb
+- sig/bridgetown/causeway.rbs
+homepage: https://github.com/FASCINATION-works/bridgetown-causeway
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/FASCINATION-works/bridgetown-causeway
+  bridgetown_features: 'true'
+  source_code_uri: https://github.com/FASCINATION-works/bridgetown-causeway
+  changelog_uri: https://github.com/FASCINATION-works/bridgetown-causeway/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Bridgetown plugin for Causeway.
+test_files: []