learn-japanese 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c326b07ac2656bdfcaf385898b70c589d8fa7571bf6adbcb4b7b369130dd51d5
-  data.tar.gz: 1c19e75e31d96b4d3b9e11d349c8c24f0e2f0b71649193afe73f4cb02c192a04
+  metadata.gz: 164745bdc76d66bff134ec0e06fb5fceef44fb480f9c266c32beb6342dfe252b
+  data.tar.gz: 9bea86b40b59102cad35e1749fc379e6c14b2384b9f6f6f4b0abcd29409c446b
 SHA512:
-  metadata.gz: 7e06b77a12fabb4667ecba8a4c681b7e1e4e6c3616d8c7ecfebc63da7cb7e21c1da8a2fade41a35d95549e9951276eca99ef358fc1e39156856eb663cacd688e
-  data.tar.gz: e67a8f0828e1d1683d085e6ab6ebabf8af0882a2524d9f3e84442f06d10e0407b00e86d97dfbcdbe0c9e70b3a899749f735d35ae0ecc65dccbfa876b3082e32d
+  metadata.gz: a0b5cf252d1a7eefb8b3953a7285bb7a6ec99b1059c284f7f934ca7813307ba37f9297423a77498277750b1a6da17745bb1c200f7067607a45884c70edb9bb17
+  data.tar.gz: 37b4068955aa70702a166265a2e9482e9141da5404251f0888a1f2bce44337b9970f70edafd0adc5cf81d20574d2431533e795a9e158ca737d5f440645b7dec8

data/.ruby-version

@@ -0,0 +1 @@
+3.1.0

data/README.md

@@ -1,25 +1,32 @@
 
 [![Gem Version](https://badge.fury.io/rb/learn-japanese.svg)](https://badge.fury.io/rb/learn-japanese)
 
-# Aprender japonés
+# Learn Japanese
 
-`learn-japanese` es un programa Ruby de licencia libre para ayudar a aprender el japonés.
-De momento, sólo se está empezando a implementar la funcionalidad para aprender el Silabario Hiragana, pero poco a poco irá creciendo a medida que yo mismo aprenda más japonés.
+`learn-japanese` helps us to learn japanese.
 
-Para instalar el programa:
-1. Debes tener Ruby instalado en tu equipo.
-2. Abrir un terminal y ejecutar `sudo gem install learn-japanese`, para instalar la herramienta.
+> WARNING: just only Hiragana (groups 1-4) for now.
 
-## Modo de Uso
+Every few week will be grow with more functions... at the same time I'm learning too... I hope.
 
-Abrir un terminal
-* Ejecutar `short-answer-game`, para el juego de preguntas donde debemos escribir la respuesta.
-* Ejecutar `choose-answer-game`, para el juego de preguntas donde debemos elegir la respuesta correcta.
-* `sounds-to-hiragana`, pasar sonidos a Hiragana.
+## Installation
 
-> NOTA: Para aumentar la dificultad haremos `short-answer-game NUMBER`, donde NUMBER será un valor entre 1-4 por el momento.
+1. Install Ruby on your system.
+2. Open a terminal and run `sudo gem install learn-japanese`, to install the Ruby gem.
 
-# Silabario japonés
+## Usage
+
+* Open a terminal and run `learn-japanese`.
+
+## Functions or mini-games
+
+| Function name | Description |
+| ------------- | ---------------------------------------- |
+| short-answer  | Write the sound associated to the symbol |
+| choose-answer | Choose the symbol associated to the sound |
+| sound         | Write the sounds and get the word |
+
+# ANEXO
 
 ## Hiragana
 

data/bin/sounds-to-hiragana

@@ -3,4 +3,4 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'learn-japanese/game/sound-game'
 
-SoundGame.loop_hiragana_game
+SoundGame.run

data/lib/learn-japanese/cli.rb

@@ -21,4 +21,16 @@ class CLI < Thor
   def short_answer(level)
     LearnJapanese.short_answer(level.to_i)
   end
+
+  map ['so', '-so', '--sound', 'sound'] => 'sound'
+  desc 'sound', 'Write sounds and get the Hiragana'
+  def sound
+    LearnJapanese.sound
+  end
+
+  map ['ro', '-ro', '--romanji' ] => 'romaji'
+  desc 'romaji', 'Write Romaji for Hiragana word'
+  def romanji
+    LearnJapanese.romanji
+  end
 end

data/lib/learn-japanese/data/dictionary.rb

@@ -0,0 +1,11 @@
+
+require 'yaml'
+
+module Dictionary
+
+  def self.words
+    filename = File.join(File.dirname(__FILE__),  'words.yaml')
+    words = YAML.load(File.read(filename))
+  end
+
+end

data/lib/learn-japanese/{hiragana.rb → data/hiragana.rb}

@@ -1,5 +1,5 @@
 require 'colorize'
-require_relative 'debug'
+require_relative '../debug'
 
 # Silabario japonés
 class Hiragana
@@ -24,7 +24,7 @@ class Hiragana
 
   def self.group3
     { sa: "\u{3055}",
-      si: "\u{3057}",
+      shi: "\u{3057}",
       su: "\u{3059}",
       se: "\u{305B}",
       so: "\u{305D}"
@@ -33,8 +33,8 @@ class Hiragana
 
   def self.group4
     { ta: "\u{305F}",
-      ti: "\u{3061}",
-      tu: "\u{3064}",
+      chi: "\u{3061}",
+      tsu: "\u{3064}",
       te: "\u{3066}",
       to: "\u{3068}"
     }
@@ -48,6 +48,36 @@ class Hiragana
     output
   end
 
+  def self.groups(levels)
+    return self.all if levels == :all
+    hiragana = {}
+    hiragana.merge! Hiragana.group1 if levels.include? 1
+    hiragana.merge! Hiragana.group2 if levels.include? 2
+    hiragana.merge! Hiragana.group3 if levels.include? 3
+    hiragana.merge! Hiragana.group4 if levels.include? 4
+    hiragana
+  end
+
+  def self.sounds_to_hiragana(sounds)
+    hiraganas = Hiragana.all
+    hiragana_array = sounds.map { hiraganas[_1.to_sym] || '*' }
+    hiragana = hiragana_array.join('')
+  end
+
+  def self.hiraganas_to_sound(hiraganas_input)
+    all_hiraganas = Hiragana.all
+
+    sounds_array = hiraganas_input.map do |hiragana_input|
+      sound = '*'
+      all_hiraganas.each_pair do |key, value|
+        sound = key if value == hiragana_input
+      end
+      sound
+    end
+
+    sounds_array.join('')
+  end
+
   def self.show_help(level=1)
     Debug.puts_line
     puts "Hiragana help\n".upcase.cyan

data/lib/learn-japanese/data/words.yaml

@@ -1,19 +1,49 @@
 ---
-- sounds: e
-  hiragana: え
-  spanish: pintura
 - sounds: ái
   hiragana: あい
   spanish: amor
+- sounds: áka
+  hiragana: あか
+  spanish: rojo
 - sounds: áo
   hiragana: あお
   spanish: azul
+- sounds: e
+  hiragana: え
+  spanish: pintura
+- sounds: éki
+  hiragana: えき
+  spanish: estación de tren
 - sounds: ié
   hiragana: いえ
   spanish: casa
 - sounds: íi
   hiragana: いい
   spanish: bien
+- sounds: i-e
+  hiragana: いいえ
+  spanish: 'no'
 - sounds: ué
   hiragana: うえ
   spanish: arriba
+- sounds: ka
+  hiragana: か
+  spanish: mosquito
+- sounds: kaó
+  hiragana: かお
+  spanish: cara
+- sounds: ki
+  hiragana: き
+  spanish: árbol
+- sounds: kíkai
+  hiragana: きかい
+  spanish: máquina, oportunidad
+- sounds: áisatsu
+  hiragana: あいさつ
+  spanish: salud
+- sounds: áisatsu wo suru
+  hiragana: あいさつをする
+  spanish: saludar
+- sounds: ohayou
+  hiragana: おはよう
+  spanish: Buenos días (casual)

data/lib/learn-japanese/debug.rb

@@ -15,4 +15,9 @@ class Debug
   def self.puts_line
     STDOUT.puts ('=' * 20).white
   end
+
+  def self.break
+    require 'debug'
+    binding.break
+  end
 end

data/lib/learn-japanese/game/choose-answer-game.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require_relative '../debug'
-require_relative '../hiragana'
+require_relative '../data/hiragana'
 
 class ChooseAnswerGame
 

data/lib/learn-japanese/game/romanji-game.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+require_relative '../debug'
+require_relative '../data/dictionary'
+
+class RomanjiGame
+
+  def initialize(level=1, max=10)
+    @level = level
+    @score = 1
+    @max_score = max
+
+    @words = Dictionary.words
+  end
+
+  def run
+    Debug.puts_line
+    while @score < @max_score
+      @words.shuffle!
+      guess_romanji(@words.first)
+    end
+  end
+
+  private
+
+  def guess_romanji(data)
+    hiragana = data['hiragana']
+    spanish = data['spanish']
+    sounds = data['sounds']
+    progress = "[ #{@score}/#{@max_score} ]"
+
+    print  "#{progress.white} Write Romanji for #{hiragana.light_yellow}: "
+    resp = STDIN.gets.chomp
+    exit if resp.empty?
+
+    good = Hiragana.hiraganas_to_sound(hiragana.split(''))
+    if resp == good
+      @score += 1
+      puts ' '*10+"#{spanish} (#{sounds})".white
+      return true
+    end
+    puts "Right answer is #{good}".light_red
+    puts ' '*10+"#{spanish} (#{sounds})".red
+    false
+  end
+
+end

data/lib/learn-japanese/game/short-answer-game.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require_relative '../debug'
-require_relative '../hiragana'
+require_relative '../data/hiragana'
 
 class ShortAnswerGame
 

data/lib/learn-japanese/game/sound-game.rb

@@ -1,33 +1,39 @@
 
-require_relative '../hiragana'
-require_relative '../dictionary'
 require 'colorize'
+require_relative '../debug'
+require_relative '../data/dictionary'
+require_relative '../data/hiragana'
 
 module SoundGame
 
   def self.to_hiragana(sounds)
-    hiraganas = Hiragana.all
+    hiragana = Hiragana.sounds_to_hiragana(sounds)
 
-    hiragana_array = sounds.map { hiraganas[_1.to_sym] || '*' }
-    hiragana = hiragana_array.join('')
-
-    none = {'hiragana': hiragana, 'spanish': '?', 'sounds': '?'}
-    words = Dictionary.new.words
+    none = {'hiragana' => hiragana, 'spanish' => '?', 'sounds' => '?'}
+    words = Dictionary.words
     word = (words.select {_1["hiragana"] == hiragana})[0] || none
 
     word
   end
 
-  def self.loop_hiragana_game
-    sounds = "init"
-    until sounds.empty?
-      puts "[ Sounds to Hiragana ] Example: a i => あい （amor - ái）".white
-      print "  Write sounds ? ".light_yellow
-      sounds = gets.chomp.split
+  def self.run
+    Debug.puts_line
+    puts "SOUNDS TO HIRAGANA".light_cyan
+    puts "Example: a i => あい （amor - ái）".blue
+    Debug.puts_line
+
+    loop do
+      print "\nWrite sounds ? ".light_yellow
+      sounds = STDIN.gets.chomp.split
+      return if sounds.empty?
+
       word = self.to_hiragana(sounds)
-      puts "  Hiragana    => #{word["hiragana"]}".cyan
-      puts "  Spanish     => #{word["spanish"]}".cyan
-      puts "  Pronounce   => #{word["sounds"]}".cyan
+      print "Hiragana    => ".white
+      puts word["hiragana"]
+      print "Spanish     => ".white
+      puts word["spanish"]
+      print "Pronounce   => ".white
+      puts word["sounds"]
     end
   end
 

data/lib/learn-japanese/version.rb

@@ -1,6 +1,6 @@
 
 module LearnJapanese
-  VERSION  = '0.5.0'
+  VERSION  = '0.7.0'
   NAME     = 'learn-japanese'
   HOMEPAGE = 'https://github.com/dvarrui/learn-japanese'
 end

data/lib/learn-japanese.rb

@@ -2,6 +2,8 @@
 require_relative 'learn-japanese/version'
 require_relative 'learn-japanese/game/choose-answer-game'
 require_relative 'learn-japanese/game/short-answer-game'
+require_relative 'learn-japanese/game/sound-game'
+require_relative 'learn-japanese/game/romanji-game'
 
 module LearnJapanese
 
@@ -25,4 +27,12 @@ module LearnJapanese
     ShortAnswerGame.show_help(level)
     ShortAnswerGame.new(level).run
   end
+
+  def self.sound
+    SoundGame.run
+  end
+
+  def self.romanji
+    RomanjiGame.new.run
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn-japanese
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -49,6 +49,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -62,13 +63,14 @@ files:
 - learn-japanese.gemspec
 - lib/learn-japanese.rb
 - lib/learn-japanese/cli.rb
+- lib/learn-japanese/data/dictionary.rb
+- lib/learn-japanese/data/hiragana.rb
 - lib/learn-japanese/data/words.yaml
 - lib/learn-japanese/debug.rb
-- lib/learn-japanese/dictionary.rb
 - lib/learn-japanese/game/choose-answer-game.rb
+- lib/learn-japanese/game/romanji-game.rb
 - lib/learn-japanese/game/short-answer-game.rb
 - lib/learn-japanese/game/sound-game.rb
-- lib/learn-japanese/hiragana.rb
 - lib/learn-japanese/version.rb
 homepage: https://github.com/dvarrui/learn-japanese
 licenses:

data/lib/learn-japanese/dictionary.rb

@@ -1,12 +0,0 @@
-
-require 'yaml'
-
-class Dictionary
-  attr_reader :words
-
-  def initialize()
-    filename = File.join(File.dirname(__FILE__), 'data', 'words.yaml')
-    @words = YAML.load(File.read(filename))
-  end
-
-end