hollaback 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f738463a8b1b0abeb5b51456d41365d7315cc59d
+  data.tar.gz: 5ef3503097683cfd440c0646725245e57fc4aa79
+SHA512:
+  metadata.gz: 4a574a01e9818b717949b1c3473ff5f2081508e0853f5c797e060922a6cf8b9a98ab2c619c287469e6363f7b94eb97d2bbaf8b4981b5ddb6e0b245b829d000ed
+  data.tar.gz: e050207bbc9b865f01400558ffc88f696d7f0c3f2ff0120e47eaa2ca4acb52e0a2b811c459f7530d24ea262f71bddae18245c330ac08bbcf5296dc0653096f60

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.0
+  Exclude:
+  - 'vendor/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': '[]'
+    '%i': '[]'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm: 2.3.1
+cache: bundler
+script:
+- bundle exec rake
+- bundle exec rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Localytics http://www.localytics.com
+
+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,68 @@
+# Hollaback
+
+[![Build Status](https://travis-ci.org/localytics/hollaback.svg?branch=master)](https://travis-ci.org/localytics/hollaback)
+[![Coverage Status](https://coveralls.io/repos/github/localytics/hollaback/badge.svg?branch=master)](https://coveralls.io/github/localytics/hollaback?branch=master)
+
+Builds method chains such that you can execute functions inside of a predefined set of callbacks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hollaback'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hollaback
+
+## Usage
+
+Sometimes you want to execute code in the context of hooks. With this gem you can build `before`, `after`, and `around` callbacks that are executed in the context of the given object. For `before`s and `after`s you can use either symbols are procs. For `around`s you can use symbols.
+
+```ruby
+class Callbacker
+  def say_hello
+    puts 'Hello!'
+  end
+
+  def say_goodbye
+    puts 'Goodbye!'
+  end
+
+  def say(&block)
+    puts 'speaking... '
+    puts yield
+    puts '...done.'
+  end
+end
+
+require 'hollaback'
+chain = Hollaback::Chain.new
+
+chain.before :say_hello
+chain.before { puts 'How are you?' }
+chain.after :say_goodbye
+chain.around :say
+
+chain.compile { '- Hollaback' }.call(Callbacker.new)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/localytics/hollaback.
+
+## 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,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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hollaback'
+
+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/hollaback.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hollaback/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hollaback'
+  spec.version       = Hollaback::VERSION
+  spec.authors       = ['Localytics']
+  spec.email         = ['oss@localytics.com']
+
+  spec.summary       = 'Add callbacks to your methods'
+  spec.homepage      = 'https://github.com/localytics/hollaback'
+  spec.license       = 'MIT'
+
+  files              = `git ls-files -z`.split("\x0")
+  spec.files         = files.reject { |f| f.match(%r{^test/}) }
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.39'
+end

data/lib/hollaback.rb

@@ -0,0 +1,4 @@
+require 'hollaback/callback'
+require 'hollaback/chain'
+require 'hollaback/sequence'
+require 'hollaback/version'

data/lib/hollaback/callback.rb

@@ -0,0 +1,19 @@
+module Hollaback
+  class Callback
+    attr_reader :type, :executable
+
+    def initialize(type, execute = nil, &block)
+      @type       = type
+      @executable = (execute ? execute : block)
+    end
+
+    def build
+      case executable
+      when Symbol
+        -> (target, &block) { target.send(executable, &block) }
+      when Proc
+        -> (target) { target.instance_eval(&executable) }
+      end
+    end
+  end
+end

data/lib/hollaback/chain.rb

@@ -0,0 +1,46 @@
+module Hollaback
+  class Chain
+    attr_reader :callbacks
+
+    def initialize
+      @callbacks = []
+    end
+
+    def +(other)
+      @callbacks += other.callbacks
+      self
+    end
+
+    def before(execute = nil, &block)
+      build(:before, execute, &block)
+    end
+
+    def after(execute = nil, &block)
+      build(:after, execute, &block)
+    end
+
+    def around(execute = nil, &block)
+      build(:around, execute, &block)
+    end
+
+    def empty?
+      callbacks.empty?
+    end
+
+    def compile(&block)
+      if empty?
+        block
+      else
+        callbacks.inject(Sequence.new(&block)) do |sequence, callback|
+          sequence.send(callback.type, &callback.build)
+        end
+      end
+    end
+
+    private
+
+    def build(type, execute, &block)
+      callbacks << Callback.new(type, execute, &block)
+    end
+  end
+end

data/lib/hollaback/sequence.rb

@@ -0,0 +1,35 @@
+module Hollaback
+  class Sequence
+    attr_reader :befores, :afters, :main
+
+    def initialize(args = {}, &main)
+      @main    = main
+      @befores = args.fetch(:befores, [])
+      @afters  = args.fetch(:afters, [])
+    end
+
+    def before(&before)
+      befores << before
+      self
+    end
+
+    def after(&after)
+      afters << after
+      self
+    end
+
+    # rubocop:disable Performance/RedundantBlockCall
+    def around(&around)
+      Sequence.new do |target|
+        around.call(target) { call(target) }
+      end
+    end
+
+    def call(target)
+      befores.each { |before| before.call(target) }
+      value = main.call(target)
+      afters.each { |after| after.call(target) }
+      value
+    end
+  end
+end

data/lib/hollaback/version.rb

@@ -0,0 +1,3 @@
+module Hollaback
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: hollaback
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Localytics
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.39'
+description: 
+email:
+- oss@localytics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hollaback.gemspec
+- lib/hollaback.rb
+- lib/hollaback/callback.rb
+- lib/hollaback/chain.rb
+- lib/hollaback/sequence.rb
+- lib/hollaback/version.rb
+homepage: https://github.com/localytics/hollaback
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Add callbacks to your methods
+test_files: []