motion-speech 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d7d171c14e64dd90873710ad94277b660dd6c33
+  data.tar.gz: 4e6522282418bc358c673fc365a3ac9ed1eada5f
+SHA512:
+  metadata.gz: 6547b64dde2bb648db4fc586b495c019381fd4069e660114d7acd176ee6010ebeec06d53c8ed500a0f538aac0006257367b7c230e70cd3361f0e9402dd9d5bfd
+  data.tar.gz: b6344702f82cf2570820623067cf0480f1f09dc24065dafd7e8ff3293b29983331db3a127e4d8e5562d3ef2fb1e55f4f3ae73873bb89ff37b7e015048d7e37fb

data/README.md

@@ -0,0 +1,129 @@
+# motion-speech
+Provides a simpler interface to using the AVSpeechSynthesizer related classes available natively in iOS 7.
+
+## Installation
+
+Add the following to your project's Gemfile to work with bundler:
+
+```ruby
+gem 'motion-speech'
+```
+
+Install with bundler:
+
+```shell
+bundle install
+```
+
+### AVFoundation
+This gem includes the `AVFoundation` framework into your project automatically for you.
+
+## Usage
+Some basic usage examples are listed below.
+
+```ruby
+# Speak a sentence
+Motion::Speech::Speaker.speak "Getting started with speech"
+
+# Control the rate of speech
+Motion::Speech::Speaker.speak "Getting started with speech", rate: 1
+
+# Pass a block to be called when the speech is completed
+Motion::Speech::Speaker.speak "Getting started with speech" do
+  puts "completed the utterance"
+end
+```
+
+## Advanced Usage
+There are several more advanced examples that you can follow below, allowing more customization of the utterance playback including voices (coming soon) as well as contriving arbitrary objects for speech.
+
+### Speakable
+
+```ruby
+class Name < String
+  def to_speakable
+    "My name is #{self}"
+  end
+end
+
+my_name = Name.new("Matt Brewer")
+Motion::Speech::Speaker.speak my_name
+# => "My name is Matt Brewer" spoken
+```
+
+### Callbacks as blocks
+This will look somewhat familiar to Rails developers, can work off a system of block callbacks for further control.
+
+```ruby
+Motion::Speech::Speaker.speak "lorem" do |events|
+  events.start do |speaker|
+    puts "started speaking: '#{speaker.message}'"
+  end
+
+  events.finish do |speaker|
+    puts "finished speaking: '#{speaker.message}'"
+  end
+
+  events.pause do |speaker|
+    puts "paused while speaking: '#{speaker.message}'"
+  end
+
+  events.cancel do |speaker|
+    puts "canceled while speaking: '#{speaker.message}'"
+  end
+
+  events.resume do |speaker|
+    puts "resumed speaking: '#{speaker.message}'"
+  end
+end
+```
+
+### Using methods for callbacks
+This is not unique to RubyMotion, but you can easily grab a block from a method on your class to use as a callback here too.
+
+```ruby
+class SomeController < UIViewController
+
+  def tapped_button(*args)
+    Motion::Speech::Speaker.speak "lorem" do |events|
+      events.start &method(:lock_ui)
+      events.finish &method(:unlock_ui)
+    end
+  end
+
+  private
+
+  def lock_iu(speaker)
+    self.view.userInteractionEnabled = false
+  end
+
+  def unlock_ui(speaker)
+    self.view.userInteractionEnabled = true
+  end
+end
+```
+
+### Controlling playback
+
+```ruby
+speaker = Motion::Speech::Speaker.speak "lorem"
+
+# pausing playback accepts symbols or actual structs
+speaker.pause :word
+speaker.pause :immediate
+speaker.pause AVSpeechBoundaryImmediate
+
+speaker.paused?
+=> true
+
+speaker.speaking?
+=> false
+
+# stopping playback accepts symbols or actual structs
+speaker.stop :word
+speaker.stop :immediate
+speaker.stop AVSpeechBoundaryImmediate
+
+# resume playback
+speaker.resume
+```

data/lib/motion-speech.rb

@@ -0,0 +1,15 @@
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  gem_files = Dir.glob(File.join(lib_dir_path, "motion/**/*.rb"))
+  app.files.unshift(gem_files).flatten!
+
+  if app.deployment_target.to_f < 7.0
+  	warn "AVSpeechSynthesizer and friends are only available in iOS 7.0+"
+  end
+
+  app.frameworks += %w(AVFoundation)
+end

data/lib/motion/speech/event_block.rb

@@ -0,0 +1,23 @@
+module Motion
+  module Speech
+    class EventBlock
+
+      Events = %w(start finish cancel pause resume).freeze
+
+      Events.each do |method|
+        define_method method do |*args, &block|
+          if !block.nil?
+            instance_variable_set("@#{method}_block", block)
+          else
+            instance_variable_get("@#{method}_block")
+          end
+        end
+      end
+
+      def call(event, speaker)
+        block = send(event)
+        block.call(speaker) unless block.nil?
+      end
+    end
+  end
+end

data/lib/motion/speech/speaker.rb

@@ -0,0 +1,114 @@
+module Motion
+  module Speech
+    class Speaker
+      attr_reader :message, :options
+
+      MultipleCallsToSpeakError = Class.new(StandardError)
+
+      def self.speak(*args, &block)
+        new(*args, &block).speak
+      end
+
+      def initialize(speakable, options={}, &block)
+        @message = string_from_speakable(speakable)
+        @options = options
+        @spoken = false
+
+        if block_given?
+          if block.arity == 0
+            events.finish &block
+          elsif block.arity == 1
+            block.call events
+          else
+            raise ArgumentError, 'block must accept either 0 or 1 arguments'
+          end
+        end
+      end
+
+      def speak
+        raise MultipleCallsToSpeakError if @spoken
+
+        synthesizer.speakUtterance utterance
+        @spoken = true
+        self
+      end
+
+      def pause(boundary)
+        synthesizer.pauseSpeakingAtBoundary boundary_from_symbol(boundary)
+      end
+
+      def stop(boundary)
+        synthesizer.stopSpeakingAtBoundary boundary_from_symbol(boundary)
+      end
+
+      def resume
+        synthesizer.continueSpeaking
+      end
+
+      def paused?
+        synthesizer.paused?
+      end
+
+      def speaking?
+        synthesizer.speaking?
+      end
+
+      def utterance
+        return @utterance unless @utterance.nil?
+
+        @utterance = AVSpeechUtterance.speechUtteranceWithString(message)
+        @utterance.rate = options.fetch(:rate, 0.15)
+        @utterance
+      end
+
+      def synthesizer
+        @synthesizer ||= AVSpeechSynthesizer.new.tap { |s| s.delegate = self }
+      end
+
+      private
+
+      def speechSynthesizer(s, didFinishSpeechUtterance: utterance)
+        events.call :finish, self
+      end
+
+      def speechSynthesizer(s, didStartSpeechUtterance: utterance)
+        events.call :start, self
+      end
+
+      def speechSynthesizer(s, didCancelSpeechUtterance: utterance)
+        events.call :cancel, self
+      end
+
+      def speechSynthesizer(s, didPauseSpeechUtterance: utterance)
+        events.call :pause, self
+      end
+
+      def speechSynthesizer(s, didContinueSpeechUtterance: utterance)
+        events.call :resume, self
+      end
+
+      def events
+        @events ||= EventBlock.new
+      end
+
+      def string_from_speakable(speakable)
+        if speakable.respond_to?(:to_speakable)
+          speakable.to_speakable
+        else
+          speakable
+        end
+      end
+
+      def boundary_from_symbol(sym)
+        case sym
+        when :word
+          AVSpeechBoundaryWord
+        when :immediate
+          AVSpeechBoundaryImmediate
+        when Fixnum
+          sym
+        end
+      end
+    end
+  end
+end

data/lib/motion/speech/version.rb

@@ -0,0 +1,5 @@
+module Motion
+  module Speech
+    VERSION = "0.0.1"
+  end
+end

data/spec/event_block_spec.rb

@@ -0,0 +1,27 @@
+describe Motion::Speech::EventBlock do
+  before do
+    @event = Motion::Speech::EventBlock.new
+  end
+
+  it "has has all the events we need" do
+    %w(start finish cancel pause resume).each do |e|
+      Motion::Speech::EventBlock::Events.should.include e
+    end
+  end
+
+  it "exposes methods for 'start' and 'finish'" do
+    @event.should.respond_to "start"
+    @event.should.respond_to "finish"
+  end
+
+  it "exposes methods to retrieve the stored block" do
+    @event.start { true }
+    @event.start.should.be.instance_of Proc
+    @event.start.call.should.be.true
+  end
+
+  it "allows you to call an event" do
+    @event.start { true }
+    @event.call(:start, nil).should.be.true
+  end
+end

data/spec/helpers/speakable.rb

@@ -0,0 +1,5 @@
+class Speakable < String
+  def to_speakable
+    "speak: #{self}"
+  end
+end

data/spec/speaker_spec.rb

@@ -0,0 +1,166 @@
+describe Motion::Speech::Speaker do
+
+  describe 'initialization' do
+
+    it "creates new instance when calling #speak" do
+      speaker = Motion::Speech::Speaker.speak "lorem"
+      speaker.should.be.instance_of Motion::Speech::Speaker
+    end
+
+    it "stores message" do
+      speaker = Motion::Speech::Speaker.new "lorem"
+      speaker.message.should.be.equal "lorem"
+    end
+
+    it "accepts an options hash" do
+      speaker = Motion::Speech::Speaker.new "lorem", key: :value
+      speaker.options.should.be.equal key: :value
+    end
+
+    it "calls #to_speakable on sentence if supported" do
+      sentence = Speakable.new("lorem")
+      speaker = Motion::Speech::Speaker.new sentence
+      speaker.message.should.be.equal sentence.to_speakable
+    end
+
+    it "raises exception if you make multiple calls to #speak" do
+      speaker = Motion::Speech::Speaker.new "lorem"
+      speaker.speak
+
+      should.raise(Motion::Speech::Speaker::MultipleCallsToSpeakError) do
+        speaker.speak
+      end
+    end
+  end
+
+  describe '#utterance' do
+    before do
+      @speaker = Motion::Speech::Speaker.new "lorem"
+    end
+
+    it "returns an AVSpeechUtterance instance" do
+      @speaker.utterance.should.be.instance_of AVSpeechUtterance
+    end
+
+    describe '#rate' do
+
+      it "sets the speech rate to a reasonable default" do
+        @speaker.utterance.rate.should.be.equal 0.15
+      end
+
+      it "allows me to override the rate" do
+        speaker = Motion::Speech::Speaker.new "lorem", rate: 0.75
+        speaker.utterance.rate.should.be.equal 0.75
+      end
+    end
+  end
+
+  describe '#synthesizer' do
+    before do
+      @speaker = Motion::Speech::Speaker.new "lorem"
+    end
+
+    it "returns an AVSpeechSynthesizer" do
+      @speaker.synthesizer.should.be.instance_of AVSpeechSynthesizer
+    end
+
+    it "is the synthesizer delegate" do
+      @speaker.synthesizer.delegate.should.be.equal @speaker
+    end
+  end
+
+  describe 'events' do
+
+    describe 'block without arguments' do
+      before do
+        @speaker = Motion::Speech::Speaker.new("lorem") { @called_block = true }
+      end
+
+      it "calls the block on completion" do
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested
+        @speaker.send 'speechSynthesizer:didFinishSpeechUtterance:', @speaker.synthesizer, @speaker.utterance
+        @called_block.should.be.true
+      end
+    end
+
+    describe 'block with too many arguments' do
+      it "raises an exception" do
+        should.raise(ArgumentError) do
+          Motion::Speech::Speaker.new("lorem") do |arg1, arg2|
+          end
+        end
+      end
+    end
+
+    describe 'block with 1 argument' do
+
+      it "calls the start block" do
+        speaker = Motion::Speech::Speaker.new "lorem" do |events|
+          events.start { @called_block = true }
+        end
+
+        @called_block = nil
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested      
+        speaker.send 'speechSynthesizer:didStartSpeechUtterance:', speaker.synthesizer, speaker.utterance
+        @called_block.should.be.true
+      end
+
+      it "calls the finish block" do
+        speaker = Motion::Speech::Speaker.new "lorem" do |events|
+          events.finish { @called_block = true }
+        end
+
+        @called_block = nil
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested      
+        speaker.send 'speechSynthesizer:didFinishSpeechUtterance:', speaker.synthesizer, speaker.utterance
+        @called_block.should.be.true
+      end
+
+      it "calls the paused block" do
+        speaker = Motion::Speech::Speaker.new "lorem" do |events|
+          events.pause { @called_block = true }
+        end
+
+        @called_block = nil
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested      
+        speaker.send 'speechSynthesizer:didPauseSpeechUtterance:', speaker.synthesizer, speaker.utterance
+        @called_block.should.be.true
+      end
+
+      it "calls the cancelled block" do
+        speaker = Motion::Speech::Speaker.new "lorem" do |events|
+          events.cancel { @called_block = true }
+        end
+
+        @called_block = nil
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested      
+        speaker.send 'speechSynthesizer:didCancelSpeechUtterance:', speaker.synthesizer, speaker.utterance
+        @called_block.should.be.true
+      end
+
+      it "calls the resumed block" do
+        speaker = Motion::Speech::Speaker.new "lorem" do |events|
+          events.resume { @called_block = true }
+        end
+
+        @called_block = nil
+        @called_block.should.be.nil
+
+        # Send delegate message immediately, AVFoundation is tested      
+        speaker.send 'speechSynthesizer:didContinueSpeechUtterance:', speaker.synthesizer, speaker.utterance
+        @called_block.should.be.true
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: motion-speech
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Brewer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Provides a simple interface for using the AVSpeechSynthesizer related
+  classes available natively in iOS 7.
+email:
+- matt.brewer@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-speech.rb
+- lib/motion/speech/event_block.rb
+- lib/motion/speech/speaker.rb
+- lib/motion/speech/version.rb
+- spec/event_block_spec.rb
+- spec/helpers/speakable.rb
+- spec/speaker_spec.rb
+homepage: https://github.com//motion-speech
+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: "[none]"
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Get your iOS app to talk the easy way.
+test_files:
+- spec/event_block_spec.rb
+- spec/helpers/speakable.rb
+- spec/speaker_spec.rb