anki_record 0.1.1

data/lib/anki_record/collection.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "pry"
+require "json"
+
+require_relative "deck"
+require_relative "deck_options_group"
+require_relative "helpers/time_helper"
+require_relative "note_type"
+
+module AnkiRecord
+  ##
+  # Collection represents the single record in the Anki database `col` table
+  class Collection
+    include AnkiRecord::TimeHelper
+
+    ##
+    # An array of the collection's note type objects
+    attr_reader :note_types
+
+    ##
+    # An array of the collection's deck objects
+    attr_reader :decks
+
+    ##
+    # Instantiates the collection object for the +anki_package+
+    def initialize(anki_package:)
+      setup_collection_instance_variables(anki_package: anki_package)
+    end
+
+    private
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_collection_instance_variables(anki_package:)
+        @anki_package = anki_package
+        @id = col_record["id"]
+        @crt = col_record["crt"]
+        @last_modified_time = (mod = col_record["mod"]).zero? ? milliseconds_since_epoch : mod
+        @scm = col_record["scm"]
+        @ver = col_record["ver"]
+        @dty = col_record["dty"]
+        @usn = col_record["usn"]
+        @ls = col_record["ls"]
+        @configuration = JSON.parse(col_record["conf"])
+        @note_types = JSON.parse(col_record["models"]).values.map do |model_hash|
+          NoteType.new(collection: self, args: model_hash)
+        end
+        @decks = JSON.parse(col_record["decks"]).values.map do |deck_hash|
+          Deck.new(collection: self, args: deck_hash)
+        end
+        @deck_option_groups = JSON.parse(col_record["dconf"]).values.map do |dconf_hash|
+          DeckOptionsGroup.new(collection: self, args: dconf_hash)
+        end
+        @tags = JSON.parse(col_record["tags"])
+        remove_instance_variable(:@col_record)
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      def col_record
+        @col_record ||= @anki_package.execute("select * from col;").first
+      end
+  end
+end

data/lib/anki_record/db/anki_schema_definition.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ANKI_SCHEMA_DEFINITION = <<~SQL # :nodoc:
+    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,
+      guid text NOT NULL,
+      mid integer NOT NULL,
+      mod integer NOT NULL,
+      usn integer NOT NULL,
+      tags text NOT NULL,
+      flds text NOT NULL,
+      sfld integer NOT NULL,
+      csum integer NOT NULL,
+      flags integer NOT NULL,
+      data text NOT NULL
+    );
+    CREATE TABLE cards (
+      id integer PRIMARY KEY,
+      nid integer NOT NULL,
+      did integer NOT NULL,
+      ord integer NOT NULL,
+      mod integer NOT NULL,
+      usn integer NOT NULL,
+      type integer NOT NULL,
+      queue integer NOT NULL,
+      due integer NOT NULL,
+      ivl integer NOT NULL,
+      factor integer NOT NULL,
+      reps integer NOT NULL,
+      lapses integer NOT NULL,
+      left integer NOT NULL,
+      odue integer NOT NULL,
+      odid integer NOT NULL,
+      flags integer NOT NULL,
+      data text NOT NULL
+    );
+    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 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);
+    CREATE TABLE graves (
+      usn integer NOT NULL,
+      oid integer NOT NULL,
+      type integer NOT NULL
+    );
+  SQL
+end

data/lib/anki_record/db/clean_collection21_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # This is the SQL insert statement (as a Ruby string/here document) for the
+  # default col record in the collection.anki21 database exported from a new Anki 2.1.54 profile
+  CLEAN_COLLECTION_21_RECORD = <<~SQL
+    INSERT INTO col VALUES(1,1676883600,0,1676902364657,11,0,0,0,'{"activeDecks":[1],"curDeck":1,"nextPos":1,"schedVer":2,"sortType":"noteFld","estTimes":true,"collapseTime":1200,"dayLearnFirst":false,"curModel":1676902364661,"sortBackwards":false,"newSpread":0,"creationOffset":300,"timeLim":0,"addToCur":true,"dueCounts":true}','{"1676902364664":{"id":1676902364664,"name":"Basic (type in the answer)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}\\n\\n{{type:Back}}","afmt":"{{Front}}\\n\\n<hr id=answer>\\n\\n{{type:Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0,1]]]},"1676902364663":{"id":1676902364663,"name":"Basic (optional reversed card)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0},{"name":"Card 2","ord":1,"qfmt":"{{#Add Reverse}}{{Back}}{{/Add Reverse}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Front}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Add Reverse","ord":2,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]],[1,"all",[1,2]]]},"1676902364665":{"id":1676902364665,"name":"Cloze","type":1,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Cloze","ord":0,"qfmt":"{{cloze:Text}}","afmt":"{{cloze:Text}}<br>\\n{{Back Extra}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Text","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back Extra","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n.cloze {\\n    font-weight: bold;\\n    color: blue;\\n}\\n.nightMode .cloze {\\n    color: lightblue;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]]]},"1676902364661":{"id":1676902364661,"name":"Basic","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]]]},"1676902364662":{"id":1676902364662,"name":"Basic (and reversed card)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0},{"name":"Card 2","ord":1,"qfmt":"{{Back}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Front}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]],[1,"any",[1]]]}}','{"1":{"id":1,"mod":0,"name":"Default","usn":0,"lrnToday":[0,0],"revToday":[0,0],"newToday":[0,0],"timeToday":[0,0],"collapsed":true,"browserCollapsed":true,"desc":"","dyn":0,"conf":1,"extendNew":0,"extendRev":0}}','{"1":{"id":1,"mod":0,"name":"Default","usn":0,"maxTaken":60,"autoplay":true,"timer":0,"replayq":true,"new":{"bury":false,"delays":[1.0,10.0],"initialFactor":2500,"ints":[1,4,0],"order":1,"perDay":20},"rev":{"bury":false,"ease4":1.3,"ivlFct":1.0,"maxIvl":36500,"perDay":200,"hardFactor":1.2},"lapse":{"delays":[10.0],"leechAction":1,"leechFails":8,"minInt":1,"mult":0.0},"dyn":false,"newMix":0,"newPerDayMinimum":0,"interdayLearningMix":0,"reviewOrder":0,"newSortOrder":0,"newGatherPriority":0,"buryInterdayLearning":false}}','{}');
+  SQL
+end

