apkg-to-csv 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1124f2bbb1471a711a6ffdd2e7fbb9316c2580b7c457a07f131411bf099f3a42
+  data.tar.gz: 741c2b58d53e1e3f4bdf7235c29f4a73a37a78c2dc4f9f23833ca539e94c87ba
+SHA512:
+  metadata.gz: 6368553fbb0bd6923e1b65f05b75184a1d5861b3da959242dc664930b9df29097b792f6c4818351be03e90b228f126ca3c454063c074e530461268e87add5162
+  data.tar.gz: 6ddb8294e29d7bc289e16df4b0e7a9d963b11c6fc58fca7a9835bf957a78f564bd85e7c54bdd12d046f4638f83e0cdd341987795cdbade7f3821a7d9be9cf5c6

data/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [3.0, 2.7, 2.6, 2.5]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@477b21f02be01bcb8030d50f37cfec92bfa615b6
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Delete lockfile (to make sure it works with gem install)
+        run: rm Gemfile.lock
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec bash ./test/test.sh
+
+      - name: Lint code
+        run: bundle exec rubocop
+
+      - name: Audit code
+        run: bundle exec bundler-audit check --update

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_gem:
+  gnar-style:
+    - "rubocop/rubocop.yml"
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+  Severity: refactor
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'bundler-audit'
+  gem 'gnar-style'
+end

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    apkg-to-csv (0.1.0)
+      rubyzip (~> 2.3.0)
+      sqlite3 (~> 1.4.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bundler-audit (0.9.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (~> 1.0)
+    gnar-style (0.13.0)
+      rubocop (>= 1.0.0, < 2.0)
+      rubocop-performance
+      rubocop-rails (~> 2.2.0)
+      thor
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.3)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.11.5)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.2.1)
+      rack (>= 1.1)
+      rubocop (>= 0.72.0)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    sqlite3 (1.4.2)
+    thor (1.1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  apkg-to-csv!
+  bundler-audit
+  gnar-style
+
+BUNDLED WITH
+   2.2.30

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 
+
+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,33 @@
+# APKG to CSV
+
+Convert [Anki](https://apps.ankiweb.net/) deck (`.apkg`) files to comma-separated values (`.csv`) files.
+
+## Motivation
+
+There is a large collection of [shared Anki decks](https://ankiweb.net/shared/decks/) available online.
+It can be difficult to work with these decks without first importing them into Anki.
+
+`apkg-to-csv` converts these decks into comma-separated values so that they can be modified without first importing them into Anki.
+
+## Requirements
+
+* `ruby >= 2.5`
+
+## Installation
+
+* `gem install apkg-to-csv`
+
+## Usage
+
+* `apkg-to-csv deck.apkg > deck.csv`
+
+## Development Installation
+
+```
+gem install bundler
+bundle install
+```
+
+## Running Tests
+
+* `bundle exec bash ./test/test.sh`

data/apkg-to-csv.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/apkg_to_csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'apkg-to-csv'
+  spec.version       = ApkgToCsv::VERSION
+  spec.authors       = ['zfletch']
+  spec.email         = ['zf.rubygems@gmail.com']
+
+  spec.summary       = 'Convert Anki deck (.apkg) files to comma-separated values (.csv) files.'
+  spec.homepage      = 'https://github.com/zfletch/apkg-to-csv'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubyzip', '~> 2.3.0'
+  spec.add_dependency 'sqlite3', '~> 1.4.2'
+end

data/bin/apkg-to-csv

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'sqlite3'
+require 'zip'
+require 'tempfile'
+require_relative '../lib/apkg_to_csv'
+
+filename = ARGV[0]
+
+unless filename
+  puts 'Filename required'
+  exit 1
+end
+
+file_written = false
+tempfile = Tempfile.new('db')
+
+Zip::File.open(filename) do |zip_file|
+  zip_file.each do |entry|
+    if entry.name == 'collection.anki2'
+      tempfile.write(entry.get_input_stream.read)
+      file_written = true
+    end
+  end
+end
+
+unless file_written
+  puts 'Could not extract zip file correctly'
+  exit 1
+end
+
+db = SQLite3::Database.new(tempfile.path)
+
+puts ApkgToCsv.csv(db).csv

data/lib/apkg_to_csv/csv.rb

@@ -0,0 +1,35 @@
+require 'csv'
+
+module ApkgToCsv
+  class Csv
+    def self.from_notes(notes, models: [])
+      csv_hash = {}
+
+      models.each do |m|
+        csv_hash[m.id] ||= []
+        csv_hash[m.id] << m.fields
+      end
+
+      notes.each do |n|
+        csv_hash[n.model_id] ||= []
+        csv_hash[n.model_id] << n.fields
+      end
+
+      new(csv_hash)
+    end
+
+    attr_reader :csv
+
+    def initialize(hash)
+      @csv = CSV.generate do |csv|
+        first, *rest = hash.values
+
+        first.each { |f| csv << f }
+        rest.each do |fields_array|
+          csv << []
+          fields_array.each { |f| csv << f }
+        end
+      end
+    end
+  end
+end

data/lib/apkg_to_csv/model.rb

@@ -0,0 +1,33 @@
+require 'json'
+require 'sqlite3'
+
+module ApkgToCsv
+  class Model
+    def self.from_db(db)
+      db.execute('SELECT models FROM col').flat_map do |row|
+        from_row(row)
+      end
+    end
+
+    def self.from_row(row)
+      row.flat_map do |models_json|
+        JSON.parse(models_json).map { |k, v| new(k, v) }
+      end
+    end
+
+    attr_reader :id
+
+    def initialize(id, model_hash)
+      @id = id.to_s
+      @model_hash = model_hash
+    end
+
+    def fields
+      @fields ||= model_hash['flds'].map { |f| f['name'] }
+    end
+
+    private
+
+    attr_reader :model_hash
+  end
+end

data/lib/apkg_to_csv/note.rb

@@ -0,0 +1,24 @@
+module ApkgToCsv
+  class Note
+    def self.from_db(db)
+      db.execute('SELECT mid, flds FROM notes').map do |model_id, field_string|
+        new(model_id, field_string)
+      end
+    end
+
+    attr_reader :model_id
+
+    def initialize(model_id, field_string)
+      @model_id = model_id.to_s
+      @field_string = field_string
+    end
+
+    def fields
+      @fields ||= field_string.split("\x1f")
+    end
+
+    private
+
+    attr_reader :field_string
+  end
+end

data/lib/apkg_to_csv/version.rb

@@ -0,0 +1,3 @@
+module ApkgToCsv
+  VERSION = '2.0.0'.freeze
+end

data/lib/apkg_to_csv.rb

@@ -0,0 +1,12 @@
+require_relative './apkg_to_csv/model'
+require_relative './apkg_to_csv/note'
+require_relative './apkg_to_csv/csv'
+
+module ApkgToCsv
+  def self.csv(db)
+    models = Model.from_db(db)
+    notes = Note.from_db(db)
+
+    Csv.from_notes(notes, models: models)
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: apkg-to-csv
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- zfletch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description:
+email:
+- zf.rubygems@gmail.com
+executables:
+- apkg-to-csv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- apkg-to-csv.gemspec
+- bin/apkg-to-csv
+- lib/apkg_to_csv.rb
+- lib/apkg_to_csv/csv.rb
+- lib/apkg_to_csv/model.rb
+- lib/apkg_to_csv/note.rb
+- lib/apkg_to_csv/version.rb
+homepage: https://github.com/zfletch/apkg-to-csv
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/zfletch/apkg-to-csv
+  source_code_uri: https://github.com/zfletch/apkg-to-csv
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Convert Anki deck (.apkg) files to comma-separated values (.csv) files.
+test_files: []