loose_erbs 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a199c48574375f7ba4180d6b80b2f5bac67ed8a9a7c77f12c57d5a2fb7f1d53a
-  data.tar.gz: cd693a62b42d1f2eec23ce25bec589b03586da8ae646d9d0a5a478a02e540e36
+  metadata.gz: 44d3446a83d21a94d64e15ad5fc6cd41541d1593c38ea6ab9ef4e36ac52e1745
+  data.tar.gz: 8529f0d1f25cf62c318b13314fc2fa2ef2bbcf2516ec87f45102c84277426b20
 SHA512:
-  metadata.gz: 5678e042d65edac1b9868f7d2438860973f3830d6766f943e81e234af9dfcaf1065f9f0034be43221de7e72a3dc9037130cdac84a5c43406da91334cad52d71e
-  data.tar.gz: b96dda47a01a131505b6585fbc87f43cab4e93df845d096ee61983577f17b71919717ea3f3a0713f76bc994165bd9624c38797e1389f56d778d34e9a90092509
+  metadata.gz: 632d54cf79d18b1bf0a8ed8af9b24c2f19a0f5cfa5f545204a1d3c204596daa5724271684da3cf758dddaaf8588e5b27ed1c4f49635bebcb66d201f02f4d9683
+  data.tar.gz: 7281ceae45fb7f0d73a413d15592c9a9ec032af02b373e77497f7b5f87be450946f7e3825f20e572eadf362c374f02993b04a21d43cda645d5dbb78975e80f97

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+Rails/RefuteMethods:
+  Enabled: false

data/README.md

@@ -1,35 +1,57 @@
-# LooseErbs
+# Loose ERBs
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/loose_erbs`. To experiment with that code, run `bin/console` for an interactive prompt.
+A tool to help find Loose ERBs in your app!
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add loose_erbs
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install loose_erbs
 
 ## Usage
 
-TODO: Write usage instructions here
+```shell
+$ loose_erbs --all --trees
+/home/hartley/test/dm/app/views/layouts/application.html.erb
+
+/home/hartley/test/dm/app/views/posts/edit.html.erb
+└── /home/hartley/test/dm/app/views/posts/_form.html.erb
+
+/home/hartley/test/dm/app/views/posts/index.html.erb
+└── /home/hartley/test/dm/app/views/posts/_post.html.erb
+
+/home/hartley/test/dm/app/views/posts/new.html.erb
+└── /home/hartley/test/dm/app/views/posts/_form.html.erb
+
+/home/hartley/test/dm/app/views/posts/show.html.erb
+└── /home/hartley/test/dm/app/views/posts/_post.html.erb
+
+/home/hartley/test/dm/app/views/pwa/manifest.json.erb
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 the created tag, 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/[USERNAME]/loose_erbs.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/skipkayhil/loose_erbs.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License][].
+
+[MIT License]: https://opensource.org/licenses/MIT

data/Rakefile

@@ -2,7 +2,9 @@
 
 require "bundler/gem_tasks"
 require "minitest/test_task"
+require "rubocop/rake_task"
 
 Minitest::TestTask.create
+RuboCop::RakeTask.new
 
-task default: :test
+task default: [:test, :rubocop]

data/exe/loose_erbs

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "loose_erbs"
 
-LooseErbs::Cli.new.run
+exit(LooseErbs::Cli.new(ARGV).run)

data/lib/loose_erbs/registry.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module LooseErbs
+  class Registry
+    def initialize(view_paths)
+      @map = {}
+      @view_paths = view_paths
+
+      @view_paths.each do |view_path|
+        Dir["#{view_path}/**/*.erb"].each { register _1 }
+      end
+    end
+
+    def dependencies_for(identifier)
+      template = @map.fetch(identifier)
+
+      LooseErbs.parser_class.call(identifier, template, @view_paths).uniq.map { lookup(_1) }
+    end
+
+    # this feels like a hack around not using view paths...
+    def lookup(pathish)
+      wrapper = Pathname.new(pathish)
+
+      if wrapper.absolute?
+        # /home/hartley/test/dm/app/views/posts/form
+        partial_path = wrapper.join("../_#{wrapper.basename}.html.erb").to_s
+
+        return partial_path if @map.key? partial_path
+
+        # The DependencyTracker always puts the partial under the parent's
+        # namespace even if it could be found under a controller's super's
+        # namespace.
+        @view_paths.each do |view_path|
+          partial_path = Pathname.new(view_path).join("application/_#{wrapper.basename}.html.erb").to_s
+
+          return partial_path if @map.key? partial_path
+        end
+      else
+        @view_paths.each do |view_path|
+          # DependencyTracker removes the _ from partial pathishs
+          # posts/post
+          partial_path = Pathname.new(view_path).join(pathish).join("../_#{wrapper.basename}.html.erb").to_s
+
+          return partial_path if @map.key? partial_path
+
+          # Using the raw RenderParser returns a pathish with the partial _
+          # components/_badge
+          partial_path = Pathname.new(view_path).join(pathish).join("../#{wrapper.basename}.html.erb").to_s
+
+          return partial_path if @map.key? partial_path
+        end
+      end
+
+      warn("Couldn't resolve pathish: #{pathish}")
+
+      "UNKNOWN TEMPLATE: #{pathish}"
+    end
+
+    def register(path)
+      @map[path] = ActionView::Template.new(
+        File.read(path),
+        path,
+        ActionView::Template::Handlers::ERB,
+        locals: nil,
+        format: :html,
+      )
+    end
+
+    def to_graph
+      Graph.new(@map.keys, self)
+    end
+  end
+end

data/lib/loose_erbs/scanner.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LooseErbs
+  class Scanner
+    singleton_class.attr_accessor :parser_class
+
+    self.parser_class = if defined?(ActionView::RenderParser::Default)
+      ActionView::RenderParser::Default
+    else
+      ActionView::RenderParser
+    end
+
+    def initialize(app = Rails.application)
+      @app = app
+    end
+
+    def renders
+      parsed_renders = []
+
+      each_file_in(helper_paths) do |helper_path|
+        parsed_renders.concat parsed_renders_in(helper_path)
+      end.uniq
+
+      parsed_renders
+    end
+
+    private
+      attr_reader :app
+
+      def helper_paths
+        app.paths["app/helpers"]
+      end
+
+      def each_file_in(paths, &block)
+        paths.each do |root_path|
+          Dir["#{Rails.root.join(root_path)}/**/*.rb"].each(&block)
+        end
+      end
+
+      def parsed_renders_in(file_path)
+        parser = self.class.parser_class.new(file_path, File.read(file_path))
+        parser.render_calls
+      end
+  end
+end

data/lib/loose_erbs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LooseErbs
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/lib/loose_erbs.rb

@@ -2,6 +2,7 @@
 
 require "action_view"
 require "action_view/dependency_tracker"
+require "optparse"
 
 require_relative "loose_erbs/version"
 
@@ -14,70 +15,203 @@ module LooseErbs
     ActionView::DependencyTracker::RipperTracker
   end
 
-  class Template
-    class << self
-      def from(path)
-        new(path, File.read(path))
-      end
-    end
+  LooseFilter = ->(node) { node.loose? }
 
-    attr_reader :path, :source
+  RegexpIncludeFactory = ->(regexp) {
+    ->(node) { node.identifier.match?(regexp) }
+  }
+  RegexpExcludeFactory = ->(regexp) {
+    ->(node) { !node.identifier.match?(regexp) }
+  }
 
-    def initialize(path, source)
-      @path = path
-      @source = source
+  class FilterChain
+    def initialize(filters)
+      @filters = filters
     end
 
-    def dependencies
-      LooseErbs.parser_class.call(path, self)
+    def filter(elements)
+      @filters.reduce(elements) do |filtered_elements, filter|
+        filtered_elements.filter(&filter)
+      end
     end
+  end
 
-    def handler
-      ActionView::Template::Handlers::ERB
-    end
+  class Cli
+    def initialize(argv)
+      @options = {}
 
-    def type
-      ["text/html"]
+      option_parser.parse!(into: @options)
     end
 
-    def inspect
-      path
+    def run
+      require File.expand_path("./config/environment")
+
+      nodes = registry.to_graph
+
+      unless options[:all]
+        used_erbs = scanner.renders.map { registry.lookup(_1) }.to_set
+
+        visitor = Graph::LooseVisitor.new
+        nodes.select { |node|
+          # assume regular templates are good until controller parsing is added
+          used_erbs.include?(node.identifier) || !node.partial?
+        }.each { _1.accept(visitor) }
+      end
+
+      nodes = FilterChain.new(filters).filter(nodes) unless filters.empty?
+
+      if options[:trees]
+        nodes.each(&:print_tree)
+
+        true
+      else
+        puts "\nLoose ERBs:" unless nodes.empty?
+        nodes.each(&:print)
+
+        nodes.empty?
+      end
     end
