anki_record 0.1.1 → 0.3.0

data/lib/anki_record/anki_package/database_setup_constants.rb

@@ -0,0 +1,91 @@
+# 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
+
+  ##
+  # 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
+  INSERT_COLLECTION_ANKI_2_COL_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
+
+  ##
+  # 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
+  INSERT_COLLECTION_ANKI_21_COL_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/card/card.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require_relative "../helpers/shared_constants_helper"
+require_relative "../helpers/time_helper"
+require_relative "card_attributes"
+
+module AnkiRecord
+  ##
+  # Card represents an Anki card.
+  class Card
+    include CardAttributes
+    include TimeHelper
+    include SharedConstantsHelper
+
+    def initialize(note:, card_template: nil, card_data: nil) # :nodoc:
+      @note = note
+      if card_template
+        setup_instance_variables_for_new_card(card_template: card_template)
+      elsif card_data
+        setup_instance_variables_from_existing(card_data: card_data)
+      else
+        raise ArgumentError
+      end
+    end
+
+    private
+
+      def setup_instance_variables_for_new_card(card_template:)
+        raise ArgumentError unless @note.note_type == card_template.note_type
+
+        setup_collaborator_object_instance_variables_for_new_card(card_template: card_template)
+        setup_simple_instance_variables_for_new_card
+      end
+
+      def setup_collaborator_object_instance_variables_for_new_card(card_template:)
+        @card_template = card_template
+        @deck = @note.deck
+        @collection = @deck.collection
+      end
+
+      def setup_simple_instance_variables_for_new_card
+        @id = milliseconds_since_epoch
+        @last_modified_timestamp = seconds_since_epoch
+        @usn = NEW_OBJECT_USN
+        %w[type queue due ivl factor reps lapses left odue odid flags].each do |instance_variable_name|
+          instance_variable_set "@#{instance_variable_name}", 0
+        end
+        @data = "{}"
+      end
+
+      def setup_instance_variables_from_existing(card_data:)
+        setup_collaborator_object_instance_variables_from_existing(card_data: card_data)
+        setup_simple_instance_variables_from_existing(card_data: card_data)
+      end
+
+      def setup_collaborator_object_instance_variables_from_existing(card_data:)
+        @collection = note.note_type.collection
+        @deck = collection.find_deck_by id: card_data["did"]
+        @card_template = note.note_type.card_templates.find do |card_template|
+          card_template.ordinal_number == card_data["ord"]
+        end
+      end
+
+      def setup_simple_instance_variables_from_existing(card_data:)
+        @last_modified_timestamp = card_data["mod"]
+        %w[id usn type queue due ivl factor reps lapses left odue odid flags data].each do |instance_variable_name|
+          instance_variable_set "@#{instance_variable_name}", card_data[instance_variable_name]
+        end
+      end
+
+    public
+
+    def save(note_exists_already: false) # :nodoc:
+      note_exists_already ? update_card_in_collection_anki21 : insert_new_card_in_collection_anki21
+    end
+
+    private
+
+      def update_card_in_collection_anki21
+        statement = @collection.anki_package.prepare <<~SQL
+          update cards set nid = ?, did = ?, ord = ?, mod = ?, usn = ?, type = ?,
+                            queue = ?, due = ?, ivl = ?, factor = ?, reps = ?, lapses = ?,
+                            left = ?, odue = ?, odid = ?, flags = ?, data = ? where id = ?
+        SQL
+        statement.execute [@note.id, @deck.id, ordinal_number,
+                           @last_modified_timestamp, @usn, @type, @queue,
+                           @due, @ivl, @factor, @reps,
+                           @lapses, @left, @odue, @odid, @flags, @data, @id]
+      end
+
+      def insert_new_card_in_collection_anki21
+        statement = @collection.anki_package.prepare <<~SQL
+          insert into cards (id, nid, did, ord,
+                            mod, usn, type, queue,
+                            due, ivl, factor, reps,
+                            lapses, left, odue, odid, flags, data)
+                      values (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)
+        SQL
+        statement.execute [@id, @note.id, @deck.id, ordinal_number,
+                           @last_modified_timestamp, @usn, @type, @queue,
+                           @due, @ivl, @factor, @reps, @lapses, @left, @odue, @odid, @flags, @data]
+      end
+
+      def ordinal_number
+        @card_template&.ordinal_number
+      end
+  end
+end

data/lib/anki_record/card/card_attributes.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # Module with the Card class's attribute readers, writers, and accessors.
+  module CardAttributes
+    ##
+    # The card's note object.
+    attr_reader :note
+
+    ##
+    # The card's deck object.
+    attr_reader :deck
+
+    ##
+    # The card's collection object.
+    attr_reader :collection
+
+    ##
+    # The card's card template object.
+    attr_reader :card_template
+
+    ##
+    # The card's id.
+    #
+    # This is also the number of milliseconds since the 1970 epoch at which the card was created.
+    attr_reader :id
+
+    ##
+    # The number of seconds since the 1970 epoch at which the card was last modified.
+    attr_reader :last_modified_timestamp
+
+    ##
+    # The card's update sequence number.
+    attr_reader :usn
+
+    attr_reader :type, :queue, :due, :ivl, :factor, :reps, :lapses, :left, :odue, :odid, :flags, :data
+  end
+end

data/lib/anki_record/{card_template.rb → card_template/card_template.rb}

@@ -1,44 +1,14 @@
 # frozen_string_literal: true
 
-require "pry"
-
-# TODO: All instance variables should at least be readable
+require_relative "card_template_attributes"
 
 module AnkiRecord
   ##
-  # CardTemplate represents a card template of an Anki note type
+  # CardTemplate represents a card template of an Anki note type.
   class CardTemplate
-    ##
-    # The name of this card template
-    attr_accessor :name
-
-    ##
-    # The question format
-    attr_accessor :question_format
-
-    ##
-    # The answer format
-    attr_accessor :answer_format
-
-    ##
-    # The font style shown for this card template in the browser
-    attr_accessor :browser_font_style
-
-    ##
-    # The font size used for this card template in the browser
-    attr_accessor :browser_font_size
-
-    ##
-    # The note type that this card template belongs to
-    attr_reader :note_type
-
-    ##
-    # 0 for the first card template of the note type, 1 for the second, etc.
-    attr_reader :ordinal_number
+    include CardTemplateAttributes
 
-    ##
-    # Instantiates a new card template called +name+ for the given note type
-    #
+    # Instantiates a new card template with name +name+ for the note type +note_type+.
     def initialize(note_type:, name: nil, args: nil)
       raise ArgumentError unless (name && args.nil?) || (args && args["name"])
 
@@ -48,6 +18,21 @@ module AnkiRecord
       else
         setup_card_template_instance_variables(name: name)
       end
+
+      @note_type.add_card_template self
+    end
+
+    def to_h # :nodoc:
+      {
+        name: @name,
+        ord: @ordinal_number,
+        qfmt: @question_format, afmt: @answer_format,
+        bqfmt: @bqfmt,
+        bafmt: @bafmt,
+        did: @deck_id,
+        bfont: @browser_font_style,
+        bsize: @browser_font_size
+      }
     end
 
     private
@@ -66,7 +51,7 @@ module AnkiRecord
 
       def setup_card_template_instance_variables(name:)
         @name =  name
-        @ordinal_number = @note_type.templates.length
+        @ordinal_number = @note_type.card_templates.length
         @question_format = ""
         @answer_format = ""
         @bqfmt =  ""
@@ -75,17 +60,5 @@ module AnkiRecord
         @browser_font_style = ""
         @browser_font_size = 0
       end
-
-    public
-
-    ##
-    # Returns the field names that are allowed in the answer format and question format
-    #
-    # These are the field_name values in {{field_name}} in those formats.
-    #
-    # They are equivalent to the names of the fields of the template's note type.
-    def allowed_field_names
-      @note_type.fields.map(&:name)
-    end
   end
 end

data/lib/anki_record/card_template/card_template_attributes.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # Module with the CardTemplate class's attribute readers, writers, and accessors.
+  module CardTemplateAttributes
+    ##
+    # The card template's name.
+    attr_accessor :name
+
+    ##
+    # The card template's font style in the browser.
+    attr_accessor :browser_font_style
+
+    ##
+    # The card template's font size used in the browser.
+    attr_accessor :browser_font_size
+
+    ##
+    # The card template's question format.
+    attr_reader :question_format
+
+    ##
+    # Sets the question format of the card template.
+    #
+    # Raises an ArgumentError if the specified format attempts to use invalid fields.
+    def question_format=(format)
+      fields_in_specified_format = format.scan(/{{.+?}}/).map do |capture|
+        capture.chomp("}}").reverse.chomp("{{").reverse
+      end
+      if fields_in_specified_format.any? do |field_name|
+        !note_type.allowed_card_template_question_format_field_names.include?(field_name)
+      end
+        raise ArgumentError, "You tried to use a field that the note type does not have."
+      end
+
+      @question_format = format
+    end
+
+    ##
+    # The card template's answer format.
+    attr_reader :answer_format
+
+    ##
+    # Sets the answer format of the card template.
+    #
+    # Raises an ArgumentError if the specified format attempts to use invalid fields.
+    def answer_format=(format)
+      fields_in_specified_format = format.scan(/{{.+?}}/).map do |capture|
+        capture.chomp("}}").reverse.chomp("{{").reverse
+      end
+      if fields_in_specified_format.any? do |field_name|
+        !note_type.allowed_card_template_answer_format_field_names.include?(field_name)
+      end
+        raise ArgumentError, "You tried to use a field that the note type does not have."
+      end
+
+      @answer_format = format
+    end
+
+    ##
+    # The card template's note type object.
+    attr_reader :note_type
+
+    ##
+    # 0 for the first card template of the note type, 1 for the second, etc.
+    attr_reader :ordinal_number
+  end
+end

data/lib/anki_record/collection/collection.rb

