manifester 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 970a70f2001b8db6a644a0a2838892722797a372e4864a68808b820f3b19ba47
-  data.tar.gz: 5593f78a76fbf7555dea253fcad7397c4c8b9f664e75350fbc2e6052fe002740
+  metadata.gz: 29824867c809881b67054ed4b5afe7da25f2522c8942c2a97ffabc3cb77e318e
+  data.tar.gz: 0f7e32d8feaf9d0808b4c280ca3ea8b480b2f43ef449e6294f1c2071498df8e4
 SHA512:
-  metadata.gz: 225a319989dd4f87be860b5924c5b1420645d57fb348624c6e5a6501c37e165822f3a3fde229e0b1b309edfa057252be1aff990db9e8f2c94a561ced062cd63c
-  data.tar.gz: cb9a5f88e5e0c4e25c0f9a65bcdc09f3c57e136184de784c34c11d01adf4b2f078a003b2f22b0727061a801d99bce3a1a76291ac6849b5910567f4aa5005c996
+  metadata.gz: 43ec8577fc3597f5ee45875c6d057c8c08da99f437a817fd8239f069925e47dbca35409420a6cf0905ea3928059ed662835ac3192413d937b8723a53516269f3
+  data.tar.gz: b582bb945ae72312d85ac10ecd117e07faf4061511818281d13d57718e2d1e904a1e89c8c17b976cb10104ccbc8682a56917a9be56d2a9fb8721974bcb65ad4a

data/README.md

@@ -1,5 +1,9 @@
 # Manifester
