asset_mapper 0.0.1 → 1.0.0

data/lib/asset_mapper/manifest.rb

@@ -0,0 +1,74 @@
+require 'dry-initializer'
+require 'dry-files'
+
+module AssetMapper
+  # Manifest reads a given sets of files and reads them into memory via a Hash
+  class Manifest
+    extend Dry::Initializer
+
+    # @return [AssetMapper::Configuration]
+    param :config
+
+    class FileNotFoundError < StandardError; end
+
+    # Attempt to find the +file_name+ inside of the manifest, fallback to given filename.
+    # @param {String} file_name - The filename to find in the manifest.
+    # @param {Boolean} prepend_asset_host - Whether or not to add the asset_host. Usually "/"
+    # @return {String}
+    def find(file_name, prepend_asset_host: true)
+      file = manifest_files[file_name]
+
+      if file.nil?
+        raise FileNotFoundError("Unable to find #{filename} in your manifest[s].") if config.raise_on_missing_file
+
+        # Fall back to the default filename, perhaps it exists....
+        file = file_name
+      end
+
+      file = file["asset_path"]
+
+      return with_asset_host(asset_host: config.asset_host, file: file) if prepend_asset_host
+
+      file
+    end
+
+    # Returns a cached copy of the manifest only if cache_manifest is true.
+    def manifest_files
+      # Always reload the manifest. Useful for development / testing.
+      return load_manifest_files if config.cache_manifest == false
+
+      @manifest_files ||= load_manifest_files
+    end
+
+    # Refreshes the cached mappings by reading the updated manifest files.
+    #   Usually used for things like auto-building.
+    def refresh_files
+      @manifest_files = load_manifest_files
+    end
+
+    private
+
+    def with_asset_host(asset_host:, file:)
+      # strip leading "/"
+      file = file[(1..-1)] if file.start_with?("/")
+
+      asset_host += "/" unless asset_host.end_with?("/")
+
+      asset_host + file
+    end
+
+    def load_manifest_files
+      generate_manifest
+
+      hash = {}
+      config.manifest_files.each { |path| hash.merge!(JSON.parse(Dry::Files.new.read(path))["files"]) }
+      hash
+    end
+
+    def generate_manifest
+      @manifest_generator ||= ManifestGenerator.new(config)
+
+      @manifest_generator.generate
+    end
+  end
+end

data/lib/asset_mapper/manifest_generator.rb

@@ -0,0 +1,65 @@
+require 'dry-initializer'
+require "rake"
+
+module AssetMapper
+  class ManifestGenerator
+    extend Dry::Initializer
+
+    FILES = Dry::Files.new
+
+    # @return [AssetMapper::Configuration]
+    param :config
+
+    def generate
+      return if config.asset_files.nil?
+      return if config.asset_files.size.zero?
+
+      map = {
+        "files" => {}
+      }
+
+      config.asset_files.each do |file|
+        hash = handle_file(file)
+
+        map["files"][hash[:relative_path]] = {
+          file_path: hash[:file_path],
+          asset_path: hash[:asset_path]
+        }
+      end
+
+      FILES.write(config.manifest_output_path, JSON.pretty_generate(map))
+    end
+
+    private
+
+    def handle_file(file)
+      relative_path = Pathname.new(file).relative_path_from(config.assets_root).to_s
+
+      content = FILES.read(file)
+      asset_path = (find_relative_hashed_path(file, content) || relative_path).to_s
+
+      dir = File.dirname(file)
+      FILES.mkdir_p(FILES.join(config.assets_output_path, dir))
+      FILES.write(FILES.join(config.assets_output_path, asset_path), content)
+
+      {
+        relative_path: relative_path,
+        file_path: FILES.join(config.assets_output_path, asset_path),
+        asset_path: asset_path
+      }
+    end
+
+    def find_relative_hashed_path(file, content)
+      return nil if config.fingerprint == false
+
+      content_hash = config.fingerprint_method.call(content)
+
+      dir = File.dirname(file)
+
+      base_name_ary = File.basename(file).split(".")
+      base_name = FILES.join(dir, base_name_ary[0])
+      hashed_path = base_name + "-#{content_hash}." + base_name_ary[1]
+      Pathname.new(hashed_path).relative_path_from(config.assets_root)
+    end
+  end
+end

data/lib/asset_mapper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssetMapper
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/asset_mapper.rb

