anki_record 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b6bcf30a94ecdc25ac6632007ec16125c92ee8a35a13d93dfbe61b721a5564c
+  data.tar.gz: d3ad70a4966a2fb260447e44d6da5f33fb799a4559a5147d8deb554ea6fbe5c1
+SHA512:
+  metadata.gz: 8ff665346db80061992e832cada84a373b22bd480bfbbbf3e1deab9ca2e3915d4a668442bccee98de746ed1a636ab6a978bc5ef0c61e640908a4df5fe0c57bf3
+  data.tar.gz: 563d4c9984ab0c98af1565748904263902c9fa374af61e3882b8c618dcb471856f2d36137e8590489354148b13c1492f94e9744970addf5e8acad07f40efce17

data/.rdoc_options

@@ -0,0 +1,27 @@
+---
+encoding: UTF-8
+static_path: []
+rdoc_include: []
+page_dir: 
+charset: UTF-8
+exclude:
+- "~\\z"
+- "\\.orig\\z"
+- "\\.rej\\z"
+- "\\.bak\\z"
+- "\\.gemspec\\z"
+hyperlink_all: false
+line_numbers: false
+locale: 
+locale_dir: locale
+locale_name: 
+main_page: 
+markup: rdoc
+output_decoration: true
+show_hash: false
+skip_tests: true
+tab_width: 8
+template_stylesheets: []
+title: 
+visibility: :protected
+webcvs: 

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+AllCops:
+  TargetRubyVersion: 3.2.1
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "spec/anki_record/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/anki_record/*"
+
+Layout/IndentationConsistency:
+  EnforcedStyle: indented_internal_methods
+
+Metrics/ClassLength:
+  Max: 120
+
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Development started] - 02-02-2023
+
+## [Unreleased/0.1.0] - 02-22-2023
+
+- First version that can be used to create a complete *.apkg file that imports into Anki
+
+## [0.1.1] - 02-24-2023
+
+- Updated documentation

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at regoky@outlook.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "3.2.1"
+
+# Specify your gem's dependencies in anki_record.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "simplecov"
+
+gem "rubocop", "~> 1.21"
+
+gem "pry"
+
+gem "rdoc"

data/Gemfile.lock

@@ -0,0 +1,84 @@
+PATH
+  remote: .
+  specs:
+    anki_record (0.1.1)
+      rubyzip (>= 2.3)
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    method_source (1.0.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    psych (5.1.0)
+      stringio
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (1.6.0-x86_64-linux)
+    stringio (3.0.5)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  anki_record!
+  pry
+  rake (~> 13.0)
+  rdoc
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simplecov
+
+RUBY VERSION
+   ruby 3.2.1p31
+
+BUNDLED WITH
+   2.3.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kyle Rego
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# AnkiRecord
+
+AnkiRecord provides an interface to Anki SQLite databases through the Ruby programming language.
+
+Currently it can be used to create an empty Anki database file, execute raw SQL statements against it, and then zip the database into an *.apkg file which can be imported into Anki.
+
+[Documentation](https://kylerego.github.io/anki_record_docs)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add anki_record
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install anki_record
+
+## Usage
+
+```ruby
+require "anki_record"
+
+db = AnkiRecord::AnkiPackage.new name: "test1"
+db.execute "any valid SQL statement"
+db.zip_and_close # creates test.apkg file in the current working directory
+
+```
+
+The RSpec tests are written BDD-style as executable documentation; reading them might help to understand the gem (e.g. [anki_package_spec.rb](https://github.com/KyleRego/anki_record/blob/main/spec/anki_record/anki_package_spec.rb)).
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Release checklist
+- Bump version
+- Update changelog
+- Regenerate documentation
+
+<!-- ## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/KyleRego/anki_record. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/KyleRego/anki_record/blob/master/CODE_OF_CONDUCT.md). -->
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AnkiRecord project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/KyleRegoanki_record/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/anki_record.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/anki_record/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "anki_record"
+  spec.version = AnkiRecord::VERSION
+  spec.authors = ["Kyle Rego"]
+  spec.email = ["regoky@outlook.com"]
+
+  spec.summary = "Automate Anki flashcard editing with the Ruby programming language."
+  spec.description = <<-DESC
+  This Ruby library, which is currently in development, will provide an interface to inspect, update, and create Anki SQLite3 databases (*.apkg files).
+  DESC
+  spec.homepage = "https://github.com/KyleRego/anki_record"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.1"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/KyleRego/anki_record"
+  spec.metadata["changelog_uri"] = "https://github.com/KyleRego/anki_record/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubyzip", ">= 2.3"
+  spec.add_dependency "sqlite3"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/anki_record/anki_package.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require "pry"
+require "pathname"
+
+require_relative "db/anki_schema_definition"
+require_relative "db/clean_collection2_record"
+require_relative "db/clean_collection21_record"
+require_relative "collection"
+
+module AnkiRecord
+  ##
+  # Represents an Anki SQLite3 package/database
+  #
+  # Use ::new to create a new object or ::open to create an object from an existing one
+  class AnkiPackage
+    NAME_ERROR_MESSAGE = "The name argument must be a string without spaces."
+    PATH_ERROR_MESSAGE = "*No .apkg file was found at the given path."
+    STANDARD_ERROR_MESSAGE = <<-MSG
+    An error occurred.
+    The temporary *.anki21 database has been deleted.
+    No *.apkg zip file has been saved.
+    MSG
+
+    private_constant :NAME_ERROR_MESSAGE, :PATH_ERROR_MESSAGE, :STANDARD_ERROR_MESSAGE
+
+    ##
+    # Creates a new object which represents an Anki SQLite3 database
+    #
+    # This method takes an optional block argument.
+    #
+    # When a block argument is used, execution is yielded to the block.
+    # After the block executes, the temporary files are zipped into the +name+.apkg file
+    # which is saved in +directory+. +directory+ is the current working directory by default.
+    # If the block throws a runtime error, the temporary files are deleted but the zip file is not created.
+    #
+    # When no block argument is used, #zip_and_close must be called explicitly at the end of your script.
+    def initialize(name:, directory: Dir.pwd)
+      setup_package_instance_variables(name: name, directory: directory)
+
+      return unless block_given?
+
+      begin
+        yield self
+      rescue StandardError => e
+        close
+        puts_error_and_standard_message(error: e)
+      else
+        zip_and_close
+      end
+    end
+
+    ##
+    # Executes a raw SQL statement against the *.anki21 database
+    #
+    # Do not use this to execute data definition language SQL statements
+    # (i.e. do not create, alter, or drop tables or indexes)
+    # unless you have a good reason to change the database schema.
+    def execute(raw_sql_string)
+      @anki21_database.execute raw_sql_string
+    end
+
+    private
+
+      def setup_package_instance_variables(name:, directory:)
+        @name = check_name_is_valid(name: name)
+        @directory = directory # TODO: check directory is valid
+        @tmpdir = Dir.mktmpdir
+        @tmp_files = []
+        @anki21_database = setup_anki21_database_object
+        @anki2_database = setup_anki2_database_object
+        @media_file = setup_media
+        @collection = Collection.new(anki_package: self)
+      end
+
+      def check_name_is_valid(name:)
+        raise ArgumentError, NAME_ERROR_MESSAGE unless name.instance_of?(String) && !name.empty? && !name.include?(" ")
+
+        name.end_with?(".apkg") ? name[0, name.length - 5] : name
+      end
+
+      def setup_anki21_database_object
+        anki21_file_name = "collection.anki21"
+        db = SQLite3::Database.new "#{@tmpdir}/#{anki21_file_name}", options: {}
+        @tmp_files << anki21_file_name
+        db.execute_batch ANKI_SCHEMA_DEFINITION
+        db.execute CLEAN_COLLECTION_21_RECORD
+        db.results_as_hash = true
+        db
+      end
+
+      def setup_anki2_database_object
+        anki2_file_name = "collection.anki2"
+        db = SQLite3::Database.new "#{@tmpdir}/#{anki2_file_name}", options: {}
+        @tmp_files << anki2_file_name
+        db.execute_batch ANKI_SCHEMA_DEFINITION
+        db.execute CLEAN_COLLECTION_2_RECORD
+        db.close
+        db
+      end
+
+      def setup_media
+        media_file_path = FileUtils.touch("#{@tmpdir}/media")[0]
+        media_file = File.open(media_file_path, mode: "w")
+        media_file.write("{}")
+        media_file.close
+        @tmp_files << "media"
+        media_file
+      end
+
+      def puts_error_and_standard_message(error:)
+        puts "#{error}\n#{STANDARD_ERROR_MESSAGE}"
+      end
+
+    public
+
+    ##
+    # Creates a new object which represents the Anki SQLite3 database file at +path+
+    #
+    # Development has focused on ::new so this method is not recommended at this time
+    def self.open(path:, create_backup: true)
+      pathname = check_file_at_path_is_valid(path: path)
+      copy_apkg_file(pathname: pathname) if create_backup
+      @anki_package = new(name: pathname.basename.to_s, directory: pathname.dirname)
+    end
+
+    class << self
+      private
+
+        def check_file_at_path_is_valid(path:)
+          pathname = Pathname.new(path)
+          raise PATH_ERROR_MESSAGE unless pathname.file? && pathname.extname == ".apkg"
+
+          pathname
+        end
+
+        def copy_apkg_file(pathname:)
+          path = pathname.to_s
+          FileUtils.cp path, "#{path}.copy-#{Time.now.to_i}"
+        end
+    end
+
+    ##
+    # Zips the temporary files into the *.apkg package and deletes the temporary files.
+    def zip_and_close
+      zip && close
+    end
+
+    private
+
+      def zip
+        Zip::File.open(target_zip_file, create: true) do |zip_file|
+          @tmp_files.each do |file_name|
+            zip_file.add(file_name, File.join(@tmpdir, file_name))
+          end
+        end
+        true
+      end
+
+      def target_zip_file
+        "#{@directory}/#{@name}.apkg"
+      end
+
+      def close
+        @anki21_database.close
+        FileUtils.rm_rf(@tmpdir)
+      end
+
+    public
+
+    ##
+    # Returns true if the database is open
+    def open?
+      !closed?
+    end
+
+    ##
+    # Returns true if the database is closed
+    def closed?
+      @anki21_database.closed?
+    end
+  end
+end

data/lib/anki_record/card_template.rb

@@ -0,0 +1,91 @@
+# 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 this card template
+    attr_accessor :name
+
+    ##
+    # The question format
+    attr_accessor :question_format
+
+    ##
+    # The answer format
+    attr_accessor :answer_format
+
+    ##
+    # The font style shown for this card template in the browser
+    attr_accessor :browser_font_style
+
+    ##
+    # The font size used for this card template in the browser
+    attr_accessor :browser_font_size
+
+    ##
+    # The note type that this card template belongs to
+    attr_reader :note_type
+
+    ##
+    # 0 for the first card template of the note type, 1 for the second, etc.
+    attr_reader :ordinal_number
+
+    ##
+    # 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.templates.length
+        @question_format = ""
+        @answer_format = ""
+        @bqfmt =  ""
+        @bafmt =  ""
+        @deck_id = nil
+        @browser_font_style = ""
+        @browser_font_size = 0
+      end
+
+    public
+
+    ##
+    # Returns the field names that are allowed in the answer format and question format
+    #
+    # These are the field_name values in {{field_name}} in those formats.
+    #
+    # They are equivalent to the names of the fields of the template's note type.
+    def allowed_field_names
+      @note_type.fields.map(&:name)
+    end
+  end
+end