language_cards 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70409b30502a716a2fb4ab829f6011b9f9a0cc2fbc56ccb608e14ce3b8a54da7
-  data.tar.gz: c83ba36d7157de02a4cc67b65eef49a0743fa777c0a42939ccd8dc7d73ff1fe5
+  metadata.gz: 409fa54cd14dc132b49083d8e4a26cd768803b13aff44e822da5c23cd5898e9a
+  data.tar.gz: ba9fcbcf3df0a95c6b7984772c90a21560beefa4790058b277dbce27515b6924
 SHA512:
-  metadata.gz: affeaf6f6ecfffc3ff5cf5f3b6b63219961d636349cdc25abf31fd0e985dc1a34758b1739cbbc1541412eee67d541b9312c4cb1e349234fc10b4829485b25a56
-  data.tar.gz: 5328c5eebdec336a264f5303dadad4b29d99bed2c9e830ba158e72778f7d2637d1b8a2da77848d4271a2a55f993bd81d123cd5d0d9e7106c24eab0040c009146
+  metadata.gz: 83285da9cb6ac703432739dc0f20ed8155bc84e73891f171b8aab07d9744b41da30ba997b5e6a8266cba55186216e31a417718ea84d45dcf9b7a8e7793568d93
+  data.tar.gz: b310a242bb5e3299bedbc306829becbab0f82bb602a4884bde516ad52356b833670ac9542c8433347dcdc43c7845b8403b2729bf345cc162c403debfd616cae4

data/cards/en/japanese-kanji-jlpt-n5.yml

@@ -0,0 +1,107 @@
+--- # https://www.jlptstudy.net/N5/?kanji-list
+Japanese:
+  Kanji (JLPT Level N5):
+    mapping: { Kanji: [Hiragana, English] }
+    一: [ひと, ひとつ, one, only, even, 1]
+    七: [なな, seven, 7]
+    万: [よろず, ten thousand]
+    三: [さん, three, 3]
+    上: [うえ, above, up]
+    下: [した, below, down, descend, give, low, inferior]
+    中: [なか, in, inside, middle, mean, center]
+    九: [ここの, nine, 9]
+    二: [に, two, 2]
+    五: [ご, five, 5]
+    人: [ひと, people, person, man, human being, other people, mankind]
+    今: [いま, now]
+    休: [きゅう, rest, day off, retire, sleep]
+    会: [かい, gathering, meeting, meet, party, association, interview, join]
+    何: [なに, なん, what]
+    先: [さき, before, ahead, previous, future, precedence]
+    入: [いり, enter, insert]
+    八: [はち, eight, 8]
+    六: [ろく, six, 6]
+    円: [えん, circle, yen, round]
+    出: [で, exit, leave]
+    分: [ぶん, part, minute of time, segment, share, degree, one's lot, duty, understand, know, rate, 1%, chances, shaku/100]
+    前: [まえ, in front, before]
+    北: [きた, north]
+    十: [じゅう, ten, 10]
+    千: [せん, thousand, 1000]
+    午: [うま, noon, sign of the horse, 11AM-1PM, seventh sign of Chinese zodiac]
+    半: [はん, half, middle, odd number, semi-, part-]
+    南: [みなみ, south]
+    友: [とも, friend]
+    口: [くち, mouth]
+    古: [ふる, old]
+    右: [みぎ, right]
+    名: [な, name, noted, distinguished, reputation]
+    四: [よん, four, 4]
+    国: [くに, country, state, region, province, home, hometown, homeland, home country, land, earth]
+    土: [つち, soil, earth, ground, Turkey]
+    外: [そと, outside, outside of]
+    多: [さわ, many, frequent, much]
+    大: [おお, large, big]
+    天: [てん, heavens, sky, imperial]
+    女: [おんな, woman, female]
+    子: [こ, child, sign of the rat, 11PM-1AM, first sign of Chinese zodiac]
+    学: [がく, study, learning, science]
+    安: [あん, cheap, relax, low, quiet, rested, contented, peaceful]
+    小: [しょう, little, small]
+    少: [すくな, few, little]
+    山: [やま, mountain]
+    川: [かわ, stream, river]
+    左: [ひだり, left]
+    年: [とし, year, counter for years, age]
+    店: [みせ, store, shop]
+    後: [あと, behind, back, later]
+    手: [て, hand]
+    新: [しん, new]
+    日: [ひ, day, sun, Japan, counter for days, sunshine, sunlight, case, event]
+    時: [じ, time, hour]
+    書: [しょ, write]
+    月: [つき, month, moon]
+    木: [き, tree, wood]
+    本: [もと, book, present, main, 'true', real, counter for long cylindrical things]
+    来: [き, come, due, next, cause, become]
+    東: [ひがし, east]
+    校: [-こう, exam, school, printing, proof, correction]
+    母: [はは, mama, mother]
+    毎: [まい, every]
+    気: [いき, spirit, mind, air, atmosphere, mood]
+    水: [みず, water]
+    火: [ひ, fire]
+    父: [ちち, father]
+    生: [なま, life, genuine, birth]
+    男: [おとこ, male]
+    白: [しろ, white]
+    百: [もも, hundred, 100]
+    目: [め, eye, class, look, insight, experience, care, favor]
+    社: [やしろ, company, firm, office, association, shrine]
+    空: [そら, empty, sky, void, vacant, vacuum]
+    立: [たて, stand up]
+    耳: [みみ, ear]
+    聞: [きき, hear, ask, listen]
+    花: [はな, flower]
+    行: [こう, going, journey]
+    西: [にし, west, Spain]
+    見: [み, see, hopes, chances, idea, opinion, look at, visible]
+    言: [げん, say]
+    話: [はなし, tale, talk]
+    語: [ご, word, speech, language]
+    読: [よみ, read]
+    買: [かい, buy]
+    足: [あし, leg, foot, be sufficient, counter for pairs of footwear]
+    車: [くるま, car]
+    週: [しゅう, week]
+    道: [みち, road-way, street, district, journey, course, moral, teachings]
+    金: [きん, gold]
+    長: [なが, long, leader]
+    間: [ま, interval, space]
+    雨: [あめ, rain]
+    電: [でん, electricity]
+    食: [しょく, eat, food]
+    飲: [いん, drink, smoke, take]
+    駅: [えき, station]
+    高: [こう, tall, high, expensive]
+    魚: [さかな, fish]

data/language_cards.gemspec

@@ -4,27 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'language_cards/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "language_cards"
+  spec.name          = 'language_cards'
   spec.version       = LanguageCards::VERSION
-  spec.authors       = ["Daniel P. Clark"]
-  spec.email         = ["6ftdan@gmail.com"]
+  spec.authors       = ['Daniel P. Clark']
+  spec.email         = ['6ftdan@gmail.com']
 
   spec.summary       = %q{Flashcard game for language learning.}
   spec.description   = %q{Flashcard game for language learning. Make your own cards or translations as well.}
-  spec.homepage      = "http://github.com/danielpclark/language_cards"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/danielpclark/language_cards'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
   spec.executables   = ['language_cards']
-  spec.require_paths = ["lib","cards"]
+  spec.require_paths = ['lib','cards']
 
-  spec.add_dependency "highline", "~> 1.7"
-  spec.add_dependency "i18n", "~> 0.7"
-  spec.add_dependency "elixirize", "~> 0.3"
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "minitest", "~> 5.10"
+  spec.add_dependency 'highline', '~> 1.7'
+  spec.add_dependency 'i18n', '~> 0.7'
+  spec.add_dependency 'slop', '~> 4.6'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'minitest', '~> 5.10'
 end

data/lib/language_cards.rb

@@ -2,17 +2,22 @@ require 'language_cards/version'
 require 'language_cards/language_cards'
 require 'yaml'
 require 'i18n'
+require 'slop'
 require 'highline'
-require 'elixirize'
 
 ##
 # TODO:
 #  * Implement score-keeper
 #  * Race against the clock
 #  * Weighted random for better learning
-#  * Value to Value is simply keyboard practice and should be clocked
 
 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

data/lib/language_cards/controllers/application_controller.rb

@@ -0,0 +1,27 @@
+module LanguageCards
+  module Controllers
+    class ApplicationController
+      include Helpers::ViewHelper
+
+      def initialize(opts = {})
+        @opts = opts
+      end
+
+      def render(_binding)
+        view = ERB.new IO.read File.expand_path("../view/#{snake name}.erb", __dir__)
+
+        view.result(_binding)
+      end
+
+      private
+      attr_reader :opts
+      def name
+        self.class.name.split('::').last
+      end
+
+      def errors
+        Array(opts[:errors])
+      end
+    end
+  end
+end

data/lib/language_cards/controllers/game.rb

@@ -1,72 +1,68 @@
+require 'language_cards/controllers/application_controller'
+
 module LanguageCards
   module Controllers
-    module Game
-      class << self
-        include Helpers::ViewHelper
-        include Helpers::GameHelper
+    class Game < ApplicationController
+      include Helpers::GameHelper
 
-        def render(correct:, incorrect:, title:, timer:, last:)
-          _score = t('Game.ScoreMenu.Score') + ": %0.2d%%" % calc_score(correct, incorrect)
-          _timer = [((t('Timer.Timer') + ": " + timer.ha) if timer.time?), nil, timer.h]
-          _mexit = t 'Menu.Exit'
+      def render(correct:, incorrect:, title:, timer:, last:)
+        _score = t('Game.ScoreMenu.Score') + ": %0.2d%%" % calc_score(correct, incorrect)
+        _timer = [((t('Timer.Timer') + ": " + timer.ha) if timer.time?), nil, timer.h]
+        _mexit = t 'Menu.Exit'
 
-          view = File.expand_path('../view/game.erb', __dir__).
-            ᐅ( IO.method :read ).
-            ᐅ ERB.method :new
-          view.result(binding)
-        end
+        super(binding)
+      end
 
-        def process(cards, mode)
-          ic = struct_data.new(cards, mode)
-          ic.get_input
-          {
-            correct: ic.valid?,
-            last: ic.valid? ? ic.correct_msg : ic.incorrect_msg
-          }
-        end
+      def process(cards, mode)
+        ic = struct_data.new(cards, mode)
+        ic.get_input
+        {
+          correct: ic.valid?,
+          last: ic.valid? ? ic.correct_msg : ic.incorrect_msg
+        }
+      end
 
-        def struct_data
-          Struct.new(:card_set, :mode) do
-            def input
-              @input 
-            end
+      def struct_data
+        Struct.new(:card_set, :mode) do
+          def input
+            @input 
+          end
 
-            def get_input
-              @input ||= CLI.ask("#{I18n.t('Game.TypeThis')}: #{display}")
-            end
+          def get_input
+            @input ||= CLI.ask("#{I18n.t('Game.TypeThis')}: #{display}")
+          end
 
-            def card
-              @card ||= card_set.sample.current
-            end
+          def card
+            @card ||= card_set.sample.current
+          end
 
-            def display
-              "#{card}"
-            end
+          def display
+            "#{card}"
+          end
 
-            def expected
-              case mode
-              when :translate
-                card.translation
-              when :typing_practice
-                 "#{card}" 
-              else
-                raise "Invalid mode in Game Controller!"
-              end
+          def expected
+            case mode
+            when :translate
+              card.translation
+            when :typing_practice
+               "#{card}" 
+            else
+              raise "Invalid mode in Game Controller!"
             end
+          end
 
-            def correct_msg
-              "#{I18n.t('Game.Correct')} #{input} = #{display}"
-            end
+          def correct_msg
+            "#{I18n.t('Game.Correct')} #{input} = #{display}"
+          end
 
-            def incorrect_msg
-              output = "#{I18n.t('Game.Incorrect')} #{input} != #{display}"
-              output << " #{I18n.t('Game.Its')} #{expected.join(', ')}" if mode == :translate
-              output
-            end
+          def incorrect_msg
+            output = "#{I18n.t('Game.Incorrect')} #{input} != #{display}"
+            output << " #{I18n.t('Game.Its')} #{expected.join(', ')}" if mode == :translate
+            output
+          end
 
-            def valid?
-              card_set.match? input
-            end
+          def valid?
+            card_set.match? input
           end
         end
       end

data/lib/language_cards/controllers/main_menu.rb

@@ -1,25 +1,20 @@
+require 'language_cards/controllers/application_controller'
+
 module LanguageCards
   module Controllers
-    module MainMenu
-      class << self
-        include Helpers::ViewHelper
-
-        def render(courses:, mode:)
-          _title = t 'Menu.Title'
-          _select = t 'Menu.Choose'
-          _mode = t('Menu.GameMode') + case mode.peek
-                  when :translate then t 'Menu.ModeTranslate'
-                  when :typing_practice then t 'Menu.ModeTyping'
-                  end
-          _toggle = "m: " + t('Menu.ToggleGameMode')
-          _courses = courses.each.with_index.map {|item,index| "#{index + 1}: #{item}" }
-          _mexit = t 'Menu.Exit'
+    class MainMenu < ApplicationController
+      def render(courses:, mode:)
+        _title = t 'Menu.Title'
+        _select = t 'Menu.Choose'
+        _mode = t('Menu.GameMode') + case mode.peek
+                when :translate then t 'Menu.ModeTranslate'
+                when :typing_practice then t 'Menu.ModeTyping'
+                end
+        _toggle = "m: " + t('Menu.ToggleGameMode')
+        _courses = courses.each.with_index.map {|item,index| "#{index + 1}: #{item}" }
+        _mexit = t 'Menu.Exit'
 
-          view = File.expand_path('../view/main_menu.erb', __dir__).
-            ᐅ( IO.method :read ).
-            ᐅ ERB.method :new
-          view.result(binding)
-        end
+        super(binding)
       end
     end
   end

data/lib/language_cards/helpers/view_helper.rb

@@ -23,6 +23,14 @@ module LanguageCards
       def humanize string
         "#{string}".split('_').map(&:capitalize).join(' ')
       end
+
+      def snake string
+        "#{string}".gsub(/(.)([A-Z])/, '\1_\2').downcase
+      end
+
+      def wordwrap words
+        "#{words}".gsub(/(.{1,#{SUBMENUWIDTH - 7}})(\s+|\Z)/, "\\1\n\t").strip
+      end
     end
   end
 end

data/lib/language_cards/language_cards.rb

@@ -1,55 +1,25 @@
 require 'language_cards/menu_node'
-require_relative 'user_interface'
+require 'language_cards/yaml_loader'
+require 'language_cards/user_interface'
 
 module LanguageCards
   class LanguageCards
     def initialize
-      @CARDS = {}
-
-      # TODO: Extract out YAML file loading behavior to methods via SRP.
-      File.join('..','..').
-        ᐅ(File.method(:expand_path), __dir__  ).
-        ᐅ(File.method(:join), 'cards', '*.yml').
-        ᐅ(Dir.method :[]                      ).
-        +(
-          if ENV['HOME']
-            File.expand_path(ENV['HOME']).
-              ᐅ(File.method(:join), '.language_cards', 'cards', '*.yml').
-              ᐅ Dir.method :[]
-          else
-            []
-          end
-        ).
-          each do |c|
-          next unless yaml_data = c.ᐅ(File.method :open).ᐅ(~:read).ᐅ(YAML.method :load)
-          for language in yaml_data.keys do
-            # Merges sub-items for languages
-            if @CARDS.has_key? language
-              @CARDS[language] = \
-                yaml_data[language].
-                ᐅ(method :Hash).
-                ᐅ @CARDS[language].
-                  ᐅ(method :Hash).
-                  method(:merge)
-            else
-              # Merges top scope languages
-              { language => yaml_data[language] }.
-                ᐅ @CARDS.method :merge!
-            end
-          end
+      self.cards = builder(YAMLLoader.new.load)
+    end
 
-        end
+    def start
+      UserInterface.new(cards).start
+    end
 
-      # Builder
-      @CARDS = @CARDS.each_with_object([]) do |(language, values), memo|
+    private
+    attr_accessor :cards
+    def builder(cards_yaml)
+      cards_yaml.each_with_object([]) do |(language, values), memo|
         values.each do |category_with_card_set|
           memo << MenuNode.new(language, category_with_card_set)
         end
       end
     end
-
-    def start
-      @CARDS.ᐅ(UserInterface.method :new).ᐅ ~:start
-    end
   end
 end

data/lib/language_cards/user_interface.rb

@@ -11,7 +11,7 @@ module LanguageCards
     include Controllers
     def initialize cards
       @cards = cards
-      @courses = cards.flat_map {|i| i.label.join(' - ') }
+      @courses = process_courses(cards)
       @mode = [:translate, :typing_practice].cycle
     end
 
@@ -26,7 +26,7 @@ module LanguageCards
         loop do
           clear
 
-          CLI.say MainMenu.render courses: courses, mode: mode
+          CLI.say MainMenu.new(opts).render courses: courses, mode: mode
 
           value = CLI.ask("")
 
@@ -40,17 +40,18 @@ module LanguageCards
             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,
+                CLI.say game.render correct: correct,
                                     incorrect: incorrect,
                                     title: title,
                                     timer: timer,
                                     last: last
-                result = Game.process(collection, collection.mode)
+                result = game.process(collection, collection.mode)
                 result[:correct] ? correct! : incorrect!
                 last = result[:last]
               end
@@ -65,6 +66,10 @@ module LanguageCards
 
     private
     attr_reader :mode, :cards, :correct, :incorrect, :courses
+    def opts
+      @opts ||= {}
+    end
+
     def correct!
       @correct = @correct.to_i + 1
     end
@@ -72,6 +77,16 @@ module LanguageCards
     def incorrect!
       @incorrect = @incorrect.to_i + 1
     end
+
+    def process_courses(cards)
+      courses = cards.flat_map {|i| i.label.join(' - ') }
+
+      if courses.empty?
+        opts[:errors] = ["No Flash Cards found for language: #{CARD_LANGUAGE}"]
+      end
+
+      courses
+    end
   end
 end
 

data/lib/language_cards/version.rb

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

data/lib/language_cards/view/game.erb

@@ -5,5 +5,5 @@
 <%= divider %>
 <%= draw (if correct || incorrect then _score end), nil, _mexit %>
 
-<%= last %>
+<%= wordwrap last %>
 <%= divider %>

data/lib/language_cards/view/main_menu.erb

@@ -2,7 +2,7 @@
 <%= draw(_title, nil, 'v' + VERSION) %>
 <%= divider %>
 <%= draw(_select, nil, _mode) %>
-<% _courses.each do |course| %>
+<% (_courses.empty? ? errors : _courses).each do |course| %>
   <%= course.chomp %><% end %>
 
 <%= draw(_mexit, nil, _toggle) %>

data/lib/language_cards/yaml_loader.rb

@@ -0,0 +1,49 @@
+module LanguageCards
+  class YAMLLoader
+    def initialize
+      @language = CARD_LANGUAGE
+    end
+
+    def load
+      cards = {}
+
+      cards_yaml.each do |c|
+        next unless yaml_data = YAML.load(File.open(c).read)
+        for language in yaml_data.keys do
+          # Merges sub-items for languages
+          if cards.has_key? language
+            cards[language] = Hash( cards[language] ).merge( Hash(yaml_data[language]) )
+          else
+            # Merges in new top scope languages
+            cards.merge!({ language => yaml_data[language] })
+          end
+        end
+      end
+
+      cards
+    end
+
+    private
+    attr_reader :language
+
+    def application_path
+      File.expand_path(File.join('..','..'), __dir__)
+    end
+
+    def cards_yaml
+      application_path_cards_yaml + home_path_cards_yaml
+    end
+
+    def application_path_cards_yaml
+      Dir[File.join(application_path, 'cards', language, '*.yml')]
+    end
+
+    def home_path_cards_yaml
+      if ENV['HOME']
+        Dir[File.join(ENV['HOME'], '.language_cards', 'cards', language, '*.yml')]
+      else
+        []
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: language_cards
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: elixirize
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '4.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -113,10 +113,12 @@ files:
 - bin/console
 - bin/language_cards
 - bin/setup
-- cards/japanese-hiragana.yml
-- cards/japanese-katakana.yml
+- cards/en/japanese-hiragana.yml
+- cards/en/japanese-kanji-jlpt-n5.yml
+- cards/en/japanese-katakana.yml
 - language_cards.gemspec
 - lib/language_cards.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
@@ -134,6 +136,7 @@ files:
 - lib/language_cards/version.rb
 - lib/language_cards/view/game.erb
 - lib/language_cards/view/main_menu.erb
+- lib/language_cards/yaml_loader.rb
 - locales/en.yml
 homepage: http://github.com/danielpclark/language_cards
 licenses: