rapidfire 2.1.0 → 3.0.0

data/app/services/rapidfire/base_service.rb

@@ -1,6 +1,6 @@
 module Rapidfire
   class BaseService
-    if Rails::VERSION::MAJOR == 4
+    if Rails::VERSION::MAJOR == 4 || Rails::VERSION::MAJOR == 5
       include ActiveModel::Model
     else
       extend  ActiveModel::Naming

data/app/services/rapidfire/question_form.rb

@@ -17,7 +17,7 @@ module Rapidfire
       result
     end
 
-    attr_accessor :question_group, :question,
+    attr_accessor :survey, :question,
       :type, :question_text, :answer_options, :answer_presence,
       :answer_minimum_length, :answer_maximum_length,
       :answer_greater_than_or_equal_to, :answer_less_than_or_equal_to
@@ -27,7 +27,7 @@ module Rapidfire
     def initialize(params = {})
       from_question_to_attributes(params[:question]) if params[:question]
       super(params)
-      @question ||= question_group.questions.new
+      @question ||= survey.questions.new
     end
 
     def save
@@ -53,7 +53,7 @@ module Rapidfire
 
     def to_question_params
       {
-        :question_group => question_group,
+        :survey => survey,
         :question_text  => question_text,
         :answer_options => answer_options,
         :validation_rules => {
@@ -68,7 +68,7 @@ module Rapidfire
 
     def from_question_to_attributes(question)
       self.type = question.type
-      self.question_group  = question.question_group
+      self.survey  = question.survey
       self.question_text   = question.question_text
       self.answer_options  = question.answer_options
       self.answer_presence = question.rules[:presence]

data/app/services/rapidfire/{question_group_results.rb → survey_results.rb}

@@ -1,6 +1,6 @@
 module Rapidfire
-  class QuestionGroupResults < Rapidfire::BaseService
-    attr_accessor :question_group
+  class SurveyResults < Rapidfire::BaseService
+    attr_accessor :survey
 
     # extracts question along with results
     # each entry will have the following:
@@ -9,7 +9,7 @@ module Rapidfire
     # 3. if aggregatable, return each option with value
     # 4. else return an array of all the answers given
     def extract
-      @question_group.questions.collect do |question|
+      @survey.questions.collect do |question|
         results =
           case question
           when Rapidfire::Questions::Select, Rapidfire::Questions::Radio,

data/app/views/rapidfire/{answer_groups → attempts}/new.html.erb

@@ -1,8 +1,8 @@
 <h2>Please answer these Questions</h2>
 <hr/>
 
-<%= form_for([@question_group, @answer_group_builder]) do |f| %>
-  <%- @answer_group_builder.answers.each do |answer| %>
+<%= form_for([@survey, @attempt_builder]) do |f| %>
+  <%- @attempt_builder.answers.each do |answer| %>
     <%= f.fields_for("#{answer.question.id}", answer) do |answer_form| %>
       <%= render_answer_form_helper(answer, answer_form) %>
     <% end %>

data/app/views/rapidfire/questions/_question.html.erb

@@ -2,8 +2,8 @@
   <td><%= question.question_text %></td>
   <td>
     <ul class="horizontal-list">
-      <li><%= link_to "Edit", [:edit, question.question_group, question] %></li>
-      <li><%= link_to "Delete", [question.question_group, question], method: :delete %></li>
+      <li><%= link_to "Edit", [:edit, question.survey, question] %></li>
+      <li><%= link_to "Delete", [question.survey, question], method: :delete %></li>
     </ul>
   </td>
 </tr>

data/app/views/rapidfire/questions/edit.html.erb

@@ -1 +1 @@
-<%= render partial: 'form', locals: { form: @question_form, url: question_group_question_path(@question_group, @question), method: :put, submit_text: 'Update Question' } %>
+<%= render partial: 'form', locals: { form: @question_form, url: survey_question_path(@survey, @question), method: :put, submit_text: 'Update Question' } %>

data/app/views/rapidfire/questions/index.html.erb

@@ -1,6 +1,6 @@
 <h2>
   Questions
-  <%= link_to "New Question", new_question_group_question_path(@question_group) %>
+  <%= link_to "New Question", new_survey_question_path(@survey) %>
 </h2>
 <hr/>
 

data/app/views/rapidfire/questions/new.html.erb

@@ -1 +1 @@
-<%= render partial: 'form', locals: { form: @question_form, url: question_group_questions_path(@question_group), method: :post, submit_text: 'Create Question' } %>
+<%= render partial: 'form', locals: { form: @question_form, url: survey_questions_path(@survey), method: :post, submit_text: 'Create Question' } %>

data/app/views/rapidfire/surveys/_form.html.erb

@@ -0,0 +1,15 @@
+<h3><%= survey.new_record? ? "New Survey" : "Edit Survey" %></h3>
+
+<%= form_for survey do |f| %>
+  <%- if survey.errors.any? %>
+    <ul>
+      <%- survey.errors.full_messages.each do |message| %>
+        <li><%= message %></li>
+      <% end %>
+    </ul>
+  <% end %>
+
+  <%= f.label :name %>
+  <%= f.text_field :name %>
+  <%= f.submit %>
+<% end %>

data/app/views/rapidfire/surveys/_survey.html.erb

@@ -0,0 +1,18 @@
+<tr id= "survey_<%= survey.id %>">
+  <td>
+    <% if can_administer? %>
+      <%= link_to survey.name, survey_questions_path(survey) %>
+    <% else %>
+      <%= survey.name %>
+    <% end %>
+  </td>
+  <td>
+    <ul class="horizontal-list">
+      <li><%= link_to "Answer Questions", new_survey_attempt_path(survey) %></li>
+      <% if can_administer? %>
+        <li><%= link_to "Results", [:results, survey] %></li>
+        <li><%= link_to "Delete", survey, method: :delete %></li>
+      <% end %>
+    </ul>
+  </td>
+</tr>

data/app/views/rapidfire/{question_groups → surveys}/index.html.erb

@@ -1,7 +1,7 @@
 <h2>
-  Question Groups
+  Surveys
   <% if can_administer? %>
-    <%= link_to "New Group", new_question_group_path %>
+    <%= link_to "New Survey", new_survey_path %>
   <% end %>
 </h2>
 <hr/>
@@ -13,11 +13,11 @@
   </colgroup>
   <thead>
     <tr>
-      <th>Question Group</th>
+      <th>Survey</th>
       <th></th>
     </tr>
   </thead>
   <tbody>
-    <%= render partial: "question_group", collection: @question_groups %>
+    <%= render partial: "survey", collection: @surveys %>
   </tbody>
 </table>

data/app/views/rapidfire/surveys/new.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'form', locals: {survey: @survey} %>

data/app/views/rapidfire/{question_groups → surveys}/results.html.erb

@@ -1,6 +1,6 @@
 <h1>Results</h1>
 
-<%- @question_group_results.each do |result| %>
+<%- @survey_results.each do |result| %>
   <div>
     <h4><%= result.question.question_text %></h4>
     <p>

data/config/routes.rb

@@ -1,10 +1,10 @@
 Rapidfire::Engine.routes.draw do
-  resources :question_groups do
+  resources :surveys do
     get 'results', on: :member
 
     resources :questions
-    resources :answer_groups, only: [:new, :create]
+    resources :attempts, only: [:new, :create]
   end
 
-  root :to => "question_groups#index"
+  root :to => "surveys#index"
 end

data/db/migrate/20130502170733_create_rapidfire_question_groups.rb

@@ -1,6 +1,6 @@
 class CreateRapidfireQuestionGroups < ActiveRecord::Migration
   def change
-    create_table :rapidfire_question_groups do |t|
+    create_table :rapidfire_surveys do |t|
       t.string  :name
       t.timestamps
     end

data/db/migrate/20130502195310_create_rapidfire_questions.rb

@@ -1,7 +1,7 @@
 class CreateRapidfireQuestions < ActiveRecord::Migration
   def change
     create_table :rapidfire_questions do |t|
-      t.references :question_group
+      t.references :survey
       t.string  :type
       t.string  :question_text
       t.integer :position
@@ -10,6 +10,6 @@ class CreateRapidfireQuestions < ActiveRecord::Migration
 
       t.timestamps
     end
-    add_index :rapidfire_questions, :question_group_id
+    add_index :rapidfire_questions, :survey_id
   end
 end

data/db/migrate/20130502195415_create_rapidfire_answer_groups.rb

@@ -1,12 +1,12 @@
 class CreateRapidfireAnswerGroups < ActiveRecord::Migration
   def change
-    create_table :rapidfire_answer_groups do |t|
-      t.references :question_group
+    create_table :rapidfire_attempts do |t|
+      t.references :survey
       t.references :user, polymorphic: true
 
       t.timestamps
     end
-    add_index :rapidfire_answer_groups, :question_group_id
-    add_index :rapidfire_answer_groups, [:user_id, :user_type]
+    add_index :rapidfire_attempts, :survey_id
+    add_index :rapidfire_attempts, [:user_id, :user_type]
   end
 end

data/db/migrate/20130502195504_create_rapidfire_answers.rb

@@ -1,13 +1,13 @@
 class CreateRapidfireAnswers < ActiveRecord::Migration
   def change
     create_table :rapidfire_answers do |t|
-      t.references :answer_group
+      t.references :attempt
       t.references :question
       t.text :answer_text
 
       t.timestamps
     end
-    add_index :rapidfire_answers, :answer_group_id
+    add_index :rapidfire_answers, :attempt_id
     add_index :rapidfire_answers, :question_id
   end
 end

data/lib/generators/rapidfire/templates/migrations/rename_answer_groups_and_question_groups.rb

@@ -0,0 +1,9 @@
+class RenameAnswerGroupsAndQuestionGroups < ActiveRecord::Migration
+  def change
+    rename_table :rapidfire_answer_groups, :rapidfire_attempts
+    rename_table :rapidfire_question_groups, :rapidfire_surveys
+    rename_column :rapidfire_answers, :answer_group_id, :attempt_id
+    rename_column :rapidfire_attempts, :question_group_id, :survey_id
+    rename_column :rapidfire_questions, :question_group_id, :survey_id
+  end
+end

data/lib/generators/rapidfire/upgrade_migration_generator.rb

@@ -0,0 +1,18 @@
+module Rapidfire
+  module Generators
+    class UpgradeMigrationGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_migrations
+        migration_template "migrations/rename_answer_groups_and_question_groups.rb", "db/migrate/rename_answer_groups_and_question_groups.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/rapidfire/views_generator.rb

@@ -4,13 +4,13 @@ require 'rails/generators'
 module Rapidfire
   module Generators
     class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path("../../../../app/views/rapidfire", __FILE__)
-      desc "Copies default Rapidfire views to your application."
+      source_root File.expand_path('../../../../app/views/rapidfire', __FILE__)
+      desc 'Copies default Rapidfire views to your application.'
 
       def copy_views
-        view_directory :answer_groups
+        view_directory :attempts
         view_directory :answers
-        view_directory :question_groups
+        view_directory :surveys
         view_directory :questions
       end
 

data/lib/rapidfire/version.rb

@@ -1,3 +1,3 @@
 module Rapidfire
-  VERSION = '2.1.0'
+  VERSION = '3.0.0'
 end

data/lib/tasks/rapidfire.rake

@@ -0,0 +1,10 @@
+namespace :rapidfire do
+  namespace :upgrade do
+    namespace :migrations do
+      desc "Renaming rapidfire_answer_groups to rapidfire_attempts and rapidfire_question_groups to surveys"
+      task from210to300: :environment do
+        `rails generate rapidfire:upgrade_migration`
+      end
+    end
+  end
+end

data/spec/controllers/rapidfire/attempts_controller_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Rapidfire::AttemptsController do
+  before do
+    @routes = Rapidfire::Engine.routes
+  end
+
+  # this scenario is possible when there is only 1 radio button question, and
+  # user has not selected any option. in this case, browser doesn't send
+  # any default value.
+  context 'when no parameters are passed' do
+    it 'initializes answer builder with empty args' do
+      survey = FactoryGirl.create(:survey)
+
+      expect {
+        post :create, survey_id: survey.id
+      }.not_to raise_error
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.