learn-japanese 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9551ba5848ab1baac33056aea1f97eaeba4057bf3de1c2cace4fe48b871e28d
-  data.tar.gz: 4101529e9a6874489cc7001d5eccf4b83691cabdd0db6c057ce32fc92373c805
+  metadata.gz: c5c1fca5b0ff073f6ce6a77acf3bab9907a7375e0f9478ee7ce4c7ee36a3d52d
+  data.tar.gz: c06390a9a5be368f29e42520c152b3fafc9844363d2969ad989aaa1c5dc402f2
 SHA512:
-  metadata.gz: 71d59ed075201be14f7f46d69e0d1ffe98d45f46c36b96cc62f56619198c00b8c35b22a398e414b60d789cc4ed475ddf3099ade875050f185e08bb324a99b917
-  data.tar.gz: c81f8b3190ed01932c2f9483d87ebecdf9026df68c8b770631c735e89033ad6d2e89e3e30aa42b1144658beb30e1ef15ad071167592e2ad09c82e430131e80fa
+  metadata.gz: 3a886b203ddb9a0471c8e57341b34341b0d52c48e6134b4d96a8d03e8be44b1d226ae541729bd55fbdb23e09a29793366202f5f2d5505555d8368bae33f2cb63
+  data.tar.gz: 8d16c2416b30f85c75afe9e320b18ef0f4ac872c1acf675ae580df79a0fd78d47af5cce3e79946e19e9f1dfa0f0631266f7a6740af25c2f0069467c667aadbec

data/README.md

@@ -5,9 +5,9 @@
 
 `learn-japanese` helps us to learn japanese.
 
-> WARNING: just only Hiragana (groups 1-4) for now.
-
-Every few week will be grow with more functions... at the same time I'm learning too... I hope.
+> WARNING: just only Hiragana (groups 1-6) for now.
+>
+> Every few week will be grow with more functions... at the same time I'm learning too... I hope.
 
 ## Installation
 
@@ -16,15 +16,18 @@ Every few week will be grow with more functions... at the same time I'm learning
 
 ## 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 |
+* Open a terminal and run `learn-japanese` command to show available functions.
+
+```
+❯ ./bin/learn-japanese             
+Commands:
+  learn-japanese choose-answer [--level=NUMBER]  # Values 1-6
+  learn-japanese help [COMMAND]                  # Describe available commands or one specific command
+  learn-japanese romaji                          # Write Romaji for Hiragana word
+  learn-japanese short-answer [--level=NUMBER]   # Values 1-6
+  learn-japanese sound                           # Write sounds and get the Hiragana
+  learn-japanese version                         # Show the program version
+```
 
 # ANEXO
 

data/lib/learn-japanese/cli.rb

@@ -11,26 +11,30 @@ class CLI < Thor
   end
 
   map ['ca', '-ca', '--choose-answer', 'choose-answer'] => 'choose_answer'
-  desc 'choose-answer [LEVEL]', 'LEVEL = 1-6'
-  def choose_answer(level)
-    LearnJapanese.choose_answer(level.to_i)
+  option :level
+  desc 'choose-answer [--level=NUMBER]', 'Values 1-6'
+  def choose_answer()
+    level = options[:level].to_i
+    LearnJapanese.choose_answer(level)
   end
 
   map ['sa', '-sa', '--short-answer', 'short-answer'] => 'short_answer'
-  desc 'short-answer [LEVEL]', 'LEVEL = 1-6'
-  def short_answer(level)
-    LearnJapanese.short_answer(level.to_i)
+  option :level
+  desc 'short-answer [--level=NUMBER]', 'Values 1-6'
+  def short_answer()
+    level = options[:level].to_i
+    LearnJapanese.short_answer(level)
   end
 
   map ['so', '-so', '--sound', 'sound'] => 'sound'
-  desc 'sound', 'Write sounds and get the Hiragana'
+  desc 'sound', 'Util: Write sounds and show Hiragana'
   def sound
     LearnJapanese.sound
   end
 
   map ['ro', '-ro', '--romanji' ] => 'romaji'
-  desc 'romaji', 'Write Romaji for Hiragana word'
-  def romanji
-    LearnJapanese.romanji
+  desc 'romaji', 'You have to Write Romaji for every Hiragana word'
+  def romaji
+    LearnJapanese.romaji
   end
 end

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

@@ -1,93 +1,48 @@
+require 'yaml'
 require 'colorize'
 require_relative '../debug'
 
-# Silabario japonés
 class Hiragana
+  # Silabario japonés
+  attr_reader :data
 
-  def self.group1
-    { a: "\u{3042}",
-      i: "\u{3044}",
-      u: "\u{3046}",
-      e: "\u{3048}",
-      o: "\u{304A}"
-    }
+  def initialize
+    filename = File.join(File.dirname(__FILE__), 'hiragana.yaml')
+    @data = YAML.load(File.read(filename))
   end
 
-  def self.group2
-    { ka: "\u{304B}",
-      ki: "\u{304D}",
-      ku: "\u{304F}",
-      ke: "\u{3051}",
-      ko: "\u{3053}"
-    }
+  def group(index)
+    @data[index - 1]
   end
 
-  def self.group3
-    { sa: "\u{3055}",
-      shi: "\u{3057}",
-      su: "\u{3059}",
-      se: "\u{305B}",
-      so: "\u{305D}"
-    }
-  end
-
-  def self.group4
-    { ta: "\u{305F}",
-      chi: "\u{3061}",
-      tsu: "\u{3064}", # つ
-      te: "\u{3066}",
-      to: "\u{3068}"
-    }
-  end
-
-  def self.group5
-    { na: "\u{306A}",
-      ni: "\u{306B}",
-      nu: "\u{306C}",
-      ne: "\u{306D}",
-      no: "\u{306E}"
-    }
-  end
-
-  def self.group6
-    { ha: "\u{306F}",
-      hi: "\u{3072}",
-      hu: "\u{3075}",
-      he: "\u{3078}",
-      ho: "\u{307B}"
-    }
-  end
-
-  def self.all
-    output = self.group1
-    output.merge!(self.group2)
-    output.merge!(self.group3)
-    output.merge!(self.group4)
-    output.merge!(self.group5)
-    output.merge!(self.group6)
+  def all_groups
+    output = {}
+    @data.each do |group|
+      output.merge!(group)
+    end
     output
   end
 
-  def self.groups(levels)
-    return self.all if levels == :all
+  def groups(levels)
+    return 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.merge! Hiragana.group4 if levels.include? 5
-    hiragana.merge! Hiragana.group4 if levels.include? 6
+    hiragana.merge! group 1 if levels.include? 1
+    hiragana.merge! group 2 if levels.include? 2
+    hiragana.merge! group 3 if levels.include? 3
+    hiragana.merge! group 4 if levels.include? 4
+    hiragana.merge! group 4 if levels.include? 5
+    hiragana.merge! group 5 if levels.include? 6
     hiragana
   end
 
-  def self.sounds_to_hiragana(sounds)
-    hiraganas = Hiragana.all
+  def sounds_to_hiragana(sounds)
+    hiraganas = all_groups
     hiragana_array = sounds.map { hiraganas[_1.to_sym] || '*' }
     hiragana = hiragana_array.join('')
   end
 
-  def self.hiraganas_to_sound(hiraganas_input)
-    all_hiraganas = Hiragana.all
+  def hiraganas_to_sound(hiraganas_input)
+    all_hiraganas = all_groups
 
     sounds_array = hiraganas_input.map do |hiragana_input|
       sound = '*'
@@ -100,16 +55,16 @@ class Hiragana
     sounds_array.join('')
   end
 
-  def self.show_help(level=1)
+  def show_help(level=1)
     Debug.puts_line
     puts "Hiragana help\n".upcase.cyan
 
-    Debug.puts_group Hiragana.group1
-    Debug.puts_group Hiragana.group2 if level > 1
-    Debug.puts_group Hiragana.group3 if level > 2
-    Debug.puts_group Hiragana.group4 if level > 3
-    Debug.puts_group Hiragana.group5 if level > 4
-    Debug.puts_group Hiragana.group6 if level > 5
-    Debug.puts_group Hiragana.group7 if level > 6
+    Debug.puts_group group(1)
+    Debug.puts_group group(2) if level > 1
+    Debug.puts_group group(3) if level > 2
+    Debug.puts_group group(4) if level > 3
+    Debug.puts_group group(5) if level > 4
+    Debug.puts_group group(6) if level > 5
+    Debug.puts_group group(7) if level > 6
   end
 end

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

@@ -0,0 +1,31 @@
+---
+- :a: あ #"\u{3042}"
+  :i: い #"\u{3044}"
+  :u: う #"\u{3046}"
+  :e: え #"\u{3048}"
+  :o: お #"\u{304A}"
+- :ka: か #"\u{304B}"
+  :ki: き #"\u{304D}"
+  :ku: く #"\u{304F}"
+  :ke: け #"\u{3051}"
+  :ko: こ #"\u{3053}"
+- :sa: さ #"\u{3055}"
+  :shi: し #"\u{3057}"
+  :su: す #"\u{3059}"
+  :se: せ #"\u{305B}"
+  :so: そ #"\u{305D}"
+- :ta: た #"\u{305F}"
+  :chi: ち #"\u{3061}"
+  :tsu: つ #"\u{3064}"
+  :te: て #"\u{3066}"
+  :to: と #"\u{3068}"
+- :na: な #"\u{306A}"
+  :ni: に #"\u{306B#}"
+  :nu: ぬ #"\u{306C}"
+  :ne: ね #"\u{306D}"
+  :no: の #"\u{306E}"
+- :ha: は #"\u{306F}"
+  :hi: ひ #"\u{3072}"
+  :hu: ふ #"\u{3075}"
+  :he: へ #"\u{3078}"
+  :ho: ほ #"\u{307B}"

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

@@ -6,6 +6,7 @@ require_relative '../data/hiragana'
 class ChooseAnswerGame
 
   def initialize(level=1, max=10)
+    @hiragana = Hiragana.new
     @level = level
     @score = 1
     @max_score = max
@@ -18,16 +19,13 @@ class ChooseAnswerGame
     #@silabario.merge! Hiragana.group5 if @level > 5
     #@silabario.merge! Hiragana.group6 if @level > 6
     levels = (1..@level).to_a
-    @silabario = Hiragana.groups(levels)
+    @silabario = @hiragana.groups(levels)
 
     @keys = @silabario.keys
   end
 
-  def self.show_help(level=1)
-    Hiragana.show_help(level)
-  end
-
   def run
+    @hiragana.show_help(@level)
     Debug.puts_line
     while @score < @max_score
       guess_japanise_symbol(@keys)

data/lib/learn-japanese/game/{romanji-game.rb → romaji-game.rb}

@@ -2,8 +2,9 @@
 
 require_relative '../debug'
 require_relative '../data/dictionary'
+require_relative '../data/hiragana'
 
-class RomanjiGame
+class RomajiGame
 
   def initialize(level=1, max=10)
     @level = level
@@ -17,13 +18,13 @@ class RomanjiGame
     Debug.puts_line
     while @score < @max_score
       @words.shuffle!
-      guess_romanji(@words.first)
+      guess_romaji(@words.first)
     end
   end
 
   private
 
-  def guess_romanji(data)
+  def guess_romaji(data)
     hiragana = data['hiragana']
     spanish = data['spanish']
     sounds = data['sounds']
@@ -33,14 +34,14 @@ class RomanjiGame
     resp = STDIN.gets.chomp
     exit if resp.empty?
 
-    good = Hiragana.hiraganas_to_sound(hiragana.split(''))
+    good = Hiragana.new.hiraganas_to_sound(hiragana.split(''))
     if resp == good
       @score += 1
-      puts ' '*10+"#{spanish} (#{sounds})".white
+      puts ' ' * 9 + "#{spanish} (#{sounds})".white
       return true
     end
     puts "Right answer is #{good}".light_red
-    puts ' '*10+"#{spanish} (#{sounds})".red
+    puts ' ' * 9 + "#{spanish} (#{sounds})".red
     false
   end
 

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

@@ -6,25 +6,23 @@ require_relative '../data/hiragana'
 class ShortAnswerGame
 
   def initialize(level=1, max=10)
+    @hiragana = Hiragana.new
+
     @level = level
     @score = 1
     @max_score = max
 
-    @silabario = Hiragana.group1
-    @silabario.merge! Hiragana.group2 if @level > 1
-    @silabario.merge! Hiragana.group3 if @level > 2
-    @silabario.merge! Hiragana.group4 if @level > 3
-    @silabario.merge! Hiragana.group5 if @level > 4
-    @silabario.merge! Hiragana.group6 if @level > 5
+    @silabario = @hiragana.groups( (1..level).to_a )
 
     @keys = @silabario.keys
   end
 
-  def self.show_help(level=1)
-    Hiragana.show_help(level)
+  def show_help(level=1)
+    @hiragana.show_help(level)
   end
 
   def run
+    @hiragana.show_help(@level)
     Debug.puts_line
     while @score < @max_score
       @keys.shuffle!

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

@@ -4,10 +4,14 @@ require_relative '../debug'
 require_relative '../data/dictionary'
 require_relative '../data/hiragana'
 
-module SoundGame
+class SoundGame
 
-  def self.to_hiragana(sounds)
-    hiragana = Hiragana.sounds_to_hiragana(sounds)
+  def initialize()
+    @hiragana = Hiragana.new
+  end
+
+  def to_hiragana(sounds)
+    hiragana = @hiragana.sounds_to_hiragana(sounds)
 
     none = {'hiragana' => hiragana, 'spanish' => '?', 'sounds' => '?'}
     words = Dictionary.words
@@ -16,7 +20,7 @@ module SoundGame
     word
   end
 
-  def self.run
+  def run
     Debug.puts_line
     puts "SOUNDS TO HIRAGANA".light_cyan
     puts "Example: a i => あい （amor - ái）".blue
@@ -27,7 +31,7 @@ module SoundGame
       sounds = STDIN.gets.chomp.split
       return if sounds.empty?
 
-      word = self.to_hiragana(sounds)
+      word = to_hiragana(sounds)
       print "Hiragana    => ".white
       puts word["hiragana"]
       print "Spanish     => ".white

data/lib/learn-japanese/version.rb

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

data/lib/learn-japanese.rb

@@ -3,7 +3,7 @@ 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'
+require_relative 'learn-japanese/game/romaji-game'
 
 module LearnJapanese
 
@@ -18,21 +18,20 @@ module LearnJapanese
 
   def self.choose_answer(level)
     show_help unless level > 0
-    ChooseAnswerGame.show_help(level)
     ChooseAnswerGame.new(level).run
   end
 
+  def self.romaji
+    RomajiGame.new.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
+    SoundGame.new.run
   end
 
-  def self.romanji
-    RomanjiGame.new.run
-  end
 end

data/tests/all.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative 'learn-japanese/data/hiragana_test'

data/tests/learn-japanese/data/hiragana_test.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'test/unit'
+require_relative '../../../lib/learn-japanese/data/hiragana'
+
+class HiraganaTest < Test::Unit::TestCase
+
+  def test_new
+    h = Hiragana.new
+
+    assert_equal 6, h.data.size
+  end
+
+  def test_every_group_has_6_symbols
+    data = Hiragana.new.data
+
+    data.each { |group| assert_equal 5, group.size }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn-japanese
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - David Vargas Ruiz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -41,10 +41,7 @@ dependencies:
 description:
 email: dvarrui@protonmail.com
 executables:
-- choose-answer-game
 - learn-japanese
-- short-answer-game
-- sounds-to-hiragana
 extensions: []
 extra_rdoc_files: []
 files:
@@ -54,10 +51,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/choose-answer-game
 - bin/learn-japanese
-- bin/short-answer-game
-- bin/sounds-to-hiragana
 - examples/01-emoji.rb
 - examples/02-emoji.rb
 - learn-japanese.gemspec
@@ -65,13 +59,16 @@ files:
 - lib/learn-japanese/cli.rb
 - lib/learn-japanese/data/dictionary.rb
 - lib/learn-japanese/data/hiragana.rb
+- lib/learn-japanese/data/hiragana.yaml
 - lib/learn-japanese/data/words.yaml
 - lib/learn-japanese/debug.rb
 - lib/learn-japanese/game/choose-answer-game.rb
-- lib/learn-japanese/game/romanji-game.rb
+- lib/learn-japanese/game/romaji-game.rb
 - lib/learn-japanese/game/short-answer-game.rb
 - lib/learn-japanese/game/sound-game.rb
 - lib/learn-japanese/version.rb
+- tests/all.rb
+- tests/learn-japanese/data/hiragana_test.rb
 homepage: https://github.com/dvarrui/learn-japanese
 licenses:
 - GPL-3

data/bin/choose-answer-game

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'learn-japanese/game/choose-answer-game'
-
-def get_level
-  level = ARGV.first.to_i
-
-  if level.zero?
-    name = File.basename(__FILE__)
-    puts "Usage: #{name} [LEVEL]  # LEVEL is [1,2,3,4]"
-    exit 0
-  end
-  level
-end
-
-level = get_level
-ChooseAnswerGame.show_help(level)
-ChooseAnswerGame.new(level).run

data/bin/short-answer-game

@@ -1,19 +0,0 @@
-#!/usr/bin/env ruby
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-require 'learn-japanese/game/short-answer-game'
-
-def get_level
-  level = ARGV.first.to_i
-
-  if level.zero?
-    name = File.basename(__FILE__)
-    puts "Usage: #{name} [LEVEL]  # LEVEL is [1,2,3,4]"
-    exit 0
-  end
-  level
-end
-
-level = get_level
-ShortAnswerGame.show_help(level)
-ShortAnswerGame.new(level).run

data/bin/sounds-to-hiragana

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