anki_record 0.2.0 → 0.3.1

data/lib/anki_record/note_field.rb

@@ -1,84 +0,0 @@
-# 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 note type that the note field belongs to
-    attr_reader :note_type
-
-    ##
-    # The name of the note field
-    attr_accessor :name
-
-    ##
-    # A boolean that indicates if this field is sticky when adding cards of the note type in Anki
-    attr_accessor :sticky
-
-    ##
-    # A boolean that indicates if this field should be right to left
-    attr_accessor :right_to_left
-
-    ##
-    # The font style used when editing the note field
-    attr_accessor :font_style
-
-    ##
-    # The font size used when editing the note field
-    attr_accessor :font_size
-
-    ##
-    # The description of the note field
-    attr_accessor :description
-
-    ##
-    # 0 for the first field of the note type, 1 for the second, etc.
-    attr_reader :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"]
-        @description = args["description"]
-      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

@@ -1,233 +0,0 @@
-# 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"
-
-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 collection object that the note type belongs to
-    attr_reader :collection
-
-    ##
-    # The id of the note type
-    attr_reader :id
-
-    ##
-    # The name of the note type
-    attr_accessor :name
-
-    ##
-    # A boolean that indicates if this note type is a cloze-deletion note type
-    attr_accessor :cloze
-
-    ##
-    # The CSS styling of the note type
-    attr_reader :css
-
-    ##
-    # The LaTeX preamble of the note type
-    attr_reader :latex_preamble
-
-    ##
-    # The LaTeX postamble of the note type
-    attr_reader :latex_postamble
-
-    ##
-    # A boolean probably related to something with LaTeX and SVG.
-    #
-    # TODO: Investigate what this does
-    attr_reader :latex_svg
-
-    ##
-    # An array of the card template objects belonging to the note type
-    attr_reader :card_templates
-
-    ##
-    # An array of the field names of the card template
-    attr_reader :fields
-
-    ##
-    # TODO: Investigate the meaning of the deck id of a note type
-    attr_reader :deck_id
-
-    ##
-    # TODO: Investigate the meaning of tags of a note type
-    attr_reader :tags
-
-    ##
-    # 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
-
-    ##
-    # Creates 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: Raise an exception if the name is already used by a field in this note type
-      note_field = AnkiRecord::NoteField.new(note_type: self, name: name)
-      @fields << note_field
-      note_field
-    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: Raise an exception if the name is already used by a template in this note type
-      card_template = AnkiRecord::CardTemplate.new(note_type: self, name: name)
-      @card_templates << card_template
-      card_template
-    end
-
-    ##
-    # Find one of the note type's card templates by name
-    def find_card_template_by(name:)
-      card_templates.find { |template| template.name == name }
-    end
-
-    ##
-    # The field names of the note type ordered by their ordinal values
-    def field_names_in_order
-      @fields.sort_by(&:ordinal_number).map(&:name)
-    end
-
-    ##
-    # The allowed field names of the note in snake_case
-    #
-    # TODO: make this more robust... what happens when the note type name has non-alphabetic characters?
-    def snake_case_field_names
-      field_names_in_order.map { |field_name| field_name.downcase.gsub(" ", "_") }
-    end
-
-    ##
-    # The name of the field used to sort notes of the note type in the Anki browser
-    def sort_field_name
-      @fields.find { |field| field.ordinal_number == @sort_field }&.name
-    end
-
-    ##
-    # The name of the sort field in snake_case
-    def snake_case_sort_field_name
-      sort_field_name.downcase.gsub(" ", "_")
-    end
-
-    ##
-    # The allowed field_name values in {{field_name}} of the note type's card templates' question format
-    #
-    # These are the note type's fields' names, and if the note type is a cloze type,
-    # these also include the note type's fields' names prepended with 'cloze:'.
-    #
-    # TODO: research if other special field names like e.g. 'FrontSide' are allowed
-    def allowed_card_template_question_format_field_names
-      allowed = field_names_in_order
-      cloze ? allowed + field_names_in_order.map { |field_name| "cloze:#{field_name}" } : allowed
-    end
-
-    ##
-    # The allowed field_name values in {{field_name}} of the note type's card templates' answer format
-    #
-    # These are the note type's fields' names, and if the note type is a cloze type,
-    # these also include the note type's fields' names prepended with 'cloze:'.
-    #
-    # TODO: research if other special field names like e.g. 'FrontSide' are allowed
-    def allowed_card_template_answer_format_field_names
-      allowed_card_template_question_format_field_names + ["FrontSide"]
-    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) }
-        @card_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 = []
-        @card_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
-
-      def default_css
-        <<-CSS
-        .card {
-          color: black;
-          background-color: transparent;
-          text-align: center;
-        }
-        CSS
-      end
-
-      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
-
-      def default_latex_postamble
-        <<-LATEX_POST
-        \\end{document}
-        LATEX_POST
-      end
-  end
-end