shuang_pin_tutorial 1.1.1 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a10efd89f18dd8b4cd10dd74e7f3fcda75c89765b7fadea755e17f560b3847
-  data.tar.gz: f88c8a9c0a893c4d89247cd79d90147444a61d4c73386d57324d96cb891c59ad
+  metadata.gz: fbb3c723acf9687739b71629fff9587badfcc52764b4c78363180ac425d9b785
+  data.tar.gz: d112cf132103aaac133cec736855d82b7b1e1b99e68503ffd281fd95b9a4a94b
 SHA512:
-  metadata.gz: f710a194ea96bae7d148e17017fef7c0514a7fc2ab3d15b832a7788775838cf3815ea23d38cf405f17b8c53fc68789b9d68ff0e96ab1d64d46016eea1ad760d1
-  data.tar.gz: 69b963816a2c38794280ee9882de3d8200543d3222de3f7c8320102803f6a72edd17f853868196e986b8bdd0ab8c012c00274623f96cdd7d7a69803b374482ac
+  metadata.gz: 7b8ee8448f6f121a1e1fb50fd7014f4847c391b5a90f1ca708f80cd66378b69495f67b06a00190afb35513e73d2a68dffa9705cc4d6a64990a8427494dcd97ec
+  data.tar.gz: ac4effda71c7bec01e380f56702f294ba4014fc5e02dedcf448ed2d5f1fa901660068476bbde95ce375733e2694802086cf265a4fd15383352a16141c625b613

data/README.md

@@ -3,12 +3,13 @@
 ### 程序簡介：
 
 一個萌妹子風格的輸入法學習套件，參考新華字典的設定，每次隨機出現出合理的拼音組合。<br>
-根據輸出的拼音組合中打出對應的雙拼，每個字用空格隔開，按 Enter 提交，輸入 ```exit``` 提交或者按下 Ctrl+c 退出練習。
+根據輸出的拼音組合中打出對應的雙拼，每個字用空格隔開，按 Enter 提交，輸入 ```exit``` 提交或者按下 Ctrl+c 退出練習。<br>
+程式已掛載上 [RubyGems][rubygem_shuang_pin_tutorial]，請用 [Gem 工具][rubygem_package_manager] 下載與使用本套件。
 
-快速學習雙拼 程序畫面：\
+快速學習雙拼 程序畫面：<br>
 ![image][shuang_pin_tutorial_console]
 
-微軟雙拼鍵盤方案圖：\
+微軟雙拼鍵盤方案圖：<br>
 ![image][shuang_pin_keyboard]
 
 <br>另外，[參考文件夾][folder_img]中附上：
@@ -29,7 +30,11 @@
 gem install shuang_pin_tutorial     # 透過 Gem 安裝學習雙拼套件
 
 shuang_pin_tutorial     # 運行套件
+shuang_pin_tutorial --help    # 查看選項
+shuang_pin_tutorial [OPTIONS]    # 運行自選項套件
 ```
+[rubygem_shuang_pin_tutorial]: https://rubygems.org/gems/shuang_pin_tutorial
+[rubygem_package_manager]: https://rubygems.org/pages/download
 
 [shuang_pin_tutorial_console]: ./img/shuang_pin_tutorial_console.png  "shuang pin tutorial console"
 [shuang_pin_keyboard]: ./img/shuang_pin_keyboard.png  "shuang pin keyboard"

data/exe/shuang_pin_tutorial

@@ -4,7 +4,28 @@
 STDOUT.sync = true
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
+require 'mercenary'
 require 'shuang_pin_tutorial'
 
-main = ShuangPinTutorial::Main.new()
-main.run()
+spt = ShuangPinTutorial
+Mercenary.program(spt::NAME) do |p|
+  p.version spt::VERSION
+  p.description "A tutorial application for Microsoft Shuang Pin input method(zh-tw)."
+  p.syntax "#{spt::NAME} [OPTIONS]"
+
+  long_opt = Proc.new { |sym| "--#{spt::OPTIONS[sym].gsub(/_/, '-')}" }
+
+  p.option "#{spt::OPTIONS[:w]}",
+   "-w", "#{long_opt.call(:w)} [num]", "Words display in each section (defaults 6)"
+  p.option "#{spt::OPTIONS[:r]}",
+   "-r", "#{long_opt.call(:r)}", "Turn off the input reminder (defaults on)"
+  p.option "#{spt::OPTIONS[:z]}",
+   "-z", "#{long_opt.call(:z)}", "Turn off the Taiwan zhuyin display (defaults on)"
+  p.option "#{spt::OPTIONS[:c]}",
+   "-c", "#{long_opt.call(:c)}", "Turn off the Chinese word display (defaults on)"
+
+  p.action do |_args, options|
+    main = spt::Main.new()
+    main.run(options)
+  end
+end

data/lib/shuang_pin_tutorial.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/ruby
 # frozen_string_literal: true
 
 # $LOAD_PATH.unshift __dir__ # For use/testing when no gem is installed
@@ -13,9 +14,16 @@ end
 module ShuangPinTutorial
   MODULE = "ShuangPinTutorial"
   NAME = "shuang_pin_tutorial"
-  VERSION = "1.1.1"
+  VERSION = "1.2.1"
+  OPTIONS = {w: "words", r: "remind_off", z: "zhuyin_off", c: "cword_off"}
+  OPTIONS_DEFAULT = {w: 6, r: true, z: true, c: true}
 
   autoload(:Main, "#{NAME}/main")
   autoload(:Handler, "#{NAME}/handler")
   autoload(:Data, "#{NAME}/data")
+end
+
+if __FILE__ == $0  # for test-run use
+  main = ShuangPinTutorial::Main.new()
+  main.run()
 end

data/lib/shuang_pin_tutorial/data.rb

@@ -1,3 +1,4 @@
+#!/usr/bin/ruby
 # encoding: UTF-8
 
 module ShuangPinTutorial

data/lib/shuang_pin_tutorial/handler.rb

@@ -4,14 +4,15 @@ require 'date'
 require_relative 'data'
 
 module ShuangPinTutorial
-  INT_WORDS_DISPLAYED = 6
+  # fixed const
   STR_TIPS_SEPARATOR='———'
-  IS_ENABLE_TIPS = true
-  IS_DISPLAY_ZHUYIN = true
-  IS_DISPLAY_CWORD = true
 
   class Handler
-    def initialize()
+    def initialize(options)
+      @int_words_displayed = options && options.key?(OPTIONS[:w]) ? options[OPTIONS[:w]].to_i : OPTIONS_DEFAULT[:w]   # integer
+      @is_enable_reminder = options && options.key?(OPTIONS[:r]) ? !options[OPTIONS[:r]] : OPTIONS_DEFAULT[:r]   # boolean(reverse)
+      @is_display_zhuyin = options && options.key?(OPTIONS[:z]) ? !options[OPTIONS[:z]] : OPTIONS_DEFAULT[:z]   # boolean(reverse)
+      @is_display_cword = options && options.key?(OPTIONS[:c]) ? !options[OPTIONS[:c]] : OPTIONS_DEFAULT[:c]   # boolean(reverse)
     end
 
     def start()
@@ -38,7 +39,7 @@ module ShuangPinTutorial
       end
     end
 
-    def get_words_showlines(num = INT_WORDS_DISPLAYED, display_delim: "|")   # return [words(str), [display line(s)]]
+    def get_words_showlines(num = @int_words_displayed, display_delim: "|")   # return [words(str), [display line(s)]]
       result = []
       display = []
       display_py = []
@@ -55,8 +56,8 @@ module ShuangPinTutorial
         display_cw.push(cw + "\t")
       end
       display << display_py.join(display_delim)
-      display << display_zy.join(display_delim) if IS_DISPLAY_ZHUYIN
-      display << display_cw.join(display_delim) if IS_DISPLAY_CWORD
+      display << display_zy.join(display_delim) if @is_display_zhuyin
+      display << display_cw.join(display_delim) if @is_display_cword
       [result.join(" "), display]
     end
 
@@ -100,7 +101,7 @@ module ShuangPinTutorial
       result_words = result[0]
       result_display = result[1]
       result_tips = []
-      if IS_ENABLE_TIPS
+      if @is_enable_reminder
         result_words.split.each { |res| result_tips.push(@sp_data.get_correct_keys(res)) }
         result_display[0] = "#{result_display[0]}  #{STR_TIPS_SEPARATOR}  【#{result_tips.join(" ")}】"
       end

data/lib/shuang_pin_tutorial/main.rb

@@ -1,4 +1,3 @@
-#!/usr/bin/ruby
 # encoding: UTF-8
 
 require_relative 'handler'
@@ -10,8 +9,8 @@ module ShuangPinTutorial
       @obj_tutorial = nil
     end
 
-    def run()
-      @obj_tutorial = Handler.new()
+    def run(options = nil)
+      @obj_tutorial = Handler.new(options)
       @obj_tutorial.start()
     rescue Interrupt => ir
       $stdout.puts('累了就該休息一下吧！')
@@ -29,9 +28,4 @@ module ShuangPinTutorial
       exit(@is_run_success)
     end
   end
-end
-
-if __FILE__ == $0  # for test-run use
-  main = ShuangPinTutorial::Main.new()
-  main.run()
 end

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: shuang_pin_tutorial
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.1
 platform: ruby
 authors:
 - David N
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-25 00:00:00.000000000 Z
-dependencies: []
+date: 2020-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 description: An interesting, featured tutorial application for practicing Microsoft
-  Shuang Pin input method.
+  Shuang Pin input method(zh-tw).
 email: dn@jsdn.hk
 executables:
 - shuang_pin_tutorial
@@ -32,8 +46,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/jsdnhk/shuang_pin_tutorial
-  changelog_uri: https://github.com/jsdnhk/shuang_pin_tutorial/CHANGELOG.md
-  documentation_uri: https://github.com/jsdnhk/shuang_pin_tutorial/README.md
+  changelog_uri: https://github.com/jsdnhk/shuang_pin_tutorial/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/jsdnhk/shuang_pin_tutorial/blob/master/README.md
 post_install_message: Welcome using Microsoft Shuang Pin tutorial!
 rdoc_options:
 - "--charset=UTF-8"
@@ -50,8 +64,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.7.0
 requirements: []
-rubygems_version: 3.1.2
+rubyforge_project: 
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
-summary: A tutorial application for Microsoft Shuang Pin input method.
+summary: A tutorial application for Microsoft Shuang Pin input method(zh-tw).
 test_files: []