mac-say 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cba1ee99ff7b0b0b58234cb6875ca13596166495
-  data.tar.gz: 0e8919d872e49f0a77cfe526274b7a38dda1a632
+  metadata.gz: 691366a15525f635d6c95a206f467a75a3692f3c
+  data.tar.gz: 19b525a7de0607f5a08759a5212c90622d066e7b
 SHA512:
-  metadata.gz: 68f049d14c698bcb76487c953ab7232ee4f8470984bfc24c8e3c2bbac54adabb15827c42f3e89b8c7a82b91c51cb2e2490ad47bc85dabbb35feb402ff387bd5a
-  data.tar.gz: 619652619a452f1decac984f957482642cd257ef0a29b84b6a2c85bb6e8bce30ee3697bb0fd31ffd5325ded22259ae266f6d02192fcad4d3394c25f7f24e3134
+  metadata.gz: 299481a3cf645e1c24759a9e254e3a902c90bce1e5e3a9fe4eb3c4303b178716942de5cf5906885e64d537bcb05ac068c6d489eeb4652dfbae9a16876c340c8c
+  data.tar.gz: 6582d02d8da76153bc33352b62fab27a3d23820a056decdafa18a29a572e2b8ac8793a97d758166fbd1cbd83180254b8ac750c1d252feb5d617dc216efaeaf0d

data/ChangeLog.md

@@ -1,4 +1,21 @@
-### 0.1.0 / 2017-01-22
+v0.2.0 / 2017-02-16
+===================
 
-* Initial release:
+  * Added useful voices meta-information: gender, quality, "is it a joke?"-flag (WARNING: all the attributes values provided are highly subjective!)
+  * Implemented searching for voices by more than one attribute (i.e. @voices.find_all &block delegation)
+  * Improved/Fixed documentation
 
+v.0.1.1 / 2017-01-30
+====================
+
+  * Fixed leaked `nil` output from the main lib file
+  * Test code with colourful language deleted from the main lib file 🤦🏻‍♂️
+
+v0.1.0 / 2017-01-30
+===================
+
+  * First version
+  * Basic TTS (Strings/Multiline strings/Files)
+  * Dynamic voices list parsing (based on the real `say` output)
+  * Voices search (by one of the attributes: name / language / country)
+  * Full test/docs coverage + CI configuration + fake `say` command for CI

data/README.md

@@ -19,7 +19,7 @@
 * [x] Multiline strings support
 * [x] Dynamic voices parsing (based on real `say` output)
 * [x] Voices list generation (including samples and ISO information)
-* [x] Voices search (by name / language / country)
+* [x] Voices search (by name / language / country / etc.)
 * [x] Simple (class-level) and customisable (instance-level) usage
 * [ ] Observe reading progress line by line❓
 * [ ] Audio output support❓
@@ -41,11 +41,19 @@ require 'mac/say'
 # Get all the voices
 pp Mac::Say.voices
 
-# Collect the separate features lists
+# Collect the separate attributes lists
 pp Mac::Say.voices.collect { |v| v[:name] }
-pp Mac::Say.voices.collect { |v| v[:iso_code] }
+pp Mac::Say.voices.collect { |v| v[:language] }
 pp Mac::Say.voices.collect { |v| v[:sample] }
 
+# Look for voices by an attribute
+pp Mac::Say.voice(:joke, false)
+pp Mac::Say.voice(:gender, :female)
+
+# Look for voices by a buch of attributes
+pp Mac::Say.voice { |v| v[:joke] == true && v[:gender] == :female }
+pp Mac::Say.voice { |v| v[:language] == :en && v[:gender] == :male && v[:quality] == :high && v[:joke] == false }
+
 # Find a voice (returns a Hash)
 pp Mac::Say.voice(:name, :alex)
 pp Mac::Say.voice(:country, :scotland)
@@ -54,7 +62,7 @@ pp Mac::Say.voice(:country, :scotland)
 pp Mac::Say.voice(:language, :en)
 
 # Work with the voices collection
-indian_english = Mac::Say.voice(:country, :in).select { |v| v[:iso_code][:language] == :en }.first[:name]
+indian_english = Mac::Say.voice(:country, :in).select { |v| v[:language] == :en }.first[:name]
 
 # Use multiline text
 puts Mac::Say.say <<-DATA, indian_english
@@ -74,7 +82,7 @@ talker = Mac::Say.new(voice: Mac::Say.voice(:country, :scotland)[:name])
 talker.say string: talker.voice(:country, :scotland)[:sample]
 
 # with the dynamic voice name selected from the multiple voices
-talker = Mac::Say.news
+talker = Mac::Say.new
 voice = talker.voice(:language, :en)&.sample(1)&.first&.fetch :name
 talker.say string: 'Hello world!', voice: voice
 
@@ -182,14 +190,14 @@ end
 # wrong feature
 begin
   Mac::Say.voice(:tone, :enthusiastic)
-rescue Mac::Say::UnknownVoiceFeature => e
+rescue Mac::Say::UnknownVoiceAttribute => e
   puts e.message
 end
 
 # wrong feature
 begin
   Mac::Say.new.voice(:articulation, :nostalgic)
-rescue Mac::Say::UnknownVoiceFeature => e
+rescue Mac::Say::UnknownVoiceAttribute => e
   puts e.message
 end
 ```

data/examples/examples.rb

@@ -7,11 +7,19 @@ require_relative '../lib/mac/say'
 # Get all the voices
 pp Mac::Say.voices
 
-# Collect the separate features lists
+# Collect the separate attributes lists
 pp Mac::Say.voices.collect { |v| v[:name] }
-pp Mac::Say.voices.collect { |v| v[:iso_code] }
+pp Mac::Say.voices.collect { |v| v[:language] }
 pp Mac::Say.voices.collect { |v| v[:sample] }
 
+# Look for voices by an attribute
+pp Mac::Say.voice(:joke, false)
+pp Mac::Say.voice(:gender, :female)
+
+# Look for voices by multiple attributes
+pp Mac::Say.voice { |v| v[:joke] == true && v[:gender] == :female }
+pp Mac::Say.voice { |v| v[:language] == :en && v[:gender] == :male && v[:quality] == :high && v[:joke] == false }
+
 # Find a voice (returns a Hash)
 pp Mac::Say.voice(:name, :alex)
 pp Mac::Say.voice(:country, :scotland)
@@ -20,7 +28,7 @@ pp Mac::Say.voice(:country, :scotland)
 pp Mac::Say.voice(:language, :en)
 
 # Work with the voices collection
-indian_english = Mac::Say.voice(:country, :in).select { |v| v[:iso_code][:language] == :en }.first[:name]
+indian_english = Mac::Say.voice(:country, :in).select { |v| v[:language] == :en }.first[:name]
 
 # Use multiline text
 puts Mac::Say.say <<-DATA, indian_english
@@ -40,7 +48,7 @@ talker = Mac::Say.new(voice: Mac::Say.voice(:country, :scotland)[:name])
 talker.say string: talker.voice(:country, :scotland)[:sample]
 
 # with the dynamic voice name selected from the multiple voices
-talker = Mac::Say.news
+talker = Mac::Say.new
 voice = talker.voice(:language, :en)&.sample(1)&.first&.fetch :name
 talker.say string: 'Hello world!', voice: voice
 
@@ -148,13 +156,13 @@ end
 # wrong feature
 begin
   Mac::Say.voice(:tone, :enthusiastic)
-rescue Mac::Say::UnknownVoiceFeature => e
+rescue Mac::Say::UnknownVoiceAttribute => e
   puts e.message
 end
 
 # wrong feature
 begin
   Mac::Say.new.voice(:articulation, :nostalgic)
-rescue Mac::Say::UnknownVoiceFeature => e
+rescue Mac::Say::UnknownVoiceAttribute => e
   puts e.message
 end

data/lib/mac/say.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 require_relative 'say/version'
+require_relative 'say/voices_attributes'
+
 require 'English'
 
 # Wrapper namespace module for a Say class
@@ -8,7 +10,7 @@ module Mac
   # Allows to use simple TTS on Mac right from Ruby scripts
   class Say
     # A regex pattern to parse say voices list output
-    VOICES_PATTERN = /(^[\w-]+)\s+([\w-]+)\s+#\s([\p{Graph}\p{Zs}]+$)/i
+    VOICE_PATTERN = /(^[\w-]+)\s+([\w-]+)\s+#\s([\p{Graph}\p{Zs}]+$)/i
 
     # An error raised when `say` command couldn't be found
     class CommandNotFound < StandardError; end
@@ -19,8 +21,19 @@ module Mac
     # An error raised when the given voice isn't valid
     class VoiceNotFound < StandardError; end
 
-    # An error raised when there is no a feature of voice to match
-    class UnknownVoiceFeature < StandardError; end
+    # An error raised when there is no a attribute of voice to match
+    class UnknownVoiceAttribute < StandardError; end
+
+    # The list of the voice attributes available
+    VOICE_ATTRIBUTES = [
+      :name,
+      :language,
+      :country,
+      :sample,
+      :gender,
+      :joke,
+      :quality
+    ]
 
     # Current voices list
     #
@@ -29,20 +42,22 @@ module Mac
     #   Mac::Say.voices #=>
     #      [
     #          {
-    #              :name => :agnes,
-    #              :iso_code => {
-    #                  :language => :en,
-    #                  :country => :us
-    #              },
-    #              :sample => "Isn't it nice to have a computer that will talk to you?"
+    #              :name     => :agnes,
+    #              :language => :en,
+    #              :country  => :us,
+    #              :sample   => "Isn't it nice to have a computer that will talk to you?",
+    #              :gender   => :female,
+    #              :joke     => false,
+    #              :quality  => :low
     #          },
     #          {
-    #              :name => :albert,
-    #              :iso_code => {
-    #                  :language => :en,
-    #                  :country => :us
-    #              },
-    #              :sample => " I have a frog in my throat. No, I mean a real frog!"
+    #              :name      => :albert,
+    #              :language  => :en,
+    #              :country   => :us,
+    #              :sample    => "I have a frog in my throat. No, I mean a real frog!",
+    #              :gender    => :male,
+    #              :joke      => true,
+    #              :quality   => :medium
     #          },
     #          ...
     #      ]
@@ -94,7 +109,7 @@ module Mac
     # Providing file, voice or rate arguments changes instance state and influence
     # all the subsequent #say calls unless they have their own custom arguments
     #
-    # @param string [String] a text to read using say command
+    # @param string [String] a text to read using say command (default: nil)
     # @param file [String] path to the file to read (default: nil)
     # @param voice [Symbol] voice to be used by the say command (default: :alex)
     # @param rate [Integer] speech rate in words per minute (default: 175) accepts values in (175..720)
@@ -126,32 +141,67 @@ module Mac
       execute_command(string)
     end
 
-    # Find a voice by one of its features (e.g. :name, :language, :country)
+    # Look for voices by their attributes (e.g. :name, :language, :country, :gender, etc.)
+    #
+    # @overload voice(attribute, value)
+    #   @param attribute [Symbol] the attribute to search voices by
+    #   @param value [Symbol, String] the value of the attribute to search voices by
+    # @overload voice(&block)
+    #   @yield [voice] Passes the given block to @voices.find_all
+    #
+    # @return [Array<Hash>, Hash, nil] an array with all the voices matched by the attribute or
+    #   a voice Hash if only one voice corresponds to the attribute, nil if no voices found
+    #
+    # @example Find voices by one or more attributes
     #
-    # @return [Array<Hash>, Hash] an array with all the voices matched by the feature or
-    #   a voice Hash if only one voice corresponds to the feature
+    #   Mac::Say.new.voice(:joke, false)
+    #   Mac::Say.new.voice(:gender, :female)
     #
-    # @raise [UnknownVoiceFeature] if the voice feature isn't supported
-    def self.voice(feature, name)
+    #   Mac::Say.new.voice { |v| v[:joke] == true && v[:gender] == :female }
+    #   Mac::Say.new.voice { |v| v[:language] == :en && v[:gender] == :male && v[:quality] == :high && v[:joke] == false }
+    #
+    # @raise [UnknownVoiceAttribute] if the voice attribute isn't supported    def self.voice(attribute = nil, value = nil, &block)
+    def self.voice(attribute = nil, value = nil, &block)
       mac = new
-      mac.voice(feature, name)
+
+      if block_given?
+        mac.voice(&block)
+      else
+        mac.voice(attribute, value)
+      end
     end
 
-    # Find a voice by one of its features (e.g. :name, :language, :country)
+    # Look for voices by their attributes (e.g. :name, :language, :country, :gender, etc.)
     #
-    # @return [Array<Hash>, Hash] an array with all the voices matched by the feature or
-    #   a voice Hash if only one voice corresponds to the feature
+    # @overload voice(attribute, value)
+    #   @param attribute [Symbol] the attribute to search voices by
+    #   @param value [Symbol, String] the value of the attribute to search voices by
+    # @overload voice(&block)
+    #   @yield [voice] Passes the given block to @voices.find_all
     #
-    # @raise [UnknownVoiceFeature] if the voice feature isn't supported
-    def voice(feature, value)
-      raise UnknownVoiceFeature, "Voice has no '#{feature}' feature" unless [:name, :language, :country].include?(feature)
-      value = value.to_sym
-
-      condition = feature == :name ? ->(v) { v[feature] == value } : ->(v) { v[:iso_code][feature] == value }
-      found_voices = @voices.find_all(&condition)
+    # @return [Array<Hash>, Hash, nil] an array with all the voices matched by the attribute or
+    #   a voice Hash if only one voice corresponds to the attribute, nil if no voices found
+    #
+    # @example Find voices by one or more attributes
+    #
+    #   Mac::Say.new.voice(:joke, false)
+    #   Mac::Say.new.voice(:gender, :female)
+    #
+    #   Mac::Say.new.voice { |v| v[:joke] == true && v[:gender] == :female }
+    #   Mac::Say.new.voice { |v| v[:language] == :en && v[:gender] == :male && v[:quality] == :high && v[:joke] == false }
+    #
+    # @raise [UnknownVoiceAttribute] if the voice attribute isn't supported
+    def voice(attribute = nil, value = nil, &block)
+      return unless (attribute && !value.nil?) || block_given?
+      raise UnknownVoiceAttribute, "Voice has no '#{attribute}' attribute" if attribute && !VOICE_ATTRIBUTES.include?(attribute)
+
+      if block_given?
+        found_voices = @voices.find_all(&block)
+      else
+        found_voices = @voices.find_all {|voice| voice[attribute] === value }
+      end
 
       return if found_voices.empty?
-
       found_voices.count == 1 ? found_voices.first : found_voices
     end
 
@@ -162,20 +212,22 @@ module Mac
     #   Mac::Say.voices #=>
     #      [
     #          {
-    #              :name => :agnes,
-    #              :iso_code => {
-    #                  :language => :en,
-    #                  :country => :us
-    #              },
-    #              :sample => "Isn't it nice to have a computer that will talk to you?"
+    #              :name      => :agnes,
+    #              :language  => :en,
+    #              :country   => :us,
+    #              :sample    => "Isn't it nice to have a computer that will talk to you?",
+    #              :gender    => :female,
+    #              :joke      => false,
+    #              :quality   => :low
     #          },
     #          {
-    #              :name => :albert,
-    #              :iso_code => {
-    #                  :language => :en,
-    #                  :country => :us
-    #              },
-    #              :sample => " I have a frog in my throat. No, I mean a real frog!"
+    #              :name      => :albert,
+    #              :language  => :en,
+    #              :country   => :us,
+    #              :sample    => "I have a frog in my throat. No, I mean a real frog!",
+    #              :gender    => :male,
+    #              :joke      => true,
+    #              :quality   => :medium
     #          },
     #          ...
     #      ]
@@ -214,7 +266,7 @@ module Mac
     # @raise [FileNotFound] if the given file wasn't found or isn't readable by the current user
     def generate_command
       say_path = @config[:say_path]
-      file = @config[:file]
+      file     = @config[:file]
 
       raise CommandNotFound, "Command `say` couldn't be found by '#{@config[:say_path]}' path" unless valid_command_path? say_path
 
@@ -235,22 +287,30 @@ module Mac
     # @raise [CommandNotFound] if the say command wasn't found
     def load_voices
       return if @voices
+
       say_path = @config[:say_path]
       raise CommandNotFound, "Command `say` couldn't be found by '#{say_path}' path" unless valid_command_path? say_path
 
-      @voices = `#{say_path} -v '?'`.scan(VOICES_PATTERN).map do |voice|
+      @voices = `#{say_path} -v '?'`.scan(VOICE_PATTERN).map do |voice|
         lang = voice[1].split(/[_-]/)
