medieval_latina 2.1.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73b3e247e6a3cd36e70b64ebffb4d4947f2f3f343a8749693269c32e6dd5f64b
-  data.tar.gz: 21652459415b9160232035ca7a355dc0f4c1ffac0848f59b5793858e9c41fc0c
+  metadata.gz: 0dd902526791ea82b288d966db1bf6ac699ca6846256412aa60c9b685253e333
+  data.tar.gz: 9abfa510fa6c2f3dbc21b4e90b0392addc45a932c244d39cc6434ca46a810639
 SHA512:
-  metadata.gz: 5a2be43d8e45015049f7fd448626ff3800706c7b5b98f1792fe902788c2ba7a6d5a3c80d5e59d0415319f7432275d8eeaea294ad167e187486d07ab580128f79
-  data.tar.gz: aba3e38916bc44b9603fd50fd27dd4c3ea94a0a7e23b46a5201f334b73c045019082fa9a2cd45970fa1891a6f50daf95b0caacee8066a3e72e8c8f39fc27a14a
+  metadata.gz: 60e4c5925a37ac2ccc8e08ffcefd35a0d61cb8e4b46c81d1298d703dc31791b3ff7d7aabf828533d3e82842d5867eb7cc5a4aaee4422d6de4fc75f733aa58566
+  data.tar.gz: 5822082352ae540e0aa67b49ad2b20f3744502c36dcb7ec96d696fd76bd1469a31a0210901caddd76a21189abecf682a129a1a094e84c3c100e52a3e1166140a

data/.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Tests
+name: Tests and Linting
 
 on:
   pull_request:
@@ -11,7 +11,7 @@ on:
 jobs:
   unit_tests:
     name: Unit Tests
-    if: "contains(github.event.commits[0].message, '[ci skip]') == false"
+    if: ${{ ! contains(github.event.head_commit.message, '[ci skip]') }}
     strategy:
       fail-fast: false
       matrix:
@@ -19,16 +19,11 @@ jobs:
           - macos
           - ubuntu
         ruby:
-          - 2.7
-          - 3.0
-          - 3.1
-          - 3.2
+          - '3.2'
+          - '3.3'
+          - '3.4'
         allow_failures:
           - false
-        include:
-          - os: ubuntu
-            ruby: ruby-head
-            allow_failures: true
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
       ALLOW_FAILURES: "${{ matrix.allow_failures }}"
@@ -36,7 +31,7 @@ jobs:
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -44,3 +39,22 @@ jobs:
           bundler-cache: true
       - name: Test
         run: bundle exec rake spec || $ALLOW_FAILURES
+
+
+  lint:
+    name: Linting
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Lint Ruby
+        run: bundle exec standardrb
+      - name: Lint JSON
+        run: bundle exec jsonlint data/dictionary.json

data/.gitignore

@@ -9,3 +9,4 @@
 
 # rspec failure tracking
 .rspec_status
+.DS_Store

data/.standard.yml

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.0
+ruby 3.4.1

data/Gemfile

@@ -2,9 +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 "builder", group: [:development, :test]
-gem "standard", group: [:development, :test]

data/Gemfile.lock

@@ -1,24 +1,42 @@
 PATH
   remote: .
   specs:
-    medieval_latina (2.1.1)
+    medieval_latina (3.1.0)
       i18n
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    builder (3.2.4)
+    ast (2.4.2)
+    bigdecimal (3.1.8)
     concurrent-ruby (1.2.2)
     diff-lcs (1.3)
     i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
+    json (2.7.2)
+    jsonlint (0.4.0)
+      oj (~> 3)
+      optimist (~> 3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    mini_portile2 (2.8.6)
+    nokogiri (1.18.0)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    oj (3.16.5)
+      bigdecimal (>= 3.0)
+      ostruct (>= 0.2)
+    optimist (3.1.0)
+    ostruct (0.6.0)
+    parallel (1.26.1)
+    parser (3.3.4.2)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rexml (3.2.5)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -32,31 +50,49 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.83.0)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      rexml
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-performance (1.5.2)
-      rubocop (>= 0.71.0)
-    ruby-progressbar (1.10.1)
-    standard (0.4.2)
-      rubocop (~> 0.83.0)
-      rubocop-performance (~> 1.5.2)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.0)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    standardrb (1.0.1)
+      standard
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  builder
-  i18n
+  jsonlint
   medieval_latina!
+  nokogiri
   rake (~> 12.0)
   rspec (~> 3.0)
-  standard
+  standardrb
 
 BUNDLED WITH
    2.4.1

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,13 +102,13 @@ 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 file when you add new International Phonetic Alphabet pronunciations.
+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.
-Run `standardrb --fix` before submitting any changes, to help keep the code formatting uniform.
+Run `bin/lint` before submitting any changes, to help keep the code formatting uniform.
 
 ## License
 

data/bin/build

@@ -1,7 +1,34 @@
 #!/usr/bin/env ruby
 
+require 'json'
 require "bundler/setup"
 require "medieval_latina"
 require "medieval_latina/lexicon_builder"
 
-MedievalLatina::LexiconBuilder.write
+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,14 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# Run StandardRB to lint Ruby files
+echo "Linting Ruby files with StandardRB..."
+bundle exec standardrb
+
+# Run jsonlint to check the dictionary.json file
+echo "Linting dictionary.json with jsonlint..."
+bundle exec jsonlint data/dictionary.json
+
+echo "Linting completed."