Merge pull request #2442 from grantbdev/gb/list-terminology-option

Provide public interface alternatives to whitelist/blacklist terminology

lib/carrierwave/uploader/content_type_blacklist.rb

@@ -28,7 +28,11 @@ module ContentTypeBlacklist
       #       [/(text|application)\/json/]
       #     end
       #
-      def content_type_blacklist; end
+      def content_type_blacklist
+        content_type_blocklist
+      end
+
+      def content_type_blocklist; end
 
     private
 

lib/carrierwave/uploader/content_type_whitelist.rb

@@ -7,6 +7,8 @@ module ContentTypeWhitelist
         before :cache, :check_content_type_whitelist!
       end
 
+      def content_type_allowlist; end
+
       ##
       # Override this method in your uploader to provide a whitelist of files content types
       # which are allowed to be uploaded.
@@ -28,7 +30,9 @@ module ContentTypeWhitelist
       #       [/(text|application)\/json/]
       #     end
       #
-      def content_type_whitelist; end
+      def content_type_whitelist
+        content_type_allowlist
+      end
 
     private
 

lib/carrierwave/uploader/extension_blacklist.rb

@@ -32,7 +32,11 @@ module ExtensionBlacklist
       #     end
       #
 
-      def extension_blacklist; end
+      def extension_blacklist
+        extension_blocklist
+      end
+
+      def extension_blocklist; end
 
     private
 

lib/carrierwave/uploader/extension_whitelist.rb

@@ -7,6 +7,8 @@ module ExtensionWhitelist
         before :cache, :check_extension_whitelist!
       end
 
+      def extension_allowlist; end
+
       ##
       # Override this method in your uploader to provide a white list of extensions which
       # are allowed to be uploaded. Compares the file's extension case insensitive.
@@ -31,7 +33,9 @@ module ExtensionWhitelist
       #       [/jpe?g/, 'gif', 'png']
       #     end
       #
-      def extension_whitelist; end
+      def extension_whitelist
+        extension_allowlist
+      end
 
     private
 

spec/uploader/content_type_blacklist_spec.rb

@@ -36,6 +36,12 @@
           expect { uploader.cache!(ruby_file) }.to raise_error(CarrierWave::IntegrityError)
         end
 
+        it "raises an integrity error if the file has a blocklisted content type" do
+          allow(uploader).to receive(:content_type_blocklist).and_return(['image/png'])
+
+          expect { uploader.cache!(ruby_file) }.to raise_error(CarrierWave::IntegrityError)
+        end
+
         it "accepts content types as regular expressions" do
           allow(uploader).to receive(:content_type_blacklist).and_return([/image\//])
 

spec/uploader/content_type_whitelist_spec.rb

@@ -49,6 +49,12 @@
           expect { uploader.cache!(bork_file) }.to raise_error(CarrierWave::IntegrityError)
         end
 
+        it "raises an integrity error the file has not an allowlisted content type" do
+          allow(uploader).to receive(:content_type_allowlist).and_return(['image/gif'])
+
+          expect { uploader.cache!(bork_file) }.to raise_error(CarrierWave::IntegrityError)
+        end
+
         it "accepts content types as regular expressions" do
           allow(uploader).to receive(:content_type_whitelist).and_return([/image\//])
 

spec/uploader/extension_blacklist_spec.rb

@@ -14,7 +14,7 @@
   before { allow(CarrierWave).to receive(:generate_cache_id).and_return(cache_id) }
 
   describe '#cache!' do
-    before { allow(uploader).to receive(:extension_blacklist).and_return(extension_blacklist) }
+    before { allow(uploader).to receive(:extension_blocklist).and_return(extension_blacklist) }
 
     context "when there are no blacklisted extensions" do
       let(:extension_blacklist) { nil }

spec/uploader/extension_whitelist_spec.rb

@@ -43,6 +43,14 @@
           }).to raise_error(CarrierWave::IntegrityError)
         end
 
+        it "raises an integrity error if the file has not an allowlisted extension" do
+          allow(@uploader).to receive(:extension_allowlist).and_return(%w(txt doc xls))
+
+          expect(running {
+            @uploader.cache!(File.open(file_path('test.jpg')))
+          }).to raise_error(CarrierWave::IntegrityError)
+        end
+
         it "raises an integrity error if the file has not a whitelisted extension, using start of string matcher" do
           allow(@uploader).to receive(:extension_whitelist).and_return(%w(txt))