suggest_rb 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: e4b15e6cb0b18984749d2abbdd32835774de3e480374dfc3d4a9dd7393f1b208
-  data.tar.gz: 71444761f35ef08b561a0e3f5cfc8c84061ab9ddc974f494f99bd0b2b42b163b
+SHA1:
+  metadata.gz: 34aee46d7b04cc746443cae1623bc6ec09fdfc6c
+  data.tar.gz: 9168c4b4db034e5c46645b7e6a2b8c2aa359addd
 SHA512:
-  metadata.gz: 42fd7d3197b65a1c708533545f16c8f395574a26275fa48a32bcf26589e98b5c98e8aedbbc79201a98ec582da2b1253d6122b1907722d6588480aa039d88ee30
-  data.tar.gz: daa3d40c2ca895d59552d6ae4dc9c6dd37619e8647493e74d1bdc8ac0202dbadddecb80f723f4c7494e9b6a4eb26ef1bbbb0ccd7ddaecfaad056a00e08ffbf08
+  metadata.gz: 04e21185e022abc6113aa0cd130ad78ab1ad770712130b5d728ea4aef6515b734e88e4b68c79fcadec8e87e8245d033cd49835fa00e0b5e64e60698b854f40bb
+  data.tar.gz: 68483b98b9fa8402c0e569f2088deb65fcc5c7407b460f6a143fdbdf80fd09389b9eb216b6823067586c62a68f35581364a439102111f5ef938998f2d0069e2d

data/README.md

@@ -2,6 +2,10 @@
 
 tells you which method does the thing you want to do
 
+## Disclaimer
+
+I don't recommend you ship this in your Gemfile. Keep it in your system's gems (e.g. `gem install`) and load it as needed (e.g. `irb -rsuggest`, `RUBY_OPT=-rsuggest irb`, etc)
+
 ## Installation
 
 ```
@@ -19,11 +23,11 @@ require 'suggest'
 
 # You can also specify the args you want that method to take
 [1,2,3].what_returns? [1], args: [1]
-=> [:sample, :first, :take, :grep, :min]
+=> [:first, :take, :grep, :min]
 
 # By default, it only returns methods that don't mutate the object
 [1,2,3].what_returns? [1], args: [1], allow_mutation: true
-=> [:sample, :first, :take, :shift, :grep, :min]
+=> [:first, :take, :shift, :grep, :min]
 
 # It works on several core modules including String
 "HELLO".what_returns? "hello"
@@ -55,6 +59,14 @@ require 'suggest'
 # And you can give it a block as well
 [1,2,3,4].what_mutates? [2,4] { |n| n % 2 == 0 }
 => [:select!, :keep_if]
+
+# It respects the ruby version
+# ruby 2.4.3
+{a: 1, b: 2}.what_returns?({})
+=> []
+# ruby 2.5.0
+{a: 1, b: 2}.what_returns?({})
+=> [:slice]
 ```
 
 ## Note to Self

data/lib/suggest.rb

@@ -47,27 +47,22 @@ module Suggest
     [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]) &&
-          !TOO_COMPLICATED.include?([m.owner, m.name])
-      end
+  SELECTOR = ->(m) do
+    SUGGEST_MODS.include?(m.owner) &&
+      !INCONSISTENT.include?([m.owner, m.name]) &&
+      !TOO_COMPLICATED.include?([m.owner, m.name])
+  end
 
-      applicable_methods.select do |m|
+  module Mixin
+    def what_returns?(expected, args: [], allow_mutation: false, allow_not_public: false, &block)
+      methods.map(&method(:method)).select(&SELECTOR).select do |m|
         arity = m.arity
-        next unless arity == -1 || arity == args.count
+        next unless arity < 0 || arity == args.count
 
         post = clone
-        if block
-          next if UNSAFE_WITH_BLOCK.include?([m.owner, m.name])
-          result = post.public_send(m.name, *args, &block) rescue next
-        else
-          result = post.public_send(m.name, *args) rescue next
-        end
+
+        next if block && UNSAFE_WITH_BLOCK.include?([m.owner, m.name])
+        result = post.__send__(allow_not_public ? :send : :public_send, m.name, *args, &block) rescue next
 
         next unless allow_mutation || self == post
 
@@ -75,31 +70,17 @@ module Suggest
       end.map(&:name)
     end
 
-    def what_mutates?(expected, opts = {})
-      args = opts[:args] || []
-      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]) &&
-          !TOO_COMPLICATED.include?([m.owner, m.name])
-      end
-
-      applicable_methods.select do |m|
+    def what_mutates?(expected, args: [], allow_not_public: false, **opts, &block)
+      methods.map(&method(:method)).select(&SELECTOR).select do |m|
         arity = m.arity
-        next unless arity == -1 || arity == args.count
+        next unless arity < 0 || arity == args.count
 
         post = clone
-        if block
-          next if UNSAFE_WITH_BLOCK.include?([m.owner, m.name])
-          result = post.public_send(m.name, *args, &block) rescue next
-        else
-          result = post.public_send(m.name, *args) rescue next
-        end
 
-        if opts.key?(:returns)
-          next unless Suggest.eq?(result, opts[:returns])
-        end
+        next if block && UNSAFE_WITH_BLOCK.include?([m.owner, m.name])
+        result = post.__send__(allow_not_public ? :send : :public_send, m.name, *args, &block) rescue next
+
+        next if opts.key?(:returns) && !Suggest.eq?(result, opts[:returns])
 
         Suggest.eq?(post, expected)
       end.map(&:name)
@@ -110,18 +91,28 @@ module Suggest
     result.is_a?(expected.class) && result == expected
   end
 
+  def self.suggestable!(mod, **corrections) # unsafe_with_block: [], inconsistent: [], too_complicated: []
+    raise ArgumentError.new("Must support smart comparison (implement «#{mod}#==»)") if mod.instance_method(:==).owner == BasicObject
+
+    SUGGEST_MODS << mod
+    %w[unsafe_with_block inconsistent too_complicated].each do |correction|
+      c = Suggest.const_get(correction.upcase)
+      [mod].product(corrections.fetch(correction, [])).each(&c.method(:<<))
+    end
+    mod.include(Suggest::Mixin) unless mod.ancestors.include?(Suggest::Mixin)
+  end
+
   def self.suggestable_methods
-    candidates = []
-    SUGGEST_MODS.each do |mod|
+    SUGGEST_MODS.each_with_object([]) do |mod, candidates|
       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|
+    end.reject do |m|
       INCONSISTENT.include?(m) || TOO_COMPLICATED.include?(m)
     end
   end
 end
 
-Object.include(Suggest::Mixin)
+Suggest::SUGGEST_MODS.each do |mod|
+  mod.include(Suggest::Mixin) unless mod.ancestors.include?(Suggest::Mixin)
+end

data/lib/suggest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suggest_rb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Josh Bodah
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-18 00:00:00.000000000 Z
+date: 2019-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: tells you which method does the thing you want to do