konamio 0.2.2 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37ffc53d7fc6b46bcbb18189e27cc170152dc44c
+  data.tar.gz: 924d388a7c51e926ffecb6ffbc8058326ac7eca9
+SHA512:
+  metadata.gz: 7bb9c6a000e52adea2c05c8f8c75a0e40350e35bce0fb650222260bb7805782337acef371cf2601c902e780ff3f9bae0bc3598c59341ba3da3091dbca549cae5
+  data.tar.gz: 889017b85fd30f1e188af487f320c4660b8cbcc413bbc8f3c9c8478dccdfb0c3e7b8e8bbf144598f33fa204cd90496de4036cb27ac16958e7077ff6840f645ae

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.0.0"
+script: bundle exec rake test

data/README.md

@@ -1,5 +1,8 @@
 ## Konamio
 
+[![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
@@ -9,18 +12,23 @@ and
     require "konamio"
 
 
-Default Usage:
+### Default Usage
 ```
 > Konamio::Sequence::Requisition.new.execute!
 Enter konami code (or hit escape)
 Good job, you.
-=> #<PayDirt::Result:0x937ddb4
+=> #<Konamio::Result:0x937ddb4
   @data={:data=>{:confirmation=>"Good job, you."}},
   @success=true>
 ```
 
-You can configure it to listen for any sequence you want:
-```
+### Configuration
+
+#### 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"]`):
+
+```ruby
 > Konamio::Sequence::Requisition.new({
     sequence:     "a".upto("z").to_a.reverse,
     prompt:       "Say the alphabet backwards",
@@ -28,18 +36,31 @@ You can configure it to listen for any sequence you want:
   }).execute!
 Say the alphabet backwards
 Okay, you can go
-=> #<PayDirt::Result:0x9265788
+=> #<Konamio::Result:0x9265788
   @data={:data=>{:confirmation=>"Okay, you can go"}},
   @success=true>
 ```
 
-You can also specify a block of code to be executed when the sequence is received successfully.
+#### Output
+
+There are three dialogs that Konamio might send to standard out.
+
+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.
+3. `:cancellation` is displayed when user terminates by pressing the escape key.
+
+You can customize any of these dialogs, or disable them individually by passing a falsey value.
+
+#### 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.
+
 The following code would prompt the user to enter the konami code twice:
-```
+```ruby
 Konamio::Sequence::Requisition.new.execute! { Konamio::Sequence::Requisition.new.execute! }
 ```
 This would give you +30 lives:
-```
+```ruby
 Konamio::Sequence::Requisition.new.execute! { 30.times { puts "+1up" } }
 ```
 
@@ -53,10 +74,7 @@ Konamio::Sequence::Requisition.new.execute! { 30.times { puts "+1up" } }
 
 ```ruby
 require "konamio"
-Konamio::Sequence::Requisition.new.execute!
+Konamio::Sequence::Requisition.new(prompt: false, confirmation: false, cancellation: false).execute!
 ```
-    
-to require console users to enter the konami code, or to require some other password:
 
-    require "konamio"
-    Konamio::Sequence::Requisition.new(sequence: "foobar").execute!
+to require console users to enter the konami code. This funny trick obviously does not provide any real protection, but it would certainly make for a nasty practical joke.

data/konamio.gemspec

@@ -7,16 +7,17 @@ Gem::Specification.new do |s|
   s.version     = Konamio::VERSION
   s.authors     = ["Tad Hosford"]
   s.email       = ["tad.hosford@gmail.com"]
-  s.homepage    = "https://github.com/rthbound/konamio"
-  s.summary     = "I'm gonna recognize the konami sequence"
-  s.description = "Recognize sequences in Ruby... just for fun."
+  s.homepage    = "https://rthbound.github.io/konamio"
+  s.summary     = "The Ruby Konami code gem."
+  s.description = "Tell it which sequence to listen for and what to do when the sequence is received."
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "pay_dirt"
+  s.add_runtime_dependency "pay_dirt", "1.0.0"
   s.add_development_dependency "minitest"
   s.add_development_dependency "pry"
   s.add_development_dependency "rake"
+  s.add_development_dependency "coveralls"
 end

data/lib/konamio/base.rb

@@ -0,0 +1,5 @@
+module Konamio
+  # A basic service object
+  class Base < PayDirt::Base
+  end
+end

data/lib/konamio/prompt.rb

@@ -1,5 +1,5 @@
 module Konamio
-  class Prompt < PayDirt::Base
+  class Prompt < Konamio::Base
     def initialize(options)
       options = {
         output: $stdout
@@ -9,8 +9,8 @@ module Konamio
     end
 
     def execute!
-      @output.puts @prompt
-      return PayDirt::Result.new(success: true, data: { prompted: @prompt })
+      prompt
+      return Konamio::Result.new(success: true, data: { prompted: @prompt })
     end
 
     def prompt

data/lib/konamio/result.rb

@@ -0,0 +1,5 @@
+module Konamio
+  # The object all my service objects will return
+  class Result < PayDirt::Result
+  end
+end

data/lib/konamio/sequence/listener.rb

@@ -1,6 +1,6 @@
 module Konamio
   module Sequence
-    class Listener < PayDirt::Base
+    class Listener < Konamio::Base
       include Konamio::KeyMap
 
       def initialize(options)
@@ -11,13 +11,11 @@ module Konamio
       def execute!
         case listen
         when true
-          return PayDirt::Result.new(success: true, data: { sequence: @sequence[1..-1]})
+          return Konamio::Result.new(success: true, data: { sequence: @sequence[1..-1]})
         when false
-          return PayDirt::Result.new(success: false, data: { sequence: @sequence })
+          return Konamio::Result.new(success: false, data: { sequence: @sequence })
         when :negative
-          return PayDirt::Result.new(success: false, data: { sequence: :negative })
-        else
-          return PayDirt::Result.new(success: false, data: { sequence: @sequence })
+          return Konamio::Result.new(success: false, data: { sequence: :negative })
         end
       end
 

data/lib/konamio/sequence/requisition.rb

@@ -1,15 +1,21 @@
 module Konamio
   module Sequence
-    class Requisition < PayDirt::Base
+    class Requisition < Konamio::Base
       include Konamio::KeyMap
+      # @param [Hash] options The group of options for the sequence requisition
+      # @option options [Class] :speaker (Konamio::Prompt) You could theoretically replace this with a class that responds to #new with an instance that responds to #execute! Not sure why you would.
+      # @option options [String] :prompt ("Enter konami code (or hit escape)") override with a falsey value to skip prompt dialog
+      # @option options [String] :confirmation ("Enter konami code (or hit escape)") override with a falsey value to skip confirmation dialog
+      # @option options [String] :cancellation ("Goodbye!") override with a falsey value to skip cancellation dialog
+      # @option options [Array, String] :sequence ([:up,:up,:down,:down,:left,:right,:left,:right,"B","A"])
       def initialize(options={})
         options = {
-          output:       $stdout,
           input:        $stdin,
-          speaker:      Konamio::Prompt,
+          output:       $stdout,
           listener:     Konamio::Sequence::Listener,
-          sequence:     [:up,:up,:down,:down,:left,:right,:left,:right,"B","A"],
+          speaker:      Konamio::Prompt,
           prompt:       "Enter konami code (or hit escape)",
+          sequence:     [:up,:up,:down,:down,:left,:right,:left,:right,"B","A"],
           confirmation: "Good job, you.",
           cancellation: "Goodbye!"
         }.merge(options)
@@ -17,23 +23,39 @@ module Konamio
         load_options(:sequence, options)
       end
 
+      # @api public
+      # @yieldreturn The result of a block, if supplied
+      # @return Konamio::Result
       def execute! &block
         prompt
+
         result = listen(@sequence)
         yield if block_given? && result.successful?
-        return result
+
+        result
       end
 
-      def prompt(prompt = @prompt)
-        @speaker.new(prompt: prompt, output: @output).execute!
+      private
+      # @api private
+      # @param prompt
+      # @return [Konamio::Result] unless running silently
+      # @return [Boolean] false if running silently
+      def prompt(prompt = @prompt, speaker = @speaker)
+        !!prompt && speaker.new(prompt: prompt, output: @output).execute!
       end
 
+      # @api private
+      # @param [String, Array<String,Symbol>] sequence The sequence you want to require. When providing an array, each element must be a recognized symbol or the string representation of an ascii character.
+      # @return [Konamio::Result]
       def listen(sequence)
         listener = @listener.new(sequence: sequence, input: @input)
         received = listener.execute!
         signal   = received.data[:sequence]
 
-        prompt(@confirmation) and return result(true, data: { confirmation: @confirmation }) if signal.empty?
+        if signal.empty?
+          prompt(@confirmation)
+          return result true, data: { confirmation: @confirmation }
+        end
 
         case signal
         when :negative
@@ -43,28 +65,17 @@ module Konamio
           prompt
           listen(@sequence)
         when sequence[1..-1]
-          listen received.data[:sequence]
-        else
-          result(false, data: { confirmation: "Unexpected termination" })
+          listen signal
         end
-        #if received.successful?
-        #  if received.data[:sequence].empty?
-        #    prompt(@confirmation)
-        #    result(true, data: { confirmation: @confirmation })
-        #  else
-        #    listen(received.data[:sequence])
-        #  end
-        #elsif received.data[:terminate]
-        #  prompt("Goodbye!")
-        #  result(false, data: { confirmation: :negative })
-        #else
-        #  prompt
-        #  listen(@sequence)
-        #end
       end
 
+      # @api private
+      # @param [Boolean] success whether the expected sequence was received.
+      # @param [Hash] ({}) data
+      # @option data [String, Boolean] :confirmation A message about how the program exited.
+      # @return [Konamio::Result]
       def result(success, data={})
-        PayDirt::Result.new(success: success, data: data)
+        Konamio::Result.new(success: success, data: data)
       end
     end
   end

data/lib/konamio/version.rb

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

data/lib/konamio.rb

@@ -1,6 +1,8 @@
 require "pay_dirt"
-require "io/console"
+require_relative 'konamio/base'
+require_relative 'konamio/result'
 
+require "io/console"
 require_relative 'konamio/key_map'
 require_relative 'konamio/sequence/listener'
 require_relative 'konamio/prompt'

data/test/konamio/sequence/listener_test.rb

@@ -27,4 +27,12 @@ describe Konamio::Sequence::Listener do
     assert @input.verify
     assert !result.successful?
   end
+
+  it "lets you escape" do
+    @input.expect(:getch, "\e")
+    @input.expect(:getch, "")
+    @input.expect(:getch, "")
+    result = @subject.new(sequence: @sequence, input: @input).execute!
+    assert !result.successful?
+  end
 end

data/test/konamio/sequence/requisition_cancelled_test.rb

@@ -0,0 +1,42 @@
+require "minitest_helper"
+
+describe Konamio::Sequence::Requisition do
+  before do
+    @subject = Konamio::Sequence::Requisition
+    @options = {
+      input:    @input            = MiniTest::Mock.new,
+      output:   @output           = MiniTest::Mock.new,
+      prompt:   @prompt           = false,
+      listener: @listener         = MiniTest::Mock.new,
+      speaker:  @speaker          = MiniTest::Mock.new,
+      sequence: @sequence         = ["a"],
+      confirmation: @confirmation = false,
+      cancellation: false
+    }
+
+    # We will call new on @listener and return
+    @listener_instance = MiniTest::Mock.new
+    @listener.expect(:new, @listener_instance, [{ sequence: @sequence, input: @input }])
+
+    # We will call execute! on the @listener_instance and return
+    @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
+    @subject.must_respond_to :new
+  end
+
+  it "must execute" do
+    @subject.new(@options).must_respond_to :execute!
+  end
+
+  it "can be cancelled" do
+    assert !@subject.new(@options).execute!.successful?
+  end
+end

data/test/konamio/sequence/requisition_test.rb

@@ -16,16 +16,24 @@ describe Konamio::Sequence::Requisition do
     @speaker_instance = MiniTest::Mock.new
     @speaker_result   = MiniTest::Mock.new
     @speaker_instance.expect(:execute!, @speaker_result)
+    @speaker_instance.expect(:execute!, @speaker_result)
 
     @listener_instance = MiniTest::Mock.new
     @listener_result   = MiniTest::Mock.new
     @listener_instance.expect(:execute!, @listener_result)
+    @listener_instance.expect(:execute!, @listener_result)
+
+    @speaker.expect(:new,  @speaker_instance,  [{ prompt: @prompt, output: @output }])
+    @listener.expect(:new, @listener_instance, [{ sequence: @sequence, input: @input }])
+    @data_hash = MiniTest::Mock.new
+    @listener_result.expect(:data, @data_hash)
+    @data_hash.expect(:[], ["a"], [:sequence])
 
     @speaker.expect(:new,  @speaker_instance,  [{ prompt: @prompt, output: @output }])
     @listener.expect(:new, @listener_instance, [{ sequence: @sequence, input: @input }])
     @data_hash = MiniTest::Mock.new
     @listener_result.expect(:data, @data_hash)
-    @data_hash.expect(:[], "", [:sequence])
+    @data_hash.expect(:[], [], [:sequence])
 
     @speaker_confirmation_instance = MiniTest::Mock.new
     @speaker_confirmation_result = MiniTest::Mock.new

data/test/minitest_helper.rb

@@ -1,7 +1,8 @@
 # Testing frameworks
-require "minitest/spec"
+require 'coveralls'
+Coveralls.wear!
+
 require "minitest/autorun"
-require "minitest/mock"
 
 # Debugger
 require "pry"

metadata

@@ -1,81 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: konamio
 version: !ruby/object:Gem::Version
-  version: 0.2.2
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Tad Hosford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-15 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pay_dirt
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Recognize sequences in Ruby... just for fun.
+description: Tell it which sequence to listen for and what to do when the sequence
+  is received.
 email:
 - tad.hosford@gmail.com
 executables: []
@@ -83,50 +89,47 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
 - konamio.gemspec
 - lib/konamio.rb
+- lib/konamio/base.rb
 - lib/konamio/key_map.rb
 - lib/konamio/prompt.rb
+- lib/konamio/result.rb
 - lib/konamio/sequence/listener.rb
 - lib/konamio/sequence/requisition.rb
 - lib/konamio/version.rb
 - test/konamio/key_map_test.rb
 - test/konamio/prompt_test.rb
 - test/konamio/sequence/listener_test.rb
+- test/konamio/sequence/requisition_cancelled_test.rb
 - test/konamio/sequence/requisition_test.rb
 - test/minitest_helper.rb
-homepage: https://github.com/rthbound/konamio
+homepage: https://rthbound.github.io/konamio
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -728235217
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -728235217
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: I'm gonna recognize the konami sequence
+specification_version: 4
+summary: The Ruby Konami code gem.
 test_files: []