learn-japanese 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb7cea3414af1cbe9ef81818791c40ec732a63a9edb891872cad1fc4517dd59
-  data.tar.gz: bd1478f589978af24a594c822eb6cbac1aa255169e51e4e38ff002ce87d9a7fd
+  metadata.gz: 5d63b5f7f7aafa4c249290ead834bad949693cb156bb25f537fba3c0665211ab
+  data.tar.gz: 758f37922314566ac2e95a944428bbd6180de32df90549fad521037548c72cdf
 SHA512:
-  metadata.gz: 503a7cd0dad0f19a95dad87f5c01375c394bbde5c4c1e13baad05a9f2932021cd52829f1497c7e3861706781e068008732dd537e10c8c484e1d81efb2d6b68be
-  data.tar.gz: b1773cf907e47823abec344e298bde05a0a8ed5251c7d22934382bbb1c6726780c48f2aaa005ab77ef4521329443282f4f501117ec4a54c9aa961f190a63286d
+  metadata.gz: 9cd09b6001f729cbf395e3bf10eadc7e3a8a69a80d3201c1ef41290d3df67b120071cff1435566f857cf2a5678a5df6a59fb53e1e14fb313582cb52f90d0b738
+  data.tar.gz: 6ad71c8b31c20cb5a7196968ef58bf6f32b3f7e719bf7ac3d33d0cb8e2e8f31126166ad80c16ddff7224c6b8fe4a183c2d99d7469b95ebaffb0f7466f9f6eb7d

data/.ruby-version

@@ -0,0 +1 @@
+2.7.5

data/README.md

@@ -1,24 +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.
+## 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/learn-japanese

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'learn-japanese/cli'
+
+CLI.start(ARGV)

data/bin/sounds-to-hiragana

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'learn-japanese/game/sound-game'
+
+SoundGame.run

data/learn-japanese.gemspec

@@ -5,14 +5,15 @@ $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 name = "learn-japanese"
 require "#{name}/version"
 
-Gem::Specification.new name, JaponesTool::VERSION do |s|
-  s.summary     = "Learn Japanese (UNDER DEVELOPMENT!!!)"
+Gem::Specification.new name, LearnJapanese::VERSION do |s|
+  s.summary     = "Learn Japanese (UNDER DEVELOPMENT)"
   s.email       = "dvarrui@protonmail.com"
-  s.homepage    = JaponesTool::HOMEPAGE
+  s.homepage    = LearnJapanese::HOMEPAGE
   s.authors     = ["David Vargas Ruiz"]
   s.files       = `git ls-files`.split("\n")
   s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.license     = "GPL-3"
 
   s.add_runtime_dependency "colorize"
+  s.add_runtime_dependency "thor"
 end

data/lib/learn-japanese/cli.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require_relative '../learn-japanese'
+
+class CLI < Thor
+  map ['h', '-h', '--help'] => 'help'
+
+  map ['v', '-v', '--version'] => 'version'
+  desc 'version', 'Show the program version'
+  def version
+    LearnJapanese.show_version
+  end
+
+  map ['ca', '-ca', '--choose-answer', 'choose-answer'] => 'choose_answer'
+  desc 'choose-answer [LEVEL]', 'LEVEL = 1-4'
+  def choose_answer(level)
+    LearnJapanese.choose_answer(level.to_i)
+  end
+
+  map ['sa', '-sa', '--short-answer', 'short-answer'] => 'short_answer'
+  desc 'short-answer [LEVEL]', 'LEVEL = 1-4'
+  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
+end

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

@@ -1,19 +1,46 @@
 ---
-- 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

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

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

data/lib/learn-japanese/version.rb

@@ -1,5 +1,6 @@
 
-module JaponesTool
-  VERSION  = '0.4.0'
+module LearnJapanese
+  VERSION  = '0.6.0'
+  NAME     = 'learn-japanese'
   HOMEPAGE = 'https://github.com/dvarrui/learn-japanese'
 end

data/lib/learn-japanese.rb

@@ -0,0 +1,33 @@
+
+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'
+
+module LearnJapanese
+
+  def self.show_version
+    puts "#{LearnJapanese::NAME} (version #{LearnJapanese::VERSION})"
+  end
+
+  def self.show_help
+    puts "Usage: learn-japanese --help"
+    exit 0
+  end
+
+  def self.choose_answer(level)
+    show_help unless level > 0
+    ChooseAnswerGame.show_help(level)
+    ChooseAnswerGame.new(level).run
+  end
+
+  def self.short_answer(level)
+    show_help unless level > 0
+    ShortAnswerGame.show_help(level)
+    ShortAnswerGame.new(level).run
+  end
+
+  def self.sound
+    SoundGame.run
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn-japanese
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -24,31 +24,51 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: dvarrui@protonmail.com
 executables:
 - choose-answer-game
+- learn-japanese
 - short-answer-game
-- sounds-to-hiragana.rb
+- sounds-to-hiragana
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/choose-answer-game
+- bin/learn-japanese
 - bin/short-answer-game
-- bin/sounds-to-hiragana.rb
+- bin/sounds-to-hiragana
 - examples/01-emoji.rb
 - examples/02-emoji.rb
 - learn-japanese.gemspec
+- lib/learn-japanese.rb
+- lib/learn-japanese/cli.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/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
@@ -70,8 +90,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
-summary: Learn Japanese (UNDER DEVELOPMENT!!!)
+summary: Learn Japanese (UNDER DEVELOPMENT)
 test_files: []

data/bin/sounds-to-hiragana.rb

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'learn-japanese/hiragana'
-require 'learn-japanese/dictionary'
-require 'colorize'
-
-puts "[ Sounds to Hiragana ] Example: a i => あい （amor - ái）".white
-
-def sound_to_hiragana
-  print "  Write sounds ? ".light_yellow
-  sounds = gets.chomp.split
-  hiraganas = Hiragana.all
-
-  hiragana_array = sounds.map { hiraganas[_1.to_sym] || '*' }
-  hiragana = hiragana_array.join('')
-
-  words = Dictionary.new.words
-  word = (words.select { _1["hiragana"] == hiragana})[0] || {'spanish': '?', 'sounds': '?'}
-
-  puts "  Hiragana    => #{hiragana}".cyan
-  puts "  Spanish     => #{word["spanish"]}".cyan
-  puts "  Pronounce   => #{word["sounds"]}".cyan
-
-  return false if sounds.size.zero?
-  true
-end
-
-while sound_to_hiragana
-end