cat_herder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 479a2393cf3c34ee5fca8210d9e642232ab012b6475a5204811e913cfbb9a4df
+  data.tar.gz: 461262ce3786120921eadfb1b082a4e494a6aacf7bb5806e0b569c3dbfd0c47b
+SHA512:
+  metadata.gz: d44bbb630714a52bbed16ed50f5c107e50212ddadcc28d830acd50864ae68c64cf320140fc1103c5ccd7c90ece4acf083c786f5279ac0a478a17377ce15e0d89
+  data.tar.gz: cda8936e2835e4e8635317da66c5611ff745799c02e91ac6c150e7dc85d835c3425b1ecfb3b5e8c23228b815fcc358cf00169a83bd8d55dde230e58b9268c973

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Jonathan Hefner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# cat_herder
+
+Minimal Rails asset pipeline experiment:
+
+* Assets are fingerprinted and copied to `public/assets` in development, just
+  like `rails assets:precompile`.  Thus they are served directly, without any
+  special routes or middleware.
+
+* ERB assets are evaluated; all other assets are copied verbatim.
+
+* ERB assets can call `asset_path` and all other [`AssetUrlHelper`][] helpers.
+
+  * Currently, `*_url` helpers always return a path instead of a full URL (the
+    same as `*_path` helpers).  Assuming these helpers are primarily used for
+    import statements (e.g. `@import url(...)`), this shouldn't pose a problem,
+    because the browser resolves such partial URLs to the asset host rather than
+    the page host.  The benefit of the current implementation is that it
+    sidesteps the issue of cache invalidation when `config.asset_host` changes.
+
+* ERB assets can call `render` to render the content of another asset inline.
+
+* ERB assets can call `glob` to iterate over other assets.  Using a given
+  pattern, `glob` will search all load paths.  With a combination of `glob` and
+  `render`, assets can perform their own bundling.
+
+* ERB assets can call `resolve` to get an absolute path to an asset file.  This
+  can be used to pass the asset to an external command, e.g.:
+
+    ```erb
+    <%# styles.css.erb %>
+    <%= `sass #{resolve "styles.sass"}` %>
+    ```
+
+* All calls to `asset_path` / `compute_asset_path`, `render`, and `resolve` will
+  add the resulting asset to the current asset's dependencies, so that the
+  current asset will be recompiled when any of its dependencies are.
+
+* Partial assets are prefixed with an underscore (like view partials), and are
+  not copied to `public/assets` by `rails assets:precompile`.  They can be
+  referenced using their logical path without the underscore (like view
+  partials).  This allows "private" files, such as raw input files or config
+  files, to be placed in any of the asset load paths and be evaluated like other
+  assets.  (Calls to `compute_asset_path` that resolve to a partial asset will
+  raise an error to prevent broken URLs.)
+
+[`AssetUrlHelper`]: https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cat_herder"
+```
+
+And run:
+
+```bash
+$ bundle install
+```
+
+Then disable Sprockets, and require *cat_herder* in your `config/application.rb`
+file:
+
+```ruby
+require "cat_herder/railtie"
+```
+
+
+## Contributing
+
+Run `bin/test` to run the tests.
+
+
+## License
+
+[MIT License](MIT-LICENSE)

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/cat_herder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "cat_herder/version"
+
+module CatHerder
+  extend ActiveSupport::Autoload
+
+  autoload :AssetNotFound
+  autoload :AssetNotPublic
+  autoload :Assets
+  autoload :Current
+  autoload :Helper
+
+  EMPTY_ARRAY = [].freeze
+end

data/lib/cat_herder/asset_not_found.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CatHerder
+  class AssetNotFound < StandardError
+    def initialize(logical_path)
+      super("Could not find asset #{logical_path.inspect}.")
+    end
+  end
+end

data/lib/cat_herder/asset_not_public.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CatHerder
+  class AssetNotPublic < StandardError
+    def initialize(asset)
+      super("Asset #{asset.logical_path.inspect} (#{asset.source_path.inspect}) does not expose a public path.")
+    end
+  end
+end

