anki_record 0.2.0 → 0.3.1

data/lib/anki_record/card.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-require "pry"
-
-require_relative "helpers/shared_constants_helper"
-require_relative "helpers/time_helper"
-
-module AnkiRecord
-  ##
-  # Card represents an Anki card.
-  class Card
-    include TimeHelper
-    include SharedConstantsHelper
-
-    ##
-    # The note that the card belongs to
-    attr_reader :note
-
-    ##
-    # The card template that the card uses
-    attr_reader :card_template
-
-    ##
-    # The id of the card, which is time it was created as the number of milliseconds since the 1970 epoch
-    attr_reader :id
-
-    ##
-    # The time that the card was last modified as the number of seconds since the 1970 epoch
-    attr_reader :last_modified_time
-
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def initialize(note:, card_template:)
-      raise ArgumentError unless note && card_template && note.note_type == card_template.note_type
-
-      @note = note
-      @apkg = @note.deck.collection.anki_package
-
-      @card_template = card_template
-
-      @id = milliseconds_since_epoch
-      @last_modified_time = seconds_since_epoch
-      @usn = NEW_OBJECT_USN
-      @type = 0
-      @queue = 0
-      @due = 0
-      @ivl = 0
-      @factor = 0
-      @reps = 0
-      @lapses = 0
-      @left = 0
-      @odue = 0
-      @odid = 0
-      @flags = 0
-      @data = {}
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-
-    ##
-    # Saves the card to the collection.anki21 database
-    def save
-      @apkg.execute <<~SQL
-        insert into cards (id, nid, did, ord,
-                          mod, usn, type, queue,
-                          due, ivl, factor, reps,
-                          lapses, left, odue, odid, flags, data)
-                    values ('#{@id}', '#{@note.id}', '#{@note.deck.id}', '#{@card_template.ordinal_number}',
-                           '#{@last_modified_time}', '#{@usn}', '#{@type}', '#{@queue}',
-                           '#{@due}', '#{@ivl}', '#{@factor}', '#{@reps}',
-                           '#{@lapses}', '#{@left}', '#{@odue}', '#{@odid}', '#{@flags}', '#{@data}')
-      SQL
-    end
-  end
-end

data/lib/anki_record/card_template.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require "pry"
-
-# TODO: All instance variables should at least be readable
-
-module AnkiRecord
-  ##
-  # CardTemplate represents a card template of an Anki note type
-  class CardTemplate
-    ##
-    # The name of the card template
-    attr_accessor :name
-
-    ##
-    # The font style shown for the card template in the browser
-    attr_accessor :browser_font_style
-
-    ##
-    # The font size used for the card template in the browser
-    attr_accessor :browser_font_size
-
-    ##
-    # The question format of the card template
-    attr_reader :question_format
-
-    ##
-    # Sets the question format and raises an ArgumentError if the specified format uses invalid fields
-    def question_format=(format)
-      fields_in_specified_format = format.scan(/{{.+?}}/).map do |capture|
-        capture.chomp("}}").reverse.chomp("{{").reverse
-      end
-      raise ArgumentError if fields_in_specified_format.any? do |field_name|
-                               !note_type.allowed_card_template_question_format_field_names.include?(field_name)
-                             end
-
-      @question_format = format
-    end
-
-    ##
-    # The answer format of the card template
-    attr_reader :answer_format
-
-    ##
-    # Sets the answer format and raises an ArgumentError if the specified format uses invalid fields
-    def answer_format=(format)
-      fields_in_specified_format = format.scan(/{{.+?}}/).map do |capture|
-        capture.chomp("}}").reverse.chomp("{{").reverse
-      end
-      raise ArgumentError if fields_in_specified_format.any? do |field_name|
-                               !note_type.allowed_card_template_answer_format_field_names.include?(field_name)
-                             end
-
-      @answer_format = format
-    end
-
-    ##
-    # The note type that the 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
-
-    ##
-    # Instantiates a new card template called +name+ 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_card_template_instance_variables_from_existing(args: args)
-      else
-        setup_card_template_instance_variables(name: name)
-      end
-    end
-
-    private
-
-      def setup_card_template_instance_variables_from_existing(args:)
-        @name = args["name"]
-        @ordinal_number = args["ord"]
-        @question_format = args["qfmt"]
-        @answer_format = args["afmt"]
-        @bqfmt = args["bqfmt"]
-        @bafmt = args["bafmt"]
-        @deck_id = args["did"]
-        @browser_font_style = args["bfont"]
-        @browser_font_size = args["bsize"]
-      end
-
-      def setup_card_template_instance_variables(name:)
-        @name =  name
-        @ordinal_number = @note_type.card_templates.length
-        @question_format = ""
-        @answer_format = ""
-        @bqfmt =  ""
-        @bafmt =  ""
-        @deck_id = nil
-        @browser_font_style = ""
-        @browser_font_size = 0
-      end
-  end
-end

