hollerback 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21a8bd56b3df5ebea1b26455c0a5b6c2809fd511
+  data.tar.gz: a361d449b9348354535191074b42654278c7ff5c
+SHA512:
+  metadata.gz: 820a8794f73386258597bacf2c2652b62307a889ddfed0070038532d8765892250f8a588dbcd85f1ef7f7d718dfd8295257bc74b9a4daa7c3062ff51d97fe9e2
+  data.tar.gz: a8e79fa74cf348fb6decd9d92834f6b2b16f7e62aa9c1102b6725bc7a3e23a2fee3dd89825d2496c370fcb624f63084337a3f943a790b6a24990b595a8cb8145

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/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+rvm:
+  - ruby-head
+  - 2.3.0
+  - 2.2.4
+  - 2.1.8
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Get local or master 'rspec-hollerback-mocks' gem
+library_path = File.expand_path("../../rspec-hollerback-mocks", __FILE__)
+if File.exist?(library_path)
+  gem 'rspec-hollerback-mocks', path: library_path
+else
+  gem 'rspec-hollerback-mocks', git: "git://github.com/delner/rspec-hollerback-mocks.git",
+                    branch: ENV.fetch('BRANCH',"master")
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David Elner
+
+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,257 @@
+Hollerback
+==========
+
+[![Build Status](https://travis-ci.org/delner/hollerback.svg?branch=master)](https://travis-ci.org/delner/hollerback) ![Gem Version](https://badge.fury.io/rb/hollerback.svg)
+###### *For Ruby 2+*
+
+### Introduction
+
+Hollerback adds the callback pattern to your application, allowing you to easily implement DSL-like event handling to your application.
+
+```ruby
+note = NoteApi.get_note("Grocery List") do |on|
+  on.found do |note|
+    puts "Found an existing note!"
+  end
+  on.not_found do |name|
+    puts "Note is missing! Creating a new one."
+    Note.create!(name: name)
+  end
+  on.error do |error|
+    puts "Failed to retrieve note!"
+  end
+end
+```
+
+### Installation
+
+##### If you're not using Bundler...
+
+Install the gem via:
+
+```
+gem install hollerback
+```
+
+Then require it into your application with:
+
+```
+require 'hollerback'
+```
+
+##### If you're using Bundler...
+
+Add the gem to your Gemfile:
+
+```
+gem 'hollerback'
+```
+
+And then `bundle install` to install the gem and its dependencies.
+
+### Usage
+
+Enable the callback pattern by including the `Hollerback` module into the class/module you want to trigger callbacks.
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  def get_note(name)
+    # ...
+  end
+end
+```
+
+Then add a `&block` argument to the function you want to be callback enabled.
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  def get_note(name, &block)
+    # ...
+  end
+end
+```
+
+And use `hollerback_for` to get a set of callbacks you can invoke:
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  def get_note(name, &block)
+    hollerback_for(block) do |callbacks|
+      # ...
+    end
+  end
+end
+```
+
+Then trigger callbacks as you like, passing any arguments you need.
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  def get_note(name, &block)
+    # Creates Callbacks object from the block
+    hollerback_for(block) do |callbacks|
+      begin
+        # Retrieves a HTTP response
+        response = make_note_request(name: name)
+
+        # Invoke Callbacks
+        when response.status
+        case 200
+          callbacks.respond_with(:found, response.body)
+        case 404
+          callbacks.respond_with(:not_found, name)
+        end
+      rescue => e
+        callbacks.respond_with(:error, e) 
+      end
+    end
+  end
+end
+```
+
+And finally use your newly callback-enabled function with your callback DSL:
+
+```ruby
+def write_note(name, content)
+  note = NoteApi.new.get_note("Grocery List") do |on|
+    on.found do |note_json|
+      Note.from_json(note_json)
+    end
+    on.not_found do |name|
+      Note.create!(name: name)
+    end
+    on.error do |error|
+      raise "Failed to retrieve note! Reason: #{error.message}"
+    end
+  end
+
+  note.append(content)
+end
+```
+
+### Features
+
+##### #hollerback_for
+
+Converts an anonymous callback block into a `Hollerback::Callbacks` object that you can invoke callbacks from. Can be called as an instance or class method from any class that includes `Hollerback`.
+
+```ruby
+class NoteApi
+  include Hollerback
+
+  def self.get_note(name, &block)
+    hollerback_for(block) do |callbacks|
+      # ...
+    end
+  end
+
+  def get_note(name, &block)
+    hollerback_for(block) do |callbacks|
+      # ...
+    end
+  end
+end
+```
+
+This is the equivalent of:
+
+```ruby
+def get_note(name, &block)
+  callbacks = Hollerback::Callbacks.new(block)
+end
+```
+
+If you override the behavior of `Hollerback::Callbacks` in a subclass, you can use it as your callbacks object instead:
+
+```ruby
+class NoteCallbacks < Hollerback::Callbacks
+  # ...
+end
+
+class NoteApi
+  include Hollerback
+
+  def get_note(name, &block)
+    hollerback_for(block, callback_class: NoteCallbacks) do |callbacks|
+      # ...
+    end
+  end
+end
+```
+
+##### #respond_with
+
+Triggers a callback, passing any arguments along. If the callback isn't defined, it raises a `NoMethodError`.
+
+```ruby
+callbacks_block = Proc.new do |on|
+  on.no_args { "No args." }
+  on.with_args { |a, b|  "#{a}, #{b}" }
+  on.with_arg_list { |*args| args }
+  on.with_arg_block { |&block| block.call }
+end
+
+callbacks = Hollerback::Callbacks.new(callbacks_block)
+
+callbacks.respond_with(:no_args)
+# => "No args."
+callbacks.respond_with(:with_args, 1, 2)
+# => "1, 2"
+callbacks.respond_with(:with_arg_list, *[1,2,3])
+# => [1,2,3]
+callbacks.respond_with(:with_arg_block, &(Proc.new { "Block called." }))
+# => "Block called."
+callbacks.respond_with(:some_nonexisting_callback)
+# => NoMethodError: No callback 'some_nonexisting_callback' is defined.
+```
+
+##### #try_respond_with
+
+Triggers a callback like `respond_with`, passing any arguments along. If the callback isn't defined, it returns `nil`.
+
+```ruby
+callbacks_block = Proc.new do |on|
+  on.no_args { "No args." }
+end
+
+callbacks = Hollerback::Callbacks.new(callbacks_block)
+
+callbacks.try_respond_with(:no_args)
+# => "No args."
+callbacks.try_respond_with(:some_nonexisting_callback)
+# => nil
+```
+
+### Testing
+
+If you're writing RSpec tests around code that uses callbacks, you can mock callbacks using the `rspec-hollerback-mocks` gem.
+
+```ruby
+it { expect(NoteApi).to receive(:get_note).with(name).and_callback(:found, note) }
+```
+
+Check out the [`rspec-hollerback-mocks`](https://github.com/delner/rspec-hollerback-mocks) gem to learn more.
+
+## Development
+
+Install dependencies using `bundle install`. Run tests using `bundle exec rspec`
+
+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/delner/rspec-hollerback-mocks.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hollerback"
+
+# 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

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/hollerback.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hollerback/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hollerback"
+  spec.version       = Hollerback::VERSION
+  spec.authors       = ["David Elner"]
+  spec.email         = ["david@davidelner.com"]
+
+  spec.summary       = %q{Simple DSL-like callback pattern for Ruby classes.}
+  spec.homepage      = "https://github.com/delner/hollerback"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-hollerback-mocks", "~> 0.1"
+  spec.add_development_dependency "pry"
+end

data/lib/hollerback.rb

@@ -0,0 +1,3 @@
+require "hollerback/version"
+
+require 'hollerback/callbacks'

data/lib/hollerback/callbacks.rb

@@ -0,0 +1,46 @@
+module Hollerback
+  def self.included(base)
+    base.send(:include, InstanceMethods)
+    base.extend(ClassMethods)
+  end
+
+  module InstanceMethods
+    def hollerback_for(callback_block, callback_class: Callbacks, &block)
+      self.class.hollerback_for(callback_block, &block)
+    end
+  end
+
+  module ClassMethods
+    def hollerback_for(callback_block, callback_class: Callbacks, &block)
+      callbacks = callback_class.new(callback_block)
+      block.call(callbacks)
+    end
+  end
+
+  class Callbacks
+    def initialize(block)
+      self.tap { |proxy| block.call(proxy) if block }
+    end
+
+    def respond_with(callback, *args)
+      if callbacks.has_key?(callback)
+        callbacks[callback].call(*args)
+      else
+        raise NoMethodError.new("No callback '#{callback.to_s}'' is defined.")
+      end
+    end
+    def try_respond_with(callback, *args)
+      callbacks[callback].call(*args) if callbacks.has_key?(callback)
+    end
+
+    def method_missing(m, *args, &block)
+      block ? callbacks[m] = block : super
+      self
+    end
+
+    protected
+    def callbacks
+      @callbacks ||= {}
+    end
+  end
+end

data/lib/hollerback/version.rb

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

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: hollerback
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Elner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec-hollerback-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- david@davidelner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hollerback.gemspec
+- lib/hollerback.rb
+- lib/hollerback/callbacks.rb
+- lib/hollerback/version.rb
+homepage: https://github.com/delner/hollerback
+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: Simple DSL-like callback pattern for Ruby classes.
+test_files: []