around_method 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9747d1cfda0d0f80ab16d2319c7d22e0622ee6c3
+  data.tar.gz: 114c54176b7e16ef93306ce6066bbf79279a5f96
+SHA512:
+  metadata.gz: 68e75d1d16be2071c5605b99dc4c5a458406eae3dd403a09c368989b593c9a986668e01a56312e8a73be2cc2b9817a110feb11399e8a884969d5c0cfba25202b
+  data.tar.gz: 8bde2450a38775efaa016d1c024a7f04b85f87577a2e92448fd33131733fa8c4ddb6a0eade22fd7aa7c4c3bf511986f717b698c8b957d25dbf7ec58c76022599

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.idea
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.rspec_status
+.ruby-version
+*.iml

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm: 2.4.2
+before_install: gem install bundler -v 1.15.4
+notifications:
+  email:
+    on_success: never
+    on_failure: change

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0
+
+- First release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Gregory Scott
+
+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,60 @@
+# AroundMethod
+
+AroundMethod is a Ruby gem for method composition. This gem was inspired by ActionController filters, but brings the same pattern to any Ruby class. :cool:
+
+[![Build Status](https://travis-ci.org/scottish613/around_method.svg?branch=master)](https://travis-ci.org/scottish613/around_method)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'around_method'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install around_method
+
+## Usage
+
+AroundMethod is automatically available on all classes.
+
+Currently, AroundMethod only supports wrapping _around_ methods. _Before_ and _after_ composition is planned for the future.
+
+#### Around
+
+```ruby
+class Class
+    around_method :wrapped, :wrapper
+
+    def wrapped
+      'cognito'
+    end
+
+    def wrapper
+      yield + ' ergo sum'
+    end
+end
+```
+
+Calling `wrapped` returns: `cognito ergo sum`
+
+## 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/scottish613/around_method.
+
+## 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/around_method.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'around_method/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'around_method'
+  spec.version       = AroundMethod::VERSION
+  spec.authors       = ['Gregory Scott']
+  spec.email         = ['gregory.c.scott@gmail.com']
+  spec.summary       = 'Ruby gem for method composition'
+  spec.homepage      = 'https://github.com/scottish613/around_method'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "around_method"
+
+# 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/around_method.rb

@@ -0,0 +1,7 @@
+require 'around_method/version'
+require 'around_method/core'
+
+# Make available to all classes.
+class Object
+  extend AroundMethod::Core
+end

data/lib/around_method/core.rb

@@ -0,0 +1,46 @@
+module AroundMethod
+  module Core
+    def around_method(method_name, wrapper_method)
+      apply_around_method(method_name, wrapper_method) if method_defined?(method_name)
+      around_method_wrapped[method_name] = wrapper_method
+    end
+
+    def apply_around_method(method_name, wrapper_method)
+      renamed_original_method = "#{method_name}_inner"
+      alias_method(renamed_original_method, method_name)
+      with_method_added_hook_disabled do
+        define_method(method_name) do
+          original_method_proc = method(renamed_original_method)
+          method(wrapper_method).call(&original_method_proc)
+        end
+      end
+    end
+
+    def method_added(method_name)
+      if around_method_wrapped.has_key?(method_name) && enable_method_added_hook?
+        apply_around_method(method_name, around_method_wrapped[method_name])
+      end
+      super
+    end
+
+    def around_method_wrapped
+      @around_method_wrapped ||= {}
+    end
+
+    def disable_method_added_hook?
+      @disable_method_added_hook
+    end
+
+    def enable_method_added_hook?
+      !disable_method_added_hook?
+    end
+
+    # Allow AroundMethod's method_added hook to be temporarily disabled,
+    # otherwise application will trigger an infinite loop.
+    def with_method_added_hook_disabled
+      @disable_method_added_hook = true
+      yield
+      @disable_method_added_hook = false
+    end
+  end
+end

data/lib/around_method/version.rb

@@ -0,0 +1,3 @@
+module AroundMethod
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: around_method
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregory Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- gregory.c.scott@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- around_method.gemspec
+- bin/console
+- bin/setup
+- lib/around_method.rb
+- lib/around_method/core.rb
+- lib/around_method/version.rb
+homepage: https://github.com/scottish613/around_method
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby gem for method composition
+test_files: []