capistrano-s3 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7181c1cd58ffcacd370bc1801a4a1de156b60490
-  data.tar.gz: 48c6ab3151aa29bc96df90bcbb50bbb66340f2f7
+  metadata.gz: cb5552bb93390a37dfef42b1c2f04ab86f8c24b2
+  data.tar.gz: 7e90088960110cc77b870709ab8e1b7cc1d00af0
 SHA512:
-  metadata.gz: df7c91285663a990bef6c758a9119b11fde17c6fc6e82b01b753c62925331f68f757d8132338aae56787d87e22b3377c8a566d4e5db2550228eeaab87986a21f
-  data.tar.gz: eb45abf3f729d1f3c92245c2e76bc505651ffd5eb94dc4ab2c6bb591a12511570cb870c9f97a78feb8918a862d40dd55bb507f4ce8fb38eb79a1cf4f12b48b71
+  metadata.gz: 96b33af80859e1be1a7df56b268d6f8f6bf6a9061c16fd006ff4d2d702571bbfaa36803a7bc228db9385d088ac6cacc3b6a3e5dcbd35400467f00da5ac88ec05
+  data.tar.gz: aaeec8a903a3e4e1c1d44246108217e33b6a80046df824ed12a86b71e90c4ddb84941166b9c1465f37eed448e5c0ad85d6c87e7b9a7e85e18ef95db26884388f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v1.2.0
+
+Feature : Add exclusions (#30) @exoszajzbuk
+
 ## v1.1.0
 
 Feature : Add support for Cloudfront invalidations (#29) @exoszajzbuk

data/README.md

@@ -139,6 +139,14 @@ set :distribution_id, "CHANGETHIS"
 set :invalidations, [ "/index.html", "/assets/*" ]
 ```
 
+### Exclude files and directories
+
+You can set a list of files or directories to exclude from upload. The path must relative to `deployment_path` and use the `dir/**/*` pattern to exclude directories.
+
+```ruby
+set :exclusions, [ "index.html", "resources/**/*" ]
+```
+
 ## Example of usage
 
 Our Ruby stack for static websites:

data/lib/capistrano/s3/defaults.rb

@@ -7,7 +7,8 @@ module Capistrano
         :s3_endpoint          => "s3.amazonaws.com",
         :redirect_options     => {},
         :only_gzip            => false,
-        :invalidations        => []
+        :invalidations        => [],
+        :exclusions           => []
       }
 
       def self.populate(context, set_method)

data/lib/capistrano/s3/publisher.rb

@@ -7,11 +7,11 @@ module Capistrano
     module Publisher
       LAST_PUBLISHED_FILE = '.last_published'
 
-      def self.publish!(s3_endpoint, key, secret, bucket, source, distribution_id, invalidations, only_gzip, extra_options)
+      def self.publish!(s3_endpoint, key, secret, bucket, source, distribution_id, invalidations, exclusions, only_gzip, extra_options)
         s3 = self.establish_s3_client_connection!(s3_endpoint, key, secret)
         updated = false
 
-        self.files(source).each do |file|
+        self.files(source, exclusions).each do |file|
           if !File.directory?(file)
             next if self.published?(file)
             next if only_gzip && self.has_gzipped_version?(file)
@@ -78,8 +78,8 @@ module Capistrano
           file.gsub(root, "")
         end
 
-        def self.files(deployment_path)
-          Dir.glob("#{deployment_path}/**/*")
+        def self.files(deployment_path, exclusions)
+          Dir.glob("#{deployment_path}/**/*") - Dir.glob(exclusions.map{ |e| "#{deployment_path}/#{e}" })
         end
 
         def self.published?(file)

data/lib/capistrano/s3/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module S3
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/lib/capistrano/tasks/capistrano_2.rb

@@ -18,7 +18,7 @@ module Capistrano
         task :upload_files do
           extra_options = { :write => bucket_write_options, :redirect => redirect_options }
           S3::Publisher.publish!(s3_endpoint, access_key_id, secret_access_key,
-                             bucket, deployment_path, distribution_id, invalidations, only_gzip, extra_options)
+                             bucket, deployment_path, distribution_id, invalidations, exclusions, only_gzip, extra_options)
         end
       end
 

data/lib/capistrano/tasks/capistrano_3.rb

@@ -15,7 +15,7 @@ namespace :deploy do
     task :upload_files do
       extra_options = { :write => fetch(:bucket_write_options), :redirect => fetch(:redirect_options) }
       Capistrano::S3::Publisher.publish!(fetch(:s3_endpoint), fetch(:access_key_id), fetch(:secret_access_key),
-                             fetch(:bucket), fetch(:deployment_path), fetch(:distribution_id), fetch(:invalidations), fetch(:only_gzip), extra_options)
+                             fetch(:bucket), fetch(:deployment_path), fetch(:distribution_id), fetch(:invalidations), fetch(:exclusions), fetch(:only_gzip), extra_options)
     end
   end
 

data/spec/publisher_spec.rb

@@ -10,17 +10,62 @@ describe Capistrano::S3::Publisher do
   context "on publish!" do
     it "publish all files" do
       AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(8)
-      AWS::CloudFront::Client::V20141106.any_instance.expects(:create_invalidation).once
 
       path = File.join(@root, 'sample')
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', ['*'], false, {})
+      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], false, {})
     end
 
     it "publish only gzip files when option is enabled" do
       AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(4)
 
       path = File.join(@root, 'sample')
-      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], true, {})
+      Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], true, {})
     end
+
+    context "invalidations" do
+      it "publish all files with invalidations" do
+        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(8)
+        AWS::CloudFront::Client::V20141106.any_instance.expects(:create_invalidation).once
+
+        path = File.join(@root, 'sample')
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', ['*'], [], false, {})
+      end
+
+      it "publish all files without invalidations" do
+        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(8)
+        AWS::CloudFront::Client::V20141106.any_instance.expects(:create_invalidation).never
+
+        path = File.join(@root, 'sample')
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], [], false, {})
+      end
+    end
+
+    context "exclusions" do
+      it "exclude one files" do
+        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(7)
+
+        path = File.join(@root, 'sample')
+        exclude_paths = ['fonts/cantarell-regular-webfont.svg']
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], exclude_paths, false, {})
+      end
+
+      it "exclude multiple files" do
+        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(6)
+
+        path = File.join(@root, 'sample')
+        exclude_paths = ['fonts/cantarell-regular-webfont.svg', 'fonts/cantarell-regular-webfont.svg.gz']
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], exclude_paths, false, {})
+      end
+
+      it "exclude directory" do
+        AWS::S3::Client::V20060301.any_instance.expects(:put_object).times(0)
+
+        path = File.join(@root, 'sample')
+        exclude_paths = ['fonts/**/*']
+        Capistrano::S3::Publisher.publish!('s3.amazonaws.com', 'abc', '123', 'mybucket.amazonaws.com', path, 'cf123', [], exclude_paths, false, {})
+      end
+    end
+
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-s3
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jean-Philippe Doyle
@@ -36,7 +36,7 @@ cert_chain:
   t/JsZnAlWYkJIees2SFV5X/t34oeMu04yY2u9y2YBqKovR97m5YF7zqgx0JODV0x
   ytwUJvEjznBnJV4OoDE=
   -----END CERTIFICATE-----
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk