merriam_webster_plus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b130e379f89000dd9d5662da07eb5fbebbeb5cff8d5ed9fabd6c0a4acc1902d9
+  data.tar.gz: d3171904a84c767ec0a3bd34c19d1e2244e5d8411e12b64c85a59c64d4167bbf
+SHA512:
+  metadata.gz: 6606bdad9e006a0dceb5da3989df75a96ec157fa574d2bc7e3976854b4f1ac3d93623828e0091aadf94f9a5609104c3a548d21c878086b54e442e901a55c9a20
+  data.tar.gz: fff5b65d8f9eae1eb4a1f6d7663790c3317f514b0e797eb68582e660b9160a83c224477fe37214b89ff4054060ce8a5e9858d00f0ab7d2f6122e277ee45e4140

data/.byebug_history

@@ -0,0 +1,256 @@
+exit
+@invalid_primary_entry
+c
+@invalid_entries
+exit
+@invalid_entries
+exit
+@invalid_entries
+exit
+csv[10]
+csv[9]
+csv[8]
+csv[7]
+csv[6]
+exit
+csv[5]
+csv[4]
+csv[3]
+csv[2]
+exit
+csv2[1]
+csv2[0]
+csv2.each {|row| p row}
+csv2 = CSV.open("test/csvs/test_out.csv").read
+csv2
+csv2.each {|row| p row}
+csv2 = CSV.open("test/csvs/test_out.csv").read.size
+csv2 = CSV.open("test/csvs/test_out.csv").read.class
+csv2 = CSV.open("test/csvs/test_out.csv").read
+csv.class
+csv
+IO.readlines(csv)
+IO.readlines(csv)[3]
+exit
+csv.first
+csv.last
+csv[2]
+csv.first
+csv[1]
+csv.[1]
+csv.first
+csv = CSV.open("fixtures/csvs/test_out_fixture.csv")
+csv.each {|row| p row}
+csv.first
+csv[0]
+csv.each {|row| p row}
+csv.each do {|row| p row}
+csv.class
+csv = CSV.open("fixtures/csvs/test_out_fixture.csv")
+CSV.open("fixtures/csvs/test_out_fixture.csv")
+File.open("fixtures/csvs/test_out_fixture.csv") == File.open("test/csvs/test_out.csv")
+File.open("fixtures/csvs/test_out_fixture.csv")
+File.open("fixtures/csvs/test_out_fixturea.csv")
+File.open("fixtures/csvs/test_out_fixture.csv")
+File.open("test/csvs/test_out.csv")
+File.open("csvs/test_out.csv")
+File.open(csvs/test_out.csv)
+@word_medley_primary_entry.class
+@word_medley_primary_entry
+pwd
+exit
+@word_medley_primary_entry
+exit
+@heteronym_merged_entries[1][:audio]
+@heteronym_merged_entries[0][:audio]
+@heteronym_merged_entries.size
+heteronym_merged_entries.size
+exit
+@non_heteronym_merged_entries[1][:audio]
+@non_heteronym_merged_entries[0][:audio]
+@non_heteronym_merged_entries.size
+exit
+@thesaurus_plus_lookup.primary_entry
+@thesaurus_plus_lookup
+exit
+@non_heteronym_merged_entries.size
+@non_heteronym_merged_entries.first
+@non_heteronym_merged_entries
+c
+@heteronym_merged_entries
+exit
+MerriamWebsterPlus::EntryAudioMerger.new(dst_entries: heteronym_dst_entries,
+																	   			src_entries: heteronym_src_entries).
+																									merged_entries
+exit
+MerriamWebsterPlus::EntryAudioMerger.new(dst_entries: non_heteronym_dst_entries,
+																	   		  src_entries: non_heteronym_src_entries).
+																									merged_entries
+MerriamWebsterPlus::EntryAudioMerger.new(dst_entries: non_heteronym_dst_entries,
+																	   		  src_entries: non_heteronym_src_entries).
+																									merged_entries
+		end
+MerriamWebsterPlus::DictionaryEntries.new(word: "beach").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "beach").main_entries
+exit
+MerriamWebsterPlus::DictionaryEntries.new(word: "beach").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "beach").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "lake").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "summery").main_entries
+MerriamWebsterPlus::DictionaryEntries.new(word: "summery").main_entries
+MerriamWebsterPlus::DictionaryEntries.new(word: "summer").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "summer").main_entries
+MerriamWebsterPlus::DictionaryEntries.new(word: "affect").main_entries
+MerriamWebsterPlus::ThesaurusEntries.new(word: "affect").main_entries
+exit
+@heteronym_merged_entries.last[:audio]
+@heteronym_merged_entries.first[:audio]
+@heteronym_dst_entries.last
+@heteronym_dst_entries.first
+exit
+@heteronym_entries.last[:audio]
+@heteronym_entries[1][:audio]
+@heteronym_entries.first[:audio]
+@heteronym_entries.first
+@heteronym_entries.size
+@heteronym_entries.szie
+@heteronym_entries
+c
+exit
+@valid_primary_entry
+puts JSON.pretty_generate(@valid_primary_entry) == @valid_primary_entry
+puts JSON.pretty_generate(@valid_primary_entry)
+@valid_primary_entry
+@valid_entry
+@valid_entries
+c
+exit
+@valid_entries
+exit
+ @valid_primary_sense[:antonyms_and_near_antonyms]
+ @valid_primary_sense[:antonyms]
+ @valid_primary_sense[:near_antonyms]
+ @valid_primary_sense[:synonymous_phrases]
+ @valid_primary_sense[:related_words]
+ @valid_primary_sense[:synonyms_and_near_synonyms]
+ @valid_primary_sense[:synonyms]
+ @valid_primary_sense[:definition]
+exit
+@valid_primary_sense[:example]
+c
+exit
+sense_group
+short_definition
+exit
+@valid_main_entry[:senses].first
+@valid_main_entry[:senses]
+exit
+@valid_main_entry[:senses]
+c
+continuec
+continue
+c
+continue
+sense_sequence.size
+sense_sequence
+short_definition
+continue
+short_definition
+exit
+short_definition
+sense_sequence.first
+sense_sequence.first.size
+sense_sequence.size
+sense_sequence.szie
+sense_sequence
+exit
+sense_sequence.each { |sense| puts sense.to_yaml }
+sense_sequence.size
+continue
+sense_sequence.each { |sense| puts sense.to_yaml }
+short_definition
+sense_sequence.first[0]
+sense_sequence.first[1]
+sense_sequence.first
+sense_sequence.first.first
+sense_sequence.first
+sense_sequence.first.first
+sense_sequence.first.first.first
+sense_sequence.first.first
+sense_sequence.first
+sense_sequence.first.size
+sense_sequence.first
+sense_sequence
+exit
+sense_sequence
+sense_sequence.size
+continue
+sense_sequence.size
+continue
+sense_sequence.size
+continue
+sense_sequence.size
+sense_sequence
+sense_sequence.size
+sense_sequence.each_with_index
+continue
+sense_sequence
+sense_sequence[1]
+sense_sequence.first
+sense_sequence
+exit
+senses
+sense_group
+next
+short_definition
+sense_sequence.each { |sense| puts sense.to_yaml }
+sense_sequence.each { |sense| p sense }
+sense_sequence
+exit
+select_verbal_illustration_section(defining_text_snote_section)
+defining_text_snote_section = defining_text_section&.select {|section| section[0]=="snote" }&.dig(0,1)
+defining_text_snote_section = defining_text_section&.select {|section| section[0]=="snote" }&.dig(0)
+defining_text_snote_section = defining_text_section&.select {|section| section[0]=="snote" }&.dig(0,1)
+defining_text_snote_section = defining_text_section&.select {|section| section[0]=="snote" }&.dig(0,1,0)
+defining_text_section&.select {|section| section[0]=="snote" }&.dig(0,1,0)
+puts defining_text_section.to_yaml
+defining_text_section
+select_verbal_illustration_section(defining_text_section_usage_notes)
+select_verbal_illustration_section(defining_text_section)
+c
+select_verbal_illustration_section(defining_text_section_usage_notes)
+select_verbal_illustration_section(defining_text_section)
+exit
+defining_text_section&.select {|section| section[0]=="vis" }&.last ||
+				defining_text_section_usage_notes&.select {|section| section[0]=="vis" }&.last
+defining_text_section&.select {|section| section[0]=="vis" }&.last
+defining_text_section_usage_notesdefining_text_section&.select {|section| section[0]=="vis" }&.last
+defining_text_section_usage_notes&.dig(1, 0, :t)&.gsub(/\{.*?\}/,'')&.strip
+verbal_illustration_section&.dig(1, 0, :t)&.gsub(/\{.*?\}/,'')&.strip ||
+				defining_text_section_usage_notes&.dig(1, 0, :t)&.gsub(/\{.*?\}/,'')&.strip
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0)
+defining_text_section&.select {|section| section[0]=="vis" }&.last
+verbal_illustration_section
+vis&.dig(1, 0, :t)&.gsub(/\{.*?\}/,'')&.strip
+vis = defining_text_section_usage_notes&.select {|section| section[0]=="vis" }&.last
+defining_text_section_usage_notes&.select {|section| section[0]=="vis" }&.last
+defining_text_section
+defining_text_section_usage_notes
+defining_text_section_usage_notes&.select {|section| section[0]=="vis" }&.last
+defining_text_section_usage_notes = defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0)
+v
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0,)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0,0)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1,0)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,1)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,0)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0)
+defining_text_section&.select {|section| section[0]=="uns" }
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,0,0)
+defining_text_section&.select {|section| section[0]=="uns" }&.dig(0,0,0).size
+defining_text_section&.select {|section| section[0]=="uns" }&.last&.last&.last.size
+defining_text_section&.select {|section| section[0]=="uns" }&.last&.last&.last
+defining_text_section&.select {|section| section[0]=="uns" }&.last&.last.size
+defining_text_section&.select {|section| section[0]=="uns" }&.last&.last
+defining_text_section&.select {|section| section[0]=="uns" }&.last.size

data/.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      COLLEGIATE_DICTIONARY_API_KEY: ${{ secrets.COLLEGIATE_DICTIONARY_API_KEY }}
+      COLLEGIATE_THESAURUS_API_KEY: ${{ secrets.COLLEGIATE_THESAURUS_API_KEY }}
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.log

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in merriam_webster_plus.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    merriam_webster_plus (0.1.0)
+      bundler (~> 2.3)
+      httparty
+      json
+      minitest
+      minitest-stub-const
+      rake
+      rubocop
+      vcr
+      webmock
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    minitest (5.16.1)
+    minitest-stub-const (0.6)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+    vcr (6.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  merriam_webster_plus!
+
+BUNDLED WITH
+   2.3.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+## Merriam-Webster Plus
+
+Easily get word definitions, synonyms/antonyms, usage examples, audio pronunciations, and more.
+
+Optimizes core Merriam-Webster APIs to create a singular lexical resource with maximal parts-of-dictionary-entry coverage.
+
+E.g. running 800 words from an official spelling bee list shows the following primary-entry coverage for Merriam-Webster Plus vs. its component sources:
+
+| Lexical Resource                          | Part of Speech | Definition | Example Sentence | Audio |
+| ----------------------------------------- |:--------------:| ----------:| ----------------:| -----:|
+| Merriam-Webster Plus                      | 99%            | 99%        | 87%              | 92%   |
+| Merriam-Webster's Collegiate  Dictionary  | 94%            | 94%        | 59%              | 89%   |
+| Merriam-Webster's Collegiate  Thesaurus   | 87%            | 87%        | 82%              | 0%    |
+
+
+## Usage
+
+Set environment variables for `COLLEGIATE_DICTIONARY_API_KEY` and `COLLEGIATE_THESAURUS_API_KEY` with eponymous keys from https://dictionaryapi.com/register/index.
+
+```ruby
+>> require "merriam_webster_plus"
+>> lookup = MerriamWebsterPlus::DictionaryPlus.new(word: "run")
+```
+```
+>> puts lookup.primary_entry.to_yaml
+---
+:word: run                                                                                 
+:class: verb                                                                               
+:definition: to go at a pace faster than a walk                                            
+:example: we ran all the way to the bus stop, but still missed the bus                     
+:audio: https://media.merriam-webster.com/audio/prons/en/us/mp3/r/run00001.mp3  
+```
+
+```
+>> puts lookup.entries.to_yaml
+---
+- :word: run                                                                               
+  :class: verb                                                                             
+  :audio: https://media.merriam-webster.com/audio/prons/en/us/mp3/r/run00001.mp3           
+  :senses:                                                                                 
+  - - 1                                                                                    
+    - :definition: to go at a pace faster than a walk                                      
+      :synonyms: dash, gallop, jog, scamper, sprint, trip, trot                      
+      :related_words: bound, canter, leap, lope, shag, skip, spring                  
+      :near_antonyms: amble, saunter, shamble, shuffle, stroll                       
+      :example: we ran all the way to the bus stop, but still missed the bus         
+  - - 2                                                                              
+    - :definition: to hasten away from something dangerous or frightening            
+      :synonyms: bolt, break, bug out, flee, fly, hightail (it), retreat, run away,  
+        run off, skedaddle                                                           
+      :related_words: abscond, clear out, decamp, elope, escape, get (away), get out,
+        lam, light out, make off, mizzle, scarper, scat, scram, skip (out), skirr
+      :synonymous_phrases: beat a retreat, beat it, make tracks, turn tail
+      :near_antonyms: beard, brave, confront, dare, defy, face
+      :example: rather than run from a black bear, it's better to hold your ground
+        and make lots of noise
+  - - 3
+    - :definition: to be positioned along a certain course or in a certain direction
+      :synonyms: bear, extend, go, head, lead, lie
+      :related_words: cross, cut, pass
+      :example: the road runs along the river for a while
+- :word: run
+  :class: noun
+  :audio: https://media.merriam-webster.com/audio/prons/en/us/mp3/r/run00001.mp3
+  :senses:
+  - - 1
+    - :definition: a prevailing or general movement or inclination
+      :synonyms: current, direction, drift, leaning, tendency, tide, trend, wind
+      :related_words: curve, downside, shift, swing, turn, turnabout, upside
+      :example: the company's stock has remained consistent with the overall run of
+        the market
+  - - 2
+    - :definition: a natural body of running water smaller than a river
+      :synonyms: beck, bourn, brook, brooklet, burn, creek, gill, rill, rivulet, runlet,
+        runnel, streamlet
+      :related_words: arroyo, billabong, fresh, freshet, runoff
+      :example: a run full of catfish
+  - - 3
+    - :definition: the period during which something exists, lasts, or is in progress
+      :synonyms: continuance, date, duration, life, life span, lifetime, standing,
+        time
+      :related_words: spell, stretch
+      :example: the actor has been assigned the part for the run of the show
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CRiSToBaLZ/merriam_webster_plus.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ["--fail-level", "E"]
+end
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "merriam_webster_plus"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/mwp

@@ -0,0 +1,4 @@
+require "merriam_webster_plus/dictionary_plus"
+
+puts MerriamWebsterPlus::DictionaryPlus.new(word: ARGV[0]).primary_entry.to_yaml
+puts

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fixtures/vcr_cassettes/empty_api_entries.yml

@@ -0,0 +1,37 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://www.dictionaryapi.com/api/v3/references/collegiate/json/?key=<COLLEGIATE_DICTIONARY_API_KEY>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Tue, 21 Jun 2022 23:24:59 GMT
+      Content-Type:
+      - text/html; charset=UTF-8
+      Content-Length:
+      - '17'
+      Connection:
+      - keep-alive
+      Server:
+      - Apache
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: Word is required.
+  recorded_at: Tue, 21 Jun 2022 23:24:59 GMT
+recorded_with: VCR 6.1.0