ankirb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 261052b86dddb5f5b9043485e791292544202a5a
+  data.tar.gz: d64ea45ae879e49671a7bcd1219e5cf79a869fc1
+SHA512:
+  metadata.gz: 6e88167cccc6acc7cff1ed803a8ca7eb87ddb2b34428d7695c9d7c6b5384f2daad328006bf266c2bc1d64641076f8d7503f30d6f892d678bc70daac1fa56eda4
+  data.tar.gz: 5bd523db2b4d98cf984a5782597ce71220e660b369e48af113412e2657edec5326d787c32a329bb1ca1f173cdf7eb5f19e8edf390b2a6643480d930eadae2001

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+scrap
+NOTES
+test.db
+.DS_Store

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ankirb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Ankirb
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ankirb`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ankirb'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ankirb
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ankirb.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/ankirb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ankirb/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ankirb"
+  spec.version       = Anki::VERSION
+  spec.authors       = ["Donald Hutchison"]
+  spec.email         = ["git@toastymofo.net"]
+
+  spec.summary       = %q{A gem to create Anki decks for loading in an Anki flashcard application}
+  spec.description   = %q{A library that lets you export apkg packaged decks for Anki. Designed to deal with creation / exporting and not much else}
+  spec.homepage      = "https://github.com/rkachowski/anki-rb"
+  spec.license       = "MIT"
+
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_runtime_dependency 'rake', '~> 10.5'
+  spec.add_runtime_dependency 'base91', '0.0'
+  spec.add_runtime_dependency 'rubyzip', '~> 1.1'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
+end

data/lib/anki.rb

@@ -0,0 +1,8 @@
+
+module Anki
+  Gem.find_files("ankirb/**/*.rb").each { |path| require path }
+
+  def self.apkg
+    APKGExporter
+  end
+end

data/lib/ankirb/anki/deck.rb

@@ -0,0 +1,56 @@
+module Anki
+  class Deck
+    attr_accessor :name, :desc
+    attr_reader :id, :cards
+
+    def initialize name
+      @name = name
+      @id = Time.now.to_i
+      @cards = {}
+      
+    end
+
+    def add_card card
+      card.deck = self
+      @cards[card.id] = card
+    end
+
+    def cards
+      @cards.values
+    end
+
+    def [] id
+      @cards[id]
+    end
+  end
+
+  class Card
+    attr_accessor :front, :back, :tags, :deck
+    attr_reader :id
+
+    @@defaults = {
+        :front => 'Card Front',
+        :back => 'Card Back'
+    }
+
+    def initialize options={}
+      @front = options[:front] || @@defaults[:front]
+      @back = options[:back] || @@defaults[:back]
+      @tags = options[:tags] || []
+
+      @id = Time.now.to_i
+    end
+  end
+
+  class Type
+    def self.new_type
+      0
+    end
+  end
+
+  class Queue
+    def self.new_queue
+      0
+    end
+  end
+end

data/lib/ankirb/export/apkg.rb

@@ -0,0 +1,129 @@
+require 'zip'
+require 'json'
+require 'fileutils'
+require 'base91'
+module Anki
+
+  SCHEMA_VERSION = 11
+
+  class APKGExporter
+
+    def self.export deck, path
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          db = DB.create 'collection.anki2'
+
+          export_deck deck, db
+          export_media deck
+          filename = deck.name + '.apkg'
+          archive = Zip::File.open(filename, Zip::File::CREATE)
+
+          Dir.glob('*').each do |file|
+            archive.add(file, file)
+          end
+
+          archive.close()
+
+          FileUtils.move(filename, path)
+        end
+      end
+    end
+
+    private
+    def self.export_media deck
+      #TODO: correctly export media
+      File.open('media', 'w'){|f| f << Defaults.media }
+    end
+
+    def self.export_deck deck, db
+
+      decks = {}
+      decks['1'] = Defaults.deck
+      decks[deck.id.to_s] = deck_to_json deck
+
+      model = Defaults.model(deck.id)
+
+      db.execute "insert into col values(
+        #{deck.id},
+        #{Time.now.to_i},
+        #{Time.now.to_i},
+        #{Time.now.to_i},
+        #{SCHEMA_VERSION},
+        0,
+        -1,
+        0,
+        '#{Defaults.conf}',
+        '#{model.to_json}',
+        '#{JSON.generate(decks)}',
+        '#{Defaults.dconf}',
+        '#{Defaults.tags}'
+      )"
+
+      deck.cards.each do |card|
+        #flds is front and back of card separated by \xf1
+        flds_bytes = [card.front, card.back].map{|f|f.bytes}.insert(1, 'f1'.hex)
+        flds = flds_bytes.flatten.pack('C*').force_encoding('utf-8')
+
+        note = {
+            :id => Time.now.to_i,
+            :guid => Base91.encode(Random.new.rand(2**63).to_s),
+            :mid => Defaults.model_id,
+            :mod => Time.now.to_i,
+            :usn => -1,
+            :tags => nil,
+            :flds => flds,
+            :sfld => card.front.gsub(/<\/?[^>]*>/, ''), #v dirty html sanitization
+            :csum => 0,
+            :flags => 0,
+            :data => nil
+        }
+
+        add_note_to_db note, db
+        add_card_to_db 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,
+        '')"
+    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]}')"
+    end
+
+    def self.deck_to_json deck
+      JSON.parse %Q({"name": "#{deck.name}", "extendRev": 50, "usn": -1, "collapsed": false, "browserCollapsed": true, "newToday": [29, 0], "timeToday": [29, 0], "dyn": 0, "extendNew": 10, "conf": 1, "revToday": [29, 0], "lrnToday": [29, 0], "id": #{deck.id}, "mod": 1454538410, "desc": "#{deck.desc}"})
+    end
+  end
+end
+

data/lib/ankirb/export/db.rb

@@ -0,0 +1,86 @@
+require 'sqlite3'
+
+module Anki
+  class DB
+    def self.create name
+      db = SQLite3::Database.new name
+      db.execute_batch @@schema
+      db
+    end
+
+
+    @@schema = <<SCHEMA
+CREATE TABLE col (
+    id              integer primary key,
+    crt             integer not null,
+    mod             integer not null,
+    scm             integer not null,
+    ver             integer not null,
+    dty             integer not null,
+    usn             integer not null,
+    ls              integer not null,
+    conf            text not null,
+    models          text not null,
+    decks           text not null,
+    dconf           text not null,
+    tags            text not null
+);
+CREATE TABLE notes (
+    id              integer primary key,   /* 0 */
+    guid            text not null,         /* 1 */
+    mid             integer not null,      /* 2 */
+    mod             integer not null,      /* 3 */
+    usn             integer not null,      /* 4 */
+    tags            text not null,         /* 5 */
+    flds            text not null,         /* 6 */
+    sfld            integer not null,      /* 7 */
+    csum            integer not null,      /* 8 */
+    flags           integer not null,      /* 9 */
+    data            text not null          /* 10 */
+);
+CREATE TABLE cards (
+    id              integer primary key,   /* 0 */
+    nid             integer not null,      /* 1 */
+    did             integer not null,      /* 2 */
+    ord             integer not null,      /* 3 */
+    mod             integer not null,      /* 4 */
+    usn             integer not null,      /* 5 */
+    type            integer not null,      /* 6 */
+    queue           integer not null,      /* 7 */
+    due             integer not null,      /* 8 */
+    ivl             integer not null,      /* 9 */
+    factor          integer not null,      /* 10 */
+    reps            integer not null,      /* 11 */
+    lapses          integer not null,      /* 12 */
+    left            integer not null,      /* 13 */
+    odue            integer not null,      /* 14 */
+    odid            integer not null,      /* 15 */
+    flags           integer not null,      /* 16 */
+    data            text not null          /* 17 */
+);
+CREATE TABLE revlog (
+    id              integer primary key,
+    cid             integer not null,
+    usn             integer not null,
+    ease            integer not null,
+    ivl             integer not null,
+    lastIvl         integer not null,
+    factor          integer not null,
+    time            integer not null,
+    type            integer not null
+);
+CREATE TABLE graves (
+    usn             integer not null,
+    oid             integer not null,
+    type            integer not null
+);
+CREATE INDEX ix_notes_usn on notes (usn);
+CREATE INDEX ix_cards_usn on cards (usn);
+CREATE INDEX ix_revlog_usn on revlog (usn);
+CREATE INDEX ix_cards_nid on cards (nid);
+CREATE INDEX ix_cards_sched on cards (did, queue, due);
+CREATE INDEX ix_revlog_cid on revlog (cid);
+CREATE INDEX ix_notes_csum on notes (csum);
+SCHEMA
+  end
+end

data/lib/ankirb/export/defaults.rb

@@ -0,0 +1,31 @@
+module Anki
+  class Defaults
+    def self.deck
+      JSON.parse '{"newToday":[0,0],"revToday":[0,0],"lrnToday":[0,0],"timeToday":[0,0],"conf":1,"usn":0,"desc":"","dyn":0,"collapsed":false,"extendNew":10,"extendRev":50}'
+    end
+
+    def self.model deck_id
+      JSON.parse %Q({"#{model_id}": {"vers": [], "name": "Basic", "tags": [], "did": #{deck_id}, "usn": -1, "req": [[0, "all", [0]]], "flds": [{"name": "Front", "media": [], "sticky": false, "rtl": false, "ord": 0, "font": "Arial", "size": 20}, {"name": "Back", "media": [], "sticky": false, "rtl": false, "ord": 1, "font": "Arial", "size": 20}], "sortf": 0, "latexPre": "\\\\documentclass[12pt]{article}\\n\\\\special{papersize=3in,5in}\\n\\\\usepackage[utf8]{inputenc}\\n\\\\usepackage{amssymb,amsmath}\\n\\\\pagestyle{empty}\\n\\\\setlength{\\\\parindent}{0in}\\n\\\\begin{document}\\n\", "tmpls": [{"name": "Card 1", "qfmt": "{{Front}}", "did": null, "bafmt": "", "afmt": "{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}", "ord": 0, "bqfmt": ""}], "latexPost": "\\\\end{document}", "type": 0, "id": 1451998862056, "css": ".card {\\n font-family: arial;\\n font-size: 20px;\\n text-align: center;\\n color: black;\\n background-color: white;\\n}\\n", "mod": 1454538410}})
+    end
+
+    def self.model_id
+      1451998862056
+    end
+
+    def self.conf
+      '{"nextPos": 1, "estTimes": true, "activeDecks": [1], "sortType": "noteFld", "timeLim": 0, "sortBackwards": false, "addToCur": true, "curDeck": 1, "newBury": true, "newSpread": 0, "dueCounts": true, "curModel": "1454538453789", "collapseTime": 1200}'
+    end
+
+    def self.dconf
+      '{"1": {"name": "Default", "replayq": true, "lapse": {"leechFails": 8, "minInt": 1, "delays": [10], "leechAction": 0, "mult": 0}, "rev": {"perDay": 100, "fuzz": 0.05, "ivlFct": 1, "maxIvl": 36500, "ease4": 1.3, "bury": true, "minSpace": 1}, "timer": 0, "maxTaken": 60, "usn": 0, "new": {"perDay": 20, "delays": [1, 10], "separate": true, "ints": [1, 4, 7], "initialFactor": 2500, "bury": true, "order": 1}, "mod": 0, "id": 1, "autoplay": true}}'
+    end
+
+    def self.tags
+      '{}'
+    end
+
+    def self.media
+      '{"1": "_Trompete.wav", "0": "____________C2A0C2A0C2A0C2A0C2A0C2A0privateC2A0C2A0C2A0C2A0C2A027-------------------27__.mp3", "3": "_Guitarre.wav", "2": "_Piano.mp3", "5": "_Flo\u0308te.mp3", "4": "_Trommel.wav", "7": "_ish_1_gb_1.mp3", "6": "_____________+no+smoking+21+27--------------------27+2C2C.mp3"}'
+    end
+  end
+end

data/lib/ankirb/version.rb

@@ -0,0 +1,3 @@
+module Anki
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: ankirb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donald Hutchison
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: base91
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A library that lets you export apkg packaged decks for Anki. Designed
+  to deal with creation / exporting and not much else
+email:
+- git@toastymofo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ankirb.gemspec
+- lib/anki.rb
+- lib/ankirb/anki/deck.rb
+- lib/ankirb/export/apkg.rb
+- lib/ankirb/export/db.rb
+- lib/ankirb/export/defaults.rb
+- lib/ankirb/version.rb
+homepage: https://github.com/rkachowski/anki-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to create Anki decks for loading in an Anki flashcard application
+test_files: []