saru 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54e40e1b2916336389bf2811d3e64aafc94fcb93
-  data.tar.gz: 7865d9d78b57022dfca8a761fe552b3e81a169d8
+  metadata.gz: ecf3d7b0302af9f092cb5aea7bc2bb1732da8f25
+  data.tar.gz: 564ee51bb24028530dafd6816f3b1c74239c76b3
 SHA512:
-  metadata.gz: 65f02843d3b4cac52fefe8ecac345d5af06a3e2d8254d2375c41957b83eb8ba69cda9d93e95cf7c432176d92d2d62b322c793a8ef114dc27d0353ff995df68c5
-  data.tar.gz: 1acafa17afe34e6a583603ec5e0af7c7f5337dabf8baecf448877239352e8e6f2d6557a23889ff82eb4216eebb275cea4f906ad9988a73d85546c2f9ea68740b
+  metadata.gz: 13b72901ee21ee2e9f6e8b7d764513e567f4804bc547a1078dd79e694759eb05000a161bbcd8e64860a4625e1f6c4ff8b945af3335836b4c0b8d71abf99835b0
+  data.tar.gz: fde8747521265edc2d4d8bbd7d87b41cec37c40fe5c261c10b1c53c9f3dc96ea57d67116ba5463ba8548ee042eb70a9f8b96efa97679c409597c17eca115f09a

data/README.md

@@ -117,6 +117,16 @@ require 'saru'
     ...
 ```
 
+### Anki export
+
+```ruby
+# You can export any search to an anki deck, in case you need extra SRS
+
+> Saru.kanji(1..26).srs_is_not_burned.total_incorrect_larger_than(10).export_to_anki
+Anki file generated in saru_deck_1704211620.txt
+=> nil
+```
+
 ### Available search methods
 
 #### SRS

data/lib/saru/anki.rb

@@ -0,0 +1,50 @@
+require 'anki'
+require 'date'
+
+module Saru
+  class Anki
+    attr_reader :items
+
+    def initialize items
+      @items = items
+    end
+
+    def deck
+      raise NotImplementedError, 'Radicals not supported' if items.first.is_a?(Saru::Radical)
+
+      @deck ||= ::Anki::Deck.new card_headers: %w(front back tags),
+                               card_data: card_data
+    end
+
+    def generate
+      file_path = "saru_deck_#{timestamp}.txt"
+
+      deck.generate_deck file: file_path
+      puts "Anki file generated in #{file_path}"
+    end
+
+  private
+
+    def card_data
+      items.map do |item|
+        {
+          'front' => item.character,
+          'back'  => back_for(item),
+          'tags'  => item.class.name.split('::').last
+        }
+      end
+    end
+
+    def timestamp
+      @timestamp ||= DateTime.now.strftime("%y%m%d%H%M")
+    end
+
+    def back_for item
+      case item
+        when Saru::Kanji      then "#{item.meaning} —— #{item.important_reading}"
+        when Saru::Vocabulary then "#{item.meaning} —— #{item.kana}"
+      end
+    end
+
+  end
+end

data/lib/saru/list.rb

@@ -3,6 +3,7 @@ require 'saru/list/unlocked_date'
 require 'saru/list/incorrect'
 require 'saru/list/srs'
 require 'saru/list/kanji_related'
+require 'saru/anki'
 
 module Saru
   class List
@@ -19,8 +20,21 @@ module Saru
       @items = items
     end
 
+    def to_anki
+      anki.deck
+    end
+
+    def export_to_anki
+      anki.generate
+    end
+
     def_delegator :@items,
                   :size
 
+  private
+
+    def anki
+      @anki ||= Saru::Anki.new(items)
+    end
   end
 end

data/lib/saru/version.rb

@@ -1,3 +1,3 @@
 module Saru
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/saru.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "json", '~>1.8'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "anki", "~> 0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saru
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Víctor
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: anki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 description: Wanikani API Wrapper for the user's items (radicals, kanji and vocabulary)
 email:
 - victor.martin84@gmail.com
@@ -97,6 +111,7 @@ files:
 - bin/console
 - bin/setup
 - lib/saru.rb
+- lib/saru/anki.rb
 - lib/saru/builder.rb
 - lib/saru/connection.rb
 - lib/saru/connection/base.rb