runaround 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d8e09f17dd32a9ac41b6d2dff013ae31db37f53
+  data.tar.gz: 930519fee7dc11a0b55803654c4287b264377b90
+SHA512:
+  metadata.gz: 61d153b46fb7b713f5189f1af0c835110ceb13f84b046b1d1c0859421c1a210c256fd008e421687e06725a124449a8806bef089fb3bde5ca7bc09c3c381db3df
+  data.tar.gz: 1ffcf26ce051603210fa4ad0b97a84e206dee9144f229cf99ea1bc9b8194733febdfa8a360d6359c0b5fd875ef90607a9f16af13848ed0663cefa18fa87d17de

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in runaround.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Feldman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# 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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'runaround'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runaround
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "runaround"
+
+require "pry"
+require "irb"
+
+IRB.start

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/runaround/callback_hook.rb

@@ -0,0 +1,22 @@
+require "runaround/method_call"
+
+module Runaround
+  module CallbackHook
+
+    def self.build_for(method, manager)
+      Module.new do
+        define_method(method) do |*args,**opts,&block|
+          mc = MethodCall.new(method, args, opts, block)
+          blocks, fibers = manager.callbacks(method)
+          blocks[:before].each { |b| b.call(mc) }
+          fibers.each { |f| f.resume(mc) }
+          mc.return_value = super(*mc.argsopts, &mc.block)
+          fibers.reverse_each { |f| f.resume(mc.return_value) }
+          blocks[:after].each { |b| b.call(mc) }
+          mc.return_value
+        end
+      end
+    end
+
+  end
+end

data/lib/runaround/errors.rb

@@ -0,0 +1,3 @@
+module Runaround
+  class CallbackSetupError < StandardError; end
+end

data/lib/runaround/instance_methods.rb

@@ -0,0 +1,28 @@
+module Runaround
+  module InstanceMethods
+
+    def self.included(into)
+      raise RuntimeError,
+        "Runaround::InstanceMethods expects to be extended, not included"
+    end
+
+    def self.extended(into)
+      into.extend Runaround
+      into.include Runaround
+      into.runaround.after(:new) do |mc|
+        mc.return_value.runaround.import(into.runaround_instance_methods)
+      end
+    end
+
+    def runaround_instance_methods
+      @runaround_instance_methods ||= Manager.new(self, apply: false)
+    end
+
+    def irunaround
+      runaround_instance_methods.tap do |x|
+        yield(x) if block_given?
+      end
+    end
+
+  end
+end

data/lib/runaround/manager.rb

@@ -0,0 +1,123 @@
+require "fiber"
+require "runaround/callback_hook"
+require "runaround/errors"
+
+module Runaround
+  class Manager
+    attr_reader :receiver, :apply
+
+    def initialize(receiver, apply: true)
+      @receiver = receiver
+      @apply = !!apply
+    end
+
+    def before(method, fifo: true, &block)
+      prepare_callback(
+        method: method, type: :before, fifo: fifo, &block)
+    end
+
+    def after(method, fifo: true, &block)
+      prepare_callback(
+        method: method, type: :after, fifo: fifo, &block)
+    end
+
+    def around(method, fifo: false, &block)
+      prepare_callback(
+        method: method, type: :around, fifo: fifo, &block)
+    end
+
+    def callbacks(method)
+      all = all_callbacks(method)
+      blocks = all.dup.tap{ |h| h.delete(:around) }
+      fibers = all[:around].map{ |b| Fiber.new(&b) }
+      return blocks, fibers
+    end
+
+    def to_h
+      callback_hooks.keys.reduce({}) do |h, method|
+        h[method] = copy_callback_map(method); h
+      end
+    end
+
+    def import(other)
+      validate_manager!(other)
+      other.to_h.each do |method, callbacks|
+        callbacks.each do |type, list|
+          list.each do |block|
+            prepare_callback(
+              method: method, type: type, fifo: true, &block)
+          end
+        end
+      end
+    end
+
+    private
+
+    def prepare_callback(method:, type:, fifo:, &block)
+      validate_opts!(method, type, fifo, block)
+      setup_callback_hook(method)
+      list = all_callbacks(method)[type]
+      fifo ? list << block : list.unshift(block)
+      list.size
+    end
+
+    def setup_callback_hook(method)
+      return true if callback_hooks[method]
+      callback_hooks[method] = CallbackHook.build_for(method, self)
+      receiver.singleton_class.prepend(callback_hooks[method]) if apply
+    end
+
+    def validate_opts!(method, type, fifo, block)
+      validate_method!(method)
+      validate_type!(type)
+      validate_fifo!(fifo)
+      validate_block!(block)
+    end
+
+    def validate_method!(method)
+      return if receiver.respond_to?(method)
+      msg = "the receiver does not respond to #{method.inspect}"
+      raise CallbackSetupError, "#{msg} ==> receiver.inspect"
+    end
+
+    def validate_type!(type)
+      return if [:before, :after, :around].include?(type)
+      msg = "#{type.inspect} is not a valid callback type"
+      msg += "; must be one of [:before, :after, :around]"
+      raise CallbackSetupError, msg
+    end
+
+    def validate_fifo!(fifo)
+      return if [true, false, nil].include?(fifo)
+      msg = "fifo must be true, false, or nil; got #{fifo.inspect}"
+      raise CallbackSetupError, msg
+    end
+
+    def validate_block!(block)
+      return if block.is_a?(Proc)
+      raise CallbackSetupError, "you must pass a block for the callback!"
+    end
+
+    def validate_manager!(manager)
+      return if manager.is_a?(self.class)
+      msg = "expected a #{self.class}, got: #{manager.inspect}"
+      raise CallbackSetupError, msg
+    end
+
+    def copy_callback_map(method)
+      all_callbacks(method).reduce({}) do |map,(type,arr)|
+        map[type] = arr.dup; map
+      end
+    end
+
+    def callback_hooks
+      @callback_hooks ||= {}
+    end
+
+    def all_callbacks(method)
+      @all_callbacks ||= {}
+      @all_callbacks[method] ||= { before: [], after: [], around: [] }
+    end
+
+  end
+end

data/lib/runaround/method_call.rb

@@ -0,0 +1,15 @@
+module Runaround
+
+  MethodCall = Struct.new(:method, :args, :opts, :block, :return_value) do
+    def run_method
+      Fiber.yield
+    end
+
+    def argsopts
+      argsopts = args ? args.dup : []
+      argsopts << opts if opts && !opts.empty?
+      argsopts
+    end
+  end
+
+end

data/lib/runaround/version.rb

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

data/lib/runaround.rb

@@ -0,0 +1,11 @@
+require "runaround/version"
+require "runaround/manager"
+require "runaround/instance_methods"
+
+module Runaround
+
+  def runaround
+    @runaround ||= Manager.new(self)
+  end
+
+end

data/runaround.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runaround/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "runaround"
+  spec.version       = Runaround::VERSION
+  spec.authors       = ["David Feldman"]
+  spec.email         = ["dbfeldman@gmail.com"]
+
+  spec.summary       = "Easy Callback System for Ruby Objects"
+  spec.description   = "Easy Callback System for Ruby Objects"
+  spec.homepage      = "https://github.com/fledman/runaround"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: runaround
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Feldman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-31 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Easy Callback System for Ruby Objects
+email:
+- dbfeldman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/runaround.rb
+- lib/runaround/callback_hook.rb
+- lib/runaround/errors.rb
+- lib/runaround/instance_methods.rb
+- lib/runaround/manager.rb
+- lib/runaround/method_call.rb
+- lib/runaround/version.rb
+- runaround.gemspec
+homepage: https://github.com/fledman/runaround
+licenses:
+- MIT
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Easy Callback System for Ruby Objects
+test_files: []