suggest_rb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e61c1dd1cb882f09e1c11a1f7adfe9d123aa770a28e2578a2785025bc6ee1cbc
-  data.tar.gz: 5f3e5ed7bbaa495ba9844412c39fb47d6b686d8dec109a0aeedb4713c0f64f9f
+  metadata.gz: e4b15e6cb0b18984749d2abbdd32835774de3e480374dfc3d4a9dd7393f1b208
+  data.tar.gz: 71444761f35ef08b561a0e3f5cfc8c84061ab9ddc974f494f99bd0b2b42b163b
 SHA512:
-  metadata.gz: 1037bab415285b2009496fb5b37e2c8b56593e5a62e5142b262fefa86978c94fedaef70b4f48ebc4fb9707a4dde5c5711843bd110a866d1c5a5e8ff523362568
-  data.tar.gz: 544907353e5c561b26edc69b20eecca87bc4070af9284cde736f37d3fa193068748b4a260dfbd0191c538cf4783c7be84134c2a6f01f8a3a3e80368ad965b633
+  metadata.gz: 42fd7d3197b65a1c708533545f16c8f395574a26275fa48a32bcf26589e98b5c98e8aedbbc79201a98ec582da2b1253d6122b1907722d6588480aa039d88ee30
+  data.tar.gz: daa3d40c2ca895d59552d6ae4dc9c6dd37619e8647493e74d1bdc8ac0202dbadddecb80f723f4c7494e9b6a4eb26ef1bbbb0ccd7ddaecfaad056a00e08ffbf08

data/README.md

@@ -56,3 +56,11 @@ require 'suggest'
 [1,2,3,4].what_mutates? [2,4] { |n| n % 2 == 0 }
 => [:select!, :keep_if]
 ```
+
+## Note to Self
+
+Snippet to use in `bin/console` for finding methods for blacklisting:
+
+```
+Suggest::SUGGEST_MODS.flat_map { |k| [k].product(k.instance_methods) }.select { |k, v| v == :rand }.map { |k, v| k.instance_method(v).owner }.uniq
+```

data/lib/suggest.rb

@@ -4,12 +4,26 @@ require "set"
 module Suggest
   SUGGEST_MODS = Set.new([
     Array,
+    BasicObject,
+    Comparable,
+    Complex,
     Enumerable,
-    String,
+    FalseClass,
+    Float,
     Hash,
-    Regexp,
     Integer,
-    Set
+    Math,
+    NilClass,
+    Numeric,
+    Range,
+    Regexp,
+    Regexp,
+    Set,
+    String,
+    Struct,
+    Symbol,
+    Time,
+    TrueClass,
   ])
 
   UNSAFE_WITH_BLOCK = Set.new([
@@ -23,12 +37,24 @@ module Suggest
     [Array, :shuffle!]
   ])
 
+  TOO_COMPLICATED = Set.new([
+    [String, :freeze],
+    [Set, :freeze],
+    [Set, :taint],
+    [Set, :untaint],
+    [Numeric, :singleton_method_added],
+    [Numeric, :clone],
+    [Numeric, :dup],
+  ])
+
   module Mixin
     def what_returns?(expected, args: [], allow_mutation: false)
       block = Proc.new if block_given?
 
       applicable_methods = self.methods.map(&method(:method)).select do |m|
-        SUGGEST_MODS.include?(m.owner) && !INCONSISTENT.include?([m.owner, m.name])
+        SUGGEST_MODS.include?(m.owner) &&
+          !INCONSISTENT.include?([m.owner, m.name]) &&
+          !TOO_COMPLICATED.include?([m.owner, m.name])
       end
 
       applicable_methods.select do |m|
@@ -54,7 +80,9 @@ module Suggest
       block = Proc.new if block_given?
 
       applicable_methods = self.methods.map(&method(:method)).select do |m|
-        SUGGEST_MODS.include?(m.owner) && !INCONSISTENT.include?([m.owner, m.name])
+        SUGGEST_MODS.include?(m.owner) &&
+          !INCONSISTENT.include?([m.owner, m.name]) &&
+          !TOO_COMPLICATED.include?([m.owner, m.name])
       end
 
       applicable_methods.select do |m|
@@ -81,6 +109,19 @@ module Suggest
   def self.eq?(result, expected)
     result.is_a?(expected.class) && result == expected
   end
+
+  def self.suggestable_methods
+    candidates = []
+    SUGGEST_MODS.each do |mod|
+      owned_methods = mod.instance_methods.select { |m| mod.instance_method(m).owner == mod }
+      next if owned_methods.none?
+      candidates += [mod].product(owned_methods)
+    end
+
+    candidates.reject do |m|
+      INCONSISTENT.include?(m) || TOO_COMPLICATED.include?(m)
+    end
+  end
 end
 
 Object.include(Suggest::Mixin)

data/lib/suggest/version.rb

@@ -1,3 +1,3 @@
 module Suggest
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suggest_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Bodah