@@ -0,0 +1,180 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "../deck/deck"
+require_relative "../deck_options_group/deck_options_group"
+require_relative "../helpers/data_query_helper"
+require_relative "../helpers/time_helper"
+require_relative "../note_type/note_type"
+require_relative "collection_attributes"
+
+module AnkiRecord
+  ##
+  # Collection represents the single record in the Anki collection.anki21 database's `col` table.
+  # The note types, decks, and deck options groups data are contained within this record.
+  class Collection
+    include AnkiRecord::DataQueryHelper
+    include AnkiRecord::TimeHelper
+    include AnkiRecord::CollectionAttributes
+
+    def initialize(anki_package:) # :nodoc:
+      setup_collection_instance_variables(anki_package: anki_package)
+    end
+
+    def add_note_type(note_type) # :nodoc:
+      raise ArgumentError unless note_type.instance_of?(AnkiRecord::NoteType)
+
+      existing_note_type = nil
+      @note_types.each do |nt|
+        existing_note_type = nt if nt.id == note_type.id
+      end
+      @note_types.delete(existing_note_type) if existing_note_type
+
+      @note_types << note_type
+    end
+
+    def add_deck(deck) # :nodoc:
+      raise ArgumentError unless deck.instance_of?(AnkiRecord::Deck)
+
+      @decks << deck
+    end
+
+    def add_deck_options_group(deck_options_group) # :nodoc:
+      raise ArgumentError unless deck_options_group.instance_of?(AnkiRecord::DeckOptionsGroup)
+
+      @deck_options_groups << deck_options_group
+    end
+
+    ##
+    # Returns the collection's note type object found by either +name+ or +id+, or nil if it is not found.
+    def find_note_type_by(name: nil, id: nil)
+      if (id && name) || (id.nil? && name.nil?)
+        raise ArgumentError,
+              "You must pass either an id or name keyword argument."
+      end
+
+      name ? find_note_type_by_name(name: name) : find_note_type_by_id(id: id)
+    end
+
+    private
+
+      def find_note_type_by_name(name:)
+        note_types.find { |note_type| note_type.name == name }
+      end
+
+      def find_note_type_by_id(id:)
+        note_types.find { |note_type| note_type.id == id }
+      end
+
+    public
+
+    ##
+    # Returns the collection's deck object found by either +name+ or +id+, or nil if it is not found.
+    def find_deck_by(name: nil, id: nil)
+      if (id && name) || (id.nil? && name.nil?)
+        raise ArgumentError,
+              "You must pass either an id or name keyword argument."
+      end
+
+      name ? find_deck_by_name(name: name) : find_deck_by_id(id: id)
+    end
+
+    private
+
+      def find_deck_by_name(name:)
+        decks.find { |deck| deck.name == name }
+      end
+
+      def find_deck_by_id(id:)
+        decks.find { |deck| deck.id == id }
+      end
+
+    public
+
+    ##
+    # Returns the collection's deck options group object found by +id+, or nil if it is not found.
+    def find_deck_options_group_by(id:)
+      deck_options_groups.find { |deck_options_group| deck_options_group.id == id }
+    end
+
+    ##
+    # Returns the collection's note object found by +id+, or nil if it is not found.
+    def find_note_by(id:)
+      note_cards_data = note_cards_data_for_note_id sql_able: anki_package, id: id
+      return nil unless note_cards_data
+
+      AnkiRecord::Note.new collection: self, data: note_cards_data
+    end
+
+    def decks_json # :nodoc:
+      JSON.parse(anki_package.prepare("select decks from col;").execute.first["decks"])
+    end
+
+    def models_json # :nodoc:
+      JSON.parse(anki_package.prepare("select models from col;").execute.first["models"])
+    end
+
+    def copy_over_existing(col_record:) # :nodoc:
+      @col_record = col_record
+      setup_simple_collaborator_objects
+      setup_custom_collaborator_objects
+      remove_instance_variable(:@col_record)
+    end
+
+    private
+
+      def setup_collection_instance_variables(anki_package:)
+        @anki_package = anki_package
+        setup_simple_collaborator_objects
+        setup_custom_collaborator_objects
+        remove_instance_variable(:@col_record)
+      end
+
+      def col_record
+        @col_record ||= @anki_package.prepare("select * from col").execute.first
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def setup_simple_collaborator_objects
+        @id = col_record["id"]
+        @created_at_timestamp = col_record["crt"]
+        @last_modified_timestamp = col_record["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"])
+        @tags = JSON.parse(col_record["tags"])
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      def setup_custom_collaborator_objects
+        setup_note_type_collaborators
+        setup_deck_options_groups_collaborators
+        setup_deck_collaborators
+      end
+
+      def setup_note_type_collaborators
+        @note_types = []
+        JSON.parse(col_record["models"]).values.map do |model_hash|
+          NoteType.new(collection: self, args: model_hash)
+        end
+      end
+
+      def setup_deck_collaborators
+        @decks = []
+        JSON.parse(col_record["decks"]).values.map do |deck_hash|
+          Deck.new(collection: self, args: deck_hash)
+        end
+      end
+
+      def setup_deck_options_groups_collaborators
+        @deck_options_groups = []
+        JSON.parse(col_record["dconf"]).values.map do |dconf_hash|
+          DeckOptionsGroup.new(collection: self, args: dconf_hash)
+        end
+      end
+  end
+end

data/lib/anki_record/collection/collection_attributes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  ##
+  # Module with the Collection class's attribute readers, writers, and accessors.
+  module CollectionAttributes
+    ##
+    # The collection's Anki package object.
+    attr_reader :anki_package
+
+    ##
+    # The collection's id, which is also the id of the col record in the collection.anki21 database (usually 1).
+    attr_reader :id
+
+    ##
+    # The number of milliseconds since the 1970 epoch when the collection record was created.
+    attr_reader :created_at_timestamp
+
+    ##
+    # The number of milliseconds since the 1970 epoch at which the collection record was last modified.
+    attr_reader :last_modified_timestamp
+
+    ##
+    # The collection's note type objects as an array.
+    attr_reader :note_types
+
+    ##
+    # The collection's deck objects as an array
+    attr_reader :decks
+
+    ##
+    # The collection's deck option group objects as an array.
+    attr_reader :deck_options_groups
+  end
+end