riposte 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc4c3dbdd6f02ea0d480764a7506c80bf808716f
-  data.tar.gz: b52d3a57a4803993543a76f0cce88d7187fd6f61
+  metadata.gz: 4e9cda507520daceedc0086ce4849f3295d6fa2e
+  data.tar.gz: 824567160f1b611ed44468ca7555514be2d6cd8c
 SHA512:
-  metadata.gz: 7f5970083c0671f3f7023911ac7a6e96ceb20462c017dcaba5888d7b0e9d7088bafd1af3e70f864b076e138fb96cdbe988b3d9c7a72f60c86442ac27c86720ce
-  data.tar.gz: f7815f999b43a870cdfecf71fe050d2d4605e2472270084126dc047d4f305c67901d1150c6c5d9c46cc1e817d793a0440bf9b86a18224276b2ff4ec4bb121261
+  metadata.gz: af45e32761319a78417c5946e140039d60c6d4d627e15ae4db8a7b5299e4d8179c6919f5017b0a6962e141b7bcbefe8deb47968becd6e9ccd540cf4c8dead25e
+  data.tar.gz: 3dfd8b6637d685e7ee0f60fed3fa4f0014eef8fb1467b3c95191228db660ff767382809def44cd0675126607680a562b586d93d4ecfc5ae93569eb5d416d3af6

data/README.md

@@ -1,6 +1,14 @@
 # Riposte
 
-TODO: Write a gem description
+Riposte was put together to scratch an itch that I had when working with
+multiple outcomes of telling an object what to do and then responding
+differently depending on the results of the action. This happens all the
+time in the software that I right. I want to save an object to the
+database and I can't because of the object not meeting the database
+requirements, or the database is down. I might have a whole host of
+different responses for the user. This is where Riposte is geared. It is
+a very small gem, and I hope to keep it that way. Finally after years of
+using similar ideas I've finally made a gem out of it.
 
 ## Installation
 
@@ -20,12 +28,50 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+I'm going to show an example usage within a basic Rails application
+because that is where I've found this to be used the most.
+
+```ruby
+class MyController < ApplicationController
+  def create
+    @article = Article.new
+
+    @article.publish { |on|
+      on.published { send_email_to_subscribers }
+      on.invalid { handle_invalid }
+      on.exception { database_down_handler }
+    }
+
+    respond_with @artcile
+  end
+end
+
+class Article < ActiveRecord::Base
+  include Riposte::Helper
+
+   def publish(&block)
+     if valid?
+       #publish logic
+       react_to :published, &block
+     else
+       #failure logic
+       react_to :invalid, &block
+     end
+   rescue SomeError => e
+     react_to :exception, &block
+   end
+end
+```
+
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/riposte/fork )
+1. Fork it ( https://github.com/adkron/riposte/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+  Licensed under the MIT license. See the LICENSE.txt file for more
+  details.

data/lib/riposte.rb

@@ -1,27 +1,6 @@
 require "riposte/version"
+require "riposte/reaction"
+require "riposte/helper"
 
 module Riposte
-  class Reaction
-    attr_accessor :type
-
-    def initialize(type)
-      self.type = type
-    end
-
-    def method_missing(name, *)
-      if name == type
-        yield if block_given?
-      end
-    end
-
-    def respond_to_missing?(*)
-      true
-    end
-
-    module Helper
-      def react_to(type, with: ->() {})
-        with.call Reaction.new(type)
-      end
-    end
-  end
 end

data/lib/riposte/helper.rb

@@ -0,0 +1,9 @@
+module Riposte
+  module Helper
+    def react_to(type)
+      Reaction.new(type).tap { |reaction|
+        yield reaction if block_given?
+      }
+    end
+  end
+end

data/lib/riposte/reaction.rb

@@ -0,0 +1,23 @@
+module Riposte
+  class Reaction
+    attr_accessor :type
+
+    def initialize(type)
+      self.type = type
+    end
+
+    def method_missing(name, *)
+      if name == type
+        yield if block_given?
+      end
+    end
+
+    def respond_to_missing?(*)
+      true
+    end
+
+    def ==(other)
+      [self.class, self.type] == [other.class, other.type]
+    end
+  end
+end

data/lib/riposte/version.rb

@@ -1,3 +1,3 @@
 module Riposte
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/helper_spec.rb

@@ -0,0 +1,25 @@
+require "riposte/helper"
+
+module Riposte
+  describe Helper do
+    let(:described_class) {
+      Class.new {
+        include Riposte::Helper
+      }
+    }
+
+    subject { described_class.new }
+
+    context "#react_to with no block" do
+      it do
+        expect(subject.react_to(:foo)).to eq(Riposte::Reaction.new(:foo))
+      end
+    end
+
+    context "#react_to with a block" do
+      it do
+        expect {|b| subject.react_to(:foo, &b) }.to yield_with_args(Riposte::Reaction.new(:foo))
+      end
+    end
+  end
+end

data/spec/{riposte_spec.rb → reaction_spec.rb}

@@ -1,4 +1,4 @@
-require "riposte"
+require "riposte/reaction"
 
 module Riposte
   describe Reaction do
@@ -20,5 +20,9 @@ module Riposte
       subject.response_type { called = true }
       expect(called).to be_truthy
     end
+
+    it "is equal to another reaction with the same type" do
+      expect(subject).to eq(described_class.new(:response_type))
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riposte
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Amos L King
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -65,9 +65,12 @@ files:
 - README.md
 - Rakefile
 - lib/riposte.rb
+- lib/riposte/helper.rb
+- lib/riposte/reaction.rb
 - lib/riposte/version.rb
 - riposte.gemspec
-- spec/riposte_spec.rb
+- spec/helper_spec.rb
+- spec/reaction_spec.rb
 homepage: https://github.com/BinaryNoggin/riposte
 licenses:
 - MIT
@@ -93,4 +96,5 @@ signing_key:
 specification_version: 4
 summary: A micro-gem for handling different outcomes of an action
 test_files:
-- spec/riposte_spec.rb
+- spec/helper_spec.rb
+- spec/reaction_spec.rb