mac-say 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: befe01288b8556115593d963428671229af0a2e0
-  data.tar.gz: 715ed2147a05a67de7c05012c1b4009d909ed0af
+SHA256:
+  metadata.gz: 7fbd8952d1388b8784f78db4baf677ccb88da4219377fd2b268a0d843b3cb04a
+  data.tar.gz: f0e497209c8b6f9b5e3e29d3b2adcab49c5376e2a6c9613375dbe66dd0aa1af6
 SHA512:
-  metadata.gz: 9d48e9271ac17bc24a068c2ce63121a3f9bd2be092c5d3002d63400e2cfc5f24f26c6f6817c24b5b37a823665043fd3e9edeb33cd91712b63bba85b67d02ac59
-  data.tar.gz: 916ea15be74ff4d22c461c25117ae8240556bc4d9a09a58c667c0d6469b136621cbc889c123e11b50d1c8eaa9eb88e0f8916fc8ff36ac54f6142543e0d1c0e1d
+  metadata.gz: efac1b9b152281063b8540cab4d88e7561f405a3edf560409b808b061f0b410fe6bad88b3db857bb6eff83b070a0280d1220e6920e9852e6f26fb3a4881d36ca
+  data.tar.gz: 4de62bb491c7bb0fdd6c8311b5d7cf2d905a78c0fe0a1479ee3a7d32e8926028960e1714a191e7c5d6b8a8a63f406a4d526f2bf41e27bbdacf93a365daf590cb

data/ChangeLog.md

@@ -1,4 +1,28 @@
-### 0.1.0 / 2017-01-22
+v0.2.1 / 2017-12-10
+===================
 
-* Initial release:
+  * Added space separated voices support (MacOS High Sierra) i.e. 'Good news', 'Bad News', 'Pipe Organ'
+  * Added a new unofficial voice attribute `singing` (for voices like 'Cellos')
+  * Added a new ar_SA voice — 'Laila'
 
+v0.2.0 / 2017-02-16
+===================
+
+  * 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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017 Serge Bedzhyk
+Copyright (c) 2022 Serge Bedzhyk
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -6,11 +6,11 @@
 
 > Ruby wrapper around the modern version of the macOS `say` command. Inspired by the @bratta's [mactts](https://github.com/bratta/mactts)
 >
-> [![Build Status](https://travis-ci.org/smileart/mac-say.svg?branch=dev)](https://travis-ci.org/smileart/mac-say) [![Coverage Status](https://coveralls.io/repos/github/smileart/mac-say/badge.svg?branch=dev)](https://coveralls.io/github/smileart/mac-say?branch=dev) [![Code Climate](https://codeclimate.com/github/smileart/mac-say/badges/gpa.svg)](https://codeclimate.com/github/smileart/mac-say) [![InchCI Status](https://inch-ci.org/github/smileart/mac-say.svg?branch=dev)](https://inch-ci.org/github/smileart/mac-say)
+> [![Build Status](https://travis-ci.org/smileart/mac-say.svg?branch=dev)](https://travis-ci.org/smileart/mac-say) [![Coverage Status](https://coveralls.io/repos/github/smileart/mac-say/badge.svg?branch=dev)](https://coveralls.io/github/smileart/mac-say?branch=dev) [![Code Climate](https://codeclimate.com/github/smileart/mac-say/badges/gpa.svg)](https://codeclimate.com/github/smileart/mac-say) [![InchCI Status](https://inch-ci.org/github/smileart/mac-say.svg?branch=dev)](https://inch-ci.org/github/smileart/mac-say) [![mac-say gem](https://img.shields.io/gem/v/mac-say.svg)](https://rubygems.org/gems/mac-say)
 
 * [Homepage](https://rubygems.org/gems/mac-say)
 * [Documentation](http://rubydoc.info/gems/mac-say/frames)
-* [Email](mailto:smileart21 at gmail.com)
+* [Email](mailto:smileart21@gmail.com)
 
 ## Features
 
@@ -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,20 @@ 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(:singing, true)
+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)
@@ -54,7 +63,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 +83,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,29 +191,33 @@ 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
 ```
 
-## Installing & Updating MacOS TTS Voices
+## Installing & Updating MacOS TTS Voices (MacOS 12.2+)
 
-Open `System Preferences` using Spotlight / Alfred / Dock and follow text or visual instructions:
+Open `System Preferences` using  Menu / Spotlight / Alfred / Dock and follow text or visual instructions:
 
 ```
-System Preferences → Accessibility → Speech → System Voice →
+System Preferences → Accessibility → Spoken Content → System Voice →
 → Customize… → (select voices) → OK → (Wait for download…)
 ```
 
 ![Installing & Updating MacOS TTS Voices](./img/voices_manual.png)
 
+## Caveats
+
+- All the `Siri...` voices you might see in the system voices list are not available in `say`, that's why you can not user them
+
 ## Dev Notes
 
 ```sh
@@ -230,8 +243,17 @@ $ bundle exec m
 $ bundle exec m ./test/test_mac-say.rb:34
 ```
 
+__Additionally to update dependencies I use my [one-liner](https://gist.github.com/smileart/9d1d17e9da8cba19f792304fd4b0e58d).__
+
+```
+# A snippet to look for any new/unknown voices and test their attributes
+pp Mac::Say.voices.select {|v| v[:gender].nil? }
+talker = Mac::Say.new(voice: :rishi)
+talker.say string: 'Hello, my name is Rishi. I am an Indian-English voice.'
+```
+
 ## Copyright
 
-Copyright (c) 2017 Serge Bedzhyk
+Copyright (c) 2022 Serge Bedzhyk
 
 See [LICENSE.txt](./LICENSE.txt) for details.

data/examples/examples.rb

@@ -7,11 +7,20 @@ 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(:singing, true)
+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 +29,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 +49,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 +157,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/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.0'
+    VERSION = '0.2.2'
   end
 end