data/lib/cat_herder/assets.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "active_support/core_ext/enumerable"
+
+module CatHerder
+  module Assets
+    extend ActiveSupport::Autoload
+
+    autoload :ErbAsset
+    autoload :VerbatimAsset
+
+    mattr_accessor :load_paths, default: []
+    mattr_accessor :public_subpath, default: "assets"
+    mattr_accessor :cache_store
+    mattr_accessor :precompiled, default: false
+    singleton_class.alias_method :precompiled?, :precompiled
+
+    class << self
+      def cache
+        @cache ||= ActiveSupport::Cache.lookup_store(*cache_store)
+      end
+
+      def public_path
+        @public_path ||= Rails.public_path.join(public_subpath)
+      end
+
+      def public_files
+        public_path.glob("**/*").select(&:file?)
+      end
+
+      def public_file_logical_path(public_file)
+        public_file.dirname.relative_path_from(public_path).to_s
+      end
+
+      def resolve_logical_path(logical_path)
+        Current.resolved_paths[logical_path] ||= begin
+          logical_dirname, logical_basename = File.split(logical_path)
+          basename_pattern = /\A_?#{Regexp.escape logical_basename}(?:\.erb)?\z/
+          load_paths.find do |load_path|
+            dirname = File.expand_path(logical_dirname, load_path)
+            basename = Current.dir_children(dirname).find { |name| basename_pattern.match?(name) }
+            break File.join(dirname, basename) if basename
+          end
+        end
+      end
+
+      def [](logical_path)
+        source_path = resolve_logical_path(logical_path) or raise AssetNotFound, logical_path
+        (@assets ||= {})[source_path] ||= (source_path.end_with?(".erb") ? ErbAsset : VerbatimAsset).new(logical_path, source_path)
+      end
+
+      def glob(*logical_patterns, &block)
+        logical_patterns.map! { |pattern| "#{pattern}{,.erb}" }
+        load_paths.flat_map { |load_path| Dir.glob(*logical_patterns, base: load_path) }.
+          each { |path| path.sub!(%r"_?([^/]+?)(?:\.erb)?\z", '\1') }.uniq.
+          tap { |logical_paths| logical_paths.each(&block) if block }
+      end
+
+      def precompile
+        public_path.rmtree if public_path.exist?
+        glob("**/[^_]*") { |logical_path| self[logical_path].compile }
+        @assets&.each_value { |asset| asset.public_file.dirname.rmtree if asset.partial? && asset.public_file.exist? }
+        cache.clear
+      end
+
+      def precompiled_asset_paths
+        @precompiled_asset_paths ||= public_files.index_by { |file| public_file_logical_path(file) }.
+          transform_values! { |file| "/#{file.relative_path_from(Rails.public_path)}" }
+      end
+
+      def precompiled_asset_path(logical_path)
+        precompiled_asset_paths[logical_path] or raise AssetNotFound, logical_path
+      end
+
+      def clean
+        public_files.each do |file|
+          logical_path = public_file_logical_path(file)
+          file.delete unless resolve_logical_path(logical_path) && file == self[logical_path].public_file
+        end
+      end
+    end
+  end
+end

data/lib/cat_herder/assets/asset.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module CatHerder
+  module Assets
+    class Asset
+      attr_reader :logical_path, :source_path, :partial
+      alias :partial? :partial
+
+      def initialize(logical_path, source_path)
+        @logical_path = logical_path
+        @source_path = source_path
+        @partial = File.basename(source_path).start_with?("_")
+        @metadata = Assets.cache.read([self, "metadata"]) || {}
+      end
+
+      def cache_key
+        source_path.delete_prefix(Rails.root.to_s)
+      end
+
+      def digest_class
+        ActiveSupport::Digest.hash_digest_class
+      end
+
+      def digest
+        @metadata[:digest]
+      end
+
+      def dependencies
+        @metadata[:dependencies]&.map { |logical_path| Assets[logical_path] } || EMPTY_ARRAY
+      end
+
+      def dependency_digests
+        @metadata[:dependency_digests] || EMPTY_ARRAY
+      end
+
+      def mtime
+        @metadata[:mtime] || Float::NAN
+      end
+
+      def source_mtime
+        Current.mtime(source_path)
+      end
+
+      def stale?
+        mtime != source_mtime || dependency_digests != dependencies.map(&:digest) || dependencies.any?(&:stale?)
+      end
+
+      def public_subpath
+        File.join(Assets.public_subpath, logical_path, "#{digest}#{File.extname(logical_path)}")
+      end
+
+      def public_file
+        Rails.public_path.join(public_subpath)
+      end
+
+      def written?
+        Current.mtime(public_file.to_s) > 0
+      end
+
+      def compile
+        write if !written? || stale?
+      end
+
+      def write_metadata(digest:, dependencies: nil)
+        @metadata = {
+          mtime: source_mtime,
+          digest: digest,
+          dependencies: dependencies&.map(&:logical_path),
+          dependency_digests: dependencies&.map(&:digest),
+        }
+        Assets.cache.write([self, "metadata"], @metadata)
+      end
+
+      def asset_path
+        raise AssetNotPublic, self if partial?
+        compile
+        File.join("/", public_subpath)
+      end
+
+      def render
+        compile
+        read
+      end
+
+      def write; raise NotImplementedError; end
+      def read; raise NotImplementedError; end
+    end
+  end
+end

