partial_inspector 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 477f232814bfb32f86217691b6f57d7cac11d35c968c615043c666c2d5bda1d9
-  data.tar.gz: 86db2c1e38e85b85ac2fb8e9116610d5807826bb98a6dee97c5f69363e144329
+  metadata.gz: 4da9f1dbf7e24e31a2ff0861e6a953077a40c3b8ddf8c32943b25b0dea006bac
+  data.tar.gz: be3e444cc43d7b41bb33806c426adeff4f155dce8d38273eac0a8241b8f52f84
 SHA512:
-  metadata.gz: 18f5c0bdf3eb999843868a165abfc12aa9d5775a6922c0171237f7063a43248ecea45c3dd7788cfdf7df11a9d1c46fce4ab832768973b5391126500b5a9e420a
-  data.tar.gz: 0bad6dc2b8d120877eacd910dc53f9ce7eeb1addbe23ba6348dbef7a2e379c0a0b01d019e9127c8ace1c2d6173702d00f528cc4db9c3a21cc0d73251ce017abb
+  metadata.gz: e6fea5f0e342ae64204796a40d9e210b3fbc9d61634d837be9f3adc0065d29dbb6c7f3ba70ebc175da071e321f80d453381ab2f17dfe73beec19e40e2e36e634
+  data.tar.gz: aab718cd76499900275cf18c41eba1ee46d6b5bf4d47648998d6b5bd73606265888bc22a8113805beedf32a2f7fc1dee58793422ea37f06d4256125c7e1a7584

data/README.md

@@ -1 +1,39 @@
 # Partial Inspector
+A tiny, developer-focused gem to help you find where your Rails partials are used.
+
+When working on large Rails projects, it's easy to lose track of where a partial is rendered throughout the codebase. **partial_inspector** scans your project and shows exactly which files render a given partial, making it much easier to refactor, test or remove unused partials confidently.
+
+## Installation
+
+```
+gem install partial_inspector
+```
+
+
+## How it works?
+1. Open irb
+2. Require the gem:
+      
+    ```
+   require "partial_inspector"
+     ```
+
+### Find where a partial is used
+1. Run the scanner:
+      
+   ```
+   PartialInspector.scanner.inspect_files_rendering_partial('path/to/partial')
+   ```
+2. Example Output
+   
+   <img width="803" alt="image" src="https://github.com/user-attachments/assets/9008c2c1-d6ea-4497-945b-1e47823208fc" />
+
+### Find unused partials
+1. Run the scanner:
+   
+   ```
+   PartialInspector.scanner.scan_unused_partials
+   ```
+
+
+

data/lib/partial_inspector/reporter.rb

@@ -1,8 +1,10 @@
-require_relative "utils"
+require_relative "used_partials"
+require_relative "unused_partials"
 
 module PartialInspector
   class Reporter
-    include PartialInspector::Utils
+    include PartialInspector::UsedPartials
+    include PartialInspector::UnusedPartials
 
     def report_files_rendering_partial(partial_path)
       files = base_scanner(partial_path)
@@ -27,24 +29,22 @@ module PartialInspector
       return
     end
 
-    private
-    def combine_unique_files(files)
-      results = {}
-      files.each do |file|
-        same_files = files.filter { |f| f[:file] == file[:file] }
+    def report_unused_partials
+      partials = inspect_unused_partials
+      unused_partials = partials[:unused_partials]
 
-        same_files.each do |same_file|
-          files.delete(same_file)
-          results[same_file[:file].to_sym] = [] if results[same_file[:file].to_sym] == nil
-          results[same_file[:file].to_sym] << { line_number: same_file[:line_number], line_content: file[:line_content] }
+      puts "\n\e[36mSEARCH SUMMARY\e[0m"
+      puts "\e[35mTOTAL PARTIALS\e[0m: \e[32m#{partials[:total_partials]}\e[0m"
+      puts "\e[35mUSED PARTIALS\e[0m: \e[32m#{partials[:used_partials]}\e[0m"
+      puts "\e[35mUNUSED PARTIALS\e[0m: \e[32m#{unused_partials.size}\e[0m"
+       
+      unless unused_partials.empty?
+        puts "\n\e[36mDETAILS\e[0m"
+        unused_partials.each do |partial|
+          puts partial
         end
       end
-
-      files.each do |file|
-        results[file[:file].to_sym] = [{ line_number: file[:line_number], line_content: file[:line_content] }]
-      end
-
-      results
+      return
     end
   end
 end

data/lib/partial_inspector/scanner.rb

@@ -8,6 +8,11 @@ module PartialInspector
       return
     end
 
+    def scan_unused_partials
+      puts reporter.report_unused_partials
+      return
+    end
+
     private
     def reporter
       PartialInspector::Reporter.new

data/lib/partial_inspector/unused_partials.rb

@@ -0,0 +1,73 @@
+require_relative 'utils'
+
+module PartialInspector
+  module UnusedPartials
+    include PartialInspector::Utils
+
+    private
+    def inspect_unused_partials
+      partials = Dir.glob("app/views/**/_*.*erb")
+      partial_paths_data = format_partial_paths_for_scanning(partials)
+      unused_partials = []
+      puts "\e[32mScanning...\e[0m\n"
+      partial_paths_data.each do |path_data|
+        unless full_path_used(path_data[:full_path]) || partial_name_used(path_data[:full_path])
+          unused_partials << path_data[:partial]
+        end
+      end
+
+      { 
+        total_partials: partials.size,
+        unused_partials: unused_partials,
+        used_partials: partials.size - unused_partials.size
+      }
+    end
+
+    def format_partial_paths_for_scanning(partials)
+      partial_paths_for_rendering = []
+      partials.each do |partial|
+        partial_paths_for_rendering << extract_complete_partial_path(partial)
+      end
+
+      partial_paths_for_rendering
+    end
+
+    def extract_complete_partial_path(partial)
+      full_path = partial.split('app/views/')[1]
+      formatted_path = ""
+      path_components = full_path.split('/')
+      path_components[-1] = extract_partial_name(path_components[-1])
+      path_components.each do |path_component|
+        formatted_path += "#{path_component}/"
+      end
+      formatted_path = formatted_path[0..-2] if formatted_path[-1] == '/'
+
+      { partial: partial, full_path: formatted_path, partial_name: path_components[-1] }
+    end
+
+    def full_path_used(partial_path)
+      files = Dir.glob("app/**/*.{rb,html.erb,js.erb,turbo_stream.erb}")
+      files.each do |file|
+        file_content = File.readlines(file)
+        file_content.each do |line|
+          return true if line.include?("'#{partial_path}'") || line.include?("\"#{partial_path}\"") 
+        end
+      end
+      return false
+    end
+  
+    def partial_name_used(partial_path)
+      partial_dir = build_partial_base_dir_path(partial_path)
+      partial_name = extract_partial_name(partial_path)
+  
+      files =  Dir.glob("app/views/#{partial_dir}*.*.erb")
+      files.each do |file|
+        file_content = File.readlines(file)
+        file_content.each do |line|
+          return true if line.include?("'#{partial_name}'") || line.include?("\"#{partial_name}\"") 
+        end
+      end
+      return false
+    end
+  end
+end

data/lib/partial_inspector/used_partials.rb

@@ -0,0 +1,125 @@
+require_relative 'utils'
+
+module PartialInspector
+  module UsedPartials
+    include PartialInspector::Utils
+
+    private
+    def base_scanner(partial_path)
+      return [] if partial_path.nil? || partial_path == ''
+      lines = []
+
+      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)
+            lines << {
+              file: file,
+              line_number: index + 1,
+              line_content: highlight_partial_form_content(partial_path, line.strip)
+            }
+          end
+        end
+      end
+
+      partial_dir = build_partial_base_dir_path(partial_path)
+      partial_name =  extract_partial_name(partial_path)
+
+      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|
+        path = path+"#{path_component}/"
+      end
+  
+      path[0..-2]
+    end
+
+    def check_partial_against_name(partial_dir, partial_name)
+      lines = []
+      
+      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)
+            lines << {
+              file: file,
+              line_number: index + 1,
+              line_content: highlight_partial_form_content(partial_name, line.strip)
+            }
+          end
+        end
+      end
+
+      lines
+    end
+
+    def highlight_partial_form_content(partial_path, content)
+      if content.include?("'#{partial_path}'")
+        content_components = content.split("'#{partial_path}'")
+        result = if content_components.size < 2
+                  content_components[0]+"\e[44m\e[32m'#{partial_path}'\e[0m\e[0m"
+                 else
+                  content_components[0]+"\e[44m\e[32m'#{partial_path}'\e[0m\e[0m"+content_components[1]
+                 end
+        return result
+      elsif content.include?("\"#{partial_path}\"")
+        content_components = content.split("\"#{partial_path}\"")
+        result = if content_components.size < 2
+                  content_components[0]+"\e[44m\e[32m\"#{partial_path}\"\e[0m\e[0m"
+                 else
+                  content_components[0]+"\e[44m\e[32m\"#{partial_path}\"\e[0m\e[0m"+content_components[1]
+                 end
+        return result
+      end
+    end
+
+    def combine_unique_files(files)
+      results = {}
+      files.each do |file|
+        same_files = files.filter { |f| f[:file] == file[:file] }
+
+        same_files.each do |same_file|
+          files.delete(same_file)
+          results[same_file[:file].to_sym] = [] if results[same_file[:file].to_sym] == nil
+          results[same_file[:file].to_sym] << { line_number: same_file[:line_number], line_content: file[:line_content] }
+        end
+      end
+
+      files.each do |file|
+        results[file[:file].to_sym] = [{ line_number: file[:line_number], line_content: file[:line_content] }]
+      end
+
+      results
+    end
+  end
+end

