anki_record 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4da2246d01a22eec129d18c242062ac1eb39b9b794129bf4666fc7eb2615087b
-  data.tar.gz: 5de4bdb4e80e078d8b5711466b2eba97b68563bfbb44f24805fc63b909a31d08
+  metadata.gz: b89baf921abc0de4f35babe65cb40cf5fa5647d4d1fe9b3b81ecb80f8a47a15b
+  data.tar.gz: f766e3344683a73d46450c8bf3cf6ae8226f4cbefee4d5126a194c6dcd831cab
 SHA512:
-  metadata.gz: ac4bb975b12ca50c5d9bba91caeec3accd75a952f04ae88a17ebef9b6b15cc7af335316ee024f1f50322ec77d321aad9106c6fac3a99eb657f48a1f513353c35
-  data.tar.gz: 62b7cbd1d173f23eb2c1a3b816a092f7cbd7200945ce8bea5aafa2d73dc59714f571f2869aadb62016749dbc2446d0f43cb16fc5d670f89ea8bc3507e2c2a2f0
+  metadata.gz: 3533d5803a630df54a2c52605fefc8f4dc4ce87e0a649a34672a7a3e369a53722f7d2481e9362388519eb89bd59fbfce8f7f226e0e489433e1d1a7d12fb285fd
+  data.tar.gz: 7b2ee79fd7ba76b1f229e06831909d3e4b7949c6edc79e608fdc2aae6fe481caa9ccf14c0cd586212b78ef1deddf9e47a91d505c30bd645cf4dae8282e3ff6a8

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.2.1
   NewCops: enable
@@ -12,14 +15,15 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+  # I like the rspec --format doc output to be very readable.
   Exclude:
-    - "spec/anki_record/*"
+    - "spec/anki_record/**/*"
 
 Metrics/BlockLength:
   Exclude:
     - "spec/*"
     - "spec/anki_record/*"
-    - "spec/integration/*"
+    - "bin/test_scripts/*"
 
 Layout/IndentationConsistency:
   EnforcedStyle: indented_internal_methods
@@ -28,4 +32,9 @@ Metrics/ClassLength:
   Max: 120
 
 Style/HashSyntax:
-  EnforcedShorthandSyntax: either
+  EnforcedShorthandSyntax: either
+
+# One expectation per test is a good practice. For this test suite,
+# following this rule would have a very high performance cost.
+RSpec/MultipleExpectations:
+  Enabled: false

data/CHANGELOG.md

@@ -35,4 +35,10 @@
     - In fixing this bug, other issues with `tags` and `vers` were introduced and then fixed.
     - It was also noticed that the default note types with "Basic" in the name should not have `tags` and `vers` so this was changed too.
 - API documentation changed from using RDoc to SDoc with the Rails template.
-- RSpec test suite was refactored to improve speed: 4 minutes -> 1.5 minutes.
+- RSpec test suite was refactored to improve speed: 4 minutes -> 1.5 minutes.
+
+## [0.4.0] - Not released
+
+- `Deck.new` was saving the deck to the `collection.anki21` database. Now it will only instantiate it and `#save` must be called to save it.
+- `Helper` modules moved into the `Helpers` module namespace.
+- Bug fix addressing using the approximate milliseconds since the epoch as the primary key id causing the uniqueness constraint to fail when creating a lot of notes.

data/Gemfile

@@ -18,3 +18,5 @@ gem "rubocop", "~> 1.21"
 gem "pry"
 
 gem "sdoc", "~> 2.6"
+
+gem "rubocop-rspec", "~> 2.20"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    anki_record (0.3.0)
+    anki_record (0.3.1)
       rubyzip (>= 2.3)
       sqlite3 (~> 1.3)
 
@@ -53,6 +53,11 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.20.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-progressbar (1.11.0)
     rubyzip (2.3.2)
     sdoc (2.6.1)
@@ -76,6 +81,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rspec (~> 2.20)
   sdoc (~> 2.6)
   simplecov
 

data/README.md

@@ -1,10 +1,6 @@
 # Anki Record
 
-Anki Record is a Ruby library which provides a programmatic interface to Anki flashcard decks/deck packages (`.apkg` files or Anki SQLite databases).
-
-**Development is ongoing and currently released versions may have some bugs. The library does not support media yet.**
-
-**To import the deck packages into Anki, click the File menu and then "Import" from inside Anki. Do not double click the `.apkg` file to open Anki and import it at the same time.**
+Anki Record is a Ruby gem providing an API to Anki flashcard deck packages (zipped SQLite databases). The main thing it does not support yet is adding media to the notes.
 
 ## Installation
 
