ankirb 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87d7373f7c03a2d839df64d8c6e6f50532be6f4d
-  data.tar.gz: 11220833871161919fa564250e1a4b954fc49f2e
+  metadata.gz: f5fd158d642c85607da73896038b549d78a066f6
+  data.tar.gz: 9b1e498c0c24d382d57c6357ac42a98a1cbdcb65
 SHA512:
-  metadata.gz: 3a701edd015461c1b8992eba94226f4d5424bcc64be149b2170a232d6ce492f80d4e3e5f1d7537114fb6a5a3a0da532087deb22530bde68ede8fde2c2f26092d
-  data.tar.gz: 30c7c63f0fe9978fdd098a587579081223a80776a79920f985ee8ec2a25a9399af651d203471065a1697b563eedaceadf29eb66f049fdb0267b021299db19be4
+  metadata.gz: bdbc517586d56262689682ae58ec1dfd6b6fedd5f575f78b360e4855540d900eefca8709285b2de1644c1abc9eda0fb54bb4de09fffeca47ce0db4839cb341e5
+  data.tar.gz: 78dbac9226d9bd2b1280952c845f0d68174fa20c4f949bcb819ea930baaa537b9cedd1bbb44e9cea9a8ee6a55ddcb58e99f7c499b4f0f51d4b37888f0dfe8400

data/README.md

