partial_inspector 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da9f1dbf7e24e31a2ff0861e6a953077a40c3b8ddf8c32943b25b0dea006bac
-  data.tar.gz: be3e444cc43d7b41bb33806c426adeff4f155dce8d38273eac0a8241b8f52f84
+  metadata.gz: b01271288a1127081cd52384cec35879907aa6bf778d9c16c30760e37d5df700
+  data.tar.gz: 503dea0d0f53e11ddcab09d73f6eda69e6cb65dd52bbcbd9007c3d24e6ac016c
 SHA512:
-  metadata.gz: e6fea5f0e342ae64204796a40d9e210b3fbc9d61634d837be9f3adc0065d29dbb6c7f3ba70ebc175da071e321f80d453381ab2f17dfe73beec19e40e2e36e634
-  data.tar.gz: aab718cd76499900275cf18c41eba1ee46d6b5bf4d47648998d6b5bd73606265888bc22a8113805beedf32a2f7fc1dee58793422ea37f06d4256125c7e1a7584
+  metadata.gz: c9ac5c9677eb732664821aa681e1fae7d6a7e35817371fd3f6b4a69e585e26fd5feaf4ecc9376c5f66211399c988c38379016fb571bdec1a84b2cd6404ae771f
+  data.tar.gz: d48cd66554591f92771c0fb9f1bdb26ec808ff66fc2ff6b20f17ae341c2cded972e2f6262017779ff9f6c8321b66f01bc5fadf4783300a73bcd515033b9ef532

data/README.md

@@ -34,6 +34,10 @@ gem install partial_inspector
    ```
    PartialInspector.scanner.scan_unused_partials
    ```
+2. Example Output
+
+   <img width="606" height="263" alt="image" src="https://github.com/user-attachments/assets/f7aef983-be65-4167-9703-810f29631a95" />
+
 
 
 

data/lib/partial_inspector/partial_tree.rb

@@ -0,0 +1,70 @@
+require_relative 'utils'
+
+module PartialInspector
+  module PartialTree
+    include PartialInspector::Utils
+
+    private
+    def data_to_build_tree(partial_path)
+      router(partial_path)
+    end
+
+    def router(path)
+      base_data = []
+      partial_path = path.split('/')[0]=='app' ? path.split('/')[2..-1].join('/') : path
+      files = find_base_files_rendering_partial(partial_path)
+      return [[path]] if files.empty?
+      files.each do |file|
+        if rendered_by_partial(file)
+          child_traces = router(file)
+          child_traces.each do |trace|
+            base_data << [path] + trace
+          end
+        else
+          base_data << [path, file]
+        end
+      end
+      base_data
+    end
+
+    def find_base_files_rendering_partial(partial_path)
+      return [] if partial_path.nil? || partial_path == ''
+      base_files = []
+
+      files = Dir.glob("app/**/*.{rb,html.erb,js.erb,turbo_stream.erb}")
+      files.each do |file|
+        file_content = File.readlines(file)
+        file_content.each_with_index do |line, index|
+          if (line.include?('render') || line.include?('partial:')) && check_partial_exists(line, partial_path)
+            base_files << file
+          end
+        end
+      end
+
+      partial_dir = build_partial_base_dir_path(partial_path)
+      partial_name =  extract_partial_name(partial_path)
+
+      base_files + find_base_files_rendering_partial_against_partial_name(partial_dir, partial_name)
+    end
+
+
+    def find_base_files_rendering_partial_against_partial_name(partial_dir, partial_name)
+      base_files = []
+
+      Dir.glob("app/views/#{partial_dir}*.*.erb").each do |file|
+        file_content = File.readlines(file)
+        file_content.each_with_index do |line, index|
+          if line.include?('render') && check_partial_exists(line, partial_name)
+            base_files << file
+          end
+        end
+      end
+
+      base_files
+    end
+
+    def rendered_by_partial(file)
+      file.split('/').last[0] == '_'
+    end
+  end
+end

data/lib/partial_inspector/reporter.rb

@@ -1,10 +1,12 @@
 require_relative "used_partials"
 require_relative "unused_partials"
+require_relative "partial_tree"
 
 module PartialInspector
   class Reporter
     include PartialInspector::UsedPartials
     include PartialInspector::UnusedPartials
+    include PartialInspector::PartialTree
 
     def report_files_rendering_partial(partial_path)
       files = base_scanner(partial_path)
@@ -46,5 +48,20 @@ module PartialInspector
       end
       return
     end
+
+    def report_partial_tree(partial_path)
+      paths = data_to_build_tree(partial_path)
+      paths.each_with_index do |path, index|
+          puts "\e[35mTREE #{index+1}\e[0m"
+          space = ""
+          path[1..-1].each do |sub_path|
+            puts "#{space}-> #{sub_path}"
+            space = space + "\t"
+          end
+          space=""
+          puts "\n"
+      end
+      return
+    end
   end
 end

data/lib/partial_inspector/scanner.rb

@@ -13,6 +13,11 @@ module PartialInspector
       return
     end
 
+    def inspect_partial_tree(partial_path)
+      puts reporter.report_partial_tree(partial_path)
+      return
+    end
+
     private
     def reporter
       PartialInspector::Reporter.new

data/lib/partial_inspector/used_partials.rb

@@ -29,32 +29,6 @@ module PartialInspector
       lines + check_partial_against_name(partial_dir, partial_name)
     end
 
-    def check_partial_exists(line, partial)
-      partial_path = ""
-      line_content = line.split(' ')
-      line_content.each_with_index do |value, index|
-        if line.include?("render partial:") && value == "render"
-          partial_path = line_content[index + 2]
-          break
-        elsif value == "render"
-          partial_path = line_content[index + 1]
-          break
-        elsif value == "partial:"
-          partial_path = line_content[index + 1]
-          break
-        end
-      end
-      if partial_path[0] == "\""
-        partial_path = partial_path[1..-2]
-        partial_path = partial_path[0..-2] if partial_path[-1] == '"'
-      elsif partial_path[0] == "'"
-        partial_path = partial_path[1..-2]
-        partial_path = partial_path[0..-2] if partial_path[-1] == "'"
-      end
-
-      partial_path == partial
-    end
-  
     def build_path(path_components)
       path = ''
       path_components.each do |path_component|

data/lib/partial_inspector/utils.rb

@@ -24,5 +24,31 @@ module PartialInspector
 
       path
     end
+
+    def check_partial_exists(line, partial)
+      partial_path = ""
+      line_content = line.split(' ')
+      line_content.each_with_index do |value, index|
+        if line.include?("render partial:") && value == "render"
+          partial_path = line_content[index + 2]
+          break
+        elsif value == "render"
+          partial_path = line_content[index + 1]
+          break
+        elsif value == "partial:"
+          partial_path = line_content[index + 1]
+          break
+        end
+      end
+      if partial_path[0] == "\""
+        partial_path = partial_path[1..-2]
+        partial_path = partial_path[0..-2] if partial_path[-1] == '"'
+      elsif partial_path[0] == "'"
+        partial_path = partial_path[1..-2]
+        partial_path = partial_path[0..-2] if partial_path[-1] == "'"
+      end
+
+      partial_path == partial
+    end
   end
 end

data/lib/partial_inspector/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PartialInspector
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: partial_inspector
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - SalihaShahid
@@ -18,6 +18,7 @@ files:
 - README.md
 - Rakefile
 - lib/partial_inspector.rb
+- lib/partial_inspector/partial_tree.rb
 - lib/partial_inspector/reporter.rb
 - lib/partial_inspector/scanner.rb
 - lib/partial_inspector/unused_partials.rb