runaround 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d8e09f17dd32a9ac41b6d2dff013ae31db37f53
-  data.tar.gz: 930519fee7dc11a0b55803654c4287b264377b90
+  metadata.gz: 57391a740400e9e80e52dad9b0c1d7e029881669
+  data.tar.gz: 5da2fff261a2a08fbaa14758d3360e46f85c4584
 SHA512:
-  metadata.gz: 61d153b46fb7b713f5189f1af0c835110ceb13f84b046b1d1c0859421c1a210c256fd008e421687e06725a124449a8806bef089fb3bde5ca7bc09c3c381db3df
-  data.tar.gz: 1ffcf26ce051603210fa4ad0b97a84e206dee9144f229cf99ea1bc9b8194733febdfa8a360d6359c0b5fd875ef90607a9f16af13848ed0663cefa18fa87d17de
+  metadata.gz: 402edc5d3604d0c25f63d2b85a5fac0d7baf53fa64f555653c28d7b4aed777c14c053d88fb885e2929f73d5ad743b9f4e3379db3ffd5e1ee4f8e274889e51db9
+  data.tar.gz: cfaa6d2cfd0ea7cfa4037dc1f481824ad6e9689a99ca4059e9781f2678433643b26f91f742d7bdd4c9d90fd70e17d1a653b81f1fa5420a5e39ccd6bab4ed25fd

data/README.md

@@ -1,41 +1,83 @@
 # Runaround
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/runaround`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An Easy Callback System for Ruby Objects
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `gem 'runaround'` to your Gemfile
 
-```ruby
-gem 'runaround'
-```
+## Usage
 
-And then execute:
+`Runaround` can be used to add `before`, `after`, and `around` callbacks to your ruby objects.
 
-    $ bundle
+#### Callbacks on a specific object instance
+```ruby
+class Subtractor
+  include Runaround
+  def subtract(a,b)
+    a - b
+  end
+end
+
+object = Subtractor.new
+object.runaround.before(:subtract){ |mc| mc.args.reverse! }
+object.subtract(7,4)
+ => -3 
+Subtractor.new.subtract(7,4)
+ => 3
+```
 
-Or install it yourself as:
+#### Callbacks on class methods
+```ruby
+class Formatter
+  extend Runaround
+  def self.format(string)
+    string.downcase.tr('[w m]', '[m w]')
+  end
+  runaround.after(:format){ |mc| mc.return_value += '!' }
+end
+
+Formatter.format('WALMART')
+ => 'malwart!' 
+```
 
-    $ gem install runaround
+#### Callbacks on instance methods
+```ruby
+require 'json'
+class Worker
+  extend Runaround::InstanceMethods
+  def work(**opts)
+    opts.to_json
+  end
+  irunaround.around(:work) do |mc|
+    puts "  BEFORE WORK"
+    mc.opts[:foo_id] = 12345
+    result = mc.run_method
+    puts "  WORK COMPLETE, GOT: #{result.inspect}"
+  end
+end
+
+worker = Worker.new
+worker.work(thing: 'one')
+  BEFORE WORK
+  WORK COMPLETE, GOT: "{\"thing\":\"one\",\"foo_id\":12345}"
+ => "{\"thing\":\"one\",\"foo_id\":12345}"
+```
 
-## Usage
+#### More Details
+Callbacks are passed a [Runaround::MethodCall](https://github.com/fledman/runaround/blob/master/lib/runaround/method_call.rb) struct. This allows for manipulation of the input arguments/options as well as the return value. Be careful when using this functionality.
 
-TODO: Write usage instructions here
+`before` and `after` callbacks are implemented using simple blocks, while `around` callbacks are implemented using `Fiber`s.
+As such, `MethodCall#run_method` is only used for `around` callbacks. All `around` callbacks must call it.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/runaround.
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/fledman/runaround.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/runaround/instance_methods.rb

@@ -15,7 +15,8 @@ module Runaround
     end
 
     def runaround_instance_methods
-      @runaround_instance_methods ||= Manager.new(self, apply: false)
+      @runaround_instance_methods ||= Manager.new(
+        self, apply: false, for_instances: true)
     end
 
     def irunaround

data/lib/runaround/manager.rb

@@ -4,11 +4,12 @@ require "runaround/errors"
 
 module Runaround
   class Manager
-    attr_reader :receiver, :apply
+    attr_reader :receiver, :apply, :for_instances
 
-    def initialize(receiver, apply: true)
+    def initialize(receiver, apply: true, for_instances: false)
       @receiver = receiver
       @apply = !!apply
+      @for_instances = !!for_instances
     end
 
     def before(method, fifo: true, &block)
@@ -75,7 +76,8 @@ module Runaround
     end
 
     def validate_method!(method)
-      return if receiver.respond_to?(method)
+      return if !for_instances && receiver.respond_to?(method)
+      return if for_instances && receiver.method_defined?(method)
       msg = "the receiver does not respond to #{method.inspect}"
       raise CallbackSetupError, "#{msg} ==> receiver.inspect"
     end

data/lib/runaround/version.rb

@@ -1,3 +1,3 @@
 module Runaround
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runaround
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - David Feldman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-31 00:00:00.000000000 Z
+date: 2016-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake