anki_record 0.3.2 → 0.4

data/lib/anki_record/collection/collection.rb

@@ -4,7 +4,6 @@ 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"
@@ -12,171 +11,38 @@ 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.
+  # The note types, decks, and deck options groups data are contained within this record, but
+  # for simplicity of the gem's API, they are managed by the Anki21Database class.
   class Collection
-    include Helpers::DataQueryHelper
     include Helpers::TimeHelper
     include 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
-
-    # :nodoc:
-    def decks_json
-      JSON.parse(anki_package.prepare("select decks from col;").execute.first["decks"])
-    end
+    attr_reader :anki21_database
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/MethodLength
     # :nodoc:
-    def models_json
-      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
+    def initialize(anki21_database:)
+      @anki21_database = anki21_database
+      @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"])
       remove_instance_variable(:@col_record)
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/MethodLength
 
     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
+        @col_record ||= anki21_database.col_record
       end
   end
 end

data/lib/anki_record/collection/collection_attributes.rb

@@ -1,35 +1,7 @@
 # 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
+  module CollectionAttributes # :nodoc:
+    attr_reader :id, :created_at_timestamp, :last_modified_timestamp
   end
 end

data/lib/anki_record/deck/deck.rb

@@ -15,28 +15,28 @@ module AnkiRecord
     include Helpers::TimeHelper
 
     ##
-    # Instantiates a new Deck object belonging to +collection+ with name +name+.
-    def initialize(collection:, name: nil, args: nil)
+    # Instantiates a new Deck object belonging to +anki21_database+ with name +name+.
+    def initialize(anki21_database:, name: nil, args: nil)
       raise ArgumentError unless (name && args.nil?) || (args && args["name"])
 
-      @collection = collection
+      @anki21_database = anki21_database
       if args
-        setup_deck_instance_variables_from_existing(args: args)
+        setup_deck_instance_variables_from_existing(args:)
       else
-        setup_deck_instance_variables(name: name)
+        setup_deck_instance_variables(name:)
       end
 
-      @collection.add_deck self
+      @anki21_database.add_deck self
       save if args
     end
 
     ##
     # Saves the deck to the collection.anki21 database.
     def save
-      collection_decks_hash = collection.decks_json
+      collection_decks_hash = anki21_database.decks_json
       collection_decks_hash[@id] = to_h
       sql = "update col set decks = ? where id = ?"
-      collection.anki_package.prepare(sql).execute([JSON.generate(collection_decks_hash), collection.id])
+      anki21_database.prepare(sql).execute([JSON.generate(collection_decks_hash), anki21_database.collection.id])
     end
 
     def to_h # :nodoc:
@@ -54,6 +54,7 @@ module AnkiRecord
     def inspect
       "#<AnkiRecord::Deck:#{object_id} id: #{id} name: #{name} description: #{description}>"
     end
+    # :nocov:
 
     private
 
@@ -72,7 +73,7 @@ module AnkiRecord
         @collapsed_in_browser = args["browserCollapsed"]
         @description = args["desc"]
         @dyn = args["dyn"]
-        @deck_options_group = @collection.find_deck_options_group_by id: args["conf"]
+        @deck_options_group = anki21_database.find_deck_options_group_by(id: args["conf"])
         @extend_new = args["extendNew"]
         @extend_review = args["extendRev"]
       end
@@ -90,7 +91,7 @@ module AnkiRecord
         @collapsed_in_browser = default_collapsed
         @description = ""
         @dyn = NON_FILTERED_DECK_DYN
-        @deck_options_group = @collection.find_deck_options_group_by id: default_deck_options_group_id
+        @deck_options_group = anki21_database.find_deck_options_group_by id: default_deck_options_group_id
         @extend_new = 0
         @extend_review = 0
       end

data/lib/anki_record/deck/deck_attributes.rb

@@ -3,28 +3,26 @@
 module AnkiRecord
   # Module with the Deck class's attribute readers, writers, and accessors.
   module DeckAttributes
-    ##
-    # The deck's collection object.
-    attr_reader :collection
+    attr_reader :anki21_database # :nodoc:
 
     ##
-    # The deck's name.
+    # The deck's name
     attr_accessor :name
 
     ##
-    # The deck's description.
+    # The deck's description
     attr_accessor :description
 
     ##
-    # The deck's id.
+    # The deck's id
     attr_reader :id
 
     ##
-    # The number of seconds since the 1970 epoch when the deck was last modified.
+    # The number of seconds since the 1970 epoch when the deck was last modified
     attr_reader :last_modified_timestamp
 
     ##
-    # The deck's deck options group object.
+    # The deck's deck options group
     attr_reader :deck_options_group
   end
 end

data/lib/anki_record/deck/deck_defaults.rb

@@ -5,7 +5,7 @@ module AnkiRecord
     private
 
       def default_deck_options_group_id
-        collection.deck_options_groups.min_by(&:id).id
+        anki21_database.deck_options_groups.min_by(&:id).id
       end
 
       def default_deck_today_array

data/lib/anki_record/deck_options_group/deck_options_group.rb

@@ -7,25 +7,27 @@ require_relative "deck_options_group_attributes"
 module AnkiRecord
   ##
   # DeckOptionsGroup represents a set of options that can be applied to an Anki deck.
+  # The interface to this has not been explored much so using the gem with these directly
+  # may involve breaking encapsulation.
   class DeckOptionsGroup
     include DeckOptionsGroupAttributes
     include Helpers::SharedConstantsHelper
     include Helpers::TimeHelper
 
     ##
-    # Instantiates a new deck options group belonging to +collection+ with name +name+.
-    def initialize(collection:, name: nil, args: nil)
+    # Instantiates a new deck options group belonging to +anki21_database+ with name +name+.
+    def initialize(anki21_database:, name: nil, args: nil)
       raise ArgumentError unless (name && args.nil?) || (args && args["name"])
 
-      @collection = collection
+      @anki21_database = anki21_database
 
       if args
-        setup_deck_options_group_instance_variables_from_existing(args: args)
+        setup_deck_options_group_instance_variables_from_existing(args:)
       else
-        setup_deck_options_group_instance_variables(name: name)
+        setup_deck_options_group_instance_variables(name:)
       end
 
-      @collection.add_deck_options_group self
+      @anki21_database.add_deck_options_group self
     end
 
     private

data/lib/anki_record/deck_options_group/deck_options_group_attributes.rb

@@ -2,22 +2,20 @@
 
 module AnkiRecord
   ##
-  # Module with the Card class's attribute readers, writers, and accessors.
+  # Module with DeckOptionsGroup's attribute readers, writers, and accessors.
   module DeckOptionsGroupAttributes
-    ##
-    # The deck options group's collection object.
-    attr_reader :collection
+    attr_reader :anki21_database # :nodoc:
 
     ##
-    # The deck option group's name.
+    # The deck option group's name
     attr_accessor :name
 
     ##
-    # The deck option group's id.
+    # The deck option group's id
     attr_reader :id
 
     ##
-    # The number of milliseconds since the 1970 epoch at which the deck options group was modified.
+    # The number of milliseconds since the 1970 epoch at which the deck options group was modified
     attr_reader :last_modified_timestamp
   end
 end

data/lib/anki_record/helpers/anki_guid_helper.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module AnkiRecord
+  module Helpers
+    ##
+    # A module for the method that computes the guid value of notes.
+    #
+    # This guid is used by Anki when importing a deck package to update existing notes
+    # rather than create duplicates of them.
+    module AnkiGuidHelper
+      ##
+      # Returns a random string of 10 characters sliced out of a random base64 string (RFC 3548).
+      def self.globally_unique_id
+        SecureRandom.base64(9).slice(1, 10)
+      end
+    end
+  end
+end

data/lib/anki_record/media/media.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module AnkiRecord
+  class Media # :nodoc:
+    attr_reader :anki_package, :media_file
+
+    FILENAME = "media"
+
+    def self.create_new(anki_package:)
+      media = new
+      media.create_initialize(anki_package:)
+      media
+    end
+
+    def create_initialize(anki_package:)
+      @anki_package = anki_package
+      media_file_path = FileUtils.touch("#{anki_package.tmpdir}/#{FILENAME}")[0]
+      @media_file = File.open(media_file_path, mode: "w")
+      media_file.write("{}")
+      media_file.close
+    end
+
+    def self.update_new(anki_package:)
+      media = new
+      media.update_initialize(anki_package:)
+      media
+    end
+
+    def update_initialize(anki_package:)
+      @anki_package = anki_package
+      @media_file = File.open("#{anki_package.tmpdir}/#{FILENAME}", mode: "w")
+      media_file.write("{}")
+      media_file.close
+    end
+  end
+end