mimas-bridgetown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b50f042aec9ed40b035f7f06c6b8c052cd92005065e421cb813e23c5853f74c7
+  data.tar.gz: da54be33b3b1ea5d7eaf6d470344c2686fb18612c60be23dbbd0d1be932bd4fa
+SHA512:
+  metadata.gz: fa1c0f65fa6a295f178fc606220c910816cbfb79eb00a0f37dad4526134b477a6f7326ca878623c702bfa53149d0bd6f7f09a0dbdf6802d6c7e71e8582c208bb
+  data.tar.gz: 46891f14c006e82dd53ffc2128fa41e7522ec1de0995248a2225d25fc48a37d7d7c8f69699d97a225406297c85b984e8faa5f3539d6b761b95ff5277d11d133e

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    mimas-bridgetown (0.1.0)
+      mimas
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bcrypt_pbkdf (1.1.2)
+    dry-cli (1.4.1)
+    ed25519 (1.4.0)
+    logger (1.7.0)
+    mimas (0.1.0)
+      bcrypt_pbkdf (~> 1.0)
+      dry-cli (~> 1.4)
+      ed25519 (~> 1.2)
+      logger (~> 1.7)
+      net-scp (~> 4.1)
+      net-ssh (~> 7.3)
+    net-scp (4.1.0)
+      net-ssh (>= 2.6.5, < 8.0.0)
+    net-ssh (7.3.3)
+    rake (13.4.2)
+
+PLATFORMS
+  arm64-darwin-23
+  ruby
+
+DEPENDENCIES
+  mimas-bridgetown!
+  rake
+
+CHECKSUMS
+  bcrypt_pbkdf (1.1.2) sha256=c2414c23ce66869b3eb9f643d6a3374d8322dfb5078125c82792304c10b94cf6
+  dry-cli (1.4.1) sha256=b8015bb76c708aa8705a36faf694973e75eeeffca39b89c8e172dc6f66a7d874
+  ed25519 (1.4.0) sha256=16e97f5198689a154247169f3453ef4cfd3f7a47481fde0ae33206cdfdcac506
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  mimas (0.1.0) sha256=2b7edf531824e6f1cd6938f081692ab8118882e89bf0e9f4a4113eb5852f83f2
+  mimas-bridgetown (0.1.0)
+  net-scp (4.1.0) sha256=a99b0b92a1e5d360b0de4ffbf2dc0c91531502d3d4f56c28b0139a7c093d1a5d
+  net-ssh (7.3.3) sha256=831def58b2c51dcef66ec00d29397d4f210de89c19fe78f95873ca30f386e86a
+  rake (13.4.2) sha256=cb825b2bd5f1f8e91ca37bddb4b9aaf345551b4731da62949be002fa89283701
+
+BUNDLED WITH
+  4.0.10

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2026-present Ayush Newatia
+
+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,47 @@
+# Bridgetown Plugin for Mimas
+
+Mimas is a CLI tool to orchestrate server provisioning and zero-downtime deploys for static sites and Ruby apps.
+
+This plugin helps setup Mimas for Bridgetown projects.
+
+## Installing 
+
+Install Mimas and this plugin:
+
+```shell
+$ bundle add mimas-bridgetown
+$ bundle binstub mimas
+```
+
+## Create Deployment Files
+
+Run the `init` command to setup the config files needed by Mimas:
+
+```shell
+$ bin/mimas init
+```
+
+You'll be prompted for details about your domain and server. The plugin provides configurations for static sites as well as hybrid apps that contain a Ruby service as well.
+
+A pre-deploy hook to build you Bridgetown site will also be set up.
+
+## Deploying
+
+Provision your server if you haven't already:
+
+```shell
+$ bin/mimas provision production
+```
+
+Push your site to your server:
+
+```shell
+# Push a static site only
+$ bin/mimas push production
+
+# Push a hybrid app
+$ bin/mimas push static production
+$ bin/mimas push api production
+```
+
+See the [Mimas Readme](https://codeberg.org/ayushn21/mimas) for complete usage and configuration details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/mimas/plugins/bridgetown/commands/init.rb

@@ -0,0 +1,70 @@
+module Mimas
+  module Plugins
+    module Bridgetown
+      module Commands
+        class Init < Mimas::CLI::Commands::BaseCommand
+          desc "Create a Mimas config file for Bridgetown"
+
+          def call
+            say "Initialising Mimas. We need some information about your site."
+            say ""
+
+            say "Your site's domain will be the containing folder on the server."
+            domain        = ask "What is your site's domain name?"
+            ip            = ask "What is your production server's IP address?"
+            site_type     = ask "Are you creating a \n  1. Static site \n  2. Static site and Ruby service \n (1 | 2)"
+            site_type     = site_types[site_type]
+
+            app_server = Bundler.load.requested_specs.map(&:name).filter { ["falcon", "puma"].include?(it) }.first
+            server_confirmation = "n"
+            if site_type == :hybrid
+              server_confirmation = ask "Are you using the #{app_server} server? (y|n)" if app_server
+
+              unless server_confirmation.downcase == "y"
+                say "Bridgetown and Mimas natively support Falcon and Puma. To use another server, ensure you configure it to bind to a unix socket defined in `ENV['MIMAS_UNIX_SOCKET']`".white.bold
+              end
+            end
+
+            Dir.mkdir("deploy") unless Dir.exist? "deploy"
+
+            destination_dir = File.join(Dir.pwd, Mimas::Config::DEFAULT_DIRECTORY)
+
+            config_dir = File.join(__dir__, "..", "templates")
+            configrb = template("config.rb", dir: config_dir, ip: ip, domain: domain, site_type: site_type, app_server: app_server)
+            File.write(File.join(destination_dir, "mimas.rb"), configrb)
+
+            if site_type == :hybrid
+              copy_file(destination_dir, "Caddyfile.static.erb")
+              copy_file(destination_dir, "Caddyfile.ruby.erb", rename: "Caddyfile.api.erb")
+
+              if server_confirmation == "y"
+                if app_server == "falcon"
+                  falconrb = template("falcon.rb", domain: domain)
+                  File.write(File.join(destination_dir, "falcon.rb"), falconrb)
+                elsif app_server == "puma"
+                  copy_file(destination_dir, "puma.rb")
+                end
+              end
+
+            else
+              copy_file(destination_dir, "Caddyfile.static.erb", rename: "Caddyfile.erb")
+            end
+
+            Dir.mkdir("tmp") unless Dir.exist?("tmp")
+
+            say ""
+            say "Successfully created files under `deploy/`. Customise your deployment by editing these files."
+            say "Please ensure your DNS is correctly configured."
+          end
+
+          def site_types
+            {
+              "1" => :static,
+              "2" => :hybrid
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mimas/plugins/bridgetown/templates/config.rb.erb

@@ -0,0 +1,57 @@
+<% if site_type == :static -%>
+site do
+  domain      "<%= domain %>"
+  root_dir    "output"
+  glob        "**/*"
+end
+<% elsif site_type == :hybrid -%>
+site :static do
+  domain      "<%= domain %>"
+  root_dir    "output"
+  glob        "**/*"
+end
+
+site :api do
+  domain  "api.<%= domain %>"
+  files do
+    `git ls-files -z`.split("\x0")
+      .reject { it.match(%r!(bin|mimas.rb|Caddyfile)!) }
+  end
+
+  healthcheck_path "/"
+
+  # Access the console by running `mimas console SERVER_NAME`
+  console "bin/bt console"
+
+  env do
+    <<~STRING
+      BRIDGETOWN_ENV=production
+    STRING
+  end
+
+  # Mimas automatically runs `bundle install` on deploy if no deploy script is defined.
+  # Ensure you invoke `bundle install` if you provide your own script here.
+  # deploy do
+  #  <<~STRING
+  #  STRING
+  # end
+
+  services do
+    web do
+<% if app_server == "puma" -%>
+      start "bundle exec puma -C deploy/puma.rb"
+<% elsif app_server == "falcon" -%>
+      start "bundle exec falcon host deploy/falcon.rb"
+<% else -%>
+      # TODO: Add your server's start command
+      start "bundle exec #start server"
+<% end -%>
+    end
+  end
+end
+<% end -%>
+
+server :production do
+  host  "<%= ip %>"
+  user  "deploy"
+end

data/lib/mimas/plugins/bridgetown/version.rb

@@ -0,0 +1,7 @@
+module Mimas
+  module Plugins
+    module Bridgetown
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/mimas/plugins/bridgetown.rb

@@ -0,0 +1,21 @@
+module Mimas
+  module Plugins
+    module Bridgetown
+      extend self
+
+      def commands
+        { "init" => Commands::Init }
+      end
+
+      def hooks
+        hooks = Mimas::Hooks.new
+
+        hooks.before_push do
+          `bin/bt deploy`
+        end
+
+        hooks
+      end
+    end
+  end
+end

data/lib/mimas-bridgetown.rb

@@ -0,0 +1,5 @@
+require "mimas"
+require_relative "mimas/plugins/bridgetown"
+require_relative "mimas/plugins/bridgetown/commands/init"
+
+Mimas::Plugins.register(Mimas::Plugins::Bridgetown)

data/mimas-bridgetown.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/mimas/plugins/bridgetown/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mimas-bridgetown"
+  spec.version       = Mimas::Plugins::Bridgetown::VERSION
+  spec.author        = "Ayush Newatia"
+  spec.email         = "ayush@hey.com"
+  spec.summary       = "Simplify Bridgetown deployment using Mimas"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+
+  spec.metadata["mimas_plugin"] = "true"
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.4.0"
+
+  spec.add_dependency "mimas"
+end

data/scripts/release

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Tag and push a release to Rubygems
+
+set -e
+
+bundle exec rake release

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: mimas-bridgetown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ayush Newatia
+bindir: bin
+cert_chain: []
+date: 2026-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimas
+  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'
+email: ayush@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mimas-bridgetown.rb
+- lib/mimas/plugins/bridgetown.rb
+- lib/mimas/plugins/bridgetown/commands/init.rb
+- lib/mimas/plugins/bridgetown/templates/config.rb.erb
+- lib/mimas/plugins/bridgetown/version.rb
+- mimas-bridgetown.gemspec
+- scripts/release
+licenses:
+- MIT
+metadata:
+  mimas_plugin: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Simplify Bridgetown deployment using Mimas
+test_files: []