-Short description and motivation.
+Manifester was born from the need to ship webpacker generated assets without webpacker.
+
+When we first shipped [Avo](https://github.com/avo-hq/avo) we shipped it with the whole Webpacker pipeline. That meant rebuilding the assets on every deploy of the parent app and other nasty unwanted behaviors (conflicting pipelines, etc.).
+
+We just needed something that would take the packed files when we  and
 
 ## Usage
 How to use my plugin.

data/lib/manifester.rb

@@ -2,8 +2,14 @@ require "zeitwerk"
 require "manifester/version"
 
 loader = Zeitwerk::Loader.for_gem
+loader.push_dir("#{__dir__}/manifester", namespace: Manifester)
 loader.setup
 
+require "manifester/helper"
+require "manifester/instance"
+require "manifester/configuration"
+require "manifester/manifest"
+
 module Manifester
   extend self
 
@@ -16,9 +22,4 @@ module Manifester
   end
 end
 
-require "manifester/instance"
-require "manifester/env"
-require "manifester/configuration"
-require "manifester/manifest"
-
 require "manifester/engine" if defined?(Rails)

data/lib/manifester/configuration.rb

@@ -1,22 +1,24 @@
-require "yaml"
-require "active_support/core_ext/hash/keys"
-require "active_support/core_ext/hash/indifferent_access"
-
 class Manifester::Configuration
-  attr_reader :root_path, :config_path, :env
+  attr_reader :root_path
+  attr_reader :public_root_dir
+  attr_reader :public_output_dir
+  attr_reader :cache_manifest
+  attr_reader :fallback_to_webpacker
 
-  def initialize(root_path:, config_path:, env:)
+  def initialize(root_path:, public_root_dir:, public_output_dir:, cache_manifest:, fallback_to_webpacker:)
     @root_path = root_path
-    @config_path = config_path
-    @env = env
+    @public_root_dir = public_root_dir
+    @public_output_dir = public_output_dir
+    @cache_manifest = cache_manifest
+    @fallback_to_webpacker = fallback_to_webpacker
   end
 
   def public_path
-    root_path.join(fetch(:public_root_path))
+    root_path.join(@public_root_dir)
   end
 
   def public_output_path
-    public_path.join(fetch(:public_output_path))
+    public_path.join(@public_output_dir)
   end
 
   def public_manifest_path
@@ -24,34 +26,10 @@ class Manifester::Configuration
   end
 
   def cache_manifest?
-    fetch(:cache_manifest)
+    @cache_manifest
   end
 
-  private
-    def fetch(key)
-      data.fetch(key, defaults[key])
-    end
-
-    def data
-      @data ||= load
-    end
-
-    def load
-      YAML.load(config_path.read)[env].deep_symbolize_keys
-
-    rescue Errno::ENOENT => e
-      raise "Manifester configuration file not found #{config_path}. " \
-            "Please run rails manifester:install " \
-            "Error: #{e.message}"
-
-    rescue Psych::SyntaxError => e
-      raise "YAML syntax error occurred while parsing #{config_path}. " \
-            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-            "Error: #{e.message}"
-    end
-
-    def defaults
-      @defaults ||= \
-        HashWithIndifferentAccess.new(YAML.load_file(File.expand_path("../../install/config/manifester.yml", __FILE__))[env])
-    end
+  def fallback_to_webpacker?
+    fallback_to_webpacker.call
+  end
 end

data/lib/manifester/engine.rb

@@ -1,15 +1,5 @@
 module Manifester
   class Engine < ::Rails::Engine
     isolate_namespace Manifester
-
-    initializer "manifester.helper" do
-      ActiveSupport.on_load :action_controller do
-        ActionController::Base.helper Manifester::ApplicationHelper
-      end
-
-      ActiveSupport.on_load :action_view do
-        include Manifester::ApplicationHelper
-      end
-    end
   end
 end

data/{app/helpers/manifester/application_helper.rb → lib/manifester/helper.rb}

@@ -1,5 +1,5 @@
 module Manifester
-  module ApplicationHelper
+  module Helper
     def current_manifester_instance
       Manifester.instance
     end
@@ -12,6 +12,8 @@ module Manifester
     #
     #   <%= asset_manifest_path 'calendar.css' %> # => "/packs/calendar-1016838bab065ae1e122.css"
     def asset_manifest_path(name, **options)
+      return asset_pack_path(name, **options) if fallback_to_webpacker?
+
       path_to_asset(current_manifester_instance.manifest.lookup!(name), options)
     end
 
@@ -23,6 +25,8 @@ module Manifester
     #
     #   <%= asset_manifest_url 'calendar.css' %> # => "http://example.com/packs/calendar-1016838bab065ae1e122.css"
     def asset_manifest_url(name, **options)
+      return asset_pack_url(name, **options) if fallback_to_webpacker?
+
       url_to_asset(current_manifester_instance.manifest.lookup!(name), options)
     end
 
@@ -30,6 +34,8 @@ module Manifester
     # 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)
+      return image_pack_path(name, **options) if fallback_to_webpacker?
+
       resolve_path_to_image(name, **options)
     end
 
@@ -38,6 +44,8 @@ module Manifester
     # 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)
+      return image_pack_url(name, **options) if fallback_to_webpacker?
+
       resolve_path_to_image(name, **options.merge(protocol: :request))
     end
 
@@ -51,6 +59,8 @@ module Manifester
     #  <%= 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)
+      return image_pack_tag(name, **options) if fallback_to_webpacker?
+
       if options[:srcset] && !options[:srcset].is_a?(String)
         options[:srcset] = options[:srcset].map do |src_name, size|
           "#{resolve_path_to_image(src_name)} #{size}"
@@ -67,6 +77,8 @@ module Manifester
     #  <%= 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)
+      return favicon_pack_tag(name, **options) if fallback_to_webpacker?
+
       favicon_link_tag(resolve_path_to_image(name), options)
     end
 
@@ -94,7 +106,9 @@ module Manifester
     #   <%= 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)
+      return javascript_pack_tag(*names, **options) if fallback_to_webpacker?
+
+      javascript_include_tag(*manifester_sources_from_manifest_entrypoints(names, type: :javascript), **options)
     end
 
     # Creates a link tag, for preloading, that references a given Manifester asset.
@@ -106,6 +120,8 @@ module Manifester
     #   <%= 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)
+      return preload_pack_asset(name, **options) if fallback_to_webpacker?
+
       if self.class.method_defined?(:preload_link_tag)
         preload_link_tag(current_manifester_instance.manifest.lookup!(name), options)
       else
@@ -135,12 +151,14 @@ module Manifester
     #   <%= 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)
+      return stylesheet_pack_tag(*names, **options) if fallback_to_webpacker?
+
+      stylesheet_link_tag(*manifester_sources_from_manifest_entrypoints(names, type: :stylesheet), **options)
     end
 
     private
 
-      def sources_from_manifest_entrypoints(names, type:)
+      def manifester_sources_from_manifest_entrypoints(names, type:)
         names.map { |name| current_manifester_instance.manifest.lookup_manifest_with_chunks!(name.to_s, type: type) }.flatten.uniq
       end
 
@@ -150,5 +168,9 @@ module Manifester
       rescue
         path_to_asset(current_manifester_instance.manifest.lookup!(name), options)
       end
+
+      def fallback_to_webpacker?
+        current_manifester_instance.config.fallback_to_webpacker?
+      end
   end
 end

data/lib/manifester/instance.rb

@@ -1,21 +1,19 @@
 class Manifester::Instance
   cattr_accessor(:logger) { ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new(STDOUT)) }
 
-  attr_reader :root_path, :config_path
+  attr_reader :root_path
 
