medieval_latina 2.0.5 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f310cf2079aed1bdaa591c79e409ccef4ec3103b1f0f358f3dd67dc834d2d42f
-  data.tar.gz: beced7869d04c3bfb10a565aa5cb2f2f6302d4709826d96e2cd01907db57f155
+  metadata.gz: 67adc073d1a06863e460da73ddfb00d371e64e532ca14f94e7216f16d1d7ecd2
+  data.tar.gz: cfc8ece414f505202c055606561a9e62b366c9f31431f6b5aa4bf8de40cf3eb1
 SHA512:
-  metadata.gz: 2efc132b60e9d2cc4379c78162acd4f8a031619cab150c00553a61d0480ba23592955e4334806b6a36c89720dfc747cc2fc58c7745a8f27f3e29be05acf8f16f
-  data.tar.gz: 6c750f532cde017ca033243c3321a5bbc26a2e9a896e2e8031a264b095f3c7a5739d4c9e5af27beaff91eb09db15a0589af92b263e71f2c9ea3d80b4ad349459
+  metadata.gz: 7c3e709b58bce1ca4d8bdce5c166a15f5eafa7a0db327452389b991ee7cfec1f242b39aee6814d9f5fab508c19413a7dbf1bcad38df77da92f7efc22a0315b86
+  data.tar.gz: d931c5f2b959b70c11fd9e4da3d3b970e48f34a2bba6fb47639b1e6c787137d8e62e92d3ccacf9230ff08c63f71666c2fbe56d3ebe50e772eadbd1297fc9f1a6

data/.github/workflows/tests.yml

@@ -19,16 +19,12 @@ jobs:
           - macos
           - ubuntu
         ruby:
-          - 2.7
           - 3.0
           - 3.1
           - 3.2
+          - 3.3
         allow_failures:
           - false
-        include:
-          - os: ubuntu
-            ruby: ruby-head
-            allow_failures: true
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
       ALLOW_FAILURES: "${{ matrix.allow_failures }}"

data/.standard.yml

@@ -1,3 +1,3 @@
 fix: true
 parallel: true
-ruby_version: 2.6
+ruby_version: 3.0

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.0
+ruby 3.3.0

data/Gemfile

@@ -2,8 +2,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in medieval_latina.gemspec
 gemspec
-
-gem "i18n"
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
-gem "standard", group: [:development, :test]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    medieval_latina (2.0.5)
+    medieval_latina (3.0.0)
       i18n
 
 GEM
@@ -12,9 +12,14 @@ GEM
     diff-lcs (1.3)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
+    mini_portile2 (2.8.6)
+    nokogiri (1.16.4)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
     parallel (1.19.1)
     parser (2.7.1.2)
       ast (~> 2.4.0)
+    racc (1.7.3)
     rainbow (3.0.0)
     rake (12.3.3)
     rexml (3.2.5)
@@ -50,8 +55,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  i18n
   medieval_latina!
+  nokogiri
   rake (~> 12.0)
   rspec (~> 3.0)
   standard

data/README.md

@@ -21,12 +21,57 @@ Or install it yourself as:
 
 ## Usage
 
+### Help English language text-to-speech engines pronounce Latin
 ```ruby
 ["caelum", "omnia", "pugno"].each { |word| puts MedievalLatina[word] }
 => "chayloom"
 => "ohm-nia"
 => "poon-yoh"
 
+sentence = MedievalLatina["sed libera nos a malo"]
+=> "sayd leebayrah nohs ah mahloh"
+```
+```javascript
+let sentence = "...";
+responsiveVoice.speak(sentence, "UK English Female");
+```
+### Generate lexicons to override text-to-speech pronunciation
+```ruby
+polly = Aws::Polly::Client.new
+s3 = Aws::S3::Client.new
+
+sentence = "PATER NOSTER qui es in caelis"
+
+words = sentence.split(" ")
+pronunciations = MedievalLatina.pronunciations_for(words)
+lexicon = MedievalLatina::LexiconBuilder.new(pronunciations).call
+
+name = "CustomLatin"
+polly.put_lexicon(name: name, content: lexicon.to_s)
+
+# Synthesize speech using the lexicons
+response = polly.synthesize_speech(
+  lexicon_names: [name],
+  text: sentence,
+  output_format: "mp3",
+  voice_id: "Joanna"
+)
+
+# Read the audio data and store it in a variable
+audio_data = response.audio_stream.read
+
+bucket_name = "foo"
+object_key = "bar/pater-noster.mp3"
+
+s3.put_object(
+  bucket: bucket_name,
+  key: object_key,
+  body: audio_data
+)
+```
+
+### Latin langauge helper methods
+```ruby
 MedievalLatina.verb?("voco")
 => true
 
@@ -48,6 +93,7 @@ MedievalLatina.noun?("canis")
 After checking out the repo, run `bin/setup` to install dependencies.
 Then, run `rake spec` to run the tests.
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Maintain project style by running `bin/lint` before commiting changes.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
@@ -56,6 +102,9 @@ To release a new version:
 2. Run `bin/setup` to increment the version in the lock file
 3. Run `bundle exec rake release`
 
+Rebuild the lexicon files when you add new International Phonetic Alphabet pronunciations.
+You do this by running: `bin/build`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jaysonvirissimo/medieval_latina.

data/bin/build

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require "bundler/setup"
+require "medieval_latina"
+require "medieval_latina/lexicon_builder"
+
+def create_pls_file(file_path, words)
+  document = MedievalLatina::LexiconBuilder.new(words).call
+
+  File.open(file_path, 'w') do |file|
+    document.write(file, 2)
+    file.write("\n")
+  end
+end
+
+file_path = File.join(File.dirname(__FILE__), '..', 'data', 'dictionary.json')
+pronunciation_guide = JSON
+  .parse(File.read(file_path))
+  .each_with_object({}) do |(word, metadata), hash|
+    if metadata["ipa"]
+      hash[word] = metadata["ipa"]
+    end
+  end
+
+# Split the words across multiple PLS files
+lexicons_dir = File.join(File.dirname(__FILE__), '..', 'lexicons')
+size = pronunciation_guide.size
+number = size / 256
+fraction = size / number
+pronunciation_guide.each_slice(fraction).to_a.each_with_index do |array, index|
+  formatted_index = sprintf("%02d", index)
+  create_pls_file(File.join(lexicons_dir, "Latin#{formatted_index}.pls"), array.to_h)
+end

data/bin/lint

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+standardrb --fix