data/lib/anki_record/db/clean_collection2_record.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # This is the SQL insert statement (as a Ruby string/here document) for the
+  # default col record in the collection.anki2 database exported from a new Anki 2.1.54 profile
+  CLEAN_COLLECTION_2_RECORD = <<~SQL
+    INSERT INTO col VALUES(1,1676883600,1676902390012,1676902390005,11,0,0,0,'{"addToCur":true,"_deck_1_lastNotetype":1676902390008,"nextPos":2,"sortType":"noteFld","newSpread":0,"schedVer":2,"collapseTime":1200,"estTimes":true,"curDeck":1,"creationOffset":300,"dayLearnFirst":false,"timeLim":0,"activeDecks":[1],"sortBackwards":false,"_nt_1676902390008_lastDeck":1,"curModel":1676902390008,"dueCounts":true}','{"1676902390010":{"id":1676902390010,"name":"Basic (optional reversed card)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0},{"name":"Card 2","ord":1,"qfmt":"{{#Add Reverse}}{{Back}}{{/Add Reverse}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Front}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Add Reverse","ord":2,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]],[1,"all",[1,2]]]},"1676902390009":{"id":1676902390009,"name":"Basic (and reversed card)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0},{"name":"Card 2","ord":1,"qfmt":"{{Back}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Front}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]],[1,"any",[1]]]},"1676902390008":{"id":1676902390008,"name":"Basic","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}","afmt":"{{FrontSide}}\\n\\n<hr id=answer>\\n\\n{{Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]]]},"1676902390011":{"id":1676902390011,"name":"Basic (type in the answer)","type":0,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Card 1","ord":0,"qfmt":"{{Front}}\\n\\n{{type:Back}}","afmt":"{{Front}}\\n\\n<hr id=answer>\\n\\n{{type:Back}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Front","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0,1]]]},"1676902390012":{"id":1676902390012,"name":"Cloze","type":1,"mod":0,"usn":0,"sortf":0,"did":null,"tmpls":[{"name":"Cloze","ord":0,"qfmt":"{{cloze:Text}}","afmt":"{{cloze:Text}}<br>\\n{{Back Extra}}","bqfmt":"","bafmt":"","did":null,"bfont":"","bsize":0}],"flds":[{"name":"Text","ord":0,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""},{"name":"Back Extra","ord":1,"sticky":false,"rtl":false,"font":"Arial","size":20,"description":""}],"css":".card {\\n    font-family: arial;\\n    font-size: 20px;\\n    text-align: center;\\n    color: black;\\n    background-color: white;\\n}\\n.cloze {\\n    font-weight: bold;\\n    color: blue;\\n}\\n.nightMode .cloze {\\n    color: lightblue;\\n}\\n","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","latexPost":"\\\\end{document}","latexsvg":false,"req":[[0,"any",[0]]]}}','{"1":{"id":1,"mod":0,"name":"Default","usn":0,"lrnToday":[0,0],"revToday":[0,0],"newToday":[0,0],"timeToday":[0,0],"collapsed":true,"browserCollapsed":true,"desc":"","dyn":0,"conf":1,"extendNew":0,"extendRev":0}}','{"1":{"id":1,"mod":0,"name":"Default","usn":0,"maxTaken":60,"autoplay":true,"timer":0,"replayq":true,"new":{"bury":false,"delays":[1.0,10.0],"initialFactor":2500,"ints":[1,4,0],"order":1,"perDay":20},"rev":{"bury":false,"ease4":1.3,"ivlFct":1.0,"maxIvl":36500,"perDay":200,"hardFactor":1.2},"lapse":{"delays":[10.0],"leechAction":1,"leechFails":8,"minInt":1,"mult":0.0},"dyn":false,"newMix":0,"newPerDayMinimum":0,"interdayLearningMix":0,"reviewOrder":0,"newSortOrder":0,"newGatherPriority":0,"buryInterdayLearning":false}}','{}');
+  SQL
+end

data/lib/anki_record/deck.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "pry"
+
+require_relative "helpers/shared_constants_helper"
+require_relative "helpers/time_helper"
+
+# TODO: All instance variables should at least be readable
+
+module AnkiRecord
+  ##
+  # Deck represents an Anki deck
+  class Deck
+    include SharedConstantsHelper
+    include TimeHelper
+
+    DEFAULT_DECK_TODAY_ARRAY = [0, 0].freeze
+    DEFAULT_COLLAPSED = false
+
+    private_constant :DEFAULT_DECK_TODAY_ARRAY, :DEFAULT_COLLAPSED
+
+    ##
+    # The name of the deck
+    attr_accessor :name
+
+    ##
+    # The description of the deck
+    attr_accessor :description
+
+    ##
+    # One of many attributes that is currently read-only and needs to be documented.
+    attr_reader :collection, :id, :last_modified_time, :deck_options_group_id
+
+    ##
+    # Instantiate a new Deck
+    def initialize(collection:, name: nil, args: nil)
+      raise ArgumentError unless (name && args.nil?) || (args && args["name"])
+
+      @collection = collection
+      if args
+        setup_deck_instance_variables_from_existing(args: args)
+      else
+        setup_deck_instance_variables(name: name)
+      end
+    end
+
+    private
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_deck_instance_variables_from_existing(args:)
+        @id = args["id"]
+        @last_modified_time = args["mod"]
+        @name = args["name"]
+        @usn = args["usn"]
+        @learn_today = args["lrnToday"]
+        @review_today = args["revToday"]
+        @new_today = args["newToday"]
+        @time_today = args["timeToday"]
+        @collapsed_in_main_window = args["collapsed"]
+        @collapsed_in_browser = args["browserCollapsed"]
+        @description = args["desc"]
+        @dyn = args["dyn"]
+        @deck_options_group_id = args["conf"]
+        @extend_new = args["extendNew"]
+        @extend_review = args["extendRev"]
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      # rubocop:disable Metrics/MethodLength
+      def setup_deck_instance_variables(name:)
+        @id = milliseconds_since_epoch
+        @last_modified_time = seconds_since_epoch
+        @name = name
+        @usn = NEW_OBJECT_USN
+        @learn_today = @review_today = @new_today = @time_today = DEFAULT_DECK_TODAY_ARRAY
+        @collapsed_in_main_window = DEFAULT_COLLAPSED
+        @collapsed_in_browser = DEFAULT_COLLAPSED
+        @description = ""
+        @dyn = NON_FILTERED_DECK_DYN
+        @deck_options_group_id = nil # TODO
+        @extend_new = 0
+        @extend_review = 0
+      end
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/anki_record/deck_options_group.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require "pry"
+
+require_relative "helpers/shared_constants_helper"
+require_relative "helpers/time_helper"
+
+module AnkiRecord
+  ##
+  # Represents the set of options that can be applied to a deck
+  class DeckOptionsGroup
+    include SharedConstantsHelper
+    include TimeHelper
+
+    ##
+    # The name of the options group
+    attr_accessor :name
+
+    ##
+    # One of many attributes that is currently read-only and needs to be documented.
+    attr_reader :collection, :id, :last_modified_time, :usn, :max_taken, :auto_play, :timer, :replay_question,
+                :new_options, :review_options, :lapse_options, :dyn, :new_mix, :new_per_day_minimum,
+                :interday_learning_mix, :review_order, :new_sort_order, :new_gather_priority, :bury_interday_learning
+
+    ##
+    # Instantiates a new deck options group called +name+ with defaults
+    def initialize(collection:, name: nil, args: nil)
+      # TODO: extract this check to a shared helper
+      raise ArgumentError unless (name && args.nil?) || (args && args["name"])
+
+      @collection = collection
+
+      if args
+        setup_deck_options_group_instance_variables_from_existing(args: args)
+      else
+        setup_deck_options_group_instance_variables(name: name)
+      end
+    end
+
+    private
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_deck_options_group_instance_variables_from_existing(args:)
+        @id = args["id"]
+        @last_modified_time = args["mod"]
+        @name = args["name"]
+        @usn = args["usn"]
+        @max_taken = args["maxTaken"]
+        @auto_play = args["autoplay"]
+        @timer = args["timer"]
+        @replay_question = args["true"]
+        @new_options = args["new"]
+        @review_options = args["rev"]
+        @lapse_options = args["lapse"]
+        @dyn = args["dyn"]
+        @new_mix = args["newMix"]
+        @new_per_day_minimum = args["newPerDayMinimum"]
+        @interday_learning_mix = args["interdayLearningMix"]
+        @review_order = args["reviewOrder"]
+        @new_sort_order = args["new_sort_order"]
+        @new_gather_priority = args["newGatherPriority"]
+        @bury_interday_learning = args["buryInterdayLearning"]
+      end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_deck_options_group_instance_variables(name:)
+        @id = milliseconds_since_epoch
+        @last_modified_time = seconds_since_epoch
+        @name = name
+        @usn = NEW_OBJECT_USN
+        @max_taken = 60
+        @auto_play = true
+        @timer = 0
+        @replay_question = true
+        @new_options = { bury: false, delays: [1.0, 10.0], initialFactor: 2500, ints: [1, 4, 0], order: 1, perDay: 20 }
+        @review_options = { bury: false, ease4: 1.3, ivlFct: 1.0, maxIvl: 36_500, perDay: 200, hardFactor: 1.2 }
+        @lapse_options = { delays: [10.0], leechAction: 1, leechFails: 8, minInt: 1, mult: 0.0 }
+        @dyn = NON_FILTERED_DECK_DYN
+        @new_mix = 0
+        @new_per_day_minimum = 0
+        @interday_learning_mix = 0
+        @review_order = 0
+        @new_sort_order = 0
+        @new_gather_priority = 0
+        @bury_interday_learning = false
+      end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/anki_record/helpers/shared_constants_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # Helper module to hold the constants used by multiple classes
+  module SharedConstantsHelper
+    NEW_OBJECT_USN = -1
+    NON_FILTERED_DECK_DYN = 0
+    private_constant :NEW_OBJECT_USN, :NON_FILTERED_DECK_DYN
+  end
+end