@@ -41,6 +41,22 @@ deck.add_card card
 Anki::apkg.export deck, "~/Anki/Decks" 
 ```
 
+### Media types
+
+Media can be added to a card face via the `<<` operator, just pass a string that points to a valid media file and the lib will convert + package the file. 
+
+For images, the position of the image in the card can be set by using a placeholder `{{img}}`. 
+
+```ruby
+card = Anki::Card.new :front => "{{img}} text after image", :back => "text before image {{img}}"
+card.front << "front_img.jpg"
+card.back << "back_img.jpg"
+```
+
+If no placeholder is present the image will just be added at the end. If multiple placeholders are present, they'll be replaced sequentially with the image files added to the card.
+
+As with anki, html tags can be used for more styling in the card content. Card model / css template support may be added in future.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/rkachowski/ankirb.

data/lib/ankirb.rb

@@ -1,8 +1,16 @@
+require 'logger'
 
 module Anki
   Gem.find_files("ankirb/**/*.rb").each { |path| require path }
 
+  @@logger = Logger.new(STDOUT)
+  @@logger.level = ENV["DEBUG"] ? Logger::DEBUG : Logger::WARN
+
   def self.apkg
     APKGExporter
   end
+
+  def self.logger
+    @@logger
+  end
 end

data/lib/ankirb/anki/card.rb

@@ -3,13 +3,12 @@ module Anki
     attr_accessor :tags, :deck
     attr_reader :id
 
-
     def initialize options={}
       @front = CardFace.new(options[:front] || '')
       @back = CardFace.new(options[:back] || '')
       @tags = options[:tags] || []
 
-      @id = Time.now.to_i
+      @id = Anki::Helper.get_id
     end
 
     def front

data/lib/ankirb/anki/deck.rb

@@ -5,9 +5,16 @@ module Anki
 
     def initialize name
       @name = name
-      @id = Time.now.to_i
+      @id = Anki::Helper.get_id
       @cards = {}
-      
+
+      #change @cards#to_s to prevent recursive output via parent / child relationship
+      class << @cards
+        def to_s
+          "#< #{self.keys.count} cards>"
+        end
+        alias_method :inspect, :to_s
+      end
     end
 
     def add_card card

data/lib/ankirb/export/apkg.rb

@@ -11,21 +11,21 @@ module Anki
 
     def self.export deck, path
       Dir.mktmpdir do |dir|
-          db = DB.create File.join(dir,'collection.anki2')
+        db = DB.create File.join(dir,'collection.anki2')
 
-          export_media deck, dir
-          export_deck deck, db
+        export_media deck, dir
+        export_deck deck, db
 
-          filename = deck.name + '.apkg'
-          archive = Zip::File.open(File.join(dir,filename), Zip::File::CREATE)
+        filename = deck.name + '.apkg'
+        archive = Zip::File.open(File.join(dir,filename), Zip::File::CREATE)
 
-          Dir.glob(File.join(dir,'*')).each do |file|
-            archive.add( File.basename(file),file)
-          end
+        Dir.glob(File.join(dir,'*')).each do |file|
+          archive.add( File.basename(file),file)
+        end
 
-          archive.close()
+        archive.close()
 
-          FileUtils.move(File.join(dir,filename), path)
+        FileUtils.move(File.join(dir,filename), path)
       end
     end
 
@@ -55,7 +55,7 @@ module Anki
 
       model = Defaults.model(deck.id)
 
-      db.execute "insert into col values(
+      cmd = "insert into col values(
         #{deck.id},
         #{Time.now.to_i},
         #{Time.now.to_i},
@@ -71,13 +71,15 @@ module Anki
         '#{Defaults.tags}'
       )"
 
+      Anki.logger.debug cmd
+      db.execute cmd
       deck.cards.each do |card|
         #flds is front and back of card separated by \x1f
         flds_bytes = [card.front.content, card.back.content].map{|f|f.bytes}.insert(1, '1f'.hex)
         flds = flds_bytes.flatten.pack('U*')
 
         note = {
-            :id => Time.now.to_i,
+            :id => Anki::Helper.get_id,
             :guid => Base91.encode(Random.new.rand(2**63).to_s),
             :mid => Defaults.model_id,
             :mod => Time.now.to_i,
@@ -91,46 +93,32 @@ module Anki
         }
 
         add_note_to_db note, db
-        add_card_to_db note, deck, db
+        add_card_to_db card.id, note, deck, db
       end
 
     end
 
-    def self.add_card_to_db(note, deck, db)
-      db.execute "insert into cards values(
-        #{Time.now.to_i},
-        #{note[:id]},
-        #{deck.id},
-        0,
-        #{Time.now.to_i},
-        -1,
-        #{Type.new_type},
-        #{Queue.new_queue},
-        #{Random.new.rand(2**10)},
-        0,
-        0,
-        0,
-        0,
-        0,
-        0,
-        0,
-        0,
-        '')"
+    def self.add_card_to_db(id, note, deck, db)
+      args = [id, note[:id],deck.id, 0, Time.now.to_i, -1, Type.new_type, Queue.new_queue,Random.new.rand(2**10),
+      0, 0, 0, 0, 0, 0, 0, 0, '']
+      cmd = "insert into
+cards( id, nid, did, ord, mod, usn, type, queue, due, ivl, factor, reps, lapses, left, odue, odid, flags, data)
+values(#{args.map{ '?' }.join(',')})"
+
+      Anki.logger.debug cmd
+      db.execute cmd, args
     end
 
     def self.add_note_to_db note, db
-      db.execute "insert into notes values(
-        #{note[:id]},
-        '#{note[:guid]}',
-        #{note[:mid]},
-        #{note[:mod]},
-        #{note[:usn]},
-        '#{note[:tags]}',
-        '#{note[:flds]}',
-        '#{note[:sfld]}',
-        #{note[:csum]},
-        #{note[:flags]},
-        '#{note[:data]}')"
+      args = [note[:id],note[:guid].to_s, note[:mid], note[:mod],note[:usn], note[:tags].to_s,
+        note[:flds].to_s,note[:sfld].to_s,note[:csum],note[:flags], note[:data].to_s]
+
+      cmd = "insert into
+notes( id, guid, mid, mod, usn, tags, flds, sfld, csum, flags, data)
+values(?,?,?,?,?,?,?,?,?,?,?)"
+
+      Anki.logger.debug cmd + ' - ' + args.join(', ')
+      db.execute(cmd, args)
     end
 
     def self.deck_to_json deck

data/lib/ankirb/util/id_helper.rb

@@ -0,0 +1,9 @@
+module Anki
+  class Helper
+    @@count = 1000
+    def self.get_id
+      @@count += 1
+      @@count
+    end
+  end
+end

data/lib/ankirb/version.rb

@@ -1,3 +1,3 @@
 module Anki
-  VERSION = '0.2.0' unless const_defined?(:VERSION)
+  VERSION = '0.3.0' unless const_defined?(:VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ankirb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Donald Hutchison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,10 +140,10 @@ files:
 - lib/ankirb.rb
 - lib/ankirb/anki/card.rb
 - lib/ankirb/anki/deck.rb
-- lib/ankirb/anki/media.rb
 - lib/ankirb/export/apkg.rb
 - lib/ankirb/export/db.rb
 - lib/ankirb/export/defaults.rb
+- lib/ankirb/util/id_helper.rb
 - lib/ankirb/util/media.rb
 - lib/ankirb/version.rb
 homepage: https://github.com/rkachowski/anki-rb
@@ -166,7 +166,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A gem to create Anki decks for loading in an Anki flashcard application

data/lib/ankirb/anki/media.rb

@@ -1,15 +0,0 @@
-module Anki
-  class Media
-    def self.audio
-
-    end
-
-    def self.image
-
-    end
-
-    def self.video
-
-    end
-  end
-end