anki 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1821356b088ea19655b5ac0d3365a754053c6a4
-  data.tar.gz: 43d256ce60dd223d14608147b64c1f3b62f96584
+  metadata.gz: 6c21472ccaf55739e044a25afb9ffc66e2752a41
+  data.tar.gz: b21056c3a15d6e8e32408d11f2073e474a21323b
 SHA512:
-  metadata.gz: cbc2ba00f45a777cca7561e73224fcbf2dd1c7c148bf16625f47bd56b0c17ec790f95ad2f0743a976dd03ef2e47db46153fb81991ecca39ec67174de4fc70bb6
-  data.tar.gz: cc2243b6267c3c569645508f48f539803ceecc815c588627e2560120ade04c000589c695dfd4c63f0953220d35a3819b069542859c82250c27620e0df0898f27
+  metadata.gz: d6661f4ae89070e88e122b2dd9d6db74649c630d617cb16dec93eb2c062ea65b5f9d7b5b28affb4e820e5db714428b991d6071414770efdb749a1e1b858a2890
+  data.tar.gz: d1cd3de9ecd1f9e7896f8b575ae9fa49bcafc4e7b2f323d64df65e188ba90e8c27e9fe6357330536e68d5fefb0adaed4451691455ec694c2886317c54ab8f1db

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 0.0.2 (April 20, 2014)
+* Card data can now include tags for importing into Anki.
+
 ## 0.0.1 (April 8, 2014 - Initial release!)
 * Basic importing of an array of hashes into a string that can be used to create files to import to Anki (plain text only).
 * Optionally saving string directly to a file, ready to be imported into Anki.

data/README.md

@@ -18,9 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-After requiring the anki gem, simply create a new instance of `Anki::Deck`, pass in an array of hashes (either including the `card_data` option when creating the `Anki::Deck` object, or using the `Anki::Deck#card_data` method), and generate the deck by using the `Anki::Deck#generate_deck` method. It will return a string that is formatted to be ready to be saved into a file for importing into Anki.
+### Generating a string for cards
 
-Alternatively, you can pass an optional `file` option when generating the deck to save the string into a file directly.
+After requiring the anki gem, simply create a new instance of `Anki::Deck`, pass in an array of hashes (either including the `card_data` option when creating the `Anki::Deck` object, or using the `Anki::Deck#card_data` method), and generate the deck by using the `Anki::Deck#generate_deck` method. It will return a string that is formatted to be ready to be saved into a file for importing into Anki.
 
 ```ruby
 require 'anki'
@@ -38,12 +38,42 @@ deck.card_data = cards
 
 deck.generate_deck
   # => "Front of the card;Back of the card\nAnother card;Another answer"
+```
+
+### Generating a file
+
+Alternatively, you can pass an optional `file` option when generating the deck to save the string into a file directly.
 
+```ruby
+require 'anki'
+
+cards = [
+          { "Front of the card" => "Back of the card" },
+          { "Another card" => "Another answer" }
+        ]
+
+deck = Anki::Deck.new(card_data: cards)
 # If you want to save it into a file directly, you can pass an optional `file` option
 # with the path where you want to save the file:
 deck.generate_deck(file: "/tmp/anki_deck.txt")
 ```
 
+### Including card tags
+
+If you want to include tags with the generated Anki deck, the value of the card data can be a hash that includes an array of strings.
+
+```ruby
+require 'anki'
+
+card = [
+         { "Front" => { "value" => "Back", "tags" => ["tag1, tag2"]} }
+       ]
+
+deck = Anki::Deck.new(card_data: card)
+deck.generate_deck
+  # => "Front;Back;tag1 tag2"
+```
+
 ## Contributing
 
 1. Fork the anki gem into your own repo (https://github.com/dennmart/anki/fork)

data/anki.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.14"
   spec.add_development_dependency "fakefs", "~> 0.5"

data/lib/anki/deck.rb

@@ -11,13 +11,26 @@ module Anki
       raise ArgumentError, "card_data should be an array of hashes" if !self.card_data.is_a?(Array)
       raise ArgumentError, "You need card data." if self.card_data.empty?
 
-      anki_string = self.card_data.map { |card| "#{card.keys.first};#{card.values.first}" }.compact.join("\n")
+      anki_string = self.card_data.map { |card| card_data_to_string(card) }.compact.join("\n")
       create_file(anki_string, options[:file]) if options[:file]
       anki_string
     end
 
     private
 
+    def card_data_to_string(card)
+      front_card = card.keys.first
+      back_card = card.values.first
+
+      if back_card.is_a?(String)
+        "#{front_card};#{back_card}"
+      elsif back_card.is_a?(Hash)
+        back_card_value = back_card["value"]
+        tags = back_card["tags"].join(" ")
+        "#{front_card};#{back_card_value};#{tags}"
+      end
+    end
+
     def create_file(str, file)
       File.open(file, 'w') { |f| f.write(str) }
     end

data/lib/anki/version.rb

@@ -1,3 +1,3 @@
 module Anki
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/anki/deck_spec.rb

@@ -31,5 +31,13 @@ describe Anki::Deck do
       subject.generate_deck(file: "/tmp/anki_deck.txt")
       File.exists?("/tmp/anki_deck.txt").should be_true
     end
+
+    it "returns a string including tags if the value of each card data is a hash" do
+      subject.card_data = [{ "a" => { "value" => "b", "tags" => ["level1"] } },
+                           { "c" => { "value" => "d", "tags" => ["level1", "level2"] } }]
+
+      subject.generate_deck.should match /a;b;level1/
+      subject.generate_deck.should match /c;d;level1 level2/
+    end
   end
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: anki
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dennis Martinez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-08 00:00:00.000000000 Z
+date: 2014-04-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +63,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt