minipack 0.3.1 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee2181b4e3046ef5d0bff95897d0f270f5693f611270d7a0a83fbe6b89b369af
-  data.tar.gz: e8f7dd5422f6d05fb47524cae3bf7e6c30bbdf055be7bf047358379b18d761fb
+  metadata.gz: be2ebfb0d6964abdaa84f7f95b525d69dfdc1a2c2229f5acb1f9d50951042358
+  data.tar.gz: f847d5b248c873b7d0897f46734a1ca6b2191fec5ed139b876a32fb012d6b111
 SHA512:
-  metadata.gz: 0a83558f3ee2f90469e8d7eaa9d80e2c14c55813e5b2657601e092e3c1c1249c0aa8514f93335a5a4ee8963bfbf610fff17605b0dcf3d12170d03844c284beed
-  data.tar.gz: da77a9a3b187fdc59d4ed0849349d4bb0758de7a859229993ce34e6cda3c8589bb9179e1d6ff75478371d09bb1e603f00eff7118b91e31af55bcf0d006ab91e2
+  metadata.gz: 28f87f19304affa8867ddb3a45afe4f8a273ab4156208ef87de626a2de23d671232d5ddf011149a5296bf52191a3e8dfe686dc4e337884623d9087cba0dfc323
+  data.tar.gz: f8a35530ba477d50ee25dde27761848447cada20f053730215af543291408519ff1420800c6081db039f9513ff9440505ad9ad7c96607c9b760a1c2017ee8f2f

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+# 0.3.6 / 2020-08-21
+
+## Bug fixes
+
+* Fix duplicated shared chunks issue (#38) by @thiagobrandam
+
+# 0.3.5 / 2020-03-21
+
+## Bug fixes
+
+* change name of method to fix conflict with ransack (#32) by @sadgb
+
+# 0.3.4 / 2020-01-26
+
+## Bug fixes
+
+* Add support for integrity attribute when using experimental splitChunks (#27) by @Jukejc
+
+# 0.3.3 / 2019-09-12
+
+## Enhancements:
+
+* Support manifest files that have integrity hashes in them (#24) by @HellRok
+
+## Breaking changes(internal apis only)
+
+* Return value of `Minipack::Manifest#lookup!` and `Minipack::Manifest#find`, now changed from String to `Minipack::Manifest::Entry`.
+
+# 0.3.2 / 2019-07-22
+
+## Enhancements:
+
+* Add ability to instruct minipack if CSS will be in the manifest (#22) by @jmortlock
+
 # 0.3.1 / 2019-06-06
 
 ## Bug fixes

data/README.md

@@ -4,7 +4,7 @@ Minipack, a gem for minimalists, which can integrates Rails with [webpack](https
 
 Minipack provides view helpers through a manifest, which resolve paths of assets build by a webpack configured by you as you like.
 
-**Note:** Before Minipack v0.3.0, it was called WebpackManifest. Please refer to [the migration guide](./docs/migrate_from_webpack_manifest.md') from WebpackManifest.
+**Note:** Before Minipack v0.3.0, it was called WebpackManifest. Please refer to [the migration guide](./docs/migrate_from_webpack_manifest.md) from WebpackManifest.
 
 ## Features
 
@@ -48,6 +48,9 @@ Minipack.configuration do |c|
   # Register a path to a manifest file here. Right now you have to specify an absolute path.
   c.manifest = Rails.root.join('public', 'assets', 'manifest.json')
 
+  # If you are not extracting CSS in your webpack config you should set this flag to false
+  # c.extract_css = !Rails.env.development?
+
   # The base directory for the frontend system. By default, it will be
   # `Rails.root`.
   # c.base_path = Rails.root
@@ -295,10 +298,6 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-**v0.2.x-trunk**
-
-v0.2.x-trunk is made from the latest released version v0.2.4. I will not intend to actively maintain v0.2.x anymore, except security fixes or bug fixes.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nikushi/minipack.

data/lib/minipack/configuration.rb

@@ -79,6 +79,9 @@ module Minipack
       # The command for installation of npm packages
       config_attr :pkg_install_command, default: 'npm install'
 
+      # Disable if you're webpack configuration is not extracting CSS files
+      config_attr :extract_css, default: true
+
       # Let me leave this line for remember the indea of post pkg install hooks
       # config_attr :post_install_hooks, default: []
 
@@ -164,6 +167,13 @@ module Minipack
         File.join(root_path, 'tmp', 'cache', 'minipack')
       end
 
+      # CSS is extracted in the webpack build
+      #
+      # @return [Boolean]
+      def extract_css?
+        extract_css
+      end
+
       private
 
       def root?

data/lib/minipack/helper.rb

@@ -9,7 +9,7 @@ module Minipack::Helper
   #   <%= asset_bundle_path 'icon/favicon.ico' %> # => "/assets/web/pack/icon/favicon-1016838bab065ae1e122.ico"
   def asset_bundle_path(name, manifest: nil, **options)
     manifest = get_manifest_by_key(manifest)
-    asset_path(manifest.lookup!(name.to_s), **options)
+    asset_path(manifest.lookup!(name.to_s).path, **options)
   end
 
   # Example:
@@ -20,7 +20,9 @@ module Minipack::Helper
   #   <%= javascript_bundle_tag 'orders/app'  %> # =>
   #   <script src="/assets/web/pack/orders/app-1016838bab065ae1e314.js"></script>
   def javascript_bundle_tag(*names, manifest: nil, **options)
-    javascript_include_tag(*sources_from_manifest(names, 'js', key: manifest), **options)
+    entries_from_manifest(names, 'js', key: manifest).map { |entry|
+      javascript_include_tag(entry.path, **minipack_options_for(entry, options))
+    }.join("\n").html_safe
   end
 
   # Creates script tags that references the js chunks from entrypoints when using split chunks API.
@@ -39,7 +41,9 @@ module Minipack::Helper
   # <%= javascript_bundles_with_chunks_tag 'calendar' %>
   # <%= javascript_bundles_with_chunks_tag 'map' %>
   def javascript_bundles_with_chunks_tag(*names, manifest: nil, **options)
-    javascript_include_tag(*sources_from_manifest_entrypoints(names, 'js', key: manifest), **options)
+    sources_from_manifest_entrypoints(names, 'js', key: manifest).map { |entry|
+      javascript_include_tag(entry.path, **minipack_options_for(entry, options))
+    }.join("\n").html_safe
   end
 
   # Examples:
@@ -52,7 +56,11 @@ module Minipack::Helper
   #   <link rel="stylesheet" media="screen"
   #    href="/assets/web/pack/orders/style-1016838bab065ae1e122.css" />
   def stylesheet_bundle_tag(*names, manifest: nil, **options)
-    stylesheet_link_tag(*sources_from_manifest(names, 'css', key: manifest), **options)
+    if Minipack.configuration.extract_css?
+      entries_from_manifest(names, 'css', key: manifest).map { |entry|
+        stylesheet_link_tag(entry.path, **minipack_options_for(entry, options))
+      }.join("\n").html_safe
+    end
   end
 
   # Creates link tags that references the css chunks from entrypoints when using split chunks API.
@@ -69,7 +77,11 @@ module Minipack::Helper
   # <%= stylesheet_bundles_with_chunks_tag 'calendar' %>
   # <%= stylesheet_bundles_with_chunks_tag 'map' %>
   def stylesheet_bundles_with_chunks_tag(*names, manifest: nil, **options)
-    stylesheet_link_tag(*sources_from_manifest_entrypoints(names, 'css', key: manifest), **options)
+    if Minipack.configuration.extract_css?
+      sources_from_manifest_entrypoints(names, 'css', key: manifest).map { |entry|
+        stylesheet_link_tag(entry.path, **minipack_options_for(entry, options))
+      }.join("\n").html_safe
+    end
   end
 
   # Examples:
@@ -81,23 +93,30 @@ module Minipack::Helper
   #   <img src="/assets/pack/icon-1016838bab065ae1e314.png" width="16" height="10" alt="Edit Entry" />
   def image_bundle_tag(name, manifest: nil, **options)
     manifest = get_manifest_by_key(manifest)
-    image_tag(manifest.lookup!(name.to_s), **options)
+    image_tag(manifest.lookup!(name.to_s).path, **options)
   end
 
   private
 
-  def sources_from_manifest(names, ext, key: nil)
+  def entries_from_manifest(names, ext, key: nil)
     manifest = get_manifest_by_key(key)
     names.map { |name| manifest.lookup!(name.to_s + '.' + ext) }
   end
 
   def sources_from_manifest_entrypoints(names, type, key: nil)
     manifest = get_manifest_by_key(key)
-    names.map { |name| manifest.lookup_pack_with_chunks!(name, type: type) }.flatten.uniq
+    names.map { |name| manifest.lookup_pack_with_chunks!(name, type: type).entries }.flatten.uniq(&:path)
   end
 
   def get_manifest_by_key(key = nil)
     repository = Minipack.configuration.manifests
     key.nil? ? repository.default : repository.get(key)
   end
+
+  # @param [Minipack::Manifest::Entry] entry
+  # @param [Hash] options
+  def minipack_options_for(entry, options)
+    return options unless entry.integrity
+    options.merge(integrity: entry.integrity)
+  end
 end

data/lib/minipack/manifest.rb

@@ -6,6 +6,36 @@ require 'uri'
 
 module Minipack
   class Manifest
+    # A class that represents a single entry in a manifest
+    class Entry
+      attr_reader :path, :integrity
+
+      # @param [String] path single path of a single entry
+      # @param [String,nil] integrity optional value for subresource integrity of script tags
+      def initialize(path, integrity: nil)
+        @path = path
+        @integrity = integrity
+      end
+
+      def ==(other)
+        @path == other.path && @integrity == other.integrity
+      end
+    end
+
+    # A class that represents a group of chunked entries in a manifest
+    class ChunkGroup
+      attr_reader :entries
+
+      # @param [Array<Minipack::Manifest::Entry>] entries paths of chunked group
+      def initialize(entries)
+        @entries = Array(entries).map { |entry| entry.is_a?(String) ? Entry.new(entry) : entry }
+      end
+
+      def ==(other)
+        @entries == other.entries
+      end
+    end
+
     class MissingEntryError < StandardError; end
     class FileNotFoundError < StandardError; end
 
@@ -20,15 +50,30 @@ module Minipack
     def lookup_pack_with_chunks!(name, type: nil)
       manifest_pack_type = manifest_type(name, type)
       manifest_pack_name = manifest_name(name, manifest_pack_type)
-      find('entrypoints')&.dig(manifest_pack_name, manifest_pack_type) || handle_missing_entry(name)
+      paths = data['entrypoints']&.dig(manifest_pack_name, manifest_pack_type) || handle_missing_entry(name)
+
+      entries = data['entrypoints']&.dig(manifest_pack_name, manifest_pack_type).map do |source|
+        entry_from_source(source) || handle_missing_entry(name)
+      end
+
+      ChunkGroup.new(entries)
     end
 
     def lookup!(name)
       find(name) || handle_missing_entry(name)
     end
 
+    # Find an entry by it's name
+    #
+    # @param [Symbol] name entry name
+    # @return [Minipack::Entry]
     def find(name)
-      data[name.to_s]
+      path = data[name.to_s] || return
+      if path.is_a? Hash
+        integrity = path['integrity']
+        path = path['src']
+      end
+      Entry.new(path, integrity: integrity)
     end
 
     def assets
@@ -82,5 +127,16 @@ module Minipack
         #{JSON.pretty_generate(@data)}
       MSG
     end
+
+    # Find an entry by its source
+    #
+    # @param [String] source
+    # @return [Minipack::Entry,nil]
+    def entry_from_source(source)
+      entry = assets.find { |entry| entry.is_a?(String) ? entry == source : entry['src'] == source }
+      return unless entry
+      entry.is_a?(String) ? Entry.new(entry) : Entry.new(entry['src'], integrity: entry['integrity'])
+    end
   end
 end
+

data/lib/minipack/manifest_repository.rb

@@ -17,7 +17,7 @@ module Minipack
 
       # @private
       def add(key, path, **options)
-        manifest = Minipack::Manifest.new(path, options)
+        manifest = Minipack::Manifest.new(path, **options)
         # Mark a first one as a default
         @default = manifest if @manifests.empty?
         @manifests[key.to_sym] = manifest

data/lib/minipack/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Minipack
-  VERSION = "0.3.1"
+  VERSION = "0.3.6"
 end

data/minipack.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionview'
   spec.add_dependency "railties", ">= 4.2"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minipack
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.6
 platform: ruby
 authors:
 - Nobuhiro Nikushi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-06 00:00:00.000000000 Z
+date: 2020-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement