manifester 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2245e87b983a5959438ada67d8918ee9676594a83f696f7334e390560cc06d1
-  data.tar.gz: b16152e7230c6724889e55e25f55227f1ab870fadbf5ba76721afed39f4a52f4
+  metadata.gz: 0f56198d24089e1e07ceefeb6d32815b16cb9fd4af486f35115ad723cb79da23
+  data.tar.gz: 5e5da6d15231011463c71fd74f5c10ad64f98c582a73a19010f8c8d8bee176e7
 SHA512:
-  metadata.gz: 79b6e43a6bd6d4b8cfa4e737d85500dc17a638c01354d8c81e4ee1b1b6589895be5ee57970810568440a6915064b86e11580910f018055c957e0731f4da8fa71
-  data.tar.gz: 61f7553cc4ba9cbfc6514283b4ca3ee46281e7806a7698c5fbb78e4192905cb681af16d1c3ab53c69b7be78e99184b6ca259c2e6cd0cea9083d5254513e02796
+  metadata.gz: eea664adc048231d6e35d6c0589cf758e07d4c98e2b172254560ae15dbde10d3fc05704b8edde38a09251cf220e3177b419ea377763834c99a83a80b5c65490b
+  data.tar.gz: 8f40f946e02ab5a68954183e4102b93b8bafb32f8e181974f14e5e4419c36dbf921cbde76c7282387f876a4afc29356f881f9bba3e31379c71504af51c46b2ed

data/app/helpers/manifester/application_helper.rb

@@ -4,21 +4,151 @@ module Manifester
       Manifester.instance
     end
 
+    # Computes the relative path for a given Webpacker asset.
+    # Returns the relative path using manifest.json and passes it to path_to_asset helper.
+    # This will use path_to_asset internally, so most of their behaviors will be the same.
+    #
+    # Example:
+    #
+    #   <%= asset_manifest_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
+    def asset_manifest_path(name, **options)
+      path_to_asset(current_manifester_instance.manifest.lookup!(name), options)
+    end
+
+    # Computes the absolute path for a given Webpacker asset.
+    # Returns the absolute path using manifest.json and passes it to url_to_asset helper.
+    # This will use url_to_asset internally, so most of their behaviors will be the same.
+    #
+    # Example:
+    #
+    #   <%= asset_manifest_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
+    def asset_manifest_url(name, **options)
+      url_to_asset(current_manifester_instance.manifest.lookup!(name), options)
+    end
+
+    # Computes the relative path for a given Webpacker image with the same automated processing as image_manifest_tag.
+    # Returns the relative path using manifest.json and passes it to path_to_asset helper.
+    # This will use path_to_asset internally, so most of their behaviors will be the same.
+    def image_manifest_path(name, **options)
+      resolve_path_to_image(name, **options)
+    end
+
+    # Computes the absolute path for a given Webpacker image with the same automated
+    # processing as image_manifest_tag. Returns the relative path using manifest.json
+    # and passes it to path_to_asset helper. This will use path_to_asset internally,
+    # so most of their behaviors will be the same.
+    def image_manifest_url(name, **options)
+      resolve_path_to_image(name, **options.merge(protocol: :request))
+    end
+
+    # Creates an image tag that references the named pack file.
+    #
+    # Example:
+    #
+    #  <%= image_manifest_tag 'application.png', size: '16x10', alt: 'Edit Entry' %>
+    #  <img alt='Edit Entry' src='/packs/application-k344a6d59eef8632c9d1.png' width='16' height='10' />
+    #
+    #  <%= image_manifest_tag 'picture.png', srcset: { 'picture-2x.png' => '2x' } %>
+    #  <img srcset= "/packs/picture-2x-7cca48e6cae66ec07b8e.png 2x" src="/packs/picture-c38deda30895059837cf.png" >
+    def image_manifest_tag(name, **options)
+      if options[:srcset] && !options[:srcset].is_a?(String)
+        options[:srcset] = options[:srcset].map do |src_name, size|
+          "#{resolve_path_to_image(src_name)} #{size}"
+        end.join(", ")
+      end
+
+      image_tag(resolve_path_to_image(name), options)
+    end
+
+    # Creates a link tag for a favicon that references the named pack file.
+    #
+    # Example:
+    #
+    #  <%= favicon_manifest_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' %>
+    #  <link href="/packs/mb-icon-k344a6d59eef8632c9d1.png" rel="apple-touch-icon" type="image/png" />
+    def favicon_manifest_tag(name, **options)
+      favicon_link_tag(resolve_path_to_image(name), options)
+    end
+
+    # Creates script tags that reference the js chunks from entrypoints when using split chunks API,
+    # as compiled by webpack per the entries list in package/environments/base.js.
+    # By default, this list is auto-generated to match everything in
+    # app/packs/entrypoints/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+    # See: https://webpack.js.org/plugins/split-chunks-plugin/
+    #
+    # Example:
+    #
+    #   <%= javascript_manifest_tag 'calendar', 'map', 'data-turbolinks-track': 'reload' %> # =>
+    #   <script src="/packs/vendor-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+    #   <script src="/packs/calendar~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+    #   <script src="/packs/calendar-1016838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+    #   <script src="/packs/map~runtime-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+    #   <script src="/packs/map-16838bab065ae1e314.chunk.js" data-turbolinks-track="reload"></script>
+    #
+    # DO:
+    #
+    #   <%= javascript_manifest_tag 'calendar', 'map' %>
+    #
+    # DON'T:
+    #
+    #   <%= javascript_manifest_tag 'calendar' %>
+    #   <%= javascript_manifest_tag 'map' %>
     def javascript_manifest_tag(*names, **options)
       javascript_include_tag(*sources_from_manifest_entrypoints(names, type: :javascript), **options)
     end
 
-    def stylesheet_manifest_tag(*names, **options)
-      stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
+    # Creates a link tag, for preloading, that references a given Webpacker asset.
+    # In production mode, the digested reference is automatically looked up.
+    # See: https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content
+    #
+    # Example:
+    #
+    #   <%= preload_manifest_asset 'fonts/fa-regular-400.woff2' %> # =>
+    #   <link rel="preload" href="/packs/fonts/fa-regular-400-944fb546bd7018b07190a32244f67dc9.woff2" as="font" type="font/woff2" crossorigin="anonymous">
+    def preload_manifest_asset(name, **options)
+      if self.class.method_defined?(:preload_link_tag)
+        preload_link_tag(current_manifester_instance.manifest.lookup!(name), options)
+      else
+        raise "You need Rails >= 5.2 to use this tag."
+      end
     end
 
-    def stylesheet_pack_tag(*names, **options)
+    # Creates link tags that reference the css chunks from entrypoints when using split chunks API,
+    # as compiled by webpack per the entries list in package/environments/base.js.
+    # By default, this list is auto-generated to match everything in
+    # app/packs/entrypoints/*.js and all the dependent chunks. In production mode, the digested reference is automatically looked up.
+    # See: https://webpack.js.org/plugins/split-chunks-plugin/
+    #
+    # Examples:
+    #
+    #   <%= stylesheet_manifest_tag 'calendar', 'map' %> # =>
+    #   <link rel="stylesheet" media="screen" href="/packs/3-8c7ce31a.chunk.css" />
+    #   <link rel="stylesheet" media="screen" href="/packs/calendar-8c7ce31a.chunk.css" />
+    #   <link rel="stylesheet" media="screen" href="/packs/map-8c7ce31a.chunk.css" />
+    #
+    # DO:
+    #
+    #   <%= stylesheet_manifest_tag 'calendar', 'map' %>
+    #
+    # DON'T:
+    #
+    #   <%= stylesheet_manifest_tag 'calendar' %>
+    #   <%= stylesheet_manifest_tag 'map' %>
+    def stylesheet_manifest_tag(*names, **options)
+      stylesheet_link_tag(*sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
     end
 
     private
 
       def sources_from_manifest_entrypoints(names, type:)
-        names.map { |name| current_manifester_instance.manifest.lookup_pack_with_chunks!(name.to_s, type: type) }.flatten.uniq
+        names.map { |name| current_manifester_instance.manifest.lookup_manifest_with_chunks!(name.to_s, type: type) }.flatten.uniq
+      end
+
+      def resolve_path_to_image(name, **options)
+        path = name.starts_with?("media/images/") ? name : "media/images/#{name}"
+        path_to_asset(current_manifester_instance.manifest.lookup!(path), options)
+      rescue
+        path_to_asset(current_manifester_instance.manifest.lookup!(name), options)
       end
   end
 end

data/lib/manifester.rb

@@ -1,5 +1,4 @@
 require "manifester/version"
-require "manifester/engine"
 
 module Manifester
   extend self
@@ -12,3 +11,10 @@ module Manifester
     @instance ||= Manifester::Instance.new
   end
 end
+
+require "manifester/instance"
+require "manifester/env"
+require "manifester/configuration"
+require "manifester/manifest"
+
+require "manifester/engine" if defined?(Rails)

data/lib/manifester/manifest.rb

@@ -12,7 +12,7 @@ class Manifester::Manifest
     @data = load
   end
 
-  def lookup_pack_with_chunks(name, pack_type = {})
+  def lookup_manifest_with_chunks(name, pack_type = {})
     manifest_pack_type = manifest_type(pack_type[:type])
     manifest_pack_name = manifest_name(name, manifest_pack_type)
     find("entrypoints")[manifest_pack_name]["assets"][manifest_pack_type]
@@ -20,8 +20,8 @@ class Manifester::Manifest
     nil
   end
 
-  def lookup_pack_with_chunks!(name, pack_type = {})
-    lookup_pack_with_chunks(name, pack_type) || handle_missing_entry(name, pack_type)
+  def lookup_manifest_with_chunks!(name, pack_type = {})
+    lookup_manifest_with_chunks(name, pack_type) || handle_missing_entry(name, pack_type)
   end
 
   # Computes the relative path for a given Manifester asset using manifest.json.

data/lib/manifester/version.rb

@@ -1,3 +1,3 @@
 module Manifester
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manifester
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-12 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails