quiz_master 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09793a75650ae624f014961a958ef09200897de6
-  data.tar.gz: 1295731425c36fe6102eec09c597a6b51baa0d13
+  metadata.gz: f36424722d7858fc0043388e0bcef810ddf656e4
+  data.tar.gz: 64f08b1237efe768726c9074273fda972c751680
 SHA512:
-  metadata.gz: 059830f6aacc192b851e2f04e3e474fee6529218f7769e9e34746a6374353533380c7d78e76ddc2a7b50238850cf0e2025b53f99085711cadd05f517209cb3fa
-  data.tar.gz: 464e3605d6583ba127fb985dc879a74f958b8ebba989a84b95fbea62adec880736e467ffc51af70ef1e012640ac808708d3de045e51ca0ff920bc8f8e823fe6d
+  metadata.gz: 7350ceb335a2e36be33902c8a0dde0dc6f423f7eb85f0e7ad5b3291cc77c8e054b21b4162f6364256caa55336f8df78f5cc4a5065564f9dec13c56e470036b8c
+  data.tar.gz: 3a26fba34d62deadce6085e68f3d64fdb38c4bb28dcd4c92d350f1f9d554be36e94f08c0c9a23fafbc8cb02c4c9c9f8656a8f9cd078e1975e0c9016aec1cd1de

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change log
+
+## master (unreleased)
+
+### New features
+
+### Bugs fixed
+
+## 0.0.2 (2014-07-24)
+
+### New Features
+
+* [#1](https://github.com/mikestok/quiz_master/issues/1): Add TextQuestionSheetFormatter
+
+## 0.0.1 (2014-07-20)
+
+### New Features
+
+* [#2](https://github.com/mikestok/quiz_master/issues/2): Add TextAnswerSheetFormatter

data/Rakefile

@@ -21,6 +21,6 @@ end
 
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.rdoc_files.include('README.md', 'CHANGELOG.md', 'lib/**/*.rb')
   rdoc.options << '--markup=tomdoc'
 end

data/lib/quiz_master.rb

@@ -1,6 +1,7 @@
 require 'quiz_master/version'
 require 'quiz_master/text_question_formatter'
 require 'quiz_master/text_answer_sheet_formatter'
+require 'quiz_master/text_question_sheet_formatter'
 require 'quiz_master/question'
 require 'quiz_master/rendered_question'
 require 'quiz_master/answer'

data/lib/quiz_master/answer.rb

@@ -13,10 +13,16 @@ module QuizMaster
 
     # Public: Initialize an Answer.
     #
-    # text - a String of text for the answer.
+    # text    - a String of text for the answer.
     # correct - whether this answer is true or false.
-    # tag - an optional String which can be used to reference this Answer from
-    #       other Answers.
+    # tag     - an optional String which can be used to reference this Answer
+    #           from other Answers.
+    #
+    # Examples
+    #
+    #     a1 = Answer.new('Correct!', true)
+    #     a1.text                           # => 'Correct!'
+    #     a1.correct?                       # => true
     def initialize(text, correct, tag = nil)
       @text = text.to_s
       @correct = correct

data/lib/quiz_master/quiz.rb

@@ -1,14 +1,26 @@
 module QuizMaster
   # A quiz is a set of questions and their answers.
+  #
+  # Examples
+  #
+  #    quiz = Quiz.new([q1, q2, q3, q4])
   class Quiz
+    # Gets the String to be used as the header of a Quiz.
+    attr_reader :header
+    # Gets the String to be used as the footer of a Quiz.
+    attr_reader :footer
+    # Gets the Array of Questions in the Quiz.
+    attr_reader :questions
+
     # Public: Initialize a quiz with an Array of Quesitons.
     #
-    # questions - An Array of Questions
-    def initialize(questions)
+    # questions - An Array of Questions.
+    # header    - A String containg header text (optional).
+    # footer    - A String containg footer text (optional).
+    def initialize(questions, header: '', footer: '')
       @questions = questions
+      @header = header
+      @footer = footer
     end
-
-    # Gets the Array of Questions
-    attr_reader :questions
   end
 end

data/lib/quiz_master/text_question_formatter.rb

@@ -1,10 +1,40 @@
 module QuizMaster
   # This class is responsible for formatting a Question as a text
   # representation.
+  #
+  # In its current state it is used to help with testing and debugging, so
+  # notions such as line length aren't considered.
+  #
+  # Examples
+  #
+  #    include QuizMaster
+  #
+  #    q = Question.new(
+  #      prompt: 'This is the prompt.  It poses the question.',
+  #      answers: [
+  #        Answer.new('This is the first answer', '5'),
+  #        Answer.new('This is the second answer'),
+  #        Answer.new('This is the third answer', '3'),
+  #        Answer.new('{{3}} and {{5}}')
+  #      ]
+  #    )
+  #
+  #    TextQuestionFormatter.new.format(q, 1)
+  #    # =>
+  #    # 1) This is the prompt.  It poses the question.
+  #    #
+  #    #   a) This is the first answer
+  #    #   b) This is the second answer
+  #    #   c) This is the third answer
+  #    #   d) (a) and (c)
+  #
   class TextQuestionFormatter
     # Public: This formats a question and its answers with a leading number.
     #
-    # Returns: A String containing the formatted Question.
+    # question - The Question to be formatted into a String.
+    # number   - An Integer used as the number for the Question.
+    #
+    # Returns a String containing the formatted Question.
     def format(question, number)
       answers = AnswersRenderer.new(answers: question.answers, first_tag: 'a')
 

data/lib/quiz_master/text_question_sheet_formatter.rb

@@ -0,0 +1,33 @@
+require_relative 'text_question_formatter'
+
+module QuizMaster
+  # This is responsible for generating a text version of Quizes.
+  class TextQuestionSheetFormatter
+    def initialize
+      @question_formatter = TextQuestionFormatter.new
+    end
+
+    # Format a given Quiz
+    #
+    # quiz - The Quiz to be formatted
+    #
+    # Returns a String containing the formatted Quiz.
+    def format(quiz)
+      header(quiz) + "\n" + questions(quiz) + "\n" + footer(quiz)
+    end
+
+    private def header(quiz)
+      quiz.header + "\n"
+    end
+
+    private def questions(quiz)
+      quiz.questions.zip(1 .. Float::INFINITY).map do |q, n|
+        @question_formatter.format(q, n)
+      end.join("\n")
+    end
+
+    private def footer(quiz)
+      quiz.footer + "\n"
+    end
+  end
+end

data/lib/quiz_master/version.rb

@@ -1,5 +1,5 @@
 #
 module QuizMaster
   # The Gem version. We will use semantic versioning: http://semver.org
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/quiz_master.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['mike@stok.ca']
   spec.summary       = 'Simple manager for multiple choice quizzes'
   # spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/mikestok/quiz_master'
   spec.license       = 'MIT'
 
   # Because there are likely to be / characters in the regular expressions

data/test/test_text_answer_sheet_formatter.rb

@@ -1,5 +1,4 @@
 require 'minitest/spec'
-require 'minitest/mock'
 require 'minitest/autorun'
 require 'quiz_master'
 

data/test/test_text_question_formatter.rb

@@ -1,5 +1,4 @@
 require 'minitest/spec'
-require 'minitest/mock'
 require 'minitest/autorun'
 require 'quiz_master'
 

data/test/test_text_question_sheet_formatter.rb

@@ -0,0 +1,56 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'quiz_master'
+
+include QuizMaster
+
+expected_output = <<ETX
+Header
+
+1) This is the prompt.  It poses the question.
+
+  a) This is the first answer
+  b) This is the second answer
+  c) This is the third answer
+  d) (a) and (c)
+
+2) What is the colour of a Banana?
+
+  a) Red
+  b) Green
+  c) Yellow
+  d) Brown
+  e) Black
+  f) All of the above except (a)
+
+Footer
+ETX
+
+q = Question.new(
+  prompt: 'This is the prompt.  It poses the question.',
+  answers: [
+    Answer.new('This is the first answer', false, '5'),
+    Answer.new('This is the second answer', false),
+    Answer.new('This is the third answer', true, '3'),
+    Answer.new('{{3}} and {{5}}', false)
+  ]
+)
+q2 = Question.new(
+  prompt: 'What is the colour of a Banana?',
+  answers: [
+    Answer.new('Red', false, 'red'),
+    Answer.new('Green', false),
+    Answer.new('Yellow', false),
+    Answer.new('Brown', false),
+    Answer.new('Black', false),
+    Answer.new('All of the above except {{red}}', true)
+  ]
+)
+
+quiz = Quiz.new([q, q2], header: 'Header', footer: 'Footer')
+
+describe TextQuestionSheetFormatter do
+  it 'formats a test OK' do
+    TextQuestionSheetFormatter.new.format(quiz).must_equal expected_output
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quiz_master
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Stok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,11 +118,13 @@ files:
 - lib/quiz_master/text_answer_sheet_formatter.rb
 - lib/quiz_master/text_assembler.rb
 - lib/quiz_master/text_question_formatter.rb
+- lib/quiz_master/text_question_sheet_formatter.rb
 - lib/quiz_master/version.rb
 - quiz_master.gemspec
 - test/test_text_answer_sheet_formatter.rb
 - test/test_text_question_formatter.rb
-homepage: ''
+- test/test_text_question_sheet_formatter.rb
+homepage: https://github.com/mikestok/quiz_master
 licenses:
 - MIT
 metadata: {}
@@ -148,4 +151,5 @@ summary: Simple manager for multiple choice quizzes
 test_files:
 - test/test_text_answer_sheet_formatter.rb
 - test/test_text_question_formatter.rb
+- test/test_text_question_sheet_formatter.rb
 has_rdoc: