ianwhite-hark 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b71c62889085f5896f266c976ae49d855d550917
-  data.tar.gz: 9f69d753ec889c9cf354b1586c68313604cbeaf3
+  metadata.gz: 257615d2c004b4af5d262c95bc085cc04a20113c
+  data.tar.gz: 6b53aeb761b46d56f932fe054866142f2e7b8657
 SHA512:
-  metadata.gz: 7c690463f3539c9b835b3ed34b09cdcaa64d642f37a51eb63f441812274888b7ee93f8f1ce40b6afa1de957b3f9056de68b7cd2860b6181d10898eca851f7425
-  data.tar.gz: f79b3613750fc960271a57091f966ea02b6b17a35f6c9d19087b35715d3b6e4ac154efc53a1390adbe6b5a6a5692fa69970d98402da2c90466c2ec0a09ff3c41
+  metadata.gz: c003deb6ef1d73e06cf9d06e17f06abc56d9ed99f6ca44b29eec664f51d4f0a9b3363c8d347e3dbac632419e8c891b1dcdb97d70af37285e8b6e7bb7b4109c6d
+  data.tar.gz: 0efa1f2ac66c433f8fb1b90d271dedfe135c995ef1300aa61c8fa63232731392460c308662d26b2db382cdbab5a478f6fced2ec7737f46721952301bc0ae3d78

data/README.md

@@ -1,13 +1,31 @@
-# Hark
+# Hark [![Code Climate](https://codeclimate.com/repos/52691919c7f3a37a2301dfc5/badges/8f5a4caa333ec7a654ec/gpa.png)](https://codeclimate.com/repos/52691919c7f3a37a2301dfc5/feed) [![Build Status](https://travis-ci.org/ianwhite/hark.png)](https://travis-ci.org/ianwhite/hark)
 
 Create an ad-hoc listener object with hark.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ianwhite-hark'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ianwhite-hark
+
+## Usage
+
 The idea behind hark is that the objects that receive listeners shouldn't need to perform any ceremony on
 them, just treat them as objects that respond to messages.  It's up to the caller to provide these lsitener objects,
-and to decide how they behave (re: lax), perhaps smushing together listeners (re: add).  If required, these ad-hoc
+and to decide how they behave, perhaps combining together listeners (in an subscriber fashion).  If required, these ad-hoc
 listeners can easily be refactored into classes in their own right, as the recievers don't need to know anything about
 hark.
 
+Tell don't ask style is encouraged with hark.  That said, the return value for a message sent to a hark listener is an array of all of the return values.
+
     listener = hark success: ->{ "succeeded" }, failure: ->{ "failed" }
     listener.success # => ["succeeded"]
     listener.failure # => ["failed"]
@@ -38,27 +56,23 @@ To add new messages to a listener, use #hark
 
 To decorate an object (of any sort) so that it becomes a hark listener (and therefore can be smushed etc)
 
-    listener = object.to_hark
+    listener = hark(object)
 
 The listener is immutable, #strict, #lax, and #hark all return new listeners
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'ianwhite-hark'
-
-And then execute:
+Here's an example from a rails controller
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ianwhite-hark
-
-## Usage
+    def create
+      SignupNewUser.new params, hark(create_response, SignupEmailer.new)
+    end
 
-TODO: Write usage instructions here
+    # response block style
+    def create_response
+      hark do |on|
+        on.signed_up {|user| redirect_to user, notice: "Signed up!" }
+        on.invalid {|user| render "new", user: user }
+      end
+    end
 
 ## Contributing
 

data/lib/hark/core_ext.rb

@@ -2,8 +2,4 @@ module Kernel
   def hark *args, &block
     Hark.from *args, &block
   end
-
-  def to_hark *args, &block
-    Hark.from self, *args, &block
-  end
 end

data/lib/hark/version.rb

@@ -1,3 +1,3 @@
 module Hark
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/hark_spec.rb

@@ -91,8 +91,8 @@ describe Hark do
     it_should_behave_like "a success/failure hark listener"
   end
 
-  describe "object.to_hark" do
-    Given(:listener) { PlainListener.new(transcript).to_hark }
+  describe "hark object" do
+    Given(:listener) { hark PlainListener.new(transcript) }
 
     it_should_behave_like "a success/failure hark listener"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ianwhite-hark
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ian White