ank3 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7264b15ab44ed69dddccfe928e26595b2769b855987ed9190fed2274a7a8da37
-  data.tar.gz: 2811385ba9476ca20a574e52f9bfebc8d0ef6695b9b16a6ac84a1db53a32967f
+  metadata.gz: ba67428ad2764e669fc40069a5ca14aa90b5d25717546074d5fd87ea86c9b63e
+  data.tar.gz: 4eb033d5c51fde87071848be058d73fda15717876b6f05b6425e498629a5f32c
 SHA512:
-  metadata.gz: d27f79862af764610b4edeedea1c6c1f6e099c83579bd3eaf15ad658303821a24fc81d54315e0e908475c90a0e47de7f6b45b55a4a48d843aff7c419d0e9cc68
-  data.tar.gz: 043b74edfa4bb40438546ce82eb7dd52cc728c9ef3bed44dc4c9f8fedfc4fc08e17aa3db1c7044f68dd1fb51ff6e97c3f335d1bddc4f200778c69b5ede98764e
+  metadata.gz: 122e6ca454cf798551dfc8a0d9b27ebff2c69e53799e9760c9d79ef27e5d70204750308602b3c0aef30584d37b47f0ff032060bf7e207ba12f9924332af3f472
+  data.tar.gz: d035c2aebc1be263a7b207439497884e72ac1f81c2f091b8fc6162f219f3e2108d1a76081d10d3231cdfb502da5a7dae42a4100bb9f81d6840eab9264ecdb2a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ank3 (0.1.0)
+    ank3 (0.2.0)
       thor
 
 GEM
@@ -13,7 +13,7 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -36,7 +36,7 @@ DEPENDENCIES
   ank3!
   bundler (~> 2.0)
   pry
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,19 @@
 # Ank3
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ank3`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ank3 is a simple command line interface (CLI) to create text files that can be ingested by Anki to create Anki cards.
+Alternatively, you can generate a boilerplate YAML file where you can create cards with a front, back, and tags.
 
-TODO: Delete this and the text above, and describe your gem
+## Motivation and Anki work flow
+
+I personally use Anki to review anything that I study. I don't always have the app available
+nor do I want to always use the app to create new cards. Sometimes I want to review the questions/answers
+of the cards because I actually create them, so I put them in a separate text file where I copy and paste
+to questions and answers to Anki when I'm ready to create the cards. This procedure is too manual, so I
+thought I would try to automate it by creating this gem.
+
+You might ask why not just create the simple Anki text file? 
+The reason is because I would like to use the YAML files for other purposes, such 
+as storing or parsing it as notes. 
 
 ## Installation
 
@@ -22,11 +33,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To parse a YAML file to a Anki .txt file, simply run:
+
+```./ank3 covert [FILE.yml]``` in the command line.
+
+Example:
+
+Using a YAML file that looks like:
+
+```yaml
+---
+- front: 'What is 1+1?'
+  back: 'Two'
+  tags: []
+---
+- front: 'What is H20?'
+  back: 'Water'
+  tags: []
+```
+
+will generate a .txt file that looks like:
+
+```
+What is 1+1?; Two
+What is H2O?; Water
+```
+
+To generate a boilerplate file, simply run:
+
+```./ank3 generate_boilerplate [number of cards]``` and it will generate a YAML file containing an array with [number of cards] of hashes.
+
+For example:
+
+```./ank3 generate_boilerplate 3``` will generate a YAML file with 3 hashes, each representing a card looking like this:
+
+```yaml
+---
+- front: ''
+  back: ''
+  tags: []
+- front: ''
+  back: ''
+  tags: []
+- front: ''
+  back: ''
+  tags: []
+```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/ank3.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "thor"
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry"
 end

data/bin/ank3

@@ -2,14 +2,5 @@
 
 require "bundler/setup"
 require "ank3"
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-# require "irb"
-# IRB.start(__FILE__)
  
 Ank3::Cli.start(ARGV)

data/lib/ank3/cli.rb

@@ -6,8 +6,8 @@ module Ank3
     end
 
     desc "generate_boilerplate", "Generate a boilerplate YAML file"
-    def generate_boilerplate(number = 1, file_name = "ank3.yml")
-      Ank3::Collection.generate_boilerplate_file(number, file_name)
+    def generate_boilerplate(file_name = "ank3.yml", number = 1)
+      Ank3::Collection.generate_boilerplate_file(file_name, number)
     end
   end
 end

data/lib/ank3/collection.rb

@@ -1,8 +1,9 @@
 module Ank3
   class Collection
-    attr_reader :cards, :data
+    attr_reader :cards, :data, :basename
 
     def initialize(file)
+      @basename = File.basename(file, ".yml")
       @data  = YAML.load(File.read(file))
       @cards = []
       convert_data_to_cards
@@ -16,14 +17,15 @@ module Ank3
       @cards.map { |card| card.convert if front_and_back_present?(card) }.join("")
     end
 
-    def write_to_file(name = "cards")
-      File.open("#{name}.txt", "w") do |file|
+    def write_to_file(name = "")
+      file_name = name != "" ? name : @basename
+      File.open("#{file_name}.txt", "w") do |file|
         file.write(convert)
         file
       end
     end
 
-    def self.generate_boilerplate_file(number = 1, file_name = "ank3.yml")
+    def self.generate_boilerplate_file(file_name = "ank3.yml", number = 1)
       array_of_hashes = []
       number.to_i.times do 
         array_of_hashes << {
@@ -36,6 +38,11 @@ module Ank3
         file.write(array_of_hashes.to_yaml)
         file
       end
+      new_file = convert_yaml_to_double_quotes!(file_name)
+      File.open(file_name, "w") do |file|
+        file.write(new_file)
+        file
+      end
     end
 
     private 
@@ -49,5 +56,10 @@ module Ank3
     def front_and_back_present?(card)
       !card.front.empty? && !card.back.empty?
     end
+
+    def self.convert_yaml_to_double_quotes!(file)
+      # https://stackoverflow.com/questions/18316333/how-do-i-force-double-quotes-when-dumping-yaml
+      File.read(file).gsub("'", "\"")
+    end
   end
 end

data/lib/ank3/version.rb

@@ -1,3 +1,3 @@
 module Ank3
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ank3
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hobertro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-18 00:00:00.000000000 Z
+date: 2020-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"