webpacker_uploader 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1f1e410b9ed124323d818d4b436581aecd735717f47176bf9754091209e608d
-  data.tar.gz: e8732c0cab079cf51864b1addd8a3e8d94c1487fa371872213f5343f2473de03
+  metadata.gz: 96198a1aa60035fa87959114f6dde6550671c8dfed6c308e2edf96baf9645376
+  data.tar.gz: f1d88a52f9f75e7f044deccbbb7c923141eecfbc421dabc48ff3ac578b73795c
 SHA512:
-  metadata.gz: 0c52c1f98939ca6338579e23fbe186fadfa1b22204bf62ceaffdb3ec4e2387c2f0763330a0db7cfcbc898e7a77035719749458b5828a0d5b7ba3b3b78ecde8e0
-  data.tar.gz: 2dde591f7f50548ad64a14f401b325aa3a4e83566c78463602406a458d6d6bc331843ab188fd7142c8be616722671574bf43ec36d0d0dcc9155f9253bdc61c84
+  metadata.gz: 7fe1589c9e7b36aaacf0a582aa94f057ddd48b05ba20fca373bb8430a621edeaeb69e64b82831e2a621a6fe3729a3a49514fad40dba351cb005ff7f928d56f62
+  data.tar.gz: cb7127ff364dee3a702e36b4fce6a9a371f5dea1af50bfe3cbfd9844fe3d61778d0ebef9c14b4d0561930bbdaf75bba5e76055f16acbff35c9958a72ec6b50fc

data/.rubocop.yml

@@ -3,7 +3,7 @@ require:
   - rubocop-minitest
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [[0.7.1]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.7.1) - 2023-01-05
+
+### Changed
+
+- Bump dependencies
+
+## [[0.7.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.7.0) - 2021-11-27
+
+### Added
+
+- Support setting Cache-Control on uploaded files. ([#16](https://github.com/tlatsas/webpacker_uploader/pull/16), [@Dimitris24sta23](https://github.com/Dimitris24sta23))
+
 ## [[0.6.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.6.0) - 2021-07-20
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    webpacker_uploader (0.6.0)
+    webpacker_uploader (0.7.1)
+      activesupport (< 7.0)
       mime-types
       rack (~> 2.0)
       webpacker (>= 5.1)
@@ -9,84 +10,84 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.4)
-      actionview (= 6.1.4)
-      activesupport (= 6.1.4)
+    actionpack (6.1.7)
+      actionview (= 6.1.7)
+      activesupport (= 6.1.7)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.4)
-      activesupport (= 6.1.4)
+    actionview (6.1.7)
+      activesupport (= 6.1.7)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.4)
+    activesupport (6.1.7)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    aws-eventstream (1.1.1)
-    aws-partitions (1.477.0)
-    aws-sdk-core (3.117.0)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.586.0)
+    aws-sdk-core (3.130.2)
       aws-eventstream (~> 1, >= 1.0.2)
-      aws-partitions (~> 1, >= 1.239.0)
+      aws-partitions (~> 1, >= 1.525.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.44.0)
-      aws-sdk-core (~> 3, >= 3.112.0)
+    aws-sdk-kms (1.56.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.96.1)
-      aws-sdk-core (~> 3, >= 3.112.0)
+    aws-sdk-s3 (1.114.0)
+      aws-sdk-core (~> 3, >= 3.127.0)
       aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.4)
