methodsolver 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6f2c0e313ebc463f001136e17e06df659e86933
-  data.tar.gz: 92bc53f31083ecdcbe0c8ae18e13e4820195c092
+  metadata.gz: 955fbe18661fe270738fb516eec66989a8b1c2b4
+  data.tar.gz: 10d0c0e22b2fe44acd4c8c6d523756922de03336
 SHA512:
-  metadata.gz: 6ca8fbed39d19eb7dc3256000674b408d01f9b7a45c1083b3e43c1a3d44bc0ecf5876e3a62a4c8fb6d5825033197f0ebc3b36dde241aac08faa160ef1e38904e
-  data.tar.gz: b8952babf725dec3a443d54c1da155c72fbcb261362fe10f11e58717c1143d86f8757fe8564371a9961f0c047cef0086bd073fb5b2d9f6c46e96397e43bdbf89
+  metadata.gz: 5424178e647cabc858ff4b59260659d248eb4a6d3d23aed7ceaa776ae34a01551ed74f5c45a8e65c1fc1da5bf21df34b9ea0bf10bf82ed6dcb636198c409c804
+  data.tar.gz: 08d46010374694ac5343a1777b23096c531f1f9498e897f85a1acab9168370ecf32423072ca3045ab30d5f6642ab9188fcf540066ce3f56c5c433e1935ec7a8a

data/README.md

@@ -5,32 +5,28 @@ Finds ruby methods given a block with placeholder.
 For example:
 
 ```ruby
-solve { 'lettuce'.foo == 7 }
+solve {
+  h = { a: 1, bunny: 2, c: 3 }
+  h.______(:bunny)
+  h.keys == [:a, :c]
+}
 ```
 
-Will find `#length` and `#size`
+Will find `#delete`
 
-Use with caution and beware of side effects!
+Use with caution!
 
-The solver attempts to executes the block with arbitrary methods found on the reciever. Append the symbol of dangerous methods to `Methodsolver::BLACKLIST` in order to blacklist them.
+Beware of side effects. The solver attempts to execute the block with arbitrary methods found on the receiver. Append the symbol of dangerous methods to `Methodsolver::BLACKLIST` in order to blacklist them. Setters and bang methods are blacklisted by default.
 
-## Installation
+## Usage
 
-Clone this repo and run pry:
+Please refer to `examples/solve.rb` (and the rspec tests) for more examples.
 
-    git clone https://github.com/akuhn/methodsolver.git
-    cd methodsolver
-    bundle
-    bundle exec pry
+## Installation
 
-And then execute:
+Get this gem:
 
-```ruby
-require 'methodsolver'
-solve { 'lettuce'.foo == 7 }
-```
-
-Please refer to `examples/solve.rb` (and the rspec tests) for more examples.
+    gem install methodsolver
 
 ## Contributing
 

data/bin/console

@@ -3,12 +3,5 @@
 require "bundler/setup"
 require "methodsolver"
 
-# 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
+require "pry"
+Pry.start

data/examples/solve.rb

@@ -1,21 +1,23 @@
 require 'methodsolver'
 
-words = %w(the quick brown fox jumps over the lazy dog)
-
 solve {
-  words.dup.foo == 'the'
+  words = %w(the quick brown fox jumps over the lazy dog)
+  words.foo == 'the'
 }
 
 solve {
-  words.dup.foo(%w(fox dog)) == %w(the quick brown jumps over the lazy)
+  words = %w(the quick brown fox jumps over the lazy dog)
+  words.foo(%w(fox dog)) == %w(the quick brown jumps over the lazy)
 }
 
 solve {
-  Numeric === words.dup.foo
+  words = %w(the quick brown fox jumps over the lazy dog)
+  Numeric === words.foo
 }
 
 solve {
-  Hash === words.dup.foo(&:itself)
+  words = %w(the quick brown fox jumps over the lazy dog)
+  Hash === words.foo(&:itself)
 }
 
 solve {

data/lib/methodsolver.rb

@@ -10,7 +10,7 @@ module Methodsolver
 
     begin
       Object.class_eval('def method_missing(name, *args); throw :undefined_method, [self, name]; end')
-      reciever, placeholder = catch :undefined_method do
+      receiver, placeholder = catch :undefined_method do
         block.call
         raise ArgumentError, 'no missing method found'
       end
@@ -18,10 +18,12 @@ module Methodsolver
       Object.class_eval('remove_method :method_missing')
     end
 
+    somewhat_limited_safety_checks(receiver, block) unless options[:unsafe]
+
     # Find methods that pass the block:
 
-    results = methods_for(reciever).select do |name|
-      method = reciever.method(name) rescue next
+    results = methods_for(receiver).select do |name|
+      method = receiver.method(name) rescue next
       begin
         method.owner.class_eval("alias #{placeholder.inspect} #{name.inspect}")
         true === block.call
@@ -35,7 +37,7 @@ module Methodsolver
     # Optionally return a hash with metadata:
 
     if options[:metadata]
-      { reciever: reciever, placeholder: placeholder, results: results }
+      { receiver: receiver, placeholder: placeholder, results: results }
     else
       results
     end
@@ -63,11 +65,30 @@ module Methodsolver
       .uniq
   end
 
+  SAVE = [Array, Fixnum, Float, Hash, Object, Range, Regexp, String]
+
+  def self.somewhat_limited_safety_checks(receiver, block)
+    return if receiver.nil?
+    block.binding.eval('local_variables').each do |name|
+      if receiver.equal? block.binding.eval("#{name} rescue nil")
+        receiver.clone rescue break # omit warning for immutables
+        raise ArgumentError,
+          "receiver equals local variable '#{name}', " <<
+          "use solve(unsafe: true) or clone/dup the variable"
+      end
+    end
+    unless SAVE.include? receiver.class
+      raise ArgumentError,
+        "class of receiver not marked as save: #{receiver.class}, " <<
+        "use solve(unsafe: true) or append to Methodsolver::SAVE"
+    end
+  end
+
 end
 
-def solve(&block)
-  data = Methodsolver.call(metadata: true, &block)
-  object, found = data[:reciever], data[:results]
+def solve(options = {}, &block)
+  data = Methodsolver.call(options.merge(metadata: true), &block)
+  object, found = data[:receiver], data[:results]
   if block.respond_to? :method_source
     puts "Found #{found.count} methods for #{block.method_source.strip}"
   else

data/lib/methodsolver/version.rb

@@ -1,3 +1,3 @@
 module Methodsolver
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: methodsolver
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Adrian Kuhn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-21 00:00:00.000000000 Z
+date: 2015-07-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: