anki 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d03bcf99764d976e6bc02dbdbf1da11545251922
-  data.tar.gz: 236e8230c7c684cbc3725df691c9bfcfac28e686
+  metadata.gz: 940654172201a6b4de10c67eb11c368c2b267077
+  data.tar.gz: 7bf0e269515b06e5717fe6348e48b238fae5433b
 SHA512:
-  metadata.gz: 3bbc95a72f555828ef77a8ab885fe20816a20148683fc408f918e4d04cc45fd784c357f5426c8410c8c02dc47bc36cc6e09da424d2d1ba1adcc80d35a15a76a8
-  data.tar.gz: 73b38e18b8b3f2633ef134365e42e9a3c40d2e00717aa62fc4e6106d1a06c05e7b458ca43dc54d59cb9161ee8d1ef6b147c77bc78abe0bdcd22da2d1ee8d2eb8
+  metadata.gz: 3e12a89d99a6389e7d39dfe0aea0c21a836dcfff3db56420075605c769e0cc81dd65596ef3209ee98b53cd802d5d4ca53af10804ea4c8e7d7423bbb7e8ce9cea
+  data.tar.gz: 2699b02fa6866fcdb7c6f13b5876ad33930244793dab71b1756136c7806cce10044d69eb1b7537915ec5aeb1d81c36bea1dc2911e703c285df5cbe260f946a52

data/.travis.yml

@@ -1,7 +1,8 @@
 language: ruby
+sudo: false
 rvm:
-  - 2.2
-  - 2.1
+  - 2.3.1
+  - 2.2.5
+  - 2.1.10
   - 2.0.0
   - 1.9.3
-  - 1.9.2

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.0.4 (August 11, 2016)
+* #4: Custom field separators can be specified when generating a deck - Thanks to Bill Robinson (@dseevr)
+
+## 0.0.3 (February 2, 2015)
+* Card headers must to be set up when generating the deck.
+
 ## 0.0.2 (April 20, 2014)
 * Card data can now include tags for importing into Anki.
 

data/README.md

@@ -58,6 +58,7 @@ deck.generate_deck(file: "/tmp/anki_deck.txt")
 ```
 
 ### Including card tags
+
 Tags are nothing special. Any field can be used as the Tag. When you are importing to Anki set the Field mapping to "Map to Tags" by clicking on the Change button for the field that contains your tags.
 
 ```ruby
@@ -73,6 +74,23 @@ deck.generate_deck
   # => "#front;back;Tags\nFront of the card;Back of the card;one_tag\nAnother card;Another answer;multiple tags are separated by spaces"
 ```
 
+### Custom field separators
+
+By default, fields are separated by semicolons when generating a deck. If you want to use a custom field separator, you can add an optional `field_separator` option when generating the deck.
+
+```ruby
+require 'anki'
+
+headers = [ "front", "back", "Tags" ]
+cards = [
+          { "front" => "Front of the card", "back" => "Back of the card", "Tags" => "one_tag" },
+          { "front" => "Another card", "back" => "Another answer", "Tags" => "multiple tags are separated by spaces" }
+        ]
+deck = Anki::Deck.new(card_headers: headers, card_data: cards, field_separator: "|")
+deck.generate_deck
+  # => "#front|back|Tags\nFront of the card|Back of the card|one_tag\nAnother card|Another answer|multiple tags are separated by spaces"
+```
+
 ## Contributing
 
 1. Fork the anki gem into your own repo (https://github.com/dennmart/anki/fork)

data/anki.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/dennmart/anki"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 1.9.3'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})

data/lib/anki/deck.rb

@@ -1,11 +1,12 @@
 # coding: utf-8
 module Anki
   class Deck
-    attr_accessor :card_headers,:card_data
+    attr_accessor :card_headers,:card_data,:field_separator
 
     def initialize(options = {})
       @card_headers = options.delete(:card_headers)
       @card_data = options.delete(:card_data)
+      @field_separator = options.delete(:field_separator) || ";"
     end
 
     def generate_deck(options = {})
@@ -24,7 +25,7 @@ module Anki
     private
 
     def card_header_to_string()
-      "#" + self.card_headers.join(";") + "\n"
+      "#" + self.card_headers.join(@field_separator) + "\n"
     end
 
     def card_data_to_string(card)
@@ -32,7 +33,7 @@ module Anki
 
       card.default = ""
 
-      self.card_headers.map{ |header| card[header] }.join(";")
+      self.card_headers.map{ |header| card[header] }.join(@field_separator)
     end
 
     def create_file(str, file)

data/lib/anki/version.rb

@@ -1,3 +1,3 @@
 module Anki
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/anki/deck_spec.rb

@@ -60,6 +60,13 @@ RSpec.describe Anki::Deck do
       expect(subject.generate_deck).to eq("#front;back\na;b\nc;d")
     end
 
+    it "returns a string with the card_headers comment, card_data values separated by a custom delimiter, and new cards by line breaks" do
+      subject.card_headers = headers
+      subject.card_data = cards
+      subject.field_separator = "|"
+      expect(subject.generate_deck).to eq("#front|back\na|b\nc|d")
+    end
+
     it "saves to a file if the file option is passed" do
       subject.card_headers = headers
       subject.card_data = cards

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anki
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dennis Martinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Generate decks ready to be imported into Anki!