wkcheck 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb99313be7e551e022128188e1366bb2834f8faa
-  data.tar.gz: e1128dedc364d077310db4003b4b23813d6cceb3
+  metadata.gz: 40d8d23291afd61aa33db1fb966363ed12c5dfcd
+  data.tar.gz: 88888eaf9efcbbdc0c2d599ead371b509799ebde
 SHA512:
-  metadata.gz: a426ab54eb80c046d5a1a183716013e297ffcfa92936a65ba357555d0554e98d0354f0d2b796ded624c56179a91b19788893f1e6d6e9e37594f392bec728ed1e
-  data.tar.gz: ce44d4e653d23ef72d5a7e014fee1294dc647bf46408410b87e875b794e40d4b785078db86f33f635ec6777e969e51a7a8a3e791e563ef06823f4794e3419961
+  metadata.gz: 9e68116d25755b19b96116e4428f64d34264e17d18fd108cac1b7e9ec3cee51799707c016fcf8513b21fc390acb6dc02c82acd8445d86f4bdc186875f5b7dbe9
+  data.tar.gz: 72a03f419d8c34858f0e2f707592d1f320f8e767760078529995c320ad3aa08c732c2ef4cbb766552e37e1feefcc7b437a1a8feead5e4cf080ed951ec59a6696

data/README.md

@@ -17,10 +17,14 @@ $ wkcheck --api-key=YOUR_WANIKANI_API_KEY
 
 ## Usage
 
-Once the API Key is saved, simply run `wkcheck` to see how many lessons and reviews you have pending in WaniKani.
+Once the API Key is saved, you can check fetch different types of information from your WaniKani account (run `wkcheck` to see the different options).
+
+### Current study queue
+
+Displays how many new lessons and current reviews you have pending.
 
 ```
-$ wkcheck
+$ wkcheck -q
 You have no lessons pending.
 You have 93 reviews pending.
 ```
@@ -28,10 +32,45 @@ You have 93 reviews pending.
 If you don't have any lessons or reviews pending, you'll be able to see when your next review will come up.
 
 ```
-$ wkcheck
+$ wkcheck -q
 You have no lessons or reviews now! You'll have some more on Sunday, May 10 at 8:45 AM.
 ```
 
+### Current level progression
+
+Displays the number of radicals and kanji that have passed 'Apprentice' status for your current level.
+
+```
+$ wkcheck -l
+Your progress for level 18:
+0 out of 8 Radicals (0.0%)
+2 out of 29 Kanji (6.9%)
+```
+
+### Critical items
+
+Displays your current criticals under a certain percentage of correctness (default: 75).
+
+```
+$ wkcheck -c
+Your Critical Items - Max percentage: 75 (Kanji, Radicals, Vocabulary):
+了 (りょう) - finish, complete, end
+感覚 (かんかく) - senses, the senses
+```
+
+You can also specify an integer to change the max percentage of correctness.
+
+```
+$ wkcheck -c 85
+Your Critical Items - Max percentage: 85 (Kanji, Radicals, Vocabulary):
+栄 (えい) - prosperity, flourish
+署 (しょ) - government office, political office, office
+隹 - turkey
+去 - cemetery
+上がる (あがる) - to rise
+商売 (しょうばい) - business, commerce
+```
+
 ## Contributing
 
 I'll be super-happy if you guys help giving back! If you want to do some hacking on wkcheck for your needs, this is a good guideline to get started:

data/bin/wkcheck

@@ -12,6 +12,7 @@ opts = Slop.parse(help: true) do
   on "api-key=", "Saves your WaniKani API Key to #{WKCheck::CONFIG_FILE}"
   on "q", "queue", "Displays your current study queue (new lessons / pending reviews)"
   on "l", "level", "Displays your current level progression (radicals / Kanji)"
+  on "c", "critical", "Displays your current critical items, with an optional argument to set the maximum percentage", argument: :optional
   on "v", "version", "Show version number and quit" do
     puts "wkcheck #{WKCheck::VERSION}"
     exit
@@ -48,5 +49,18 @@ if opts.level?
   exit
 end
 
+if opts.critical?
+  percentage = opts["critical"] || 75
+
+  if percentage.to_i.between?(1, 99)
+    critical = WKCheck::CriticalItems.new(percentage.to_i)
+    puts critical.critical_items
+    exit
+  else
+    puts "The maximum percentage should be between 1 and 99!"
+    exit 1
+  end
+end
+
 # No flags / Invalid flags - Display the help.
 puts opts.help

data/lib/wkcheck/critical_items.rb

@@ -0,0 +1,35 @@
+module WKCheck
+  class CriticalItems
+    def initialize(percentage)
+      @percentage = percentage
+    end
+
+    def critical_items
+      critical = Wanikani::CriticalItems.critical(@percentage).sort_by { |item| item["type"] }
+
+      if critical.empty?
+        Rainbow("Awesome, you have no items under #{@percentage} percent correct! Keep on rockin'!").bright.green
+      else
+        summary =  Rainbow("Your Critical Items - Max percentage: #{@percentage} ").bright.white
+        summary += "(#{Rainbow('Kanji').red}, #{Rainbow('Radicals').cyan}, #{Rainbow('Vocabulary').magenta}):\n"
+        summary += critical.map { |item| send("#{item["type"]}_info", item) }.compact.join("\n")
+      end
+    end
+
+    private
+
+    def kanji_info(item)
+      important_reading = item["important_reading"]
+      "#{Rainbow(item["character"]).red} #{Rainbow("(#{item[important_reading]})").red} - #{item["meaning"]}"
+    end
+
+    def vocabulary_info(item)
+      "#{Rainbow(item["character"]).magenta} #{Rainbow("(#{item["kana"]})").magenta} - #{item["meaning"]}"
+    end
+
+    def radical_info(item)
+      return nil if item["character"].nil?
+      "#{Rainbow(item["character"]).cyan} - #{item["meaning"]}"
+    end
+  end
+end

data/lib/wkcheck/version.rb

@@ -1,3 +1,3 @@
 module WKCheck
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/wkcheck.rb

@@ -2,6 +2,7 @@ require 'wanikani'
 require 'rainbow'
 require 'wkcheck/version'
 require 'wkcheck/stats'
+require 'wkcheck/critical_items'
 
 module WKCheck
   CONFIG_FILE = "#{Dir.home}/.wkcheck.yml"

data/wkcheck.gemspec

@@ -6,7 +6,7 @@ require 'wkcheck/version'
 Gem::Specification.new do |s|
   s.name          = "wkcheck"
   s.version       = WKCheck::VERSION
-  s.date          = "2014-04-10"
+  s.date          = "2014-04-14"
   s.summary       = "Check your WaniKani stats from the command line"
   s.description   = "Check your pending lessons and reviews of your WaniKani account (http://www.wanikani.com/) from the command line"
   s.authors       = ["Dennis Martinez"]
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
     wkcheck.gemspec
     lib/wkcheck.rb
     lib/wkcheck/stats.rb
+    lib/wkcheck/critical_items.rb
     lib/wkcheck/version.rb
   ]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wkcheck
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Dennis Martinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-10 00:00:00.000000000 Z
+date: 2014-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wanikani
@@ -105,6 +105,7 @@ files:
 - README.md
 - bin/wkcheck
 - lib/wkcheck.rb
+- lib/wkcheck/critical_items.rb
 - lib/wkcheck/stats.rb
 - lib/wkcheck/version.rb
 - wkcheck.gemspec