external_asset_pipeline 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0c608c4887f1a6584bec569e7ea1bd31c1baf0617a1a71e2a33d5340a9a233d
+  data.tar.gz: 8acdec2d61b41b47644b1c66dbc99705fd615adeb03428b7d852f905e33b8f6c
+SHA512:
+  metadata.gz: ca18e90fc4093746261daa6a02d778658d266f3ea2140f3096292f06753de7f7030548630ba38f011481a834c5849721082bacab4027ad66e490b237af4ed5da
+  data.tar.gz: 6e8f2be51af359e08821858e03c2004277ae5a1fcd00ba9c62ad6c7f4e0b368f74422e36e556a503e260868910a402791ab3da112f392ce39b707c7e393da95b

data/lib/external_asset_pipeline/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ExternalAssetPipeline
+  class Configuration
+    attr_accessor :assets_prefix,
+                  :cache_manifest,
+                  :fall_back_to_sprockets,
+                  :manifest_filename,
+                  :public_path
+
+    alias cache_manifest? cache_manifest
+    alias fall_back_to_sprockets? fall_back_to_sprockets
+
+    def initialize
+      @assets_prefix = '/packs'
+      @cache_manifest = true
+      @fall_back_to_sprockets = false
+      @manifest_filename = 'manifest.json'
+    end
+
+    def configure
+      yield self
+      self
+    end
+
+    def manifest_path
+      @public_path.join(public_subdirectory, @manifest_filename)
+    end
+
+    private
+
+    def public_subdirectory
+      @assets_prefix[1..-1]
+    end
+  end
+end

data/lib/external_asset_pipeline/helper.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'external_asset_pipeline'
+
+module ExternalAssetPipeline
+  module Helper
+    # Overrides the built-in
+    # `ActionView::Helpers::AssetUrlHelper#compute_asset_path` to use the
+    # external asset pipeline, in the same manner that sprockets-rails does:
+    # https://github.com/rails/sprockets-rails/blob/v3.2.1/lib/sprockets/rails/helper.rb#L74-L96
+    def compute_asset_path(source, _options = {})
+      value_in_asset_manifest = ExternalAssetPipeline.manifest.find(source)
+
+      return value_in_asset_manifest if value_in_asset_manifest
+      return super if ExternalAssetPipeline.manifest.fall_back_to_sprockets?
+
+      raise AssetNotFound,
+            "The asset #{source.inspect} is not present in the asset manifest"
+    end
+  end
+end

data/lib/external_asset_pipeline/manifest.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module ExternalAssetPipeline
+  class Manifest
+    def initialize(config)
+      @config = config
+    end
+
+    def find(name)
+      value = data[name.to_s]
+      "#{@config.assets_prefix}/#{value}" if value
+    end
+
+    def fall_back_to_sprockets?
+      @config.fall_back_to_sprockets?
+    end
+
+    private
+
+    def data
+      if @config.cache_manifest?
+        @data ||= load
+      else
+        load
+      end
+    end
+
+    def load
+      JSON.parse(@config.manifest_path.read)
+    end
+  end
+end

data/lib/external_asset_pipeline/origin.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'json'
+
+# rubocop:disable all
+module ExternalAssetPipeline
+  class Origin
+    def initialize(server:, fallback:)
+      @server = server
+      @fallback = fallback
+    end
+
+    # USE THIS VERSION IF IT WORKS!
+    # Run some tests in the demo app with different asset_host procs
+    # _Might_ need to define this proc inside a module that includes
+    # ActionView::Helpers::AssetUrlHelper in order for
+    # compute_asset_host to be available - not sure.
+    def call(source, request = nil)
+      if @server.running?
+        @server.origin
+      else
+        ComputeAssetHostProxy.new(request).call(source, host: @fallback)
+      end
+    end
+
+    class ComputeAssetHostProxy
+      include ActionView::Helpers::AssetUrlHelper
+
+      attr_reader :request
+
+      def initialize(request:)
+        @request = request
+      end
+
+      def call(source, host:)
+        compute_asset_host(source, host: host)
+      end
+    end
+
+    def ugly_call(source, request)
+      # Ugh, this is so ugly
+      # the logic in the elsif branch is copied from
+      # https://github.com/rails/rails/blob/b13a5cb83ea00d6a3d71320fd276ca21049c2544/actionview/lib/action_view/helpers/asset_url_helper.rb#L280-L284
+      if server.running?
+        server.origin
+      elsif fallback.respond_to?(:call)
+        arity =
+          if fallback.respond_to?(:arity)
+            host.arity
+          else
+            host.method(:call).arity
+          end
+        args = [source]
+        args << request if request && (arity > 1 || arity < 0)
+        fallback.call(*args)
+      else
+        fallback
+      end
+    end
+  end
+end
+# rubocop:enable all

data/lib/external_asset_pipeline/railtie.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+require 'external_asset_pipeline'
+require 'external_asset_pipeline/configuration'
+require 'external_asset_pipeline/helper'
+require 'external_asset_pipeline/manifest'
+
+module ExternalAssetPipeline
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      config.external_asset_pipeline = Configuration.new.configure do |c|
+        c.public_path = ::Rails.root.join('public')
+      end
+    end
+
+    config.after_initialize do
+      ExternalAssetPipeline.manifest =
+        Manifest.new(config.external_asset_pipeline)
+
+      ActiveSupport.on_load(:action_view) do
+        include ExternalAssetPipeline::Helper
+      end
+    end
+  end
+end

data/lib/external_asset_pipeline/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ExternalAssetPipeline
+  VERSION = '0.1.0'
+end

data/lib/external_asset_pipeline.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'external_asset_pipeline/version'
+
+module ExternalAssetPipeline
+  class Error < StandardError; end
+  class AssetNotFound < Error; end
+
+  class << self
+    attr_accessor :manifest
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: external_asset_pipeline
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Macklin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: |
+  This gem provides a thin layer to connect an externally-managed asset
+  pipeline to ActionView's AssetUrlHelper and AssetTagHelper methods. This is
+  useful if you are comfortable leveraging other programs to produce an asset
+  manifest and you just want it to integrate with ActionView's helper methods
+  (e.g. `asset_path`, `javascript_include_tag`, etc.)
+email:
+- 1863540+rmacklin@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/external_asset_pipeline.rb
+- lib/external_asset_pipeline/configuration.rb
+- lib/external_asset_pipeline/helper.rb
+- lib/external_asset_pipeline/manifest.rb
+- lib/external_asset_pipeline/origin.rb
+- lib/external_asset_pipeline/railtie.rb
+- lib/external_asset_pipeline/version.rb
+homepage: https://github.com/rails-front-end/external_asset_pipeline
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rails-front-end/external_asset_pipeline
+  source_code_uri: https://github.com/rails-front-end/external_asset_pipeline/tree/v0.1.0
+  changelog_uri: https://github.com/rails-front-end/external_asset_pipeline/blob/v0.1.0/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Integrate an externally-managed asset pipeline with ActionView
+test_files: []