+        name = voice[0].downcase.to_sym
+
+        additional_attributes = ADDITIONAL_VOICE_ATTRIBUTES[name] || ADDITIONAL_VOICE_ATTRIBUTES[:_unknown_voice]
+
         {
-          name: voice[0].downcase.to_sym,
-          iso_code: { language: lang[0].downcase.to_sym, country: lang[1].downcase.to_sym },
-          sample: voice[2]
-        }
+          name: name,
+          language: lang[0].downcase.to_sym,
+          country: lang[1].downcase.to_sym,
+          sample: voice[2].strip
+        }.merge(additional_attributes)
       end
     end
 
     # Checks voice existence by the name
     # Loads voices if they weren't loaded before
     #
+    # @param name [String, Symbol] the name of the voice to validate
+    #
     # @return [Boolean] if the voices name in the list of voices
     #
     # @raise [CommandNotFound] if the say command wasn't found
@@ -261,6 +321,8 @@ module Mac
 
     # Checks say command existence by the path
     #
+    # @param path [String] the path of the `say` command to validate
+    #
     # @return [Boolean] if the command exists and if it is executable
     def valid_command_path?(path)
       File.exist?(path) && File.executable?(path)
@@ -268,6 +330,8 @@ module Mac
 
     # Checks text file existence by the path
     #
+    # @param path [String] the path of the text file validate
+    #
     # @return [Boolean] if the file exists and if it is readable
     def valid_file_path?(path)
       path && File.exist?(path) && File.readable?(path)

data/lib/mac/say/version.rb

@@ -2,10 +2,10 @@
 
 # Wrapper namespace module for a Say class
 module Mac
-  # A class wrapper around the MacOS `say` commad
+  # A class wrapper around the MacOS `say` command
   # Allows to use simple TTS on Mac right from Ruby scripts
   class Say
     # mac-say version
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/mac/say/voices_attributes.rb

@@ -0,0 +1,510 @@
+# Additional voice attributes mixed to the original Hash of
+# parsed voices (to provide additional context when looking for a voice)
+#
+# @note Unfortunately information in system *.plist files
+#   e.g. /System/Library/Speech/Voices/<VoiceName>.SpeechVoice/Contents/Info.plist"
+#   is inconsistent, fragmentary and sometimes incorrect, but:
+#
+#   WARNING: all the attributes values provided here are highly subjective!!!
+ADDITIONAL_VOICE_ATTRIBUTES = {
+    _unknown_voice: {
+      gender: nil,
+      joke: nil,
+      quality: nil
+    },
+    agnes: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    albert: {
+      gender: :male,
+      joke: true,
+      quality: :medium
+    },
+    alex: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    alice: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    allison: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    alva: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    amelie: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    angelica: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    anna: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    audrey: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    aurelie: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    ava: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    bahh: {
+      gender: :male,
+      joke: true,
+      quality: :low
+    },
+    bells: {
+      gender: :neutral,
+      joke: true,
+      quality: :medium
+    },
+    boing: {
+      gender: :neutral,
+      joke: true,
+      quality: :medium
+    },
+    bruce: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    bubbles: {
+      gender: :male,
+      joke: true,
+      quality: :medium
+    },
+    carlos: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    carmit: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    catarina: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    cellos: {
+      gender: :male,
+      joke: true,
+      quality: :medium
+    },
+    cem: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    chantal: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    claire: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    damayanti: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    daniel: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    deranged: {
+      gender: :neutral,
+      joke: true,
+      quality: :medium
+    },
+    diego: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    ellen: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    ewa: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    federica: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    felipe: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    fiona: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    fred: {
+      gender: :male,
+      joke: true,
+      quality: :low
+    },
+    henrik: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    hysterical: {
+      gender: :male,
+      joke: true,
+      quality: :medium
+    },
+    ioana: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    iveta: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    joana: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    jorge: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    juan: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    junior: {
+      gender: :male,
+      joke: true,
+      quality: :low
+    },
+    kanya: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    karen: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    kate: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    kathy: {
+      gender: :female,
+      joke: true,
+      quality: :low
+    },
+    katya: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    klara: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    kyoko: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    laura: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    lee: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    lekha: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    luca: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    luciana: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    maged: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    magnus: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    mariska: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    markus: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    :'mei-jia' => {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    melina: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    milena: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    moira: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    monica: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    nicolas: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    nikos: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    nora: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    oliver: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    oskar: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    otoya: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    paola: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    paulina: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    petra: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    princess: {
+      gender: :female,
+      joke: true,
+      quality: :low
+    },
+    ralph: {
+      gender: :male,
+      joke: true,
+      quality: :low
+    },
+    samantha: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    sara: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    satu: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    serena: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    :'sin-ji' => {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    soledad: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    susan: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    tarik: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    tessa: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    thomas: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    :'ting-ting' => {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    tom: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    trinoids: {
+      gender: :neutral,
+      joke: true,
+      quality: :medium
+    },
+    veena: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    },
+    vicki: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    victoria: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    whisper: {
+      gender: :male,
+      joke: true,
+      quality: :medium
+    },
+    xander: {
+      gender: :male,
+      joke: false,
+      quality: :high
+    },
+    yannick: {
+      gender: :male,
+      joke: false,
+      quality: :medium
+    },
+    yelda: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    yuna: {
+      gender: :female,
+      joke: false,
+      quality: :medium
+    },
+    yuri: {
+      gender: :male,
+      joke: false,
+      quality: :low
+    },
+    zarvox: {
+      gender: :neutral,
+      joke: true,
+      quality: :medium
+    },
+    zosia: {
+      gender: :female,
+      joke: false,
+      quality: :low
+    },
+    zuzana: {
+      gender: :female,
+      joke: false,
+      quality: :high
+    }
+}.freeze

data/test/fake/say

@@ -9,6 +9,7 @@ Fiona               en-scotland # Hello, my name is Fiona. I am a Scottish-Engli
 Serena              en_GB    # Hello, my name is Serena. I am a British-English voice.
 Ting-Ting           zh_CN    # 您好，我叫Ting-Ting。我讲中文普通话。
 Veena               en_IN    # Hello, my name is Veena. I am an Indian-English voice.
+Test                en_GB    # Well I'm the most mysterious voice round here, believe me.
 VOICES
 
 VOICES_NAMES = [
@@ -16,7 +17,8 @@ VOICES_NAMES = [
   :daniel,
   :fiona,
   :'ting-ting',
-  :veena
+  :veena,
+  :test
 ]
 
 options = {

data/test/helper.rb

@@ -4,15 +4,19 @@ require 'rubygems'
 require 'coveralls'
 Coveralls.wear!
 
+require 'simplecov'
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
 begin
   require 'bundler/setup'
 rescue LoadError => error
   abort error.message
 end
 
-require 'simplecov'
-SimpleCov.start
-
 require 'minitest/autorun'
 require 'minitest/reporters'
 

data/test/test_mac-say.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 require 'helper'
 require 'mac/say'
+require 'mac/say/voices_attributes'
 
 describe 'Mac::Say as a macOS `say` wrapper' do
   describe 'On a class level' do
@@ -21,34 +22,27 @@ describe 'Mac::Say as a macOS `say` wrapper' do
       voice = Mac::Say.voice(:name, :alex)
       voice.wont_be_empty
       voice.must_be_kind_of Hash
-      voice.keys.must_equal [:name, :iso_code, :sample]
+      voice.keys.must_equal Mac::Say::VOICE_ATTRIBUTES
     end
 
-    it 'must return specific Hash structure for an iso_code' do
-      voice = Mac::Say.voice(:name, :alex)
-      voice.wont_be_empty
-      voice[:iso_code].must_be_kind_of Hash
-      voice[:iso_code].keys.must_equal [:language, :country]
-    end
+    it 'must return additional attributes for known voices' do
+      voice_name = :alex
+      voice = Mac::Say.voice(:name, voice_name)
+      additional_voice_attributes = ADDITIONAL_VOICE_ATTRIBUTES[voice_name]
 
-    it '.voice must search for a voice by name' do
-      voice = Mac::Say.voice(:name, :alex)
-      voice[:name].must_equal :alex
+      voice[:gender].must_equal additional_voice_attributes[:gender]
+      voice[:joke].must_equal additional_voice_attributes[:joke]
+      voice[:quality].must_equal additional_voice_attributes[:quality]
     end
 
-    it '.voice must accept String as a value' do
-      voice = Mac::Say.voice(:name, 'alex')
+    it '.voice must search for a voice using single attribute' do
+      voice = Mac::Say.voice(:name, :alex)
       voice[:name].must_equal :alex
     end
 
-    it '.voice must search for a voice by country' do
-      voice = Mac::Say.voice(:country, :scotland)
-      voice[:name].must_equal :fiona
-    end
-
-    it '.voice must search for a voice by language' do
-      voices = Mac::Say.voice(:language, :en)
-      voices.count.must_be :>, 2
+    it '.voice must search for a voice using block given' do
+      voices = Mac::Say.voice {|voice| voice[:language] == :en && voice[:joke] == false }
+      voices.must_be_kind_of Array
     end
 
     it '.voice must return one voice as a Hash' do
@@ -66,6 +60,7 @@ describe 'Mac::Say as a macOS `say` wrapper' do
       voices.must_be_nil
     end
 
+
     it '.say must return 0 in successive speech' do
       expectation = ["#{@say_path} -v 'alex' -r 175", 0]
       Mac::Say.say('42').must_equal expectation
@@ -91,10 +86,10 @@ describe 'Mac::Say as a macOS `say` wrapper' do
       }.must_raise Mac::Say::VoiceNotFound
     end
 
-    it '.voice must fail on wrong voice feature' do
+    it '.voice must fail on wrong voice attribute' do
       -> {
         Mac::Say.voice(:tone, :enthusiastic)
-      }.must_raise Mac::Say::UnknownVoiceFeature
+      }.must_raise Mac::Say::UnknownVoiceAttribute
     end
   end
 
@@ -133,6 +128,17 @@ describe 'Mac::Say as a macOS `say` wrapper' do
       @reader.say.must_equal expectation
     end
 
+    it 'must return nil additional attrs for unknown voices' do
+      if ENV['USE_FAKE_SAY']
+        voice = @reader.voice(:name, :test)
+        additional_voice_attributes = ADDITIONAL_VOICE_ATTRIBUTES[:test]
+
+        voice[:gender].must_be_nil
+        voice[:joke].must_be_nil
+        voice[:quality].must_be_nil
+      end
+    end
+
     it '#say must change :file from initial config' do
       gb_absolute_path = File.absolute_path './fixtures/text/en_gb_test.txt', File.dirname(__FILE__)
       us_absolute_path = File.absolute_path './fixtures/text/en_us_test.txt', File.dirname(__FILE__)
@@ -217,10 +223,10 @@ describe 'Mac::Say as a macOS `say` wrapper' do
       }.must_raise Mac::Say::FileNotFound
     end
 
-    it '#voice must fail on wrong feature' do
+    it '#voice must fail on wrong attribute' do
       -> {
         Mac::Say.new.voice(:articulation, :nostalgic)
-      }.must_raise Mac::Say::UnknownVoiceFeature
+      }.must_raise Mac::Say::UnknownVoiceAttribute
     end
 
     it '#say must fail on initial wrong file path' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mac-say
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Serge Bedzhyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-30 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -201,6 +201,7 @@ files:
 - img/voices_manual.png
 - lib/mac/say.rb
 - lib/mac/say/version.rb
+- lib/mac/say/voices_attributes.rb
 - mac-say.gemspec
 - test/fake/say
 - test/fixtures/text/en_gb.txt