@@ -18,12 +14,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-The Anki package object is instantiated with `AnkiRecord::AnkiPackage.new`. If this is passed a block, it will execute the block, and afterwards zip an `*.apkg` file where `*` is the name argument (this argument is not allowed to contain spaces):
+The Anki package object is instantiated with `AnkiRecord::AnkiPackage.new`. If this is passed a block, the collection object is yielded to the block, and an Anki deck package file is created after execution of the block:
 
 ```ruby
 require "anki_record"
 
-AnkiRecord::AnkiPackage.new(name: "test") do |apkg|
+AnkiRecord::AnkiPackage.new(name: "test") do |collection|
   3.times do |number|
     puts "#{3 - number}..."
   end
@@ -42,27 +38,29 @@ Alternatively, if `AnkiRecord::Package::new` is not passed a block, the `zip` me
 require "anki_record"
 
 apkg = AnkiRecord::AnkiPackage.new(name: "test")
+collection = apkg.collection
+# Add notes to the collection
 apkg.zip # This zips the temporary files into test.apkg, and then deletes them.
 ```
 
-The second, optional argument to `AnkiRecord::Package.new` is `directory`. The default value is the current working directory, but if a relative file path argument is given, the new `*.apkg` file will be saved in that directory. An exception will be raised if the relative file path is not to a directory that exists.
+The second, optional argument to `AnkiRecord::AnkiPackage.new` is `target_directory`. The default value is the current working directory, but if a relative file path argument is given, the new `*.apkg` file will be saved in that directory. An exception will be raised if the relative file path is not to a directory that exists.
 
 A new Anki package object is initialized with the "Default" deck and the default note types of a new Anki collection (including "Basic" and "Cloze"). The deck and note type objects are accessed through the `collection` attribute of the Anki package object through the `find_deck_by` and `find_note_type_by` methods passed the `name` keyword argument:
 
 ```ruby
 require "anki_record"
 
-apkg = AnkiRecord::AnkiPackage.new(name: "test") do |apkg|
-  deck = apkg.collection.find_deck_by name: "Default"
+AnkiRecord::AnkiPackage.new(name: "test") do |collection|
+  deck = collection.find_deck_by name: "Default"
 
-  note_type = apkg.collection.find_note_type_by name: "Basic"
+  note_type = collection.find_note_type_by name: "Basic"
 
   note = AnkiRecord::Note.new note_type: note_type, deck: deck
   note.front = "Hello"
   note.back = "World"
   note.save
 
-  note_type2 = apkg.collection.find_note_type_by name: "Cloze"
+  note_type2 = collection.find_note_type_by name: "Cloze"
 
   note2 = AnkiRecord::Note.new note_type: note_type2, deck: deck
   note2.text = "Cloze {{c1::Hello}}"
@@ -83,6 +81,7 @@ note_id = nil
 
 AnkiRecord::AnkiPackage.new(name: "test_1") do |collection|
   crazy_deck = AnkiRecord::Deck.new collection: collection, name: "test_1_deck"
+  crazy_deck.save
 
   crazy_note_type = AnkiRecord::NoteType.new collection: collection, name: "test 1 note type"
   AnkiRecord::NoteField.new note_type: crazy_note_type, name: "crazy front"
@@ -127,19 +126,22 @@ This script creates an Anki package `test_1.apkg` with a new deck and new note t
 
 The [API Documentation](https://kylerego.github.io/anki_record_docs) is generated using SDoc from comments in the source code. You might notice that some public methods are intentionally omitted from this documentation. Although public, these methods are not intended to be used outside of the gem's implementation and should be treated as private.
 
-The RSpec examples are intended to provide executable documentation and may also be helpful to understand the API. Running the test suite with the `rspec` command will output these in a more readable way that also reflects the nesting of the RSpec examples and example groups. The following is an example of output from one example in `spec/anki_record/note_spec.rb`:
+The RSpec examples are intended to provide executable documentation and may also be helpful to understand the API. Running the test suite with the `rspec` command will output these in a more readable way that also reflects the nesting of the RSpec examples and example groups. This is an example of part of the output:
 
 ```
-AnkiRecord::Note
-  #save
-    for a note that does not exist in the collection.anki21 database (custom note type, 2 card templates)
-      should save two card records to the collection.anki21 database
-        with nid values equal to the id of the cards' note object's id
+AnkiRecord::Deck#save
+  when the deck does not exist in the collection.anki21 database
+    saves the deck object's id as a key in the decks column's JSON object in the collection.anki21 database
+    saves the deck object as a hash, as the value of the deck object's id key, in the decks hash
+    saves the deck object as a hash with the following keys: 'id', 'mod', 'name', 'usn', 'lrnToday', 'revToday', 'newToday', 'timeToday', 'collapsed', 'browserCollapsed', 'desc', 'dyn', 'conf', 'extendNew', 'extendRev'
+    saves the deck object as a hash with the deck object's id attribute as the value for the id key in the deck hash
+    saves the deck object as a hash with the deck object's last_modified_timestamp attribute as the value for the mod key in the deck hash
+
 ```
 
-The RSpec test suite files in `spec` have a mapping with the source code in `lib`.
+The RSpec test suite files in `spec` are organized similarly to the the source code in `lib`.
 
-## Development
+<!-- ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -174,7 +176,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 - Update usage examples
 - Update and regenerate documentation
 - Bump version
-- Release gem
+- Release gem -->
 
 <!-- ## Contributing
 

data/lib/anki_record/anki_package/anki_package.rb

@@ -5,16 +5,14 @@ require "pathname"
 require_relative "../card/card"
 require_relative "../collection/collection"
 require_relative "../note/note"
-require_relative "database_setup_constants"
+require_relative "../database_setup_constants"
 
 # rubocop:disable Metrics/ClassLength
 module AnkiRecord
   ##
-  # AnkiPackage represents an Anki package.
-  #
-  # Here, Anki package refers to the zip file that Anki can export and import.
+  # AnkiPackage represents an Anki package deck file.
   class AnkiPackage
-    include AnkiRecord::DataQueryHelper
+    include AnkiRecord::Helpers::DataQueryHelper
 
     ##
     # The package's collection object.
@@ -45,8 +43,8 @@ module AnkiRecord
 
     private
 
-      def execute_closure_and_zip(object_to_yield, &closure)
-        closure.call(object_to_yield)
+      def execute_closure_and_zip(collection, &closure)
+        closure.call(collection)
       rescue StandardError => e
         destroy_temporary_directory
         puts_error_and_standard_message(error: e)
@@ -151,15 +149,7 @@ module AnkiRecord
     end
 
     # rubocop:disable Metrics/MethodLength
-
-    ##
-    # Unzips the *.apkg file that was opened and yields its collection.anki21 database
-    # as a SQLite3::Database object (see sqlite3 gem) to the block.
-    #
-    # After the block executes, the files created by unzipping are deleted.
-    #
-    # Throws an error if the Anki package was not instantiated using ::open.
-    #
+    # :nodoc:
     def temporarily_unzip_source_apkg
       raise ArgumentError unless @open_path && block_given?
 
@@ -179,7 +169,7 @@ module AnkiRecord
     # rubocop:enable Metrics/MethodLength
 
     class << self
-      include TimeHelper
+      include Helpers::TimeHelper
 
       # rubocop:disable Metrics/MethodLength
       # rubocop:disable Metrics/AbcSize
@@ -233,11 +223,13 @@ module AnkiRecord
 
     public
 
-    def open? # :nodoc:
+    # :nodoc:
+    def open?
       !closed?
     end
 
-    def closed? # :nodoc:
+    # :nodoc:
+    def closed?
       @anki21_database.closed?
     end
   end

data/lib/anki_record/card/card.rb

@@ -9,8 +9,8 @@ module AnkiRecord
   # Card represents an Anki card.
   class Card
     include CardAttributes
-    include TimeHelper
-    include SharedConstantsHelper
+    include Helpers::TimeHelper
+    include Helpers::SharedConstantsHelper
 
     def initialize(note:, card_template: nil, card_data: nil) # :nodoc:
       @note = note

data/lib/anki_record/collection/collection.rb

@@ -14,9 +14,9 @@ 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
+    include Helpers::DataQueryHelper
+    include Helpers::TimeHelper
+    include CollectionAttributes
 
     def initialize(anki_package:) # :nodoc:
       setup_collection_instance_variables(anki_package: anki_package)
@@ -107,11 +107,13 @@ module AnkiRecord
       AnkiRecord::Note.new collection: self, data: note_cards_data
     end
 
-    def decks_json # :nodoc:
+    # :nodoc:
+    def decks_json
       JSON.parse(anki_package.prepare("select decks from col;").execute.first["decks"])
     end
 
-    def models_json # :nodoc:
+    # :nodoc:
+    def models_json
       JSON.parse(anki_package.prepare("select models from col;").execute.first["models"])
     end
 

data/lib/anki_record/{anki_package/database_setup_constants.rb → database_setup_constants.rb}

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module AnkiRecord
-  ANKI_SCHEMA_DEFINITION = <<~SQL # :nodoc:
+  # :nodoc:
+  ANKI_SCHEMA_DEFINITION = <<~SQL
     CREATE TABLE col (
       id integer PRIMARY KEY,
       crt integer NOT NULL,
@@ -75,16 +76,12 @@ module AnkiRecord
     );
   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
+  # :nodoc:
   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
+  # :nodoc:
   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

data/lib/anki_record/deck/deck.rb

@@ -8,13 +8,11 @@ require_relative "../helpers/time_helper"
 module AnkiRecord
   ##
   # Deck represents an Anki deck.
-  # In the collection.anki21 database, the deck is a JSON object
-  # which is part of a larger JSON object: the value of the col record's decks column.
   class Deck
     include DeckAttributes
     include DeckDefaults
-    include SharedConstantsHelper
-    include TimeHelper
+    include Helpers::SharedConstantsHelper
+    include Helpers::TimeHelper
 
     ##
     # Instantiates a new Deck object belonging to +collection+ with name +name+.
@@ -29,11 +27,11 @@ module AnkiRecord
       end
 
       @collection.add_deck self
-      save
+      save if args
     end
 
     ##
-    # Saves the deck (or updates it) in the collection.anki21 database.
+    # Saves the deck to the collection.anki21 database.
     def save
       collection_decks_hash = collection.decks_json
       collection_decks_hash[@id] = to_h

data/lib/anki_record/deck_options_group/deck_options_group.rb

@@ -9,8 +9,8 @@ module AnkiRecord
   # DeckOptionsGroup represents a set of options that can be applied to an Anki deck.
   class DeckOptionsGroup
     include DeckOptionsGroupAttributes
-    include SharedConstantsHelper
-    include TimeHelper
+    include Helpers::SharedConstantsHelper
+    include Helpers::TimeHelper
 
     ##
     # Instantiates a new deck options group belonging to +collection+ with name +name+.

data/lib/anki_record/helpers/checksum_helper.rb

@@ -3,15 +3,17 @@
 require "digest"
 
 module AnkiRecord
-  ##
-  # A module for the method that calculates the checksum value of notes.
-  #
-  # This checksum may be used by Anki to detect duplicates.
-  module ChecksumHelper
+  module Helpers
     ##
-    # Returns the integer representation of the first 8 characters of the SHA-1 digest of the +sfld+ argument
-    def checksum(sfld)
-      Digest::SHA1.hexdigest(sfld)[0...8].to_i(16).to_s
+    # A module for the method that calculates the checksum value of notes.
+    #
+    # This checksum may be used by Anki to detect duplicates.
+    module ChecksumHelper
+      ##
+      # Returns the integer representation of the first 8 characters of the SHA-1 digest of the +sfld+ argument
+      def checksum(sfld)
+        Digest::SHA1.hexdigest(sfld)[0...8].to_i(16).to_s
+      end
     end
   end
 end

data/lib/anki_record/helpers/data_query_helper.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module AnkiRecord
-  module DataQueryHelper # :nodoc:
-    def note_cards_data_for_note_id(sql_able:, id:)
-      note_data = sql_able.prepare("select * from notes where id = ?").execute([id]).first
-      return nil unless note_data
+  module Helpers
+    module DataQueryHelper # :nodoc:
+      def note_cards_data_for_note_id(sql_able:, id:)
+        note_data = sql_able.prepare("select * from notes where id = ?").execute([id]).first
+        return nil unless note_data
 
-      cards_data = sql_able.prepare("select * from cards where nid = ?").execute([id]).to_a
-      { note_data: note_data, cards_data: cards_data }
+        cards_data = sql_able.prepare("select * from cards where nid = ?").execute([id]).to_a
+        { note_data: note_data, cards_data: cards_data }
+      end
     end
   end
 end

data/lib/anki_record/helpers/shared_constants_helper.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 module AnkiRecord
-  module SharedConstantsHelper # :nodoc:
-    NEW_OBJECT_USN = -1
-    NON_FILTERED_DECK_DYN = 0
-    private_constant :NEW_OBJECT_USN, :NON_FILTERED_DECK_DYN
+  module Helpers
+    module SharedConstantsHelper # :nodoc:
+      NEW_OBJECT_USN = -1
+      NON_FILTERED_DECK_DYN = 0
+      private_constant :NEW_OBJECT_USN, :NON_FILTERED_DECK_DYN
+    end
   end
 end

data/lib/anki_record/helpers/time_helper.rb

@@ -3,23 +3,26 @@
 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
+  module Helpers
     ##
-    # Returns approximately the number of milliseconds since the 1970 epoch.
-    # A random amount of milliseconds between -5000 and 5000 is added so that
-    # primary key ids calculated with this should be unique.
-    def milliseconds_since_epoch
-      DateTime.now.strftime("%Q").to_i + rand(-5000..5000)
-    end
+    # 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
+      ##
+      # Returns approximately the number of milliseconds since the 1970 epoch.
+      # This is used for some of the primary key ids. To prevent violation of the
+      # uniqueness constraint, sleep is called for 1 millisecond.
+      def milliseconds_since_epoch
+        sleep 0.001
+        DateTime.now.strftime("%Q").to_i
+      end
 
-    ##
-    # Returns approximately the number of seconds since the 1970 epoch.
-    def seconds_since_epoch
-      Time.now.to_i
+      ##
+      # Returns approximately the number of seconds since the 1970 epoch.
+      def seconds_since_epoch
+        Time.now.to_i
+      end
     end
   end
 end

data/lib/anki_record/note/note.rb

@@ -9,18 +9,15 @@ require_relative "note_attributes"
 # rubocop:disable Metrics/ClassLength
 module AnkiRecord
   ##
-  # Represents an Anki note. The note object corresponds to a record in the `notes`
-  # table in the collection.anki21 database.
+  # Represents an Anki note.
   class Note
-    include ChecksumHelper
+    include Helpers::ChecksumHelper
     include NoteAttributes
-    include TimeHelper
-    include SharedConstantsHelper
+    include Helpers::TimeHelper
+    include Helpers::SharedConstantsHelper
 
     ##
     # Instantiates a note of type +note_type+ and belonging to deck +deck+.
-    #
-    # If +note_type+ and +deck+ arguments are used, +collection+ and +data should not be given.
     def initialize(note_type: nil, deck: nil, collection: nil, data: nil)
       if note_type && deck
         setup_instance_variables_for_new_note(note_type: note_type, deck: deck)

data/lib/anki_record/note_type/note_type.rb

@@ -13,10 +13,10 @@ module AnkiRecord
   #
   # The attributes are documented in the NoteTypeAttributes module.
   class NoteType
-    include AnkiRecord::SharedConstantsHelper
-    include AnkiRecord::TimeHelper
-    include AnkiRecord::NoteTypeAttributes
-    include AnkiRecord::NoteTypeDefaults
+    include Helpers::SharedConstantsHelper
+    include Helpers::TimeHelper
+    include NoteTypeAttributes
+    include NoteTypeDefaults
 
     NOTE_TYPES_WITHOUT_TAGS_AND_VERS_VALUES = ["Basic", "Basic (and reversed card)",
                                                "Basic (optional reversed card)", "Basic (type in the answer)"].freeze

data/lib/anki_record/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anki_record
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kyle Rego
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-26 00:00:00.000000000 Z
+date: 2023-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -58,13 +58,13 @@ files:
 - anki_record.gemspec
 - lib/anki_record.rb
 - lib/anki_record/anki_package/anki_package.rb
-- lib/anki_record/anki_package/database_setup_constants.rb
 - lib/anki_record/card/card.rb
 - lib/anki_record/card/card_attributes.rb
 - lib/anki_record/card_template/card_template.rb
 - lib/anki_record/card_template/card_template_attributes.rb
 - lib/anki_record/collection/collection.rb
 - lib/anki_record/collection/collection_attributes.rb
+- lib/anki_record/database_setup_constants.rb
 - lib/anki_record/deck/deck.rb
 - lib/anki_record/deck/deck_attributes.rb
 - lib/anki_record/deck/deck_defaults.rb