data/lib/partial_inspector/utils.rb

@@ -1,30 +1,7 @@
 module PartialInspector
   module Utils
-    private
-    def base_scanner(partial_path)
-      return [] if partial_path.nil? || partial_path == ''
-      lines = []
-
-      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)
-            lines << {
-              file: file,
-              line_number: index + 1,
-              line_content: highlight_partial_form_content(partial_path, line.strip)
-            }
-          end
-        end
-      end
-
-      partial_dir = build_partial_base_dir_path(partial_path)
-      partial_name =  extract_partial_name(partial_path)
-
-      lines + check_partial_against_name(partial_dir, partial_name)
-    end
 
+    private
     def extract_partial_file_name(partial_path)
       file_name = partial_path.split('/').last
       file_name
@@ -37,41 +14,6 @@ module PartialInspector
       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|
-        path = path+"#{path_component}/"
-      end
-  
-      path[0..-2]
-    end
-
     def build_partial_base_dir_path(partial_path)
       path_components = partial_path.split('/')
       path = ''
@@ -82,44 +24,5 @@ module PartialInspector
 
       path
     end
-
-    def check_partial_against_name(partial_dir, partial_name)
-      lines = []
-      
-      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)
-            lines << {
-              file: file,
-              line_number: index + 1,
-              line_content: highlight_partial_form_content(partial_name, line.strip)
-            }
-          end
-        end
-      end
-
-      lines
-    end
-
-    def highlight_partial_form_content(partial_path, content)
-      if content.include?("'#{partial_path}'")
-        content_components = content.split("'#{partial_path}'")
-        result = if content_components.size < 2
-                  content_components[0]+"\e[44m\e[32m'#{partial_path}'\e[0m\e[0m"
-                 else
-                  content_components[0]+"\e[44m\e[32m'#{partial_path}'\e[0m\e[0m"+content_components[1]
-                 end
-        return result
-      elsif content.include?("\"#{partial_path}\"")
-        content_components = content.split("\"#{partial_path}\"")
-        result = if content_components.size < 2
-                  content_components[0]+"\e[44m\e[32m\"#{partial_path}\"\e[0m\e[0m"
-                 else
-                  content_components[0]+"\e[44m\e[32m\"#{partial_path}\"\e[0m\e[0m"+content_components[1]
-                 end
-        return result
-      end
-    end
   end
 end

data/lib/partial_inspector/version.rb

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

data/lib/partial_inspector.rb

@@ -5,7 +5,6 @@ require_relative "partial_inspector/scanner"
 
 module PartialInspector
   class Error < StandardError; end
-  # Your code goes here...
 
   def self.scanner()
     PartialInspector::Scanner.new

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: partial_inspector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - SalihaShahid
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email:
 - salihashahid1102@gmail.com
 executables: []
@@ -22,6 +20,8 @@ files:
 - lib/partial_inspector.rb
 - lib/partial_inspector/reporter.rb
 - lib/partial_inspector/scanner.rb
+- lib/partial_inspector/unused_partials.rb
+- lib/partial_inspector/used_partials.rb
 - lib/partial_inspector/utils.rb
 - lib/partial_inspector/version.rb
 - sig/partial_inspector.rbs
@@ -29,7 +29,6 @@ homepage: https://github.com/SalihaShahid/partial_inspector
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -44,8 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Partial Inspector
 test_files: []