bullet_train-themes 1.0.21 → 1.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0c18f9c1c13209675d75ec7aea4fe1ab8c757274ea1946039ae6513a39972d
-  data.tar.gz: 855ec82140585d5a9a3bafe0539350e303b80881d1a742a333e743171254e60e
+  metadata.gz: 685b92afad2e422cdc06cca2443590eaa4d845b865199afca11889494680230f
+  data.tar.gz: 10a9416768d934e69ed1105dcf1d5ce3170a1e60d71612a5901766510f92976d
 SHA512:
-  metadata.gz: 5650aba384c318717a4e98d9808621a3adc4e8458c8526d7d8a77c82b65163bdbb679de6761d50a4a71437cb0dfff0b7f77c22e19332a5d49427b790324d1d4c
-  data.tar.gz: ab42ae6102b2960bed7421ec0a4fa107bce9c8f1dad0b08de564718003fe5ee9faf2e21b1cf4b687817576895559c9d9e9f34bd74bd4ad13bbc208b23b8b5da7
+  metadata.gz: 5500669ce576dcd48a105791dd4a98719cc311a80b2586f46e959f44533bf63abf76cee9fb4b53ee6f1f6f190e26a3441d0464a95550ce6ccefe68df43d39108
+  data.tar.gz: 8fde38b8386af1698559268a4766361d834bc781013b2653bdc29cd14da0f1f0d3154480e2cef64425ae69e9a6d64b90f4f108b78005b63639960712c334a89a

data/app/helpers/theme_helper.rb

@@ -1,81 +1,57 @@
-module ThemeHelper
-  # TODO Do we want this to be configurable by downstream applications?
-  INVOCATION_PATTERNS = [
-    # ❌ This path is included for legacy purposes, but you shouldn't reference partials like this in new code.
-    /^account\/shared\//,
-
-    # ✅ This is the correct path to generically reference theme component partials with.
-    /^shared\//,
-  ]
-
-  def current_theme_object
-    @current_theme_object ||= "BulletTrain::Themes::#{current_theme.to_s.classify}::Theme".constantize.new
-  end
+# Our custom devise views are housed in `bullet_train-base`, but they're overwritten
+# by devise's standard views if the devise gem is declared after `bullet_train`.
+# To ensure we use our custom views, we temporarily unregister the original devise
+# views path from the FileSystemResolver, add our custom path, and find the views that way.
+module ActionView
+  class LookupContext
+    module ViewPaths
+      def find(name, prefixes = [], partial = false, keys = [], options = {})
+        name, prefixes = normalize_name(name, prefixes)
+        details, details_key = detail_args_for(options)
+
+        devise_view = false
+        prefixes.each do |prefix|
+          if prefix.match?(/devise/)
+            devise_view = true
+            break
+          end
+        end
 
-  def render(options = {}, locals = {}, &block)
-    # The theme engine only supports `<%= render 'shared/box' ... %>` style calls to `render`.
-    if options.is_a?(String)
-      # Initialize a global variable that will cache all resolutions of a given path for the entire life of the server.
-      $resolved_theme_partial_paths ||= {}
+        resolver = if name == "devise" || devise_view
+          original_devise_view_path = BulletTrain::Themes::Light.original_devise_path
+          bullet_train_resolver = @view_paths.paths.reject do |resolver|
+            resolver.path.match?(original_devise_view_path)
+          end
+          PathSet.new(bullet_train_resolver)
+        else
+          @view_paths
+        end
 
-      # Check whether we've already resolved this partial to render from another path before.
-      # If we've already resolved this partial from a different path before, then let's just skip to that.
-      # TODO This should be disabled in development so new templates are taken into account without restarting the server.
-      if $resolved_theme_partial_paths[options]
-        # Override the value in place. This will be respected when we call `super` below.
-        options = $resolved_theme_partial_paths[options]
+        resolver.find(name, prefixes, partial, details, details_key, keys)
       end
+      alias_method :find_template, :find
     end
+  end
+end
 
-    begin
-      # This is where we try to just lean on Rails default behavior. If someone renders `shared/box` and also has a
-      # `app/views/shared/_box.html.erb`, then no error will be thrown and we will have never interfered in the normal
-      # Rails behavior.
-      #
-      # We also don't do anything special if someone renders `shared/box` and we've already previously resolved that
-      # partial to be served from `themes/light/box`. In that case, we've already replaced `shared/box` with the
-      # actual path of the partial, and Rails will do the right thing from this point.
-      #
-      # However, if one of those two situations isn't true, then this call here will throw an exception and we can
-      # perform the appropriate magic to figure out where amongst the themes the partial should be rendering from.
-      super
-    rescue ActionView::MissingTemplate => exception
-      # The theme engine only supports `<%= render 'shared/box' ... %>` style calls to `render`.
-      if options.is_a?(String)
-
-        # Does the requested partial path match one of the invocation regexes?
-        if (invocation_pattern = INVOCATION_PATTERNS.detect { |regex| options.match?(regex) })
-          # Keep track of the original options.
-          original_options = options
-
-          # Trim out the base part of the requested partial.
-          requested_partial = options.gsub(invocation_pattern, "")
-
-          # TODO We're hard-coding this for now, but this should probably come from the `Current` model.
-          current_theme_object.directory_order.each do |theme_path|
-            # Update our options from something like `shared/box` to `themes/light/box`.
-            options = "themes/#{theme_path}/#{requested_partial}"
-
-            # Try rendering the partial again with the updated options.
-            body = super
-
-            # 🏆 If we get this far, then we've found the actual path of the theme partial. We should cache it!
-            $resolved_theme_partial_paths[original_options] = options
-
-            # We also need to return whatever the rendered body was.
-            return body
-
-          # If calling `render` with the updated options is still resulting in a missing template, we need to
-          # keep iterating over `directory_order` to work our way up the theme stack and see if we can find the
-          # partial there, e.g. going from `light` to `tailwind` to `base`.
-          rescue ActionView::MissingTemplate => _
-            next
-          end
-        end
-      end
+module ThemeHelper
+  def current_theme_object
+    BulletTrain::Themes.themes[current_theme]
+  end
 
