giblish 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ec2fb091e00a933c081217c3a82f6b7002f3bffee15f5263ec9dc1f4f6ab128
-  data.tar.gz: 138dee38cd08e1efe6627635ef6fa110af3e5fa3f9ac96137afcbdf4296aa7e0
+  metadata.gz: fc2d44b3987ea014fad53e2accf48aa3734e1ba68c20328506179bf19e41621e
+  data.tar.gz: 65b013e0e91895ed2b9d882ff0249111856bbee31db29d72b08242d2cef9b3e6
 SHA512:
-  metadata.gz: 7a29d740604e700c77222b570df47119dcafa1c8f074f818d81ea9ce16c13736b9332ade2a04f1a151258b5043fe56e0883537a303438426599e039b526a2eb5
-  data.tar.gz: 414ac99ae8eed148a2b72453ae092fa5a0721917b5ca5d9cd8de8c0fc2b8c1edb65e92abe3f975f35562bf07e86492eb7781b9e856f0b0b88e2d77afe0d0947f
+  metadata.gz: e3cbae7cfd88de2a747dfe27e82bedf52fcb270963c8388a2f1b3e41c4401bd412a536e5d87097ce715c9c5aaf380385d85ee78b0d190669e6be1ffea24f8733
+  data.tar.gz: ca512fe02b3b3a172637bfaa955682fedbde866ba943276cc81b8389ff3b40b59e0714702d56752d11d0cf4a0b8413bbf06d371f3550a04b153c286378b0cd00

data/Changelog.adoc

@@ -7,6 +7,17 @@
  ** write instructions for github webhook triggered generation
  * Update the default css for giblish html generation.
 
+== v3.0.1
+
+ * add release scripts
+ * fix some linting issues
+
+== v3.0.0
+
+ * break out the pathtree operations into a separate gem (gran)
+ * bump ruby version to >= 3.3
+ * bump all asciidoctor dependencies to the latest available
+
 == v2.2.2
 
  * [BUGFIX] - fix a possible null ref when generating pdfs

data/giblish.gemspec

@@ -49,7 +49,7 @@ Gem::Specification.new do |spec|
   # 'matrix' needed because of incompatibilities between prawn v2.4
   # and ruby 3.1
   # sorbet-runtime
-  spec.add_runtime_dependency "gran", "~> 0.1"
+  spec.add_runtime_dependency "gran", "~> 0.1", ">= 0.1.1"
   #  spec.add_runtime_dependency "matrix", "~>0.4"
   spec.add_runtime_dependency "warning", "~>1.0"
   spec.add_runtime_dependency "asciidoctor", "~>2.0", ">= 2.0.25"

data/lib/giblish/gitrepos/checkoutmanager.rb

@@ -27,7 +27,7 @@ module Giblish
       raise ArgumentError, "The path: #{cmd_opts.srcdir} is not within a git repo!" if @repo_root.nil?
 
       @local_only = cmd_opts.local_only
-      @abort_on_error = cmd_opts.abort_on_error.nil? ? true : cmd_opts.abort_on_error
+      @abort_on_error = cmd_opts.abort_on_error.nil? || cmd_opts.abort_on_error
 
       @git_repo = init_git_repo(@repo_root, @local_only)
       @branches = select_user_branches(cmd_opts.branch_regex, @local_only)
@@ -76,7 +76,8 @@ module Giblish
 
       # merge branches with their upstream at origin unless
       # 'only local'
-      unless (treeish.respond_to?(:tag?) && treeish.tag?) || @local_only
+      is_tag = treeish.respond_to?(:tag?) && treeish.tag?
+      if !is_tag && !@local_only
         # this is a branch, make sure it is up-to-date
         Giblog.logger.info { "Merging with origin/#{treeish.name}" }
         @git_repo.merge "origin/#{treeish.name}"

data/lib/giblish/indexbuilders/subtree_indices.rb

@@ -76,11 +76,9 @@ module Giblish
 
         #{"Purpose::\n#{node_data.purpose_str}" unless node_data.purpose_str.to_s.empty?}
 
-        #{if node_data.stderr.empty?
-            ""
-          else
+        #{unless node_data.stderr.empty?
             "Conversion issues::\n"\
-            "#{node_data.stderr.gsub(/^/, " * ")}"
+              "#{node_data.stderr.gsub(/^/, " * ")}"
           end
         }
 

data/lib/giblish/version.rb

@@ -1,3 +1,3 @@
 module Giblish
-  VERSION = "3.0.0".freeze
+  VERSION = "3.0.1".freeze
 end

data/scripts/release.rb

@@ -0,0 +1,365 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+require "optparse"
+require "fileutils"
+
+# Release automation script for giblish gem
+class GiblishReleaseManager
+  GIBLISH_DIR = Pathname.new(__dir__).parent
+
+  VALID_COMMANDS = %w[prepare publish all].freeze
+  VALID_VERSION_TYPES = %w[major minor patch].freeze
+
+  attr_reader :command, :version_type, :dry_run, :yes, :specific_version
+
+  def initialize(args)
+    @dry_run = false
+    @yes = false
+    @specific_version = nil
+    parse_options(args)
+    validate_args
+  end
+
+  def run
+    puts "\n=== Giblish Release Manager ==="
+    puts "Command: #{command}"
+    puts "Version: #{version_type || specific_version}"
+    puts "Dry-run: #{dry_run}"
+    puts "================================\n\n"
+
+    case command
+    when "prepare"
+      prepare_release
+    when "publish"
+      publish_release
+    when "all"
+      prepare_release
+      publish_release
+    end
+  end
+
+  private
+
+  def parse_options(args)
+    OptionParser.new do |opts|
+      opts.banner = "Usage: release.rb [options] COMMAND [VERSION]"
+      opts.separator ""
+      opts.separator "COMMAND: #{VALID_COMMANDS.join(", ")}"
+      opts.separator "VERSION: #{VALID_VERSION_TYPES.join(", ")} or specific version (e.g., 0.2.0)"
+      opts.separator ""
+      opts.separator "Options:"
+
+      opts.on("-n", "--dry-run", "Show what would happen without doing it") do
+        @dry_run = true
+      end
+
+      opts.on("-y", "--yes", "Skip confirmation prompts") do
+        @yes = true
+      end
+
+      opts.on("-h", "--help", "Show this help message") do
+        puts opts
+        exit 0
+      end
+    end.parse!(args)
+
+    @command = args[0]
+
+    # Parse version argument
+    if args[1]
+      if VALID_VERSION_TYPES.include?(args[1])
+        @version_type = args[1]
+      elsif args[1].match?(/^\d+\.\d+\.\d+$/)
+        @specific_version = args[1]
+      else
+        puts "ERROR: Invalid version '#{args[1]}'. Must be #{VALID_VERSION_TYPES.join(", ")} or a version number (e.g., 0.2.0)"
+        exit 1
+      end
+    end
+  end
+
+  def validate_args
+    unless VALID_COMMANDS.include?(command)
+      puts "ERROR: Invalid command '#{command}'. Must be one of: #{VALID_COMMANDS.join(", ")}"
+      exit 1
+    end
+
+    if command != "publish" && version_type.nil? && specific_version.nil?
+      puts "ERROR: VERSION argument required for '#{command}' command"
+      exit 1
+    end
+  end
+
+  def prepare_release
+    puts "\n📦 Preparing giblish for release...\n"
+    with_dir(GIBLISH_DIR) do
+      run_safety_checks
+      check_gran_dependency
+      new_version = bump_version(GIBLISH_DIR / "lib/giblish/version.rb")
+      update_changelog(new_version)
+      build_gem
+      create_git_commit_and_tag(new_version)
+      success("Giblish prepared for release: v#{new_version}")
+    end
+  end
+
+  def publish_release
+    puts "\n🚀 Publishing giblish to RubyGems...\n"
+    with_dir(GIBLISH_DIR) do
+      push_to_github
+      publish_gem
+      success("Giblish published!")
+    end
+  end
+
+  # Safety Checks
+  def run_safety_checks
+    step("Running safety checks")
+    check_git_status
+    check_on_main_branch
+    run_tests
+    run_linter
+  end
+
+  def check_git_status
+    output = `git status --porcelain`.strip
+    unless output.empty?
+      error("Working directory is not clean. Commit or stash changes first.")
+    end
+  end
+
+  def check_on_main_branch
+    branch = `git rev-parse --abbrev-ref HEAD`.strip
+    unless branch == "main"
+      unless confirm("You are on branch '#{branch}', not 'main'. Continue anyway?")
+        error("Aborted. Switch to main branch or use --yes to override.")
+      end
+    end
+  end
+
+  def run_tests
+    step("Running tests")
+    unless system("bundle exec rake test > /dev/null 2>&1")
+      error("Tests failed! Fix tests before releasing.")
+    end
+  end
+
+  def run_linter
+    step("Running linter")
+    unless system("bundle exec rake standard > /dev/null 2>&1")
+      error("Linter failed! Fix linting issues before releasing.")
+    end
+  end
+
+  def check_gran_dependency
+    gemspec_path = GIBLISH_DIR / "giblish.gemspec"
+    content = File.read(gemspec_path)
+
+    if content =~ /add_runtime_dependency\s+"gran",\s+"~>\s*([\d.]+)"/
+      current_dep = $1
+      latest_gran = get_latest_rubygems_version("gran")
+
+      if latest_gran && Gem::Version.new(latest_gran) > Gem::Version.new(current_dep)
+        puts "⚠️  Gran dependency in giblish.gemspec is ~> #{current_dep}"
+        puts "    Latest gran on RubyGems is #{latest_gran}"
+        puts "    Consider updating the dependency before releasing."
+        unless confirm("Continue with current gran dependency?")
+          error("Aborted. Update gran dependency first.")
+        end
+      end
+    end
+  end
+
+  # Version Management
+  def bump_version(version_file)
+    current_version = extract_version(version_file)
+    new_version = calculate_new_version(current_version)
+
+    puts "Current version: #{current_version}"
+    puts "New version: #{new_version}"
+
+    unless confirm("Bump version to #{new_version}?")
+      error("Aborted by user")
+    end
+
+    update_version_file(version_file, current_version, new_version)
+    new_version
+  end
+
+  def extract_version(version_file)
+    content = File.read(version_file)
+    if content =~ /VERSION\s*=\s*"([\d.]+)"/
+      $1
+    else
+      error("Could not find VERSION in #{version_file}")
+    end
+  end
+
+  def calculate_new_version(current)
+    return specific_version if specific_version
+
+    parts = current.split(".").map(&:to_i)
+    case version_type
+    when "major"
+      "#{parts[0] + 1}.0.0"
+    when "minor"
+      "#{parts[0]}.#{parts[1] + 1}.0"
+    when "patch"
+      "#{parts[0]}.#{parts[1]}.#{parts[2] + 1}"
+    end
+  end
+
+  def update_version_file(version_file, old_version, new_version)
+    content = File.read(version_file)
+    content.gsub!(/VERSION\s*=\s*"#{Regexp.escape(old_version)}"/,
+      "VERSION = \"#{new_version}\"")
+
+    if dry_run
+      puts "[DRY-RUN] Would update #{version_file.basename} to #{new_version}"
+    else
+      File.write(version_file, content)
+      puts "✓ Updated #{version_file.basename}"
+    end
+  end
+
+  # Changelog
+  def update_changelog(version)
+    step("Updating CHANGELOG")
+    puts "⚠️  Please update the CHANGELOG manually with changes for v#{version}"
+    puts "Press Enter when done..."
+    $stdin.gets unless yes
+  end
+
+  # Gem Operations
+  def build_gem
+    step("Building giblish gem")
+
+    if dry_run
+      puts "[DRY-RUN] Would run: gem build giblish.gemspec"
+    else
+      unless system("gem build giblish.gemspec")
+        error("Failed to build gem")
+      end
+      puts "✓ Gem built successfully"
+    end
+  end
+
+  def publish_gem
+    gem_file = Dir.glob("giblish-*.gem").max_by { |f| File.mtime(f) }
+
+    unless gem_file
+      error("No gem file found to publish")
+    end
+
+    step("Publishing #{gem_file}")
+
+    unless confirm("Push #{gem_file} to RubyGems.org?")
+      error("Aborted by user")
+    end
+
+    if dry_run
+      puts "[DRY-RUN] Would run: gem push #{gem_file}"
+    else
+      unless system("gem push #{gem_file}")
+        error("Failed to publish gem")
+      end
+      puts "✓ Gem published successfully"
+    end
+  end
+
+  # Git Operations
+  def create_git_commit_and_tag(version)
+    tag_name = "giblish-v#{version}"
+    commit_message = "Release giblish v#{version}"
+
+    step("Creating git commit and tag")
+
+    if dry_run
+      puts "[DRY-RUN] Would run:"
+      puts "  git add ."
+      puts "  git commit -m '#{commit_message}'"
+      puts "  git tag -a #{tag_name} -m '#{commit_message}'"
+    else
+      system("git add .")
+      unless system("git commit -m '#{commit_message}'")
+        error("Failed to create commit")
+      end
+      unless system("git tag -a #{tag_name} -m '#{commit_message}'")
+        error("Failed to create tag")
+      end
+      puts "✓ Created commit and tag: #{tag_name}"
+    end
+  end
+
+  def push_to_github
+    step("Pushing to GitHub")
+
+    unless confirm("Push commits and tags to GitHub?")
+      error("Aborted by user")
+    end
+
+    if dry_run
+      puts "[DRY-RUN] Would run:"
+      puts "  git push origin main"
+      puts "  git push origin --tags"
+    else
+      unless system("git push origin main")
+        error("Failed to push commits")
+      end
+      unless system("git push origin --tags")
+        error("Failed to push tags")
+      end
+      puts "✓ Pushed to GitHub"
+    end
+  end
+
+  # Helpers
+  def get_latest_rubygems_version(gem_name)
+    output = `gem search ^#{gem_name}$ --remote 2>/dev/null`
+    if output =~ /#{gem_name}\s+\(([\d.]+)\)/
+      $1
+    end
+  end
+
+  def with_dir(dir)
+    original_dir = Dir.pwd
+    Dir.chdir(dir)
+    yield
+  ensure
+    Dir.chdir(original_dir)
+  end
+
+  def confirm(message)
+    return true if yes
+    print "#{message} (y/N): "
+    response = $stdin.gets.strip.downcase
+    response == "y" || response == "yes"
+  end
+
+  def step(message)
+    puts "\n→ #{message}..."
+  end
+
+  def success(message)
+    puts "\n✓ #{message}\n"
+  end
+
+  def error(message)
+    puts "\n✗ ERROR: #{message}\n"
+    exit 1
+  end
+end
+
+# Run the script
+if __FILE__ == $0
+  if ARGV.empty?
+    puts "Usage: release.rb [options] COMMAND [VERSION]"
+    puts "Run with --help for more information"
+    exit 1
+  end
+
+  manager = GiblishReleaseManager.new(ARGV)
+  manager.run
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giblish
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Anders Rillbert
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-10-17 00:00:00.000000000 Z
+date: 2025-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gran
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: warning
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +214,7 @@ files:
 - lib/giblish/version.rb
 - scripts/hooks/post-receive.example
 - scripts/hooks/post-update.example
+- scripts/release.rb
 - scripts/resources/css/adoc-colony.css
 - scripts/resources/css/giblish-serif.css
 - scripts/resources/css/giblish.css