card-mod-assets 0.15.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f28b495e0d136c8e5f45b1c19bc922ba6da1ba0b33f9478c6efbfc5dd4cd22b0
-  data.tar.gz: 83b8529f49f06ef20b4a9e458e32694650174dc437952ce46885657a6f15ed38
+  metadata.gz: 25621c837fd7effe9227d019d92fb0cf73c8892b4a9e77b3723a9d160f0457c7
+  data.tar.gz: 205c3ebcfcd1a77cbe48a4f7649a64e9bc7a2aa69fd3913cc8839fbb08623187
 SHA512:
-  metadata.gz: c09c79ed6edf0c58b9c46ff5608187c3bcc19bd810b5ac1d06078b822655f0c418a4e3148a8a44ea178a91324473f99f651c2edb3dc6c2e4d5cd241d1371ec14
-  data.tar.gz: 2948211e42bc9578afa028581a57d08d8d8f6d21c7a48e2292c8b634bfed9eeda894751747a9abb86c62ae42ab8fb32f6f4fdbfbf5eebdb27662c3162abfec87
+  metadata.gz: 93bb6a14918c6b702fb18985966a00628383b68453572545949b402e44c142b22ab580a2ecf021a2ecb74718f8a950005f7e7915d839a26b23095a9603835f50
+  data.tar.gz: 79e3353ed13b1c8320f6f8525a171b16252a96d7f8639d1cbc1eda9a7b1bb9ba0645a1e28234b5d1a335e36beb1505906e52a7b356645a5fc90a72122a97f62b

data/README.md

@@ -0,0 +1,114 @@
+<!--
+# @title README - mod: assets
+-->
+
+# Assets mod
+
+This mod unifies handling of styles (CSS, SCSS, etc) and scripts
+(JavaScript, CoffeeScript, etc).
+
+For both styles and scripts, the idea is to output optimized files for
+browser caching and thus improve users' experience by reducing loading times. In other
+words, we use a wide variety of asset sources to assemble a ready-for-prime-time
+.js and .css files.
+
+There are two main kinds of cards in the asset pipeline: inputters (where
+the code comes from) and outputters (where it ends up).
+
+## Inputters
+
+Inputters are can be created in multiple ways:
+
+1. By adding code to the assets directory in a mod
+2. By adding remote and/or local assets to a manifest.yml file
+3. By combining other inputters
+4. By directly creating cards of an inputter type
+
+### adding code to the assets directory
+
+Each mod can have an `assets` directory with `style` and `script` subdirectories.
+By adding CSS or SCSS files to `assets/style` (or JavaScript or CoffeeScript
+files to `assets/script`) to a mod in use, your code will automatically be included
+in standard asset output.
+
+After adding the first asset to a mod, you may need to run `rake card:mod:install` (or
+the more comprehensive `decko update`) for the change to take effect. Otherwise,
+everything should pretty much handle itself.
+
+By default, the load order within a mod is alphabetical, and the load order across mods
+is governed by the mod load order, which can be seen using `rake card:mod:list`.
+
+### using manifest.yml files
+
+If you want to customize the load order of asset files, you can add a `manifest.yml`
+file to `assets/style` or `assets/script`.
+
+For example, consider these lines from the manifest.yml file in the bootstrap mod:
+
+    libraries:
+      items:
+        - font_awesome.css
+        - material_icons.css
+        - bootstrap_colorpicker.scss
+        - ../../vendor/bootstrap-colorpicker/src/sass/_colorpicker.scss
+
+The word `libraries` is an arbitrary name for the manifest group; you can use any name
+(other than `remote`) as long as it isn't duplicated in the file. The `items` specify
+the load order for this manifest group.
+
+Note that the manifest also makes it possible to include source files that are not in
+the assets directory using relative path references.
+
+Manifests also make it possible to include remote files. For example:
+
+    remote:
+      items:
+        - src: https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.6-rc.1/js/select2.full.min.js
+          integrity: ...
+          referrerpolicy: no-referrer
+          crossorigin: anonymous
+
+### combining other inputters
+
+There are various special cards that combine inputters and are inputters themselves:
+
+- the `:style_mods` card contains all the standard assets from mods' asset directories
+- _Skin_ cards combine a particular set of styles
+- `(Mod)+:style` and `(Mod)+:script` assemble the assets for a given mod
+
+### creating inputter cards
+
+Many Cardtypes are coded to be inputters. If you create a card with the type CSS,
+for example, it will automatically be treated as an inputter. The same goes for SCSS,
+CoffeeScript, and JavaScript cards. (In code terms, this is achieved by having those
+sets include the `Abstract::AssetInputter` set).
+
+Because these cards are intended for Sharks, they are predominantly documented on
+decko.org
+
+## Outputters
+
+Outputters produce the final asset (.js and .css) files delivered to users' browsers.
+
+They work slightly differently with style and script cards. JavaScript (.js) output is
+produced on a mod-by-mod basis. The `:all+:script` rule maintains a list of all mods
+with script inputters, and output is produced for each mod that assembles all the
+javascript for that mod. The output is managed with a file card using the name pattern
+`MOD+:asset_ouput`
+
+With style cards, SCSS variables are often shared across many mods, so the output CSS
+cannot be constructed on a mod-by-mod basis; it has to be generated across all mods at
+once. Thus the site's main CSS is served as a single file associated with `:all+:style`,
+which typically points to a skin card. The output is managed as a file card at
+`:all+:style+:asset_output`.
+
+### generating output from input
+
+For each inputter, we generate a VirtualCache card following this pattern:
+`(Inputter)+:asset_input`. This card processes the inputs as much as it safely can.
+For example, SCSS cards cannot be converted to CSS here, because they often
+involve variables that must be used by other inputters.
+
+When changes to inputters are detected, they trigger changes to all inputters and
+outputters that depend on them.
+