-      # If we weren't able to find the partial in some theme-based place, then just let the original error bubble up.
-      raise exception
-    end
+  def render(options = {}, locals = {}, &block)
+    options = current_theme_object.resolved_partial_path_for(@lookup_context, options, locals) || options
+
+    # This is where we try to just lean on Rails default behavior. If someone renders `shared/box` and also has a
+    # `app/views/shared/_box.html.erb`, then no error will be thrown and we will have never interfered in the normal
+    # Rails behavior.
+    #
+    # We also don't do anything special if someone renders `shared/box` and we've already previously resolved that
+    # partial to be served from `themes/light/box`. In that case, we've already replaced `shared/box` with the
+    # actual path of the partial, and Rails will do the right thing from this point.
+    #
+    # However, if one of those two situations isn't true, then this call here will throw an exception and we can
+    # perform the appropriate magic to figure out where amongst the themes the partial should be rendering from.
+    super
   end
 end

data/app/views/themes/base/attributes/_text.html.erb

@@ -1,9 +1,10 @@
 <% object ||= current_attributes_object %>
 <% strategy ||= current_attributes_strategy || :none %>
 <% url ||= nil %>
+<% options ||= {} %>
 
 <% if object.send(attribute).present? %>
   <%= render 'shared/attributes/attribute', object: object, attribute: attribute, strategy: strategy, url: url do %>
-    <%= object.send(attribute) %>
+    <%= options[:password] ? "●" * object.send(attribute).length : object.send(attribute) %>
   <% end %>
 <% end %>

data/app/views/themes/base/fields/_super_select.html.erb

@@ -7,7 +7,7 @@ form ||= current_fields_form
 options ||= {}
 other_options ||= {}
 html_options ||= {}
-html_options[:id] ||= id_for(form, method)
+html_options[:id] ||= form.field_id(method)
 html_options[:class] = "form-control select2 #{html_options[:class]}".strip
 choices_url ||= nil
 if choices_url.nil?
@@ -26,7 +26,8 @@ wrapper_options = { data: { controller: stimulus_controller }}
 wrapper_options[:data]["#{stimulus_controller}-enable-search-value"] = true if other_options[:search]
 wrapper_options[:data]["#{stimulus_controller}-accepts-new-value"] = true if other_options[:accepts_new]
 wrapper_options[:data]["#{stimulus_controller}-search-url-value"] = choices_url if choices_url.present?
-html_options[:data] = { "#{stimulus_controller}-target": 'select' }
+html_options[:data] ||= {}
+html_options[:data].merge!("#{stimulus_controller}-target": 'select')
 
 %>
 

data/lib/bullet_train/themes/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Themes
-    VERSION = "1.0.21"
+    VERSION = "1.0.22"
   end
 end

data/lib/bullet_train/themes.rb

@@ -7,11 +7,41 @@ module BulletTrain
     mattr_accessor :themes, default: {}
     mattr_accessor :logo_height, default: 54
 
+    mattr_reader :partial_paths, default: {}
+
+    # TODO Do we want this to be configurable by downstream applications?
+    INVOCATION_PATTERNS = [
+      # ❌ This path is included for legacy purposes, but you shouldn't reference partials like this in new code.
+      /^account\/shared\//,
+
+      # ✅ This is the correct path to generically reference theme component partials with.
+      /^shared\//,
+    ]
+
+    def self.theme_invocation_path_for(path)
+      # Themes only support `<%= render 'shared/box' ... %>` style calls to `render`, so check `path` is a string first.
+      if path.is_a?(String) && (pattern = INVOCATION_PATTERNS.find { _1.match? path })
+        path.remove(pattern)
+      end
+    end
+
     module Base
       class Theme
         def directory_order
           ["base"]
         end
+
+        def resolved_partial_path_for(lookup_context, path, locals)
+          # TODO This caching should be disabled in development so new templates are taken into account without restarting the server.
+          BulletTrain::Themes.partial_paths.fetch(path) do
+            if (theme_path = BulletTrain::Themes.theme_invocation_path_for(path))
+              # TODO directory_order should probably come from the `Current` model.
+              if (partial = lookup_context.find_all(theme_path, directory_order.map { "themes/#{_1}" }, true, locals.keys).first)
+                BulletTrain::Themes.partial_paths[path] = partial.virtual_path.gsub("/_", "/")
+              end
+            end
+          end
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-themes
 version: !ruby/object:Gem::Version
-  version: 1.0.21
+  version: 1.0.22
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-25 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standard