-  def initialize(root_path: Rails.root, config_path: Rails.root.join("config/manifester.yml"))
-    @root_path, @config_path = root_path, config_path
-  end
-
-  def env
-    @env ||= Manifester::Env.inquire self
+  def initialize(root_path: Rails.root, public_root_dir: "public", public_output_dir: "packs", cache_manifest: false, fallback_to_webpacker: -> {})
+    @root_path, @public_root_dir, @public_output_dir, @cache_manifest, @fallback_to_webpacker = root_path, public_root_dir, public_output_dir, cache_manifest, fallback_to_webpacker
   end
 
   def config
     @config ||= Manifester::Configuration.new(
-      root_path: root_path,
-      config_path: config_path,
-      env: env
+      root_path: @root_path,
+      public_root_dir: @public_root_dir,
+      public_output_dir: @public_output_dir,
+      cache_manifest: @cache_manifest,
+      fallback_to_webpacker: @fallback_to_webpacker
     )
   end
 

data/lib/manifester/version.rb

@@ -1,3 +1,3 @@
 module Manifester
-  VERSION = '0.1.2'
+  VERSION = '0.1.7'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manifester
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,8 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Manifester loads stylesheets and javascript assets from your manifest.json
-  file.
+description: Manifester loads your webpacker generated javascript and stylesheets
+  assets from your manifest.json file.
 email:
 - adrian@adrianthedev.com
 executables: []
@@ -49,29 +49,20 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/manifester_manifest.js
-- app/assets/stylesheets/manifester/application.css
-- app/controllers/manifester/application_controller.rb
-- app/helpers/manifester/application_helper.rb
-- app/jobs/manifester/application_job.rb
-- app/mailers/manifester/application_mailer.rb
-- app/models/manifester/application_record.rb
-- app/views/layouts/manifester/application.html.erb
-- config/routes.rb
 - lib/install/config/manifester.yml
 - lib/manifester.rb
 - lib/manifester/configuration.rb
 - lib/manifester/engine.rb
-- lib/manifester/env.rb
+- lib/manifester/helper.rb
 - lib/manifester/instance.rb
 - lib/manifester/manifest.rb
 - lib/manifester/version.rb
 - lib/tasks/manifester_tasks.rake
-homepage: https://avohq.io
+homepage: https://github.com/avo-hq/manifester
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://avohq.io
+  homepage_uri: https://github.com/avo-hq/manifester
   source_code_uri: https://github.com/avo-hq/manifester
   changelog_uri: https://github.com/avo-hq/manifester
 post_install_message:
@@ -92,6 +83,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
-summary: Manifester loads stylesheets and javascript assets from your manifest.json
-  file.
+summary: Manifester loads your webpacker generated assets.
 test_files: []

data/app/assets/config/manifester_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/manifester .css

data/app/assets/stylesheets/manifester/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/manifester/application_controller.rb

@@ -1,4 +0,0 @@
-module Manifester
-  class ApplicationController < ActionController::Base
-  end
-end

data/app/jobs/manifester/application_job.rb

@@ -1,4 +0,0 @@
-module Manifester
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/manifester/application_mailer.rb

@@ -1,6 +0,0 @@
-module Manifester
-  class ApplicationMailer < ActionMailer::Base
-    default from: 'from@example.com'
-    layout 'mailer'
-  end
-end

data/app/models/manifester/application_record.rb

@@ -1,5 +0,0 @@
-module Manifester
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/manifester/application.html.erb

@@ -1,15 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Manifester</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag "manifester/application", media: "all" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/config/routes.rb

@@ -1,2 +0,0 @@
-Manifester::Engine.routes.draw do
-end

data/lib/manifester/env.rb

@@ -1,39 +0,0 @@
-class Manifester::Env
-  DEFAULT = "production".freeze
-
-  delegate :config_path, :logger, to: :@manifester
-
-  def self.inquire(manifester)
-    new(manifester).inquire
-  end
-
-  def initialize(manifester)
-    @manifester = manifester
-  end
-
-  def inquire
-    fallback_env_warning if config_path.exist? && !current
-    current || DEFAULT.inquiry
-  end
-
-  private
-    def current
-      Rails.env.presence_in(available_environments)
-    end
-
-    def fallback_env_warning
-      logger.info "RAILS_ENV=#{Rails.env} environment is not defined in config/manifester.yml, falling back to #{DEFAULT} environment"
-    end
-
-    def available_environments
-      if config_path.exist?
-        YAML.load(config_path.read).keys
-      else
-        [].freeze
-      end
-    rescue Psych::SyntaxError => e
-      raise "YAML syntax error occurred while parsing #{config_path}. " \
-            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
-            "Error: #{e.message}"
-    end
-end