vagrant-ssh-config-manager 1.0.0.alpha → 1.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f9a813e321f5ad9c85a343e9caf8d1fff7c220e91e5276f54ce306677d0264
-  data.tar.gz: 92261bf77ca112add8fe96b3c35c613ea7bc461022008b75a9aff879c5a146a8
+  metadata.gz: 1c65d67becc3cd83b365456e37514f3b2c1509e7d089a42419cc3202434c0b5e
+  data.tar.gz: fd9ddd98df6e0a3a260387250b5e843b33150705738debbfe5bc9ac7c528e0c0
 SHA512:
-  metadata.gz: 6807f6309de0a625b8773a98c696a9e40e6b74465a009f1b2fa57d355cfc6007cab440ff468e98590fa84e6aaca5bc3bce3dc65ad9219e432620370640dfa60a
-  data.tar.gz: bb1dc4515944ae88da5a621a8e48d87ca16c9ef60c5a2ee717f3c6eaef64bbc6dded204d90d006d79808473a02d4971cfbe380e67d2d81e7fbbcbc6d5d441295
+  metadata.gz: a56070239d397f265090a6d75e8ff00caa2438a819e4959f6954dd0118835b33c7c0bfc285d06e2ff3a3ea98fac6c95103c4e895c33b4fc8aede5a905a84fdbd
+  data.tar.gz: 67f5f03db6beaeafc6e8aa7bbe3d66f267d08ef062d74d0f50f77324d0acd786cdb17bc3a5c4212a732dc25c5f4a940e7a0e036e229e49354e142ab0b57f704a

data/.gitignore

@@ -1,6 +1,8 @@
 vendor
-.github/instructions
+.github/*instructions*
 test_file
 vagrant-ssh-config-manager-*.gem
 Gemfile.lock
-.vagrant
+.vagrant
+.pi/plans
+.pi/discussions

data/.rubocop.yml

@@ -2,25 +2,43 @@
 
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
+
+Metrics/ClassLength:
+  Max: 300
 
-# Disable metrics and complexity cops for large methods/classes
-Metrics/BlockLength:
-  Enabled: false
 Metrics/MethodLength:
-  Enabled: false
+  Max: 40
+  Exclude:
+    - 'lib/vagrant_ssh_config_manager/action/*.rb'
+    - 'lib/vagrant_ssh_config_manager/ssh_info_extractor.rb'
+
 Metrics/AbcSize:
-  Enabled: false
+  Max: 35
+  Exclude:
+    - 'lib/vagrant_ssh_config_manager/action/*.rb'
+    - 'lib/vagrant_ssh_config_manager/config.rb'
+    - 'lib/vagrant_ssh_config_manager/ssh_info_extractor.rb'
+    - 'spec/**/*'
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+    - 'vagrant-ssh-config-manager.gemspec'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Keep these complexity cops out of the v1 cleanup gate for now. The enabled
+# MethodLength/ClassLength/AbcSize gates cover the largest maintainability risks.
 Metrics/CyclomaticComplexity:
   Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-Metrics/ClassLength:
-  Enabled: false
 Metrics/BlockNesting:
   Enabled: false
-Layout/LineLength:
-  Enabled: false
-  Max: 120
 
 # Disable accessor naming cop for spec files (get_ prefix methods allowed in tests)
 Naming/AccessorMethodName:

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/vagrant-ssh-config-manager.svg)](https://badge.fury.io/rb/vagrant-ssh-config-manager) [![Run Tests](https://github.com/marekruzicka/vagrant-ssh-config-manager/actions/workflows/test.yml/badge.svg)](https://github.com/marekruzicka/vagrant-ssh-config-manager/actions/workflows/test.yml)
+
 # Vagrant SSH Config Manager
 
 A Vagrant plugin that automatically manages SSH configuration entries for Vagrant-managed VMs, providing seamless SSH access without the need to remember ports, IPs, or key locations.
@@ -6,8 +8,8 @@ A Vagrant plugin that automatically manages SSH configuration entries for Vagran
 
 - **Automatic SSH Config Management**: Creates and maintains SSH config files when VMs are started
 - **Project Isolation**: Each Vagrant project gets its own SSH config namespace to avoid conflicts
-- **Separate File Management**: Creates individual SSH config files for each VM in a dedicated directory
-- **Include Directive Management**: Automatically manages Include directives in your main SSH config
+- **Per-VM File Management**: Creates one SSH config file per VM under `~/.ssh/config.d/vagrant/`
+- **Include Directive Management**: Optionally manages the `Include ~/.ssh/config.d/vagrant/*.conf` directive in your main SSH config
 - **Lifecycle Integration**: Hooks into all Vagrant VM lifecycle events (up, destroy, reload, halt, provision)
 - **Configurable Behavior**: Extensive configuration options for different workflows
 - **Robust Error Handling**: Graceful handling of file permission issues and concurrent access
@@ -97,9 +99,9 @@ end
 
 ## How It Works
 
-### Separate File Architecture (Default)
+### Per-VM File Architecture
 
-The plugin creates individual SSH config files for each VM in a dedicated directory (default: `~/.ssh/config.d/vagrant/`). This approach:
+v1 uses a per-VM SSH config architecture. The plugin creates one SSH config file for each VM in a dedicated directory (default: `~/.ssh/config.d/vagrant/`) and SSH reads those files through an `Include` directive. This approach:
 
 - **Prevents conflicts**: Each VM has its own config file
 - **Enables easier cleanup**: Destroying a VM removes only its config file
@@ -110,12 +112,21 @@ The plugin creates individual SSH config files for each VM in a dedicated direct
 
 ```
 ~/.ssh/config                           # Your main SSH config
+  └── Include ~/.ssh/config.d/vagrant/*.conf
 ~/.ssh/config.d/vagrant/                # Plugin-managed directory
   ├── a1b2c3d4-web.conf                # Individual VM config files
   ├── a1b2c3d4-db.conf
   └── f5e6d7c8-api.conf                # From different projects
 ```
 
+Per-VM filenames use the first eight characters of the MD5 hash of the project path for storage uniqueness:
+
+```
+{md5-project-hash}-{vm}.conf
+```
+
+The MD5 hash is only used in filenames. SSH `Host` aliases never include the MD5 hash.
+
 ### Include Directive Management
 
 When `manage_includes` is enabled (default: false), the plugin automatically adds:
@@ -131,10 +142,17 @@ Include ~/.ssh/config.d/vagrant/*.conf
 
 ### Project Isolation
 
-Each Vagrant project gets a unique identifier based on the project path:
+`project_isolation` controls SSH alias naming:
+
+- `project_isolation: true` (default): `Host {project}-{vm}` such as `my-app-web`
+- `project_isolation: false`: `Host {vm}` such as `web`
+
+Set `project_isolation` to `false` when host names are managed elsewhere, such as by `vagrant-hostmanager`. Be mindful of hostname collisions when using non-isolated aliases.
+
+Storage filenames remain hash-prefixed regardless of `project_isolation`:
+
 - Project path: `/home/user/my-app`
 - Project hash: `a1b2c3d4` (first 8 chars of MD5)
-- SSH host names: `my-app-web`, `my-app-db`
 - Config files: `a1b2c3d4-web.conf`, `a1b2c3d4-db.conf`
 
 ### Individual Config File Example

data/Rakefile

@@ -3,7 +3,22 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+# Unit and integration specs must run in separate Ruby processes.
+# Integration specs load the real Vagrant gem which defines
+# Vagrant::Plugin::V2::Config as a class; unit specs mock it as a
+# module, causing TypeError when loaded in the same process.
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**/*_spec.rb'
+  end
+end
+
+desc 'Run all specs (unit + integration in separate processes)'
+task spec: ['spec:unit', 'spec:integration']
 
 task default: :spec
 

data/TESTING.md

@@ -5,14 +5,12 @@ This project uses a **hybrid testing approach** that combines fast unit tests wi
 ## 🚀 Quick Start
 
 ```bash
-# Run unit tests (fast, recommended for development)
-bundle exec rspec spec/unit/
+# Canonical full-suite command
+bundle exec rake
 
-# Run integration tests (real APIs)
-bundle exec rspec spec/integration/
-
-# Run both test suites
-./test-all.sh
+# Individual suites
+bundle exec rake spec:unit
+bundle exec rake spec:integration
 
 # Helper scripts for detailed output:
 ./test-unit.sh           # Unit tests with documentation format
@@ -20,6 +18,8 @@ bundle exec rspec spec/integration/
 ./test-all.sh            # Both suites with progress format
 ```
 
+`bundle exec rake` is the supported full-suite command. It runs unit and integration specs in separate Ruby processes because integration specs load real Vagrant while unit specs mock some Vagrant constants.
+
 ## 📁 Test Structure
 
 ```
@@ -29,26 +29,23 @@ spec/
 ├── unit/                    # Fast, isolated unit tests
 │   ├── config_spec.rb          # ✅ Config class (32 examples)
 │   ├── file_locker_spec.rb     # ✅ FileLocker class (27 examples)
-│   ├── file_manager_spec.rb    # ✅ FileManager class (39 examples)
-│   └── ssh_config_manager_spec.rb # ✅ SshConfigManager class (43 examples)
+│   └── file_manager_spec.rb    # ✅ FileManager class (39 examples)
 └── integration/             # Real API integration tests
     └── include_manager_spec.rb # ✅ IncludeManager (14 examples)
 ```
 
 ## ✅ Current Test Status
 
-- **Unit Tests**: 141 examples, 0 failures (~0.23s)
-- **Integration Tests**: 14 examples, 0 failures (~0.02s)
-- **Total**: **155 examples, 0 failures** (100% pass rate)
+- **Unit Tests**: run with `bundle exec rake spec:unit`
+- **Integration Tests**: run with `bundle exec rake spec:integration`
+- **Full Suite**: run with `bundle exec rake`
 - **Combined Runtime**: ~0.25 seconds (extremely fast!)
 
 ## 🚀 Performance Metrics
 
 ```bash
-$ ./test-all.sh
-📦 Unit Tests: 141 examples, 0 failures (0.23s)
-🔗 Integration Tests: 14 examples, 0 failures (0.02s)
-✅ Total: 155 examples, 0 failures
+$ bundle exec rake
+# Runs unit specs, then integration specs, in separate Ruby processes
 ```
 
 ## 🔧 Test Types
@@ -56,17 +53,16 @@ $ ./test-all.sh
 ### Unit Tests (spec/unit/)
 - **Purpose**: Fast feedback, isolated component testing
 - **Setup**: Mocked dependencies, no real Vagrant loading
-- **Speed**: ~0.23 seconds for 141 tests
+- **Command**: `bundle exec rake spec:unit`
 - **Coverage**: 
-  - Config validation and setup (32 examples)
-  - FileLocker concurrency and thread safety (27 examples)
-  - FileManager SSH file operations (39 examples)
-  - SshConfigManager entry management (43 examples)
+  - Config validation and setup
+  - FileLocker concurrency and thread safety
+  - FileManager SSH file operations
 
 ### Integration Tests (spec/integration/)
 - **Purpose**: Real API verification, end-to-end testing
 - **Setup**: Real Vagrant APIs, isolated file system environments
-- **Speed**: ~0.02 seconds for 14 tests
+- **Command**: `bundle exec rake spec:integration`
 - **Coverage**: IncludeManager SSH config manipulation, plugin markers
 
 ## 🛠 Helper Scripts

data/lib/vagrant_ssh_config_manager/config.rb

@@ -84,7 +84,8 @@ module VagrantPlugins
                 errors << "sshconfigmanager.ssh_config_dir cannot be created: #{e.message}"
               end
             else
-              errors << "sshconfigmanager.ssh_config_dir does not exist and auto_create_dir is disabled: #{@ssh_config_dir}"
+              errors << 'sshconfigmanager.ssh_config_dir does not exist and auto_create_dir is disabled: '
+              errors[-1] += @ssh_config_dir
             end
           else
             errors << 'sshconfigmanager.ssh_config_dir must be a string path'
@@ -152,20 +153,30 @@ module VagrantPlugins
         result = self.class.new
 
         # Merge each attribute, preferring the other config's values if set
-        result.enabled = other.enabled == UNSET_VALUE ? @enabled : other.enabled
-        result.ssh_config_dir = other.ssh_config_dir == UNSET_VALUE ? @ssh_config_dir : other.ssh_config_dir
-        result.manage_includes = other.manage_includes == UNSET_VALUE ? @manage_includes : other.manage_includes
-        result.auto_create_dir = other.auto_create_dir == UNSET_VALUE ? @auto_create_dir : other.auto_create_dir
-        result.cleanup_empty_dir = other.cleanup_empty_dir == UNSET_VALUE ? @cleanup_empty_dir : other.cleanup_empty_dir
-        result.auto_remove_on_destroy = other.auto_remove_on_destroy == UNSET_VALUE ? @auto_remove_on_destroy : other.auto_remove_on_destroy
-        result.update_on_reload = other.update_on_reload == UNSET_VALUE ? @update_on_reload : other.update_on_reload
-        result.refresh_on_provision = other.refresh_on_provision == UNSET_VALUE ? @refresh_on_provision : other.refresh_on_provision
-        result.keep_config_on_halt = other.keep_config_on_halt == UNSET_VALUE ? @keep_config_on_halt : other.keep_config_on_halt
-        result.project_isolation = other.project_isolation == UNSET_VALUE ? @project_isolation : other.project_isolation
+        config_attributes.each do |attribute|
+          result.public_send("#{attribute}=", merged_value(other, attribute))
+        end
 
         result
       end
 
+      # Config attributes that can be inherited/merged.
+      def config_attributes
+        %i[
+          enabled ssh_config_dir manage_includes auto_create_dir cleanup_empty_dir
+          auto_remove_on_destroy update_on_reload refresh_on_provision
+          keep_config_on_halt project_isolation
+        ]
+      end
+
+      # Prefer explicitly set child values when merging config objects.
+      def merged_value(other, attribute)
+        other_value = other.public_send(attribute)
+        return public_send(attribute) if other_value == UNSET_VALUE
+
+        other_value
+      end
+
       # Create SSH config directory with proper permissions
       def ensure_ssh_config_directory
         return false unless @auto_create_dir
@@ -178,13 +189,6 @@ module VagrantPlugins
           false
         end
       end
-
-      # Retrieve the SSH config manager for a given machine
-      def ssh_manager_instance(_machine)
-        require_relative 'file_manager'
-        FileManager.new(self)
-      end
-      alias get_ssh_manager_instance ssh_manager_instance
     end
   end
 end

data/lib/vagrant_ssh_config_manager/file_manager.rb

@@ -204,12 +204,35 @@ module VagrantPlugins
 
       # Generate SSH host name for machine
       def generate_host_name(machine)
-        if @config.project_isolation
-          project_name = File.basename(machine.env.root_path)
-          "#{project_name}-#{machine.name}"
-        else
-          machine.name.to_s
-        end
+        host_name = if @config.project_isolation
+                      project_name = sanitize_name(File.basename(machine.env.root_path))
+                      vm_name = sanitize_name(machine.name.to_s)
+                      "#{project_name}-#{vm_name}"
+                    else
+                      sanitize_name(machine.name.to_s)
+                    end
+
+        truncate_host_name(host_name)
+      end
+
+      # Sanitize project and VM names for use as SSH host aliases.
+      def sanitize_name(name)
+        return 'unknown' if name.nil? || name.to_s.strip.empty?
+
+        name.to_s
+            .gsub(/[^a-zA-Z0-9\-_.]/, '-')
+            .gsub(/\.+/, '.')
+            .gsub(/-+/, '-')
+            .gsub(/^[-._]+|[-._]+$/, '')
+            .downcase
+            .then { |value| value.empty? ? 'unknown' : value }
+      end
+
+      # Keep generated aliases short enough for common hostname consumers.
+      def truncate_host_name(host_name, max_length = 64)
+        return host_name if host_name.length <= max_length
+
+        host_name[0...max_length].gsub(/[-._]+$/, '')
       end
 
       # Write file atomically using temporary file and rename

data/lib/vagrant_ssh_config_manager/plugin.rb

@@ -39,14 +39,12 @@ module VagrantPlugins
         hook.before(Vagrant::Action::Builtin::GracefulHalt, Action::Halt)
       end
 
-      action_hook(:ssh_config_manager, :machine_action_suspend) do |hook|
-        require 'vagrant_ssh_config_manager/action/halt'
-        hook.before(Vagrant::Action::Builtin::Suspend, Action::Halt)
-      end
+      # Suspend hook removed: Vagrant 2.4.x has no built-in suspend action
+      # middleware constant. Halt behavior (keep SSH config) covers suspend.
 
       action_hook(:ssh_config_manager, :machine_action_resume) do |hook|
         require 'vagrant_ssh_config_manager/action/up'
-        hook.after(Vagrant::Action::Builtin::Resume, Action::Up)
+        hook.after(Vagrant::Action::Builtin::WaitForCommunicator, Action::Up)
       end
 
       action_hook(:ssh_config_manager, :machine_action_provision) do |hook|

data/lib/vagrant_ssh_config_manager/version.rb

@@ -2,6 +2,6 @@
 
 module VagrantPlugins
   module SshConfigManager
-    VERSION = '1.0.0.alpha'
+    VERSION = '1.0.0.alpha.2'
   end
 end

data/vagrant-ssh-config-manager.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/marekruzicka/vagrant-ssh-config-manager'
   spec.license       = 'MIT'
 
-  spec.metadata['documentation_uri'] = 'https://rubydoc.info/github/marekruzicka/vagrant-ssh-config-manager/main'
+  spec.metadata['documentation_uri'] = 'https://github.com/marekruzicka/vagrant-ssh-config-manager#readme'
   spec.metadata['source_code_uri']   = 'https://github.com/marekruzicka/vagrant-ssh-config-manager'
   spec.metadata['changelog_uri']     = 'https://github.com/marekruzicka/vagrant-ssh-config-manager/blob/main/CHANGELOG.md'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-ssh-config-manager
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha
+  version: 1.0.0.alpha.2
 platform: ruby
 authors:
 - Marek Ruzicka
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-14 00:00:00.000000000 Z
+date: 2026-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,6 @@ files:
 - lib/vagrant_ssh_config_manager/file_manager.rb
 - lib/vagrant_ssh_config_manager/include_manager.rb
 - lib/vagrant_ssh_config_manager/plugin.rb
-- lib/vagrant_ssh_config_manager/ssh_config_manager.rb
 - lib/vagrant_ssh_config_manager/ssh_info_extractor.rb
 - lib/vagrant_ssh_config_manager/version.rb
 - test-all.sh
@@ -120,7 +119,7 @@ homepage: https://github.com/marekruzicka/vagrant-ssh-config-manager
 licenses:
 - MIT
 metadata:
-  documentation_uri: https://rubydoc.info/github/marekruzicka/vagrant-ssh-config-manager/main
+  documentation_uri: https://github.com/marekruzicka/vagrant-ssh-config-manager#readme
   source_code_uri: https://github.com/marekruzicka/vagrant-ssh-config-manager
   changelog_uri: https://github.com/marekruzicka/vagrant-ssh-config-manager/blob/main/CHANGELOG.md
   vagrant_plugin: 'true'