motion-speech 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d7d171c14e64dd90873710ad94277b660dd6c33
-  data.tar.gz: 4e6522282418bc358c673fc365a3ac9ed1eada5f
+  metadata.gz: ce4943f7503b1ee12089b77bee68f4d4b3a5648e
+  data.tar.gz: 184ba85dab57de0d04d9ebd0b4300e7a68895a99
 SHA512:
-  metadata.gz: 6547b64dde2bb648db4fc586b495c019381fd4069e660114d7acd176ee6010ebeec06d53c8ed500a0f538aac0006257367b7c230e70cd3361f0e9402dd9d5bfd
-  data.tar.gz: b6344702f82cf2570820623067cf0480f1f09dc24065dafd7e8ff3293b29983331db3a127e4d8e5562d3ef2fb1e55f4f3ae73873bb89ff37b7e015048d7e37fb
+  metadata.gz: 32fe0a1bb77d695f28d94878db9d30bb434cb338f2e19d1c3e87a0c3cb5dc554cdc45e496f96e38ea15df2707ae086aa93eb0f91355a11ff8dc80f3b2f34e5b1
+  data.tar.gz: 94a5754c16a64e878b1c2abcc249d8fe9f2f9e6d27a52b87a6f282f461f01231080ce93496021926a15bff642cfbc804b2e381b589ab90c8236666e54f5dab6f

data/README.md

@@ -1,6 +1,8 @@
 # motion-speech
 Provides a simpler interface to using the AVSpeechSynthesizer related classes available natively in iOS 7.
 
+![Travis CI](https://secure.travis-ci.org/macfanatic/motion-speech.png?branch=master)
+
 ## Installation
 
 Add the following to your project's Gemfile to work with bundler:
@@ -78,6 +80,26 @@ Motion::Speech::Speaker.speak "lorem" do |events|
 end
 ```
 
+### Customizing the speech
+You can pass several options directly through the speaker so that the spoken utterance is easily configured as you would like.
+
+```ruby
+
+# To customize the rate
+Motion::Speech::Speaker.speak "lorem", rate: :minimum # also accepts, :maximum, :default and any float between 0..1
+
+# To customize the pitch
+Motion::Speech::Speaker.speak "lorem", pitch: 2.0 # documentation specifies between 0.5 and 2.0, default being 1.0
+
+# To customize the voice
+voice_ref = AVSpeechSynthesisVoice.voiceWithLanguage("some_lang")
+Motion::Speech::Speaker.speak "lorem", voice: voice_ref
+
+# To customize the volume
+Motion::Speech::Speaker.speak "lorem", volume: 0.5
+```
+
+
 ### 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.
 

data/lib/motion/speech/speaker.rb

@@ -1,7 +1,7 @@
 module Motion
   module Speech
     class Speaker
-      attr_reader :message, :options
+      attr_reader :events, :utterance
 
       MultipleCallsToSpeakError = Class.new(StandardError)
 
@@ -10,8 +10,8 @@ module Motion
       end
 
       def initialize(speakable, options={}, &block)
-        @message = string_from_speakable(speakable)
-        @options = options
+        @events = EventBlock.new
+        @utterance = Utterance.new(speakable, options)
         @spoken = false
 
         if block_given?
@@ -53,12 +53,8 @@ module Motion
         synthesizer.speaking?
       end
 
-      def utterance
-        return @utterance unless @utterance.nil?
-
-        @utterance = AVSpeechUtterance.speechUtteranceWithString(message)
-        @utterance.rate = options.fetch(:rate, 0.15)
-        @utterance
+      def message
+        utterance.message
       end
 
       def synthesizer
@@ -87,18 +83,6 @@ module Motion
         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

data/lib/motion/speech/utterance.rb

@@ -0,0 +1,54 @@
+module Motion
+  module Speech
+    class Utterance < AVSpeechUtterance
+
+      def initialize(speakable, options={})
+        self.message = speakable
+        self.rate = options.fetch(:rate, 0.15)
+        self.pitch = options.fetch(:pitch, pitch)
+        self.voice = options.fetch(:voice, nil)
+        self.volume = options.fetch(:volume, volume)
+      end
+
+      def setSpeechString(speakable)
+        super string_from_speakable(speakable)
+      end
+
+      def setRate(multiplier)
+        super rate_for_symbol_or_float(multiplier)
+      end
+
+      alias_method :message, :speechString
+      alias_method :message=, :setSpeechString
+      alias_method :pitch, :pitchMultiplier
+      alias_method :pitch=, :setPitchMultiplier
+      alias_method :rate=, :setRate
+
+      private
+
+      def string_from_speakable(speakable)
+        if speakable.respond_to?(:to_speakable)
+          speakable.to_speakable
+        else
+          speakable
+        end
+      end
+
+      def rate_for_symbol_or_float(rate)
+        case rate
+        when :maximum
+          AVSpeechUtteranceMaximumSpeechRate
+        when :minimum
+          AVSpeechUtteranceMinimumSpeechRate
+        when :default
+          AVSpeechUtteranceDefaultSpeechRate
+        when Fixnum, Float
+          rate.to_f
+        else
+          raise ArgumentError, "invalid rate given: '#{rate}'"
+        end
+      end
+
+    end
+  end
+end

data/lib/motion/speech/version.rb

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

data/spec/speaker_spec.rb

@@ -12,17 +12,6 @@ describe Motion::Speech::Speaker do
       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
@@ -39,19 +28,7 @@ describe Motion::Speech::Speaker do
     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
+      @speaker.utterance.should.be.instance_of Motion::Speech::Utterance
     end
   end
 

data/spec/utterance_spec.rb

@@ -0,0 +1,87 @@
+describe Motion::Speech::Utterance do
+
+  before do
+    @message = "lorem"
+  end
+
+  describe '#message' do
+    it "stores the message on initialization" do
+      utterance = Motion::Speech::Utterance.new(@message)
+      utterance.speechString.should.be.equal @message
+    end
+
+    it "provides a :message accessor" do
+      utterance = Motion::Speech::Utterance.new(@message)
+      utterance.message.should.be.equal @message
+
+      utterance.message = "change the message"
+      utterance.message.should.be.equal "change the message"
+    end
+
+    it "calls :to_speakable" do
+      sentence = Speakable.new("lorem")
+      utterance = Motion::Speech::Utterance.new(sentence)
+      utterance.message.should.be.equal sentence.to_speakable
+    end
+  end
+
+  describe '#pitch' do
+    it "provides a #pitch accessor" do
+      utterance = Motion::Speech::Utterance.new(@message)
+      utterance.pitchMultiplier.should.be.equal utterance.pitch
+    end
+
+    it "allows customization on initialization" do
+      utterance = Motion::Speech::Utterance.new(@message, pitch: 0.5)
+      utterance.pitch.should.be.equal 0.5
+    end
+  end
+
+  describe '#rate' do
+    it "provides a default rate" do
+      utterance = Motion::Speech::Utterance.new(@message)
+      utterance.rate.should.be.equal 0.15
+    end
+
+    it "overrides rate" do
+      utterance = Motion::Speech::Utterance.new(@message, rate: 1)
+      utterance.rate.should.be.equal 1
+    end
+
+    it "accepts a symbol for :minimum" do
+      utterance = Motion::Speech::Utterance.new(@message, rate: :minimum)
+      utterance.rate.should.be.equal AVSpeechUtteranceMinimumSpeechRate
+    end
+
+    it "accepts a symbol for :maximum" do
+      utterance = Motion::Speech::Utterance.new(@message, rate: :maximum)
+      utterance.rate.should.be.equal AVSpeechUtteranceMaximumSpeechRate
+    end
+
+    it "accepts a symbol for :default" do
+      utterance = Motion::Speech::Utterance.new(@message, rate: :default)
+      utterance.rate.should.be.equal AVSpeechUtteranceDefaultSpeechRate
+    end
+
+    it "raises an error when passed an unrecognized symbol" do
+      @utterance = Motion::Speech::Utterance.new @message
+      ->{ @utterance.rate = :unknown }.should.raise(ArgumentError)
+    end
+  end
+
+  describe '#voice' do
+    it "allows customization on initialization" do
+      voice = AVSpeechSynthesisVoice.speechVoices.last
+      utterance = Motion::Speech::Utterance.new(@message, voice: voice)
+      utterance.voice.should.be.equal voice
+    end
+  end
+
+  describe '#volumne' do
+    it "allows customization on initialization" do
+      utterance = Motion::Speech::Utterance.new(@message, volume: 0.123)
+      utterance.volume.should.be.equal 0.123
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: motion-speech
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Matt Brewer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,10 +36,12 @@ files:
 - lib/motion-speech.rb
 - lib/motion/speech/event_block.rb
 - lib/motion/speech/speaker.rb
+- lib/motion/speech/utterance.rb
 - lib/motion/speech/version.rb
 - spec/event_block_spec.rb
 - spec/helpers/speakable.rb
 - spec/speaker_spec.rb
+- spec/utterance_spec.rb
 homepage: https://github.com//motion-speech
 licenses:
 - MIT
@@ -68,3 +70,4 @@ test_files:
 - spec/event_block_spec.rb
 - spec/helpers/speakable.rb
 - spec/speaker_spec.rb
+- spec/utterance_spec.rb