data/lib/anki_record/collection.rb

@@ -1,105 +0,0 @@
-# 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
-
-    ##
-    # The instance of AnkiRecord::AnkiPackage that this collection object belongs to
-    attr_reader :anki_package
-
-    ##
-    # The id attribute will become, or is the same as, the primary key id of this record in the database
-    #
-    # Since there should be only one col record, this attribute should be 1
-    attr_reader :id
-
-    ##
-    # The time in milliseconds that the col record was created since the 1970 epoch
-    attr_reader :creation_timestamp
-
-    ##
-    # The last time that the col record was modified in milliseconds since the 1970 epoch
-    attr_reader :last_modified_time
-
-    ##
-    # An array of the collection's note type objects, which are instances of AnkiRecord::NoteType
-    attr_reader :note_types
-
-    ##
-    # An array of the collection's deck objects, which are instances of AnkiRecord::Deck
-    attr_reader :decks
-
-    ##
-    # An array of the collection's deck options group objects, which are instances of AnkiRecord::DeckOptionsGroup
-    #
-    # These represent groups of settings that can be applied to a deck.
-    attr_reader :deck_options_groups
-
-    ##
-    # Instantiates the collection object for the +anki_package+
-    #
-    # The collection object represents the single record of the collection.anki21 database col table.
-    #
-    # This record stores the note types used by the notes and the decks that they belong to.
-    def initialize(anki_package:)
-      setup_collection_instance_variables(anki_package: anki_package)
-    end
-
-    ##
-    # Find one of the collection's note types by name
-    def find_note_type_by(name: nil)
-      note_types.find { |note_type| note_type.name == name }
-    end
-
-    ##
-    # Find one of the collection's decks by name
-    def find_deck_by(name: nil)
-      decks.find { |deck| deck.name == name }
-    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"]
-        @creation_timestamp = col_record["crt"]
-        @last_modified_time = 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"])
-        @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_options_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

@@ -1,77 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,10 +0,0 @@
-# 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

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-require "pry"
-
-require_relative "helpers/shared_constants_helper"
-require_relative "helpers/time_helper"
-
-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 collection object that the deck belongs to
-    attr_reader :collection
-
-    ##
-    # The name of the deck
-    attr_accessor :name
-
-    ##
-    # The description of the deck
-    attr_accessor :description
-
-    ##
-    # The id of the deck
-    attr_reader :id
-
-    ##
-    # The last time the deck was modified in number of seconds since the epoch
-    #
-    # TODO: is this really supposed to be seconds? Should it be milliseconds?
-    attr_reader :last_modified_time
-
-    ##
-    # The id of the eck options/settings group that is applied to the deck
-    attr_reader :deck_options_group_id
-
-    ##
-    # Instantiates a new Deck object
-    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: Set id to the default deck options group?
-        # TODO: alternatively, if this is nil when the deck is saved, it can be set to the default options group id
-        @extend_new = 0
-        @extend_review = 0
-      end
-    # rubocop:enable Metrics/MethodLength
-  end
-end

data/lib/anki_record/note.rb