@@ -4,29 +4,19 @@ require "zeitwerk"
 loader = Zeitwerk::Loader.for_gem
 loader.setup # ready!
 
-require "dry/configurable"
 
+# @example
+#
+#   asset_mapper = AssetMapper.new.configure do |config|
+#     config.asset_host = "/builds"
+#     config.manifest_files = "public/builds/asset_manifest.json"
+#     config.cache_manifest = Rails.env.development? || Rails.env.test?
+#     config.raise_on_missing_file = Rails.env.development? || Rails.env.test?
+#   end
 module AssetMapper
-  # Your code goes here...
-  extend ::Dry::Configurable
-  extend self
-
-  setting :files, reader: true
-  setting :output_path, reader: true
-
-  # For file.1234.ext
-  # if using file-1234.ext change to: /\.[\d\w]+\./
-  setting :fingerprint_regexp, default: /\-[\d\w]+\./, reader: true
-  setting :fingerprint_replacer, default: ".", reader: true
-
-  def generate_mapping
-    hash = {}
-
-    files.map do |file|
-      file_without_fingerprint = file.gsub(fingerprint_regexp, fingerprint_replacer)
-      hash[file_without_fingerprint] = file
-    end
-
-    hash
+  # Returns an instance of AssetMapper configuration.
+  # @return [Configuration]
+  def self.new(*args, **kwargs, &block)
+    Configuration.new(*args, **kwargs, &block)
   end
 end

data/packages/asset-mapper-esbuild/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.0.1](https://github.com/KonnorRogers/asset_mapper/compare/v1.0.0...v1.0.1) (2022-12-29)
+
+## [1.0.0](https://github.com/KonnorRogers/asset_mapper/compare/v0.0.1...v1.0.0) (2022-12-29)
+
+
+### Bug Fixes
+
+* more fun fixes ([c3955ab](https://github.com/KonnorRogers/asset_mapper/commit/c3955ab79b522aa3dd2fea0cec1feaf2add3a8ec))

data/packages/asset-mapper-esbuild/esbuild.config.js

@@ -0,0 +1,37 @@
+// @ts-check
+const esbuild = require("esbuild")
+const fs = require("fs")
+
+const watch = process.argv.includes("--watch")
+
+/** @type {import("esbuild").BuildOptions} */
+const options = {
+  entryPoints: {
+    index: "src/index.js",
+  },
+  watch,
+  bundle: false,
+  sourcemap: true,
+  treeShaking: false
+}
+
+;(async () => {
+  fs.rmSync("dist", { recursive: true, force: true });
+
+  try {
+    await Promise.allSettled([
+      esbuild.build({
+        ...options,
+        format: "esm",
+        outdir: "dist/esm"
+      }),
+      esbuild.build({
+        ...options,
+        format: "cjs",
+        outdir: "dist/cjs"
+      })
+    ])
+  } catch(e) { throw e }
+
+  console.log("Finished build")
+})()

data/packages/asset-mapper-esbuild/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "asset-mapper-esbuild",
+  "version": "1.0.1",
+  "description": "Manifest generator for ESBuild designed for use with AssetMapper.",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "scripts": {
+    "build": "node esbuild.config.js && tsc && tsc -p ./tsconfig-cjs.json",
+    "deploy": "pnpm build && standard-version --release-as",
+    "deploy:beta": "pnpm build && standard-version --prerelease beta",
+    "deploy:patch": "pnpm build && standard-version --release-as patch",
+    "deploy:minor": "pnpm build && standard-version --release-as minor",
+    "deploy:major": "pnpm build && standard-version --release-as major",
+    "push": "git push --follow-tags origin main && pnpm publish",
+    "tsc": "tsc"
+  },
+  "keywords": [
+    "asset_mapper",
+    "esbuild"
+  ],
+  "author": "Konnor Rogers",
+  "bugs": {
+    "url": "https://github.com/konnorrogers/asset_mapper/issues",
+    "email": "konnor5456@gmail.com"
+  },
+  "homepage": "https://github.com/konnorrogers/asset_mapper#readme",
+  "files": [
+    "dist"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^18.11.12",
+    "esbuild": "^0.16.4",
+    "rimraf": "^3.0.2",
+    "standard-version": "^9.5.0",
+    "typescript": "^4.9.4"
+  },
+  "peerDependencies": {
+    "esbuild": ">= 0.14.0"
+  }
+}