data/lib/anki_record/helpers/time_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "date"
+
+module AnkiRecord
+  ##
+  # Helper module to calculate integer time values since the 1970 epoch
+  #
+  # Specifically, the time that has passed since 00:00:00 UTC Jan 1 1970
+  module TimeHelper
+    ##
+    # Return the number of milliseconds since the 1970 epoch
+    def milliseconds_since_epoch
+      DateTime.now.strftime("%Q").to_i
+    end
+
+    ##
+    # Return the number of seconds since the 1970 epoch
+    def seconds_since_epoch
+      Time.now.to_i
+    end
+  end
+end

data/lib/anki_record/note_field.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+# TODO: raise exceptions on invalid assignment to prevent downstream errors and specs for the writeable attributes
+# TODO: All instance variables should at least be readable
+
+require "pry"
+
+module AnkiRecord
+  ##
+  # NoteField represents a field of an Anki note type
+  class NoteField
+    DEFAULT_FIELD_FONT_STYLE = "Arial"
+    DEFAULT_FIELD_FONT_SIZE = 20
+    DEFAULT_FIELD_DESCRIPTION = ""
+    private_constant :DEFAULT_FIELD_FONT_STYLE, :DEFAULT_FIELD_FONT_SIZE, :DEFAULT_FIELD_DESCRIPTION
+
+    ##
+    # The name of the note field
+    attr_accessor :name
+
+    ##
+    # One of many attributes that is readable and writeable but needs to be documented
+    attr_accessor :sticky, :right_to_left, :font_style, :font_size, :description
+
+    ##
+    # One of many attributes that is currently read-only and needs to be documented.
+    attr_reader :note_type, :ordinal_number
+
+    ##
+    # Instantiates a new field for the given note type
+    def initialize(note_type:, name: nil, args: nil)
+      raise ArgumentError unless (name && args.nil?) || (args && args["name"])
+
+      @note_type = note_type
+      if args
+        setup_note_field_instance_variables_from_existing(args: args)
+      else
+        setup_note_field_instance_variables(name: name)
+      end
+    end
+
+    private
+
+      def setup_note_field_instance_variables_from_existing(args:)
+        @name = args["name"]
+        @ordinal_number = args["ord"]
+        @sticky = args["sticky"]
+        @right_to_left = args["rtl"]
+        @font_style = args["font"]
+        @font_size = args["size"]
+      end
+
+      def setup_note_field_instance_variables(name:)
+        @name = name
+        @ordinal_number = @note_type.fields.length
+        @sticky = false
+        @right_to_left = false
+        @font_style = DEFAULT_FIELD_FONT_STYLE
+        @font_size = DEFAULT_FIELD_FONT_SIZE
+        @description = DEFAULT_FIELD_DESCRIPTION
+      end
+  end
+end

data/lib/anki_record/note_type.rb

@@ -0,0 +1,147 @@
+# frozen_string_literal: true
+
+require "pry"
+
+require_relative "card_template"
+require_relative "helpers/shared_constants_helper"
+require_relative "helpers/time_helper"
+require_relative "note_field"
+
+# TODO: All instance variables should at least be readable
+
+module AnkiRecord
+  ##
+  # NoteType represents an Anki note type (also called a model)
+  class NoteType
+    include AnkiRecord::SharedConstantsHelper
+    include AnkiRecord::TimeHelper
+    NEW_NOTE_TYPE_SORT_FIELD = 0
+    private_constant :NEW_NOTE_TYPE_SORT_FIELD
+
+    ##
+    # The name of this note type
+    attr_accessor :name
+
+    ##
+    # true if the note type is a cloze note type and false if it is not
+    attr_accessor :cloze
+
+    ##
+    # One of many attributes that is readable and writeable but needs to be documented
+    attr_accessor :css, :latex_preamble, :latex_postamble, :latex_svg
+
+    ##
+    # One of many attributes that is currently read-only and needs to be documented.
+    attr_reader :id, :templates, :fields, :deck_id
+
+    ##
+    # Instantiates a new note type
+    def initialize(collection:, name: nil, cloze: false, args: nil)
+      raise ArgumentError unless (name && args.nil?) || (args && args["name"])
+
+      @collection = collection
+
+      if args
+        setup_note_type_instance_variables_from_existing(args: args)
+      else
+        setup_note_type_instance_variables(
+          name: name, cloze: cloze
+        )
+      end
+    end
+
+    ##
+    # Create a new field and adds it to this note type's fields
+    #
+    # The field is an instance of AnkiRecord::NoteField
+    def new_note_field(name:)
+      # TODO: Check if name already used by a field in this note type
+      @fields << AnkiRecord::NoteField.new(note_type: self, name: name)
+    end
+
+    ##
+    # Create a new card template and adds it to this note type's templates
+    #
+    # The card template is an instance of AnkiRecord::CardTemplate
+    def new_card_template(name:)
+      # TODO: Check if name already used by a template in this note type
+      @templates << AnkiRecord::CardTemplate.new(note_type: self, name: name)
+    end
+
+    private
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def setup_note_type_instance_variables_from_existing(args:)
+        @id = args["id"]
+        @name = args["name"]
+        @cloze = args["type"] == 1
+        @last_modified_time = args["mod"]
+        @usn = args["usn"]
+        @sort_field = args["sortf"]
+        @deck_id = args["did"]
+        @fields = args["flds"].map { |fld| NoteField.new(note_type: self, args: fld) }
+        @templates = args["tmpls"].map { |tmpl| CardTemplate.new(note_type: self, args: tmpl) }
+        @css = args["css"]
+        @latex_preamble = args["latexPre"]
+        @latex_postamble = args["latexPost"]
+        @latex_svg = args["latexsvg"]
+        @req = args["req"]
+        @tags = args["tags"]
+        @vers = args["vers"]
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      # rubocop:disable Metrics/MethodLength
+      def setup_note_type_instance_variables(name:, cloze:)
+        @id = milliseconds_since_epoch
+        @name = name
+        @cloze = cloze
+        @last_modified_time = seconds_since_epoch
+        @usn = NEW_OBJECT_USN
+        @sort_field = NEW_NOTE_TYPE_SORT_FIELD
+        @deck_id = nil
+        @fields = []
+        @templates = []
+        @css = default_css
+        @latex_preamble = default_latex_preamble
+        @latex_postamble = default_latex_postamble
+        @latex_svg = false
+        @req = nil
+        @tags = []
+        @vers = []
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      # TODO: use constant here
+      def default_css
+        <<-CSS
+        .card {
+          color: black;
+          background-color: transparent;
+          text-align: center;
+        }
+        CSS
+      end
+
+      # TODO: use constant here
+      def default_latex_preamble
+        <<-LATEX_PRE
+        \\documentclass[12pt]{article}
+        \\special{papersize=3in,5in}
+        \\usepackage{amssymb,amsmath}
+        \\pagestyle{empty}
+        \\setlength{\\parindent}{0in}
+        \\begin{document}
+        LATEX_PRE
+      end
+
+      # TODO: use constant here
+      def default_latex_postamble
+        <<-LATEX_POST
+        \\end{document}
+        LATEX_POST
+      end
+  end
+end

data/lib/anki_record/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  VERSION = "0.1.1" # :nodoc:
+end

data/lib/anki_record.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "securerandom"
+require "sqlite3"
+require "zip"
+
+require_relative "anki_record/anki_package"
+require_relative "anki_record/version"
+
+##
+# This module is the namespace for all AnkiRecord classes:
+# - AnkiPackage
+# - CardTemplate
+# - Collection
+# - DeckOptionsGroup
+# - Deck
+# - NoteField
+# - NoteType
+#
+# And modules:
+# - SharedConstantsHelper
+# - TimeHelper
+module AnkiRecord
+  class Error < StandardError; end # :nodoc:
+end