mirrorfile 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 513175ce2e6de6e4e0a0a810d844ce5a280fd3e899cf490b289249054a8c37f9
-  data.tar.gz: 9a8ca82bdd368ef020c97fbf156aba1e5d3cad6860e5eef4e02226165c167277
+  metadata.gz: 4216911dce60b274bfaf08354c6ebedba8a3e226750a655236fbed0dbbaf8d13
+  data.tar.gz: c7b0bd4bc994641810ea9ff115e198171ef81b929d539f1d9942f198fad0ebb5
 SHA512:
-  metadata.gz: 0046b1bde5286137d682244bf597e8f72a0d43a206c6013b4dc470b08b9dead8ebbe0d7aa390c63437330b9ccf15c93dbefc99ca8e5a0bd346606166232f38b9
-  data.tar.gz: fa70c541f5cdaa6e17c2a654bf07a094cb2037a405409a9fda00fe8f7d725331cb6b66737915fe1df8b39a2f7c8bdbe4bcd887a1a536fd7c1420fa8bcbbdd971
+  metadata.gz: d45d8d2a3c7eb6cd6e39df812c499b5a595daa22949bbbbaeedcfac03ffa0c05483ecd1579fa599ba11e7c816fcef452b111f965afab81c520e30059e08c3b91
+  data.tar.gz: 53e4c4554638cbd36571be7a7ef852803b5c10f6e714d3bb7c872405320681413dbb8cb7dbddbc633609bae6ea5887f9f1af6b4822086db1ee0f0b429e374c3f

data/CHANGELOG.md

@@ -7,6 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.0] - 2026-10-21
+
+### Added
+
+- `mirror init` now declares `mirrorfile` in an existing `Gemfile`: when the
+  project root has a `Gemfile` that does not already depend on the gem,
+  `Mirrorfile::Mirror#init` runs `bundle add mirrorfile` before creating the
+  Mirrorfile. Projects without a `Gemfile` are unaffected, and an existing
+  declaration is left alone. A failing `bundle add` raises `Mirrorfile::Error`.
+
+### Changed
+
+- `gem_kit` (`~> 0.2`) is now a runtime dependency of the gem, not just a
+  development one.
+
 ## [0.1.0] - 2024-01-01
 
 ### Added

data/README.md

@@ -28,6 +28,9 @@ mirror update    # pulls existing repos
 mirror list      # shows defined mirrors
 ```
 
+When a Gemfile exists, `mirror init` adds and installs mirrorfile
+via Bundler unless it is already declared as a dependency.
+
 ## Example Mirrorfile
 
 You can change sources mid-file:

data/lib/mirrorfile/cli.rb

@@ -21,7 +21,7 @@ module Mirrorfile
   class CLI
     # Available CLI commands
     # @return [Array<String>] list of valid commands
-    COMMANDS = %w[init install update list git help].freeze
+    COMMANDS = %w[init install update list git migrate-to-v1 help].freeze
 
     # Creates a new CLI instance.
     #
@@ -70,8 +70,9 @@ module Mirrorfile
       when 'install' then install
       when 'update'  then update
       when 'list'    then list
-      when 'git'     then git(args.drop(1))
-      when 'help'    then help
+      when 'git'            then git(args.drop(1))
+      when 'migrate-to-v1'  then migrate_to_v1
+      when 'help'           then help
       when '-h', '--help' then help
       when '-v', '--version' then version
       else usage
@@ -152,6 +153,14 @@ module Mirrorfile
       system('git', '--git-dir=.git.mirror', *args)
     end
 
+    # Executes the migrate-to-v1 command.
+    #
+    # @return [void]
+    # @api private
+    def migrate_to_v1
+      Mirror.new.migrate_to_v1
+    end
+
     # Displays help information.
     #
     # @return [void]
@@ -163,13 +172,15 @@ 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
-          git       Run git commands against a .git.mirror directory
-          help      Show this help message
+          init           Initialize project with Mirrorfile, .gitignore entry,
+                         and Zeitwerk initializer for Rails projects;
+                         add mirrorfile to an existing Gemfile
+          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
+          migrate-to-v1  Upgrade legacy mirrors to v1.0 format
+          help           Show this help message
 
         Options:
           -h, --help     Show this help message
@@ -212,12 +223,14 @@ 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
-          git       Run git commands against a .git.mirror directory
-          help      Show detailed help
+          init           Create Mirrorfile, .gitignore entry, and Zeitwerk initializer (Rails only)
+                         Add mirrorfile to an existing Gemfile
+          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
+          migrate-to-v1  Upgrade legacy mirrors to v1.0 format
+          help           Show detailed help
 
         Run 'mirror help' for more information.
       USAGE

data/lib/mirrorfile/mirror.rb

@@ -103,6 +103,7 @@ module Mirrorfile
     # - Creates a Mirrorfile with example syntax
     # - Adds /mirrors to .gitignore (creates file if needed)
     # - Creates a Rails initializer for Zeitwerk autoloading (Rails projects only)
+    # - Adds mirrorfile as a dependency if a Gemfile exists
     #
     # Existing files are not overwritten.
     #
@@ -117,6 +118,7 @@ module Mirrorfile
     # @see #setup_gitignore
     # @see #setup_zeitwerk
     def init
+      setup_dependency
       create_mirrorfile
       setup_gitignore
       setup_templates
@@ -136,6 +138,23 @@ module Mirrorfile
       @mirrorfile.entries.to_a
     end
 
+    # Migrates the project to mirrorfile v1.0.
+    #
+    # 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
+    #
+    # @return [void]
+    def migrate_to_v1
+      update_gemfile
+      update_system_gem
+      setup_templates
+      rename_git_dirs
+      puts 'Migration to v1.0 complete.'
+    end
+
     # Returns whether any mirrors use legacy .git directories.
     #
     # A project is considered legacy if any subdirectory of mirrors/
@@ -152,6 +171,28 @@ module Mirrorfile
 
     private
 
+    # Adds mirrorfile to the project's bundle, preserving existing declarations.
+    #
+    # @return [void]
+    # @raise [Error] if Bundler cannot add the dependency
+    # @api private
+    def setup_dependency
+      gemfile = root.join('Gemfile').expand_path
+      return unless gemfile.file?
+
+      require 'bundler'
+
+      Bundler.with_unbundled_env do
+        definition = Bundler::Dsl.new
+        definition.eval_gemfile(gemfile)
+        next if definition.dependencies.any? { |dependency| dependency.name == 'mirrorfile' }
+
+        unless system('bundle', 'add', 'mirrorfile', chdir: root.to_s)
+          raise Error, 'Failed to run bundle add mirrorfile'
+        end
+      end
+    end
+
     # Loads and parses the Mirrorfile.
     #
     # @return [Mirrorfile] the parsed Mirrorfile
@@ -273,6 +314,63 @@ module Mirrorfile
       readme_dest.exist? || FileUtils.cp(templates_dir.join('README.md.template'), readme_dest)
     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
+
+    # 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
+    end
+
     # Determines if the current project is a Rails application by checking
     # for the standard Rails application entrypoint.
     #

data/lib/mirrorfile/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mirrorfile
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nathan Kidd
@@ -9,6 +9,20 @@ bindir: exe
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gem_kit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -77,15 +91,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".envrc"
-- ".yardopts"
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
 - exe/mirror
-- flake.lock
-- flake.nix
 - lib/mirrorfile.rb
 - lib/mirrorfile/cli.rb
 - lib/mirrorfile/cli_legacy.rb
@@ -93,7 +102,6 @@ files:
 - lib/mirrorfile/mirror.rb
 - lib/mirrorfile/mirrorfile.rb
 - lib/mirrorfile/version.rb
-- mirrorfile.gemspec
 - templates/README.md.template
 - templates/envrc.template
 homepage: https://github.com/n-at-han-k/mirrorfile

data/.envrc

@@ -1 +0,0 @@
-use flake

data/.yardopts

@@ -1,7 +0,0 @@
---markup markdown
---markup-provider redcarpet
---charset utf-8
---output-dir doc
---readme README.md
---title "GitMirror Documentation"
-lib/**/*.rb

data/Rakefile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "yard"
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
-
-YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib/**/*.rb"]
-  t.options = ["--markup", "markdown"]
-end
-
-task default: :test

data/flake.lock

@@ -1,61 +0,0 @@
-{
-  "nodes": {
-    "flake-utils": {
-      "inputs": {
-        "systems": "systems"
-      },
-      "locked": {
-        "lastModified": 1731533236,
-        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
-        "type": "github"
-      },
-      "original": {
-        "owner": "numtide",
-        "repo": "flake-utils",
-        "type": "github"
-      }
-    },
-    "nixpkgs": {
-      "locked": {
-        "lastModified": 1772773019,
-        "narHash": "sha256-E1bxHxNKfDoQUuvriG71+f+s/NT0qWkImXsYZNFFfCs=",
-        "owner": "nixos",
-        "repo": "nixpkgs",
-        "rev": "aca4d95fce4914b3892661bcb80b8087293536c6",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nixos",
-        "ref": "nixos-unstable",
-        "repo": "nixpkgs",
-        "type": "github"
-      }
-    },
-    "root": {
-      "inputs": {
-        "flake-utils": "flake-utils",
-        "nixpkgs": "nixpkgs"
-      }
-    },
-    "systems": {
-      "locked": {
-        "lastModified": 1681028828,
-        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
-        "owner": "nix-systems",
-        "repo": "default",
-        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
-        "type": "github"
-      },
-      "original": {
-        "owner": "nix-systems",
-        "repo": "default",
-        "type": "github"
-      }
-    }
-  },
-  "root": "root",
-  "version": 7
-}

data/flake.nix

@@ -1,34 +0,0 @@
-{
-  inputs = {
-    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
-
-    flake-utils.url = "github:numtide/flake-utils";
-    flake-utils.inputs.nixpkgs.follows = "nixpkgs";
-  };
-
-  outputs = { self, nixpkgs, flake-utils }:
-    flake-utils.lib.eachDefaultSystem (system:
-      let
-        pkgs = nixpkgs.legacyPackages.${system};
-      in
-      {
-        devShells.default = pkgs.mkShell {
-          packages = with pkgs; [
-            ruby_3_4
-            bundler
-          ];
-
-          shellHook = ''
-            export BUNDLE_PATH=".bundler"
-            export GEM_PATH=".bundler/ruby/3.4.0"
-
-            export PATH="$PWD/bin:$PATH"
-            export PATH=".bundler/ruby/3.4.0/bin:$PATH"
-          '';
-
-        };
-
-        packages.default = pkgs.hello;
-      }
-    );
-}

data/mirrorfile.gemspec

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/mirrorfile/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "mirrorfile"
-  spec.version = Mirrorfile::VERSION
-  spec.authors = ["Nathan Kidd"]
-  spec.email = ["nathankidd@hey.com"]
-
-  spec.summary = "Manage local mirrors of git repositories"
-
-  spec.description = <<~DESC
-    Mirrorfile provides a DSL similar to Bundler's Gemfile for managing local
-    mirrors of git repositories. Clone and keep repositories updated with
-    simple commands. Includes Rails/Zeitwerk integration for autoloading
-    mirrored code.
-  DESC
-
-  spec.homepage = "https://github.com/n-at-han-k/mirrorfile"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.2.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
-  spec.metadata["documentation_uri"] = spec.homepage
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
-    end
-  end
-
-  spec.bindir = "exe"
-  spec.executables = ["mirror"]
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rubocop", "~> 1.21"
-  spec.add_development_dependency "yard", "~> 0.9"
-end