webpacker_uploader 0.3.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e574118301b21c8bcf8dae3686a791d0d335554c09b16776de598418989463e
-  data.tar.gz: 65423231b058c0808aacd401720ce7345e194488a2c8add95fee100278d0c197
+  metadata.gz: 0c6cbb5cf694108a74e0cf8bb306acf9adca3ccedfef971a30c33503e7ccc1a1
+  data.tar.gz: 542dd824922fb799670706955b354564f17a467b2e4cb5a5860d4380f4b5ee1a
 SHA512:
-  metadata.gz: dd586f4296617a0898c73f58c5c88bd68a29f58f3ffd2982472325e52c47b684bbb764afb705fb3648815b97d9a34f892d624a907447d4f94241a457944a9c63
-  data.tar.gz: c68ea8fdac8579bfb52caa4928cd0474331653cefc6c418ca242cbda2ebd70a8432603ea9cd84d432eb3443ae3759d3f6bcdb3f84cb6506f528e275df8c64ff9
+  metadata.gz: 96aba1a007135c90161ad63baeec1d2a3ea7e6aec85561d7e6e6919c614e00bb7c6252afd9e31f8263a2d121646c42e63eb3de26d79b789e0b9ccde1bd0a2c35
+  data.tar.gz: 522bb686c11ce429880befc7015b106f1230264aedde757e8ce7b47dd015485fbab45b71d69712cbe5c75488229c684dc3175ca9137f1ad60c795f5be04c4448

data/.gitignore

@@ -9,3 +9,4 @@
 .ruby-version
 *.gem
 /test/test_app/log/
+/integration/dummy/log/

data/.rubocop.yml

@@ -1,20 +1,18 @@
-require: rubocop-performance
+require:
+  - rubocop-performance
+  - rubocop-minitest
 
 AllCops:
   TargetRubyVersion: 2.5
   # 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
+  SuggestExtensions: false
 
 # Prefer &&/|| over and/or.
 Style/AndOr:
   Enabled: true
 
-# Do not use braces for hash literals when they are the last argument of a
-# method call.
-Style/BracesAroundHashParameters:
-  Enabled: true
-
 # Align `when` with `case`.
 Layout/CaseIndentation:
   Enabled: true
@@ -47,7 +45,7 @@ Style/HashSyntax:
 # extra level of indentation.
 Layout/IndentationConsistency:
   Enabled: true
-  EnforcedStyle: rails
+  EnforcedStyle: indented_internal_methods
 
 # Two spaces, no tabs (for indentation).
 Layout/IndentationWidth:
@@ -96,11 +94,11 @@ Style/StringLiterals:
   EnforcedStyle: double_quotes
 
 # Detect hard tabs, no hard tabs.
-Layout/Tab:
+Layout/IndentationStyle:
   Enabled: true
 
 # Blank lines should not have any spaces.
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 # No trailing whitespace.
@@ -108,7 +106,7 @@ Layout/TrailingWhitespace:
   Enabled: true
 
 # Use quotes for string literals when they are enough.
-Style/UnneededPercentQ:
+Style/RedundantPercentQ:
   Enabled: true
 
 # Align `end` with the matching keyword or starting expression except for
@@ -120,3 +118,192 @@ Layout/EndAlignment:
 # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
 Lint/RequireParentheses:
   Enabled: true
+
+Minitest/AssertEmpty:
+  Enabled: true
+
+Minitest/AssertEmptyLiteral:
+  Enabled: true
+
+Minitest/AssertEqual:
+  Enabled: true
+
+Minitest/AssertionInLifecycleHook:
+  Enabled: true
+
+Minitest/AssertMatch:
+  Enabled: true
+
+Minitest/AssertIncludes:
+  Enabled: true
+
+Minitest/AssertInstanceOf:
+  Enabled: true
+
+Minitest/AssertKindOf:
+  Enabled: true
+
+Minitest/AssertNil:
+  Enabled: true
+
+Minitest/AssertOutput:
+  Enabled: true
+
+Minitest/AssertPathExists:
+  Enabled: true
+
+Minitest/AssertRespondTo:
+  Enabled: true
+
+Minitest/AssertSilent:
+  Enabled: true
+
+Minitest/AssertTruthy:
+  Enabled: true
+
+Minitest/GlobalExpectations:
+  Enabled: true
+
+Minitest/LiteralAsActualArgument:
+  Enabled: true
+
+Minitest/RefuteEmpty:
+  Enabled: true
+
+Minitest/RefuteEqual:
+  Enabled: true
+
+Minitest/RefuteFalse:
+  Enabled: true
+
+Minitest/RefuteIncludes:
+  Enabled: true
+
+Minitest/RefuteMatch:
+  Enabled: true
+
+Minitest/RefuteInstanceOf:
+  Enabled: true
+
+Minitest/RefuteKindOf:
+  Enabled: true
+
+Minitest/RefuteNil:
+  Enabled: true
+
+Minitest/RefutePathExists:
+  Enabled: true
+
+Minitest/RefuteRespondTo:
+  Enabled: true
+
+Minitest/TestMethodName:
+  Enabled: true
+
+Minitest/UnspecifiedException:
+  Enabled: true
+
+# Use `bind_call(obj, args, ...)` instead of `bind(obj).call(args, ...)`.
+Performance/BindCall:
+  Enabled: true
+
+# Use `caller(n..n)` instead of `caller`.
+Performance/Caller:
+  Enabled: true
+
+# Use `casecmp` for case comparison.
+Performance/Casecmp:
+  Enabled: true
+
+# Extract Array and Hash literals outside of loops into local variables or constants.
+Performance/CollectionLiteralInLoop:
+  Enabled: true
+
+# Prefer `sort_by(&:foo)` instead of `sort { |a, b| a.foo <=> b.foo }`.
+Performance/CompareWithBlock:
+  Enabled: true
+
+# Use `count` instead of `{select,find_all,filter,reject}...{size,count,length}`.
+Performance/Count:
+  Enabled: true
+
+# Use `delete_prefix` instead of `gsub`.
+Performance/DeletePrefix:
+  Enabled: true
+
+# Use `delete_suffix` instead of `gsub`.
+Performance/DeleteSuffix:
+  Enabled: true
+
+# Use `detect` instead of `select.first`, `find_all.first`, `filter.first`, `select.last`, `find_all.last`, and `filter.last`.
+Performance/Detect:
+  Enabled: true
+
+# Use `str.{start,end}_with?(x, ..., y, ...)` instead of `str.{start,end}_with?(x, ...) || str.{start,end}_with?(y, ...)`.
+Performance/DoubleStartEndWith:
+  Enabled: true
+
+# Use `end_with?` instead of a regex match anchored to the end of a string.
+Performance/EndWith:
+  Enabled: true
+
+# Do not compute the size of statically sized objects except in constants.
+Performance/FixedSize:
+  Enabled: true
+
+# Use `Enumerable#flat_map` instead of `Enumerable#map...Array#flatten(1).
+Performance/FlatMap:
+  Enabled: true
+
+# Use `key?` or `value?` instead of `keys.include?` or `values.include?`.
+Performance/InefficientHashSearch:
+  Enabled: true
+
+# Use `Range#cover?` instead of `Range#include?` (or `Range#member?`).
+Performance/RangeInclude:
+  Enabled: true
+
+# Use `yield` instead of `block.call`.
+Performance/RedundantBlockCall:
+  Enabled: true
+
+# Use `=~` instead of `String#match` or `Regexp#match` in a context where the returned `MatchData` is not needed.
+Performance/RedundantMatch:
+  Enabled: true
+
+# Use Hash#[]=, rather than Hash#merge! with a single key-value pair.
+Performance/RedundantMerge:
+  Enabled: true
+
+# Use `match?` instead of `Regexp#match`, `String#match`, `Symbol#match`, `Regexp#===`, or `=~` when `MatchData` is not used.
+Performance/RegexpMatch:
+  Enabled: true
+
+# Use `reverse_each` instead of `reverse.each`.
+Performance/ReverseEach:
+  Enabled: true
+
+# Use `size` instead of `count` for counting the number of elements in `Array` and `Hash`.
+Performance/Size:
+  Enabled: true
+
+# Use `start_with?` instead of a regex match anchored to the beginning of a string.
+Performance/StartWith:
+  Enabled: true
+
+# Use `tr` instead of `gsub` when you are replacing the same number of characters.
+# Use `delete` instead of `gsub` when you are deleting characters.
+Performance/StringReplacement:
+  Enabled: true
+
+# Checks for .times.map calls.
+Performance/TimesMap:
+  Enabled: true
+
+# Use unary plus to get an unfrozen string literal.
+Performance/UnfreezeString:
+  Enabled: true
+
+# Use `URI::DEFAULT_PARSER` instead of `URI::Parser.new`.
+Performance/UriDefaultParser:
+  Enabled: true

