bard 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dd77cf990608d404bbcc5cca1dd5ee5bfbb2310a08dd723495c237f66221bdd
-  data.tar.gz: 1d5e3e825ffeea97b828f7719e116a9ab506599c7f298282af7e2d4e20d5f257
+  metadata.gz: a48fc76ba8d93a7cbf4527db8645112863b1f21fd76616b260e43d70df8cf789
+  data.tar.gz: a8ccdfeb4872d4659f27018637395e111286af2c75cc7b4b31fde32744f4919a
 SHA512:
-  metadata.gz: 2bd4f528655c8b6e9a8d675a3a2ead6201f5b11c8c12a6abfcc011ca47fb998a80a73487e9273bfecb0ba670b2aaea8efcd1e74f2f0d6cbb7273c475169a881e
-  data.tar.gz: 812897863cd76a56f76af06cf9eaec0fa43fda334dcd5f5a43487309b823b97100dd199a57dede44a94439c6b67e0235364870e5bd623c24f68e2f3df8823726
+  metadata.gz: 6be5034adb2ce0c03540eef11b46bd00aba88ce4f333fd31d0fb914ee2568c6d355942efd3380b066c909c891c5b9d3fb8d4d3cf5f4cd2854e9d2f87d7f04ba4
+  data.tar.gz: b410e47c51b5c7d968cf3a633da99d54ef3908c58b517c36ad85389bc7f533e69efc7e35ebb96eb70cb86181e5c836b25c3393f30e4d04dd9518f036247d0ba8

data/lib/bard/plugins/git.rb

@@ -31,6 +31,15 @@ module Bard
       return false if git_dir.empty? || common_dir.empty?
       File.expand_path(git_dir) != File.expand_path(common_dir)
     end
+
+    def github_pages_url
+      remote = `git remote get-url origin`.chomp
+      match = remote.match(%r{github\.com[:/]+([^/]+?)/(.+?)(?:\.git)?/?\z})
+      raise "Could not derive a github.io URL: origin remote #{remote.inspect} is not a github.com repository" unless match
+      owner, repo = match[1], match[2]
+      host = "#{owner.downcase}.github.io"
+      repo.casecmp?(host) ? "https://#{host}/" : "https://#{host}/#{repo}/"
+    end
   end
 end
 

data/lib/bard/plugins/github_pages/strategy.rb

@@ -47,6 +47,12 @@ module Bard
       end
 
       def build_site
+        # No custom domain => the site serves under /<repo>/, so make the mirror relocatable:
+        # -k rewrites absolute links to relative, and the sed strips the localhost prefix wget
+        # bakes into any links it couldn't crawl.
+        convert_links = @domain ? "" : "-k"
+        relocate_step = @domain ? "" : %(find . -type f \\( -name '*.html' -o -name '*.css' \\) -exec sed -i "s#http://localhost:$PORT/#/#g" {} +)
+        cname_step = @domain ? "echo #{@domain} > CNAME" : ""
         system "rm -rf #{@build_dir.sub(@sha, "*")}"
         run! <<~SH
           set -e
@@ -78,9 +84,10 @@ module Bard
 
           cd $BUILD
           echo copying...
-          wget -nv -r -l inf --no-remove-listing -FEnH --reject-regex "(\\.*)\\?(.*)" http://localhost:$PORT/ 2>&1
+          wget -nv -r -l inf #{convert_links} --no-remove-listing -FEnH --reject-regex "(\\.*)\\?(.*)" http://localhost:$PORT/ 2>&1
 
-          echo #{@domain} > CNAME
+          #{relocate_step}
+          #{cname_step}
         SH
       ensure
         # cleanup

data/lib/bard/plugins/github_pages.rb

@@ -1,16 +1,21 @@
 require "bard/plugins/github_pages/strategy"
+require "bard/plugins/git"
 require "bard/config"
 require "bard/target"
 
 class Bard::Config
-  def github_pages(url)
-    uri = url.start_with?("http") ? URI.parse(url) : URI.parse("https://#{url}")
-    hostname = uri.hostname.sub(/^www\./, "")
+  def github_pages(url = nil)
+    hostname = if url
+      uri = url.start_with?("http") ? URI.parse(url) : URI.parse("https://#{url}")
+      uri.hostname.sub(/^www\./, "")
+    else 
+      Bard::Git.github_pages_url
+    end
 
     remove_target :production
     target :production do
       github_pages url
-      url(hostname) if hostname
+      url hostname
     end
 
     backup(false) if respond_to?(:backup)
@@ -18,12 +23,12 @@ class Bard::Config
 end
 
 class Bard::Target
-  def github_pages(url = nil)
-    if url.nil?
+  def github_pages(*args)
+    if args.empty?
       @github_pages_url
     else
       @deploy_strategy = :github_pages
-      @github_pages_url = url
+      @github_pages_url = args.first
       enable_capability(:github_pages)
     end
   end

data/lib/bard/version.rb

@@ -1,4 +1,4 @@
 module Bard
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end
 

data/spec/bard/config_spec.rb

@@ -147,4 +147,26 @@ describe Bard::Config do
       end
     end
   end
+
+  context "with github_pages directive and no domain" do
+    subject { described_class.new("test", source: "github_pages") }
+
+    before do
+      allow(Bard::Git).to receive(:github_pages_url).and_return("https://acme.github.io/widgets/")
+    end
+
+    describe "#target" do
+      it "creates a production target with github_pages enabled and no custom domain" do
+        production = subject[:production]
+        expect(production).not_to be_nil
+        expect(production.has_capability?(:github_pages)).to be true
+        expect(production.github_pages).to be_nil
+        expect(production.ssh).to be_nil
+      end
+
+      it "uses the derived github.io url for pinging" do
+        expect(subject[:production].url).to eq "https://acme.github.io/widgets/"
+      end
+    end
+  end
 end

data/spec/bard/deploy_strategy/github_pages_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+require "bard/plugins/github_pages/strategy"
+require "bard/plugins/github_pages"
+
+describe Bard::DeployStrategy::GithubPages do
+  let(:config) { double("config", project_name: "testapp") }
+
+  def build_shell_for(target)
+    strategy = described_class.new(target)
+    strategy.instance_variable_set(:@sha, "abc123")
+    strategy.instance_variable_set(:@build_dir, "tmp/github-build-abc123")
+    strategy.instance_variable_set(:@port, 4321)
+    strategy.instance_variable_set(:@domain, strategy.send(:extract_domain))
+
+    captured = []
+    allow(strategy).to receive(:run!) { |cmd| captured << cmd }
+    allow(strategy).to receive(:system)
+    strategy.send(:build_site)
+    captured.join("\n")
+  end
+
+  context "with no custom domain (project page under /<repo>/)" do
+    let(:target) do
+      Bard::Target.new(:production, config).tap { |t| t.github_pages(nil) }
+    end
+
+    it "mirrors with --convert-links so the tree is relocatable under the subpath" do
+      expect(build_shell_for(target)).to match(/wget .*\s-k\s/)
+    end
+
+    it "strips the localhost prefix wget bakes into un-crawled links" do
+      expect(build_shell_for(target))
+        .to include(%(sed -i "s#http://localhost:$PORT/#/#g"))
+    end
+
+    it "does not write a CNAME" do
+      expect(build_shell_for(target)).not_to match(/> CNAME/)
+    end
+  end
+
+  context "with a custom domain (served at the domain root)" do
+    let(:target) do
+      Bard::Target.new(:production, config).tap { |t| t.github_pages("example.com") }
+    end
+
+    it "does not add --convert-links" do
+      expect(build_shell_for(target)).not_to match(/wget .*\s-k\s/)
+    end
+
+    it "does not run the localhost strip" do
+      expect(build_shell_for(target)).not_to include("localhost:$PORT/#")
+    end
+
+    it "writes the CNAME" do
+      expect(build_shell_for(target)).to match(/echo example\.com > CNAME/)
+    end
+  end
+end

data/spec/bard/git_spec.rb

@@ -61,5 +61,41 @@ describe Bard::Git do
       expect(Bard::Git.sha_of("ref")).to be_nil
     end
   end
+
+  describe ".github_pages_url" do
+    def stub_origin(remote)
+      allow(Bard::Git).to receive(:`).with("git remote get-url origin").and_return("#{remote}\n")
+    end
+
+    it "derives a project pages url from an ssh remote" do
+      stub_origin("git@github.com:botandrose/bard")
+      expect(Bard::Git.github_pages_url).to eq("https://botandrose.github.io/bard/")
+    end
+
+    it "derives a project pages url from an https remote with a .git suffix" do
+      stub_origin("https://github.com/botandrose/bard.git")
+      expect(Bard::Git.github_pages_url).to eq("https://botandrose.github.io/bard/")
+    end
+
+    it "lowercases the owner in the pages host" do
+      stub_origin("git@github.com:BotAndRose/Bard.git")
+      expect(Bard::Git.github_pages_url).to eq("https://botandrose.github.io/Bard/")
+    end
+
+    it "uses the root url for a user/org pages repo" do
+      stub_origin("git@github.com:botandrose/botandrose.github.io")
+      expect(Bard::Git.github_pages_url).to eq("https://botandrose.github.io/")
+    end
+
+    it "raises for a non-github remote" do
+      stub_origin("git@gitlab.com:botandrose/bard.git")
+      expect { Bard::Git.github_pages_url }.to raise_error(/not a github\.com repository/)
+    end
+
+    it "raises when there is no origin remote" do
+      allow(Bard::Git).to receive(:`).with("git remote get-url origin").and_return("\n")
+      expect { Bard::Git.github_pages_url }.to raise_error(/not a github\.com repository/)
+    end
+  end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: bard
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Micah Geisel
 bindir: bin
 cert_chain: []
-date: 2026-07-02 00:00:00.000000000 Z
+date: 2026-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -254,6 +254,7 @@ files:
 - spec/bard/command_spec.rb
 - spec/bard/config_spec.rb
 - spec/bard/copy_spec.rb
+- spec/bard/deploy_strategy/github_pages_spec.rb
 - spec/bard/deploy_strategy/ssh_spec.rb
 - spec/bard/deploy_strategy_spec.rb
 - spec/bard/dynamic_dsl_spec.rb
@@ -323,6 +324,7 @@ test_files:
 - spec/bard/command_spec.rb
 - spec/bard/config_spec.rb
 - spec/bard/copy_spec.rb
+- spec/bard/deploy_strategy/github_pages_spec.rb
 - spec/bard/deploy_strategy/ssh_spec.rb
 - spec/bard/deploy_strategy_spec.rb
 - spec/bard/dynamic_dsl_spec.rb