deprecool 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8979f5deb74f90a5e9e6061319b79a1d920c6153bf3a32d378293514c6f5c547
-  data.tar.gz: 7a17ed36ecfb88aab21b1032a1fa74ae2165e8126826bae9cff2a341c5ae47a7
+  metadata.gz: 959b5cdb23ec0d5eef80f87185fb7a31a5646cf991cced0030d4d839fb835906
+  data.tar.gz: 87eac39b80c35af2e3bc868ab99b03d534f46f06e0f6ef6945381e5d00e8798b
 SHA512:
-  metadata.gz: d61efb1f6c1a4b36570040aa91dbf20b856fa63b8564390732e3ef14de6ee704f899d6aace163c338db6bec7511f2d189e158d5819f80b75a9002709a1214c4c
-  data.tar.gz: 62ada454736be50a5ff349562d2500d8266ecbe23829cd5a078446abd768fb7677e21e676201da08c4b6f9e1e6329afa0a5a3e3c4b2891c0355777de10166bd4
+  metadata.gz: d6da4e681409697beeaad714e669ad6854000a66a9086a8bf593ded61016e3741beb5147d616a42d99c3e19b3d51ad886f432d056ba58db2e56a559b0188ae87
+  data.tar.gz: cd41a34a6787fb74f7985e9180893d46a765a19d369b90c09d23738a378ee645bce9d02109fda4e7806195f82bc94f9b0d2ac300ec6c69bf6d0ccb65c9e41e9a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Deprecool
 
-## [0.1.0] - 2026-08-13
+## [0.1.2] - 2026-08-14
+
+- Add Finder for Rails's deprecation of `write_attribute(:id, value)`
+
+## [0.1.0], [0.1.1] - 2026-08-13
 
 - Initial Release

data/README.md

@@ -2,11 +2,12 @@
 
 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'`, and `bundle install`
+
 Or directly `gem install deprecool`
 
 Then you can run `deprecool` in the command line to get:
@@ -24,12 +25,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/finders/rails/v7.1.0/serializer_positional_class_argument.rb

@@ -25,11 +25,10 @@ module Deprecool
 
           def on_call_node(node)
             return unless node.name == :serialize
+            return unless arguments_are_length(node.arguments, 2)
+            return unless unwrap_arguments(node.arguments)[1].is_a?(Prism::ConstantReadNode)
 
-            arguments_array = unwrap_arguments(node.arguments)
-            return unless arguments_array && arguments_array[1]
-
-            add_offense(node, confidence: :high) if arguments_array[1].is_a?(Prism::ConstantReadNode)
+            add_offense(node, confidence: :high)
           end
         end
       end

data/lib/deprecool/finders/rails/v8.2.0/to_sql_binds.rb

@@ -7,7 +7,7 @@ module Deprecool
         class ToSqlBinds < Deprecool::Finder
           gem           :rails
           deprecated_in '8.2.0'
-          removed_in    '8.3.0'
+          removed_in    '9.0.0'
           title         'Passing "binds" into "to_sql" is deprecated'
           summary       'Since Rails 5.2, bind parameters live on the Arel AST ' \
                         'to_sql_and_binds no longer uses binds for SQL construction, ' \
@@ -26,9 +26,7 @@ module Deprecool
             # if a method called 'to_sql' is passed two arguments and the second is an
             # array that's probably good enough
             return unless node.name == :to_sql
-
-            arguments_array = unwrap_arguments(node.arguments)
-            return unless arguments_array && arguments_array[1]
+            return unless arguments_are_length(node.arguments, 2)
 
             add_offense(node, confidence: :high)
           end

data/lib/deprecool/finders/rails/v8.2.0/write_attribute_id.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Deprecool
+  module Finders
+    module Rails
+      module V8_2_0
+        class WriteAttributeId < Deprecool::Finder
+          gem           :rails
+          deprecated_in '8.2.0'
+          removed_in    '9.0.0'
+          title         'Using "write_attribute" for the primary key is deprecated'
+          summary       'Just like Rails 7.1\'s deprecation of calling "read_attribute(:id)", '\
+                        '"write_attribute(:id)" is now deprecated and will be removed in the next version of Rails. ' \
+                        'making :id refer only to the id column, not the primary key.'
+          suggestion    'Use "#id=" on a model whose primary key is not named "id"'
+          reference     'Original Rails Commit: https://github.com/rails/rails/commit/1a90632bbe62dae2626de7a058bc18c29f77aea6'
+          effort        :low
+
+          def on_call_node(node)
+            return unless node.name == :write_attribute
+            return unless arguments_are_length(node.arguments, 2)
+            return unless arguments_contain(node.arguments, "id", position: 0)
+
+            add_offense(node, confidence: :high)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/deprecool/helpers/prism_helpers.rb

@@ -36,4 +36,28 @@ module PrismHelpers
 
     node.child_nodes
   end
+
+  def arguments_are_length(node, length)
+    return false unless node.is_a?(Prism::ArgumentsNode)
+
+    unwrap_arguments(node.arguments).length == length
+  end
+
+  def arguments_contain(node, value, position: -1, kwarg: nil)
+    return false unless node.is_a?(Prism::ArgumentsNode)
+
+    arguments = unwrap_arguments(node)
+
+    return (value_from_argument(arguments[position]) == value) if position >= 0
+
+    arguments.any? do |arg|
+      value_from_argument(arg) == value
+    end
+  end
+
+  def value_from_argument(node)
+    case node
+    when Prism::SymbolNode, Prism::StringNode then node.unescaped
+    end
+  end
 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.2'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deprecool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Zac Radford
@@ -58,6 +58,7 @@ files:
 - lib/deprecool/finders/rails/v7.1.0/serializer_positional_class_argument.rb
 - lib/deprecool/finders/rails/v8.2.0/redis_cache_store_default_redis_options.rb
 - lib/deprecool/finders/rails/v8.2.0/to_sql_binds.rb
+- lib/deprecool/finders/rails/v8.2.0/write_attribute_id.rb
 - lib/deprecool/finders/ruby/v4.0.0/object_space_id2ref.rb
 - lib/deprecool/finders/ruby/v4.0.0/to_set_arguments.rb
 - lib/deprecool/helpers/prism_helpers.rb