kita 0.5.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06aaa540d2009b44eaf3c78f98c2614781e0d51bfc95d1a5e290b7906f38a43c
-  data.tar.gz: 291ed4302f1f50f8672db9c34767cc3ad82bf90e2eca65c1fc6c3214ee03c5f9
+  metadata.gz: 9711a0da8f810049a096344ec961730fd5dd80f65c5cf651c5af7921c3a13fd3
+  data.tar.gz: d3edfe79eedc16dc3fb35d5758c9476d3a71e5e102c68e6ed09be906d4ee3587
 SHA512:
-  metadata.gz: 4e902f3ffb940bf08ea38f31d94773d77969853012f8bd67a3090b99b462bacdf6bc1d0fc952ca5d50986a9509abbd1f9c1167f63a0b8773da21f3ee012134a3
-  data.tar.gz: 5e6ad8fa67b82c58c5256525087ae9b03fde7b41becfc76c0ab4f3b429a4ed6e0e57dde4462104b4a05741d17924eece64a532902e230da73eb821a6a41efb9b
+  metadata.gz: b342a9ba97d484c52b2ab8500f21560be2be295868784d5e5dc015f37af2a9f466e3a2966ddae4c69572bb035fc7b0575918f22701a0b687412ba0463e23ba1e
+  data.tar.gz: d1024783d109e846e817d7c8a55ab0812062fd0f6c2171d83a0e2b4931d6a3867e0ad9617aaf2021053443a5465f799d903e5af7e708c9f61e46af5f688c6ac2

data/.gitignore

@@ -8,6 +8,7 @@ vendor
 /coverage/
 /doc/
 /pkg/
+/prime/
 /spec/reports/
 /tmp/
 

data/CHANGELOG.md

@@ -9,6 +9,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+## 2020-06-02
+### Added
+- Kita randomly selects between two different recordings for each kana
+
+## 2020-05-27
+### Changed
+- Selecting an incorrect answer for a Katakana question, shows the correct Katakana, rather than
+just repeating the Hiragana
+
+## 2020-05-25
+### Changed
+- Improved sounds, neither へ nor は are pronounced in their particle form (e and wa).
+
 ## 2020-05-24
 ### Added
 - First release

data/Gemfile.lock

@@ -1,7 +1,11 @@
 PATH
   remote: .
   specs:
-    kita (0.5.3)
+<<<<<<< Updated upstream
+    kita (0.6.0)
+=======
+    kita (0.6.1)
+>>>>>>> Stashed changes
       config (~> 2.2)
       gir_ffi (~> 0.15.2)
       gstreamer (~> 3.4)

data/README.md

@@ -1 +1,3 @@
-# Kita
+# <img width="60" height="60" alt="Kita Logo" src="https://raw.githubusercontent.com/danbishop/kita/master/ui/kita-bordered.svg?sanitize=true"> Kita
+
+A small GTK app to help learn the Japanese kana systems.

data/kita.gemspec

@@ -7,12 +7,16 @@ Gem::Specification.new do |spec|
   spec.version       = Kita::VERSION
   spec.authors       = ['Dan Bishop']
   spec.email         = ['d@nbishop.uk']
-  spec.license       = 'GPLv3+'
+  spec.license       = 'GPL-3.0+'
 
   spec.summary       = 'A Japanese kana learning tool.'
-  spec.description   = 'A simple tool to help Japanese language learners with hiragana and katakana.'
+  spec.description   = <<-DESC
+    A simple GTK3 app to help Japanese language learners with Hiragana and Katakana. It introduces
+    users to the sounds of the kana and teaches basic recognition of both writing systems.
+  DESC
+
   spec.homepage      = 'https://www.danbishop.org'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/danbishop/kita'

data/lib/kita.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
+
 require 'gtk3'
 require_relative 'kita/audio'
 require_relative 'kita/config'
-require_relative 'kita/hiragana'
-require_relative 'kita/katakana'
+require_relative 'kita/question'
 require_relative 'kita/version'
 
 module Kita
@@ -11,99 +11,55 @@ module Kita
   class Application < Gtk::Application
     def initialize
       super 'uk.danbishop.kita', :handles_open
-      builder_file = "#{File.expand_path(File.dirname(__dir__))}/ui/builder.ui"
       # Construct a Gtk::Builder instance and load our UI description
-      @builder = Gtk::Builder.new(file: builder_file)
-      # Initiate Hiragana class
-      @hiragana = Hiragana.new
-      # Initiate Katakana class
-      @katakana = Katakana.new
-      @types = [@hiragana]
+      @builder = Gtk::Builder.new(file: "#{File.expand_path(File.dirname(__dir__))}/ui/builder.ui")
+      @builder.connect_signals { |handler| method(handler) }
+      # Initiate Question class
+      @question = Question.new
       @button_signals = {}
       @sound = Audio.new
       new_question
-      menu_setup
-      setup_new_question_button
-      setup_repeat_button
-      build_main_window
-    end
-
-    def menu_setup
-      setup_hiragana_switch
-      setup_katakana_switch
-      setup_sound_switch
       setup_about_box
+      build_main_window
     end
 
     def setup_about_box
-      about_box = @builder.get_object('about_box')
+      @ee = 0
+      about_box = @builder['about_box']
       about_box.version = VERSION
-      about_button = @builder.get_object('menu_about')
-      about_button.signal_connect('clicked') do
+      @builder['menu_about'].signal_connect('clicked') do
         about_box.run
         about_box.hide
       end
     end
 
-    def setup_new_question_button
-      new_question_button = @builder.get_object('new_question')
-      new_question_button.signal_connect('clicked') do
-        new_question
-      end
-    end
-
-    def setup_repeat_button
-      new_question_button = @builder.get_object('speak')
-      new_question_button.signal_connect('clicked') do
-        @sound.repeat
-      end
-    end
-
-    def setup_hiragana_switch
-      @hiragana_switch = @builder.get_object('hiragana_switch')
-      @hiragana_switch.signal_connect('notify::active') do
-        toggle_hiragana
-      end
-    end
-
-    def setup_katakana_switch
-      @katakana_switch = @builder.get_object('katakana_switch')
-      @katakana_switch.signal_connect('notify::active') do
-        toggle_katakana
-      end
-    end
-
-    def setup_sound_switch
-      @sound_switch = @builder.get_object('sound_switch')
-      @sound_switch.signal_connect('notify::active') do
-        toggle_sound
-      end
+    def repeat_button_click
+      @sound.repeat
     end
 
     def toggle_katakana
-      # TODO: Switch this to using Settings
-      @types = []
-      @types << @hiragana if @hiragana_switch.active?
-      @types << @katakana if @katakana_switch.active?
-      (@hiragana_switch.set_active(true) && @types = [@hiragana]) if @types.empty?
+      Settings.katakana = !Settings.katakana
+      (@builder['hiragana_switch'].set_active(true) && Settings.hiragana = true) if !Settings.katakana && !Settings.hiragana
     end
 
     def toggle_hiragana
-      # TODO: Switch this to using Settings
-      @types = []
-      @types << @hiragana if @hiragana_switch.active?
-      @types << @katakana if @katakana_switch.active?
-      (@katakana_switch.set_active(true) && @types = [@katakana]) if @types.empty?
+      Settings.hiragana = !Settings.hiragana
+      (@builder['katakana_switch'].set_active(true) && Settings.katakana = true) if !Settings.katakana && !Settings.hiragana
     end
 
     def toggle_sound
       Settings.speak = !Settings.speak
     end
 
+    def ee
+      @ee += 1
+      @sound.play('これは北です') if @ee == 3
+    end
+
     def build_main_window
       signal_connect :activate do
         # Connect signal handlers to the constructed widgets
-        window = @builder.get_object('window')
+        window = @builder['window']
         window.signal_connect('destroy') { Gtk.main_quit }
         window.present
       end
@@ -111,20 +67,18 @@ module Kita
 
     def new_question
       reset_buttons
-      question = @types.sample.question
-      question_label = @builder.get_object('question')
-      question_label.set_markup("<span font='72'>#{question[:question]}</span>")
+      question = @question.new_question
+      @builder['question'].set_markup("<span font='72'>#{question[:question]}</span>")
       buttons = %w[a b c d]
       correct_button(buttons, question)
       wrong_buttons(buttons, question)
-      puts "Playing: #{question[:question].hiragana}"
-      @sound.play(question[:question].hiragana) if Settings.speak
+      @sound.play("#{question[:question].hiragana}#{[1, 2].sample}") if Settings.speak
     end
 
     def correct_button(buttons, question)
       # Choose random letter and remove it from array
       correct = buttons.delete(buttons.sample)
-      correct_button = @builder.get_object("answer_#{correct}")
+      correct_button = @builder["answer_#{correct}"]
       correct_button.set_label(question[:answer])
       correct_signal = correct_button.signal_connect('clicked') do
         new_question
@@ -144,14 +98,17 @@ module Kita
     def wrong_button_click(button)
       button.set_sensitive(false)
       label = button.child
-      label.set_markup("<span color='#d40000'>#{button.label} #{button.label.hiragana}</span>")
+      correction = @question.type == 'hiragana' ? button.label.hiragana : button.label.katakana
+      label.set_markup(
+        "<span color='#d40000'>#{button.label} #{correction}</span>"
+      )
     end
 
     def reset_buttons
       return nil if @button_signals.empty?
 
       @button_signals.each do |letter, signal|
-        button = @builder.get_object("answer_#{letter}")
+        button = @builder["answer_#{letter}"]
         button.signal_handler_disconnect(signal)
         button.set_sensitive(true)
       end

data/lib/kita/config.rb

@@ -1,8 +1,26 @@
 # frozen_string_literal: true
 
 require 'config'
+require 'fileutils'
 
-Config.load_and_set_settings(Config.setting_files('~/kita.yaml', 'kita'))
-Settings.speak = true
-Settings.hiragana = true
-Settings.katakana = false
+# Set config directory and create it if it doesn't exist
+CONF_DIR = "#{ENV['HOME']}/.config/kita"
+CONF_FILE = "#{CONF_DIR}/config.yaml"
+FileUtils.mkdir_p(CONF_DIR) unless File.exist?(CONF_DIR)
+
+def save_settings
+  puts 'Saved settings'
+  File.open(CONF_FILE, 'w') { |file| file.write(Settings.to_hash.to_yaml) }
+end
+
+if File.exist?(CONF_FILE)
+  puts 'Loaded settings'
+  Config.load_and_set_settings(CONF_FILE)
+else
+  puts 'No settings detected, first run? Using defaults.'
+  Config.load_and_set_settings(CONF_FILE)
+  Settings.speak = true
+  Settings.hiragana = true
+  Settings.katakana = false
+  save_settings
+end

data/lib/kita/hiragana.rb

@@ -48,6 +48,7 @@ class Hiragana
   def build_question(chars)
     {
       question: chars[0],
+      type: 'hiragana',
       answer: chars[0].romaji,
       choices: [
         chars[1].romaji,

data/lib/kita/katakana.rb

@@ -48,6 +48,7 @@ class Katakana
   def build_question(chars)
     {
       question: chars[0],
+      type: 'katakana',
       answer: chars[0].hiragana,
       choices: [
         chars[1].hiragana,

data/lib/kita/question.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'hiragana'
+require_relative 'katakana'
+
+# Question Class
+class Question
+  attr_accessor :type
+
+  def initialize
+    @hiragana = Hiragana.new
+    @katakana = Katakana.new
+  end
+
+  def new_question
+    question_types = []
+    question_types.push @hiragana if Settings.hiragana
+    question_types.push @katakana if Settings.katakana
+    question = question_types.sample.question
+    @type = question[:type]
+    question
+  end
+end

data/lib/kita/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kita
-  VERSION = '0.5.5'
+  VERSION = '0.6.1'
 end

data/snap/gui/kita.desktop

@@ -0,0 +1,10 @@
+[Desktop Entry]
+Name=Kita
+GenericName=Kita
+X-GNOME-FullName=Kita
+Comment=Learn the Japanese kana
+Keywords=Japanese;kana;hiragana;katakana;learn;
+Exec=kita
+Terminal=false
+Type=Application
+Icon=${SNAP}/meta/gui/kita.svg

data/snap/gui/kita.svg

@@ -0,0 +1,137 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="50mm"
+   height="50mm"
+   viewBox="0 0 50 50"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.5 (2060ec1f9f, 2020-04-08)"
+   sodipodi:docname="kita.svg">
+  <defs
+     id="defs2">
+    <filter
+       style="color-interpolation-filters:sRGB"
+       id="filter987"
+       inkscape:label="filter0" />
+    <filter
+       style="color-interpolation-filters:sRGB"
+       inkscape:label="Noise Fill"
+       id="filter1667">
+      <feTurbulence
+         type="fractalNoise"
+         baseFrequency="0.02 0.04"
+         numOctaves="5"
+         seed="1"
+         result="turbulence"
+         id="feTurbulence1651" />
+      <feComposite
+         in="SourceGraphic"
+         in2="turbulence"
+         operator="in"
+         result="composite1"
+         id="feComposite1653" />
+      <feColorMatrix
+         values="1 0 0 0 0 0 1 0 0 0 0 0 1 0 0 0 0 0 3 -1 "
+         result="color"
+         id="feColorMatrix1655" />
+      <feFlood
+         flood-opacity="1"
+         flood-color="rgb(21,40,57)"
+         result="flood"
+         id="feFlood1657" />
+      <feMerge
+         result="merge"
+         id="feMerge1663">
+        <feMergeNode
+           in="flood"
+           id="feMergeNode1659" />
+        <feMergeNode
+           in="color"
+           id="feMergeNode1661" />
+      </feMerge>
+      <feComposite
+         in2="SourceGraphic"
+         operator="in"
+         result="composite2"
+         id="feComposite1665" />
+    </filter>
+  </defs>
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#000000"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.7"
+     inkscape:cx="337.63766"
+     inkscape:cy="-256.1795"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     inkscape:window-width="3368"
+     inkscape:window-height="1376"
+     inkscape:window-x="72"
+     inkscape:window-y="27"
+     inkscape:window-maximized="1"
+     fit-margin-top="0"
+     fit-margin-left="0"
+     fit-margin-right="0"
+     fit-margin-bottom="0"
+     inkscape:pagecheckerboard="true" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-25.905403,-105.02035)">
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10.58333302px;line-height:1.25;font-family:Ubuntu;-inkscape-font-specification:Ubuntu;letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:0.26458332"
+       x="46.869045"
+       y="115.57143"
+       id="text817"><tspan
+         sodipodi:role="line"
+         id="tspan815"
+         x="46.869045"
+         y="125.4403"
+         style="stroke-width:0.26458332" /></text>
+    <circle
+       style="opacity:1;fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;paint-order:markers fill stroke"
+       id="path3017"
+       cx="50.905403"
+       cy="130.02036"
+       r="25" />
+    <text
+       xml:space="preserve"
+       style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:38.4786377px;line-height:1.25;font-family:Ubuntu;-inkscape-font-specification:Ubuntu;letter-spacing:0px;word-spacing:0px;fill:#d40000;fill-opacity:1;stroke:none;stroke-width:0.96196598"
+       x="31.512171"
+       y="144.46909"
+       id="text2913"><tspan
+         sodipodi:role="line"
+         id="tspan2911"
+         x="31.512171"
+         y="144.46909"
+         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Ubuntu;-inkscape-font-specification:'Ubuntu Bold';fill:#d40000;stroke-width:0.96196598">北</tspan></text>
+  </g>
+</svg>