data/lib/tasks/card/assets.rake

@@ -0,0 +1,20 @@
+namespace :card do
+  namespace :assets do
+    desc "regenerate asset outputs"
+    task refresh: :environment do
+      Card::Assets.refresh force: true
+    end
+
+    desc "update coded asset outputs"
+    task code: :environment do
+      Cardio.config.compress_assets = true
+      Card::Cache.reset_all
+      Card::Assets.make_output_coded
+    end
+
+    desc "delete all cached asset outputs and inputs"
+    task wipe: :environment do
+      Card::Assets.wipe
+    end
+  end
+end

data/set/abstract/asset_file.rb

@@ -59,7 +59,7 @@ format :html do
   end
 
   def short_content
-    fa_icon("exclamation-circle", class: "text-muted pe-2") +
+    icon_tag(:warning, class: "text-muted pe-2") +
       wrap_with(:span, "asset file", class: "text-muted")
   end
 end

data/set/abstract/asset_inputter.rb

@@ -12,11 +12,13 @@ def referers_responding_to method_name
   referers.select { |referer| referer.respond_to? method_name }
 end
 
-event :asset_input_changed, :finalize, on: :save, skip: :allowed do
+event :asset_input_changed, :finalize,
+      on: :save, when: :asset_inputter?, skip: :allowed do
   update_asset_input
 end
 
-event :asset_input_changed_on_delete, :finalize, on: :delete, before: :clear_references do
+event :asset_input_changed_on_delete, :finalize,
+      on: :delete, when: :asset_inputter?, before: :clear_references do
   update_referers_after_input_changed
 end
 
@@ -39,13 +41,13 @@ def update_asset_input
 end
 
 def asset_input_content
-  return render_asset_input_content if virtual?
+  return assemble_asset_input_content if virtual?
   update_asset_input if asset_input.blank?
   asset_input
 end
 
-def render_asset_input_content
-  format(input_format).render(input_view)
+def assemble_asset_input_content
+  format(input_format).render input_view
 end
 
 def input_view
@@ -64,6 +66,11 @@ def asset_input_needs_refresh?
   false
 end
 
+# for override
+def asset_inputter?
+  true
+end
+
 format :html do
   def edit_success
     { reload: true }

data/set/abstract/mod_assets.rb

@@ -80,6 +80,7 @@ def manifest_group_minimize? group_name
 end
 
 def manifest
+  # FIXME: sometimes this needs to get cleared!
   @manifest ||= load_manifest
 end
 

data/set/right/asset_input.rb

@@ -1,7 +1,7 @@
 include_set Abstract::VirtualCache
 
 def virtual_content
-  left.render_asset_input_content
+  left.assemble_asset_input_content
 end
 
 def history?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: card-mod-assets
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Ethan McCutchen
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: card
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.105.0
+        version: 1.105.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.105.0
+        version: 1.105.1
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
@@ -52,70 +52,70 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: card-mod-format
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: card-mod-list
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: card-mod-carrierwave
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: card-mod-content
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.15.1
 description: ''
 email:
 - info@decko.org
@@ -123,11 +123,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- config/locales/de.yml
+- config/locales/en.yml
 - data/real.yml
 - db/migrate_core_cards/202108028112352_death_to_machines.rb
 - lib/card/assets.rb
-- locales/de.yml
-- locales/en.yml
+- lib/tasks/card/assets.rake
 - set/abstract/01_manifest_group.rb
 - set/abstract/asset_file.rb
 - set/abstract/asset_group.rb