rhymera 0.1.0

data/README.md

@@ -0,0 +1,37 @@
+# Rhymera
+
+Rhymera is a CLI gem to search the [RhymeBrain](https://rhymebrain.com) API for rhymes and portmanteaus of a given query. Menus give you the option to start a new search with the result, look through previous searches, or copy a result to the clipboard.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rhymera'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rhymera
+
+## Usage
+
+Execute `rhymera`. After searching a query and choosing which type of search to conduct, you can find more information about each result in the menus.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/revarcline/rhymera.
+
+## License
+
+Licensed under GPL 3.0, See LICENSE for details.

data/ROADMAP.md

@@ -0,0 +1,101 @@
+RHYMERA
+===
+ for api/scraper calls
+[RhymeBrain](https://rhymebrain.com) for rhymes and portmanteaus
+[clipboard](https://github.com/janlelis/clipboard) to copy result to clipboard
+
+HEY OK DITCHING CLI/UI BECAUSE THEN YOU WON'T NEED THE DAMN HASH
+like then you can just return objects
+as cool as interactivity is it's not what they're looking for
+
+make sure you go back to initializing list as array!
+
+please research how to
+a) take args from cli
+b) paginate (should be easy) (also, its own method)
+
+
+should probably review revision history of this document for blog post
+of note:
+initially wanted to add in scraper for OneLook but it was unscrapable (no js)
+tried building with cli-ui gem from shopify so i could get a nice interactive prompt
+however returning a string hobbled this - if i could understand the handlers better, maybe?
+
+this way i can generate my list by iterating through each object enumerable
+
+maybe switch to [TTY::Prompt](https://github.com/piotrmurach/tty-prompt)
+i can keep my objects as arrays (clean, no redundancy)
+and make my menus return the object value itself!
+should be able to do this as a block!
+
+ok! so blogpost about "picking the right depedencies"
+- shopify's looked pretty fresh, liked the vi-keys functionality
+- only returned string value though, meaning i would need to do some dumb iterations
+- tty-prompt allowed me to more easily pass a hash
+
+## basic outline:
+
+present with
+"Enter a word"
+or "quit"
+
+then, choose
+1) rhyme
+(type: getRhymes)
+2) portmanteaus
+(type: getPortmanteaus)
+
+get a list of results back (possibly limit or paginate?)
+
+
+detail view, common (module?)
+- copy to clipboard
+- search using word as query
+- search previous query
+- search a new query 
+- back to list
+
+detail view - rhyme
+word
+number of syllables
+
+detail view - portmanteau
+portmanteau (actually spelling[0])
+root word 1
+root word 2 (selectable with common menu)
+alternative (spelling[1] if spelling[1])
+ - selectable and switches with portmanteau name on selection (incl searchability)
+
+## classes (and tests):
+
+### Rhymera
+- creates menu
+- do i make everything extend it so i can call it from other stuff?
+
+### Menu
+- handles choices, relies on `TTY::Prompt`
+- send word to clipboard with `Clipboard`
+- displays `List` object as selectable menu
+    - also: search new word/previous search/search {other type}
+- selecting `Rhyme` or `Portmanteau` entry shows relevant details, option to search
+
+### List
+- init with type (rhyme or port) and query
+- has many `Rhyme`, `Portmanteau`
+- collects the prior for display from a rhymebrain call
+- class instance variable with prior queries!
+
+### Rhyme
+- contains each rhyme entry from json object
+- syllables
+
+### Portmanteau
+- contains each portmanteau entry from json object
+- spelling (array of one or two)
+- source 1
+- source 2
+test:
+make sure it parses input correctly, and `:alternative` is conditional on original object
+
+### RhymeBrain
+- uses input to structure api, scrapes rhymebrain results page, returns json

data/Rakefile

@@ -0,0 +1,12 @@
+# 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
+
+task default: :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rhymera'
+require_relative '../config/environment'
+
+# 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/rhymera

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/rhymera'
+Rhymera::Menu.new.call

data/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'rhymera'

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/lib/rhymera.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative 'rhymera/version'
+require_relative 'rhymera/menu'
+require_relative 'rhymera/list'
+require_relative 'rhymera/rhymebrain'
+require_relative 'rhymera/rhyme'
+require_relative 'rhymera/portmanteau'
+
+module Rhymera
+  class Error < StandardError; end
+end

data/lib/rhymera/list.rb

@@ -0,0 +1,50 @@
+module Rhymera
+  # container for lists of Rhyme and Portmanteau
+  class List
+    attr_reader :query, :type, :object
+    attr_accessor :entries
+
+    @all = []
+
+    # using class instance variable instead of class variable per rubocop
+    class << self
+      attr_accessor :all
+    end
+
+    def initialize(function:, word:)
+      @object = Rhymera::RhymeBrain.query(function: function, word: word)
+      @query = word
+      @type = function
+      @entries = []
+      build_correct_type
+
+      # add to all hash
+      self.class.all << self
+    end
+
+    def build_correct_type
+      case @type
+      when 'getRhymes'
+        create_rhymes
+      when 'getPortmanteaus'
+        create_portmanteaus
+      end
+    end
+
+    def create_portmanteaus
+      @object.each do |entry|
+        port = Rhymera::Portmanteau.new(source: entry['source'],
+                                        combined: entry['combined'])
+        entries << port
+      end
+    end
+
+    def create_rhymes
+      @object.each do |entry|
+        rhyme = Rhymera::Rhyme.new(word: entry['word'],
+                                   syllables: entry['syllables'])
+        entries << rhyme
+      end
+    end
+  end
+end

data/lib/rhymera/menu.rb

@@ -0,0 +1,82 @@
+require 'clipboard'
+require 'tty-prompt'
+
+module Rhymera
+  # menu handler
+  class Menu
+    attr_accessor :list, :result, :word, :function
+    attr_reader :prompt
+
+    def initialize
+      @prompt = TTY::Prompt.new
+      # print once on intialization
+      puts 'Welcome to Rhymera.'
+    end
+
+    def call
+      @word = prompt.ask("Please enter a search term or :q to quit.\n>")
+      call if @word == ''
+      # vim-style quit, seems best
+      exit(0) if @word == ':q'
+      search(@word)
+    end
+
+    def search(term)
+      # can be called again and again!
+      @word = term
+      @function = search_type
+      @list = Rhymera::List.new(word: @word, function: "get#{@function}")
+      display_results
+    end
+
+    def search_type
+      prompt.select('Which type of result are you looking for?',
+                    %w[Rhymes Portmanteaus])
+    end
+
+    def display_results
+      # can be called both by search and previous entries
+      results = extra_menu_entries
+      results << @list.entries.map { |ent| { ent.word.to_s => ent } }
+      result = prompt.select("#{@function} for '#{@word}' and other options:", results)
+
+      @word = result.word
+      detail_view(result)
+    end
+
+    def extra_menu_entries
+      # options leading to lambas! we love lambdas, don't we folks
+      [{ "Copy '#{@word}' to Clipboard" => -> { Clipboard.copy(@word) } },
+       { "Search '#{@word}'" => -> { search(@word) } },
+       { 'New Search' => -> { call } },
+       { 'Previous Searches' => -> { old_searches } },
+       { 'Quit Program' => -> { exit(0) } }]
+    end
+
+    def detail_view(object)
+      menu = extra_menu_entries
+      # iterate through attrs of a given Rhyme or Portmanteau for display
+      object.instance_variables.each do |var|
+        arg = var.to_s.gsub('@', '')
+        word = object.send(arg)
+        menu << { "#{arg.capitalize}: #{word}" => word }
+      end
+      opts = prompt.select("More details on #{@word}:", menu)
+
+      @word = opts
+      prompt.select("More details on #{@word}:", extra_menu_entries)
+    end
+
+    def old_searches
+      # here's one of the ol' class methods
+      lists = Rhymera::List.all.map do |list|
+        { "#{list.type[3..]} for #{list.query}" => list }
+      end
+      selection = prompt.select('Previous searches:', lists)
+      @list = selection
+      @function = selection.type[3..]
+      @word = selection.query
+      display_results
+    end
+  end
+end

data/lib/rhymera/portmanteau.rb

@@ -0,0 +1,15 @@
+module Rhymera
+  # converts RhymeBrain json data to object
+  class Portmanteau
+    attr_reader :prefix, :suffix, :word, :alternative
+
+    def initialize(source:, combined:)
+      source_words = source.split(',')
+      combined_words = combined.split(',')
+      @prefix = source_words[0]
+      @suffix = source_words[1]
+      @word = combined_words[0]
+      @alternative = combined_words[1] if combined_words[1]
+    end
+  end
+end

data/lib/rhymera/rhyme.rb

@@ -0,0 +1,11 @@
+module Rhymera
+  # converts RhymeBrain json to object
+  class Rhyme
+    attr_reader :word, :syllables
+
+    def initialize(word:, syllables:)
+      @word = word
+      @syllables = syllables
+    end
+  end
+end

data/lib/rhymera/rhymebrain.rb

@@ -0,0 +1,12 @@
+require 'net/http'
+require 'json'
+
+module Rhymera
+  # calls Rhymebrain API via URL, gets JSON object
+  class RhymeBrain
+    def self.query(function:, word:)
+      uri = URI.parse("https://rhymebrain.com/talk?function=#{function}&word=#{word}")
+      JSON.parse(Net::HTTP.get(uri))
+    end
+  end
+end

data/lib/rhymera/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Rhymera
+  VERSION = '0.1.0'
+end

data/rhymera.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rhymera/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rhymera'
+  spec.version       = Rhymera::VERSION
+  spec.authors       = ['Alex Cline']
+  spec.email         = ['rev.a.r.cline@gmail.com']
+
+  spec.summary       = 'rhyme and portmanteau generator'
+  spec.description   = 'uses RhymeBrain api to find rhymes and portmanteaus'
+  spec.homepage      = 'https://github.com/revarcline/rhymera'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.1')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/revarcline/rhymera.git'
+  spec.metadata['changelog_uri'] = 'https://github.com/revarcline/rhymera/blob/main/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = %w[rhymera]
+  spec.require_paths = %w[lib bin]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency 'clipboard', '~> 1.3'
+  spec.add_dependency 'tty-prompt', '~> 0.23'
+
+  spec.add_development_dependency 'bundler', '~> 2.2'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/scratch.rb

@@ -0,0 +1,31 @@
+require 'tty-prompt'
+require_relative 'lib/rhymera'
+prompt = TTY::Prompt.new
+port_list = Rhymera::List.new(function: 'getPortmanteaus', word: 'fancy')
+
+prompt.yes?('is this working?')
+
+prompt.select('Select a result for more info',
+              port_list.entries.map(&:word))
+
+object = prompt.select('Select a result for more info',
+                       port_list.entries.map { |entry| { entry.word.to_s => entry } })
+
+object.instance_variables
+
+object.instance_variables.first.to_s.gsub('@', '')
+
+object.source_one
+
+object.instance_variables.each do |var|
+  arg = var.to_s.gsub('@', '')
+  puts "#{arg.capitalize}: #{object.send(arg)}"
+end
+
+Rhymera::List.all
+
+Rhymera::List.all.first.class.to_s.split('::')[1]
+Rhymera::List.all.first.entries.first.word
+
+Rhymera::List.all.first.query
+Rhymera::List.all.first.type[3..]