konamio 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37ffc53d7fc6b46bcbb18189e27cc170152dc44c
-  data.tar.gz: 924d388a7c51e926ffecb6ffbc8058326ac7eca9
+  metadata.gz: 9355bbc85a0b405369b30b96176d3275749a69a9
+  data.tar.gz: c9610b2b28cc66a1f96bce6e0f470422fc80fbff
 SHA512:
-  metadata.gz: 7bb9c6a000e52adea2c05c8f8c75a0e40350e35bce0fb650222260bb7805782337acef371cf2601c902e780ff3f9bae0bc3598c59341ba3da3091dbca549cae5
-  data.tar.gz: 889017b85fd30f1e188af487f320c4660b8cbcc413bbc8f3c9c8478dccdfb0c3e7b8e8bbf144598f33fa204cd90496de4036cb27ac16958e7077ff6840f645ae
+  metadata.gz: dfcb60568f3c7289ae2eec4b0ac44066e7f80216841fe7bfcef3d91f420910907a8f1ac9dc9b1426f0b2857f52be40d6400adc31e1db034b240e17bad5c4e421
+  data.tar.gz: d224f73499c5ced6f5e21b6976a667bc09f64792aa619d7fe786906a410ef6242b87f0fc4788220234d69be8c16d1d73d254be64910e04a9e1045c6544ed02c3

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/konamio.png)](http://badge.fury.io/rb/konamio)  [![Build Status](https://travis-ci.org/rthbound/konamio.png?branch=master)](https://travis-ci.org/rthbound/konamio) [![Coverage Status](https://coveralls.io/repos/rthbound/konamio/badge.png)](https://coveralls.io/r/rthbound/konamio) [![Code Climate](https://codeclimate.com/github/rthbound/konamio.png)](https://codeclimate.com/github/rthbound/konamio)
 
-
 ![Konami Code](http://images.nintendolife.com/news/2012/01/the_origins_of_the_konami_code_revealed/attachment/0/small.jpg)
 
     gem install konamio
@@ -26,9 +25,12 @@ Good job, you.
 
 #### Sequences
 
-You can configure it to listen for any ascii based sequence you want. This can be specified using a string (`"foobar"`) or an array of recognized symbols and one character strings (escaped characters are okay, e.g. `[:up, "1", "2", "3", "\t"]`):
+You can configure it to listen for any ascii based sequence you want
+using the `:sequence` option. This can be specified using a string
+(`"foobar"`) or an array of recognized symbols and one-character strings
+(escaped charactersare okay, e.g. `[:up, "1", "2", "3", "\t"]`):
 
-```ruby
+```
 > Konamio::Sequence::Requisition.new({
     sequence:     "a".upto("z").to_a.reverse,
     prompt:       "Say the alphabet backwards",
@@ -43,7 +45,7 @@ Okay, you can go
 
 #### Output
 
-There are three dialogs that Konamio might send to standard out.
+There are three dialogs that Konamio might send to stdout.
 
 1. `:prompt` is the dialog displayed initially, and each time the user fails to supply the proper sequence.
 2. `:confirmation` is displayed when the required sequence is entered properly.
@@ -53,7 +55,11 @@ You can customize any of these dialogs, or disable them individually by passing
 
 #### Success!
 
-It would be boring if all Konamio did was return a result object. In fact, `Konamio::Sequence::Requisition#execute!` takes a block, and will execute that block when the sequence has been successfully entered. You're limited only by your imagination and the context of your application.
+It would be boring if all Konamio did was return a result object. That's why
+`Konamio::Sequence::Requisition#execute!` **takes a block**, and will execute
+that block when the sequence has been successfully entered. You're limited only
+by your imagination and the context of your application. Konamio will supply
+the value of the sequence to the block.
 
 The following code would prompt the user to enter the konami code twice:
 ```ruby

data/lib/konamio/sequence/requisition.rb

@@ -24,13 +24,14 @@ module Konamio
       end
 
       # @api public
+      # @yield [sequence] Gives the sequence to the block
       # @yieldreturn The result of a block, if supplied
       # @return Konamio::Result
       def execute! &block
         prompt
 
         result = listen(@sequence)
-        yield if block_given? && result.successful?
+        yield(@sequence) if block_given? && result.successful?
 
         result
       end

data/lib/konamio/version.rb

@@ -1,3 +1,3 @@
 module Konamio
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/konamio/sequence/requisition_cancelled_test.rb

@@ -9,7 +9,7 @@ describe Konamio::Sequence::Requisition do
       prompt:   @prompt           = false,
       listener: @listener         = MiniTest::Mock.new,
       speaker:  @speaker          = MiniTest::Mock.new,
-      sequence: @sequence         = ["a"],
+      sequence: @sequence         = "ab",
       confirmation: @confirmation = false,
       cancellation: false
     }
@@ -22,10 +22,6 @@ describe Konamio::Sequence::Requisition do
     @listener_result   = MiniTest::Mock.new
     @listener_instance.expect(:execute!, @listener_result)
 
-    # The @listener_result contains some data
-    @data_hash = MiniTest::Mock.new
-    @listener_result.expect(:data, @data_hash)
-    @data_hash.expect(:[], :negative, [:sequence])
   end
 
   it "can be initialized" do
@@ -37,6 +33,27 @@ describe Konamio::Sequence::Requisition do
   end
 
   it "can be cancelled" do
+    # The @listener_result contains some data
+    @data_hash = MiniTest::Mock.new
+    @listener_result.expect(:data, @data_hash)
+    @data_hash.expect(:[], :negative, [:sequence])
+
+    assert !@subject.new(@options).execute!.successful?
+  end
+
+  it "will listen for the next character" do
+    # This will happen a second time
+    @listener.expect(:new, @listener_instance, [{ sequence: "b", input: @input }])
+    @listener_instance.expect(:execute!, @listener_result)
+
+    # The @listener_result contains some data
+    @data_hash = MiniTest::Mock.new
+    @listener_result.expect(:data, @data_hash)
+    @data_hash.expect(:[], "b", [:sequence])
+
+    @listener_result.expect(:data, @data_hash)
+    @data_hash.expect(:[], :negative, [:sequence])
+
     assert !@subject.new(@options).execute!.successful?
   end
 end

data/test/konamio/sequence/requisition_test.rb

@@ -59,4 +59,13 @@ describe Konamio::Sequence::Requisition do
     @speaker.expect(:new,  @speaker_instance,  [{ prompt: "konamio!", output: @output }])
     assert @subject.new(@options).execute! { @speaker.new(prompt: "konamio!", output: @output) }
   end
+
+  it "will pass the sequence to the block" do
+    truth = false
+    assert @subject.new(@options).execute! { |seq|
+      truth = !truth if @sequence == seq
+    }
+
+    assert truth
+  end
 end

data/test/minitest_helper.rb

@@ -1,6 +1,8 @@
 # Testing frameworks
-require 'coveralls'
-Coveralls.wear!
+#require 'coveralls'
+#Coveralls.wear!
+require 'simplecov'
+SimpleCov.start
 
 require "minitest/autorun"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konamio
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Tad Hosford