@@ -1,135 +0,0 @@
-# frozen_string_literal: true
-
-require "pry"
-require "securerandom"
-
-require_relative "helpers/checksum_helper"
-require_relative "helpers/time_helper"
-
-module AnkiRecord
-  ##
-  # Note represents an Anki note
-  class Note
-    include ChecksumHelper
-    include TimeHelper
-    include SharedConstantsHelper
-
-    ##
-    # The id of the note
-    attr_reader :id
-
-    ##
-    # The globally unique id of the note
-    attr_reader :guid
-
-    ##
-    # The last time the note was modified in seconds since the 1970 epoch
-    attr_reader :last_modified_time
-
-    ##
-    # The tags applied to the note
-    #
-    # TODO: a setter method for the tags of the note
-    attr_reader :tags
-
-    ##
-    # The deck that the note's cards will be put into when saved
-    attr_reader :deck
-
-    ##
-    # The note type of the note
-    attr_reader :note_type
-
-    ##
-    # The card objects of the note
-    attr_reader :cards
-
-    ##
-    # Instantiate a new note for a deck and note type
-    # or TODO: instantiate a new object from an already existing record
-    # rubocop:disable Metrics/MethodLength
-    # rubocop:disable Metrics/AbcSize
-    def initialize(deck:, note_type:)
-      raise ArgumentError unless deck && note_type && deck.collection == note_type.collection
-
-      @apkg = deck.collection.anki_package
-
-      @id = milliseconds_since_epoch
-      @guid = globally_unique_id
-      @last_modified_time = seconds_since_epoch
-      @usn = NEW_OBJECT_USN
-      @tags = []
-      @deck = deck
-      @note_type = note_type
-      @field_contents = setup_field_contents
-      @cards = @note_type.card_templates.map { |card_template| Card.new(note: self, card_template: card_template) }
-    end
-    # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/AbcSize
-
-    ##
-    # Save the note to the collection.anki21 database
-    def save
-      @apkg.execute <<~SQL
-        insert into notes (id, guid, mid, mod, usn, tags, flds, sfld, csum, flags, data)
-                    values ('#{@id}', '#{@guid}', '#{note_type.id}', '#{@last_modified_time}', '#{@usn}', '#{@tags.join(" ")}', '#{field_values_separated_by_us}', '#{sort_field_value}', '#{checksum(sort_field_value)}', '0', '')
-      SQL
-      cards.each(&:save)
-      true
-    end
-
-    ##
-    # This overrides BasicObject#method_missing and has the effect of creating "ghost methods"
-    #
-    # Specifically, creates setter and getter ghost methods for the fields of the note's note type
-    #
-    # TODO: This should raise a NoMethodError if
-    # the missing method does not end with '=' and is not a field of the note type
-    def method_missing(method_name, field_content = nil)
-      method_name = method_name.to_s
-      return @field_contents[method_name] unless method_name.end_with?("=")
-
-      method_name = method_name.chomp("=")
-      valid_fields_snake_names = @field_contents.keys
-      unless valid_fields_snake_names.include?(method_name)
-        raise ArgumentError, "Valid fields for the #{note_type.name} note type are one of #{valid_fields_snake_names.join(", ")}"
-      end
-
-      @field_contents[method_name] = field_content
-    end
-
-    ##
-    # This allows #respond_to? to be accurate for the ghost methods created by #method_missing
-    def respond_to_missing?(method_name, *)
-      method_name = method_name.to_s
-      if method_name.end_with?("=")
-        note_type.snake_case_field_names.include?(method_name.chomp("="))
-      else
-        note_type.snake_case_field_names.include?(method_name)
-      end
-    end
-
-    private
-
-      def setup_field_contents
-        field_contents = {}
-        note_type.snake_case_field_names.each do |field_name|
-          field_contents[field_name] = ""
-        end
-        field_contents
-      end
-
-      def globally_unique_id
-        SecureRandom.uuid.slice(5...15)
-      end
-
-      def field_values_separated_by_us
-        # The ASCII control code represented by hexadecimal 1F is the Unit Separator (US)
-        note_type.snake_case_field_names.map { |field_name| @field_contents[field_name] }.join("\x1F")
-      end
-
-      def sort_field_value
-        @field_contents[note_type.snake_case_sort_field_name]
-      end
-  end
-end