middleman-s3_sync 4.5.0 → 4.6.1

data/spec/s3_sync_integration_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+require 'middleman/s3_sync'
+
+describe 'S3Sync CloudFront Integration' do
+  let(:app) { double('middleman_app') }
+  let(:s3_sync_options) do
+    double(
+      cloudfront_invalidate: true,
+      cloudfront_distribution_id: 'E1234567890123',
+      cloudfront_invalidate_all: false,
+      cloudfront_invalidation_batch_size: 1000,
+      aws_access_key_id: 'test_key',
+      aws_secret_access_key: 'test_secret',
+      aws_session_token: nil,
+      dry_run: false,
+      verbose: false,
+      delete: true,
+      bucket: 'test-bucket'
+    )
+  end
+
+  before do
+    allow(::Middleman::Application).to receive(:new).and_return(app)
+    allow(Middleman::S3Sync).to receive(:s3_sync_options).and_return(s3_sync_options)
+    allow(Middleman::S3Sync).to receive(:say_status)
+    allow(Middleman::S3Sync).to receive(:work_to_be_done?).and_return(true)
+    allow(Middleman::S3Sync).to receive(:update_bucket_versioning)
+    allow(Middleman::S3Sync).to receive(:update_bucket_website)
+    allow(Middleman::S3Sync).to receive(:ignore_resources)
+    allow(Middleman::S3Sync).to receive(:create_resources)
+    allow(Middleman::S3Sync).to receive(:update_resources)
+    allow(Middleman::S3Sync).to receive(:delete_resources)
+    allow(Middleman::S3Sync::CloudFront).to receive(:invalidate)
+  end
+
+  describe 'CloudFront invalidation integration' do
+    it 'calls CloudFront invalidation after sync operations' do
+      # Reset invalidation paths for this test
+      Middleman::S3Sync.instance_variable_set(:@invalidation_paths, [])
+      
+      expect(Middleman::S3Sync::CloudFront).to receive(:invalidate).with(
+        [], # Initially empty, gets populated during resource operations
+        s3_sync_options
+      )
+
+      Middleman::S3Sync.sync
+    end
+
+    it 'calls CloudFront invalidation with collected paths' do
+      # Mock the methods to inject paths during sync
+      allow(Middleman::S3Sync).to receive(:create_resources) do
+        Middleman::S3Sync.add_invalidation_path('/updated/file.html')
+      end
+      allow(Middleman::S3Sync).to receive(:update_resources) do
+        Middleman::S3Sync.add_invalidation_path('/new/file.css')
+      end
+
+      expect(Middleman::S3Sync::CloudFront).to receive(:invalidate) do |paths, options|
+        expect(paths).to include('/updated/file.html')
+        expect(paths).to include('/new/file.css')
+        expect(options).to eq(s3_sync_options)
+      end
+
+      Middleman::S3Sync.sync
+    end
+
+    context 'when cloudfront_invalidate_all is true' do
+      let(:s3_sync_options) do
+        double(
+          cloudfront_invalidate: true,
+          cloudfront_distribution_id: 'E1234567890123',
+          cloudfront_invalidate_all: true,
+          bucket: 'test-bucket'
+        )
+      end
+
+      it 'still calls CloudFront invalidation even when no work is needed' do
+        allow(Middleman::S3Sync).to receive(:work_to_be_done?).and_return(false)
+        
+        expect(Middleman::S3Sync::CloudFront).to receive(:invalidate).with(
+          [], s3_sync_options
+        )
+
+        Middleman::S3Sync.sync
+      end
+    end
+
+    context 'when CloudFront invalidation is disabled' do
+      let(:s3_sync_options) do
+        double(
+          cloudfront_invalidate: false,
+          bucket: 'test-bucket'
+        )
+      end
+
+      it 'does not call CloudFront invalidation' do
+        expect(Middleman::S3Sync::CloudFront).not_to receive(:invalidate)
+
+        Middleman::S3Sync.sync
+      end
+    end
+  end
+
+  describe 'path tracking during resource operations' do
+    before do
+      # Reset invalidation paths before each path tracking test
+      Middleman::S3Sync.instance_variable_set(:@invalidation_paths, [])
+    end
+
+    it 'adds paths to invalidation list when resources are processed' do
+      # Test the add_invalidation_path method directly
+      Middleman::S3Sync.add_invalidation_path('test/file.html')
+      Middleman::S3Sync.add_invalidation_path('images/photo.jpg')
+      
+      expect(Middleman::S3Sync.invalidation_paths).to include('/test/file.html')
+      expect(Middleman::S3Sync.invalidation_paths).to include('/images/photo.jpg')
+    end
+
+    it 'normalizes paths when adding to invalidation list' do
+      Middleman::S3Sync.add_invalidation_path('no-leading-slash.html')
+      
+      expect(Middleman::S3Sync.invalidation_paths).to include('/no-leading-slash.html')
+    end
+
+    it 'does not add duplicate paths' do
+      Middleman::S3Sync.add_invalidation_path('/same/path.html')
+      Middleman::S3Sync.add_invalidation_path('/same/path.html')
+      
+      expect(Middleman::S3Sync.invalidation_paths.count('/same/path.html')).to eq(1)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-s3_sync
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.1
 platform: ruby
 authors:
 - Frederic Jean
 - Will Koehler
 bindir: bin
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-cloudfront
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: map
   requirement: !ruby/object:Gem::Requirement
@@ -312,6 +326,7 @@ files:
 - lib/middleman/redirect.rb
 - lib/middleman/s3_sync.rb
 - lib/middleman/s3_sync/caching_policy.rb
+- lib/middleman/s3_sync/cloudfront.rb
 - lib/middleman/s3_sync/options.rb
 - lib/middleman/s3_sync/resource.rb
 - lib/middleman/s3_sync/status.rb
@@ -319,7 +334,9 @@ files:
 - lib/middleman_extension.rb
 - middleman-s3_sync.gemspec
 - spec/caching_policy_spec.rb
+- spec/cloudfront_spec.rb
 - spec/resource_spec.rb
+- spec/s3_sync_integration_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/fredjean/middleman-s3_sync
 licenses:
@@ -344,5 +361,7 @@ specification_version: 4
 summary: Tries really, really hard not to push files to S3.
 test_files:
 - spec/caching_policy_spec.rb
+- spec/cloudfront_spec.rb
 - spec/resource_spec.rb
+- spec/s3_sync_integration_spec.rb
 - spec/spec_helper.rb