polaris_view_components 0.13.5 → 1.0.0

data/lib/polaris/view_components/codemods/v3_slot_setters.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+module Polaris
+  module ViewComponents
+    # Usage:
+    #
+    # Run via rake task:
+    #
+    #     bin/rails polaris_view_components:detect_legacy_slots
+    #     bin/rails polaris_view_components:migrate_legacy_slots
+    #     bin/rails polaris_view_components:migrate_legacy_slots app/views
+    #
+    # Or run via rails console if you need to pass custom paths:
+    #
+    #     Polaris::ViewComponents::Codemods::V3SlotSetters.new(
+    #       view_path: Rails.root.join("app/views"),
+    #     ).call
+    module Codemods
+      class V3SlotSetters
+        TEMPLATE_LANGUAGES = %w[erb slim haml].join(",").freeze
+        RENDER_REGEX = /render[( ](?<component>\w+(?:::\w+)*)\.new[) ]+(do|\{) \|(?<arg>\w+)\b/ # standard:disable Lint/MixedRegexpCaptureTypes
+
+        Suggestion = Struct.new(:file, :line, :message)
+
+        def initialize(view_component_path: [], view_path: [], migrate: false)
+          Rails.application.eager_load!
+
+          @view_component_path = view_component_path
+          @view_path = view_path
+          @migrate = migrate
+        end
+
+        def call
+          puts "Using ViewComponent path: #{view_component_paths.join(", ")}"
+          puts "Using Views path: #{view_paths.join(", ")}"
+          puts "#{view_components.size} ViewComponents found"
+          puts "#{slottable_components.size} ViewComponents using Slots found"
+          puts "#{view_component_files.size} ViewComponent templates found"
+          puts "#{view_files.size} view files found"
+          process_all_files
+        end
+
+        def process_all_files
+          all_files.each do |file|
+            process_file(file)
+          end
+        end
+
+        def process_file(file)
+          @suggestions = []
+          @suggestions += scan_exact_matches(file)
+          @suggestions += scan_uncertain_matches(file)
+
+          if @suggestions.any?
+            puts
+            puts "File: #{file}"
+            @suggestions.each do |s|
+              puts "=> line #{s.line}: #{s.message}"
+            end
+          end
+        end
+
+        private
+
+        def scan_exact_matches(file)
+          [].tap do |suggestions|
+            rendered_components = []
+            content = File.read(file)
+
+            if (render_match = content.match(RENDER_REGEX))
+              component = render_match[:component]
+              arg = render_match[:arg]
+
+              if registered_slots.key?(component.constantize)
+                used_slots_names = registered_slots[component.constantize]
+                rendered_components << {component: component, arg: arg, slots: used_slots_names}
+              end
+            end
+
+            File.open(file, "r+") do |f|
+              lines = []
+              f.each_line do |line|
+                rendered_components.each do |rendered_component|
+                  arg = rendered_component[:arg]
+                  slots = rendered_component[:slots]
+
+                  if (matches = line.scan(/#{arg}\.#{Regexp.union(slots)}/))
+                    matches.each do |match|
+                      new_value = match.gsub("#{arg}.", "#{arg}.with_")
+                      message = if @migrate
+                        "replaced `#{match}` with `#{new_value}`"
+                      else
+                        "probably replace `#{match}` with `#{new_value}`"
+                      end
+                      suggestions << Suggestion.new(file, f.lineno, message)
+                      if @migrate
+                        line.gsub!("#{arg}.", "#{arg}.with_")
+                      end
+                    end
+                  end
+                end
+                lines << line
+              end
+
+              if @migrate
+                f.rewind
+                f.write(lines.join)
+              end
+            end
+          end
+        end
+
+        def scan_uncertain_matches(file)
+          [].tap do |suggestions|
+            File.open(file, "r+") do |f|
+              lines = []
+              f.each_line do |line|
+                if (matches = line.scan(/(?<!\s)\.(?<slot>#{Regexp.union(all_registered_slot_names)})\b/))
+                  matches.flatten.each do |match|
+                    next if @suggestions.find { |s| s.file == file && s.line == f.lineno }
+
+                    message = if @migrate
+                      "replaced `#{match}` with `with_#{match}`"
+                    else
+                      "maybe replace `#{match}` with `with_#{match}`"
+                    end
+                    suggestions << Suggestion.new(file, f.lineno, message)
+                    if @migrate
+                      line.gsub!(/(?<!\s)\.(#{match})\b/, ".with_\\1")
+                    end
+                  end
+                end
+                lines << line
+              end
+
+              if @migrate
+                f.rewind
+                f.write(lines.join)
+              end
+            end
+          end
+        end
+
+        def view_components
+          ViewComponent::Base.descendants
+        end
+
+        def slottable_components
+          view_components.select do |comp|
+            comp.registered_slots.any?
+          end
+        end
+
+        def registered_slots
+          @registered_slots ||= {}.tap do |slots|
+            puts
+            puts "Detected slots:"
+            slottable_components.each do |comp|
+              puts "- `#{comp}` has slots: #{comp.registered_slots.keys.join(", ")}"
+              slots[comp] = comp.registered_slots.map do |slot_name, slot|
+                normalized_slot_name(slot_name, slot)
+              end
+            end
+          end
+        end
+
+        def all_registered_slot_names
+          @all_registered_slot_names ||= registered_slots.values.flatten.uniq
+        end
+
+        def view_component_files
+          Dir.glob(Pathname.new(File.join(view_component_path_glob, "**", "*.{rb,#{TEMPLATE_LANGUAGES}}")))
+        end
+
+        def view_files
+          Dir.glob(Pathname.new(File.join(view_path_glob, "**", "*.{#{TEMPLATE_LANGUAGES}}")))
+        end
+
+        def all_files
+          view_component_files + view_files
+        end
+
+        def view_component_paths
+          @view_component_paths ||= [
+            Rails.application.config.view_component.view_component_path,
+            @view_component_path
+          ].flatten.compact.uniq
+        end
+
+        def view_component_path_glob
+          return view_component_paths.first if view_component_paths.size == 1
+
+          "{#{view_component_paths.join(",")}}"
+        end
+
+        def rails_view_paths
+          ActionController::Base.view_paths.select do |path|
+            path.to_s.include?(Rails.root.to_s)
+          end.map(&:to_s)
+        end
+
+        def view_paths
+          @view_paths ||= [
+            rails_view_paths,
+            Rails.application.config.view_component.preview_paths,
+            @view_path
+          ].flatten.compact.uniq
+        end
+
+        def view_path_glob
+          return view_paths.first if view_paths.size == 1
+
+          "{#{view_paths.join(",")}}"
+        end
+
+        def normalized_slot_name(slot_name, slot)
+          slot[:collection] ? ActiveSupport::Inflector.singularize(slot_name) : slot_name.to_s
+        end
+      end
+    end
+  end
+end

data/lib/polaris/view_components/engine.rb

@@ -1,9 +1,6 @@
 require "rails/engine"
 require "view_component"
 require "view_component/version"
-if ViewComponent::VERSION::MAJOR == 2 && ViewComponent::VERSION::MINOR < 43
-  require "view_component/engine"
-end
 
 module Polaris
   module ViewComponents

data/lib/polaris/view_components/version.rb

@@ -1,5 +1,5 @@
 module Polaris
   module ViewComponents
-    VERSION = "0.13.5"
+    VERSION = "1.0.0"
   end
 end

data/lib/tasks/polaris_view_components_tasks.rake

@@ -1,6 +1,20 @@
+require "polaris/view_components/codemods/v3_slot_setters"
+
 namespace :polaris_view_components do
   desc "Setup Polaris::ViewComponents for the app"
   task :install do
     system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb", __dir__)}"
   end
+
+  task detect_legacy_slots: :environment do
+    ARGV.each { |a| task a.to_sym {} }
+    custom_paths = ARGV.compact.map { |path| Rails.root.join(path) }
+    Polaris::ViewComponents::Codemods::V3SlotSetters.new(view_path: custom_paths).call
+  end
+
+  task migrate_legacy_slots: :environment do
+    ARGV.each { |a| task a.to_sym {} }
+    custom_paths = ARGV.compact.map { |path| Rails.root.join(path) }
+    Polaris::ViewComponents::Codemods::V3SlotSetters.new(view_path: custom_paths, migrate: true).call
+  end
 end