bullet_train-themes 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b8f18381414981334281312835975fd93241577a4eff5fd85aece600fa76e3
-  data.tar.gz: 272efa679248e0957b78e05ca1b4e96e99924b8a49e98567d1247891c416d438
+  metadata.gz: b887cc1683a78e19df263a0ae451f8e926517bee14785408483a686f3e7045d2
+  data.tar.gz: 4634ae00490cd02fe0758bda07cade5370833fcf758a09ffe0db41d2a2189320
 SHA512:
-  metadata.gz: 7fa85c03a6e0dd87797097d8fad5f9f7af6a9b6675e89b300a90b220d87bec1798dea849a6a778b4deba4d835ad6f682eef32da234e1ee6cbc7cde91822479ed
-  data.tar.gz: faf92219a9b463333c271c402e0d4c143758bbe785e4679ae4e7ec09c191ee3b8781eb906370fdcac31429f33d10f10bd219772f4793c40e30021ea5d15e2741
+  metadata.gz: 075d43fa0fe5c2a52d88eda8835e645cb12efe6b5f78685db71bfb14f6b82a685ba12791f969859dabcaaae9a54db9ef09f7f956ccbfdd456f2ed38a4525175a
+  data.tar.gz: bf007da695280d3223471a6c43356bda55a71fd48acc973b3e19f4f4e9ba70b4004a3ed9c935e8446a9880acd0cb223c284bd11fadd3792f9bf152e177e84856

data/app/helpers/theme_helper.rb

@@ -1,19 +1,89 @@
-require_relative "../../lib/theme_partials"
-
 module ThemeHelper
-  include ThemePartials
+  # 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
-    THEME_DIRECTORY_ORDER.first
+    # Temporarily hardcoded. We actually don't want this to be just an `mattr_accessor` because the same application
+    # can use multiple themes. Need to think about this a bit.
+    :light
+  end
+
+  def current_theme_object
+    @current_theme_object ||= "BulletTrain::Themes::#{current_theme.to_s.classify}::Theme".constantize.new
   end
 
   def render(options = {}, locals = {}, &block)
+    # The theme engine only supports `<%= render 'shared/box' ... %>` style calls to `render`.
     if options.is_a?(String)
-      theme_partial = Resolver.resolve(options)
+      # Initialize a global variable that will cache all resolutions of a given path for the entire life of the server.
+      $resolved_theme_partial_paths ||= {}
 
-      return super theme_partial, locals, &block unless theme_partial.blank?
+      # 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]
+      end
     end
 
-    super
+    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.
+      return 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|
+            begin
+              # 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
+      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
   end
 end

data/lib/bullet_train/themes/version.rb

@@ -1,5 +1,5 @@
 module BulletTrain
   module Themes
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
   end
 end

data/lib/bullet_train/themes.rb

@@ -3,6 +3,6 @@ require "bullet_train/themes/engine"
 
 module BulletTrain
   module Themes
-    # Your code goes here...
+    mattr_accessor :themes, default: {}
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet_train-themes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Andrew Culver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -65,7 +65,6 @@ files:
 - lib/bullet_train/themes/engine.rb
 - lib/bullet_train/themes/version.rb
 - lib/tasks/bullet_train/themes_tasks.rake
-- lib/theme_partials.rb
 homepage: https://github.com/bullet-train-co/bullet_train-themes
 licenses:
 - MIT

data/lib/theme_partials.rb

@@ -1,97 +0,0 @@
-module ThemePartials
-  # TODO This needs to be configurable now that we've moved this file upstream.
-  # TODO Also, this feels almost like it should be set on a per-request basis, since you can have more than one theme
-  # in an app at a time.
-  THEME_DIRECTORY_ORDER = [
-    "light",
-    "tailwind",
-    "base",
-  ]
-
-  INCLUDE_TARGETS = [
-    # ❌ 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"
-  ]
-
-  # i.e. Changes "account/shared/box" to "account/shared/_box"
-  def convert_to_literal_partial(path)
-    path.sub(/.*\K\//, "/_")
-  end
-
-  # i.e. Changes "account/shared/_box" to "_box"
-  def remove_hierarchy_base(path, include_target)
-    path.sub(/^#{include_target}\//, "")
-  end
-
-  # i.e. Get "app/views/themes/light/_box.html.erb" from "_box"
-  def get_full_debased_file_path(path, theme_directory)
-    "app/views/themes/#{theme_directory}/#{path}.html.erb"
-  end
-
-  # Adds a hierarchy with a specific theme to a partial.
-  # i.e. Changes "workflow/box" to "themes/light/workflow/box"
-  def add_hierarchy_to_path(file_path, theme_directory)
-    "themes/#{theme_directory}/#{file_path}"
-  end
-
-  class Resolver
-    extend ThemePartials
-
-    # This global variable is created once per application boot.
-    # We're not using the Rails caching system because we want everything in local memory for this.
-    # If we use the Rails caching system, we end up querying it over the wire from Redis or memcached.
-    $resolved_theme_partials = {}
-
-    def self.base_path_for(theme)
-      begin
-        "BulletTrain::Themes::#{theme.to_s.classify}::PathSnitch".constantize.method(:confess).source_location.first.split("/lib/bullet_train/themes/").first
-      rescue NameError => _
-        nil
-      end
-    end
-
-    def self.resolve(options)
-      INCLUDE_TARGETS
-        .filter { |include_target| options.start_with? include_target }
-        .each do |include_target|
-        # If the partial path has already been resolved since boot, just return that value.
-        # This caching is not enabled in development so people can introduce new files without restarting.
-        unless Rails.env.development?
-          if $resolved_theme_partials[options]
-            return $resolved_theme_partials[options]
-          end
-        end
-
-        # Otherwise, we need to traverse the inheritance structure of the themes to find the right partial.
-        debased_file_path = remove_hierarchy_base(options, include_target)
-        normal_file_path = convert_to_literal_partial(options)
-
-        # TODO this is a hack because the main menu is still in this directory
-        # and other people might also add stuff there.
-        unless File.exist?("#{Rails.root}/app/views/#{normal_file_path}.html.erb")
-          THEME_DIRECTORY_ORDER.each do |theme_directory|
-            # First we check whether it's defined in the actual application. This takes precedence.
-            full_debased_file_path = convert_to_literal_partial(get_full_debased_file_path(debased_file_path, theme_directory))
-
-            actual_file_path = [
-              Rails.root,
-              # This will return nil if the theme isn't distributed as a Ruby gem.
-              base_path_for(theme_directory),
-            ].compact.map { |path| "#{path}/#{full_debased_file_path}" }.detect { |file| File.exist?(file) }
-
-            if actual_file_path
-              # Once we've found it, ensure we don't do this again for the same partial.
-              $resolved_theme_partials[options] = add_hierarchy_to_path(debased_file_path, theme_directory)
-              return $resolved_theme_partials[options]
-            end
-          end
-        end
-      end
-
-      nil
-    end
-  end
-end