data/.yardopts

@@ -0,0 +1,8 @@
+--title "WebpackerUploader Documentation"
+--readme README.md
+--markup markdown
+--hide-void-return
+--no-private
+-
+CHANGELOG.md
+MIT-LICENSE

data/CHANGELOG.md

@@ -4,6 +4,35 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [[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
+
+- Allow passing arbitrary options to the AWS S3 Client through the AWS provider. ([#11](https://github.com/tlatsas/webpacker_uploader/pull/11), [@tlatsas](https://github.com/tlatsas))
+
+### Fixed
+
+- Fix undefined method delegate for WebpackerUploader:Module when using the console script. ([#13](https://github.com/tlatsas/webpacker_uploader/pull/13), [@tlatsas](https://github.com/tlatsas))
+
+## [[0.5.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.5.0) - 2021-07-12
+
+### Fixed
+
+- Change the way we pass the named profile option in the AWS provider. This allows the full resolution of credentials implemented
+  in Aws::CredentialProviderChain to work for all kinds of role assumptions, profile extensions, etc. ([#10](https://github.com/tlatsas/webpacker_uploader/pull/10), [@eirc](https://github.com/eirc))
+
+## [[0.4.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.4.0) - 2021-05-25
+
+### Changed
+
+- Logger is now part of the configuration object instead of a class attribute. ([#9](https://github.com/tlatsas/webpacker_uploader/pull/9), [@tlatsas](https://github.com/tlatsas))
+
 ## [[0.3.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.3.0) - 2021-03-06
 
 ### Added

data/Gemfile

@@ -4,6 +4,7 @@ gemspec
 
 gem "rake", ">= 11.1"
 gem "aws-sdk-s3"
+gem "yard", "~> 0.9"
 
 group :test do
   gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -1,109 +1,121 @@
 PATH
   remote: .
   specs:
-    webpacker_uploader (0.3.0)
+    webpacker_uploader (0.7.0)
       mime-types
+      rack (~> 2.0)
       webpacker (>= 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.3)
-      actionview (= 6.1.3)
-      activesupport (= 6.1.3)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       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.3)
-      activesupport (= 6.1.3)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.3)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
-    aws-eventstream (1.1.0)
-    aws-partitions (1.376.0)
-    aws-sdk-core (3.108.0)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.507.0)
+    aws-sdk-core (3.121.1)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-kms (1.38.0)
-      aws-sdk-core (~> 3, >= 3.99.0)
+    aws-sdk-kms (1.48.0)
+      aws-sdk-core (~> 3, >= 3.120.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.81.1)
-      aws-sdk-core (~> 3, >= 3.104.3)
+    aws-sdk-s3 (1.103.0)
+      aws-sdk-core (~> 3, >= 3.120.0)
       aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.2.2)
+      aws-sigv4 (~> 1.4)
+    aws-sigv4 (1.4.0)
       aws-eventstream (~> 1, >= 1.0.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    i18n (1.8.9)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
     jmespath (1.4.0)
-    loofah (2.9.0)
+    loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2020.0512)
-    minitest (5.14.2)
-    nokogiri (1.11.1)
+    mime-types-data (3.2021.0901)
+    mini_portile2 (2.6.1)
+    minitest (5.14.4)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     racc (1.5.2)
     rack (2.2.3)
-    rack-proxy (0.6.5)
+    rack-proxy (0.7.0)
       rack
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
-    rubocop (0.68.1)
-      jaro_winkler (~> 1.5.1)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.11.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    rubocop-performance (1.3.0)
-      rubocop (>= 0.68.0)
-    ruby-progressbar (1.10.1)
-    semantic_range (2.3.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.11.5)
+      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)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.5.0)
-    webpacker (5.2.1)
+    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)
 
 PLATFORMS
@@ -114,9 +126,11 @@ DEPENDENCIES
   bundler (>= 1.3.0)
   minitest (~> 5.0)
   rake (>= 11.1)
-  rubocop (< 0.69)
+  rubocop (= 1.11.0)
+  rubocop-minitest
   rubocop-performance
   webpacker_uploader!
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -3,6 +3,7 @@
 [![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)
 [![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)
 
 Webpacker uploader provides an easy way to upload your assets to AWS S3.
 It knows which files to upload by reading the `manifest.json` file.
@@ -15,16 +16,20 @@ S3 + CDN, outside of your Rails application.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "webpacker_uploader"
+gem "webpacker_uploader", require: false
 ```
 
-And then execute:
+and run:
 
-    $ bundle install
+```sh
+bundle install
+```
 
-Or install it yourself as:
+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:
 
@@ -34,6 +39,8 @@ gem "aws-sdk-s3", require: false
 
 ## Usage
 
+Usually, in a Rake task you would add the following to upload the assets to AWS S3:
+
 ```ruby
 require "webpacker_uploader"
 require "webpacker_uploader/providers/aws"
@@ -100,6 +107,18 @@ 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:
@@ -107,6 +126,7 @@ 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                                  |
 | public_manifest_path | The webpack manifest path                                    | Webpacker.config.public_manifest_path |
 | public_path          | The webpack public output path                               | Webpacker.config.public_path          |
@@ -144,6 +164,19 @@ interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+## Integration tests
+
+This gem also provides an integration test suite. It runs using [localstack](https://github.com/localstack/localstack/).
+To run the integration tests, install docker on your system and spin up a localstack container running the s3 service.
+
+```shell
+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` 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/tlatsas/webpacker_uploader.

data/Rakefile

@@ -1,10 +1,23 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+require "yard"
+YARD::Rake::YardocTask.new
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+namespace :test do
+  desc "Run integration tests using localstack"
+  Rake::TestTask.new(:integration) do |t|
+    t.libs << "integration"
+    t.test_files = FileList["integration/**/*_test.rb"]
+  end
+end
+
 task default: :test

data/lib/webpacker_uploader/configuration.rb

@@ -1,13 +1,33 @@
 # frozen_string_literal: true
 
+require "active_support/logger"
+require "active_support/tagged_logging"
+
+# This is the class which holds the configuration options.
+#
+# Options are set and retrieved using `WebpackerUploader.config`
+# and `WebpackerUploader.configure`.
 class WebpackerUploader::Configuration
-  attr_accessor :ignored_extensions, :log_output
-  attr_reader   :public_manifest_path, :public_path
+  # @return [Array] the file extentions ignored by the uploader.
+  attr_accessor :ignored_extensions
+
+  # @return [ActiveSupport::Logger] the logger to use.
+  attr_accessor :logger
+
+  # @return [Boolean] whether or not to log operations.
+  attr_accessor :log_output
+
+  # @return [Pathname] the path to manifest.json, defaults to Webpacker public manifest path.
+  attr_reader :public_manifest_path
+
+  # @return [Pathname] the public root path, defaults to Webpacker public root path.
+  attr_reader :public_path
 
   alias_method :log_output?, :log_output
 
   def initialize
     @ignored_extensions = []
+    @logger = ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT))
     @log_output = true
     @public_manifest_path = ::Webpacker.config.public_manifest_path
     @public_path = ::Webpacker.config.public_path