trivia_factory 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 061fd3b7cdd3fb4ffd630cd1bd08d5cff5b8b654
-  data.tar.gz: 11585669b30b6bef798bc1d34d368935427b9117
+  metadata.gz: 4524191157360deda5cebba57fdf401f4ff03140
+  data.tar.gz: 588645eae9360aa04178b207850b9aaa16dcd1e8
 SHA512:
-  metadata.gz: 38cb4a15e72f227dfc6315da238e3cce9c2c14e92d32f9ad0ec670795a3fc9bb6f9f26fdf40d26edd5608cc72e29714611c722ba7a0a544d78f304508b178cd3
-  data.tar.gz: 69be04c20a13dd803d43d2faf637ff04278d361f8864a743d715d76c896d2b8e34a205960b7d3064238c4815c98a73e439f046e18f400bd441b6e90041b9d559
+  metadata.gz: 354348a7f0a91e1804f94f5efa0b7243e5c42f4375e61885cf6a31f2428c827f7246f203585fe8b16c57a42b5eb000cc3a399b7044446fc1d97fa799b08ce1bb
+  data.tar.gz: b56f43c564a52618d6de63c732f875af86f9c45f9d8a35eb764e489ccc1fb7f0023b3db7dac5bbde1afe0eb70edf4e4e08772614ca8bd9459e1d35db48e380f3

data/README.md

@@ -1,43 +1,103 @@
 # Trivia Factory
 
-Ruby gem for creating sample trivia/test questions. Intended for use in specs (like Faker) or apps that need questions.
+Ruby gem for creating tons of sample trivia/test questions. Intended for use in specs or apps that need questions.
+Think of it as [Faker](https://github.com/stympy/faker) for trivia questions.
+
+Originally part of a sports trivia app I had that was somewhat popular (Hat Trick), this gem uses tables of data (in CSV form) to
+create random questions.
 
 ## Installation
 
-*Coming soon (gem not published yet)*
+`gem install trivia_factory`
+
+If you're using Bundler and/or Rails, add the following to your Gemfile:
+
+`gem 'trivia_factory'`
 
 ## Usage
 
-Sample question (not random yet):
+### Generate a random question (from all available types)
 
-```
+`question = TriviaFactory::Question.random`
 
-> question = TriviaFactory::Question.generate
->
-> question.to_h
-> {
->   label: "Who won the MLB World Series in 2016?",
->   question_type: :multiple_choice,
->   choices: ["San Francisco Giants", "Chicago Cubs", "Cleveland Indians", "Golden State Warriors"],
->   answer_type: :choice_index,
->   answer: 1
-> }
+This will return a `TriviaFactory::Question` object. Use the `to_h` helper to get it as a hash.
 
 ```
+question.to_h
 
-Basic math question (addition of random integers):
-
+{
+            :label => "Sacramento is the capital of what US state?",
+    :question_type => :multiple_choice,
+          :choices => [
+            "Oklahoma",
+            "Delaware",
+            "California",
+            "Oregon"
+          ],
+           :answer => 2,
+      :answer_type => :choice_index
+}
 ```
 
-> question = TriviaFactory::Question.math(10)
-> 
-> question.to_h
-> {
->   label: "5 + 3 = _____?",
->   question_type: :fill_in_the_blank,
->   choices: [],
->   answer_type: :integer,
->   answer: 8
-> }
+### Question object structure
+
+Question objects have the following attributes (which are also available as keys in the hash):
+
+**label**: this is the actual question being asked
+
+**question_type**: a symbol denoting the type of question. Will be one of the following:
+
+* :true_false
+* :multiple_choice
+* :fill_in_the_blank
+
+**choices**: an array of choices for multiple choice questions. Will be an empty array (not `nil`) for other question types.
+
+**answer**: the correct answer for the question. Its type/class may vary (see below).
+
+**answer_type**: specifies the type of answer. Will be one of the following: `[:choice_index, :boolean, :string, :integer]`. *Note*: when `:choice_index`, the correct answer corresponds to the correct choice in the `choices` array.
+
+### Question categories
+
+Currently the following question categories exist as subclasses of `TriviaFactory::Question`:
+
+**TriviaFactory::MathQuestion**: generates a basic integer addition problem (fill in the blank).
+
+**TriviaFactory::SportsQuestion**: generates a sports trivia question (multiple choice).
+
+**TriviaFactory::UsStateCapitalsQuestion**: generates a question about US state capitals.
+
+**TriviaFactory::VocabularyQuestion**: generates a multiple choice vocabulary *word* <-> *definition* question. From a list of 1,000 vocabulary study words.
+
+To create a question from any of these types, simply call the `generate()` method on any of the classes.
+
+### More examples
 
 ```
+# Math question can accept a max param that can limit the size of operands
+q = TriviaFactory::MathQuestion.generate(20)
+q.to_h
+=>  {
+      :label         => "5 + 5 = _____?",
+      :question_type => :fill_in_the_blank,
+      :choices       => [],
+      :answer        => 10,
+      :answer_type   => :integer
+    }
+```
+
+```
+q = TriviaFactory::SportsQuestion.generate
+q.to_h
+=> {
+      :label         => "In 1987 who defeated the St. Louis Cardinals to win the World Series?",
+      :question_type => :multiple_choice,
+      :choices       => ["Detroit Tigers", "Minnesota Twins", "Anaheim Angels", "New York Yankees"],
+      :answer        => 1,
+      :answer_type   => :choice_index
+    }
+```
+
+## Contributing
+
+Contributions welcome. Add a CSV to the data/ folder, create a subclass, write a test, and submit a PR.

data/lib/trivia_factory/capital_cities_question.rb

@@ -0,0 +1,22 @@
+module TriviaFactory
+  class CapitalCitiesQuestion < Question
+
+    class << self
+      def generate
+        # File: capital_cities.csv
+        # Column 1: city
+        # Column 2: country
+        data = fetch_csv('capital_cities')
+        answer_row = data.sample
+        question = TriviaFactory::Question.new
+        question.label = "#{answer_row[0]} is the capital city of what country?"
+        question.question_type = :fill_in_the_blank
+        question.answer_type = :string
+        question.answer = answer_row[1]
+        question.choices = []
+        question
+      end
+    end
+
+  end
+end

data/lib/trivia_factory/version.rb

@@ -1,3 +1,3 @@
 module TriviaFactory
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/trivia_factory.rb

@@ -43,7 +43,7 @@ module TriviaFactory
       end
 
       def generate
-        question = TriviaFactory::Question.new
+        TriviaFactory::Question.new
       end
 
       def math(max = 100)
@@ -54,6 +54,10 @@ module TriviaFactory
         TriviaFactory::UsStateCapitalsQuestion.generate
       end
 
+      def capital_cities
+        TriviaFactory::CapitalCitiesQuestion.generate
+      end
+
       def sports
         TriviaFactory::SportsQuestion.generate
       end
@@ -64,7 +68,7 @@ module TriviaFactory
 
       def fetch_csv(name)
         file = File.join(File.dirname(__FILE__), "data", "#{name}.csv")
-        data = CSV.read(file)
+        CSV.read(file)
       end
     end
   end
@@ -74,3 +78,4 @@ require "trivia_factory/vocabulary_question"
 require "trivia_factory/math_question"
 require "trivia_factory/sports_question"
 require "trivia_factory/us_state_capitals_question"
+require "trivia_factory/capital_cities_question"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trivia_factory
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Callmeed
@@ -71,11 +71,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/data/country_capitals.csv
+- lib/data/capital_cities.csv
 - lib/data/sports_champions.csv
 - lib/data/us_state_capitals.csv
 - lib/data/vocabulary.csv
 - lib/trivia_factory.rb
+- lib/trivia_factory/capital_cities_question.rb
 - lib/trivia_factory/math_question.rb
 - lib/trivia_factory/sports_question.rb
 - lib/trivia_factory/us_state_capitals_question.rb