mirrorfile 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de77b25cb4e899eb5e29e28c56864a7f592a917721333e7846f27143ce4e7fd1
-  data.tar.gz: e67318033257885299216cb91234ca51f53204224e6fd2a17d7e3cb86170b832
+  metadata.gz: 513175ce2e6de6e4e0a0a810d844ce5a280fd3e899cf490b289249054a8c37f9
+  data.tar.gz: 9a8ca82bdd368ef020c97fbf156aba1e5d3cad6860e5eef4e02226165c167277
 SHA512:
-  metadata.gz: 9f78685072b0bc631479c96d980a78a52f45e00d8ed9109937f9ead3a2de2e0fc1a48e5f85556630c7e7a22b5e160e1949b70c42d0513cbc91320c4626a33e16
-  data.tar.gz: f0c17c1fe5cfa8ac281bf61c0b0b7e0f1f9c518476444a49184087845ea355664f5f7f0613176710698455e34751212b3d6fc210fa84fd00dce9df74fba499e3
+  metadata.gz: 0046b1bde5286137d682244bf597e8f72a0d43a206c6013b4dc470b08b9dead8ebbe0d7aa390c63437330b9ccf15c93dbefc99ca8e5a0bd346606166232f38b9
+  data.tar.gz: fa70c541f5cdaa6e17c2a654bf07a094cb2037a405409a9fda00fe8f7d725331cb6b66737915fe1df8b39a2f7c8bdbe4bcd887a1a536fd7c1420fa8bcbbdd971

data/lib/mirrorfile/cli.rb

@@ -21,12 +21,7 @@ module Mirrorfile
   class CLI
     # Available CLI commands
     # @return [Array<String>] list of valid commands
-    COMMANDS = %w[init install update list migrate-to-v1 help].freeze
-
-    # Deprecation warning shown on every command except migrate-to-v1
-    DEPRECATION_WARNING = <<~WARN.freeze
-      [mirrorfile] WARNING: v#{VERSION} is deprecated. Run `mirror migrate-to-v1` to upgrade to v1.0.
-    WARN
+    COMMANDS = %w[init install update list git help].freeze
 
     # Creates a new CLI instance.
     #
@@ -53,16 +48,31 @@ module Mirrorfile
     def call(args)
       command = args.first
 
-      @stderr.puts DEPRECATION_WARNING unless command == 'migrate-to-v1'
+      if legacy_command?(command) && Mirror.new.legacy?
+        return CLILegacy.new(stdout: @stdout, stderr: @stderr).call(args)
+      end
+
+      dispatch(args)
+    end
+
+    # Dispatches args to the appropriate command method.
+    #
+    # Separated from {#call} so that {CLILegacy} can dispatch
+    # without re-checking legacy state.
+    #
+    # @param args [Array<String>] command-line arguments
+    # @return [Integer] exit status code
+    def dispatch(args)
+      command = args.first
 
       case command
-      when 'init'           then init
-      when 'install'        then install
-      when 'update'         then update
-      when 'list'           then list
-      when 'migrate-to-v1'  then migrate_to_v1
-      when 'help'           then help
-      when '-h', '--help'   then help
+      when 'init'    then init
+      when 'install' then install
+      when 'update'  then update
+      when 'list'    then list
+      when 'git'     then git(args.drop(1))
+      when 'help'    then help
+      when '-h', '--help' then help
       when '-v', '--version' then version
       else usage
       end
@@ -79,6 +89,19 @@ module Mirrorfile
 
     private
 
+    # Returns whether the given command should use legacy mode
+    # when legacy mirrors are detected.
+    #
+    # Commands like init, help, and version flags are not affected
+    # by legacy state and always use the standard CLI.
+    #
+    # @param command [String, nil] the command name
+    # @return [Boolean]
+    # @api private
+    def legacy_command?(command)
+      %w[install update list git].include?(command)
+    end
+
     # Executes the init command.
     #
     # @return [void]
@@ -117,12 +140,16 @@ module Mirrorfile
       entries.empty? ? @stdout.puts('No mirrors defined.') : entries.each { @stdout.puts _1 }
     end
 
-    # Executes the migrate-to-v1 command.
+    # Executes a git command against a .git.mirror directory.
+    #
+    # Runs git with --git-dir=.git.mirror in the current working
+    # directory, passing through all additional arguments.
     #
+    # @param args [Array<String>] arguments to pass to git
     # @return [void]
     # @api private
-    def migrate_to_v1
-      Mirror.new.migrate_to_v1
+    def git(args)
+      system('git', '--git-dir=.git.mirror', *args)
     end
 
     # Displays help information.
@@ -136,13 +163,13 @@ module Mirrorfile
         Usage: mirror <command>
 
         Commands:
-          init           Initialize project with Mirrorfile, .gitignore entry,
-                         and Zeitwerk initializer for Rails projects
-          install        Clone repositories that don't exist locally
-          update         Pull latest changes for existing repositories
-          list           Show all defined mirrors
-          migrate-to-v1  Upgrade to mirrorfile v1.0
-          help           Show this help message
+          init      Initialize project with Mirrorfile, .gitignore entry,
+                    and Zeitwerk initializer for Rails projects
+          install   Clone repositories that don't exist locally
+          update    Pull latest changes for existing repositories
+          list      Show all defined mirrors
+          git       Run git commands against a .git.mirror directory
+          help      Show this help message
 
         Options:
           -h, --help     Show this help message
@@ -152,6 +179,7 @@ module Mirrorfile
           $ mirror init
           $ mirror install
           $ mirror update
+          $ cd mirrors/rails && mirror git log --oneline
 
         Mirrorfile syntax:
           source "https://github.com"
@@ -184,12 +212,12 @@ module Mirrorfile
         Usage: mirror <command>
 
         Commands:
-          init           Create Mirrorfile, .gitignore entry, and Zeitwerk initializer (Rails only)
-          install        Clone repositories that don't exist locally
-          update         Pull latest changes for existing repositories
-          list           Show all defined mirrors
-          migrate-to-v1  Upgrade to mirrorfile v1.0
-          help           Show detailed help
+          init      Create Mirrorfile, .gitignore entry, and Zeitwerk initializer (Rails only)
+          install   Clone repositories that don't exist locally
+          update    Pull latest changes for existing repositories
+          list      Show all defined mirrors
+          git       Run git commands against a .git.mirror directory
+          help      Show detailed help
 
         Run 'mirror help' for more information.
       USAGE

data/lib/mirrorfile/cli_legacy.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Mirrorfile
+  # Legacy CLI for projects with old-style .git directories.
+  #
+  # This CLI is used automatically when mirrorfile detects that the
+  # mirrors directory contains repositories with .git instead of
+  # .git.mirror. It prints a deprecation warning and operates using
+  # the legacy .git directory name.
+  #
+  # @see CLI
+  # @since 1.0.0
+  class CLILegacy < CLI
+    LEGACY_WARNING = <<~WARN
+      [mirrorfile] WARNING: Your mirrors use legacy .git directories.
+      Upgrade with mirrorfile v0.1.1 (`mirror migrate-to-v1`), or remove
+      the mirrors/ directory and re-run `mirror install`.
+    WARN
+
+    # Overrides CLI#call to skip legacy detection and dispatch directly.
+    #
+    # @param args [Array<String>] command-line arguments
+    # @return [Integer] exit status code
+    def call(args)
+      dispatch(args)
+    end
+
+    private
+
+    # Executes the install command in legacy mode.
+    #
+    # @return [void]
+    # @api private
+    def install
+      @stderr.puts LEGACY_WARNING
+      @stdout.puts 'Installing mirrors (legacy mode)...'
+      Mirror.new.install(legacy: true)
+      @stdout.puts 'Done.'
+    end
+
+    # Executes the update command in legacy mode.
+    #
+    # @return [void]
+    # @api private
+    def update
+      @stderr.puts LEGACY_WARNING
+      @stdout.puts 'Updating mirrors (legacy mode)...'
+      Mirror.new.update(legacy: true)
+      @stdout.puts 'Done.'
+    end
+
+    # Executes the list command with a legacy warning.
+    #
+    # @return [void]
+    # @api private
+    def list
+      @stderr.puts LEGACY_WARNING
+      super
+    end
+
+    # Executes a git command using the default .git directory.
+    #
+    # In legacy mode, mirrors have .git (not .git.mirror), so
+    # no --git-dir flag is needed.
+    #
+    # @param args [Array<String>] arguments to pass to git
+    # @return [void]
+    # @api private
+    def git(args)
+      @stderr.puts LEGACY_WARNING
+      system('git', *args)
+    end
+  end
+end

data/lib/mirrorfile/entry.rb

@@ -41,7 +41,13 @@ module Mirrorfile
     # clone the repository once. If the local directory already exists,
     # no action is taken.
     #
+    # After cloning, the .git directory is renamed to the configured
+    # git_dir name (default: .git.mirror) so that the host project's
+    # git does not treat it as a nested repository.
+    #
     # @param base_dir [Pathname] the base directory to clone into
+    # @param git_dir [String] the git directory name to use
+    #   (default: ".git.mirror", use ".git" for legacy mode)
     # @return [Boolean, nil] true if clone succeeded, false if failed,
     #   nil if already exists
     #
@@ -49,9 +55,15 @@ module Mirrorfile
     #   entry.install(Pathname.new("mirrors"))
     #
     # @see #update
-    def install(base_dir)
+    def install(base_dir, git_dir: '.git.mirror')
       dir = local_path(base_dir)
-      system("git", "clone", url, dir.to_s) unless dir.exist?
+      return if dir.exist?
+
+      return unless system('git', 'clone', url, dir.to_s)
+
+      return unless git_dir != '.git'
+
+      File.rename(dir.join('.git').to_s, dir.join(git_dir).to_s)
     end
 
     # Updates an existing repository by pulling the latest changes.
@@ -60,6 +72,8 @@ module Mirrorfile
     # If the local directory doesn't exist, no action is taken.
     #
     # @param base_dir [Pathname] the base directory containing the clone
+    # @param git_dir [String] the git directory name to use
+    #   (default: ".git.mirror", use ".git" for legacy mode)
     # @return [Boolean, nil] true if pull succeeded, false if failed,
     #   nil if directory doesn't exist
     #
@@ -67,9 +81,12 @@ module Mirrorfile
     #   entry.update(Pathname.new("mirrors"))
     #
     # @see #install
-    def update(base_dir)
+    def update(base_dir, git_dir: '.git.mirror')
       dir = local_path(base_dir)
-      system("git", "-C", dir.to_s, "pull", "--ff-only") if dir.exist?
+      return unless dir.exist?
+
+      system('git', '--git-dir', dir.join(git_dir).to_s,
+             '--work-tree', dir.to_s, 'pull', '--ff-only')
     end
 
     # Returns a human-readable representation of the entry.

data/lib/mirrorfile/mirror.rb

@@ -68,10 +68,11 @@ module Mirrorfile
     #   mirror.install
     #
     # @see Entry#install
-    def install
+    def install(legacy: false)
       ensure_mirrorfile!
       mirrors_dir.mkpath
-      @mirrorfile.entries.each { _1.install(mirrors_dir) }
+      git_dir = legacy ? '.git' : '.git.mirror'
+      @mirrorfile.entries.each { _1.install(mirrors_dir, git_dir: git_dir) }
     end
 
     # Updates all existing local repositories.
@@ -88,9 +89,10 @@ module Mirrorfile
     #   mirror.update
     #
     # @see Entry#update
-    def update
+    def update(legacy: false)
       ensure_mirrorfile!
-      @mirrorfile.entries.each { _1.update(mirrors_dir) }
+      git_dir = legacy ? '.git' : '.git.mirror'
+      @mirrorfile.entries.each { _1.update(mirrors_dir, git_dir: git_dir) }
     end
 
     # Initializes a new project with mirror support.
@@ -117,6 +119,7 @@ module Mirrorfile
     def init
       create_mirrorfile
       setup_gitignore
+      setup_templates
       setup_zeitwerk
       puts "Initialized mirrors in #{root}"
     end
@@ -133,21 +136,18 @@ module Mirrorfile
       @mirrorfile.entries.to_a
     end
 
-    # Migrates the project to mirrorfile v1.0.
+    # Returns whether any mirrors use legacy .git directories.
     #
-    # Performs the following steps:
-    # - Updates Gemfile version constraint to ~> 1.0 (if Gemfile exists)
-    # - Updates the system gem if installed
-    # - Installs template files (.envrc, README.md) into mirrors/
-    # - Renames .git directories to .git.mirror in existing mirrors
+    # A project is considered legacy if any subdirectory of mirrors/
+    # contains a .git directory without a .git.mirror sibling.
     #
-    # @return [void]
-    def migrate_to_v1
-      update_gemfile
-      update_system_gem
-      install_templates
-      rename_git_dirs
-      puts 'Migration to v1.0 complete.'
+    # @return [Boolean] true if legacy mirrors are detected
+    def legacy?
+      return false unless mirrors_dir.exist?
+
+      mirrors_dir.children.select(&:directory?).any? do |path|
+        path.join('.git').exist? && !path.join('.git.mirror').exist?
+      end
     end
 
     private
@@ -253,87 +253,24 @@ module Mirrorfile
       RUBY
     end
 
