partial_finder 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2829293afb5eb8e9b04ebd9a69aad5156bf2f3a6c0124cb2242942dc08dbb6c
+  data.tar.gz: 7f023fefc32b9233557a5dfd3887bc9f617a86bfcc62a27a0dada85922c63c42
+SHA512:
+  metadata.gz: 5c807fdddf4dda8fbaa87429266829bd5828e139ebb2a1d8e452b00c91f5e90181dc160f295e03ce946b379baa359e02d0e68293e3c17dad03545ffabdd67fc8
+  data.tar.gz: 93cfcd44e0b040d447789811b9b21722cc4989fd42645413e7f343a18781d1c7b53235bb799927718d74264e18b34b2882c64265393ee52c624a39109fff3cad

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ironclad00@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in partial_finder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    partial_finder (0.1.2)
+      activesupport (~> 6)
+      colorize (>= 0.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    byebug (11.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.15.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.3.4)
+  byebug
+  partial_finder!
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeremy Baker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# PartialFinder
+
+As Rails apps grow, partial usage and templates get increasingly complicated. PartialFinder adds rake tasks to your Rails app to help you track down the various ways that a given parial may be rendered. You can provide it a partial path and it will output all of the routes and controllers that serve it, along with the intermediate files.
+
+Usage: `rake partial_finder:find\['path/to/_partial.html.erb'\]`
+
+## Installation
+
+Add this line to your application's Gemfile under the development group:
+
+```ruby
+gem 'partial_finder', "~> 0.1.1", git: "https://github.com/Negotiatus/Partial-Finder.git"
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+To view this help manual outside of the README, run `bundle exec rake partial_finder:help`.
+
+PartialFinder adds two rake tasks to help track down partial usage:
+
+Task: Find
+Usage: `rake partial_finder:find\['path/to/_partial.html.erb'\]`
+Outputs all render chains and tries to match each partial with any controllers and routes that eventually render it.
+
+Task: Debug
+Usage: `rake partial_finder:debug\['path/to/_partial.html.erb'\]`
+Contains the same output as Find but with additional intermediate steps that can be used to help validate the final results.
+
+Here's an example output when running `rake partial_finder:find\["app/views/order_product_links/_description_block.html.erb"\]`:
+
+![example_results](./example.png)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Negotiatus/Partial-Finder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PartialFinder project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Negotiatus/Partial-Finder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'partial_finder'
+
+namespace :partial_finder do
+
+  desc "Output routes that render a given partial. Usage: rake partial_finder:find\\['path/to/_partial.html.erb'\\]"
+  task :find, [:path] => [:environment] do |task_name, args|
+    args[:path]
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "partial_finder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/partial_finder/assumption_graph.rb

@@ -0,0 +1,107 @@
+module PartialFinder
+  # AssumptionGraph accepts a standard Graph class and augments it with more information about
+  # how each render chain terminates, ie what controller method is used and what route points
+  # to said controller method.
+  #
+  # Given the flexiblity of metaprogramming and the many edge cases that exist even in a
+  # system with good conventions like the Rails rendering system, it's best to consider the
+  # guesses that this class makes exactly that - guesses, and sometimes manual checking may be
+  # needed to ensure the correctness of it's output.
+  #
+  # See Graph and LinkSet for more information on the primitives that this class is based on.
+  class AssumptionGraph < Graph
+    attr_reader :custom_rails_root
+
+    # Custom rails root needs to be set if the Rails root and current working directory
+    # of this class are not the same. This is needed to properly load and read controller
+    # code. Usually they will be the same, but during testing or when used outside of the
+    # standard rake context, may need to be set.
+    def initialize(links, custom_rails_root = nil)
+      super(links)
+      @custom_rails_root = custom_rails_root
+      @structure = structure.map{ |link| add_assumptions_to(link) }
+    end
+
+    private
+
+    def add_assumptions_to(link)
+      if link.parent.is_a? Array
+        link.parent.each{ |li| add_assumptions_to(li) }
+      else
+        link.parent = assumptions_for(link)
+      end
+
+      link
+    end
+
+    def assumptions_for(link)
+      case Formatter.type_of(link.parent)
+      when :partial
+        new_parent = "This render chain appears to be unused".colorize(:yellow)
+      when :view
+        new_parent = new_parent_for_view(link.parent)
+      when :controller
+        new_parent = new_parent_for_controller(link)
+      else
+        new_parent = "Match of unknown type found in #{link.parent}".colorize(:yellow)
+      end
+
+      [Link.new(link.parent, new_parent)]
+    end
+
+    def new_parent_for_controller(link)
+      if custom_rails_root.present?
+        methods = Formatter.methods_that_render(link.child, link.parent, custom_rails_root)
+      else
+        methods = Formatter.methods_that_render(link.child, link.parent)
+      end
+
+      if methods.any?
+        sigs = methods
+          .map{ |method| Formatter.controller_signature(link.parent, method) }
+
+        sig_str = sigs
+          .join(', ')
+          .remove(/,\z/)
+        sig_msg = "Rendered by #{sig_str}".colorize(:green)
+
+        routes = sigs.flat_map{ |sig| Router.routes_from(sig) }
+
+        if routes.any?
+          routes = routes
+            .join(', ')
+            .remove(/,\z/)
+          route_msg = "Routes to #{routes}".colorize(:green)
+        else
+          route_msg = "No routes found".colorize(:red)
+        end
+      else
+        sig_msg = "Method lookup failed".colorize(:red)
+        route_msg = "Routing not possible since method lookup failed".colorize(:red)
+      end
+
+      [Link.new(sig_msg, route_msg)]
+    end
+
+    def new_parent_for_view(path)
+      # TODO: technically a view can be rendered via calls like
+      # render template, but this isn't accounted for
+      # TODO: A controller might not actually have the method
+      # it is assumed to have. Check this eventually
+      # TODO: mailers are not accounted for
+      sig = Formatter.controller_signature_from_view(path)
+      routes = Router.routes_from(sig)
+
+      if routes.any?
+        routes = routes
+          .join(', ')
+          .remove(/,\z/)
+        route_msg = "Routes to #{routes}".colorize(:green)
+      else
+        route_msg = "Could not find route for #{sig}".colorize(:red)
+      end
+
+      [Link.new("Rendered by #{sig}".colorize(:green), route_msg)]
+    end
+  end
+end

data/lib/partial_finder/formatter.rb

@@ -0,0 +1,124 @@
+module PartialFinder
+  module Formatter
+    # Takes a file path and turns it into a partial reference. Example:
+    # app/views/orders/_order_sidepanel.html.erb
+    # becomes
+    # orders/order_sidepanel
+    # which is the format used when rendering a partial in a controller or view.
+    def self.path_to_ref(path)
+      ref = path.deep_dup
+      ref.remove!('app/').remove!('views/').remove!(/\.html\.erb\z/)
+      ref = ref.split('/')
+      ref[-1] = ref.last.remove(/\A_/)
+      ref.join('/')
+    end
+
+    def self.is_partial?(path)
+      return false unless path.present?
+      !!path.split('/').last.match(/\A_.+\.erb/)
+    end
+
+    def self.is_view?(path)
+      return false unless path.present?
+      !!path.split('/').last.match(/\A[^_].+\.erb/)
+    end
+
+    def self.is_controller?(path)
+      return false unless path.present?
+      !!path.split('/').last.match(/.+_controller\.rb/)
+    end
+
+    # Takes a view path that can be complete or have missing/extra
+    # parts and returns it in the format
+    # app/views/any_subfolders/view_file.html.erb
+    # or
+    # app/controllers/any_subfolders/controller_file.html.erb
+    #
+    # This is needed mainly when the search directly for grep is altered
+    # and parts of the path need to be restored and scrubbed of the
+    # leading ./ characters.
+    def self.fix_path(incomplete_path)
+      path = incomplete_path.remove(/\A\.\//)
+
+      if path.match(/\Aviews/) || path.match(/\Acontrollers/)
+        "app/#{path}"
+      elsif !path.match /\Aapp/
+        if is_view?(path)
+          "app/views/#{path}"
+        elsif is_controller?(path)
+          "app/controllers/#{path}"
+        else
+          path
+        end
+      else
+        path
+      end
+    end
+
+    # Determines if the given path is a partial, a view, a controller
+    # or none of the above
+    def self.type_of(path)
+      if is_partial?(path)
+        :partial
+      elsif is_view?(path)
+        :view
+      elsif is_controller?(path)
+        :controller
+      else
+        :unknown
+      end
+    end
+
+    # Given a view path, the controller name and method that implicitly
+    # renders it are assumed by convention. A controller signature is returned.
+    # If the path is not a view, an empty string is returned.
+    def self.controller_signature_from_view(path)
+      if is_view?(path)
+        cname = path.deep_dup
+        cname.remove!('app/').remove!('views/').remove!('.html.erb')
+        cname = cname.split('/')
+        method = cname.pop
+        "#{cname.join('/')}##{method}"
+      else
+        ""
+      end
+    end
+
+    # Returns a controller signature constructed from a controller's view path
+    # and a manually specified method name.
+    # If the path is not a controller, an empty string is returned.
+    def self.controller_signature(path, method)
+      if is_controller?(path)
+        cname = path.deep_dup
+        cname.remove!('app/').remove!('controllers/').remove!('_controller.rb')
+        "#{cname}##{method}"
+      else
+        ""
+      end
+    end
+
+    # Searches through a controller's definition to find which method is rendering
+    # a given partial. Multiple method names may be returned.
+    #
+    # A root is needed to provide flexibility so the controller file can be opened
+    # regardless of the current working directory. Normally paths are just used
+    # for their conventions, but in the controller's case here, the path needs
+    # to actually point to a file relative to the current working directory.
+    def self.methods_that_render(partial_path, controller_path, rails_root = PartialFinder.default_root)
+      if is_partial?(partial_path) && is_controller?(controller_path)
+        full_c_path = "#{rails_root}/#{controller_path}"
+        fragments = File.read(full_c_path).split /def (.+?)$/
+        ref = path_to_ref(partial_path)
+        matches = []
+
+        fragments.each.with_index do |fr,i|
+          matches << fragments[i-1] if fr.match ref
+        end
+
+        matches
+      else
+        ""
+      end
+    end
+  end
+end

data/lib/partial_finder/graph.rb

@@ -0,0 +1,63 @@
+module PartialFinder
+  # The Graph object assembles individual chain links into a structure that better
+  # resembles the multiple render paths of a partial.
+  #
+  # Specifically, using hash syntax, the structure looks something like:
+  # { original_partial => [{ parent1 => [...] }, { parent2 => [...] }, "terminating_view_file"] }
+  # In this example, the partial is directly rendered by "terminating_view_file" and
+  # has a deeper rendering chain up to 2 other parents somewhere.
+  #
+  # Chains will terminate in a string instead of an array (ie, the parent will be a string).
+  # These strings presumably will be either a controller or a view, but if the partial is unused, it could
+  # also terminate in itself or another partial.
+  class Graph
+    attr_reader :links, :structure
+
+    def initialize(links)
+      raise NonLinkArgument.new(links) unless links.is_a? LinkSet
+      @links = links
+
+      if links.any?
+        # The usage of 'root' is a side-effect of how #assemble_links works.
+        # If given the initial link instead of a new 'root' link, only the first
+        # parent of { partial => [parent1, parent2, ...] } will be traversed.
+        @structure = assemble_links(Link.new('root', links.first.child)).parent
+      else
+        @structure = []
+      end
+    end
+
+    def self.from(path, root)
+      new(LinkSet.new(path,root))
+    end
+
+    def to_s
+      @to_s ||= Printer.new(self).string
+    end
+
+    private
+
+    # This is also where controller methods, routing, and looping messages are
+    # determined.
+    def assemble_links(origin_link)
+      found = []
+
+      links.each do |link|
+        # If the given arg link is rendered by the link being examined,
+        # it's part of the render chain.
+        # Ie, if origin_link = { partialC => partialB }, then link
+        # { partialB => partialA } is a found link.
+        found << link.deep_dup if link.child == origin_link.parent
+      end
+
+      # If no links were found, return the new { link => parent_set }
+      # that was just built. Otherwise, recurse through the remaining parent
+      # links to continue building the render chain.
+      if found.any?
+        origin_link.parent = found.map{ |link| assemble_links(link) }
+      end
+
+      origin_link
+    end
+  end
+end

data/lib/partial_finder/link.rb

@@ -0,0 +1,6 @@
+# Child should be a string, but parent can be a string or an array
+PartialFinder::Link = Struct.new(:child, :parent) do
+  def to_s
+    "#{child} rendered by #{parent}"
+  end
+end

data/lib/partial_finder/link_set.rb

@@ -0,0 +1,86 @@
+require 'forwardable'
+
+module PartialFinder
+  # LinkSet is a simple collection of { render_child => render_parent } file paths.
+  # Given a partial path and a file root to search, it will recursively search for
+  # and collect render links for that partial.
+  # This is the base structure that is used to generate and print full render chains.
+  class LinkSet
+    extend Forwardable
+    attr_reader :path, :search_root, :values, :debug_mode
+
+    delegate [:any?, :each, :map, :[], :first] => :@values
+
+    # Accepts a file path to a partial and a file path used as the search root.
+    # The search root can be expanded or shrunk as needed but should stay within
+    # the Rails root. It can be flexible since the size of the search directory
+    # can drastically effect the performance of grep.
+    # It is recommended to use rails_root/app.
+    def initialize(partial_path, search_root, debug_mode: false)
+      raise NonPartialArgument.new(partial_path) unless Formatter.is_partial?(partial_path)
+
+      @debug_mode = debug_mode
+      @path = partial_path
+      @search_root = search_root
+      @values = []
+      collect_links(path)
+    end
+
+    # Returns a list of files that reference the given partial.
+    # Non-partials are not searched for as render chains
+    # terminate in non-partials (ie, if a view or controller has
+    # been found, the render chain can halt).
+    def self.files_that_reference(path, search_root, debug_mode: false)
+      if Formatter.is_partial? path
+        # Scans for instances of the partial being explicitly rendered.
+        # For example, given the path app/views/orders/_foo.html.erb, the
+        # resulting string used by grep would be:
+        # "partial: [\"']orders/foo[\"']"
+        # This accounts for use of " and ' in the reference.
+        #
+        # TODO: Make this single line? Character escaping this properly isn't fun
+        term = <<~STR.remove("\n")
+"partial: [\\"']#{Formatter.path_to_ref(path)}[\\"']"
+STR
+
+        puts "Running grep: 'cd #{search_root} && grep -rl #{term}'" if debug_mode
+        `cd #{search_root} && grep -rl #{term}`
+          .split("\n")
+          .map{ |a| Formatter.fix_path(a) }
+      else
+        []
+      end
+    end
+
+    private
+
+    def files_that_reference(path)
+      self.class.files_that_reference(path, search_root, debug_mode: debug_mode)
+    end
+
+    def links_are_unique?
+      values.uniq.size == values.size
+    end
+
+    # Recursive method that returns a list of
+    # { render_child_path => render_parent_path }
+    # file paths. These paths are the core structure used later on to assemble a
+    # full graph-like structure to represent render chains.
+    #
+    # "Parent" and "child" refer to the order that a view is rendered. The
+    # contorller/view that eventually renders a partial is always a parent and
+    # the given partial is a child.
+    # Ie, { file_that_is_rendered => file_that_renders_it }.
+    def collect_links(path)
+      files_that_reference(path).each do |parent_path|
+        values << Link.new(path, parent_path)
+
+        # Only continue recursion if there's more partials to look through. A view
+        # or controller indicates the end of a render chain.
+        collect_links(parent_path) if Formatter.is_partial?(parent_path) && links_are_unique?
+
+        values.pop unless links_are_unique?
+      end
+    end
+  end
+end

data/lib/partial_finder/printer.rb

@@ -0,0 +1,39 @@
+module PartialFinder
+  # Printer class can accept and stringify any class that implements #structure such that
+  # #structure returns an array of Links.
+  class Printer
+    attr_reader :structure, :string
+
+    TAB = "  ".freeze
+
+    # Can be any class that has a #structure method
+    def initialize(graph)
+      @structure = graph.structure
+      @string = ""
+      structure.map{ |link| stringify_link(link) }
+    end
+
+    private
+
+    def stringify_link(link, depth=0)
+      if link.parent.is_a? Array
+        @string << indent(depth) + link.child + "\n"
+        link.parent.each{ |plink| stringify_link(plink, depth+1) }
+      else
+        @string << stringify_simple_link(link, depth)
+      end
+    end
+
+    # Simple link meaning the link parent is not an array
+    def stringify_simple_link(link, depth)
+      indent(depth) + link.child + "\n" + indent(depth+1) + link.parent + "\n"
+    end
+
+    # Returns a string of spaces to represent an indent
+    def indent(depth)
+      spaces = ""
+      depth.times{ spaces << TAB }
+      spaces
+    end
+  end
+end

data/lib/partial_finder/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module PartialFinder
+  class Railtie < Rails::Railtie
+    railtie_name :partial_finder
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/../tasks/**/*.rake").each{ |f| load f }
+    end
+  end
+end

data/lib/partial_finder/router.rb

@@ -0,0 +1,25 @@
+module PartialFinder
+  module Router
+    def self.routes
+      @@routes ||= `rake routes`
+    end
+
+    # Input string must be in the format controller_name#method,
+    # ie "users_controller#create".
+    # Returns a list of strings that correspond to the routes that
+    # point to the given controller.
+    def self.routes_from(controller_sig)
+      entries = routes
+        .scan(/^.+  \/(.+)\(\.:format\) +(#{controller_sig})/)
+        .first
+
+      if entries.present?
+        entries
+          .reject{ |a| a == controller_sig }
+          .map{ |a| "/#{a}" }
+      else
+        []
+      end
+    end
+  end
+end

data/lib/partial_finder/runner.rb

@@ -0,0 +1,58 @@
+module PartialFinder
+  class Runner
+    attr_reader :partial, :root
+
+    def initialize(partial, search_root = nil)
+      @root = search_root || default_search_root
+      @partial = partial
+    end
+
+    def print
+      puts "\n\nStarting the partial finder for #{partial} in #{@root}\n\n".colorize(:green)
+
+      Printer.new(
+        AssumptionGraph.from(@partial, @root)
+      ).string
+    end
+
+    def debug
+      puts "\n\nStarting the partial finder in debug mode for #{partial} in #{@root}\n\n".colorize(:green)
+
+      links = LinkSet.new(@partial, @root, debug_mode: true)
+      graph = Graph.new(links)
+      agraph = AssumptionGraph.new(links)
+
+      puts ""
+      puts "=== Set of Links ===".colorize(:blue)
+      puts links.map{ |li| li.to_s }.join("\n")
+      puts ""
+      puts "=== Chains without Assumptions ===".colorize(:blue)
+      puts Printer.new(graph).string
+      puts ""
+      puts "=== Full Render Chains ===".colorize(:blue)
+      puts Printer.new(agraph).string
+    end
+
+    def default_search_root
+      PartialFinder.default_root + "/app"
+    end
+
+    def self.help
+<<-MSG.colorize(:blue)
+Partial Finder is a tool that helps link a given partial with the controllers and routes that render it. It works by making assumptions about Rail's rendering conventions and greping through the application code and routes.
+
+Conditional rendering logic is not considered. If a view, partial, or controller appears in the output list, this is only a statement that said file MAY render the partial under certain conditions.
+
+While it should handle all common use cases, it doesn't account for every possible edge case and manual greping may still be needed.
+
+Task: Find
+Usage: rake partial_finder:find\\['path/to/_partial.html.erb'\\]
+Outputs all render chains and tries to match each partial with any controllers and routes that eventually render it.
+
+Task: Debug
+Usage: rake partial_finder:debug\\['path/to/_partial.html.erb'\\]
+Contains the same output as Find but with additional intermediate steps that can be used to help validate the final results.
+MSG
+    end
+  end
+end

data/lib/partial_finder/version.rb

@@ -0,0 +1,3 @@
+module PartialFinder
+  VERSION = "0.1.2"
+end

data/lib/partial_finder.rb

@@ -0,0 +1,41 @@
+require "partial_finder/version"
+require "partial_finder/formatter"
+require "partial_finder/router"
+require "partial_finder/runner"
+require "partial_finder/printer"
+require "partial_finder/link"
+require "partial_finder/link_set"
+require "partial_finder/graph"
+require "partial_finder/assumption_graph"
+require "partial_finder/railtie" if defined?(Rails)
+require "colorize"
+require "active_support/core_ext/object"
+require "active_support/core_ext/string"
+
+module PartialFinder
+  class NonPartialArgument < StandardError
+    def initialize(path)
+      super "You may only use this class with partials, but gave '#{path}'"
+    end
+  end
+
+  class NonLinkArgument < StandardError
+    def initialize(arg)
+      super "You may only use this class with a LinkSet, but gave '#{arg}'"
+    end
+  end
+
+  class NonGraphArgument < StandardError
+    def initialize(arg)
+      super "You may only use this class with a Graph, but gave '#{arg}'"
+    end
+  end
+
+  def self.default_root
+    if defined?(Rails)
+      "Rails".constantize.root.to_s
+    else
+      "."
+    end
+  end
+end

data/lib/tasks/debug.rake

@@ -0,0 +1,6 @@
+namespace :partial_finder do
+  desc "Same as the find task, but prints out intermediate steps as well."
+  task :debug, [:path] => [:environment] do |task_name, args|
+    puts PartialFinder::Runner.new(args[:path]).debug
+  end
+end

data/lib/tasks/find.rake

@@ -0,0 +1,6 @@
+namespace :partial_finder do
+  desc "Outputs routes that render a given partial."
+  task :find, [:path] => [:environment] do |task_name, args|
+    puts PartialFinder::Runner.new(args[:path]).print
+  end
+end

data/lib/tasks/help.rake

@@ -0,0 +1,6 @@
+namespace :partial_finder do
+  desc "Display the help menu for Partial Finder"
+  task help: :environment do |task_name, args|
+    puts PartialFinder::Runner.help
+  end
+end

data/partial_finder.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "partial_finder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "partial_finder"
+  spec.version       = PartialFinder::VERSION
+  spec.authors       = ["Jeremy Baker"]
+  spec.email         = ["jeremy.baker@order.co"]
+
+  spec.summary       = %q{Finds app routes and render paths given a partial file name.}
+  spec.description   = %q{Adds a rake task that accepts a view partial file name and outputs the render chain along with best guesses as to the routes used to render the partial.}
+  spec.homepage      = "https://github.com/Negotiatus/Partial-Finder"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Negotiatus/Partial-Finder"
+    spec.metadata["changelog_uri"] = "https://github.com/Negotiatus/Partial-Finder"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.3.4"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "activesupport", "~> 6"
+  spec.add_dependency "colorize", ">= 0.8"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: partial_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jeremy Baker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Adds a rake task that accepts a view partial file name and outputs the
+  render chain along with best guesses as to the routes used to render the partial.
+email:
+- jeremy.baker@order.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- example.png
+- lib/partial_finder.rb
+- lib/partial_finder/assumption_graph.rb
+- lib/partial_finder/formatter.rb
+- lib/partial_finder/graph.rb
+- lib/partial_finder/link.rb
+- lib/partial_finder/link_set.rb
+- lib/partial_finder/printer.rb
+- lib/partial_finder/railtie.rb
+- lib/partial_finder/router.rb
+- lib/partial_finder/runner.rb
+- lib/partial_finder/version.rb
+- lib/tasks/debug.rake
+- lib/tasks/find.rake
+- lib/tasks/help.rake
+- partial_finder.gemspec
+homepage: https://github.com/Negotiatus/Partial-Finder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Negotiatus/Partial-Finder
+  source_code_uri: https://github.com/Negotiatus/Partial-Finder
+  changelog_uri: https://github.com/Negotiatus/Partial-Finder
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Finds app routes and render paths given a partial file name.
+test_files: []