suggest_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4767a25d85dccc93708b86da3fc1abaf21163f1
+  data.tar.gz: 9dac49839363b1aa5cea4c1905797d41a7d9ecf1
+SHA512:
+  metadata.gz: 01fe386299c1c54e02833812316aa96097243eeef9460474bdbd28b8d4e1535d4db8ae961db7be8baa98a31ba649b6ddd04ebaf2e85e6dfbc04eae758ad1984f
+  data.tar.gz: 143bd64a2fee717bfdf443fa1f788014141112aef692ca7e9c5bf7befe64ccce04bab339c22cbdb19cd6f7a6e1c980bc0134f1aaa3191ff699d7d74ce982eefa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in suggest.gemspec
+gemspec

data/README.md

@@ -0,0 +1,58 @@
+# Suggest
+
+tells you which method does the thing you want to do
+
+## Installation
+
+```
+gem install suggest_rb
+```
+
+## Usage
+
+```rb
+require 'suggest'
+
+# Object#what_returns? tells you which method returns the value
+[1,2,3].what_returns? 1
+=> [:first, :min]
+
+# 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]
+
+# 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]
+
+# It works on several core modules including String
+"HELLO".what_returns? "hello"
+=> [:downcase, :swapcase]
+
+# You can also specify a block that you want the method to accept
+[1,2,3,4].what_returns?({true => [2,4], false => [1,3]}) { |n| n % 2 == 0 }
+=> [:group_by]
+
+# Object#what_mutates? tells you which method changes the object to the desired state
+[1,2,3].what_mutates? [2, 3]
+=> [:shift]
+
+# You can also match on the return value
+[1,2,3].what_mutates? [2, 3], returns: 1
+=> [:shift]
+
+[1,2,3].what_mutates? [2, 3], returns: 2
+=> []
+
+# You can specify which args to pass to the method
+[1,2,3].what_mutates? [3], args: [2]
+=> [:shift]
+
+# It also works on a bunch of core modules
+"HELLO".what_mutates? "hello"
+=> [:swapcase!, :downcase!]
+
+# And you can give it a block as well
+[1,2,3,4].what_mutates? [2,4] { |n| n % 2 == 0 }
+=> [:select!, :keep_if]
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "suggest"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/suggest/version.rb

@@ -0,0 +1,3 @@
+module Suggest
+  VERSION = "0.1.0"
+end

data/lib/suggest.rb

@@ -0,0 +1,64 @@
+require "suggest/version"
+require "set"
+
+module Suggest
+  SUGGEST_MODS = Set.new([Array, Enumerable, String, Hash, Regexp, Integer])
+  UNSAFE = Set.new([Array.instance_method(:cycle)])
+
+  module Mixin
+    def what_returns?(expected, args: [], allow_mutation: false)
+      block = Proc.new if block_given?
+
+      applicable_methods = self.methods.map(&method(:method)).select { |m| SUGGEST_MODS.include?(m.owner) }
+
+      applicable_methods.select do |m|
+        arity = m.arity
+        next unless arity == -1 || arity == args.count
+
+        post = clone
+        if block
+          next if UNSAFE.include?(m.unbind)
+          result = post.public_send(m.name, *args, &block) rescue next
+        else
+          result = post.public_send(m.name, *args) rescue next
+        end
+
+        next unless allow_mutation || self == post
+
+        Suggest.eq?(result, expected)
+      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 { |m| SUGGEST_MODS.include?(m.owner) }
+
+      applicable_methods.select do |m|
+        arity = m.arity
+        next unless arity == -1 || arity == args.count
+
+        post = clone
+        if block
+          next if UNSAFE.include?(m.unbind)
+          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
+
+        Suggest.eq?(post, expected)
+      end.map(&:name)
+    end
+  end
+
+  def self.eq?(result, expected)
+    result.is_a?(expected.class) && result == expected
+  end
+end
+
+Object.include(Suggest::Mixin)

data/suggest.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "suggest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "suggest_rb"
+  spec.version       = Suggest::VERSION
+  spec.authors       = ["Josh Bodah"]
+  spec.email         = ["jbodah@cargurus.com"]
+
+  spec.summary       = %q{tells you which method does the thing you want to do}
+  spec.homepage      = "https://github.com/jbodah/suggest_rb"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-tagz"
+  spec.add_development_dependency "pry-byebug"
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: suggest_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Bodah
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-tagz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jbodah@cargurus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/suggest.rb
+- lib/suggest/version.rb
+- suggest.gemspec
+homepage: https://github.com/jbodah/suggest_rb
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: tells you which method does the thing you want to do
+test_files: []