deprecool 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8979f5deb74f90a5e9e6061319b79a1d920c6153bf3a32d378293514c6f5c547
-  data.tar.gz: 7a17ed36ecfb88aab21b1032a1fa74ae2165e8126826bae9cff2a341c5ae47a7
+  metadata.gz: e52876064a919fd936c1ce856a936497321260b30bb28d4af9583f1c4f408b2f
+  data.tar.gz: e2f181b5779334b951ab52f209533608d565764a09d9633c22bcc282ff604b04
 SHA512:
-  metadata.gz: d61efb1f6c1a4b36570040aa91dbf20b856fa63b8564390732e3ef14de6ee704f899d6aace163c338db6bec7511f2d189e158d5819f80b75a9002709a1214c4c
-  data.tar.gz: 62ada454736be50a5ff349562d2500d8266ecbe23829cd5a078446abd768fb7677e21e676201da08c4b6f9e1e6329afa0a5a3e3c4b2891c0355777de10166bd4
+  metadata.gz: 2054d49032593500337f9f406c298852b0fb11b03e745217c0ebdda4d5e26aa89ea06ed9d84855269a7c1079d38c09a6bb27fd5ac5a35b9138ac626f2fc0db72
+  data.tar.gz: f5014e5d52b173c5071f5622d892fc72783cbf61585cbed8d8a6845994ec704db0f3152055d2ae1074988b8be0331cac04134c73d797b6b8bc05c4dcdab7af34

data/README.md

@@ -2,11 +2,11 @@
 
 A static ruby code analyzer to find your deprecated code!
 
-For any developer who has ever ignored a gem's warning and then ran into an error when they went to update
+A helpful tool for any developer who has ever ignored a gem's warning and then ran into an error when they went to update
 
 ## Usage
 
-Add to your gemfile: `gem 'deprecool'`
+Add to your Gemfile: `gem 'deprecool'`
 Or directly `gem install deprecool`
 
 Then you can run `deprecool` in the command line to get:
@@ -24,12 +24,39 @@ Commands:
 
 - `--gem` takes a comma separated list of gems to scan for:
 
+_(make sure there are no spaces between the gem names)_
+
 ```
 deprecool scan --gem=rails,ruby
 ```
-_(make sure there are no spaces between the gem names)_
 
 - `--format=json` if you want the output as json instead of the default text
 - `--lockfile` takes a path to your `Gemfile.lock`, it defaults to using the current directory
 - `--all` run every finder regardless of applicability
 - `--paths` an array of the files or directories to look for ruby file in, defaults to `'.'`
+
+## Contributing
+
+This project has an incredibly large scope and I can't do it alone!
+
+If you see a deprecation warning in your code that isn't reflected here please either create an issue or make a PR
+
+Deprecool is designed to be able to support new deprecation warnings very easily.
+
+After cloning the repo, simply add two files:
+
+```
+lib/deprecool/finders/< gem name >/< gem version>/<short_name_of_warning>.rb
+
+test/deprecool/finders/< gem name >/< gem version>/<short_name_of_warning>_test.rb
+```
+
+Or, run the `exe/contribute` script and it will prompt you for:
+- the gem name
+- the version the deprecation first appears in
+- a short name for the warning's finder class
+
+_(if the script doesn't work, run `chmod +x exe/contribute` and try again)_
+
+Then use `rake` to run the test suite.
+

data/lib/deprecool/cli.rb

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'dry/cli'
-require 'debug'
 
 module Deprecool
   # Command-line entry point. Scans the given files/directories and reports

data/lib/deprecool/finder.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# requiring this here so we don't have to remember to add
-# it in individual finders
 require_relative 'helpers/prism_helpers'
 
 module Deprecool
@@ -106,7 +104,6 @@ module Deprecool
       # Prism::VisitClassNode  => on_class_node
       # Prism::VisitDefNode    => on_def_node
       # Prism::VisitModuleNode => on_module_node
-      # Prism::
       def hook_methods
         instance_methods(false).grep(/\Aon_\w+_node\z/)
       end
@@ -116,7 +113,7 @@ module Deprecool
 
     def initialize(file_path, source, offenses)
       @file_path = file_path
-      @source    = source # the result of Prism.parse
+      @source    = source # the AST from Prism.parse
       @offenses  = offenses
     end
 

data/lib/deprecool/registry.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
 module Deprecool
-  # Selects which finders should run for a given application, based on the gems
-  # (and Ruby) it actually uses and at what versions.
+  # Selects which finders should run for a given application
   module Registry
     extend self
 
-    # Every registered finder.
+    # All the subclasses of Finder
     def all_finders
       Finder.registry
     end

data/lib/deprecool/scanner.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 module Deprecool
-  # Parses a source file with Prism and runs a set of finders against it in a
-  # single AST traversal.
+  # Parses a source file with Prism and runs a set of finders against it
   class Scanner
     def initialize(finders)
       @finders = Array(finders)
@@ -12,8 +11,8 @@ module Deprecool
       scan_source(File.read(path), path)
     end
 
-    # Returns an Array<Offense>. Files that fail to parse yield no offenses;
-    # parse errors are surfaced separately via {#parse_errors}.
+    # pass Prism's AST over to the dispatcher to gather offending
+    # snippets of code into an array
     def scan_source(source, path = '(source)')
       result = Prism.parse(source)
       return [] unless result.success?
@@ -25,36 +24,39 @@ module Deprecool
       # and offenses are only needed for the add_offense method, not the actual
       # searching for an offense?
       instances = @finders.map { |finder| finder.new(path, source, offenses) }
-      DispatchVisitor.new(instances).visit(result.value)
+      FinderDispatcher.new(instances).visit(result.value)
       offenses
     end
 
-    # Combines the given Finder classes into one class by
+    # Combines the given Finder instances into one class by
     #  defining one method per Prism::Visitor hook (e.g. visit_call_node)
     #  based on all the given finders that define a method that matches that
     #  hook method name
-    class DispatchVisitor < Prism::Visitor
-      # finder_instances is the array passed to the Scanner.new class,
-      # so this would be [Ruby::V4_0_0::ToSetArguments, ..]
+    #
+    # This pattern makes it so that the Finders can remain as simple as
+    # possible while passing off their functionality info this class
+    class FinderDispatcher < Prism::Visitor
+      # finder_instances is the array passed to the Scanner instance,
+      # i.e [Ruby::V4_0_0::ToSetArguments.new, ...]
       def initialize(finder_instances)
         super()
 
         dispatch = Hash.new { |hash, key| hash[key] = [] }
         finder_instances.each do |instance|
           # find the hooks and add the instances to the hash of hook methods
-          # so { on_call_node: [ToSetArguments.new, ObjectSpaceId2ref.new,.. ], ... }
+          # so { on_call_node: [ToSetArguments.new, ObjectSpaceId2ref.new, ... ], ... }
           instance.class.hook_methods.each { |hook| dispatch[hook] << instance }
         end
 
         dispatch.each do |hook, finders|
-          # convert the instances' hooks to what prism::visitor expects
-          # so finder classes must use this pattern to name the visit_node methods
+          # convert the instances' hooks to what Prism::Visitor expects.
+          # Finder classes must use this pattern to name their visit_*_node methods
           #
           # 'on_call_node'   => good
           # 'find_call_node' => bad
           visit_method = hook.to_s.sub(/\Aon_/, 'visit_').to_sym
 
-          # define the prism::visitor hook to loop through each of the
+          # define the Prism::Visitor hook method to loop through each of the
           # related finders and call the name of the hook like so:
           #
           # def visit_call_node(node)

data/lib/deprecool/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Deprecool
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deprecool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Zac Radford