acts_as_learnable 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9092717ab1468252ea8a8cf91d265ec3e8027fbd
-  data.tar.gz: f079169cecead415c0f71e22f4b217bd76c592a9
+  metadata.gz: 24b49c5a5beec988626f52390586b33b40b40ec6
+  data.tar.gz: 38e31cd2da1105c780ae3aee8f081ebf3aba2d33
 SHA512:
-  metadata.gz: a7da136b1d6a9289f4757ec0547adadbff6c4099b2d5182396d63e8a85cd07e8d354c233e3e82a47204cf86d96a013a04e2047111041558bd1714ec8865f2c62
-  data.tar.gz: 3ec4488330cda7f47dd0c46fe8fdfb29963180d4e5341d0bde9bdea58d05fb71ccfa1268aa51153a8784e29ee4901cdc255c4bf2af8cee0a2aaa5ffbd2ec688d
+  metadata.gz: 8e7ff740e320e942b5a03a07cf2bd6da9a9dbf885fc964bb12d89fa30d5e6ec7a0a9af7316c617e5cd651dd2b728de6d72f4493656796504f734bc169e9ce9ac
+  data.tar.gz: ce389b6a20c055613ee143946eaab9f04bcf3cad8ade54ec61bad56f45abcab60324c6bea3f2216ada1ab3af30d334c8ef94f7d9c763141373ec6ba4e0f7c3ce

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.gem
+.DS_Store

data/README.md

@@ -1,6 +1,6 @@
 # ActsAsLearnable
 
-ActsAsLearnable is a Ruby gem for ActiveRecord models. It provides a simple way to create flashcards in your app. It automatically schedules flashcards for review depending on recall quality (1 to 5). You can easily create a Spaced Repetition System (SRS) using this gem.
+ActsAsLearnable is a Ruby gem for ActiveRecord models. It provides a simple way to create flashcards in your app. It automatically schedules flashcards for review depending on recall quality (1 to 5). You can easily create a Spaced Repetition System (SRS) using this gem. Flashcards are scheduled using SuperMemo 2 algorithm.
 
 ## Installation
 
@@ -18,6 +18,11 @@ Or install it yourself as:
 
     $ gem install acts_as_learnable
 
+Create and run migrations (will add flashcard fields if table already exists):
+
+    $ rails generate flashcard MODEL
+    $ rake db:migrate
+
 ## Usage
 
 Within your model call `acts_as_learnable` method:
@@ -32,18 +37,6 @@ It will automatically extend your class with all necessary methods.
 
 Make sure you have the following fields on the model (generators will be added later):
 
-```ruby
-ActiveRecord::Schema.define(version: 1) do
-  create_table :flashcards do |t|
-    t.float :easiness_factor, default: 2.5
-    t.integer :repetitions, default: 0
-    t.integer :interval, default: 0
-    t.date :due, default: nil
-    t.date :studied_at, default: nil
-  end
-end
-```
-
 Then you can review items:
 
 ```ruby
@@ -58,7 +51,7 @@ card.repetitions # => 1
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/acts_as_learnable/fork )
+1. Fork it ( https://github.com/itsdan/acts_as_learnable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
@@ -66,6 +59,5 @@ card.repetitions # => 1
 
 ## TODO
 
-* Migration generators
 * More detailed README
 * Other repetition algorithms (Anki)

data/acts_as_learnable.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'activerecord'
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activerecord', '~> 4.0'
+  spec.add_dependency 'activesupport', '~> 4.0'
 
-  spec.add_development_dependency 'bundler', "~> 1.7"
-  spec.add_development_dependency 'rake', "~> 10.0"
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'byebug', '~> 4.0'
 end

data/lib/acts_as_learnable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsLearnable
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/generators/flashcard/flashcard_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+class FlashcardGenerator < ActiveRecord::Generators::Base
+  include Rails::Generators::Migration
+
+  desc 'This generator creates a migration file with flashcard fields.'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def install_flashcards
+    if File.exist?("#{destination_root}/db/schema.rb") &&
+       File.read("#{destination_root}/db/schema.rb") =~ /create_table \"#{table_name}\"/
+      migration_template(
+        'add_fields_migration.rb',
+        "db/migrate/add_flashcard_fields_to_#{table_name}.rb")
+    else
+      migration_template('create_table_migration.rb', "db/migrate/create_#{table_name}.rb")
+    end
+  end
+end

data/lib/generators/flashcard/templates/add_fields_migration.rb

@@ -0,0 +1,17 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= table_name %>, :easiness_factor, :float,   default: 2.5
+    add_column :<%= table_name %>, :repetitions,     :integer, default: 0
+    add_column :<%= table_name %>, :interval,        :integer, default: 0
+    add_column :<%= table_name %>, :due,             :date,    default: nil
+    add_column :<%= table_name %>, :studied_at,      :date,    default: nil
+  end
+
+  def self.down
+    remove_column :<%= table_name %>, :easiness_factor
+    remove_column :<%= table_name %>, :repetitions
+    remove_column :<%= table_name %>, :interval
+    remove_column :<%= table_name %>, :due
+    remove_column :<%= table_name %>, :studied_at
+  end
+end

data/lib/generators/flashcard/templates/create_table_migration.rb

@@ -0,0 +1,15 @@
+class <%= @migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table '<%= table_name %>' do |t|
+      t.column :easiness_factor, :float,   default: 2.5
+      t.column :repetitions,     :integer, default: 0
+      t.column :interval,        :integer, default: 0
+      t.column :due,             :date,    default: nil
+      t.column :studied_at,      :date,    default: nil
+    end
+  end
+
+  def self.down
+    drop_table '<%= table_name %>'
+  end
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_learnable
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Danya Kim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,30 +70,30 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 description: ActsAsLearnable is a Ruby gem for ActiveRecord models. It provides a
   simple way to create flashcards in your app. It automatically schedules flashcards
   for review depending on recall quality (1 to 5). You can easily create a Spaced
@@ -113,9 +113,9 @@ files:
 - lib/acts_as_learnable.rb
 - lib/acts_as_learnable/base.rb
 - lib/acts_as_learnable/version.rb
-- lib/generators/acts_as_learnable/USAGE
-- lib/generators/acts_as_learnable/templates/add_fields_migration.rb
-- lib/generators/acts_as_learnable/templates/create_table_migration.rb
+- lib/generators/flashcard/flashcard_generator.rb
+- lib/generators/flashcard/templates/add_fields_migration.rb
+- lib/generators/flashcard/templates/create_table_migration.rb
 - test/test_base.rb
 - test/test_helper.rb
 homepage: http://github.com/itsdan/acts_as_learnable