kita 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc52ea1433292c7a3c9146792e73117217f6d1ab6c640524489c0f22a30158a6
+  data.tar.gz: 32f74e1b6261250a6c36a9124f5ac4c5f651f9866c6665c7f949b2b43b50e6f3
+SHA512:
+  metadata.gz: 79062cb37ecc657c208445d7a074d8fb3a8bacb32d84b1d5b94f8edbed3423e37e0d56b7cf6ad1563e7fe8daeb764d9838c8214f4d80c10cf66ee2cd70785372
+  data.tar.gz: e59ae6841712228838da590cf17eb093a18746f1b0073308d5b0160fa52d6dfd5659e2c649a8e753cf30158dc71f73424d72607d2925f7ff3cb7376b1863d3b7

data/.gitignore

@@ -0,0 +1,14 @@
+vendor
+*~
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+# Show URLs for each cop
+AllCops:
+  DisplayStyleGuide: true
+
+# Disable block-length checks for rspec
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+# Extend permitted line length
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+### Added
+- Marketing banner to prompt users to upgrade to a free account
+
+### Changed
+
+## 2020-05-24
+### Added
+- First release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+* The use of sexualised language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the project team at d@nbishop.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.9'

data/Gemfile.lock

@@ -0,0 +1,120 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    atk (3.4.3)
+      glib2 (= 3.4.3)
+    cairo (1.16.5)
+      native-package-installer (>= 1.0.3)
+      pkg-config (>= 1.2.2)
+    cairo-gobject (3.4.3)
+      cairo (>= 1.16.2)
+      glib2 (= 3.4.3)
+    concurrent-ruby (1.1.6)
+    config (2.2.1)
+      deep_merge (~> 1.2, >= 1.2.1)
+      dry-validation (~> 1.0, >= 1.0.0)
+    deep_merge (1.2.1)
+    diff-lcs (1.3)
+    dry-configurable (0.11.5)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-initializer (3.0.3)
+    dry-logic (1.0.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-schema (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.4)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5)
+    ffi (1.12.2)
+    ffi-bit_masks (0.1.1)
+      ffi (~> 1.0)
+    gdk3 (3.4.3)
+      cairo-gobject (= 3.4.3)
+      gdk_pixbuf2 (= 3.4.3)
+      pango (= 3.4.3)
+    gdk_pixbuf2 (3.4.3)
+      gio2 (= 3.4.3)
+    gio2 (3.4.3)
+      gobject-introspection (= 3.4.3)
+    gir_ffi (0.15.2)
+      ffi (~> 1.8)
+      ffi-bit_masks (~> 0.1.1)
+    glib2 (3.4.3)
+      native-package-installer (>= 1.0.3)
+      pkg-config (>= 1.3.5)
+    gobject-introspection (3.4.3)
+      glib2 (= 3.4.3)
+    gstreamer (3.4.3)
+      gobject-introspection (= 3.4.3)
+    gtk3 (3.4.3)
+      atk (= 3.4.3)
+      gdk3 (= 3.4.3)
+      gdk_pixbuf2 (= 3.4.3)
+      gio2 (= 3.4.3)
+      pango (= 3.4.3)
+    moji (1.6)
+    mojinizer (0.2.2)
+      moji (~> 1.6)
+    native-package-installer (1.0.9)
+    pango (3.4.3)
+      cairo-gobject (= 3.4.3)
+      gobject-introspection (= 3.4.3)
+    pkg-config (1.4.1)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  config (~> 2.2)
+  gir_ffi (~> 0.15.2)
+  gstreamer (~> 3.4)
+  gtk3 (~> 3.4)
+  mojinizer (~> 0.2.2)
+  pango (~> 3.4)
+  rake (~> 13.0)
+  rspec (~> 3.9)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1 @@
+# Kita

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/kita

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+application_root_path = File.expand_path(__dir__)
+require File.join(application_root_path, '../lib/kita.rb')
+
+app = Kita::Application.new
+
+app.run
+
+Gtk.main

data/kita.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/kita/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kita'
+  spec.version       = Kita::VERSION
+  spec.authors       = ['Dan Bishop']
+  spec.email         = ['d@nbishop.uk']
+
+  spec.summary       = 'A Japanese kana learning tool.'
+  spec.description   = 'A simple tool to help Japanese language learners with hiragana and katakana.'
+  spec.homepage      = 'https://www.danbishop.org'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/danbishop/kita'
+  spec.metadata['changelog_uri'] = 'https://github.com/danbishop/kita/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'config', '~> 2.2'
+  spec.add_dependency 'gir_ffi', '~> 0.15.2'
+  spec.add_dependency 'gstreamer', '~> 3.4'
+  spec.add_dependency 'gtk3', '~> 3.4'
+  spec.add_dependency 'mojinizer', '~> 0.2.2'
+  spec.add_dependency 'pango', '~> 3.4'
+end

data/lib/kita.rb

@@ -0,0 +1,160 @@
+# 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/version'
+
+module Kita
+  # Main application class
+  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]
+      @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
+    end
+
+    def setup_about_box
+      about_box = @builder.get_object('about_box')
+      about_button = @builder.get_object('menu_about')
+      about_button.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
+    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?
+    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?
+    end
+
+    def toggle_sound
+      Settings.speak = !Settings.speak
+    end
+
+    def build_main_window
+      signal_connect :activate do
+        # Connect signal handlers to the constructed widgets
+        window = @builder.get_object('window')
+        window.signal_connect('destroy') { Gtk.main_quit }
+        window.present
+      end
+    end
+
+    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>")
+      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
+    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.set_label(question[:answer])
+      correct_signal = correct_button.signal_connect('clicked') do
+        new_question
+      end
+      @button_signals[correct] = correct_signal
+    end
+
+    def wrong_buttons(buttons, question)
+      buttons.each_with_index do |letter, i|
+        button = @builder.get_object("answer_#{letter}")
+        button.set_label(question[:choices][i])
+        signal = button.signal_connect('clicked') { wrong_button_click(button) }
+        @button_signals[letter] = signal
+      end
+    end
+
+    def wrong_button_click(button)
+      button.set_sensitive(false)
+      label = button.child
+      label.set_markup("<span color='#d40000'>#{button.label} #{button.label.hiragana}</span>")
+    end
+
+    def reset_buttons
+      return nil if @button_signals.empty?
+
+      @button_signals.each do |letter, signal|
+        button = @builder.get_object("answer_#{letter}")
+        button.signal_handler_disconnect(signal)
+        button.set_sensitive(true)
+      end
+      @button_signals = {}
+    end
+  end
+end