data/lib/cat_herder/assets/erb_asset.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "action_view/helpers/asset_url_helper"
+require "cat_herder/assets/asset"
+
+module CatHerder
+  module Assets
+    class ErbAsset < Asset
+      def write
+        result, dependencies = evaluate_erb
+        write_metadata(digest: digest_class.hexdigest(result), dependencies: dependencies)
+        public_file.tap { |file| file.dirname.mkpath }.write(result)
+      end
+
+      def read
+        public_file.read
+      end
+
+      private
+        def evaluate_erb
+          ruby = Assets.cache.fetch([self, "ruby"], version: source_mtime) do
+            require "erubi"
+            Erubi::Engine.new(File.read(source_path), filename: source_path).src
+          end
+          context = ErbContext.new(logical_path)
+          [context.instance_eval(ruby), context._dependencies]
+        end
+
+        class ErbContext
+          include ActionView::Helpers::AssetUrlHelper
+
+          attr_reader :_dependencies
+
+          def initialize(logical_path)
+            @_logical_path = logical_path
+            @_dependencies = []
+          end
+
+          def compute_asset_path(logical_path, *)
+            _dependency(logical_path).asset_path
+          end
+
+          def resolve(logical_path)
+            _dependency(logical_path).source_path
+          end
+
+          def render(logical_path)
+            _dependency(logical_path).render
+          end
+
+          def glob(*logical_patterns, &block)
+            Assets.glob(*logical_patterns.map { |pattern| _expand_logical_path(pattern) }, &block)
+          end
+
+          private
+            def _dependency(logical_path)
+              dependency = Assets[_expand_logical_path(logical_path)]
+              @_dependencies << dependency unless @_dependencies.include?(dependency)
+              dependency
+            end
+
+            def _expand_logical_path(logical_path)
+              logical_path.start_with?("./", "../") ? Pathname(@_logical_path).dirname.join(logical_path).to_s : logical_path
+            end
+        end
+    end
+  end
+end

data/lib/cat_herder/assets/verbatim_asset.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "cat_herder/assets/asset"
+
+module CatHerder
+  module Assets
+    class VerbatimAsset < Asset
+      def write
+        write_metadata(digest: digest_class.file(source_path).hexdigest)
+        FileUtils.cp(source_path, public_file.tap { |file| file.dirname.mkpath }) unless partial?
+      end
+
+      def written?
+        partial? || super
+      end
+
+      def read
+        File.read(source_path)
+      end
+    end
+  end
+end

data/lib/cat_herder/current.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module CatHerder
+  class Current < ActiveSupport::CurrentAttributes
+    attribute :resolved_paths, :mtime_cache, :dir_children_cache
+
+    def resolved_paths
+      super || (self.resolved_paths = {})
+    end
+
+    def mtime(path)
+      (self.mtime_cache ||= {})[path] ||= File.file?(path) ? File.mtime(path).to_f : Float::NAN
+    end
+
+    def dir_children(path)
+      (self.dir_children_cache ||= {})[path] ||= File.directory?(path) ? Dir.children(path) : EMPTY_ARRAY
+    end
+  end
+end

data/lib/cat_herder/helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module CatHerder
+  module Helper
+    def compute_asset_path(logical_path, options = {})
+      Assets.precompiled? ? Assets.precompiled_asset_path(logical_path) : Assets[logical_path].asset_path
+    end
+  end
+end

data/lib/cat_herder/railtie.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "rails"
+require "cat_herder"
+
+module CatHerder
+  class Railtie < ::Rails::Railtie
+    config.assets = ActiveSupport::OrderedOptions.new
+
+    initializer "assets.configure" do |app|
+      Assets.load_paths = [
+        *app.paths["app/assets"].existent_directories,
+        *app.paths["lib/assets"].existent_directories,
+        *app.paths["vendor/assets"].existent_directories,
+        *app.config.assets.paths,
+      ]
+      Assets.public_subpath = app.config.assets.prefix.delete_prefix("/") if app.config.assets.prefix
+      Assets.cache_store = app.config.assets.cache_store || [:file_store, app.root.join("tmp/assets.cache")]
+      Assets.precompiled = app.config.assets.compile == false
+    end
+
+    server do
+      if Assets.precompiled?
+        Assets.precompiled_asset_paths # warm up
+      else
+        Assets.clean
+      end
+    end
+
+    ActiveSupport.on_load(:action_view) do
+      include Helper
+    end
+
+    rake_tasks do
+      load "tasks/cat_herder_tasks.rake"
+    end
+  end
+end

data/lib/cat_herder/version.rb

@@ -0,0 +1,3 @@
+module CatHerder
+  VERSION = '0.1.0'
+end

data/lib/tasks/cat_herder_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :cat_herder do
+  desc "Compile all assets"
+  task :precompile => :environment do
+    CatHerder::Assets.precompile
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: cat_herder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Hefner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+description: 
+email:
+- jonathan@hefner.pro
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/cat_herder.rb
+- lib/cat_herder/asset_not_found.rb
+- lib/cat_herder/asset_not_public.rb
+- lib/cat_herder/assets.rb
+- lib/cat_herder/assets/asset.rb
+- lib/cat_herder/assets/erb_asset.rb
+- lib/cat_herder/assets/verbatim_asset.rb
+- lib/cat_herder/current.rb
+- lib/cat_herder/helper.rb
+- lib/cat_herder/railtie.rb
+- lib/cat_herder/version.rb
+- lib/tasks/cat_herder_tasks.rake
+homepage: https://github.com/jonathanhefner/cat_herder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jonathanhefner/cat_herder
+  source_code_uri: https://github.com/jonathanhefner/cat_herder
+  changelog_uri: https://github.com/jonathanhefner/cat_herder/blob/master/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.1.4
+signing_key: 
+specification_version: 4
+summary: Minimal Rails asset pipeline experiment
+test_files: []