+
+    private
+      attr_reader :options
+
+      def registry
+        Registry.new(ActionController::Base.view_paths)
+      end
+
+      def scanner
+        Scanner.new
+      end
+
+      def filters
+        [
+          LooseFilter,
+          (RegexpIncludeFactory.call(options[:include]) if options[:include]),
+          (RegexpExcludeFactory.call(options[:exclude]) if options[:exclude]),
+        ].compact
+      end
+
+      def option_parser
+        OptionParser.new do |parser|
+          parser.on("--trees", "Print files and their dependencies")
+          parser.on("--all", "Print all files with no parents (defaults to only partials)")
+          parser.on("--include [REGEXP]", Regexp, "Only print files that match [REGEXP]")
+          parser.on("--exclude [REGEXP]", Regexp, "Do not print files that match [REGEXP]")
+        end
+      end
   end
 
-  class Registry
-    def initialize
-      @map = {}
-    end
+  class Graph
+    class Printer
+      def initialize(root)
+        @node_stack = [[root, -1]]
+        @seen_nodes = Set.new
+      end
 
-    def print
-      @map.values.each do |template|
-        puts template.inspect
+      def print_tree
+        while !@node_stack.empty?
+          node, depth = @node_stack.pop
 
-        template.dependencies.each do |dependency|
-          puts "└── #{dependency}"
+          puts "#{("    " * depth) + "└── " if depth >= 0}#{node.identifier}"
+
+          if @seen_nodes.include?(node) && !node.children.empty?
+            puts ("    " * (depth + 1)) + "└── ..."
+          else
+            @seen_nodes << node
+
+            node.children.each do |child|
+              @node_stack << [child, depth + 1]
+            end
+          end
         end
+        puts
+      end
+    end
+
+    class LooseVisitor
+      def visit(node)
+        return unless node.loose?
+
+        node.not_loose!
+
+        node.children.each { visit(_1) }
       end
     end
 
-    def register(path)
-      @map[path] = Template.from(path)
+    class Node
+      attr_reader :children, :identifier, :parents
+
+      def initialize(identifier)
+        @identifier = identifier
+        @children = []
+        @parents = []
+        @loose = true
+      end
+
+      def accept(visitor)
+        visitor.visit(self)
+      end
+
+      def loose?
+        @loose
+      end
+
+      def not_loose!
+        @loose = false
+      end
+
+      def partial?
+        Pathname.new(identifier).basename.to_s.start_with?("_")
+      end
+
+      def print
+        puts identifier
+      end
+
+      def print_tree
+        Printer.new(self).print_tree
+      end
     end
-  end
 
-  class Cli
-    def run
-      registry = Registry.new
+    include Enumerable
+
+    def initialize(keys, registry)
+      @node_map = keys.to_h { [_1, Node.new(_1)] }
+      @registry = registry
 
-      views.each { registry.register(_1) }
+      each { process(_1) }
+    end
 
-      registry.print
+    def each(&block)
+      nodes.each(&block)
     end
 
     private
+      attr_reader :registry
 
-    def views
-      Dir["#{Dir.pwd}/app/views/**/*.html.erb"]
-    end
+      def nodes
+        @node_map.values
+      end
+
+      def process(node)
+        assign_children!(node)
+        assign_parents!(node)
+      end
+
+      def assign_children!(node)
+        registry.dependencies_for(node.identifier).each do |identifier|
+          # warn("No template registered for path: #{template.identifier}")
+          node.children << @node_map.fetch(identifier) { Node.new(identifier) }
+        end
+      end
+
+      def assign_parents!(node)
+        node.children.each do |child_node|
+          child_node.parents << node
+        end
+      end
   end
 end
+
+require_relative "loose_erbs/registry"
+require_relative "loose_erbs/scanner"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loose_erbs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Hartley McGuire
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-31 00:00:00.000000000 Z
+date: 2024-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -32,11 +32,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
 - exe/loose_erbs
 - lib/loose_erbs.rb
+- lib/loose_erbs/registry.rb
+- lib/loose_erbs/scanner.rb
 - lib/loose_erbs/version.rb
 homepage: https://github.com/skipkayhil/loose_erbs
 licenses: