webpacker_uploader 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afcb36d0e425f938651b2aea9ac9e51044213196a4b962b3a40ab12f0a7d7aa0
-  data.tar.gz: 11a5794d1f92a496cbd174a6e17c6c416e31c21f7939d21f9a724ce72bf0ca2a
+  metadata.gz: 8e574118301b21c8bcf8dae3686a791d0d335554c09b16776de598418989463e
+  data.tar.gz: 65423231b058c0808aacd401720ce7345e194488a2c8add95fee100278d0c197
 SHA512:
-  metadata.gz: 0f29b023448d8b68eb5ac8029ec88a8be63a15dc0e5e960b0064b7d69fb4d5abd8d64aa236541f3fc8eb8a9378ead16e15ce74825359de2a4dbe5a69c9149ab1
-  data.tar.gz: ac84915b894fb2dc9c46f1c89c738fd31001abfb4c66f190ff3676fd58ca92a31e49eb30f6c9f7342ac5a5fbab5e89eeda91b17af7a201feb2c1b6f7f5433bf9
+  metadata.gz: dd586f4296617a0898c73f58c5c88bd68a29f58f3ffd2982472325e52c47b684bbb764afb705fb3648815b97d9a34f892d624a907447d4f94241a457944a9c63
+  data.tar.gz: c68ea8fdac8579bfb52caa4928cd0474331653cefc6c418ca242cbda2ebd70a8432603ea9cd84d432eb3443ae3759d3f6bcdb3f84cb6506f528e275df8c64ff9

data/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project will be documented in this file. The format
 
 ## [Unreleased]
 
+## [[0.3.0]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.3.0) - 2021-03-06
+
+### Added
+
+- Allow gem configuration. ([@tlatsas](https://github.com/tlatsas))
+
+### Changed
+
+- With the newly introduced configuration options, ignored file extension list is now empty by default.
+  This means that every file type will be uploaded unless otherwise specified. ([@tlatsas](https://github.com/tlatsas))
+
 ## [[0.2.1]](https://github.com/tlatsas/webpacker_uploader/releases/tag/v0.2.1) - 2021-02-09
 
 ### Added

data/Gemfile.lock

@@ -1,27 +1,27 @@
 PATH
   remote: .
   specs:
-    webpacker_uploader (0.2.1)
+    webpacker_uploader (0.3.0)
       mime-types
       webpacker (>= 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionpack (6.1.3)
+      actionview (= 6.1.3)
+      activesupport (= 6.1.3)
       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.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.3)
+      activesupport (= 6.1.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activesupport (6.1.1)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -45,14 +45,14 @@ GEM
     aws-sigv4 (1.2.2)
       aws-eventstream (~> 1, >= 1.0.2)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     erubi (1.10.0)
-    i18n (1.8.7)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
     jmespath (1.4.0)
-    loofah (2.8.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
@@ -60,7 +60,7 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2020.0512)
     minitest (5.14.2)
-    nokogiri (1.11.1-x86_64-darwin)
+    nokogiri (1.11.1)
       racc (~> 1.4)
     parallel (1.19.2)
     parser (2.7.1.4)
@@ -76,9 +76,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
+    railties (6.1.3)
+      actionpack (= 6.1.3)
+      activesupport (= 6.1.3)
       method_source
       rake (>= 0.8.7)
       thor (~> 1.0)
@@ -95,7 +95,7 @@ GEM
       rubocop (>= 0.68.0)
     ruby-progressbar (1.10.1)
     semantic_range (2.3.1)
-    thor (1.0.1)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)

data/README.md

@@ -89,18 +89,6 @@ provider_options = {
 provider = WebpackerUploader::Providers::Aws.new(provider_options)
 ```
 
-### Ignore files
-
-The uploader can be configured to skip certain files based on the file extension.
-By default `.map` files are excluded. This can be configured through the `ignored_extensions` attribute.
-In order to upload everything pass an empty array.
-
-```ruby
-# skip uploading images
-WebpackerUploader.ignored_extensions = [".png", ".jpg", ".webp"]
-WebpackerUploader.upload!(provider)
-```
-
 ### Prefix remote files
 
 Uploaded files can be prefixed by setting the `prefix` parameter during upload:
@@ -112,6 +100,42 @@ 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`.
 
+### Configuration
+
+WebpackerUploader currently supports the following configuration options:
+
+| option               | description                                                  | default value                         |
+|----------------------|--------------------------------------------------------------|---------------------------------------|
+| ignored_extensions   | Which files uploader should skip based on the file extension | []                                    |
+| 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          |
+
+It can be configured using a block:
+
+```ruby
+WebpackerUploader.configure do |config|
+  config.ignored_extensions = [".png", ".jpg", ".webp"]
+  config.log_output = false
+  config.public_manifest_path = "path/to/manifest.json"
+  config.public_path = "path/to/public/dir"
+end
+```
+
+or directly:
+
+```ruby
+WebpackerUploader.config.log_output = false
+```
+
+The uploader used to skip `.map` files by default. This has changed (see [CHANGELOG.md](https://github.com/tlatsas/webpacker_uploader/blob/main/CHANGELOG.md))
+and everything is uploaded by default now. To retain the previous functionality use:
+
+```ruby
+# skip uploading map files
+WebpackerUploader.config.ignored_extensions = [".map"]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/webpacker_uploader.rb

@@ -15,9 +15,10 @@ module WebpackerUploader
     @instance ||= WebpackerUploader::Instance.new
   end
 
-  delegate :logger, :logger=, :upload!, :ignored_extensions, :ignored_extensions=, to: :instance
+  delegate :logger, :logger=, :configure, :config, :upload!, to: :instance
 end
 
+require "webpacker_uploader/configuration"
 require "webpacker_uploader/instance"
 require "webpacker_uploader/manifest"
 require "webpacker_uploader/mime"

data/lib/webpacker_uploader/configuration.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class WebpackerUploader::Configuration
+  attr_accessor :ignored_extensions, :log_output
+  attr_reader   :public_manifest_path, :public_path
+
+  alias_method :log_output?, :log_output
+
+  def initialize
+    @ignored_extensions = []
+    @log_output = true
+    @public_manifest_path = ::Webpacker.config.public_manifest_path
+    @public_path = ::Webpacker.config.public_path
+  end
+
+  def public_manifest_path=(path)
+    @public_manifest_path = Pathname.new(path)
+  end
+
+  def public_path=(path)
+    @public_path = Pathname.new(path)
+  end
+end

data/lib/webpacker_uploader/instance.rb

@@ -2,17 +2,22 @@
 
 class WebpackerUploader::Instance
   cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
-  cattr_accessor(:ignored_extensions) { %w[.map] }
+
+  attr_writer :config
 
   def manifest
     @manifest ||= WebpackerUploader::Manifest.new
   end
 
-  def upload!(provider, prefix: nil)
-    if ignored_extensions.nil?
-      raise ArgumentError, "Ignored extensions should be specified as an array"
-    end
+  def config
+    @config ||= WebpackerUploader::Configuration.new
+  end
 
+  def configure
+    yield config
+  end
+
+  def upload!(provider, prefix: nil)
     manifest.assets.each do |name, js_path|
       path = js_path[1..-1]
 
@@ -23,13 +28,14 @@ class WebpackerUploader::Instance
           "#{prefix}/#{path}"
         end
 
-      file_path = Rails.root.join("public", path)
+      file_path = config.public_path.join(path)
 
-      if name.end_with?(*ignored_extensions)
-        logger.info("Skipping #{file_path}")
+      if name.end_with?(*config.ignored_extensions)
+        logger.info("Skipping #{file_path}") if config.log_output?
       else
         content_type = WebpackerUploader::Mime.mime_type(path)
-        logger.info("Processing #{file_path} as #{content_type}")
+
+        logger.info("Processing #{file_path} as #{content_type}") if config.log_output?
 
         provider.upload!(remote_path, file_path, content_type)
       end

data/lib/webpacker_uploader/manifest.rb

@@ -10,8 +10,8 @@ class WebpackerUploader::Manifest
   private
 
     def load
-      if ::Webpacker.config.public_manifest_path.exist?
-        JSON.parse(::Webpacker.config.public_manifest_path.read).except("entrypoints")
+      if WebpackerUploader.config.public_manifest_path.exist?
+        JSON.parse(WebpackerUploader.config.public_manifest_path.read).except("entrypoints")
       else
         {}
       end

data/lib/webpacker_uploader/version.rb

@@ -1,3 +1,3 @@
 module WebpackerUploader
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/webpacker_uploader.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |s|
 
   s.metadata = {
     "homepage_uri"    => s.homepage,
+    "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/v#{s.version}"
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker_uploader
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Tasos Latsas
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webpacker
@@ -101,6 +101,7 @@ files:
 - bin/console
 - bin/setup
 - lib/webpacker_uploader.rb
+- lib/webpacker_uploader/configuration.rb
 - lib/webpacker_uploader/instance.rb
 - lib/webpacker_uploader/manifest.rb
 - lib/webpacker_uploader/mime.rb
@@ -112,7 +113,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/tlatsas/webpacker_uploader
-  source_code_uri: https://github.com/tlatsas/webpacker_uploader/tree/v0.2.1
+  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.3.0
 post_install_message:
 rdoc_options: []
 require_paths: