language_cards 0.3.1 → 2.0.0

data/lib/language_cards/modes/game.rb

@@ -3,18 +3,20 @@ module LanguageCards
   module Modes
     class Game
       def initialize card_set
-        @card_set = card_set
+        @card_set = card_set.cards
         @index = 0
         @current = nil
       end
 
       def current
-        @current or raise "Current grapheme not yet set!"
+        @current or raise "Current flash card not yet set!"
       end
 
-      # @return Grapheme Returns a random grapheme
+      # Picks a random card, avoiding the same card twice in a row.
+      # @return self
       def sample
-        @current = @card_set.sample
+        choices = @card_set.length > 1 ? @card_set - [@current] : @card_set
+        @current = choices.sample
         self
       end
 
@@ -25,6 +27,15 @@ module LanguageCards
         @index += 1
         @current = value
       end
+
+      private
+      # Makes comparisons forgiving of surrounding/repeated whitespace and of
+      # differing Unicode compositions (e.g. pinyin tone marks).
+      def normalize(text)
+        text = text.to_s
+        text = text.unicode_normalize(:nfc) rescue text
+        text.strip.squeeze(' ')
+      end
     end
   end
 end

data/lib/language_cards/modes/translate.rb

@@ -1,14 +1,25 @@
 require 'language_cards/modes/game'
 module LanguageCards
   module Modes
+    def self.translate card_set
+      Translate.new card_set
+    end
+
     class Translate < Game
       def match? input
-        current.translation.any? {|value| value == input }
+        answer = comparable(input)
+        current.translation.any? {|value| comparable(value) == answer }
       end
 
       def mode
         :translate
       end
+
+      private
+      # Case-insensitive, and a leading "to " is optional ("to eat" == "eat").
+      def comparable(text)
+        normalize(text).downcase.sub(/\Ato (?=\S)/, '')
+      end
     end
   end
 end

data/lib/language_cards/modes/typing_practice.rb

@@ -1,9 +1,13 @@
 require 'language_cards/modes/game'
 module LanguageCards
   module Modes
+    def self.typing_practice card_set
+      TypingPractice.new card_set
+    end
+
     class TypingPractice < Game
       def match? input
-        "#{current}" == input
+        normalize(current) == normalize(input)
       end
 
       def mode

data/lib/language_cards/paginator.rb

@@ -0,0 +1,59 @@
+module LanguageCards
+  # Splits a list of menu entries into pages so long menus stay readable.
+  # Entries keep their absolute numbering across pages, so any listed
+  # number can be picked no matter which page is currently shown.
+  class Paginator
+    attr_reader :items, :per_page, :page
+
+    def initialize(items, per_page = PER_PAGE)
+      @items = Array(items)
+      @per_page = [per_page.to_i, 1].max
+      @page = 0
+    end
+
+    # @return Array<Array(Integer, Object)> number/item pairs for the current page
+    def current
+      items.each_with_index
+           .map {|item, index| [index + 1, item] }
+           .slice(page * per_page, per_page) || []
+    end
+
+    def pages
+      [(items.length.to_f / per_page).ceil, 1].max
+    end
+
+    def paginated?
+      pages > 1
+    end
+
+    def next_page?
+      page < pages - 1
+    end
+
+    def previous_page?
+      page > 0
+    end
+
+    def next_page
+      @page += 1 if next_page?
+      self
+    end
+
+    def previous_page
+      @page -= 1 if previous_page?
+      self
+    end
+
+    # @param number [Integer] the 1-based number shown in the menu
+    # @return the item for that number or nil
+    def [](number)
+      number = Integer(number) rescue (return nil)
+      return nil unless (1..items.length).include?(number)
+      items[number - 1]
+    end
+
+    def offset
+      page * per_page
+    end
+  end
+end

data/lib/language_cards/user_interface.rb

@@ -1,17 +1,17 @@
 require 'language_cards/timer'
+require 'language_cards/paginator'
 require 'language_cards/helpers/view_helper'
 require 'language_cards/helpers/game_helper'
 require 'language_cards/controllers/main_menu'
 require 'language_cards/controllers/game'
-require 'erb'
 
 module LanguageCards
   class UserInterface
     include Helpers::ViewHelper
     include Controllers
-    def initialize cards
-      @cards = cards
-      @courses = process_courses(cards)
+    def initialize menu_items
+      @menu_items = menu_items
+      @languages = group_by_language(menu_items)
       @mode = [:translate, :typing_practice].cycle
     end
 
@@ -22,70 +22,102 @@ module LanguageCards
         sleep 2
       end
 
-      begin
-        loop do
-          clear
-
-          CLI.say MainMenu.new(opts).render courses: courses, mode: mode
-
-          value = CLI.ask("")
-
-          next mode.next if value =~ /\Am\z/i
-          value = value.to_i - 1 rescue next
-
-          last = nil
-          if (0..courses.length-1).include? value
-
-            collection = cards[value] # MenuNode
-            title = "#{collection.title} (#{humanize mode.peek})"
-            collection = collection.mode(mode.peek) # Mode<CardSet> < Game
-
-            game = Game.new(opts)
-            timer = Timer.new
-            begin # Game Loop
-              loop do
-                clear
-                timer.mark
-                CLI.say game.render correct: correct,
-                                    incorrect: incorrect,
-                                    title: title,
-                                    timer: timer,
-                                    last: last
-                result = game.process(collection, collection.mode)
-                result[:correct] ? correct! : incorrect!
-                last = result[:last]
-              end
-            rescue SystemExit, Interrupt
-            end
-          end
-        end
-
-      rescue SystemExit, Interrupt
+      catch(:quit) do
+        languages.length == 1 ? card_set_menu(languages.keys.first, false) : language_menu
       end
+    rescue SystemExit, Interrupt, EOFError
     end
 
     private
-    attr_reader :mode, :cards, :correct, :incorrect, :courses
+    attr_reader :mode, :menu_items, :languages
     def opts
       @opts ||= {}
     end
 
-    def correct!
-      @correct = @correct.to_i + 1
+    # First screen: pick a language.
+    def language_menu
+      menu_loop(
+        Paginator.new(languages.keys),
+        heading: t('Menu.ChooseLanguage'),
+        label: ->(language) {
+          sets = languages[language].length
+          "#{language} (#{sets} #{t(sets == 1 ? 'Menu.Set' : 'Menu.Sets')})"
+        }
+      ) {|language| card_set_menu(language) }
+    end
+
+    # Second screen: pick a card set for the chosen language.
+    def card_set_menu(language, back = true)
+      menu_loop(
+        Paginator.new(languages[language]),
+        heading: "#{language}#{JOIN}#{t('Menu.ChooseCardSet')}",
+        back: back,
+        label: ->(course) { "#{course.title(JOIN, 1..-1)} (#{course.size} #{t('Menu.Cards')})" }
+      ) {|course| play(course) }
     end
 
-    def incorrect!
-      @incorrect = @incorrect.to_i + 1
+    # Renders a paginated menu until the user goes back.  Selected items
+    # are yielded to the block.
+    def menu_loop(pages, heading:, label:, back: false)
+      loop do
+        clear
+        CLI.say MainMenu.new(opts).render courses: pages.current.map {|_, item| label.(item) },
+                                          offset: pages.offset,
+                                          mode: mode,
+                                          heading: heading,
+                                          pages: pages,
+                                          back: back
+
+        value = CLI.ask("").to_s.strip
+
+        case value
+        when /\Am\z/i then mode.next
+        when /\An\z/i, '>' then pages.next_page
+        when /\Ap\z/i, '<' then pages.previous_page
+        when /\Ab\z/i then return if back
+        when /\Aq\z/i then throw :quit
+        else
+          item = pages[value]
+          yield item if item
+        end
+      end
     end
 
-    def process_courses(cards)
-      courses = cards.flat_map {|i| i.label.join(' - ') }
+    def play(course)
+      title = "#{course.title} (#{humanize mode.peek})"
+      collection = course.game(mode.peek) # Mode<CardSet> < Game
+      game = Game.new(opts)
+      timer = Timer.new
+      correct = incorrect = last = nil
+
+      loop do # Game Loop
+        clear
+        timer.mark
+        CLI.say game.render correct: correct,
+                            incorrect: incorrect,
+                            title: title,
+                            timer: timer,
+                            last: last
+        result = game.process(collection)
+        if result[:correct]
+          correct = correct.to_i + 1
+        else
+          incorrect = incorrect.to_i + 1
+        end
+        last = result[:last]
+      end
+    rescue Interrupt # CTRL-C returns to the menu
+    end
 
-      if courses.empty?
+    # @return Hash{String => Array<MenuNode>} languages sorted by name
+    def group_by_language(menu_items)
+      if menu_items.empty?
         opts[:errors] = ["No Flash Cards found for language: #{CARD_LANGUAGE}"]
       end
 
-      courses
+      menu_items.group_by {|item| item.label.first }
+                .sort_by {|language, _| language.downcase }
+                .to_h
     end
   end
 end

data/lib/language_cards/version.rb

@@ -1,3 +1,3 @@
 module LanguageCards
-  VERSION = "0.3.1"
+  VERSION = "2.0.0"
 end

data/lib/language_cards/view/main_menu.erb

@@ -5,5 +5,7 @@
 <% (_courses.empty? ? errors : _courses).each do |course| %>
   <%= course.chomp %><% end %>
 
-<%= draw(_mexit, nil, _toggle) %>
+<% if _page %><%= draw(_page.first, nil, _page.last) %>
+<% end %><%= draw(_back, nil, _toggle) %>
+<%= draw(_mexit, nil, _quit) %>
 <%= divider %>

data/lib/language_cards/yaml_loader.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 module LanguageCards
   class YAMLLoader
     def initialize
@@ -8,7 +10,7 @@ module LanguageCards
       cards = {}
 
       cards_yaml.each do |c|
-        next unless yaml_data = YAML.load(File.open(c).read)
+        next unless yaml_data = YAML.safe_load(File.read(c, encoding: 'UTF-8'))
         for language in yaml_data.keys do
           # Merges sub-items for languages
           if cards.has_key? language
@@ -35,12 +37,12 @@ module LanguageCards
     end
 
     def application_path_cards_yaml
-      Dir[File.join(application_path, 'cards', language, '*.yml')]
+      Dir[File.join(application_path, 'cards', language, '*.yml')].sort
     end
 
     def home_path_cards_yaml
       if ENV['HOME']
-        Dir[File.join(ENV['HOME'], '.language_cards', 'cards', language, '*.yml')]
+        Dir[File.join(ENV['HOME'], '.language_cards', 'cards', language, '*.yml')].sort
       else
         []
       end

data/lib/language_cards.rb

@@ -1,9 +1,8 @@
 require 'language_cards/version'
-require 'language_cards/language_cards'
-require 'yaml'
-require 'i18n'
-require 'slop'
-require 'highline'
+require 'language_cards/defaults'
+require 'language_cards/yaml_loader'
+require 'language_cards/user_interface'
+require 'language_cards/menu_builder'
 
 ##
 # TODO:
@@ -12,25 +11,9 @@ require 'highline'
 #  * Weighted random for better learning
 
 module LanguageCards
-  OPTS = Slop.parse do |args|
-    args.string '-l', '--language', 'language (default: en)', default: 'en'
-  end
-
-  CARD_LANGUAGE = OPTS[:language]
-
-  module ESC
-    CLEAR = (ERASE_SCOLLBACK = "\e[3J") + (CURSOR_HOME = "\e[H") + (ERASE_DISPLAY = "\e[2J")
-  end
-
-  CLI = HighLine.new
-  JOIN = " : "
-
-  SUBMENUWIDTH = 60
-
-  ::I18n.load_path = Dir[File.join(File.expand_path(File.join('..','..'), __FILE__), 'locales', '*.yml')]
-  ::I18n.load_path += Dir[File.join(File.expand_path(ENV['HOME']), '.language_cards', 'locales', '*.yml')] if ENV['HOME']
-
   def self.start
-    LanguageCards.new.start
+    yaml = YAMLLoader.new.load
+    menu = menu_builder(yaml)
+    UserInterface.new(menu).start
   end
 end

data/locales/en.yml

@@ -2,6 +2,16 @@ en:
   Menu:
     Title: Language Cards by @6ftdan
     Choose: Select an option
+    ChooseLanguage: Select a language
+    ChooseCardSet: Select a card set
+    Set: set
+    Sets: sets
+    Cards: cards
+    Page: "Page %{page} of %{pages}"
+    NextPage: Next page
+    PreviousPage: Previous page
+    Back: Back
+    Quit: Quit
     GameMode: "GAME MODE: "
     ToggleGameMode: Change Mode
     ModeTranslate: Translate
@@ -9,6 +19,7 @@ en:
     Exit: Press CTRL-C to quit.
   Game:
     TypeThis: Type the following in
+    Exit: Press CTRL-C for the menu.
     Correct: Correct!
     Incorrect: Wrong!
     Its: it's

metadata

@@ -1,43 +1,54 @@
 --- !ruby/object:Gem::Specification
 name: language_cards
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Daniel P. Clark
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: slop
   requirement: !ruby/object:Gem::Requirement
@@ -52,34 +63,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.6'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +91,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.10'
-description: Flashcard game for language learning. Make your own cards or translations
-  as well.
+description: 'Flashcard game for language learning: Japanese (kana, JLPT N5-N1 kanji
+  and vocabulary), Chinese (HSK 1-4), Korean, Russian, Arabic, Hindi and many more.
+  Make your own cards or translations as well.'
 email:
 - 6ftdan@gmail.com
 executables:
@@ -104,8 +102,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".appveyor.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,24 +112,55 @@ files:
 - bin/console
 - bin/language_cards
 - bin/setup
-- cards/en/japanese-hiragana.yml
-- cards/en/japanese-kanji-jlpt-n5.yml
-- cards/en/japanese-katakana.yml
+- cards/en/arabic.yml
+- cards/en/armenian.yml
+- cards/en/bengali.yml
+- cards/en/chinese-hsk1.yml
+- cards/en/chinese-hsk2.yml
+- cards/en/chinese-hsk3.yml
+- cards/en/chinese-hsk4.yml
+- cards/en/georgian.yml
+- cards/en/greek.yml
+- cards/en/hebrew.yml
+- cards/en/hindi.yml
+- cards/en/japanese-01-hiragana.yml
+- cards/en/japanese-02-katakana.yml
+- cards/en/japanese-03-keyboard-mappings.yml
+- cards/en/japanese-10-kanji-jlpt-n5.yml
+- cards/en/japanese-11-kanji-jlpt-n4.yml
+- cards/en/japanese-12-kanji-jlpt-n3.yml
+- cards/en/japanese-13-kanji-jlpt-n2.yml
+- cards/en/japanese-14-kanji-jlpt-n1.yml
+- cards/en/japanese-20-vocabulary-jlpt-n5.yml
+- cards/en/japanese-21-vocabulary-jlpt-n4.yml
+- cards/en/japanese-22-vocabulary-jlpt-n3.yml
+- cards/en/japanese-23-vocabulary-jlpt-n2.yml
+- cards/en/japanese-24-vocabulary-jlpt-n1.yml
+- cards/en/korean.yml
+- cards/en/persian.yml
+- cards/en/punjabi.yml
+- cards/en/russian.yml
+- cards/en/tamil.yml
+- cards/en/thai.yml
+- cards/en/ukrainian.yml
+- cards/en/urdu.yml
 - language_cards.gemspec
 - lib/language_cards.rb
+- lib/language_cards/card_set_builder.rb
 - lib/language_cards/controllers/application_controller.rb
 - lib/language_cards/controllers/game.rb
 - lib/language_cards/controllers/main_menu.rb
-- lib/language_cards/grapheme_builder.rb
+- lib/language_cards/defaults.rb
 - lib/language_cards/helpers/game_helper.rb
 - lib/language_cards/helpers/view_helper.rb
-- lib/language_cards/language_cards.rb
+- lib/language_cards/menu_builder.rb
 - lib/language_cards/menu_node.rb
+- lib/language_cards/models/card.rb
 - lib/language_cards/models/card_set.rb
-- lib/language_cards/models/grapheme.rb
 - lib/language_cards/modes/game.rb
 - lib/language_cards/modes/translate.rb
 - lib/language_cards/modes/typing_practice.rb
+- lib/language_cards/paginator.rb
 - lib/language_cards/timer.rb
 - lib/language_cards/user_interface.rb
 - lib/language_cards/version.rb
@@ -142,7 +172,6 @@ homepage: http://github.com/danielpclark/language_cards
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -151,16 +180,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
-summary: Flashcard game for language learning.
+summary: Terminal flashcard game for learning languages with foreign scripts.
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4.0
-before_install: gem install bundler -v 1.13.7