+      aws-sigv4 (~> 1.4)
+    aws-sigv4 (1.5.0)
       aws-eventstream (~> 1, >= 1.0.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
-    erubi (1.10.0)
-    i18n (1.8.10)
+    erubi (1.12.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    jmespath (1.4.0)
-    loofah (2.10.0)
+    jmespath (1.6.1)
+    loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0704)
-    mini_portile2 (2.5.3)
-    minitest (5.14.2)
-    nokogiri (1.11.7)
-      mini_portile2 (~> 2.5.0)
+    mime-types-data (3.2022.0105)
+    mini_portile2 (2.8.1)
+    minitest (5.15.0)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    racc (1.5.2)
-    rack (2.2.3)
-    rack-proxy (0.7.0)
+    racc (1.6.2)
+    rack (2.2.5)
+    rack-proxy (0.7.4)
       rack
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack-test (2.0.2)
+      rack (>= 1.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
-      loofah (~> 2.3)
-    railties (6.1.4)
-      actionpack (= 6.1.4)
-      activesupport (= 6.1.4)
+    rails-html-sanitizer (1.4.4)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (6.1.7)
+      actionpack (= 6.1.7)
+      activesupport (= 6.1.7)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (2.1.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.3.1)
     rexml (3.2.5)
     rubocop (1.11.0)
       parallel (~> 1.10)
@@ -97,26 +98,28 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-minitest (0.10.3)
-      rubocop (>= 0.87, < 2.0)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.19.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
     semantic_range (3.0.0)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+    thor (1.2.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    webpacker (5.4.0)
+    unicode-display_width (2.1.0)
+    webpacker (5.4.3)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)
       semantic_range (>= 2.3.0)
-    yard (0.9.26)
-    zeitwerk (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
@@ -133,4 +136,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   2.1.4
+   2.3.3

data/README.md

@@ -1,7 +1,7 @@
 # WebpackerUploader
 
-[![Ruby tests](https://img.shields.io/github/workflow/status/tlatsas/webpacker_uploader/Ruby%20tests?style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
-[![RuboCop](https://img.shields.io/github/workflow/status/tlatsas/webpacker_uploader/RuboCop?label=rubocop&style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
+[![Ruby tests](https://img.shields.io/github/actions/workflow/status/tlatsas/webpacker_uploader/ruby.yml?style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
+[![RuboCop](https://img.shields.io/github/actions/workflow/status/tlatsas/webpacker_uploader/rubocop.yml?label=rubocop&style=flat-square)](https://github.com/tlatsas/webpacker_uploader/actions)
 [![Gem](https://img.shields.io/gem/v/webpacker_uploader?style=flat-square)](https://rubygems.org/gems/webpacker_uploader)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg?style=flat-square)](https://www.rubydoc.info/gems/webpacker_uploader)
 
@@ -21,11 +21,15 @@ gem "webpacker_uploader", require: false
 
 and run:
 
-    $ bundle install
+```sh
+bundle install
+```
 
 or:
 
-    $ gem install webpacker_uploader
+```sh
+gem install webpacker_uploader
+```
 
 To use the aws provider install the aws-sdk-s3 gem. Add in your Gemfile:
 
@@ -103,12 +107,24 @@ WebpackerUploader.upload!(provider, prefix: "assets")
 This will prefix all remote file paths with `assets` so instead of storing `packs/application-dd6b1cd38bfa093df600.css` it
 will store `assets/packs/application-dd6b1cd38bfa093df600.css`.
 
+### Add a cache-control directive to remote files
+
+```ruby
+WebpackerUploader.upload!(provider, cache_control: "public, max-age=3600")
+```
+
+This option is used to specify caching behavior along the request/reply chain.
+
+```text
+⚠️ This option is applied to all uploaded files, not on a per-file basis.
+```
+
 ### Configuration
 
 WebpackerUploader currently supports the following configuration options:
 
 | option               | description                                                  | default value                         |
-|----------------------|--------------------------------------------------------------|---------------------------------------|
+| -------------------- | ------------------------------------------------------------ | ------------------------------------- |
 | ignored_extensions   | Which files uploader should skip based on the file extension | []                                    |
 | logger               | The logger to use for logging                                | ActiveSupport::Logger.new(STDOUT)     |
 | log_output           | Log output as we upload files                                | true                                  |
@@ -159,7 +175,7 @@ docker compose -f "integration/docker-compose.yml" up --detach
 
 To run the tests, use `rake test:integration`.
 
-To stop the container once done run: `docker-compose -f "integration/docker-compose.yml" down` 
+To stop the container once done run: `docker-compose -f "integration/docker-compose.yml" down`
 
 ## Contributing
 

data/lib/webpacker_uploader/instance.rb

@@ -45,7 +45,8 @@ class WebpackerUploader::Instance
   # @return [void]
   # @param provider [WebpackerUploader::Providers::Aws] A provider to use for file uploading.
   # @param prefix [String] Used to prefix the remote file paths.
-  def upload!(provider, prefix: nil)
+  # @param cache_control [String] Used to add cache-control header to files.
+  def upload!(provider, prefix: nil, cache_control: nil)
     manifest.assets.each do |name, js_path|
       path = js_path[1..-1]
 
@@ -65,7 +66,7 @@ class WebpackerUploader::Instance
 
         config.logger.info("Processing #{file_path} as #{content_type}") if config.log_output?
 
-        provider.upload!(remote_path, file_path, content_type)
+        provider.upload!(remote_path, file_path, content_type, cache_control)
       end
     end
   end

data/lib/webpacker_uploader/providers/aws.rb

@@ -64,9 +64,9 @@ module WebpackerUploader
       # @param file [Pathname] Path of the local file.
       # @param content_type [String] The content type that will be set to the S3 object.
       # @return [void]
-      def upload!(object_key, file, content_type = "")
+      def upload!(object_key, file, content_type = "", cache_control = "")
         object = @resource.bucket(@bucket_name).object(object_key)
-        object.upload_file(file, content_type: content_type)
+        object.upload_file(file, content_type: content_type, cache_control: cache_control)
       end
 
       private

data/lib/webpacker_uploader/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebpackerUploader
-  VERSION = "0.6.0"
+  VERSION = "0.7.1"
 end

data/test/test_helper.rb

@@ -21,8 +21,8 @@ module WebpackerUploader::Providers
       @asset_objects = asset_objects
     end
 
-    def upload!(object_key, file, content_type = "")
-      @asset_objects << { object_key: object_key, file: file, content_type: content_type }
+    def upload!(object_key, file, content_type = "", cache_control = "")
+      @asset_objects << { object_key: object_key, file: file, content_type: content_type, cache_control: cache_control }
     end
   end
 end

data/test/webpacker_uploader_test.rb

@@ -29,4 +29,9 @@ class WebpackerUploaderTest < Minitest::Test
     assert_instance_of Pathname, @asset_objects.first[:file]
     assert_equal "text/css", @asset_objects.first[:content_type]
   end
+
+  def test_upload_with_cache_control
+    WebpackerUploader.upload!(@provider, cache_control: "cache_control")
+    assert_equal "cache_control", @asset_objects.first[:cache_control]
+  end
 end

data/webpacker_uploader.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.homepage      = "https://github.com/tlatsas/webpacker_uploader"
   s.license       = "MIT"
 
-  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
 
   s.metadata = {
     "homepage_uri"    => s.homepage,
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "webpacker", ">= 5.1"
+  s.add_dependency "activesupport", "< 7.0"
   s.add_dependency "mime-types"
   s.add_dependency "rack", "~> 2.0"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker_uploader
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Tasos Latsas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +162,7 @@ metadata:
   homepage_uri: https://github.com/tlatsas/webpacker_uploader
   bug_tracker_uri: https://github.com/tlatsas/webpacker_uploader/issues
   changelog_uri: https://github.com/tlatsas/webpacker_uploader/blob/main/CHANGELOG.md
-  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.6.0
+  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.7.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -157,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="