-    # Updates the Gemfile to use mirrorfile ~> 1.0.
-    #
-    # Replaces any existing mirrorfile gem declaration with one
-    # constrained to ~> 1.0. Does nothing if Gemfile doesn't exist
-    # or doesn't reference mirrorfile.
-    #
-    # @return [void]
-    # @api private
-    def update_gemfile
-      gemfile = root.join('Gemfile')
-      return unless gemfile.exist?
-
-      content = gemfile.read
-      updated = content.gsub(/^(\s*gem\s+["']mirrorfile["']).*$/, '\1, "~> 1.0"')
-
-      return unless content != updated
-
-      gemfile.write(updated)
-      puts 'Updated Gemfile to mirrorfile ~> 1.0'
-    end
-
-    # Updates the system-installed mirrorfile gem.
-    #
-    # Checks if the gem is installed globally and runs gem update
-    # if so.
-    #
-    # @return [void]
-    # @api private
-    def update_system_gem
-      return if ENV['MIRRORFILE_SKIP_GEM_UPDATE']
-      return unless system('gem', 'list', '-i', 'mirrorfile', out: File::NULL, err: File::NULL)
-
-      puts 'Updating system gem...'
-      system('gem', 'update', 'mirrorfile')
-    end
-
     # Copies template files into the mirrors directory.
     #
-    # Creates the mirrors directory if needed, then copies
-    # envrc.template and README.md.template. Existing files
-    # are not overwritten.
+    # Creates the mirrors directory if it doesn't exist, then copies
+    # envrc.template and README.md.template from the gem's
+    # templates directory. Existing files are not overwritten.
     #
     # @return [void]
     # @api private
-    def install_templates
+    def setup_templates
       mirrors_dir.mkpath
 
       templates_dir = Pathname.new(__dir__).join('../../templates')
 
       envrc_dest = mirrors_dir.join('.envrc')
-      unless envrc_dest.exist?
-        FileUtils.cp(templates_dir.join('envrc.template'), envrc_dest)
-        puts 'Created mirrors/.envrc'
-      end
+      envrc_dest.exist? || FileUtils.cp(templates_dir.join('envrc.template'), envrc_dest)
 
       readme_dest = mirrors_dir.join('README.md')
-      return if readme_dest.exist?
-
-      FileUtils.cp(templates_dir.join('README.md.template'), readme_dest)
-      puts 'Created mirrors/README.md'
-    end
-
-    # Renames .git directories to .git.mirror in existing mirrors.
-    #
-    # Scans all subdirectories of mirrors/ for .git directories
-    # and renames them. Skips entries that already have .git.mirror.
-    #
-    # @return [void]
-    # @api private
-    def rename_git_dirs
-      return unless mirrors_dir.exist?
-
-      mirrors_dir.children.select(&:directory?).each do |mirror_path|
-        git_dir = mirror_path.join('.git')
-        git_mirror_dir = mirror_path.join('.git.mirror')
-
-        if git_dir.exist? && !git_mirror_dir.exist?
-          File.rename(git_dir.to_s, git_mirror_dir.to_s)
-          puts "Renamed #{mirror_path.basename}/.git to .git.mirror"
-        end
-      end
+      readme_dest.exist? || FileUtils.cp(templates_dir.join('README.md.template'), readme_dest)
     end
 
     # Determines if the current project is a Rails application by checking

data/lib/mirrorfile/version.rb

@@ -3,5 +3,5 @@
 module Mirrorfile
   # Current version of the Mirrorfile gem
   # @return [String] the semantic version string
-  VERSION = '0.1.1'
+  VERSION = '1.0.0'
 end

data/lib/mirrorfile.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require "pathname"
+require 'pathname'
 
-require_relative "mirrorfile/version"
-require_relative "mirrorfile/entry"
-require_relative "mirrorfile/mirrorfile"
-require_relative "mirrorfile/mirror"
-require_relative "mirrorfile/cli"
+require_relative 'mirrorfile/version'
+require_relative 'mirrorfile/entry'
+require_relative 'mirrorfile/mirrorfile'
+require_relative 'mirrorfile/mirror'
+require_relative 'mirrorfile/cli'
+require_relative 'mirrorfile/cli_legacy'
 
 # Mirrorfile is a gem for managing local mirrors of git repositories.
 #
@@ -49,14 +50,14 @@ module Mirrorfile
     #
     # @return [Pathname] path to the mirrors directory
     def mirrors_dir
-      root.join("mirrors")
+      root.join('mirrors')
     end
 
     # Returns the path to the Mirrorfile
     #
     # @return [Pathname] path to the Mirrorfile
     def mirrorfile_path
-      root.join("Mirrorfile")
+      root.join('Mirrorfile')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirrorfile
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Nathan Kidd
@@ -88,6 +88,7 @@ files:
 - flake.nix
 - lib/mirrorfile.rb
 - lib/mirrorfile/cli.rb
+- lib/mirrorfile/cli_legacy.rb
 - lib/mirrorfile/entry.rb
 - lib/mirrorfile/mirror.rb
 - lib/mirrorfile/mirrorfile.rb