sprockets-jets 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 842c6136e2b8f4efb03f2e78bac691af922dd187e9c3eee9f84681b0bb8fbf93
+  data.tar.gz: dade6363a6463d5677c6e7ecde62a206fdebc5fbf04ac9fba10d896390987cd2
+SHA512:
+  metadata.gz: 81928fabba5e67cae0f6832b0efa61155f0867f11265d0ef2b2c24a33299e138623b4a1fd609c911352df5de801b12b7c306a34066d4f3e8b725f1f41e3a7454
+  data.tar.gz: 23d2041951980d3f1bdf235e6a392fda9316393cbde9ff30b9275f12c7a4d76949e6678122ddd6bf08533e79261de07643202865d640e2bb583582edd89646ae

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+/.bundle
+/.config
+/.yardoc
+/_yardoc
+/coverage
+/doc/
+/Gemfile.lock
+/InstalledFiles
+/lib/bundler/man
+/pkg
+/rdoc
+/spec/reports
+/test/tmp
+/test/version_tmp
+/tmp

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+## [0.1.0]
+- Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem dependencies in sprockets.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,19 @@
+guard "bundler", cmd: "bundle" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) Tung Nguyen
+
+MIT License
+
+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,23 @@
+# Sprockets Jets
+
+[![Gem Version](https://badge.fury.io/rb/sprockets-jets.png)](http://badge.fury.io/rb/sprockets-jets)
+
+[![BoltOps Badge](https://img.boltops.com/boltops/badges/boltops-badge.png)](https://www.boltops.com)
+
+[![BoltOps Learn Badge](https://img.boltops.com/boltops-learn/boltops-learn.png)](https://learn.boltops.com)
+
+Provides [Sprockets](https://github.com/rails/sprockets) implementation for Jets Asset Pipeline.
+
+## Installation
+
+Gemfile
+
+```ruby
+gem "sprockets-jets"
+```
+
+## Usage
+
+    jets assets:precompile
+    jets assets:clean       # keeps most recent 3 copies
+    jets assets:clobber

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new

data/lib/sprockets/autoloader.rb

@@ -0,0 +1,22 @@
+require "zeitwerk"
+
+module Sprockets
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.ignore("#{File.dirname(__dir__)}/sprockets-jets.rb")
+        loader.setup
+      end
+    end
+  end
+end

data/lib/sprockets/jets/engine.rb

@@ -0,0 +1,43 @@
+module Sprockets::Jets
+  class Engine < ::Jets::Engine
+    config.assets = ActiveSupport::OrderedOptions.new
+    config.assets.paths = %w[
+      app/assets/config
+      app/assets/images
+      app/assets/javascripts
+      app/assets/stylesheets
+    ]
+    config.assets.prefix = "/assets"
+    config.assets.use_precompiled = false # for development false, for production true, but Jets will serve directly with s3 anyway
+    config.assets.precompile      = []
+    # See: https://github.com/rails/sprockets/blob/main/UPGRADING.md#manifestjs
+    # In Sprockets 4, the manifest file using the manifest.js is encouraged
+    # And using individual files like ["application.js", "application.css"] is discouraged.
+
+    # Old jets settings. S3 serving of assets. Still need the configs.
+    config.assets.base_url = nil # IE: https://cloudfront.com/my/base/path
+    config.assets.cache_control = nil # IE: public, max-age=3600 , max_age is a shorter way to set cache_control.
+    config.assets.folders = %w[assets images packs files]
+    config.assets.max_age = 3600
+    config.assets.webpacker_asset_host = "s3_endpoint"  # true = use conventional by default
+
+    initializer "sprockets-jets-helpers" do |app|
+      ActiveSupport.on_load(:action_view) do
+        include Helper
+      end
+    end
+
+    initializer "sprockets-jets-mount-assets" do |app|
+      app.routes.prepend do
+        # Important: Env.build within block so it's lazy loaded. Otherwise, it
+        # may not use the correct config.assets.paths
+        sprockets_env = Env.build # Sprockets::Environment.new with config.assets.paths
+        mount sprockets_env => Jets.config.assets.prefix, internal: true # /assets
+      end
+    end
+
+    rake_tasks do
+      RakeTasks.load_tasks
+    end
+  end
+end

data/lib/sprockets/jets/env.rb

@@ -0,0 +1,26 @@
+module Sprockets::Jets
+  class Env
+    class << self
+      extend Memoist
+
+      def build
+        env = Sprockets::Environment.new
+
+        # Set any config.assets values that Sprockets::Environment accepts
+        Jets.config.assets.each do |key, value|
+          setter = :"#{key}="
+          if env.respond_to?(setter)
+            env.public_send(setter, value)
+          end
+        end
+        # Set paths
+        Jets.config.assets.paths.each do |path|
+          env.append_path(path)
+        end
+
+        env
+      end
+      memoize :build
+    end
+  end
+end

data/lib/sprockets/jets/helper.rb

@@ -0,0 +1,67 @@
+module Sprockets::Jets
+  module Helper
+    extend Memoist
+
+    # Writes over the built in ActionView::Helpers::AssetUrlHelper#compute_asset_path
+    # to use the asset pipeline.
+    def compute_asset_path(path, options = {})
+      if config_assets.use_precompiled
+        # Handle precompiled assets
+        manifest = Manifest.build # Sprockets::Manifest
+        digest_path = manifest.assets[path]
+      else
+        # Handle on-the-fly assets
+        env = Env.build # Sprockets::Environment
+        asset = env.find_asset(path) # returns #<Sprockets::Asset>
+        env_path = env[path]
+        if env_path.nil?
+          puts "ERROR: asset not found: path=#{path.inspect} env_path=#{env_path.inspect}".color(:yellow)
+          assets_paths = Jets.config.assets.paths.map {|p| "    #{p}" }.join("\n")
+          env_paths = env.paths.map {|p| "    #{p}" }.join("\n")
+          puts <<~EOL
+            Are you sure it exists in one of your asset paths?
+            Jets.config.assets.paths:
+
+            #{assets_paths}
+
+            Sprockets env.paths
+
+            #{env_paths}
+            EOL
+          raise AssetNotFound.new(asset_not_found_message(path))
+        end
+        digest_path = env_path.digest_path
+      end
+
+      if digest_path
+        assets_prefix = config_assets.prefix # /assets
+        asset_path = [assets_prefix, digest_path].join("/") # /assets/application-1e8f3a4e.css
+        # dont call super, otherwise it will add /stylesheets to the path
+        # IE: /stylesheets/application.css instead of
+        #     /assets/application-381287eca19f4d3ca6a8aa9ed68b8805d918bc26f4597e4f39e30f6259188840.css
+      else
+        raise AssetNotFound.new(asset_not_found_message(path))
+      end
+    end
+
+    def asset_not_found_message(path)
+      if config_assets.use_precompiled
+        <<~EOL
+          Precompiled asset not found for: #{path}
+          Please run:
+
+            jets assets:precompile
+
+          And restart the server
+        EOL
+      else
+        "Precompiled asset not found for: #{path}"
+      end
+    end
+
+    # Note: Cannot name config because it conflicts with an ActionView config method
+    def config_assets
+      Jets.config.assets
+    end
+  end
+end

data/lib/sprockets/jets/manifest.rb

@@ -0,0 +1,13 @@
+module Sprockets::Jets
+  class Manifest
+    class << self
+      extend Memoist
+
+      def build
+        env = Env.build # Sprockets::Environment
+        Sprockets::Manifest.new(env, "./public/assets")
+      end
+      memoize :build
+    end
+  end
+end

data/lib/sprockets/jets/rake_tasks.rb

@@ -0,0 +1,58 @@
+require 'sprockets'
+require 'rake/sprocketstask'
+
+module Sprockets::Jets
+  class RakeTasks < Rake::SprocketsTask
+    def define
+      namespace :assets do
+        %w( environment precompile clean clobber ).each do |task|
+          Rake::Task[task].clear if Rake::Task.task_defined?(task)
+        end
+
+        # Override this task change the loaded dependencies
+        desc "Load asset compile environment"
+        task :environment do
+          # Load full Jets environment by default
+          Rake::Task[:environment].invoke
+        end
+
+        desc "Compile all the assets named in config.assets.precompile"
+        task precompile: :environment do
+          with_logger do
+            manifest.compile(assets)
+          end
+        end
+
+        desc "Remove old compiled assets"
+        task :clean, [:keep] => :environment do |t, args|
+          with_logger do
+            manifest.clean(Integer(args.keep || self.keep))
+          end
+        end
+
+        desc "Remove compiled assets"
+        task clobber: :environment do
+          with_logger do
+            manifest.clobber
+          end
+        end
+      end
+    end
+
+    class << self
+      def load_tasks
+        new do |task|
+          task.environment = Env.build
+          task.output      = "public/assets"
+          task.assets = [ "manifest.js", "application.js" ]
+          task.assets += Jets.config.assets.precompile
+
+          # task.assets      = ["manifest.js"] # dont have to deal with backwards compatibility since this is a new gem
+          # See: https://github.com/rails/sprockets/blob/main/UPGRADING.md#manifestjs
+          # In Sprockets 4, the manifest file using the manifest.js is encouraged
+          # And using individual files like ["application.js", "application.css"] is discouraged.
+        end
+      end
+    end
+  end
+end

data/lib/sprockets/version.rb

@@ -0,0 +1,3 @@
+module Sprockets
+  VERSION = "0.1.0"
+end

data/lib/sprockets-jets.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.expand_path("../", __FILE__))
+
+require "sprockets/autoloader"
+Sprockets::Autoloader.setup
+
+require "memoist"
+require "rainbow/ext/string"
+require "sprockets"
+require "sprockets/jets/engine"
+
+module Sprockets::Jets
+  class Error < StandardError; end
+  class AssetNotFound < StandardError; end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+ENV["SPROCKETS_TEST"] = "1"
+
+# CodeClimate test coverage: https://docs.codeclimate.com/docs/configuring-test-coverage
+# require 'simplecov'
+# SimpleCov.start
+
+require "pp"
+require "byebug"
+root = File.expand_path("../", File.dirname(__FILE__))
+require "#{root}/lib/sprockets"
+
+module Helper
+end
+
+RSpec.configure do |c|
+  c.include Helper
+end

data/sprockets-jets.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sprockets/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sprockets-jets"
+  spec.version       = Sprockets::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+  spec.summary       = "Sprockets Jets Integration"
+  spec.homepage      = "https://github.com/rubyonjets/sprockets-jets"
+  spec.license       = "MIT"
+
+  spec.files         = File.directory?('.git') ? `git ls-files`.split($/) : Dir.glob("**/*")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "memoist"
+  spec.add_dependency "rainbow"
+  spec.add_dependency "sprockets", ">= 3.0.0"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: sprockets-jets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sprockets-jets.rb
+- lib/sprockets/autoloader.rb
+- lib/sprockets/jets/engine.rb
+- lib/sprockets/jets/env.rb
+- lib/sprockets/jets/helper.rb
+- lib/sprockets/jets/manifest.rb
+- lib/sprockets/jets/rake_tasks.rb
+- lib/sprockets/version.rb
+- spec/spec_helper.rb
+- sprockets-jets.gemspec
+homepage: https://github.com/rubyonjets/sprockets-jets
+licenses:
+- MIT
+metadata: {}
+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.4.20
+signing_key: 
+specification_version: 4
+summary: Sprockets Jets Integration
+test_files:
+- spec/spec_helper.rb