hanami-assets 1.3.5 → 2.1.0.rc1

data/lib/hanami/assets/asset.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Assets
+    # Represents a single front end asset.
+    #
+    # @api public
+    # @since 2.1.0
+    class Asset
+      # @api private
+      # @since 2.1.0
+      attr_reader :config
+      private :config
+
+      # Returns the asset's absolute URL path.
+      #
+      # @example Asset from local dev server
+      #   asset.path # => "/assets/app.js"
+      #
+      # @example Deployed asset with fingerprinted name
+      #   asset.path # => "/assets/app-28a6b886de2372ee3922fcaf3f78f2d8.js"
+      #
+      # @return [String]
+      #
+      # @api public
+      # @since 2.1.0
+      attr_reader :path
+
+      # @api private
+      # @since 2.1.0
+      attr_reader :base_url
+      private :base_url
+
+      # Returns the asset's subresource integrity value, or nil if none is available.
+      #
+      # @return [String, nil]
+      #
+      # @api public
+      # @since 2.1.0
+      attr_reader :sri
+
+      # @api private
+      # @since 2.1.0
+      def initialize(path:, base_url:, sri: nil)
+        @path = path
+        @base_url = base_url
+        @sri = sri
+      end
+
+      # @api public
+      # @since 2.1.0
+      alias_method :subresource_integrity_value, :sri
+
+      # Returns the asset's full URL.
+      #
+      # @example Asset from local dev server
+      #   asset.path # => "https://example.com/assets/app.js"
+      #
+      # @example Deployed asset with fingerprinted name
+      #   asset.path # => "https://example.com/assets/app-28a6b886de2372ee3922fcaf3f78f2d8.js"
+      #
+      # @return [String]
+      #
+      # @api public
+      # @since 2.1.0
+      def url
+        base_url.join(path)
+      end
+
+      # Returns the asset's full URL
+      #
+      # @return [String]
+      #
+      # @see #url
+      #
+      # @api public
+      # @since 2.1.0
+      def to_s
+        url
+      end
+    end
+  end
+end

data/lib/hanami/assets/base_url.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Assets
+    # Base URL
+    #
+    # @since 2.1.0
+    # @api private
+    class BaseUrl
+      # @since 2.1.0
+      # @api private
+      SEPARATOR = "/"
+      private_constant :SEPARATOR
+
+      # @since 2.1.0
+      # @api private
+      attr_reader :url
+      private :url
+
+      # Initialize a base URL
+      #
+      # @param url [String] the URL
+      # @param prefix [String,NilClass] the prefix
+      #
+      # @since 2.1.0
+      # @api private
+      def initialize(url, prefix = nil)
+        @url = URI(url + prefix.to_s).to_s
+        freeze
+      end
+
+      # Join the base URL with the given paths
+      #
+      # @param other [String] the paths
+      # @return [String] the joined URL
+      #
+      # @since 2.1.0
+      # @api private
+      def join(other)
+        (url + other).to_s
+      end
+
+      # @since 2.1.0
+      # @api private
+      def to_s
+        @url
+      end
+
+      # Check if the source is a cross origin
+      #
+      # @param source [String] the source
+      # @return [Boolean] true if the source is a cross origin
+      #
+      # @since 2.1.0
+      # @api private
+      def crossorigin?(source)
+        # TODO: review if this is the right way to check for cross origin
+        return true if @url.empty?
+
+        !source.start_with?(@url)
+      end
+    end
+  end
+end

data/lib/hanami/assets/config.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "dry/configurable"
+require_relative "base_url"
+
+module Hanami
+  class Assets
+    # Framework configuration
+    #
+    # @since 0.1.0
+    class Config
+      include Dry::Configurable
+
+      # @since 2.1.0
+      # @api private
+      BASE_URL = ""
+      private_constant :BASE_URL
+
+      # @since 2.1.0
+      # @api private
+      setting :package_manager_run_command, default: "npm run --silent"
+
+      # @since 2.1.0
+      # @api private
+      setting :path_prefix, default: "/assets"
+
+      # @since 2.1.0
+      # @api private
+      setting :destination
+
+      # @since 2.1.0
+      # @api private
+      setting :subresource_integrity, default: []
+
+      # @since 2.1.0
+      # @api private
+      setting :sources, default: [], constructor: -> v { Array(v).flatten }
+
+      # @since 2.1.0
+      # @api private
+      setting :base_url, constructor: -> url { BaseUrl.new(url.to_s) }
+
+      # @since 2.1.0
+      # @api private
+      setting :entry_points_pattern, default: "index.{js,jsx,ts,tsx}"
+
+      # @since 2.1.0
+      # @api private
+      setting :manifest_path
+
+      # @since 2.1.0
+      # @api private
+      def initialize(**values)
+        super()
+
+        config.update(values.select { |k| _settings.key?(k) })
+
+        yield(config) if block_given?
+      end
+
+      # @since 2.1.0
+      # @api private
+      def entry_points
+        sources.map do |source|
+          Dir.glob(File.join(source, "**", config.entry_points_pattern))
+        end.flatten
+      end
+
+      # Check if the given source is linked via Cross-Origin policy.
+      # In other words, the given source, doesn't satisfy the Same-Origin policy.
+      #
+      # @see https://en.wikipedia.org/wiki/Same-origin_policy#Origin_determination_rules
+      # @see https://en.wikipedia.org/wiki/Same-origin_policy#document.domain_property
+      #
+      # @since 1.2.0
+      # @api private
+      def crossorigin?(source)
+        base_url.crossorigin?(source)
+      end
+
+      private
+
+      # @api private
+      def method_missing(name, ...)
+        if config.respond_to?(name)
+          config.public_send(name, ...)
+        else
+          super
+        end
+      end
+
+      # @api private
+      def respond_to_missing?(name, _incude_all = false)
+        config.respond_to?(name) || super
+      end
+    end
+  end
+end

data/lib/hanami/assets/errors.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Hanami
+  class Assets
+    # Base error for Hanami::Assets
+    #
+    # All the errors defined in this framework MUST inherit from it.
+    #
+    # @since 0.1.0
+    class Error < ::StandardError
+    end
+
+    # Error raised when assets config is not valid.
+    #
+    # @since 2.1.0
+    # @api public
+    class ConfigError < Error
+    end
+
+    # Error returned when the assets manifest file is missing.
+    #
+    # @since 2.1.0
+    # @api public
+    class ManifestMissingError < Error
+      def initialize(manifest_path)
+        super(<<~TEXT)
+          Missing manifest file at #{manifest_path.inspect}
+
+          Have you run `hanami assets compile` or `hanami assets watch`?
+        TEXT
+      end
+    end
+
+    # Error raised when no asset can be found for a source path.
+    #
+    # @since 2.1.0
+    # @api public
+    class AssetMissingError < Error
+      def initialize(source_path)
+        super(<<~TEXT)
+          No asset found for #{source_path.inspect}
+        TEXT
+      end
+    end
+  end
+end

data/lib/hanami/assets/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Hanami
-  module Assets
+  class Assets
     # Defines the version
     #
     # @since 0.1.0
-    VERSION = "1.3.5"
+    VERSION = "2.1.0.rc1"
   end
 end

data/lib/hanami/assets.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require "hanami/utils/class_attribute"
+require "json"
+require "zeitwerk"
 
 # Hanami
 #
@@ -9,167 +10,84 @@ module Hanami
   # Assets management for Ruby web applications
   #
   # @since 0.1.0
-  module Assets
-    # Base error for Hanami::Assets
-    #
-    # All the errors defined in this framework MUST inherit from it.
-    #
-    # @since 0.1.0
-    class Error < ::StandardError
+  class Assets
+    # @since 2.1.0
+    # @api private
+    def self.gem_loader
+      @gem_loader ||= Zeitwerk::Loader.new.tap do |loader|
+        root = File.expand_path("..", __dir__)
+        loader.tag = "hanami-assets"
+        loader.push_dir(root)
+        loader.ignore(
+          "#{root}/hanami-assets.rb",
+          "#{root}/hanami/assets/version.rb",
+          "#{root}/hanami/assets/errors.rb"
+        )
+        loader.inflector = Zeitwerk::GemInflector.new("#{root}/hanami-assets.rb")
+      end
     end
 
-    require "hanami/assets/version"
-    require "hanami/assets/configuration"
-    require "hanami/assets/config/global_sources"
-    require "hanami/assets/helpers"
+    gem_loader.setup
+    require_relative "assets/version"
+    require_relative "assets/errors"
 
-    include Utils::ClassAttribute
-
-    # Configuration
-    #
-    # @since 0.1.0
+    # @since 2.1.0
     # @api private
-    class_attribute :configuration
-    self.configuration = Configuration.new
-
-    # Configure framework
-    #
-    # @param blk [Proc] configuration code block
-    #
-    # @return self
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Assets::Configuration
-    def self.configure(&blk)
-      configuration.instance_eval(&blk)
-      self
-    end
+    SEPARATOR = "/"
+    private_constant :SEPARATOR
 
-    # Prepare assets for deploys
-    #
-    # @since 0.1.0
-    def self.deploy
-      require "hanami/assets/precompiler"
-      require "hanami/assets/bundler"
+    attr_reader :config
 
-      Precompiler.new(configuration, duplicates).run
-      Bundler.new(configuration,     duplicates).run
+    # @since 2.1.0
+    # @api public
+    def initialize(config:)
+      @config = config
     end
 
-    # Precompile assets
-    #
-    # @since 0.4.0
-    def self.precompile(configurations)
-      require "hanami/assets/precompiler"
-      require "hanami/assets/bundler"
-
-      Precompiler.new(configuration, configurations).run
-      Bundler.new(configuration,     configurations).run
+    # @since 2.1.0
+    # @api public
+    def [](path)
+      asset_attrs = manifest
+        .fetch(path) { raise AssetMissingError.new(path) }
+        .transform_keys(&:to_sym)
+        .tap { |attrs|
+          # The `url` attribute we receive from the manifest is actually a path; rename it as such
+          # so our `Asset` attributes make more sense on their own.
+          attrs[:path] = attrs.delete(:url)
+        }
+
+      Asset.new(
+        **asset_attrs,
+        base_url: config.base_url
+      )
     end
 
-    # Preload the framework
-    #
-    # This MUST be used in production mode
-    #
-    # @since 0.1.0
-    #
-    # @example Direct Invocation
-    #   require 'hanami/assets'
-    #
-    #   Hanami::Assets.load!
-    #
-    # @example Load Via Configuration Block
-    #   require 'hanami/assets'
-    #
-    #   Hanami::Assets.configure do
-    #     # ...
-    #   end.load!
-    def self.load!
-      configuration.load!
+    # @since 2.1.0
+    # @api public
+    def subresource_integrity?
+      config.subresource_integrity.any?
     end
 
-    # Global assets sources
-    #
-    # This is designed for third party integration gems with frontend frameworks
-    # like Bootstrap, Ember.js or React.
-    #
-    # Developers can maintain gems that ship static assets for these frameworks
-    # and make them available to Hanami::Assets.
-    #
-    # @return [Hanami::Assets::Config::GlobalSources]
-    #
-    # @since 0.1.0
-    #
-    # @example Ember.js Integration
-    #   # lib/hanami/emberjs.rb (third party gem)
-    #   require 'hanami/assets'
-    #
-    #   Hanami::Assets.sources << '/path/to/emberjs/assets'
-    def self.sources
-      synchronize do
-        @@sources ||= Config::GlobalSources.new # rubocop:disable Style/ClassVars
-      end
+    # @since 2.1.0
+    # @api public
+    def crossorigin?(source_path)
+      config.crossorigin?(source_path)
     end
 
-    # Duplicate the framework and generate modules for the target application
-    #
-    # @param _mod [Module] the Ruby namespace of the application
-    # @param blk [Proc] an optional block to configure the framework
-    #
-    # @return [Module] a copy of Hanami::Assets
-    #
-    # @since 0.1.0
-    #
-    # @see Hanami::Assets#dupe
-    # @see Hanami::Assets::Configuration
-    def self.duplicate(_mod, &blk)
-      dupe.tap do |duplicated|
-        duplicated.configure(&blk) if block_given?
-        duplicates << duplicated
-      end
-    end
+    private
 
-    # Duplicate Hanami::Assets in order to create a new separated instance
-    # of the framework.
-    #
-    # The new instance of the framework will be completely decoupled from the
-    # original. It will inherit the configuration, but all the changes that
-    # happen after the duplication, won't be reflected on the other copies.
-    #
-    # @return [Module] a copy of Hanami::Assets
-    #
-    # @since 0.1.0
-    # @api private
-    def self.dupe
-      dup.tap do |duplicated|
-        duplicated.configuration = configuration.duplicate
-      end
-    end
+    def manifest
+      return @manifest if instance_variable_defined?(:@manifest)
 
-    # Keep track of duplicated frameworks
-    #
-    # @return [Array] a collection of duplicated frameworks
-    #
-    # @since 0.1.0
-    # @api private
-    #
-    # @see Hanami::Assets#duplicate
-    # @see Hanami::Assets#dupe
-    def self.duplicates
-      synchronize do
-        @@duplicates ||= [] # rubocop:disable Style/ClassVars
+      unless config.manifest_path
+        raise ConfigError, "no manifest_path configured"
       end
-    end
 
-    class << self
-      private
-
-      # @since 0.1.0
-      # @api private
-      def synchronize(&blk)
-        Mutex.new.synchronize(&blk)
+      unless File.exist?(config.manifest_path)
+        raise ManifestMissingError.new(config.manifest_path)
       end
+
+      @manifest = JSON.parse(File.read(config.manifest_path))
     end
   end
 end

data/lib/hanami-assets.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "hanami/assets"