wordword 1.0.0

data/README.md

@@ -0,0 +1,44 @@
+# Wordword
+
+Process of learning of a new language consist of two parts - grammar and vocabulary. First is best studied with a person near you, a book and will to understand and grasp the concepts of a language. The second, though, can be improved by repetition and perservance. In order to ease the process of repetition of learning words and stick to the most minimal sufficient environment without hussle of the UI this gem is created specifically to work in the console. Just toss the words and translations list file in the `wordword train FILE` command and you are good to go!
+
+## Installation
+
+Install it with:
+
+    $ gem install wordword
+
+## Usage
+
+This application has two commands - `train` and `compose`.
+
+`train` command is a command that is aimed to train (oh yeah?) your knowledge of the words in the file provided with tests like that one. It goes over all the words in the file and says you if you are wrong. In the end you are either congratulated with no wrong answers or given a list of wrong answers and their relative correct ones.
+
+```
+What is the translation of 'die Apfeltasche'? (Use ↑/↓ arrow keys, press Enter to select)
+‣ apple pie
+  beer
+  hamburger
+  fries
+```
+
+`compose` command allows you to create files that can be processed by `train` command. It asks you for word and translation until you ethier interrupt the command or type `\q` into the prompt.
+After this you can save this in the file. If the file already exists, it allows you to merge new and old words and save them in that file, discard your new words or rewrite the file and write only the new words in the file.
+
+## Development
+
+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.
+
+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 tags, 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/artur-martsinkovskyi/wordword. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Code of Conduct
+
+Everyone interacting in the Wordword project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/artur-martsinovskyi/wordword/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2020 Artur Martsinkovskyi. See [MIT License](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'wordword'
+
+# 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/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/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  errors:
+    file_is_not_readable: "File is not readable. Check if it exists and you have correct permissions."
+    file_is_not_parseable: "File can't be parsed. Check if it is a valid words file e.g. that it includes only lines separated by # with words on each sides of it."
+  train:
+    interrupted: "\nYou finished the training abruptly."
+    wrong_alert: "Wrong!"
+    wrong_answers_intro: "Here are the words/phrases you got wrong:"
+    wrong_answer_entry: "%{word} is %{correct_answer}. Your answer was %{answer}."
+    everything_correct: "You've got every word/phrase right. You're awesome, [FRIENDLY PRONOUN OF CHOICE]."

data/exe/wordword

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require "wordword/cli"
+
+Signal.trap("INT") do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Wordword::CLI.start
+rescue Wordword::CLI::Error => e
+  puts "ERROR: #{e.message}"
+  exit 1
+end

data/lib/initializers/i18n.rb

@@ -0,0 +1,4 @@
+require "i18n"
+
+I18n.load_path << Dir[File.expand_path("config/locales") + "/*.yml"]
+I18n.default_locale = :en

data/lib/wordword.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "wordword/version"
+
+module Wordword
+  class Error < StandardError; end
+  Dir[File.join(File.dirname(__FILE__), "initializers", "*")].map { |f| require f }
+  # Your code goes here...
+end

data/lib/wordword/cli.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "thor"
+require_relative "../wordword"
+
+module Wordword
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor
+
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc "version", "wordword version"
+    def version
+      require_relative "version"
+      puts File.read(File.join(File.dirname(__FILE__), "..", "..", "assets/logo.txt"))
+      puts "v#{Wordword::VERSION}"
+    end
+    map %w[--version -v] => :version
+
+    desc "compose", "Launches a repl loop to create file with words/phrases and translations that can be fed to train"
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
+    def compose(*)
+      if options[:help]
+        invoke :help, ["compose"]
+      else
+        require_relative "commands/compose"
+        Wordword::Commands::Compose.new(options).execute
+      end
+    end
+
+    desc "train FILE", "Train knowledge of the words in the provided file."
+    method_option :help, aliases: "-h", type: :boolean,
+                         desc: "Display usage information"
+    method_option :number, type: :numeric, aliases: %w[-n],
+                           desc: "Number of words to be trained"
+    def train(file = nil)
+      if options[:help]
+        invoke :help, ["train"]
+      else
+        require_relative "commands/train"
+        Wordword::Commands::Train.new(file, options).execute
+      end
+    end
+
+  end
+end
+__END__
+
+I8,        8        ,8I   ,ad8888ba,    88888888ba   88888888ba,             "8a           I8,        8        ,8I   ,ad8888ba,    88888888ba   88888888ba,
+`8b       d8b       d8'  d8"'    `"8b   88      "8b  88      `"8b              "8a         `8b       d8b       d8'  d8"'    `"8b   88      "8b  88      `"8b
+ "8,     ,8"8,     ,8"  d8'        `8b  88      ,8P  88        `8b               "8a        "8,     ,8"8,     ,8"  d8'        `8b  88      ,8P  88        `8b
+  Y8     8P Y8     8P   88          88  88aaaaaa8P'  88         88                 "8a       Y8     8P Y8     8P   88          88  88aaaaaa8P'  88         88
+  `8b   d8' `8b   d8'   88          88  88""""88'    88         88     aaaaaaaa    a8"       `8b   d8' `8b   d8'   88          88  88""""88'    88         88
+   `8a a8'   `8a a8'    Y8,        ,8P  88    `8b    88         8P     """"""""  a8"          `8a a8'   `8a a8'    Y8,        ,8P  88    `8b    88         8P
+    `8a8'     `8a8'      Y8a.    .a8P   88     `8b   88      .a8P              a8"             `8a8'     `8a8'      Y8a.    .a8P   88     `8b   88      .a8P
+     `8'       `8'        `"Y8888Y"'    88      `8b  88888888Y"'             a8"                `8'       `8'        `"Y8888Y"'    88      `8b  88888888Y"'

data/lib/wordword/command.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Wordword
+  class Command
+
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute(*)
+      raise(
+        NotImplementedError,
+        "#{self.class}##{__method__} must be implemented",
+      )
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command(**options)
+      require "tty-command"
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require "tty-cursor"
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require "tty-editor"
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require "tty-file"
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager(**options)
+      require "tty-pager"
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require "tty-platform"
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt(**options)
+      require "tty-prompt"
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require "tty-screen"
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which(*args)
+      require "tty-which"
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist?(*args)
+      require "tty-which"
+      TTY::Which.exist?(*args)
+    end
+
+  end
+end

data/lib/wordword/commands/.gitkeep

@@ -0,0 +1 @@
+#

data/lib/wordword/commands/compose.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../interactors/compose/handle_exit"
+
+module Wordword
+  module Commands
+    class Compose < Wordword::Command
+
+      QUIT_CODE = '\\q'
+
+      def initialize(options)
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        words = {}
+        loop do
+          word = prompt.ask(
+            "What is the word/phrase?(write #{QUIT_CODE} to exit)",
+          ) do |w|
+            w.required true
+          end
+          break if word == QUIT_CODE
+
+          translation = prompt.ask(
+            "What is the translation?(write #{QUIT_CODE} to exit)",
+          ) do |t|
+            t.required true
+          end
+          break if translation == QUIT_CODE
+
+          words[word] = translation
+        end
+      rescue TTY::Reader::InputInterrupt
+        prompt.error("\nYou interrupted the command, exiting...")
+      ensure
+        ::Compose::HandleExit.new(self).call(words)
+      end
+
+    end
+  end
+end

data/lib/wordword/commands/train.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "../command"
+require_relative "../operations/read_word_table"
+require_relative "../interactors/train/word_loop"
+require "tty/reader"
+
+module Wordword
+  module Commands
+    class Train < Wordword::Command
+
+      def initialize(file, options)
+        @file = file
+        @options = options
+      end
+
+      def execute(input: $stdin, output: $stdout)
+        read_result = ReadWordTable.new.call(filename: @file)
+        if read_result.success?
+          words = read_result.success
+        else
+          output.puts(
+            pastel.red(
+              I18n.t("errors.#{read_result.failure}"),
+            ),
+          )
+          return
+        end
+
+        word_loop.run(
+          words,
+          loop_depth: @options[:number],
+        )
+      rescue TTY::Reader::InputInterrupt
+        prompt.error(
+          pastel.red(
+            I18n.t("train.interrupted"),
+          ),
+        )
+      ensure
+        if words && word_loop
+          if word_loop.wrong_answers.any?
+            prompt.error(I18n.t("train.wrong_answers_intro"))
+            word_loop.wrong_answers.each do |wrong_answer_message|
+              prompt.say(wrong_answer_message)
+            end
+          elsif words.any?
+            prompt.ok(
+              I18n.t("train.everything_correct"),
+            )
+          end
+        end
+      end
+
+      private
+
+      def word_loop
+        @word_loop ||= ::Train::WordLoop.new(self)
+      end
+
+      def pastel
+        @pastel ||= Pastel.new
+      end
+
+    end
+  end
+end

data/lib/wordword/interactors/compose/handle_exit.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require_relative "../../operations/read_word_table"
+
+module Compose
+  class HandleExit
+
+    extend Forwardable
+
+    def_delegators :@command_context, :prompt
+
+    MERGE = :merge
+    REWRITE = :rewrite
+
+    def initialize(command_context)
+      @command_context = command_context
+    end
+
+    def call(words)
+      return unless words.any?
+      return unless prompt.yes?("Save the file?")
+
+      filename = prompt.ask("What is the filename?")
+      if File.exist?(filename)
+        file_mode = ask_file_mode
+        if file_mode == REWRITE
+          write_words(filename, words)
+        elsif file_mode == MERGE
+          existing_words = ReadWordTable.new.call(filename: filename).value!
+          merged_words = existing_words.merge(words)
+
+          write_words(filename, merged_words)
+        end
+      else
+        write_words(filename, words)
+      end
+    end
+
+    private
+
+    def ask_file_mode
+      prompt.select(
+        "File with that name already exists. Merge, rewrite or discard current input?(it will be lost in that case)",
+      ) do |menu|
+        menu.choice "Merge", -> { MERGE }
+        menu.choice "Rewrite", -> { REWRITE }
+        menu.choice "Discard"
+      end
+    end
+
+    def write_words(filename, words)
+      File.write(
+        filename,
+        words.sort.to_h.map { |word| word.join(" # ") }.join("\n"),
+      )
+    end
+
+  end
+end