anki 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1821356b088ea19655b5ac0d3365a754053c6a4
+  data.tar.gz: 43d256ce60dd223d14608147b64c1f3b62f96584
+SHA512:
+  metadata.gz: cbc2ba00f45a777cca7561e73224fcbf2dd1c7c148bf16625f47bd56b0c17ec790f95ad2f0743a976dd03ef2e47db46153fb81991ecca39ec67174de4fc70bb6
+  data.tar.gz: cc2243b6267c3c569645508f48f539803ceecc815c588627e2560120ade04c000589c695dfd4c63f0953220d35a3819b069542859c82250c27620e0df0898f27

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in anki.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dennis Martinez
+
+MIT License
+
+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,54 @@
+# Anki
+
+Generate decks ready to be imported into [Anki](http://ankisrs.net/)! The anki gem will take an array of hashes and convert them into a string which can then be saved to a file that is ready to be imported into your Anki decks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'anki'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install anki
+
+## 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.
+
+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)
+
+# Alternatively, you can pass in the array of hashes for card data
+# after initializing the object:
+deck.card_data = cards
+
+deck.generate_deck
+  # => "Front of the card;Back of the card\nAnother card;Another answer"
+
+# 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")
+```
+
+## Contributing
+
+1. Fork the anki gem into your own repo (https://github.com/dennmart/anki/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`) and make sure your write tests for your new feature!
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+6. That's it! High fives given upon request :)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec
+

data/anki.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'anki/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "anki"
+  spec.version       = Anki::VERSION
+  spec.authors       = ["Dennis Martinez"]
+  spec.email         = ["dennis@dennmart.com"]
+  spec.summary       = "Generate decks ready to be imported into Anki!"
+  spec.description   = "Generate decks ready to be imported into Anki! Just pass an array of hashes and get back a string that you can save in a file and import directly into Anki."
+  spec.homepage      = "https://github.com/dennmart/anki"
+  spec.license       = "MIT"
+
+  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)/})
+  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"
+end

data/lib/anki.rb

@@ -0,0 +1,2 @@
+require "anki/version"
+require "anki/deck"

data/lib/anki/deck.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+module Anki
+  class Deck
+    attr_accessor :card_data
+
+    def initialize(options = {})
+      @card_data = options.delete(:card_data)
+    end
+
+    def generate_deck(options = {})
+      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")
+      create_file(anki_string, options[:file]) if options[:file]
+      anki_string
+    end
+
+    private
+
+    def create_file(str, file)
+      File.open(file, 'w') { |f| f.write(str) }
+    end
+  end
+end

data/lib/anki/version.rb

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

data/spec/anki/deck_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Anki::Deck do
+  describe "#generate_deck" do
+    subject { Anki::Deck.new }
+    let(:cards) { [{ "a" => "b" }, { "c" => "d" }] }
+
+    it "raises an ArgumentError if card_data is not an array" do
+      subject.card_data = "I'm card_data!"
+
+      expect {
+        subject.generate_deck
+      }.to raise_error(ArgumentError)
+    end
+
+    it "raises an ArgumentError if card_data is an empty array" do
+      subject.card_data = []
+
+      expect {
+        subject.generate_deck
+      }.to raise_error(ArgumentError)
+    end
+
+    it "returns a string with the card_data hashes, separating key and value with a semicolon and adding line breaks" do
+      subject.card_data = cards
+      subject.generate_deck.should == "a;b\nc;d"
+    end
+
+    it "saves to a file if the file option is passed" do
+      subject.card_data = cards
+      subject.generate_deck(file: "/tmp/anki_deck.txt")
+      File.exists?("/tmp/anki_deck.txt").should be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "anki"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: anki
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Martinez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Generate decks ready to be imported into Anki! Just pass an array of
+  hashes and get back a string that you can save in a file and import directly into
+  Anki.
+email:
+- dennis@dennmart.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- anki.gemspec
+- lib/anki.rb
+- lib/anki/deck.rb
+- lib/anki/version.rb
+- spec/anki/deck_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/dennmart/anki
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Generate decks ready to be imported into Anki!
+test_files:
+- spec/anki/deck_spec.rb
+- spec/spec_helper.rb